@wix/ecom 1.0.520 → 1.0.522

package/build/es/src/ecom-recommendations-v1-recommendation.meta.d.ts

@@ -1,14 +0,0 @@
-import * as ambassadorWixEcomRecommendationsV1RecommendationTypes from './ecom-recommendations-v1-recommendation.types';
-import * as ambassadorWixEcomRecommendationsV1RecommendationUniversalTypes from './ecom-recommendations-v1-recommendation.universal';
-export type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
-    getUrl: (context: any) => string;
-    httpMethod: K;
-    path: string;
-    pathParams: M;
-    __requestType: T;
-    __originalRequestType: S;
-    __responseType: Q;
-    __originalResponseType: R;
-};
-export declare function listAvailableAlgorithms(): __PublicMethodMetaInfo<'GET', {}, ambassadorWixEcomRecommendationsV1RecommendationUniversalTypes.ListAvailableAlgorithmsRequest, ambassadorWixEcomRecommendationsV1RecommendationTypes.ListAvailableAlgorithmsRequest, ambassadorWixEcomRecommendationsV1RecommendationUniversalTypes.ListAvailableAlgorithmsResponse & ambassadorWixEcomRecommendationsV1RecommendationUniversalTypes.ListAvailableAlgorithmsResponseNonNullableFields, ambassadorWixEcomRecommendationsV1RecommendationTypes.ListAvailableAlgorithmsResponse & ambassadorWixEcomRecommendationsV1RecommendationTypes.ListAvailableAlgorithmsResponseNonNullableFields>;
-export declare function getRecommendation(): __PublicMethodMetaInfo<'POST', {}, ambassadorWixEcomRecommendationsV1RecommendationUniversalTypes.GetRecommendationRequest, ambassadorWixEcomRecommendationsV1RecommendationTypes.GetRecommendationRequest, ambassadorWixEcomRecommendationsV1RecommendationUniversalTypes.GetRecommendationResponse & ambassadorWixEcomRecommendationsV1RecommendationUniversalTypes.GetRecommendationResponseNonNullableFields, ambassadorWixEcomRecommendationsV1RecommendationTypes.GetRecommendationResponse & ambassadorWixEcomRecommendationsV1RecommendationTypes.GetRecommendationResponseNonNullableFields>;

package/build/es/src/ecom-recommendations-v1-recommendation.meta.js

@@ -1,38 +0,0 @@
-import * as ambassadorWixEcomRecommendationsV1Recommendation from './ecom-recommendations-v1-recommendation.http';
-export function listAvailableAlgorithms() {
-    const payload = {};
-    const getRequestOptions = ambassadorWixEcomRecommendationsV1Recommendation.listAvailableAlgorithms(payload);
-    const getUrl = (context) => {
-        const { url } = getRequestOptions(context);
-        return url;
-    };
-    return {
-        getUrl,
-        httpMethod: 'GET',
-        path: '/v1/recommendations/algorithms',
-        pathParams: {},
-        __requestType: null,
-        __originalRequestType: null,
-        __responseType: null,
-        __originalResponseType: null,
-    };
-}
-export function getRecommendation() {
-    const payload = {};
-    const getRequestOptions = ambassadorWixEcomRecommendationsV1Recommendation.getRecommendation(payload);
-    const getUrl = (context) => {
-        const { url } = getRequestOptions(context);
-        return url;
-    };
-    return {
-        getUrl,
-        httpMethod: 'POST',
-        path: '/v1/recommendations/get',
-        pathParams: {},
-        __requestType: null,
-        __originalRequestType: null,
-        __responseType: null,
-        __originalResponseType: null,
-    };
-}
-//# sourceMappingURL=ecom-recommendations-v1-recommendation.meta.js.map

