@wix/auto_sdk_stores_products 1.0.74 → 1.0.75
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +57 -57
- package/build/cjs/index.js +1107 -1107
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +1396 -1396
- package/build/cjs/index.typings.js +952 -952
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +1038 -1038
- package/build/cjs/meta.js +823 -823
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +57 -57
- package/build/es/index.mjs +1107 -1107
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +1396 -1396
- package/build/es/index.typings.mjs +952 -952
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +1038 -1038
- package/build/es/meta.mjs +823 -823
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +57 -57
- package/build/internal/cjs/index.js +1107 -1107
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +1386 -1386
- package/build/internal/cjs/index.typings.js +952 -952
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +1038 -1038
- package/build/internal/cjs/meta.js +823 -823
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +57 -57
- package/build/internal/es/index.mjs +1107 -1107
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +1386 -1386
- package/build/internal/es/index.typings.mjs +952 -952
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +1038 -1038
- package/build/internal/es/meta.mjs +823 -823
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
package/build/cjs/index.d.ts
CHANGED
|
@@ -1,57 +1,7 @@
|
|
|
1
1
|
import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
2
|
-
import {
|
|
2
|
+
import { Product, CreateProductResponse, UpdateProduct, UpdateProductResponse, VariantOverride, UpdateVariantsResponse, MediaDataForWrite, MediaAssignmentToChoice, Collection, CreateCollectionResponse, UpdateCollection, UpdateCollectionResponse, SetValue, BulkUpdateProductsResponse, AdjustValue, BulkAdjustProductPropertiesResponse, GetProductOptions, GetProductResponse, GetCollectionBySlugResponse, ProductOptionsAvailabilityResponse, QueryProductVariantsOptions, QueryProductVariantsResponse, PlatformQuery, QueryStoreVariantsResponse, GetStoreVariantResponse, ProductCollectionChangedEnvelope, ProductCollectionCreatedEnvelope, ProductCollectionDeletedEnvelope, ProductChangedEnvelope, ProductCreatedEnvelope, ProductDeletedEnvelope, ProductVariantsChangedEnvelope, ProductsQueryBuilder, ProductQuery, typedQueryProducts } from './index.typings.js';
|
|
3
3
|
export { AccountInfo, AddProductMediaRequest, AddProductMediaResponse, AddProductMediaToChoicesRequest, AddProductMediaToChoicesResponse, AddProductsToCollectionRequest, AddProductsToCollectionResponse, AdditionalInfoSection, AdjustValueValueOneOf, AggregateProductsRequest, AggregateProductsResponse, AllowedProductsCountLimitExceededErrorData, ApplicationError, BaseEventMetadata, BulkActionMetadata, BulkAdjustProductPropertiesByFilterSyncRequest, BulkAdjustProductPropertiesByFilterSyncResponse, BulkAdjustProductPropertiesRequest, BulkDeleteProductsRequest, BulkDeleteProductsResponse, BulkProductResult, BulkQueryCustomFieldsRequest, BulkQueryCustomFieldsResponse, BulkRemoveCustomFieldsRequest, BulkRemoveCustomFieldsResponse, BulkSetCustomFieldsRequest, BulkSetCustomFieldsResponse, BulkUpdateProductsByFilterSyncRequest, BulkUpdateProductsByFilterSyncResponse, BulkUpdateProductsRequest, Choice, CollectionChanged, CollectionCreated, CollectionDeleted, CommonQueryWithEntityContext, CostAndProfitData, CreateCollectionRequest, CreateDigitalProductRequest, CreateDigitalProductResponse, CreateProductPlatformizedRequest, CreateProductPlatformizedResponse, CreateProductRequest, CursorPaging, Cursors, CustomFieldsContainer, CustomTextField, DeleteCollectionRequest, DeleteCollectionResponse, DeleteProductOptionsRequest, DeleteProductOptionsResponse, DeleteProductPlatformizedRequest, DeleteProductPlatformizedResponse, DeleteProductRequest, DeleteProductResponse, Discount, DiscountType, DiscountTypeWithLiterals, FileType, FileTypeWithLiterals, FocalPoint, FormattedPrice, GetCollectionBySlugRequest, GetCollectionRequest, GetCollectionResponse, GetProductPlatformizedRequest, GetProductPlatformizedResponse, GetProductRequest, GetProductsRequest, GetProductsResponse, GetStoreVariantRequest, IdentificationData, IdentificationDataIdOneOf, InventoryStatus, InventoryStatusWithLiterals, ItemMetadata, Keyword, MeasurementUnit, MeasurementUnitWithLiterals, Media, MediaDataForWriteMediaSourceOneOf, MediaItem, MediaItemItemOneOf, MediaItemType, MediaItemTypeWithLiterals, MediaItemUrlAndSize, MediaItemVideo, MessageEnvelope, NumericPropertyRange, OptionAndChoice, OptionType, OptionTypeWithLiterals, PageUrl, Paging, PagingMetadata, PagingWithBigLimit, PercentageData, PlatformMedia, PlatformMediaMediaOneOf, PlatformPaging, PlatformPagingMetadata, PlatformQueryPagingMethodOneOf, PreorderInfo, PriceData, PricePerUnitData, ProductChanged, ProductCreated, ProductDeleted, ProductOption, ProductOptionsAvailabilityRequest, ProductQuerySpec, ProductType, ProductTypeWithLiterals, ProductsQueryResult, PropertyAdjustmentData, PropertyAdjustmentDataByOneOf, Query, QueryCollectionsPlatformizedRequest, QueryCollectionsPlatformizedResponse, QueryCollectionsRequest, QueryCollectionsResponse, QueryCustomFieldsRequest, QueryCustomFieldsResponse, QueryProductVariantsRequest, QueryProductsPlatformizedRequest, QueryProductsPlatformizedResponse, QueryProductsRequest, QueryProductsResponse, QueryProductsWithBigPageLimitRequest, QueryStoreVariantsRequest, QueryStoreVariantsWithBigLimitRequest, QueryWithBigPageLimit, ReCloneStoreRequest, ReCloneStoreResponse, RemoveCustomFieldsRequest, RemoveCustomFieldsResponse, RemoveProductBrandRequest, RemoveProductBrandResponse, RemoveProductMediaFromChoicesRequest, RemoveProductMediaFromChoicesResponse, RemoveProductMediaRequest, RemoveProductMediaResponse, RemoveProductRibbonRequest, RemoveProductRibbonResponse, RemoveProductsFromCollectionRequest, RemoveProductsFromCollectionResponse, ResetAllVariantDataRequest, ResetAllVariantDataResponse, Ribbon, SecuredMedia, SeoSchema, SetCustomFieldsRequest, SetCustomFieldsResponse, SetValueValueOneOf, Settings, SortOrder, SortOrderWithLiterals, Sorting, Stock, StoreVariant, Tag, UnlimitedPlatformCursorPaging, UnlimitedPlatformPaging, UnlimitedPlatformQuery, UnlimitedPlatformQueryPagingMethodOneOf, UpdateCollectionRequest, UpdateProductPlatformizedRequest, UpdateProductPlatformizedResponse, UpdateProductRequest, UpdateVariantsRequest, V1CreateProductPlatformizedRequest, V1CreateProductPlatformizedResponse, V1DeleteProductPlatformizedRequest, V1DeleteProductPlatformizedResponse, V1UpdateProductPlatformizedRequest, V1UpdateProductPlatformizedResponse, Variant, VariantChanged, VariantData, VariantDataWithNoStock, VariantStock, VariantsChanged, Version, VersionWithLiterals, VideoResolution, WebhookIdentityType, WebhookIdentityTypeWithLiterals, utils } from './index.typings.js';
|
|
4
4
|
|
|
5
|
-
declare function getProduct$1(httpClient: HttpClient): GetProductSignature;
|
|
6
|
-
interface GetProductSignature {
|
|
7
|
-
/**
|
|
8
|
-
* Retrieves a product with the provided ID.
|
|
9
|
-
* @param - Requested product ID.
|
|
10
|
-
*/
|
|
11
|
-
(_id: string, options?: GetProductOptions): Promise<NonNullablePaths<GetProductResponse, `product._id` | `product.slug` | `product.productType` | `product.weightRange.minValue` | `product.weightRange.maxValue` | `product.stock.trackInventory` | `product.stock.inStock` | `product.stock.inventoryStatus` | `product.price.currency` | `product.price.discountedPrice` | `product.price.formatted.price` | `product.price.formatted.discountedPrice` | `product.costAndProfitData.formattedItemCost` | `product.costAndProfitData.profit` | `product.costAndProfitData.formattedProfit` | `product.costAndProfitData.profitMargin` | `product.pricePerUnitData.totalQuantity` | `product.pricePerUnitData.totalMeasurementUnit` | `product.pricePerUnitData.baseQuantity` | `product.pricePerUnitData.baseMeasurementUnit` | `product.additionalInfoSections` | `product.additionalInfoSections.${number}.title` | `product.additionalInfoSections.${number}.description` | `product.ribbons` | `product.ribbons.${number}.text` | `product.media.mainMedia.image.url` | `product.media.mainMedia.image.width` | `product.media.mainMedia.image.height` | `product.media.mainMedia.video.files` | `product.media.mainMedia.video.stillFrameMediaId` | `product.media.mainMedia.mediaType` | `product.media.mainMedia.title` | `product.media.mainMedia._id` | `product.media.items` | `product.customTextFields` | `product.customTextFields.${number}.title` | `product.customTextFields.${number}.maxLength` | `product.customTextFields.${number}.mandatory` | `product.productOptions` | `product.productOptions.${number}.optionType` | `product.productOptions.${number}.name` | `product.productPageUrl.base` | `product.productPageUrl.path` | `product.numericId` | `product.inventoryItemId` | `product.discount.type` | `product.discount.value` | `product.collectionIds` | `product.variants` | `product.variants.${number}._id` | `product.variants.${number}.variant.weight` | `product.variants.${number}.variant.sku` | `product.variants.${number}.variant.visible` | `product.variants.${number}.stock.trackQuantity` | `product.variants.${number}.stock.inStock` | `product.seoData.tags` | `product.seoData.tags.${number}.type` | `product.seoData.tags.${number}.children` | `product.seoData.tags.${number}.custom` | `product.seoData.tags.${number}.disabled` | `product.seoData.settings.preventAutoRedirect` | `product.seoData.settings.keywords` | `product.seoData.settings.keywords.${number}.term` | `product.seoData.settings.keywords.${number}.isMain`, 7>>;
|
|
12
|
-
}
|
|
13
|
-
declare function getCollectionBySlug$1(httpClient: HttpClient): GetCollectionBySlugSignature;
|
|
14
|
-
interface GetCollectionBySlugSignature {
|
|
15
|
-
/**
|
|
16
|
-
* Retrieves a collection with the provided slug.
|
|
17
|
-
* @param - Slug of the collection to retrieve.
|
|
18
|
-
*/
|
|
19
|
-
(slug: string): Promise<NonNullablePaths<GetCollectionBySlugResponse, `collection.media.mainMedia.image.url` | `collection.media.mainMedia.image.width` | `collection.media.mainMedia.image.height` | `collection.media.mainMedia.video.files` | `collection.media.mainMedia.video.stillFrameMediaId` | `collection.media.mainMedia.mediaType` | `collection.media.mainMedia.title` | `collection.media.mainMedia._id` | `collection.media.items` | `collection.numberOfProducts`, 6>>;
|
|
20
|
-
}
|
|
21
|
-
declare function getProductOptionsAvailability$1(httpClient: HttpClient): GetProductOptionsAvailabilitySignature;
|
|
22
|
-
interface GetProductOptionsAvailabilitySignature {
|
|
23
|
-
/**
|
|
24
|
-
* Gets the availability of relevant product variants based on the product ID and selections provided. See [Use Cases](https://dev.wix.com/api/rest/wix-stores/catalog/use-cases) for an example.
|
|
25
|
-
* @param - Requested product ID.
|
|
26
|
-
* @param - Array containing the selected options. For example, `{"color": "Blue", "size": "Large"}`.
|
|
27
|
-
*/
|
|
28
|
-
(_id: string, options: Record<string, string>): Promise<NonNullablePaths<ProductOptionsAvailabilityResponse, `selectedVariant.price.currency` | `selectedVariant.price.discountedPrice` | `selectedVariant.price.formatted.price` | `selectedVariant.price.formatted.discountedPrice` | `selectedVariant.sku` | `selectedVariant.inStock` | `selectedVariant.visible` | `media.mainMedia.image.url` | `media.mainMedia.image.width` | `media.mainMedia.image.height` | `media.mainMedia.video.files` | `media.mainMedia.video.stillFrameMediaId` | `media.mainMedia.mediaType` | `media.mainMedia.title` | `media.mainMedia._id` | `media.items` | `productOptions` | `productOptions.${number}.optionType` | `productOptions.${number}.name` | `availableForPurchase`, 5>>;
|
|
29
|
-
}
|
|
30
|
-
declare function queryProductVariants$1(httpClient: HttpClient): QueryProductVariantsSignature;
|
|
31
|
-
interface QueryProductVariantsSignature {
|
|
32
|
-
/**
|
|
33
|
-
* Retrieves product variants, based on either choices (option-choice key-value pairs) or variant IDs.
|
|
34
|
-
* See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.
|
|
35
|
-
* @param - Requested product ID.
|
|
36
|
-
*/
|
|
37
|
-
(_id: string, options?: QueryProductVariantsOptions): Promise<NonNullablePaths<QueryProductVariantsResponse, `variants` | `variants.${number}._id` | `variants.${number}.variant.priceData.currency` | `variants.${number}.variant.priceData.discountedPrice` | `variants.${number}.variant.costAndProfitData.formattedItemCost` | `variants.${number}.variant.costAndProfitData.profit` | `variants.${number}.variant.costAndProfitData.formattedProfit` | `variants.${number}.variant.costAndProfitData.profitMargin` | `variants.${number}.variant.weight` | `variants.${number}.variant.sku` | `variants.${number}.variant.visible` | `variants.${number}.stock.trackQuantity` | `variants.${number}.stock.inStock` | `metadata.items` | `metadata.offset` | `totalResults`, 6>>;
|
|
38
|
-
}
|
|
39
|
-
declare function queryStoreVariants$1(httpClient: HttpClient): QueryStoreVariantsSignature;
|
|
40
|
-
interface QueryStoreVariantsSignature {
|
|
41
|
-
/**
|
|
42
|
-
* Retrieves up to 100 store variants, given the provided paging, filtering, and sorting.
|
|
43
|
-
* @param - Query options.
|
|
44
|
-
*/
|
|
45
|
-
(query: PlatformQuery): Promise<NonNullablePaths<QueryStoreVariantsResponse, `variants` | `variants.${number}._id` | `variants.${number}.variantId` | `variants.${number}.productId` | `variants.${number}.variantName` | `variants.${number}.productName` | `variants.${number}.managedVariant` | `variants.${number}.sku` | `variants.${number}.stock.trackQuantity` | `variants.${number}.stock.inStock` | `variants.${number}.preorderInfo.enabled`, 5>>;
|
|
46
|
-
}
|
|
47
|
-
declare function getStoreVariant$1(httpClient: HttpClient): GetStoreVariantSignature;
|
|
48
|
-
interface GetStoreVariantSignature {
|
|
49
|
-
/**
|
|
50
|
-
* Retrieves a store variant with the provided ID.
|
|
51
|
-
* @param - Store variant ID. Comprised of the `productId` and the `variantId`, separated by a hyphen. For example, `{productId}-{variantId}`.
|
|
52
|
-
*/
|
|
53
|
-
(_id: string): Promise<NonNullablePaths<GetStoreVariantResponse, `variant._id` | `variant.variantId` | `variant.productId` | `variant.variantName` | `variant.productName` | `variant.managedVariant` | `variant.sku` | `variant.stock.trackQuantity` | `variant.stock.inStock` | `variant.collectionIds` | `variant.preorderInfo.enabled`, 4>>;
|
|
54
|
-
}
|
|
55
5
|
declare function createProduct$1(httpClient: HttpClient): CreateProductSignature;
|
|
56
6
|
interface CreateProductSignature {
|
|
57
7
|
/**
|
|
@@ -226,6 +176,56 @@ interface BulkAdjustProductPropertySignature {
|
|
|
226
176
|
*/
|
|
227
177
|
(adjust: AdjustValue, ids: string[]): Promise<NonNullablePaths<BulkAdjustProductPropertiesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
228
178
|
}
|
|
179
|
+
declare function getProduct$1(httpClient: HttpClient): GetProductSignature;
|
|
180
|
+
interface GetProductSignature {
|
|
181
|
+
/**
|
|
182
|
+
* Retrieves a product with the provided ID.
|
|
183
|
+
* @param - Requested product ID.
|
|
184
|
+
*/
|
|
185
|
+
(_id: string, options?: GetProductOptions): Promise<NonNullablePaths<GetProductResponse, `product._id` | `product.slug` | `product.productType` | `product.weightRange.minValue` | `product.weightRange.maxValue` | `product.stock.trackInventory` | `product.stock.inStock` | `product.stock.inventoryStatus` | `product.price.currency` | `product.price.discountedPrice` | `product.price.formatted.price` | `product.price.formatted.discountedPrice` | `product.costAndProfitData.formattedItemCost` | `product.costAndProfitData.profit` | `product.costAndProfitData.formattedProfit` | `product.costAndProfitData.profitMargin` | `product.pricePerUnitData.totalQuantity` | `product.pricePerUnitData.totalMeasurementUnit` | `product.pricePerUnitData.baseQuantity` | `product.pricePerUnitData.baseMeasurementUnit` | `product.additionalInfoSections` | `product.additionalInfoSections.${number}.title` | `product.additionalInfoSections.${number}.description` | `product.ribbons` | `product.ribbons.${number}.text` | `product.media.mainMedia.image.url` | `product.media.mainMedia.image.width` | `product.media.mainMedia.image.height` | `product.media.mainMedia.video.files` | `product.media.mainMedia.video.stillFrameMediaId` | `product.media.mainMedia.mediaType` | `product.media.mainMedia.title` | `product.media.mainMedia._id` | `product.media.items` | `product.customTextFields` | `product.customTextFields.${number}.title` | `product.customTextFields.${number}.maxLength` | `product.customTextFields.${number}.mandatory` | `product.productOptions` | `product.productOptions.${number}.optionType` | `product.productOptions.${number}.name` | `product.productPageUrl.base` | `product.productPageUrl.path` | `product.numericId` | `product.inventoryItemId` | `product.discount.type` | `product.discount.value` | `product.collectionIds` | `product.variants` | `product.variants.${number}._id` | `product.variants.${number}.variant.weight` | `product.variants.${number}.variant.sku` | `product.variants.${number}.variant.visible` | `product.variants.${number}.stock.trackQuantity` | `product.variants.${number}.stock.inStock` | `product.seoData.tags` | `product.seoData.tags.${number}.type` | `product.seoData.tags.${number}.children` | `product.seoData.tags.${number}.custom` | `product.seoData.tags.${number}.disabled` | `product.seoData.settings.preventAutoRedirect` | `product.seoData.settings.keywords` | `product.seoData.settings.keywords.${number}.term` | `product.seoData.settings.keywords.${number}.isMain`, 7>>;
|
|
186
|
+
}
|
|
187
|
+
declare function getCollectionBySlug$1(httpClient: HttpClient): GetCollectionBySlugSignature;
|
|
188
|
+
interface GetCollectionBySlugSignature {
|
|
189
|
+
/**
|
|
190
|
+
* Retrieves a collection with the provided slug.
|
|
191
|
+
* @param - Slug of the collection to retrieve.
|
|
192
|
+
*/
|
|
193
|
+
(slug: string): Promise<NonNullablePaths<GetCollectionBySlugResponse, `collection.media.mainMedia.image.url` | `collection.media.mainMedia.image.width` | `collection.media.mainMedia.image.height` | `collection.media.mainMedia.video.files` | `collection.media.mainMedia.video.stillFrameMediaId` | `collection.media.mainMedia.mediaType` | `collection.media.mainMedia.title` | `collection.media.mainMedia._id` | `collection.media.items` | `collection.numberOfProducts`, 6>>;
|
|
194
|
+
}
|
|
195
|
+
declare function getProductOptionsAvailability$1(httpClient: HttpClient): GetProductOptionsAvailabilitySignature;
|
|
196
|
+
interface GetProductOptionsAvailabilitySignature {
|
|
197
|
+
/**
|
|
198
|
+
* Gets the availability of relevant product variants based on the product ID and selections provided. See [Use Cases](https://dev.wix.com/api/rest/wix-stores/catalog/use-cases) for an example.
|
|
199
|
+
* @param - Requested product ID.
|
|
200
|
+
* @param - Array containing the selected options. For example, `{"color": "Blue", "size": "Large"}`.
|
|
201
|
+
*/
|
|
202
|
+
(_id: string, options: Record<string, string>): Promise<NonNullablePaths<ProductOptionsAvailabilityResponse, `selectedVariant.price.currency` | `selectedVariant.price.discountedPrice` | `selectedVariant.price.formatted.price` | `selectedVariant.price.formatted.discountedPrice` | `selectedVariant.sku` | `selectedVariant.inStock` | `selectedVariant.visible` | `media.mainMedia.image.url` | `media.mainMedia.image.width` | `media.mainMedia.image.height` | `media.mainMedia.video.files` | `media.mainMedia.video.stillFrameMediaId` | `media.mainMedia.mediaType` | `media.mainMedia.title` | `media.mainMedia._id` | `media.items` | `productOptions` | `productOptions.${number}.optionType` | `productOptions.${number}.name` | `availableForPurchase`, 5>>;
|
|
203
|
+
}
|
|
204
|
+
declare function queryProductVariants$1(httpClient: HttpClient): QueryProductVariantsSignature;
|
|
205
|
+
interface QueryProductVariantsSignature {
|
|
206
|
+
/**
|
|
207
|
+
* Retrieves product variants, based on either choices (option-choice key-value pairs) or variant IDs.
|
|
208
|
+
* See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.
|
|
209
|
+
* @param - Requested product ID.
|
|
210
|
+
*/
|
|
211
|
+
(_id: string, options?: QueryProductVariantsOptions): Promise<NonNullablePaths<QueryProductVariantsResponse, `variants` | `variants.${number}._id` | `variants.${number}.variant.priceData.currency` | `variants.${number}.variant.priceData.discountedPrice` | `variants.${number}.variant.costAndProfitData.formattedItemCost` | `variants.${number}.variant.costAndProfitData.profit` | `variants.${number}.variant.costAndProfitData.formattedProfit` | `variants.${number}.variant.costAndProfitData.profitMargin` | `variants.${number}.variant.weight` | `variants.${number}.variant.sku` | `variants.${number}.variant.visible` | `variants.${number}.stock.trackQuantity` | `variants.${number}.stock.inStock` | `metadata.items` | `metadata.offset` | `totalResults`, 6>>;
|
|
212
|
+
}
|
|
213
|
+
declare function queryStoreVariants$1(httpClient: HttpClient): QueryStoreVariantsSignature;
|
|
214
|
+
interface QueryStoreVariantsSignature {
|
|
215
|
+
/**
|
|
216
|
+
* Retrieves up to 100 store variants, given the provided paging, filtering, and sorting.
|
|
217
|
+
* @param - Query options.
|
|
218
|
+
*/
|
|
219
|
+
(query: PlatformQuery): Promise<NonNullablePaths<QueryStoreVariantsResponse, `variants` | `variants.${number}._id` | `variants.${number}.variantId` | `variants.${number}.productId` | `variants.${number}.variantName` | `variants.${number}.productName` | `variants.${number}.managedVariant` | `variants.${number}.sku` | `variants.${number}.stock.trackQuantity` | `variants.${number}.stock.inStock` | `variants.${number}.preorderInfo.enabled`, 5>>;
|
|
220
|
+
}
|
|
221
|
+
declare function getStoreVariant$1(httpClient: HttpClient): GetStoreVariantSignature;
|
|
222
|
+
interface GetStoreVariantSignature {
|
|
223
|
+
/**
|
|
224
|
+
* Retrieves a store variant with the provided ID.
|
|
225
|
+
* @param - Store variant ID. Comprised of the `productId` and the `variantId`, separated by a hyphen. For example, `{productId}-{variantId}`.
|
|
226
|
+
*/
|
|
227
|
+
(_id: string): Promise<NonNullablePaths<GetStoreVariantResponse, `variant._id` | `variant.variantId` | `variant.productId` | `variant.variantName` | `variant.productName` | `variant.managedVariant` | `variant.sku` | `variant.stock.trackQuantity` | `variant.stock.inStock` | `variant.collectionIds` | `variant.preorderInfo.enabled`, 4>>;
|
|
228
|
+
}
|
|
229
229
|
declare const onProductCollectionChanged$1: EventDefinition<ProductCollectionChangedEnvelope, "com.wix.ecommerce.catalog.api.v1.CollectionChanged">;
|
|
230
230
|
declare const onProductCollectionCreated$1: EventDefinition<ProductCollectionCreatedEnvelope, "com.wix.ecommerce.catalog.api.v1.CollectionCreated">;
|
|
231
231
|
declare const onProductCollectionDeleted$1: EventDefinition<ProductCollectionDeletedEnvelope, "com.wix.ecommerce.catalog.api.v1.CollectionDeleted">;
|
|
@@ -238,12 +238,6 @@ declare function customQueryProducts(httpClient: HttpClient): {
|
|
|
238
238
|
(): ProductsQueryBuilder;
|
|
239
239
|
(query: ProductQuery): ReturnType<typeof typedQueryProducts>;
|
|
240
240
|
};
|
|
241
|
-
declare const getProduct: MaybeContext<BuildRESTFunction<typeof getProduct$1> & typeof getProduct$1>;
|
|
242
|
-
declare const getCollectionBySlug: MaybeContext<BuildRESTFunction<typeof getCollectionBySlug$1> & typeof getCollectionBySlug$1>;
|
|
243
|
-
declare const getProductOptionsAvailability: MaybeContext<BuildRESTFunction<typeof getProductOptionsAvailability$1> & typeof getProductOptionsAvailability$1>;
|
|
244
|
-
declare const queryProductVariants: MaybeContext<BuildRESTFunction<typeof queryProductVariants$1> & typeof queryProductVariants$1>;
|
|
245
|
-
declare const queryStoreVariants: MaybeContext<BuildRESTFunction<typeof queryStoreVariants$1> & typeof queryStoreVariants$1>;
|
|
246
|
-
declare const getStoreVariant: MaybeContext<BuildRESTFunction<typeof getStoreVariant$1> & typeof getStoreVariant$1>;
|
|
247
241
|
declare const createProduct: MaybeContext<BuildRESTFunction<typeof createProduct$1> & typeof createProduct$1>;
|
|
248
242
|
declare const updateProduct: MaybeContext<BuildRESTFunction<typeof updateProduct$1> & typeof updateProduct$1>;
|
|
249
243
|
declare const deleteProduct: MaybeContext<BuildRESTFunction<typeof deleteProduct$1> & typeof deleteProduct$1>;
|
|
@@ -263,6 +257,12 @@ declare const deleteCollection: MaybeContext<BuildRESTFunction<typeof deleteColl
|
|
|
263
257
|
declare const removeRibbon: MaybeContext<BuildRESTFunction<typeof removeRibbon$1> & typeof removeRibbon$1>;
|
|
264
258
|
declare const bulkUpdateProductsProperty: MaybeContext<BuildRESTFunction<typeof bulkUpdateProductsProperty$1> & typeof bulkUpdateProductsProperty$1>;
|
|
265
259
|
declare const bulkAdjustProductProperty: MaybeContext<BuildRESTFunction<typeof bulkAdjustProductProperty$1> & typeof bulkAdjustProductProperty$1>;
|
|
260
|
+
declare const getProduct: MaybeContext<BuildRESTFunction<typeof getProduct$1> & typeof getProduct$1>;
|
|
261
|
+
declare const getCollectionBySlug: MaybeContext<BuildRESTFunction<typeof getCollectionBySlug$1> & typeof getCollectionBySlug$1>;
|
|
262
|
+
declare const getProductOptionsAvailability: MaybeContext<BuildRESTFunction<typeof getProductOptionsAvailability$1> & typeof getProductOptionsAvailability$1>;
|
|
263
|
+
declare const queryProductVariants: MaybeContext<BuildRESTFunction<typeof queryProductVariants$1> & typeof queryProductVariants$1>;
|
|
264
|
+
declare const queryStoreVariants: MaybeContext<BuildRESTFunction<typeof queryStoreVariants$1> & typeof queryStoreVariants$1>;
|
|
265
|
+
declare const getStoreVariant: MaybeContext<BuildRESTFunction<typeof getStoreVariant$1> & typeof getStoreVariant$1>;
|
|
266
266
|
declare const queryProducts: MaybeContext<BuildRESTFunction<typeof customQueryProducts> & typeof customQueryProducts>;
|
|
267
267
|
/**
|
|
268
268
|
* Triggered when a collection is changed.
|