@wix/auto_sdk_atlas_autocomplete 1.0.0 → 1.0.2

package/build/internal/es/src/atlas-v2-prediction-autocomplete.universal.d.ts

@@ -1,140 +0,0 @@
-export 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;
-}
-export interface MatchedSubstrings {
-    length?: number;
-    offset?: number;
-}
-export 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[];
-}
-export 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;
-    /** The point around which you wish to retrieve place information */
-    location?: AddressLocation;
-    /** 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[];
-}
-export interface AddressLocation {
-    /** Address latitude. */
-    latitude?: number | null;
-    /** Address longitude. */
-    longitude?: number | null;
-}
-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 ListPredictionsResponse {
-    predictions?: Prediction[];
-}
-export interface PredictRequest {
-    /**
-     * The text the predictions will be based on.
-     * @minLength 1
-     */
-    input: string;
-    /** The origin point from which to calculate straight-line distance to the destination */
-    origin?: AddressLocation;
-    /** The point around which you wish to retrieve place information */
-    location?: AddressLocation;
-    /** 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.
-     * @format GUID
-     */
-    sessionToken?: string | null;
-}
-export interface PredictResponse {
-    predictions?: Prediction[];
-}
-interface MatchedSubstringsNonNullableFields {
-    length: number;
-    offset: number;
-}
-interface TextStructureNonNullableFields {
-    mainText: string;
-    secondaryText: string;
-    mainTextMatchedSubstrings: MatchedSubstringsNonNullableFields[];
-}
-interface PredictionNonNullableFields {
-    description: string;
-    searchId: string;
-    matchedSubstrings: MatchedSubstringsNonNullableFields[];
-    textStructure?: TextStructureNonNullableFields;
-}
-export interface PredictResponseNonNullableFields {
-    predictions: PredictionNonNullableFields[];
-}
-/**
- * A Predict end-point take an input and returns an list of Prediction object.
- * @param input - The text the predictions will be based on.
- * @public
- * @documentationMaturity preview
- * @requiredField input
- * @permissionId WIX_ATLAS.LIST_PREDICTIONS
- * @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.AutocompleteServiceV2.Predict
- */
-export declare function predict(input: string, options?: PredictOptions): Promise<PredictResponse & PredictResponseNonNullableFields>;
-export interface PredictOptions {
-    /** The origin point from which to calculate straight-line distance to the destination */
-    origin?: AddressLocation;
-    /** The point around which you wish to retrieve place information */
-    location?: AddressLocation;
-    /** 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.
-     * @format GUID
-     */
-    sessionToken?: string | null;
-}
-export {};

package/build/internal/es/src/atlas-v2-prediction-autocomplete.universal.js

@@ -1,71 +0,0 @@
-import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
-import { renameKeysFromSDKRequestToRESTRequest, renameKeysFromRESTResponseToSDKResponse, } from '@wix/sdk-runtime/rename-all-nested-keys';
-import * as ambassadorWixAtlasV2Prediction from './atlas-v2-prediction-autocomplete.http.js';
-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 Predict end-point take an input and returns an list of Prediction object.
- * @param input - The text the predictions will be based on.
- * @public
- * @documentationMaturity preview
- * @requiredField input
- * @permissionId WIX_ATLAS.LIST_PREDICTIONS
- * @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.AutocompleteServiceV2.Predict
- */
-export async function predict(input, options) {
-    // @ts-ignore
-    const { httpClient, sideEffects } = arguments[2];
-    const payload = renameKeysFromSDKRequestToRESTRequest({
-        input: input,
-        origin: options?.origin,
-        location: options?.location,
-        radius: options?.radius,
-        countryCodes: options?.countryCodes,
-        sessionToken: options?.sessionToken,
-    });
-    const reqOpts = ambassadorWixAtlasV2Prediction.predict(payload);
-    sideEffects?.onSiteCall?.();
-    try {
-        const result = await httpClient.request(reqOpts);
-        sideEffects?.onSuccess?.(result);
-        return renameKeysFromRESTResponseToSDKResponse(result.data);
-    }
-    catch (err) {
-        const transformedError = sdkTransformError(err, {
-            spreadPathsToArguments: {},
-            explicitPathsToArguments: {
-                input: '$[0]',
-                origin: '$[1].origin',
-                location: '$[1].location',
-                radius: '$[1].radius',
-                countryCodes: '$[1].countryCodes',
-                sessionToken: '$[1].sessionToken',
-            },
-            singleArgumentUnchanged: false,
-        }, ['input', 'options']);
-        sideEffects?.onError?.(err);
-        throw transformedError;
-    }
-}
-//# sourceMappingURL=atlas-v2-prediction-autocomplete.universal.js.map

package/build/internal/es/src/atlas-v2-prediction-autocomplete.universal.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"atlas-v2-prediction-autocomplete.universal.js","sourceRoot":"","sources":["../../../../src/atlas-v2-prediction-autocomplete.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,8BAA8B,MAAM,4CAA4C,CAAC;AAwD7F,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;AAqDD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAC3B,KAAa,EACb,OAAwB;IAExB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,KAAK,EAAE,KAAK;QACZ,MAAM,EAAE,OAAO,EAAE,MAAM;QACvB,QAAQ,EAAE,OAAO,EAAE,QAAQ;QAC3B,MAAM,EAAE,OAAO,EAAE,MAAM;QACvB,YAAY,EAAE,OAAO,EAAE,YAAY;QACnC,YAAY,EAAE,OAAO,EAAE,YAAY;KACpC,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,8BAA8B,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAEhE,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,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE;gBACxB,KAAK,EAAE,MAAM;gBACb,MAAM,EAAE,aAAa;gBACrB,QAAQ,EAAE,eAAe;gBACzB,MAAM,EAAE,aAAa;gBACrB,YAAY,EAAE,mBAAmB;gBACjC,YAAY,EAAE,mBAAmB;aAClC;YACD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,OAAO,EAAE,SAAS,CAAC,CACrB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC"}