package/build/es/src/ecom-recommendations-v1-recommendation.meta.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ecom-recommendations-v1-recommendation.meta.js","sourceRoot":"","sources":["../../../src/ecom-recommendations-v1-recommendation.meta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,gDAAgD,MAAM,+CAA+C,CAAC;AAsBlH,MAAM,UAAU,uBAAuB;IAUrC,MAAM,OAAO,GAAG,EAAS,CAAC;IAE1B,MAAM,iBAAiB,GACrB,gDAAgD,CAAC,uBAAuB,CACtE,OAAO,CACR,CAAC;IAEJ,MAAM,MAAM,GAAG,CAAC,OAAY,EAAU,EAAE;QACtC,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,GAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,MAAM;QACN,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE,gCAAgC;QACtC,UAAU,EAAE,EAAE;QACd,aAAa,EAAE,IAAW;QAC1B,qBAAqB,EAAE,IAAW;QAClC,cAAc,EAAE,IAAW;QAC3B,sBAAsB,EAAE,IAAW;KACpC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,iBAAiB;IAU/B,MAAM,OAAO,GAAG,EAAS,CAAC;IAE1B,MAAM,iBAAiB,GACrB,gDAAgD,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAE9E,MAAM,MAAM,GAAG,CAAC,OAAY,EAAU,EAAE;QACtC,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,GAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,MAAM;QACN,UAAU,EAAE,MAAM;QAClB,IAAI,EAAE,yBAAyB;QAC/B,UAAU,EAAE,EAAE;QACd,aAAa,EAAE,IAAW;QAC1B,qBAAqB,EAAE,IAAW;QAClC,cAAc,EAAE,IAAW;QAC3B,sBAAsB,EAAE,IAAW;KACpC,CAAC;AACJ,CAAC"}

package/build/es/src/ecom-recommendations-v1-recommendation.public.d.ts

@@ -1,9 +0,0 @@
-import { HttpClient } from '@wix/sdk-types';
-import { Algorithm, GetRecommendationOptions } from './ecom-recommendations-v1-recommendation.universal';
-export declare const __metadata: {
-    PACKAGE_NAME: string;
-};
-export declare function listAvailableAlgorithms(httpClient: HttpClient): () => Promise<import("./ecom-recommendations-v1-recommendation.universal").ListAvailableAlgorithmsResponse & import("./ecom-recommendations-v1-recommendation.universal").ListAvailableAlgorithmsResponseNonNullableFields>;
-export declare function getRecommendation(httpClient: HttpClient): (algorithms: Algorithm[], options?: GetRecommendationOptions) => Promise<import("./ecom-recommendations-v1-recommendation.universal").GetRecommendationResponse & import("./ecom-recommendations-v1-recommendation.universal").GetRecommendationResponseNonNullableFields>;
-export { AlgorithmType } from './ecom-recommendations-v1-recommendation.universal';
-export { Recommendation, CatalogReference, Algorithm, ListAvailableAlgorithmsRequest, ListAvailableAlgorithmsResponse, AlgorithmInfo, AlgorithmConfig, GetRecommendationRequest, GetRecommendationResponse, ItemAppIdNotSupportedByProvider, RecommendationAlgorithmNotSupported, ListAvailableAlgorithmsResponseNonNullableFields, GetRecommendationResponseNonNullableFields, GetRecommendationOptions, } from './ecom-recommendations-v1-recommendation.universal';

package/build/es/src/ecom-recommendations-v1-recommendation.public.js

@@ -1,14 +0,0 @@
-import { listAvailableAlgorithms as universalListAvailableAlgorithms, getRecommendation as universalGetRecommendation, } from './ecom-recommendations-v1-recommendation.universal';
-export const __metadata = { PACKAGE_NAME: '@wix/ecom' };
-export function listAvailableAlgorithms(httpClient) {
-    return () => universalListAvailableAlgorithms(
-    // @ts-ignore
-    { httpClient });
-}
-export function getRecommendation(httpClient) {
-    return (algorithms, options) => universalGetRecommendation(algorithms, options, 
-    // @ts-ignore
-    { httpClient });
-}
-export { AlgorithmType } from './ecom-recommendations-v1-recommendation.universal';
-//# sourceMappingURL=ecom-recommendations-v1-recommendation.public.js.map

package/build/es/src/ecom-recommendations-v1-recommendation.public.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ecom-recommendations-v1-recommendation.public.js","sourceRoot":"","sources":["../../../src/ecom-recommendations-v1-recommendation.public.ts"],"names":[],"mappings":"AACA,OAAO,EACL,uBAAuB,IAAI,gCAAgC,EAC3D,iBAAiB,IAAI,0BAA0B,GAGhD,MAAM,oDAAoD,CAAC;AAE5D,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC;AAExD,MAAM,UAAU,uBAAuB,CAAC,UAAsB;IAC5D,OAAO,GAAG,EAAE,CACV,gCAAgC;IAC9B,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,UAAsB;IACtD,OAAO,CAAC,UAAuB,EAAE,OAAkC,EAAE,EAAE,CACrE,0BAA0B,CACxB,UAAU,EACV,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,OAAO,EAAE,aAAa,EAAE,MAAM,oDAAoD,CAAC"}

package/build/es/src/ecom-recommendations-v1-recommendation.types.d.ts

