@wix/atlas 1.0.10 → 1.0.12

package/type-bundles/index.bundle.d.ts

@@ -0,0 +1,405 @@
+interface Place {
+    /** The given place id */
+    placeId?: string;
+    /** The Address object */
+    address?: Address$1;
+    /** The Place type. For example: airport, library etc... */
+    types?: string[];
+}
+/** Physical address */
+interface Address$1 extends AddressStreetOneOf$1 {
+    /** Street name and number. */
+    streetAddress?: StreetAddress$1;
+    /** Main address line, usually street and number as free text. */
+    addressLine1?: string | null;
+    /** Country code. */
+    country?: string | null;
+    /** Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
+    subdivision?: string | null;
+    /** City name. */
+    city?: string | null;
+    /** Zip/postal code. */
+    postalCode?: string | null;
+    /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
+    addressLine2?: string | null;
+}
+/** @oneof */
+interface AddressStreetOneOf$1 {
+    /** Street name and number. */
+    streetAddress?: StreetAddress$1;
+    /** Main address line, usually street and number as free text. */
+    addressLine?: string | null;
+}
+interface StreetAddress$1 {
+    /** Street number. */
+    number?: string;
+    /** Street name. */
+    name?: string;
+}
+interface AddressLocation$2 {
+    /** Address latitude. */
+    latitude?: number | null;
+    /** Address longitude. */
+    longitude?: number | null;
+}
+interface Subdivision$1 {
+    /** Short subdivision code. */
+    code?: string;
+    /** Subdivision full name. */
+    name?: string;
+}
+declare enum SubdivisionType$1 {
+    UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
+    /** State */
+    ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
+    /** County */
+    ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
+    /** City/town */
+    ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
+    /** Neighborhood/quarter */
+    ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
+    /** Street/block */
+    ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
+    /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
+    COUNTRY = "COUNTRY"
+}
+interface GetPlaceRequest {
+    searchId: string;
+    /** A random string which identifies an autocomplete session for billing purposes. The session begins when the user starts typing a query, and concludes when they select a place and a call to Get Place is made. Once a session has concluded, the token is no longer valid. your app must generate a fresh token for each session. */
+    sessionToken?: string | null;
+}
+interface GetPlaceResponse {
+    place?: Place;
+}
+interface GetPlaceResponseNonNullableFields {
+    place?: {
+        placeId: string;
+        types: string[];
+    };
+}
+interface GetPlaceOptions {
+    /** A random string which identifies an autocomplete session for billing purposes. The session begins when the user starts typing a query, and concludes when they select a place and a call to Get Place is made. Once a session has concluded, the token is no longer valid. your app must generate a fresh token for each session. */
+    sessionToken?: string | null;
+}
+
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+
+declare const __metadata$2: {
+    PACKAGE_NAME: string;
+};
+declare function getPlace(httpClient: HttpClient): (searchId: string, options?: GetPlaceOptions) => Promise<GetPlaceResponse & GetPlaceResponseNonNullableFields>;
+
+type index_d$2_GetPlaceOptions = GetPlaceOptions;
+type index_d$2_GetPlaceRequest = GetPlaceRequest;
+type index_d$2_GetPlaceResponse = GetPlaceResponse;
+type index_d$2_GetPlaceResponseNonNullableFields = GetPlaceResponseNonNullableFields;
+type index_d$2_Place = Place;
+declare const index_d$2_getPlace: typeof getPlace;
+declare namespace index_d$2 {
+  export { type Address$1 as Address, type AddressLocation$2 as AddressLocation, type AddressStreetOneOf$1 as AddressStreetOneOf, type index_d$2_GetPlaceOptions as GetPlaceOptions, type index_d$2_GetPlaceRequest as GetPlaceRequest, type index_d$2_GetPlaceResponse as GetPlaceResponse, type index_d$2_GetPlaceResponseNonNullableFields as GetPlaceResponseNonNullableFields, type index_d$2_Place as Place, type StreetAddress$1 as StreetAddress, type Subdivision$1 as Subdivision, SubdivisionType$1 as SubdivisionType, __metadata$2 as __metadata, index_d$2_getPlace as getPlace };
+}
+
+interface Prediction {
+    /** The human-readable name of the prediction */
+    description?: string;
+    /** The id of the prediction that can be use in place api. Available for short time. */
+    searchId?: string;
+    /** Contains an array with offset value and length. These describe the location of the entered term in the prediction result text, so that the term can be highlighted if desired */
+    matchedSubstrings?: MatchedSubstrings[];
+    /** Provides pre-formatted text that can be shown in your autocomplete results */
+    textStructure?: TextStructure;
+    /** Contains an integer indicating the straight-line distance between the predicted place, and the specified origin point, in meters. */
+    distanceInMeters?: number | null;
+}
+interface MatchedSubstrings {
+    length?: number;
+    offset?: number;
+}
+interface TextStructure {
+    /** Contains the main text of a prediction, usually the name of the place */
+    mainText?: string;
+    /** Contains the secondary text of a prediction, usually the location of the place */
+    secondaryText?: string;
+    /** Contains an array with offset value and length. These describe the location of the entered term in the prediction result text, so that the term can be highlighted if desired */
+    mainTextMatchedSubstrings?: MatchedSubstrings[];
+}
+interface ListPredictionsRequest {
+    /** The text the predictions will be based on. */
+    input?: string;
+    /** The origin point from which to calculate straight-line distance to the destination */
+    origin?: AddressLocation$1;
+    /** The point around which you wish to retrieve place information */
+    location?: AddressLocation$1;
+    /** The acceptable distance from that location (in meters) */
+    radius?: string | null;
+    /** Filters the user can add in order to get more accurate results */
+    filterBy?: FilterBy$1[];
+}
+interface AddressLocation$1 {
+    /** Address latitude. */
+    latitude?: number | null;
+    /** Address longitude. */
+    longitude?: number | null;
+}
+interface FilterBy$1 {
+    /** One of the filter types enum */
+    filterType?: FilterType$1;
+    /** Free text like "us" */
+    filterValue?: string;
+}
+declare enum FilterType$1 {
+    /** Filter by zip code */
+    zip_code = "zip_code",
+    /** Filter by 2-letters or 3-letters country code */
+    country_code = "country_code"
+}
+interface ListPredictionsResponse {
+    predictions?: Prediction[];
+}
+interface PredictRequest {
+    /** The text the predictions will be based on. */
+    input: string;
+    /** The origin point from which to calculate straight-line distance to the destination */
+    origin?: AddressLocation$1;
+    /** The point around which you wish to retrieve place information */
+    location?: AddressLocation$1;
+    /** The acceptable distance from that location (in meters) */
+    radius?: string | null;
+    /** alpha-2 or alpha-3 ISO-3166 country codes to filter by */
+    countryCodes?: string[];
+    /** A random string which identifies an autocomplete session for billing purposes. The session begins when the user starts typing a query, and concludes when they select a place and a call to Get Place is made. Once a session has concluded, the token is no longer valid. your app must generate a fresh token for each session. */
+    sessionToken?: string | null;
+}
+interface PredictResponse {
+    predictions?: Prediction[];
+}
+interface PredictResponseNonNullableFields {
+    predictions: {
+        description: string;
+        searchId: string;
+        matchedSubstrings: {
+            length: number;
+            offset: number;
+        }[];
+        textStructure?: {
+            mainText: string;
+            secondaryText: string;
+            mainTextMatchedSubstrings: {
+                length: number;
+                offset: number;
+            }[];
+        };
+    }[];
+}
+interface PredictOptions {
+    /** The origin point from which to calculate straight-line distance to the destination */
+    origin?: AddressLocation$1;
+    /** The point around which you wish to retrieve place information */
+    location?: AddressLocation$1;
+    /** The acceptable distance from that location (in meters) */
+    radius?: string | null;
+    /** alpha-2 or alpha-3 ISO-3166 country codes to filter by */
+    countryCodes?: string[];
+    /** A random string which identifies an autocomplete session for billing purposes. The session begins when the user starts typing a query, and concludes when they select a place and a call to Get Place is made. Once a session has concluded, the token is no longer valid. your app must generate a fresh token for each session. */
+    sessionToken?: string | null;
+}
+
+declare const __metadata$1: {
+    PACKAGE_NAME: string;
+};
+declare function predict(httpClient: HttpClient): (input: string, options?: PredictOptions) => Promise<PredictResponse & PredictResponseNonNullableFields>;
+
+type index_d$1_ListPredictionsRequest = ListPredictionsRequest;
+type index_d$1_ListPredictionsResponse = ListPredictionsResponse;
+type index_d$1_MatchedSubstrings = MatchedSubstrings;
+type index_d$1_PredictOptions = PredictOptions;
+type index_d$1_PredictRequest = PredictRequest;
+type index_d$1_PredictResponse = PredictResponse;
+type index_d$1_PredictResponseNonNullableFields = PredictResponseNonNullableFields;
+type index_d$1_Prediction = Prediction;
+type index_d$1_TextStructure = TextStructure;
+declare const index_d$1_predict: typeof predict;
+declare namespace index_d$1 {
+  export { type AddressLocation$1 as AddressLocation, type FilterBy$1 as FilterBy, FilterType$1 as FilterType, type index_d$1_ListPredictionsRequest as ListPredictionsRequest, type index_d$1_ListPredictionsResponse as ListPredictionsResponse, type index_d$1_MatchedSubstrings as MatchedSubstrings, type index_d$1_PredictOptions as PredictOptions, type index_d$1_PredictRequest as PredictRequest, type index_d$1_PredictResponse as PredictResponse, type index_d$1_PredictResponseNonNullableFields as PredictResponseNonNullableFields, type index_d$1_Prediction as Prediction, type index_d$1_TextStructure as TextStructure, __metadata$1 as __metadata, index_d$1_predict as predict };
+}
+
+interface SearchResult {
+    /** The Address object */
+    address?: Address;
+    /** stores additional data about the proximity to the specified location */
+    proximity?: Proximity;
+}
+/** Physical address */
+interface Address extends AddressStreetOneOf {
+    /** Street name and number. */
+    streetAddress?: StreetAddress;
+    /** Main address line, usually street and number as free text. */
+    addressLine1?: string | null;
+    /** Country code. */
+    country?: string | null;
+    /** Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
+    subdivision?: string | null;
+    /** City name. */
+    city?: string | null;
+    /** Zip/postal code. */
+    postalCode?: string | null;
+    /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
+    addressLine2?: string | null;
+}
+/** @oneof */
+interface AddressStreetOneOf {
+    /** Street name and number. */
+    streetAddress?: StreetAddress;
+    /** Main address line, usually street and number as free text. */
+    addressLine?: string | null;
+}
+interface StreetAddress {
+    /** Street number. */
+    number?: string;
+    /** Street name. */
+    name?: string;
+}
+interface AddressLocation {
+    /** Address latitude. */
+    latitude?: number | null;
+    /** Address longitude. */
+    longitude?: number | null;
+}
+interface Subdivision {
+    /** Short subdivision code. */
+    code?: string;
+    /** Subdivision full name. */
+    name?: string;
+}
+declare enum SubdivisionType {
+    UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
+    /** State */
+    ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
+    /** County */
+    ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
+    /** City/town */
+    ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
+    /** Neighborhood/quarter */
+    ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
+    /** Street/block */
+    ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
+    /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
+    COUNTRY = "COUNTRY"
+}
+declare enum Proximity {
+    UNKNOWN_PROXIMITY = "UNKNOWN_PROXIMITY",
+    /** indicates that the returned result is a precise geocode for which we have location information accurate down to street address precision */
+    PINPOINT = "PINPOINT",
+    /** indicates that the returned result is the geometric center of a result */
+    APPROXIMATE = "APPROXIMATE",
+    /** indicates that the returned result is around an area */
+    GENERAL_AREA = "GENERAL_AREA"
+}
+/** User must provide query or filter by parameters */
+interface SearchRequest {
+    /** Free text */
+    query?: string | null;
+    /**
+     * Deprecate! - Please use 'zipCode' and 'countryCodes' fields
+     * @deprecated
+     */
+    filterBy?: FilterBy[];
+    /** Zip code filter the user can add in order to get more accurate results */
+    zipCode?: string | null;
+    /** Country codes filter the user can add in order to get more accurate results */
+    countryCodes?: string[];
+}
+interface FilterBy {
+    /** One of the filter types enum */
+    filterType?: FilterType;
+    /** Free text like "us" */
+    filterValue?: string;
+}
+declare enum FilterType {
+    /** Filter by zip code */
+    zip_code = "zip_code",
+    /** Filter by 2-letters or 3-letters country code */
+    country_code = "country_code"
+}
+interface SearchResponse {
+    /** List of 'Address' objects */
+    searchResults?: SearchResult[];
+}
+interface ReverseGeocodingRequest {
+    /** The latitude and longitude values specifying the location for which you wish to obtain the closest, human-readable address. */
+    addressLocation?: AddressLocation;
+}
+interface ReverseGeocodingResponse {
+    searchResults?: SearchResult[];
+}
+interface SearchResponseNonNullableFields {
+    searchResults: {
+        proximity: Proximity;
+    }[];
+}
+interface SearchOptions {
+    /** Free text */
+    query?: string | null;
+    /**
+     * Deprecate! - Please use 'zipCode' and 'countryCodes' fields
+     * @deprecated
+     */
+    filterBy?: FilterBy[];
+    /** Zip code filter the user can add in order to get more accurate results */
+    zipCode?: string | null;
+    /** Country codes filter the user can add in order to get more accurate results */
+    countryCodes?: string[];
+}
+
+declare const __metadata: {
+    PACKAGE_NAME: string;
+};
+declare function search(httpClient: HttpClient): (options?: SearchOptions) => Promise<SearchResponse & SearchResponseNonNullableFields>;
+
+type index_d_Address = Address;
+type index_d_AddressLocation = AddressLocation;
+type index_d_AddressStreetOneOf = AddressStreetOneOf;
+type index_d_FilterBy = FilterBy;
+type index_d_FilterType = FilterType;
+declare const index_d_FilterType: typeof FilterType;
+type index_d_Proximity = Proximity;
+declare const index_d_Proximity: typeof Proximity;
+type index_d_ReverseGeocodingRequest = ReverseGeocodingRequest;
+type index_d_ReverseGeocodingResponse = ReverseGeocodingResponse;
+type index_d_SearchOptions = SearchOptions;
+type index_d_SearchRequest = SearchRequest;
+type index_d_SearchResponse = SearchResponse;
+type index_d_SearchResponseNonNullableFields = SearchResponseNonNullableFields;
+type index_d_SearchResult = SearchResult;
+type index_d_StreetAddress = StreetAddress;
+type index_d_Subdivision = Subdivision;
+type index_d_SubdivisionType = SubdivisionType;
+declare const index_d_SubdivisionType: typeof SubdivisionType;
+declare const index_d___metadata: typeof __metadata;
+declare const index_d_search: typeof search;
+declare namespace index_d {
+  export { type index_d_Address as Address, type index_d_AddressLocation as AddressLocation, type index_d_AddressStreetOneOf as AddressStreetOneOf, type index_d_FilterBy as FilterBy, index_d_FilterType as FilterType, index_d_Proximity as Proximity, type index_d_ReverseGeocodingRequest as ReverseGeocodingRequest, type index_d_ReverseGeocodingResponse as ReverseGeocodingResponse, type index_d_SearchOptions as SearchOptions, type index_d_SearchRequest as SearchRequest, type index_d_SearchResponse as SearchResponse, type index_d_SearchResponseNonNullableFields as SearchResponseNonNullableFields, type index_d_SearchResult as SearchResult, type index_d_StreetAddress as StreetAddress, type index_d_Subdivision as Subdivision, index_d_SubdivisionType as SubdivisionType, index_d___metadata as __metadata, index_d_search as search };
+}
+
+export { index_d$1 as autocomplete, index_d as location, index_d$2 as places };