@wix/stores 1.0.4 → 1.0.6

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

@@ -8,7 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { serializer, transformError, resolveQueryFieldsTransformationPaths, } from '@wix/metro-runtime/velo';
-import * as ambassadorWixStoresPocV1Collection from './stores-poc-v1-collection.http';
+import * as ambassadorWixStoresCatalogV1Collection from './stores-catalog-v1-collection.http';
 // @ts-ignore
 import { wrapWithQueryBuilder } from '@wix/motion-edm-autogen-query-wrapper';
 let __verbose = false;
@@ -44,55 +44,10 @@ const _getCollectionRequest = {};
 const _getCollectionResponse = {};
 const _queryCollectionsRequest = {};
 const _queryCollectionsResponse = {};
-/** @param collectionId - Requested collection ID.
- * @public
- * @requiredField collectionId
- */
-export 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 } = serializer({
-            rootSchema: _getCollectionRequest,
-            depSchemas: {},
-            fqdnTransformation: {
-                paths: [],
-                transformation: _fromVeloEntity,
-            },
-            customTransformation: requestTransformation,
-        });
-        const { fromJSON } = 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 = transformError(err, requestTransformation, [
-                'collectionId',
-                'options',
-            ]);
-            throw transformedError;
-        }
-    });
-}
-/** @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 function queryCollections() {
     const requestTransformation = { '*': '$[1]', query: '$[0]' };
     const responseTransformation = {
@@ -121,7 +76,7 @@ export function queryCollections() {
     });
     return wrapWithQueryBuilder({
         func: (payload) => {
-            const reqOpts = ambassadorWixStoresPocV1Collection.queryCollections(payload);
+            const reqOpts = ambassadorWixStoresCatalogV1Collection.queryCollections(payload);
             return httpClient.request(reqOpts);
         },
         requestTransformer: (...args) => toAmbassadorRequest(args),
@@ -130,8 +85,53 @@ export function queryCollections() {
             const transformedError = transformError(err, requestTransformation);
             throw transformedError;
         },
-        pagingMethod: 'OFFSET',
+        pagingMethod: 'CURSOR',
         transformationPaths: resolveQueryFieldsTransformationPaths(_toVeloEntity),
     })({ cursorWithEmptyFilterAndSort: true });
 }
-//# sourceMappingURL=stores-poc-v1-collection.universal.js.map
+/**
+ * Retrieves a collection with the provided ID.
+ * @param _id - Requested collection ID.
+ * @public
+ * @requiredField _id
+ */
+export 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 } = serializer({
+            rootSchema: _getCollectionRequest,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _fromVeloEntity,
+            },
+            customTransformation: requestTransformation,
+        });
+        const { fromJSON } = 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 = transformError(err, requestTransformation, [
+                '_id',
+            ]);
+            throw transformedError;
+        }
+    });
+}
+//# sourceMappingURL=stores-catalog-v1-collection.universal.js.map

package/build/es/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,OAAO,EACL,UAAU,EACV,cAAc,EACd,qCAAqC,GACtC,MAAM,yBAAyB,CAAC;AAEjC,OAAO,KAAK,sCAAsC,MAAM,qCAAqC,CAAC;AAC9F,aAAa;AACb,OAAO,EAAE,oBAAoB,EAAE,MAAM,uCAAuC,CAAC;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;AAED,MAAM,CAAC,MAAM,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,MAAM,CAAN,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,KAAb,aAAa,QAOxB;AAuED,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,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,MAAM,UAAU,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,UAAU,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,UAAU,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,oBAAoB,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,cAAc,CAAC,GAAG,EAAE,qBAAqB,CAAC,CAAC;YAEpE,MAAM,gBAAgB,CAAC;QACzB,CAAC;QACD,YAAY,EAAE,QAAQ;QACtB,mBAAmB,EAAE,qCAAqC,CAAC,aAAa,CAAC;KAC1E,CAAC,CAAC,EAAE,4BAA4B,EAAE,IAAI,EAAE,CAAC,CAAC;AAC7C,CAAC;AA4CD;;;;;GAKG;AACH,MAAM,UAAgB,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,UAAU,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,UAAU,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,cAAc,CAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,KAAK;aACN,CAAC,CAAC;YAEH,MAAM,gBAAgB,CAAC;SACxB;IACH,CAAC;CAAA"}

package/build/es/src/stores-catalog-v1-product.http.d.ts