@@ -1,136 +0,0 @@
-export interface Recommendation {
-    /** Recommended items. */
-    items?: CatalogReference[];
-    /** The algorithm used to provide the recommendation. */
-    algorithm?: Algorithm;
-}
-/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
-export interface CatalogReference {
-    /** ID of the item within the catalog it belongs to. */
-    catalogItemId?: string;
-    /**
-     * ID of the app providing the catalog.
-     *
-     * You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
-     *
-     * For items from Wix catalogs, the following values always apply:
-     * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
-     * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
-     * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
-     */
-    appId?: string;
-    /**
-     * Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
-     *
-     * For products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration).
-     */
-    options?: Record<string, any> | null;
-}
-export interface Algorithm {
-    /** Algorithm ID defined by the app providing the algorithm. */
-    id?: string;
-    /**
-     * App ID of the Wix or 3rd-party app providing the algorithm.
-     *
-     * Wix app IDs are <a href="https://dev.wix.com/api/rest/getting-started/wix-business-solutions#getting-started_wix-business-solutions_about-wix-business-solutions" target="_blank">listed here</a>.
-     */
-    appId?: string;
-}
-export interface ListAvailableAlgorithmsRequest {
-}
-export interface ListAvailableAlgorithmsResponse {
-    /** Algorithms available for use on your Wix site or project. See the method description for more information. */
-    availableAlgorithms?: AlgorithmInfo[];
-}
-export interface AlgorithmInfo {
-    /** How the algorithm is configured. */
-    config?: AlgorithmConfig;
-    /**
-     * The app ID of the application providing the algorithm.
-     *
-     * Wix app IDs are <a href="https://dev.wix.com/api/rest/getting-started/wix-business-solutions#getting-started_wix-business-solutions_about-wix-business-solutions" target="_blank">listed here</a>.
-     */
-    appId?: string;
-    /**
-     * App IDs of catalogs to which the algorithm can be applied.
-     *
-     * Wix app IDs are <a href="https://dev.wix.com/api/rest/getting-started/wix-business-solutions#getting-started_wix-business-solutions_about-wix-business-solutions" target="_blank">listed here</a>.
-     */
-    catalogAppIds?: string[];
-}
-export interface AlgorithmConfig {
-    /** Algorithm ID. This must be unique for a specific app but does not have to be unique across all apps on the site or in the project. */
-    id?: string;
-    /** Algorithm name. This value is not translatable. */
-    name?: string;
-    /** Algorithm description. This describes how the algorithm works and if it has any limitations regarding site content, number of items in the catalog, site traffic, and so on. This value is not translatable. */
-    description?: string;
-    /** A supplemental `description`. It can be used to help break up and organize information. You can, for example, display this information as a tooltip or as an additional section that is collapsed by default. */
-    additionalInfo?: string | null;
-    /**
-     * Algorithms may have the following types:
-     * * `RELATED_ITEMS` - This type of algorithm provides recommendations based on 1 or more other provided items. For example, when an item is added to a cart, the algorithm can suggest other items frequently bought together with that item.
-     * * `GLOBAL` - This type of algorithm provides general recommendations based on site or project statistics. For example, bestsellers or new arrivals.
-     */
-    algorithmType?: AlgorithmType;
-}
-export declare enum AlgorithmType {
-    UNSPECIFIED = "UNSPECIFIED",
-    RELATED_ITEMS = "RELATED_ITEMS",
-    GLOBAL = "GLOBAL"
-}
-export interface GetRecommendationRequest {
-    /** The set of items for which to get recommendations. Required if the `algorithmType` is `RELATED_ITEMS`. */
-    items?: CatalogReference[];
-    /**
-     * A list of algorithms checked in a specific order determined by their `appID` and their position in the `algorithms` array.
-     * See the method description for more information.
-     *
-     * If no algorithm is able to return at least `minimumRecommendedItems` items, an empty array is returned.
-     */
-    algorithms: Algorithm[];
-    /**
-     * The minimum number of items that must be recommended by the algorithm for those items to be returned in the response.
-     *
-     * Max: `100`
-     */
-    minimumRecommendedItems?: number;
-}
-export interface GetRecommendationResponse {
-    /** An object containing a list of items recommended by 1 of the specified algorithms. The recommendation is empty if none of the specified algorithms recommended enough items. */
-    recommendation?: Recommendation;
-}
-export interface ItemAppIdNotSupportedByProvider {
-    /** Items with an App ID not supported by the provider. Supported App IDs can be found in the provider config in the Dev Center. */
-    items?: CatalogReference[];
-    /** Algorithms that don't support the requested items. */
-    algorithms?: Algorithm[];
-}
-export interface RecommendationAlgorithmNotSupported {
-    /** Algorithms not supported by the provider. */
-    unsupportedAlgorithms?: Algorithm[];
-}
-export interface ListAvailableAlgorithmsResponseNonNullableFields {
-    availableAlgorithms: {
-        config?: {
-            id: string;
-            name: string;
-            description: string;
-            algorithmType: AlgorithmType;
-        };
-        appId: string;
-        catalogAppIds: string[];
-    }[];
-}
-export interface GetRecommendationResponseNonNullableFields {
-    recommendation?: {
-        items: {
-            catalogItemId: string;
-            appId: string;
-        }[];
-        algorithm?: {
-            id: string;
-            appId: string;
-        };
-    };
-}

