Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update params and types for geocoding and search API #184

Merged
merged 5 commits into from
Oct 16, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/api/geocoding.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ class Geocoding {
static async forwardGeocode(params: RadarForwardGeocodeParams): Promise<RadarGeocodeResponse> {
const options = Config.get();

const { query, layers, country } = params;
const { query, layers, country, lang } = params;

const response: any = await Http.request({
method: 'GET',
Expand All @@ -22,6 +22,7 @@ class Geocoding {
query,
layers,
country,
lang,
},
});

Expand Down
2 changes: 2 additions & 0 deletions src/api/search.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ class SearchAPI {
countryCode,
expandUnits,
mailable,
lang,
} = params;

// near can be provided as a string or Location object
Expand All @@ -44,6 +45,7 @@ class SearchAPI {
countryCode,
expandUnits,
mailable,
lang,
},
requestId,
});
Expand Down
23 changes: 20 additions & 3 deletions src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,7 @@ export type RadarGeocodeLayer =
| 'address'
| 'postalCode'
| 'locality'
| 'neighborhood'
| 'county'
| 'state'
| 'country'
Expand Down Expand Up @@ -302,10 +303,24 @@ export interface RadarAddress {
street?: string;
}

export interface RadarTimeZone {
id: string;
name: string;
code: string;
currentTime: string;
utcOffset: number;
dstOffset: number;
}

export interface RadarAutocompleteAddress extends RadarAddress {
unit?: string;
}

export interface RadarGeocodeAddress extends RadarAddress {
unit?: string;
timeZone?: RadarTimeZone;
}

export type RadarValidationRecordType = 'S' | 'R' | 'P' | 'M' | 'H' | 'G' | 'F' | undefined;

export type RadarValidationPropertyType = 'commercial' | 'residential' | undefined;
Expand All @@ -325,6 +340,7 @@ export interface RadarForwardGeocodeParams {
query: string;
layers?: RadarGeocodeLayer[];
country?: string;
lang?: string;
}

export interface RadarReverseGeocodeParams {
Expand All @@ -333,13 +349,13 @@ export interface RadarReverseGeocodeParams {
layers?: RadarGeocodeLayer[];
}

export interface RadarGeocodeResponse extends RadarResponse {
addresses: RadarAddress[];
export interface RadarGeocodeResponse extends RadarResponse {
addresses: RadarGeocodeAddress[];
}

export interface RadarIPGeocodeResponse extends RadarResponse {
ip: string;
address?: RadarAddress;
address?: RadarGeocodeAddress;
proxy?: boolean;
}

Expand All @@ -352,6 +368,7 @@ export interface RadarAutocompleteParams {
/** @deprecated this is always true, regardless of the value passed here */
expandUnits?: boolean;
mailable?: boolean;
lang?: string;
}

export interface RadarAutocompleteResponse extends RadarResponse {
Expand Down
Loading