@@ -0,0 +1,62 @@
+import { RequestOptionsFactory } from '@wix/sdk-types';
+import { AddProductMediaRequest, AddProductMediaResponse, AddProductMediaToChoicesRequest, AddProductMediaToChoicesResponse, AddProductsToCollectionRequest, AddProductsToCollectionResponse, BulkAdjustProductPropertiesRequest, BulkAdjustProductPropertiesResponse, BulkUpdateProductsRequest, BulkUpdateProductsResponse, CreateCollectionRequest, CreateCollectionResponse, CreateProductRequest, CreateProductResponse, DeleteCollectionRequest, DeleteCollectionResponse, DeleteProductOptionsRequest, DeleteProductOptionsResponse, DeleteProductRequest, DeleteProductResponse, GetProductRequest, GetProductResponse, QueryProductsPlatformizedRequest, QueryProductsPlatformizedResponse, RemoveProductBrandRequest, RemoveProductBrandResponse, RemoveProductMediaFromChoicesRequest, RemoveProductMediaFromChoicesResponse, RemoveProductMediaRequest, RemoveProductMediaResponse, RemoveProductRibbonRequest, RemoveProductRibbonResponse, RemoveProductsFromCollectionRequest, RemoveProductsFromCollectionResponse, ResetAllVariantDataRequest, ResetAllVariantDataResponse, UpdateCollectionRequest, UpdateCollectionResponse, UpdateProductRequest, UpdateProductResponse, UpdateVariantsRequest, UpdateVariantsResponse } from './stores-catalog-v1-product.types';
+/** Creates a new product. */
+export declare function createProduct(payload: CreateProductRequest): RequestOptionsFactory<CreateProductResponse>;
+/** Updates specified fields in a product. */
+export declare function updateProduct(payload: UpdateProductRequest): RequestOptionsFactory<UpdateProductResponse>;
+/** Deletes a product. */
+export declare function deleteProduct(payload: DeleteProductRequest): RequestOptionsFactory<DeleteProductResponse>;
+/** Updates variants of a specified product. */
+export declare function updateVariants(payload: UpdateVariantsRequest): RequestOptionsFactory<UpdateVariantsResponse>;
+/** Resets all variant information to default values (price = current product price; weight = current product weight; SKU = current product SKU; visibility = true). */
+export declare function resetAllVariantData(payload: ResetAllVariantDataRequest): RequestOptionsFactory<ResetAllVariantDataResponse>;
+/** Adds products to a specified collection. */
+export declare function addProductsToCollection(payload: AddProductsToCollectionRequest): RequestOptionsFactory<AddProductsToCollectionResponse>;
+/** Deletes products from a specified collection. */
+export declare function removeProductsFromCollection(payload: RemoveProductsFromCollectionRequest): RequestOptionsFactory<RemoveProductsFromCollectionResponse>;
+/** Adds media items to a specified product, either via URL or existing media ID. */
+export declare function addProductMedia(payload: AddProductMediaRequest): RequestOptionsFactory<AddProductMediaResponse>;
+/**
+ * Removes specified media items from a product.
+ * Pass an empty array to remove all media items.
+ */
+export declare function removeProductMedia(payload: RemoveProductMediaRequest): RequestOptionsFactory<RemoveProductMediaResponse>;
+/**
+ * Links media items that are already associated with a specific product to a choice within the same product.
+ *
+ * Media items can only be set for choices within one option at a time - e.g., if you set media items for some or all of the choices within the Colors option (blue, green, and red), you won't be able to also assign media items to choices within the Size option (S, M, and L).
+ *
+ * To remove all existing media items, call the [Remove Product Media From Choices](https://dev.wix.com/api/rest/wix-stores/catalog/products/remove-product-media-from-choices) endpoint.
+ */
+export declare function addProductMediaToChoices(payload: AddProductMediaToChoicesRequest): RequestOptionsFactory<AddProductMediaToChoicesResponse>;
+/**
+ * Removes media items from all or some of a product's choices.
+ * (Media items can only be set for choices within one option at a time - e.g., if you set media items for some or all of the choices within the Colors option (blue, green, and red), you won't be able to also assign media items to choices within the Size option (S, M, and L).)
+ */
+export declare function removeProductMediaFromChoices(payload: RemoveProductMediaFromChoicesRequest): RequestOptionsFactory<RemoveProductMediaFromChoicesResponse>;
+/** Delete all options from a specific product (only available when variant management is disabled). */
+export declare function deleteProductOptions(payload: DeleteProductOptionsRequest): RequestOptionsFactory<DeleteProductOptionsResponse>;
+/** Deletes a product's brand. */
+export declare function removeBrand(payload: RemoveProductBrandRequest): RequestOptionsFactory<RemoveProductBrandResponse>;
+/** Creates a new collection. */
+export declare function createCollection(payload: CreateCollectionRequest): RequestOptionsFactory<CreateCollectionResponse>;
+/**
+ * Updates specified properties of a collection.
+ * To add products to a collection, call the [Add Products to Collection](https://dev.wix.com/api/rest/wix-stores/catalog/collection/add-products-to-collection) endpoint.
+ */
+export declare function updateCollection(payload: UpdateCollectionRequest): RequestOptionsFactory<UpdateCollectionResponse>;
+/** Deletes a collection. */
+export declare function deleteCollection(payload: DeleteCollectionRequest): RequestOptionsFactory<DeleteCollectionResponse>;
+/** Deletes a product's ribbon. */
+export declare function removeRibbon(payload: RemoveProductRibbonRequest): RequestOptionsFactory<RemoveProductRibbonResponse>;
+/** Updates a specified property for up to 100 products at a time. */
+export declare function bulkUpdateProducts(payload: BulkUpdateProductsRequest): RequestOptionsFactory<BulkUpdateProductsResponse>;
+/**
+ * Adjusts a specified numerical property for up to 100 products at a time.
+ * The property can be increased or decreased either by percentage or amount.
+ */
+export declare function bulkAdjustProductProperties(payload: BulkAdjustProductPropertiesRequest): RequestOptionsFactory<BulkAdjustProductPropertiesResponse>;
+/** Returns a list of up to 100 products, given the provided paging, sorting and filtering. */
+export declare function queryProductsPlatformized(payload: QueryProductsPlatformizedRequest): RequestOptionsFactory<QueryProductsPlatformizedResponse>;
+/** Retrieves a product with the provided ID. */
+export declare function getProduct(payload: GetProductRequest): RequestOptionsFactory<GetProductResponse>;