@wix/auto_sdk_atlas_location 1.0.0

package/build/internal/es/src/atlas-v2-search-result-location.universal.d.ts

@@ -0,0 +1,169 @@
+export interface SearchResult {
+    /** The Address object */
+    address?: Address;
+    /** stores additional data about the proximity to the specified location */
+    proximity?: Proximity;
+}
+/** Physical address */
+export 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.
+     * @format COUNTRY
+     */
+    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 */
+export interface AddressStreetOneOf {
+    /** Street name and number. */
+    streetAddress?: StreetAddress;
+    /** Main address line, usually street and number as free text. */
+    addressLine?: string | null;
+}
+export interface StreetAddress {
+    /** Street number. */
+    number?: string;
+    /** Street name. */
+    name?: string;
+}
+export interface AddressLocation {
+    /** Address latitude. */
+    latitude?: number | null;
+    /** Address longitude. */
+    longitude?: number | null;
+}
+export interface Subdivision {
+    /** Short subdivision code. */
+    code?: string;
+    /** Subdivision full name. */
+    name?: string;
+}
+export 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"
+}
+export 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 */
+export 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[];
+}
+export interface FilterBy {
+    /** One of the filter types enum */
+    filterType?: FilterType;
+    /** Free text like "us" */
+    filterValue?: string;
+}
+export declare enum FilterType {
+    /** Filter by zip code */
+    zip_code = "zip_code",
+    /** Filter by 2-letters or 3-letters country code */
+    country_code = "country_code"
+}
+export interface SearchResponse {
+    /** List of 'Address' objects */
+    searchResults?: SearchResult[];
+}
+export interface ReverseGeocodingRequest {
+    /** The latitude and longitude values specifying the location for which you wish to obtain the closest, human-readable address. */
+    addressLocation?: AddressLocation;
+}
+export interface ReverseGeocodingResponse {
+    searchResults?: SearchResult[];
+}
+interface StreetAddressNonNullableFields {
+    number: string;
+    name: string;
+    apt: string;
+}
+interface SubdivisionNonNullableFields {
+    name: string;
+}
+interface AddressNonNullableFields {
+    streetAddress?: StreetAddressNonNullableFields;
+    subdivisions: SubdivisionNonNullableFields[];
+}
+interface SearchResultNonNullableFields {
+    address?: AddressNonNullableFields;
+    proximity: Proximity;
+}
+export interface SearchResponseNonNullableFields {
+    searchResults: SearchResultNonNullableFields[];
+}
+/**
+ * A Search request takes a free text as an input and returns a list of 'Address' objects.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId WIX_ATLAS.SEARCH
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Access Verticals by Automations
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.vi.atlas.service.v2.LocationServiceV2.Search
+ */
+export declare function search(options?: SearchOptions): Promise<SearchResponse & SearchResponseNonNullableFields>;
+export 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[];
+}
+export {};

package/build/internal/es/src/atlas-v2-search-result-location.universal.js

@@ -0,0 +1,98 @@
+import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
+import { renameKeysFromSDKRequestToRESTRequest, renameKeysFromRESTResponseToSDKResponse, } from '@wix/sdk-runtime/rename-all-nested-keys';
+import * as ambassadorWixAtlasV2SearchResult from './atlas-v2-search-result-location.http.js';
+import { transformRESTAddressToSDKAddress } from '@wix/sdk-runtime/transformations/address';
+import { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';
+export var SubdivisionType;
+(function (SubdivisionType) {
+    SubdivisionType["UNKNOWN_SUBDIVISION_TYPE"] = "UNKNOWN_SUBDIVISION_TYPE";
+    /** State */
+    SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_1"] = "ADMINISTRATIVE_AREA_LEVEL_1";
+    /** County */
+    SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_2"] = "ADMINISTRATIVE_AREA_LEVEL_2";
+    /** City/town */
+    SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_3"] = "ADMINISTRATIVE_AREA_LEVEL_3";
+    /** Neighborhood/quarter */
+    SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_4"] = "ADMINISTRATIVE_AREA_LEVEL_4";
+    /** Street/block */
+    SubdivisionType["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. */
+    SubdivisionType["COUNTRY"] = "COUNTRY";
+})(SubdivisionType || (SubdivisionType = {}));
+export var Proximity;
+(function (Proximity) {
+    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 */
+    Proximity["PINPOINT"] = "PINPOINT";
+    /** indicates that the returned result is the geometric center of a result */
+    Proximity["APPROXIMATE"] = "APPROXIMATE";
+    /** indicates that the returned result is around an area */
+    Proximity["GENERAL_AREA"] = "GENERAL_AREA";
+})(Proximity || (Proximity = {}));
+export var FilterType;
+(function (FilterType) {
+    /** Filter by zip code */
+    FilterType["zip_code"] = "zip_code";
+    /** Filter by 2-letters or 3-letters country code */
+    FilterType["country_code"] = "country_code";
+})(FilterType || (FilterType = {}));
+/**
+ * A Search request takes a free text as an input and returns a list of 'Address' objects.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId WIX_ATLAS.SEARCH
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Access Verticals by Automations
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.vi.atlas.service.v2.LocationServiceV2.Search
+ */
+export async function search(options) {
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[1];
+    const payload = renameKeysFromSDKRequestToRESTRequest({
+        query: options?.query,
+        filterBy: options?.filterBy,
+        zipCode: options?.zipCode,
+        countryCodes: options?.countryCodes,
+    });
+    const reqOpts = ambassadorWixAtlasV2SearchResult.search(payload);
+    sideEffects?.onSiteCall?.();
+    try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+        return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
+            {
+                transformFn: transformRESTAddressToSDKAddress,
+                paths: [{ path: 'searchResults.address' }],
+            },
+        ]));
+    }
+    catch (err) {
+        const transformedError = sdkTransformError(err, {
+            spreadPathsToArguments: {},
+            explicitPathsToArguments: {
+                query: '$[0].query',
+                filterBy: '$[0].filterBy',
+                zipCode: '$[0].zipCode',
+                countryCodes: '$[0].countryCodes',
+            },
+            singleArgumentUnchanged: false,
+        }, ['options']);
+        sideEffects?.onError?.(err);
+        throw transformedError;
+    }
+}
+//# sourceMappingURL=atlas-v2-search-result-location.universal.js.map