package/build/es/src/ecom-recommendations-v1-recommendation.types.js

@@ -1,7 +0,0 @@
-export var AlgorithmType;
-(function (AlgorithmType) {
-    AlgorithmType["UNSPECIFIED"] = "UNSPECIFIED";
-    AlgorithmType["RELATED_ITEMS"] = "RELATED_ITEMS";
-    AlgorithmType["GLOBAL"] = "GLOBAL";
-})(AlgorithmType || (AlgorithmType = {}));
-//# sourceMappingURL=ecom-recommendations-v1-recommendation.types.js.map

package/build/es/src/ecom-recommendations-v1-recommendation.types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ecom-recommendations-v1-recommendation.types.js","sourceRoot":"","sources":["../../../src/ecom-recommendations-v1-recommendation.types.ts"],"names":[],"mappings":"AAkFA,MAAM,CAAN,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,4CAA2B,CAAA;IAC3B,gDAA+B,CAAA;IAC/B,kCAAiB,CAAA;AACnB,CAAC,EAJW,aAAa,KAAb,aAAa,QAIxB"}

package/build/es/src/ecom-recommendations-v1-recommendation.universal.d.ts

@@ -1,206 +0,0 @@
-export interface Recommendation {
-    /** Recommended items. */
-    items?: CatalogReference[];
-    /** The algorithm used to provide the recommendation. */
-    algorithm?: Algorithm;
-}
-/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
-export interface CatalogReference {
-    /** ID of the item within the catalog it belongs to. */
-    catalogItemId?: string;
-    /**
-     * ID of the app providing the catalog.
-     *
-     * You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
-     *
-     * For items from Wix catalogs, the following values always apply:
-     * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
-     * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
-     * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
-     */
-    appId?: string;
-    /**
-     * Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
-     *
-     * For products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration).
-     */
-    options?: Record<string, any> | null;
-}
-export interface Algorithm {
-    /** Algorithm ID defined by the app providing the algorithm. */
-    _id?: string;
-    /**
-     * App ID of the Wix or 3rd-party app providing the algorithm.
-     *
-     * Wix app IDs are <a href="https://dev.wix.com/api/rest/getting-started/wix-business-solutions#getting-started_wix-business-solutions_about-wix-business-solutions" target="_blank">listed here</a>.
-     */
-    appId?: string;
-}
-export interface ListAvailableAlgorithmsRequest {
-}
-export interface ListAvailableAlgorithmsResponse {
-    /** Algorithms available for use on your Wix site or project. See the method description for more information. */
-    availableAlgorithms?: AlgorithmInfo[];
-}
-export interface AlgorithmInfo {
-    /** How the algorithm is configured. */
-    config?: AlgorithmConfig;
-    /**
-     * The app ID of the application providing the algorithm.
-     *
-     * Wix app IDs are <a href="https://dev.wix.com/api/rest/getting-started/wix-business-solutions#getting-started_wix-business-solutions_about-wix-business-solutions" target="_blank">listed here</a>.
-     */
-    appId?: string;
-    /**
-     * App IDs of catalogs to which the algorithm can be applied.
-     *
-     * Wix app IDs are <a href="https://dev.wix.com/api/rest/getting-started/wix-business-solutions#getting-started_wix-business-solutions_about-wix-business-solutions" target="_blank">listed here</a>.
-     */
-    catalogAppIds?: string[];
-}
-export interface AlgorithmConfig {
-    /** Algorithm ID. This must be unique for a specific app but does not have to be unique across all apps on the site or in the project. */
-    _id?: string;
-    /** Algorithm name. This value is not translatable. */
-    name?: string;
-    /** Algorithm description. This describes how the algorithm works and if it has any limitations regarding site content, number of items in the catalog, site traffic, and so on. This value is not translatable. */
-    description?: string;
-    /** A supplemental `description`. It can be used to help break up and organize information. You can, for example, display this information as a tooltip or as an additional section that is collapsed by default. */
-    additionalInfo?: string | null;
-    /**
-     * Algorithms may have the following types:
-     * * `RELATED_ITEMS` - This type of algorithm provides recommendations based on 1 or more other provided items. For example, when an item is added to a cart, the algorithm can suggest other items frequently bought together with that item.
-     * * `GLOBAL` - This type of algorithm provides general recommendations based on site or project statistics. For example, bestsellers or new arrivals.
-     */
-    algorithmType?: AlgorithmType;
-}
-export declare enum AlgorithmType {
-    UNSPECIFIED = "UNSPECIFIED",
-    RELATED_ITEMS = "RELATED_ITEMS",
-    GLOBAL = "GLOBAL"
-}
-export interface GetRecommendationRequest {
-    /** The set of items for which to get recommendations. Required if the `algorithmType` is `RELATED_ITEMS`. */
-    items?: CatalogReference[];
-    /**
-     * A list of algorithms checked in a specific order determined by their `appID` and their position in the `algorithms` array.
-     * See the method description for more information.
-     *
-     * If no algorithm is able to return at least `minimumRecommendedItems` items, an empty array is returned.
-     */
-    algorithms: Algorithm[];
-    /**
-     * The minimum number of items that must be recommended by the algorithm for those items to be returned in the response.
-     *
-     * Max: `100`
-     */
-    minimumRecommendedItems?: number;
-}
-export interface GetRecommendationResponse {
-    /** An object containing a list of items recommended by 1 of the specified algorithms. The recommendation is empty if none of the specified algorithms recommended enough items. */
-    recommendation?: Recommendation;
-}
-export interface ItemAppIdNotSupportedByProvider {
-    /** Items with an App ID not supported by the provider. Supported App IDs can be found in the provider config in the Dev Center. */
-    items?: CatalogReference[];
-    /** Algorithms that don't support the requested items. */
-    algorithms?: Algorithm[];
-}
-export interface RecommendationAlgorithmNotSupported {
-    /** Algorithms not supported by the provider. */
-    unsupportedAlgorithms?: Algorithm[];
-}
-export interface ListAvailableAlgorithmsResponseNonNullableFields {
-    availableAlgorithms: {
-        config?: {
-            _id: string;
-            name: string;
-            description: string;
-            algorithmType: AlgorithmType;
-        };
-        appId: string;
-        catalogAppIds: string[];
-    }[];
-}
-export interface GetRecommendationResponseNonNullableFields {
-    recommendation?: {
-        items: {
-            catalogItemId: string;
-            appId: string;
-        }[];
-        algorithm?: {
-            _id: string;
-            appId: string;
-        };
-    };
-}
-/**
- * Returns a list of recommendation algorithms that can be used on your Wix site or project. These algorithms can be used with [`getRecommendation()`](#getRecommendation) to provide item recommendations to the customer.
- *
- * Algorithms are run by the apps that provide them, and can only be used on catalogs they support. Apps may provide algorithms for use with their own catalogs and/or catalogs from other apps.
- *
- * The app which provides an algorithm is referenced by that algorithm’s `appId`. The apps whose catalogs are supported by an algorithm are referenced by the IDs in that algorithm’s `catalogAppIds` array.
- *
- *
- * For an algorithm to be considered “Available” and returned in this method’s response, the algorithm must meet the following conditions:
- * 1. The algorithm’s `appId` must match the ID of an installed Wix app.
- * 2. At least 1 of the IDs in `catalogAppIds` must match the ID of an installed Wix app.
- *
- * Wix app IDs are [listed here](https://dev.wix.com/api/rest/getting-started/wix-business-solutions#getting-started_wix-business-solutions_about-wix-business-solutions).
- * @public
- * @documentationMaturity preview
- * @permissionScope Read eCommerce - all read permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
- * @applicableIdentity APP
- * @applicableIdentity MEMBER
- * @applicableIdentity VISITOR
- */
-export declare function listAvailableAlgorithms(): Promise<ListAvailableAlgorithmsResponse & ListAvailableAlgorithmsResponseNonNullableFields>;
-/**
- * Returns a recommendation object containing a list of items to recommend to the customer.
- *
- * `getRecommendation()` determines which items to recommend based on the given recommendation algorithms.
- *
- * `getRecommendation()` doesn’t run the algorithms. It calls the installed apps that provide them.
- *
- * Apps may provide algorithms for use with their own catalogs, or for use with catalogs from other apps.
- * For example, Wix Stores provides algorithms that can only be used on its own catalogs.
- * To run an algorithm, the app providing it must be installed, and an app providing a supported catalog must be installed.
- * For more information and to see which algorithms are available on your site or project, call [`listAvailableAlgorithms()`](#listavailablealgorithms).
- *
- * `getRecommendation()` operates as follows:
- * 1. `getRecommendation()` receives as input a list of algorithms as an array. These algorithms can be provided by different apps and can apply to different catalogs.
- * 2. `getRecommendation()` calls the app that corresponds to the `appId` of the first algorithm in the list of algorithms. It passes that algorithm’s ID and the IDs of any subsequent algorithms in the array for the same app.
- * 3. The app runs the algorithms.
- * 4. `getRecommendation()` returns items recommendations from the first algorithm (according to its position in the `algorithms` array) that meets the minimum number of recommendations. At that point `getRecommendation()` stops calling other apps.
- * 5. If none of the algorithms run by the first app meet the minimum recommended items, `getRecommendation()` finds the next algorithm in the array with a new `appId` (an ID of an app that has not yet been called), and repeats the process.
- * 6. If no algorithms in the `algorithms` array recommend at least the minimum recommended items, `getRecommendation()` returns an empty array.
- * @param algorithms - A list of algorithms checked in a specific order determined by their `appID` and their position in the `algorithms` array.
- * See the method description for more information.
- *
- * If no algorithm is able to return at least `minimumRecommendedItems` items, an empty array is returned.
- * @public
- * @documentationMaturity preview
- * @requiredField algorithms
- * @requiredField algorithms._id
- * @requiredField algorithms.appId
- * @requiredField options.items.appId
- * @requiredField options.items.catalogItemId
- * @param options - Get recommendation options.
- * @permissionScope Read eCommerce - all read permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
- * @applicableIdentity APP
- * @applicableIdentity MEMBER
- * @applicableIdentity VISITOR
- */
-export declare function getRecommendation(algorithms: Algorithm[], options?: GetRecommendationOptions): Promise<GetRecommendationResponse & GetRecommendationResponseNonNullableFields>;
-export interface GetRecommendationOptions {
-    /** The set of items for which to get recommendations. Required if the `algorithmType` is `RELATED_ITEMS`. */
-    items?: CatalogReference[];
-    /**
-     * The minimum number of items that must be recommended by the algorithm for those items to be returned in the response.
-     *
-     * Max: `100`
-     */
-    minimumRecommendedItems?: number;
-}

