@wix/stores 1.0.5 → 1.0.7

package/build/cjs/index.d.ts

@@ -1,2 +1,2 @@
-export * as collections from './src/stores-poc-v1-collection.public';
-export * as products from './src/stores-poc-v1-product.public';
+export * as collections from './src/stores-catalog-v1-collection.public';
+export * as products from './src/stores-catalog-v1-product-products.public';

package/build/cjs/index.js

@@ -20,6 +20,6 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.products = exports.collections = void 0;
-exports.collections = __importStar(require("./src/stores-poc-v1-collection.public"));
-exports.products = __importStar(require("./src/stores-poc-v1-product.public"));
+exports.collections = __importStar(require("./src/stores-catalog-v1-collection.public"));
+exports.products = __importStar(require("./src/stores-catalog-v1-product-products.public"));
 //# sourceMappingURL=index.js.map

package/build/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,qFAAqE;AACrE,+EAA+D"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,yFAAyE;AACzE,4FAA4E"}

package/build/cjs/src/{stores-poc-v1-collection.http.d.ts → stores-catalog-v1-collection.http.d.ts}

@@ -1,4 +1,9 @@
 import { RequestOptionsFactory } from '@wix/sdk-types';
-import { GetCollectionRequest, GetCollectionResponse, QueryCollectionsRequest, QueryCollectionsResponse } from './stores-poc-v1-collection.types';
-export declare function getCollection(payload: GetCollectionRequest): RequestOptionsFactory<GetCollectionResponse>;
+import { GetCollectionRequest, GetCollectionResponse, QueryCollectionsRequest, QueryCollectionsResponse } from './stores-catalog-v1-collection.types';
+/**
+ * Retrieves a list of up to 100 collections, given the provided paging, sorting and filtering.
+ * See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.
+ */
 export declare function queryCollections(payload: QueryCollectionsRequest): RequestOptionsFactory<QueryCollectionsResponse>;
+/** Retrieves a collection with the provided ID. */
+export declare function getCollection(payload: GetCollectionRequest): RequestOptionsFactory<GetCollectionResponse>;

package/build/cjs/src/{stores-poc-v1-collection.http.js → stores-catalog-v1-collection.http.js}

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.queryCollections = exports.getCollection = void 0;
+exports.getCollection = exports.queryCollections = void 0;
 const metro_runtime_1 = require("@wix/metro-runtime");
 const ambassador_1 = require("@wix/metro-runtime/ambassador");
 const metro_runtime_2 = require("@wix/metro-runtime");
@@ -8,91 +8,94 @@ const _getCollectionRequest = {};
 const _getCollectionResponse = {};
 const _queryCollectionsRequest = {};
 const _queryCollectionsResponse = {};