package/build/internal/es/src/atlas-v2-search-result-location.universal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"atlas-v2-search-result-location.universal.js","sourceRoot":"","sources":["../../../../src/atlas-v2-search-result-location.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,gCAAgC,MAAM,2CAA2C,CAAC;AAC9F,OAAO,EAAE,gCAAgC,EAAE,MAAM,0CAA0C,CAAC;AAC5F,OAAO,EAAE,cAAc,EAAE,MAAM,kDAAkD,CAAC;AA2DlF,MAAM,CAAN,IAAY,eAcX;AAdD,WAAY,eAAe;IACzB,wEAAqD,CAAA;IACrD,YAAY;IACZ,8EAA2D,CAAA;IAC3D,aAAa;IACb,8EAA2D,CAAA;IAC3D,gBAAgB;IAChB,8EAA2D,CAAA;IAC3D,2BAA2B;IAC3B,8EAA2D,CAAA;IAC3D,mBAAmB;IACnB,8EAA2D,CAAA;IAC3D,8IAA8I;IAC9I,sCAAmB,CAAA;AACrB,CAAC,EAdW,eAAe,KAAf,eAAe,QAc1B;AAED,MAAM,CAAN,IAAY,SAQX;AARD,WAAY,SAAS;IACnB,oDAAuC,CAAA;IACvC,+IAA+I;IAC/I,kCAAqB,CAAA;IACrB,6EAA6E;IAC7E,wCAA2B,CAAA;IAC3B,2DAA2D;IAC3D,0CAA6B,CAAA;AAC/B,CAAC,EARW,SAAS,KAAT,SAAS,QAQpB;AAwBD,MAAM,CAAN,IAAY,UAKX;AALD,WAAY,UAAU;IACpB,yBAAyB;IACzB,mCAAqB,CAAA;IACrB,oDAAoD;IACpD,2CAA6B,CAAA;AAC/B,CAAC,EALW,UAAU,KAAV,UAAU,QAKrB;AAwCD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAC1B,OAAuB;IAEvB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,KAAK,EAAE,OAAO,EAAE,KAAK;QACrB,QAAQ,EAAE,OAAO,EAAE,QAAQ;QAC3B,OAAO,EAAE,OAAO,EAAE,OAAO;QACzB,YAAY,EAAE,OAAO,EAAE,YAAY;KACpC,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,gCAAgC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAEjE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAC5C,cAAc,CAAC,MAAM,CAAC,IAAI,EAAE;YAC1B;gBACE,WAAW,EAAE,gCAAgC;gBAC7C,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,uBAAuB,EAAE,CAAC;aAC3C;SACF,CAAC,CACF,CAAC;IACL,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE;gBACxB,KAAK,EAAE,YAAY;gBACnB,QAAQ,EAAE,eAAe;gBACzB,OAAO,EAAE,cAAc;gBACvB,YAAY,EAAE,mBAAmB;aAClC;YACD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,SAAS,CAAC,CACZ,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC"}

package/meta/package.json

@@ -0,0 +1,3 @@
+{
+  "main": "../build/cjs/meta.js"
+}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@wix/auto_sdk_atlas_location",
+  "version": "1.0.0",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "keywords": [],
+  "sideEffects": false,
+  "main": "./build/cjs/index.js",
+  "types": "./build/es/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./build/es/index.js",
+      "require": "./build/cjs/index.js",
+      "types": "./build/es/index.d.ts"
+    },
+    "./package.json": "./package.json",
+    "./meta": {
+      "import": "./build/es/meta.js",
+      "require": "./build/cjs/meta.js",
+      "types": "./build/es/meta.d.ts"
+    }
+  },
+  "files": [
+    "build",
+    "meta",
+    "service-plugins"
+  ],
+  "dependencies": {
+    "@wix/sdk-runtime": "^0.3.35",
+    "@wix/sdk-types": "^1.12.4"
+  },
+  "devDependencies": {
+    "typescript": "^5.3.2"
+  },
+  "scripts": {
+    "build": "tsc -b tsconfig.json tsconfig.esm.json tsconfig.internal.json tsconfig.internal.esm.json",
+    "test": ":"
+  },
+  "wix": {
+    "artifact": {
+      "artifactId": "auto-sdk-atlas-location",
+      "groupId": "com.wixpress.public-sdk-dependencies"
+    },
+    "sdkDependency": {
+      "fqdnNamespace": "location",
+      "fqdn": "wix.atlas.v2.search_result"
+    }
+  },
+  "falconPackageHash": "bda10dde9997fe03dd40a3b237ff290013245a60b3d9bfda497364a4"
+}