package/build/es/src/ecom-recommendations-v1-recommendation.universal.js

@@ -1,179 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import { serializer } from '@wix/metro-runtime/velo';
-import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
-import * as ambassadorWixEcomRecommendationsV1Recommendation from './ecom-recommendations-v1-recommendation.http';
-const _toVeloEntity = '$';
-const _fromVeloEntity = '$';
-export var AlgorithmType;
-(function (AlgorithmType) {
-    AlgorithmType["UNSPECIFIED"] = "UNSPECIFIED";
-    AlgorithmType["RELATED_ITEMS"] = "RELATED_ITEMS";
-    AlgorithmType["GLOBAL"] = "GLOBAL";
-})(AlgorithmType || (AlgorithmType = {}));
-const _getRecommendationRequest = {};
-const _getRecommendationResponse = {};
-const _listAvailableAlgorithmsRequest = {};
-const _listAvailableAlgorithmsResponse = {};
-/**
- * Returns a list of recommendation algorithms that can be used on your Wix site or project. These algorithms can be used with [`getRecommendation()`](#getRecommendation) to provide item recommendations to the customer.
- *
- * Algorithms are run by the apps that provide them, and can only be used on catalogs they support. Apps may provide algorithms for use with their own catalogs and/or catalogs from other apps.
- *
- * The app which provides an algorithm is referenced by that algorithm’s `appId`. The apps whose catalogs are supported by an algorithm are referenced by the IDs in that algorithm’s `catalogAppIds` array.
- *
- *
- * For an algorithm to be considered “Available” and returned in this method’s response, the algorithm must meet the following conditions:
- * 1. The algorithm’s `appId` must match the ID of an installed Wix app.
- * 2. At least 1 of the IDs in `catalogAppIds` must match the ID of an installed Wix app.
- *
- * Wix app IDs are [listed here](https://dev.wix.com/api/rest/getting-started/wix-business-solutions#getting-started_wix-business-solutions_about-wix-business-solutions).
- * @public
- * @documentationMaturity preview
- * @permissionScope Read eCommerce - all read permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
- * @applicableIdentity APP
- * @applicableIdentity MEMBER
- * @applicableIdentity VISITOR
- */
-export function listAvailableAlgorithms() {
-    var _a, _b, _c;
-    return __awaiter(this, arguments, void 0, function* () {
-        const requestTransformation = {};
-        const responseTransformation = '$';
-        // @ts-ignore
-        const { httpClient, sideEffects } = arguments[0];
-        const { toAmbassadorRequest } = serializer({
-            rootSchema: _listAvailableAlgorithmsRequest,
-            depSchemas: {},
-            fqdnTransformation: {
-                paths: [],
-                transformation: _fromVeloEntity,
-            },
-            customTransformation: requestTransformation,
-        });
-        const { fromJSON } = serializer({
-            rootSchema: _listAvailableAlgorithmsResponse,
-            depSchemas: {},
-            fqdnTransformation: {
-                paths: [],
-                transformation: _toVeloEntity,
-            },
-            customTransformation: responseTransformation,
-        });
-        const payload = toAmbassadorRequest([]);
-        const reqOpts = ambassadorWixEcomRecommendationsV1Recommendation.listAvailableAlgorithms(payload);
-        (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
-        try {
-            const result = yield httpClient.request(reqOpts);
-            (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
-            return fromJSON(result.data);
-        }
-        catch (err) {
-            const transformedError = sdkTransformError(err, {
-                spreadPathsToArguments: {},
-                explicitPathsToArguments: {},
-                singleArgumentUnchanged: false,
-            }, []);
-            (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
-            throw transformedError;
-        }
-    });
-}
-/**
- * Returns a recommendation object containing a list of items to recommend to the customer.
- *
- * `getRecommendation()` determines which items to recommend based on the given recommendation algorithms.
- *
- * `getRecommendation()` doesn’t run the algorithms. It calls the installed apps that provide them.
- *
- * Apps may provide algorithms for use with their own catalogs, or for use with catalogs from other apps.
- * For example, Wix Stores provides algorithms that can only be used on its own catalogs.
- * To run an algorithm, the app providing it must be installed, and an app providing a supported catalog must be installed.
- * For more information and to see which algorithms are available on your site or project, call [`listAvailableAlgorithms()`](#listavailablealgorithms).
- *
- * `getRecommendation()` operates as follows:
- * 1. `getRecommendation()` receives as input a list of algorithms as an array. These algorithms can be provided by different apps and can apply to different catalogs.
- * 2. `getRecommendation()` calls the app that corresponds to the `appId` of the first algorithm in the list of algorithms. It passes that algorithm’s ID and the IDs of any subsequent algorithms in the array for the same app.
- * 3. The app runs the algorithms.
- * 4. `getRecommendation()` returns items recommendations from the first algorithm (according to its position in the `algorithms` array) that meets the minimum number of recommendations. At that point `getRecommendation()` stops calling other apps.
- * 5. If none of the algorithms run by the first app meet the minimum recommended items, `getRecommendation()` finds the next algorithm in the array with a new `appId` (an ID of an app that has not yet been called), and repeats the process.
- * 6. If no algorithms in the `algorithms` array recommend at least the minimum recommended items, `getRecommendation()` returns an empty array.
- * @param algorithms - A list of algorithms checked in a specific order determined by their `appID` and their position in the `algorithms` array.
- * See the method description for more information.
- *
- * If no algorithm is able to return at least `minimumRecommendedItems` items, an empty array is returned.
- * @public
- * @documentationMaturity preview
- * @requiredField algorithms
- * @requiredField algorithms._id
- * @requiredField algorithms.appId
- * @requiredField options.items.appId
- * @requiredField options.items.catalogItemId
- * @param options - Get recommendation options.
- * @permissionScope Read eCommerce - all read permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
- * @applicableIdentity APP
- * @applicableIdentity MEMBER
- * @applicableIdentity VISITOR
- */
-export function getRecommendation(algorithms, options) {
-    var _a, _b, _c;
-    return __awaiter(this, arguments, void 0, function* () {
-        const requestTransformation = {
-            algorithms: '$[0]',
-            items: '$[1].items',
-            minimumRecommendedItems: '$[1].minimumRecommendedItems',
-        };
-        const responseTransformation = '$';
-        // @ts-ignore
-        const { httpClient, sideEffects } = arguments[2];
-        const { toAmbassadorRequest } = serializer({
-            rootSchema: _getRecommendationRequest,
-            depSchemas: {},
-            fqdnTransformation: {
-                paths: [],
-                transformation: _fromVeloEntity,
-            },
-            customTransformation: requestTransformation,
-        });
-        const { fromJSON } = serializer({
-            rootSchema: _getRecommendationResponse,
-            depSchemas: {},
-            fqdnTransformation: {
-                paths: [...['recommendation']],
-                transformation: _toVeloEntity,
-            },
-            customTransformation: responseTransformation,
-        });
-        const payload = toAmbassadorRequest([algorithms, options]);
-        const reqOpts = ambassadorWixEcomRecommendationsV1Recommendation.getRecommendation(payload);
-        (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
-        try {
-            const result = yield httpClient.request(reqOpts);
-            (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
-            return fromJSON(result.data);
-        }
-        catch (err) {
-            const transformedError = sdkTransformError(err, {
-                spreadPathsToArguments: {},
-                explicitPathsToArguments: {
-                    algorithms: '$[0]',
-                    items: '$[1].items',
-                    minimumRecommendedItems: '$[1].minimumRecommendedItems',
-                },
-                singleArgumentUnchanged: false,
-            }, ['algorithms', 'options']);
-            (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
-            throw transformedError;
-        }
-    });
-}
-//# sourceMappingURL=ecom-recommendations-v1-recommendation.universal.js.map

package/build/es/src/ecom-recommendations-v1-recommendation.universal.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ecom-recommendations-v1-recommendation.universal.js","sourceRoot":"","sources":["../../../src/ecom-recommendations-v1-recommendation.universal.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAEvF,OAAO,KAAK,gDAAgD,MAAM,+CAA+C,CAAC;AAElH,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;AAoF5B,MAAM,CAAN,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,4CAA2B,CAAA;IAC3B,gDAA+B,CAAA;IAC/B,kCAAiB,CAAA;AACnB,CAAC,EAJW,aAAa,KAAb,aAAa,QAIxB;AAyDD,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,0BAA0B,GAAG,EAAE,CAAC;AACtC,MAAM,+BAA+B,GAAG,EAAE,CAAC;AAC3C,MAAM,gCAAgC,GAAG,EAAE,CAAC;AAE5C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAgB,uBAAuB;;;QAI3C,MAAM,qBAAqB,GAAG,EAAE,CAAC;QACjC,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,UAAU,CAAC;YACzC,UAAU,EAAE,+BAA+B;YAC3C,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC;YAC9B,UAAU,EAAE,gCAAgC;YAC5C,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAC;QAExC,MAAM,OAAO,GACX,gDAAgD,CAAC,uBAAuB,CACtE,OAAO,CACR,CAAC;QAEJ,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,2DAAI,CAAC;QAC5B,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,4DAAG,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;QACtC,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;gBACE,sBAAsB,EAAE,EAAE;gBAC1B,wBAAwB,EAAE,EAAE;gBAC5B,uBAAuB,EAAE,KAAK;aAC/B,EACD,EAAE,CACH,CAAC;YACF,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,4DAAG,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;QACzB,CAAC;;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAM,UAAgB,iBAAiB,CACrC,UAAuB,EACvB,OAAkC;;;QAIlC,MAAM,qBAAqB,GAAG;YAC5B,UAAU,EAAE,MAAM;YAClB,KAAK,EAAE,YAAY;YACnB,uBAAuB,EAAE,8BAA8B;SACxD,CAAC;QACF,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,UAAU,CAAC;YACzC,UAAU,EAAE,yBAAyB;YACrC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC;YAC9B,UAAU,EAAE,0BAA0B;YACtC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;gBAC9B,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;QAE3D,MAAM,OAAO,GACX,gDAAgD,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAE9E,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,2DAAI,CAAC;QAC5B,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,4DAAG,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;QACtC,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;gBACE,sBAAsB,EAAE,EAAE;gBAC1B,wBAAwB,EAAE;oBACxB,UAAU,EAAE,MAAM;oBAClB,KAAK,EAAE,YAAY;oBACnB,uBAAuB,EAAE,8BAA8B;iBACxD;gBACD,uBAAuB,EAAE,KAAK;aAC/B,EACD,CAAC,YAAY,EAAE,SAAS,CAAC,CAC1B,CAAC;YACF,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,4DAAG,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;QACzB,CAAC;;CACF"}

package/build/es/src/ecom-v1-abandoned-checkout.context.d.ts

@@ -1,3 +0,0 @@
-import { getAbandonedCheckout as publicGetAbandonedCheckout } from './ecom-v1-abandoned-checkout.public';
-import { BuildRESTFunction } from '@wix/sdk-types';
-export declare const getAbandonedCheckout: BuildRESTFunction<typeof publicGetAbandonedCheckout>;