-function resolveWixCoreservicesMetroinspectorV1CollectionsPocCollectionsPocServiceUrl(opts) {
+function resolveWixCatalogApiV2CollectionReadApiUrl(opts) {
     const domainToMappings = {
-        'apps._base_domain_': [
+        'api._api_base_domain_': [
             {
-                srcPath: '/_api/metro-inspector',
-                destPath: '/api',
+                srcPath: '/wix-ecommerce-catalog-reader-web',
+                destPath: '',
             },
         ],
-        'api._api_base_domain_': [
+        'www._base_domain_': [
             {
-                srcPath: '/metro-inspector',
+                srcPath: '/wix-ecommerce-catalog-reader-web',
                 destPath: '',
             },
-        ],
-        _: [
             {
-                srcPath: '/metro-inspector',
-                destPath: '/api',
+                srcPath: '/_api/catalog-reader-server',
+                destPath: '',
             },
+        ],
+        '*.dev.wix-code.com': [
             {
-                srcPath: '/_api/metro-inspector',
-                destPath: '/api',
+                srcPath: '/_api/catalog-reader-server',
+                destPath: '',
             },
         ],
-        'www._base_domain_': [
+        _: [
             {
-                srcPath: '/metro-inspector',
-                destPath: '/api',
+                srcPath: '/_api/catalog-reader-server',
+                destPath: '',
             },
         ],
         'manage._base_domain_': [
             {
-                srcPath: '/metro-inspector',
+                srcPath: '/wix-ecommerce-catalog-reader-web',
                 destPath: '',
             },
-        ],
-        'www.wixgateway.com': [
             {
-                srcPath: '/_api/metro-inspector',
-                destPath: '/api',
+                srcPath: '/_api/catalog-reader-server',
+                destPath: '',
             },
         ],
     };
     return metro_runtime_2.resolveUrl(Object.assign(opts, { domainToMappings }));
 }
-function getCollection(payload) {
-    const { toJSON: toReq, fromJSON: fromReq } = ambassador_1.serializer(_getCollectionRequest, {});
-    const { fromJSON: fromRes } = ambassador_1.serializer(_getCollectionResponse, {});
-    function __getCollection({ host }) {
+/**
+ * Retrieves a list of up to 100 collections, given the provided paging, sorting and filtering.
+ * See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.
+ */
+function queryCollections(payload) {
+    const { toJSON: toReq, fromJSON: fromReq } = ambassador_1.serializer(_queryCollectionsRequest, {});
+    const { fromJSON: fromRes } = ambassador_1.serializer(_queryCollectionsResponse, {});
+    function __queryCollections({ host }) {
         const serializedData = toReq(payload);
         const metadata = {
-            method: 'GET',
-            url: resolveWixCoreservicesMetroinspectorV1CollectionsPocCollectionsPocServiceUrl({
-                protoPath: '/api/v1/collections-stores-poc/{collectionId}',
+            method: 'POST',
+            url: resolveWixCatalogApiV2CollectionReadApiUrl({
+                protoPath: '/v2/collections/query',
                 data: serializedData,
                 host,
             }),
-            params: metro_runtime_1.toURLSearchParams(serializedData),
+            data: serializedData,
             transformResponse: fromRes,
         };
         return metadata;
     }
-    __getCollection.fromReq = fromReq;
-    return __getCollection;
+    __queryCollections.fromReq = fromReq;
+    return __queryCollections;
 }
-exports.getCollection = getCollection;
-function queryCollections(payload) {
-    const { toJSON: toReq, fromJSON: fromReq } = ambassador_1.serializer(_queryCollectionsRequest, {});
-    const { fromJSON: fromRes } = ambassador_1.serializer(_queryCollectionsResponse, {});
-    function __queryCollections({ host }) {
+exports.queryCollections = queryCollections;
+/** Retrieves a collection with the provided ID. */
+function getCollection(payload) {
+    const { toJSON: toReq, fromJSON: fromReq } = ambassador_1.serializer(_getCollectionRequest, {});
+    const { fromJSON: fromRes } = ambassador_1.serializer(_getCollectionResponse, {});
+    function __getCollection({ host }) {
         const serializedData = toReq(payload);
         const metadata = {
-            method: 'POST',
-            url: resolveWixCoreservicesMetroinspectorV1CollectionsPocCollectionsPocServiceUrl({
-                protoPath: '/api/v1/collections-stores-poc/query',
+            method: 'GET',
+            url: resolveWixCatalogApiV2CollectionReadApiUrl({
+                protoPath: '/v2/collections/{id}',
                 data: serializedData,
                 host,
             }),
-            data: serializedData,
+            params: metro_runtime_1.toURLSearchParams(serializedData),
             transformResponse: fromRes,
         };
         return metadata;
     }
-    __queryCollections.fromReq = fromReq;
-    return __queryCollections;
+    __getCollection.fromReq = fromReq;
+    return __getCollection;
 }
-exports.queryCollections = queryCollections;
-//# sourceMappingURL=stores-poc-v1-collection.http.js.map
+exports.getCollection = getCollection;
+//# sourceMappingURL=stores-catalog-v1-collection.http.js.map

package/build/cjs/src/stores-catalog-v1-collection.http.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stores-catalog-v1-collection.http.js","sourceRoot":"","sources":["../../../src/stores-catalog-v1-collection.http.ts"],"names":[],"mappings":";;;AAAA,sDAAuD;AACvD,8DAA2D;AAC3D,sDAAgD;AAUhD,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACjC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAClC,MAAM,wBAAwB,GAAG,EAAE,CAAC;AACpC,MAAM,yBAAyB,GAAG,EAAE,CAAC;AAErC,SAAS,0CAA0C,CACjD,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,uBAAuB,EAAE;YACvB;gBACE,OAAO,EAAE,mCAAmC;gBAC5C,QAAQ,EAAE,EAAE;aACb;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,mCAAmC;gBAC5C,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,6BAA6B;gBACtC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,6BAA6B;gBACtC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,CAAC,EAAE;YACD;gBACE,OAAO,EAAE,6BAA6B;gBACtC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,mCAAmC;gBAC5C,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,6BAA6B;gBACtC,QAAQ,EAAE,EAAE;aACb;SACF;KACF,CAAC;IAEF,OAAO,0BAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;GAGG;AACH,SAAgB,gBAAgB,CAC9B,OAAgC;IAEhC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,uBAAU,CACrD,wBAAwB,EACxB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,uBAAU,CAAC,yBAAyB,EAAE,EAAE,CAAC,CAAC;IAExE,SAAS,kBAAkB,CAAC,EAAE,IAAI,EAAO;QACvC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,MAAM,EAAE,MAAa;YACrB,GAAG,EAAE,0CAA0C,CAAC;gBAC9C,SAAS,EAAE,uBAAuB;gBAClC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,kBAAkB,CAAC,OAAO,GAAG,OAAO,CAAC;IAErC,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AA5BD,4CA4BC;AAED,mDAAmD;AACnD,SAAgB,aAAa,CAC3B,OAA6B;IAE7B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,uBAAU,CACrD,qBAAqB,EACrB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,uBAAU,CAAC,sBAAsB,EAAE,EAAE,CAAC,CAAC;IAErE,SAAS,eAAe,CAAC,EAAE,IAAI,EAAO;QACpC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,MAAM,EAAE,KAAY;YACpB,GAAG,EAAE,0CAA0C,CAAC;gBAC9C,SAAS,EAAE,sBAAsB;gBACjC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,MAAM,EAAE,iCAAiB,CAAC,cAAc,CAAC;YACzC,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,eAAe,CAAC,OAAO,GAAG,OAAO,CAAC;IAElC,OAAO,eAAe,CAAC;AACzB,CAAC;AA5BD,sCA4BC"}

package/build/cjs/src/stores-catalog-v1-collection.public.d.ts

@@ -0,0 +1,5 @@
+import { HttpClient } from '@wix/sdk-types';
+export declare function queryCollections(httpClient: HttpClient): () => import("./stores-catalog-v1-collection.universal").CollectionsQueryBuilder;
+export declare function getCollection(httpClient: HttpClient): (_id: string) => Promise<import("./stores-catalog-v1-collection.universal").Collection>;
+export { MediaItemType, SortOrder, } from './stores-catalog-v1-collection.universal';
+export { Collection, Media, MediaItem, MediaItemItemOneOf, MediaItemUrlAndSize, MediaItemVideo, SeoSchema, Tag, Settings, QueryCollectionsRequest, PlatformQuery, PlatformQueryPagingMethodOneOf, Sorting, PlatformPaging, CursorPaging, QueryCollectionsResponse, PlatformPagingMetadata, Cursors, GetCollectionRequest, GetCollectionResponse, CollectionsQueryResult, CollectionsQueryBuilder, } from './stores-catalog-v1-collection.universal';

package/build/cjs/src/stores-catalog-v1-collection.public.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SortOrder = exports.MediaItemType = exports.getCollection = exports.queryCollections = void 0;
+const stores_catalog_v1_collection_universal_1 = require("./stores-catalog-v1-collection.universal");
+function queryCollections(httpClient) {
+    return () => stores_catalog_v1_collection_universal_1.queryCollections(
+    // @ts-ignore
+    { httpClient });
+}
+exports.queryCollections = queryCollections;
+function getCollection(httpClient) {
+    return (_id) => stores_catalog_v1_collection_universal_1.getCollection(_id, 
+    // @ts-ignore
+    { httpClient });
+}
+exports.getCollection = getCollection;
+var stores_catalog_v1_collection_universal_2 = require("./stores-catalog-v1-collection.universal");
+Object.defineProperty(exports, "MediaItemType", { enumerable: true, get: function () { return stores_catalog_v1_collection_universal_2.MediaItemType; } });
+Object.defineProperty(exports, "SortOrder", { enumerable: true, get: function () { return stores_catalog_v1_collection_universal_2.SortOrder; } });
+//# sourceMappingURL=stores-catalog-v1-collection.public.js.map

package/build/cjs/src/stores-catalog-v1-collection.public.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stores-catalog-v1-collection.public.js","sourceRoot":"","sources":["../../../src/stores-catalog-v1-collection.public.ts"],"names":[],"mappings":";;;AACA,qGAGkD;AAElD,SAAgB,gBAAgB,CAAC,UAAsB;IACrD,OAAO,GAAG,EAAE,CACV,yDAAyB;IACvB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAND,4CAMC;AAED,SAAgB,aAAa,CAAC,UAAsB;IAClD,OAAO,CAAC,GAAW,EAAE,EAAE,CACrB,sDAAsB,CACpB,GAAG;IACH,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,sCAOC;AAED,mGAGkD;AAFhD,uIAAA,aAAa,OAAA;AACb,mIAAA,SAAS,OAAA"}

package/build/cjs/src/{stores-poc-v1-collection.types.d.ts → stores-catalog-v1-collection.types.d.ts}

@@ -76,26 +76,37 @@ export interface MediaItemVideo {
     /** ID of an image taken from the video. Used primarily for Wix Search indexing. For example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`. */
     stillFrameMediaId?: string;
 }
-export interface GetCollectionRequest {
-    /** Requested collection ID. */
-    collectionId: string;
-    /**
-     * Whether to return the `collection.numberOfProducts` field in the response.
-     * Defaults to false, in which case the value of `collection.numberOfProducts` will be 0.
-     */
-    includeNumberOfProducts?: boolean;
-    /** Include description in response. When False, description will be null */
-    includeDescription?: boolean;
-}
-export interface GetCollectionResponse {
-    collection?: Collection;
+/**
+ * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
+ * The search engines use this information for ranking purposes, or to display snippets in the search results.
+ * This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
+ */
+export interface SeoSchema {
+    /** SEO tags information. */
+    tags?: Tag[];
+    /** SEO general settings. */
+    settings?: Settings;
+}
+export interface Tag {
+    /** SEO tag type. Supported values: `title`, `meta`, `script`, `link`. */
+    type?: string;
+    /** SEO tag attributes/properties (name, content, rel, href). */
+    props?: Record<string, any> | null;
+    /** Tag meta data, e.g. {height: 300, width: 240}. */
+    meta?: Record<string, any> | null;
+    /** Tag inner content e.g. `<title> inner content </title>`. */
+    children?: string;
+    /** Whether the tag is a custom tag. */
+    custom?: boolean;
+    /** Whether the tag is disabled. */
+    disabled?: boolean;
+}
+export interface Settings {
+    /** disable auto creation of 301 redirects on slug changes (enabled by default). */
+    preventAutoRedirect?: boolean;
 }
 export interface QueryCollectionsRequest {
     query?: PlatformQuery;
-    /** Whether number of products should be included in the response. */
-    includeNumberOfProducts?: boolean;
-    /** Include description in response. When False, description will be null */
-    includeDescription?: boolean;
 }
 export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
     /** Filter object. */
@@ -104,11 +115,15 @@ export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
     sort?: Sorting[];
     /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
     paging?: PlatformPaging;
+    /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
 }
 /** @oneof */
 export interface PlatformQueryPagingMethodOneOf {
     /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
     paging?: PlatformPaging;
+    /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
 }
 export interface Sorting {
     /** Name of the field to sort by. */
@@ -126,6 +141,18 @@ export interface PlatformPaging {
     /** Number of items to skip in the current sort order. */
     offset?: number | null;
 }
+export interface CursorPaging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get the relevant cursor token
+     * from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
 export interface QueryCollectionsResponse {
     collections?: Collection[];
     metadata?: PlatformPagingMetadata;
@@ -146,3 +173,10 @@ export interface Cursors {
     /** Cursor pointing to previous page in the list of results. */
     prev?: string | null;
 }
+export interface GetCollectionRequest {
+    /** Requested collection ID. */
+    id: string;
+}
+export interface GetCollectionResponse {
+    collection?: Collection;
+}

package/build/cjs/src/{stores-poc-v1-collection.types.js → stores-catalog-v1-collection.types.js}

@@ -15,4 +15,4 @@ var SortOrder;
     SortOrder["ASC"] = "ASC";
     SortOrder["DESC"] = "DESC";
 })(SortOrder = exports.SortOrder || (exports.SortOrder = {}));
-//# sourceMappingURL=stores-poc-v1-collection.types.js.map
+//# sourceMappingURL=stores-catalog-v1-collection.types.js.map

package/build/cjs/src/stores-catalog-v1-collection.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stores-catalog-v1-collection.types.js","sourceRoot":"","sources":["../../../src/stores-catalog-v1-collection.types.ts"],"names":[],"mappings":";;;AAqEA,IAAY,aAOX;AAPD,WAAY,aAAa;IACvB,4EAA2D,CAAA;IAC3D,gCAAe,CAAA;IACf,gCAAe,CAAA;IACf,gCAAe,CAAA;IACf,sCAAqB,CAAA;IACrB,4BAAW,CAAA;AACb,CAAC,EAPW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAOxB;AAuED,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB"}

package/build/cjs/src/{stores-poc-v1-collection.universal.d.ts → stores-catalog-v1-collection.universal.d.ts}

@@ -82,26 +82,37 @@ export interface MediaItemVideo {
     /** ID of an image taken from the video. Used primarily for Wix Search indexing. For example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`. */
     stillFrameMediaId?: string;
 }
-export interface GetCollectionRequest {
-    /** Requested collection ID. */
-    collectionId: string;
-    /**
-     * Whether to return the `collection.numberOfProducts` field in the response.
-     * Defaults to false, in which case the value of `collection.numberOfProducts` will be 0.
-     */
-    includeNumberOfProducts?: boolean;
-    /** Include description in response. When False, description will be null */
-    includeDescription?: boolean;
-}
-export interface GetCollectionResponse {
-    collection?: Collection;
+/**
+ * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
+ * The search engines use this information for ranking purposes, or to display snippets in the search results.
+ * This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
+ */
+export interface SeoSchema {
+    /** SEO tags information. */
+    tags?: Tag[];
+    /** SEO general settings. */
+    settings?: Settings;
+}
+export interface Tag {
+    /** SEO tag type. Supported values: `title`, `meta`, `script`, `link`. */
+    type?: string;
+    /** SEO tag attributes/properties (name, content, rel, href). */
+    props?: Record<string, any> | null;
+    /** Tag meta data, e.g. {height: 300, width: 240}. */
+    meta?: Record<string, any> | null;
+    /** Tag inner content e.g. `<title> inner content </title>`. */
+    children?: string;
+    /** Whether the tag is a custom tag. */
+    custom?: boolean;
+    /** Whether the tag is disabled. */
+    disabled?: boolean;
+}
+export interface Settings {
+    /** disable auto creation of 301 redirects on slug changes (enabled by default). */
+    preventAutoRedirect?: boolean;
 }
 export interface QueryCollectionsRequest {
     query?: PlatformQuery;
-    /** Whether number of products should be included in the response. */
-    includeNumberOfProducts?: boolean;
-    /** Include description in response. When False, description will be null */
-    includeDescription?: boolean;
 }
 export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
     /** Filter object. */
@@ -110,11 +121,15 @@ export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
     sort?: Sorting[];
     /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
     paging?: PlatformPaging;
+    /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
 }
 /** @oneof */
 export interface PlatformQueryPagingMethodOneOf {
     /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
     paging?: PlatformPaging;
+    /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
 }
 export interface Sorting {
     /** Name of the field to sort by. */
@@ -132,6 +147,18 @@ export interface PlatformPaging {
     /** Number of items to skip in the current sort order. */
     offset?: number | null;
 }
+export interface CursorPaging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get the relevant cursor token
+     * from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
 export interface QueryCollectionsResponse {
     collections?: Collection[];
     metadata?: PlatformPagingMetadata;
@@ -152,32 +179,25 @@ export interface Cursors {
     /** Cursor pointing to previous page in the list of results. */
     prev?: string | null;
 }
-/** @param collectionId - Requested collection ID.
- * @public
- * @requiredField collectionId
- */
-export declare function getCollection(collectionId: string, options?: GetCollectionOptions): Promise<Collection>;
-export interface GetCollectionOptions {
-    /**
-     * Whether to return the `collection.numberOfProducts` field in the response.
-     * Defaults to false, in which case the value of `collection.numberOfProducts` will be 0.
-     */
-    includeNumberOfProducts?: boolean;
-    /** Include description in response. When False, description will be null */
-    includeDescription?: boolean;
+export interface GetCollectionRequest {
+    /** Requested collection ID. */
+    _id: string;
+}
+export interface GetCollectionResponse {
+    collection?: Collection;
 }
-/** @public */
+/**
+ * Retrieves a list of up to 100 collections, given the provided paging, sorting and filtering.
+ * See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.
+ * @public */
 export declare function queryCollections(): CollectionsQueryBuilder;
-interface QueryOffsetResult {
-    currentPage: number;
-    totalPages: number;
-    totalCount: number;
+interface QueryCursorResult {
     hasNext: () => boolean;
     hasPrev: () => boolean;
     length: number;
     pageSize: number;
 }
-export interface CollectionsQueryResult extends QueryOffsetResult {
+export interface CollectionsQueryResult extends QueryCursorResult {
     items: Collection[];
     query: CollectionsQueryBuilder;
     next: () => Promise<CollectionsQueryResult>;
@@ -208,8 +228,13 @@ export interface CollectionsQueryBuilder {
     descending: (...propertyNames: string[]) => CollectionsQueryBuilder;
     /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
     limit: (limit: number) => CollectionsQueryBuilder;
-    /** @param skip - Number of items to skip in the query results before returning the results. */
-    skip: (skip: number) => CollectionsQueryBuilder;
     find: () => Promise<CollectionsQueryResult>;
 }
+/**
+ * Retrieves a collection with the provided ID.
+ * @param _id - Requested collection ID.
+ * @public
+ * @requiredField _id
+ */
+export declare function getCollection(_id: string): Promise<Collection>;
 export {};

package/build/cjs/src/{stores-poc-v1-collection.universal.js → stores-catalog-v1-collection.universal.js}

@@ -28,9 +28,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.queryCollections = exports.getCollection = exports.SortOrder = exports.MediaItemType = exports.__debug = void 0;
+exports.getCollection = exports.queryCollections = exports.SortOrder = exports.MediaItemType = exports.__debug = void 0;
 const velo_1 = require("@wix/metro-runtime/velo");
-const ambassadorWixStoresPocV1Collection = __importStar(require("./stores-poc-v1-collection.http"));
+const ambassadorWixStoresCatalogV1Collection = __importStar(require("./stores-catalog-v1-collection.http"));
 // @ts-ignore
 const motion_edm_autogen_query_wrapper_1 = require("@wix/motion-edm-autogen-query-wrapper");
 let __verbose = false;
@@ -66,56 +66,10 @@ const _getCollectionRequest = {};
 const _getCollectionResponse = {};
 const _queryCollectionsRequest = {};
 const _queryCollectionsResponse = {};
-/** @param collectionId - Requested collection ID.
- * @public
- * @requiredField collectionId
- */
-function getCollection(collectionId, options) {
-    return __awaiter(this, arguments, void 0, function* () {
-        const requestTransformation = {
-            collectionId: '$[0]',
-            includeNumberOfProducts: '$[1].includeNumberOfProducts',
-            includeDescription: '$[1].includeDescription',
-        };
-        const responseTransformation = '$.collection';
-        // @ts-ignore
-        const httpClient = arguments[2].httpClient;
-        const { toAmbassadorRequest } = velo_1.serializer({
-            rootSchema: _getCollectionRequest,
-            depSchemas: {},
-            fqdnTransformation: {
-                paths: [],
-                transformation: _fromVeloEntity,
-            },
-            customTransformation: requestTransformation,
-        });
-        const { fromJSON } = velo_1.serializer({
-            rootSchema: _getCollectionResponse,
-            depSchemas: {},
-            fqdnTransformation: {
-                paths: [...['collection']],
-                transformation: _toVeloEntity,
-            },
-            customTransformation: responseTransformation,
-        });
-        const payload = toAmbassadorRequest([collectionId, options]);
-        const reqOpts = ambassadorWixStoresPocV1Collection.getCollection(payload);
-        __log(`"GetCollection" sending request with: ${__inspect(reqOpts)}`);
-        try {
-            const { data } = yield httpClient.request(reqOpts);
-            return fromJSON(data);
-        }
-        catch (err) {
-            const transformedError = velo_1.transformError(err, requestTransformation, [
-                'collectionId',
-                'options',
-            ]);
-            throw transformedError;
-        }
-    });
-}
-exports.getCollection = getCollection;
-/** @public */
+/**
+ * Retrieves a list of up to 100 collections, given the provided paging, sorting and filtering.
+ * See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.
+ * @public */
 function queryCollections() {
     const requestTransformation = { '*': '$[1]', query: '$[0]' };
     const responseTransformation = {
@@ -144,7 +98,7 @@ function queryCollections() {
     });
     return motion_edm_autogen_query_wrapper_1.wrapWithQueryBuilder({
         func: (payload) => {
-            const reqOpts = ambassadorWixStoresPocV1Collection.queryCollections(payload);
+            const reqOpts = ambassadorWixStoresCatalogV1Collection.queryCollections(payload);
             return httpClient.request(reqOpts);
         },
         requestTransformer: (...args) => toAmbassadorRequest(args),
@@ -153,9 +107,55 @@ function queryCollections() {
             const transformedError = velo_1.transformError(err, requestTransformation);
             throw transformedError;
         },
-        pagingMethod: 'OFFSET',
+        pagingMethod: 'CURSOR',
         transformationPaths: velo_1.resolveQueryFieldsTransformationPaths(_toVeloEntity),
     })({ cursorWithEmptyFilterAndSort: true });
 }
 exports.queryCollections = queryCollections;
-//# sourceMappingURL=stores-poc-v1-collection.universal.js.map
+/**
+ * Retrieves a collection with the provided ID.
+ * @param _id - Requested collection ID.
+ * @public
+ * @requiredField _id
+ */
+function getCollection(_id) {
+    return __awaiter(this, arguments, void 0, function* () {
+        const requestTransformation = { id: '$[0]' };
+        const responseTransformation = '$.collection';
+        // @ts-ignore
+        const httpClient = arguments[1].httpClient;
+        const { toAmbassadorRequest } = velo_1.serializer({
+            rootSchema: _getCollectionRequest,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _fromVeloEntity,
+            },
+            customTransformation: requestTransformation,
+        });
+        const { fromJSON } = velo_1.serializer({
+            rootSchema: _getCollectionResponse,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [...['collection']],
+                transformation: _toVeloEntity,
+            },
+            customTransformation: responseTransformation,
+        });
+        const payload = toAmbassadorRequest([_id]);
+        const reqOpts = ambassadorWixStoresCatalogV1Collection.getCollection(payload);
+        __log(`"GetCollection" sending request with: ${__inspect(reqOpts)}`);
+        try {
+            const { data } = yield httpClient.request(reqOpts);
+            return fromJSON(data);
+        }
+        catch (err) {
+            const transformedError = velo_1.transformError(err, requestTransformation, [
+                '_id',
+            ]);
+            throw transformedError;
+        }
+    });
+}
+exports.getCollection = getCollection;
+//# sourceMappingURL=stores-catalog-v1-collection.universal.js.map

package/build/cjs/src/stores-catalog-v1-collection.universal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stores-catalog-v1-collection.universal.js","sourceRoot":"","sources":["../../../src/stores-catalog-v1-collection.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAIiC;AAEjC,4GAA8F;AAC9F,aAAa;AACb,4FAA6E;AAE7E,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB,SAAS,KAAK,CAAC,GAAG,IAAW;IAC3B,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAEY,QAAA,OAAO,GAAG;IACrB,cAAc,EAAE;QACd,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC;KAC/B;CACF,CAAC;AACF,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;AAuE5B,IAAY,aAOX;AAPD,WAAY,aAAa;IACvB,4EAA2D,CAAA;IAC3D,gCAAe,CAAA;IACf,gCAAe,CAAA;IACf,gCAAe,CAAA;IACf,sCAAqB,CAAA;IACrB,4BAAW,CAAA;AACb,CAAC,EAPW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAOxB;AAuED,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB;AAsDD,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACjC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAClC,MAAM,wBAAwB,GAAG,EAAE,CAAC;AACpC,MAAM,yBAAyB,GAAG,EAAE,CAAC;AAErC;;;aAGa;AACb,SAAgB,gBAAgB;IAC9B,MAAM,qBAAqB,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;IAC7D,MAAM,sBAAsB,GAAG;QAC7B,KAAK,EAAE,eAAe;QACtB,cAAc,EAAE,YAAY;KAC7B,CAAC;IAEF,aAAa;IACb,MAAM,UAAU,GAAe,SAAS,CAAC,CAAC,CAAC,CAAC,UAAwB,CAAC;IAErE,MAAM,EAAE,mBAAmB,EAAE,GAAG,iBAAU,CAAC;QACzC,UAAU,EAAE,wBAAwB;QACpC,UAAU,EAAE,EAAE;QACd,kBAAkB,EAAE;YAClB,KAAK,EAAE,EAAE;YACT,cAAc,EAAE,eAAe;SAChC;QACD,oBAAoB,EAAE,qBAAqB;KAC5C,CAAC,CAAC;IAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,iBAAU,CAAC;QAC9B,UAAU,EAAE,yBAAyB;QACrC,UAAU,EAAE,EAAE;QACd,kBAAkB,EAAE;YAClB,KAAK,EAAE,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;YACjC,cAAc,EAAE,aAAa;SAC9B;QACD,oBAAoB,EAAE,sBAAsB;KAC7C,CAAC,CAAC;IAEH,OAAO,uDAAoB,CAAC;QAC1B,IAAI,EAAE,CAAC,OAAY,EAAE,EAAE;YACrB,MAAM,OAAO,GACX,sCAAsC,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAEnE,OAAO,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACrC,CAAC;QACD,kBAAkB,EAAE,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC;QACjE,mBAAmB,EAAE,CAAC,EAAE,IAAI,EAAO,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC;QACtD,gBAAgB,EAAE,CAAC,GAAQ,EAAE,EAAE;YAC7B,MAAM,gBAAgB,GAAG,qBAAc,CAAC,GAAG,EAAE,qBAAqB,CAAC,CAAC;YAEpE,MAAM,gBAAgB,CAAC;QACzB,CAAC;QACD,YAAY,EAAE,QAAQ;QACtB,mBAAmB,EAAE,4CAAqC,CAAC,aAAa,CAAC;KAC1E,CAAC,CAAC,EAAE,4BAA4B,EAAE,IAAI,EAAE,CAAC,CAAC;AAC7C,CAAC;AA/CD,4CA+CC;AA4CD;;;;;GAKG;AACH,SAAsB,aAAa,CAAC,GAAW;;QAC7C,MAAM,qBAAqB,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC;QAC7C,MAAM,sBAAsB,GAAG,cAAc,CAAC;QAE9C,aAAa;QACb,MAAM,UAAU,GAAe,SAAS,CAAC,CAAC,CAAC,CAAC,UAAwB,CAAC;QAErE,MAAM,EAAE,mBAAmB,EAAE,GAAG,iBAAU,CAAC;YACzC,UAAU,EAAE,qBAAqB;YACjC,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,iBAAU,CAAC;YAC9B,UAAU,EAAE,sBAAsB;YAClC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;gBAC1B,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAE3C,MAAM,OAAO,GAAG,sCAAsC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAE9E,KAAK,CAAC,yCAAyC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAErE,IAAI;YACF,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAEnD,OAAO,QAAQ,CAAC,IAAI,CAAQ,CAAC;SAC9B;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,qBAAc,CAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,KAAK;aACN,CAAC,CAAC;YAEH,MAAM,gBAAgB,CAAC;SACxB;IACH,CAAC;CAAA;AA5CD,sCA4CC"}