@wix/auto_sdk_stores_products 1.0.27 → 1.0.29
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 +15 -22
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +14 -21
- package/build/cjs/index.typings.js.map +1 -1
- package/build/es/index.d.mts +15 -22
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +14 -21
- package/build/es/index.typings.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +15 -22
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +14 -21
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/es/index.d.mts +15 -22
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +14 -21
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/package.json +3 -3
package/build/cjs/index.d.ts
CHANGED
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
2
2
|
import { ProductsQueryBuilder, GetProductOptions, GetProductResponse, GetCollectionBySlugResponse, ProductOptionsAvailabilityResponse, QueryProductVariantsOptions, QueryProductVariantsResponse, PlatformQuery, QueryStoreVariantsResponse, GetStoreVariantResponse, Product, CreateProductResponse, UpdateProduct, UpdateProductResponse, VariantOverride, UpdateVariantsResponse, MediaDataForWrite, MediaAssignmentToChoice, Collection, CreateCollectionResponse, UpdateCollection, UpdateCollectionResponse, SetValue, BulkUpdateProductsResponse, AdjustValue, BulkAdjustProductPropertiesResponse, ProductCollectionChangedEnvelope, ProductCollectionCreatedEnvelope, ProductCollectionDeletedEnvelope, ProductChangedEnvelope, ProductCreatedEnvelope, ProductDeletedEnvelope, ProductVariantsChangedEnvelope } from './index.typings.js';
|
|
3
|
-
export { 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, CostAndProfitData, CreateCollectionRequest, CreateDigitalProductRequest, CreateDigitalProductResponse, CreateProductPlatformizedRequest, CreateProductPlatformizedResponse, CreateProductRequest, CursorPaging, Cursors, CustomFieldsContainer, CustomTextField, DeleteCollectionRequest, DeleteCollectionResponse, DeleteProductOptionsRequest, DeleteProductOptionsResponse, DeleteProductPlatformizedRequest, DeleteProductPlatformizedResponse, DeleteProductRequest, DeleteProductResponse, Discount, DiscountType, FileType, FocalPoint, FormattedPrice, GetCollectionBySlugRequest, GetCollectionRequest, GetCollectionResponse, GetProductPlatformizedRequest, GetProductPlatformizedResponse, GetProductRequest, GetProductsRequest, GetProductsResponse, GetStoreVariantRequest, IdentificationData, IdentificationDataIdOneOf, InventoryStatus, ItemMetadata, Keyword, MeasurementUnit, Media, MediaDataForWriteMediaSourceOneOf, MediaItem, MediaItemItemOneOf, MediaItemType, MediaItemUrlAndSize, MediaItemVideo, MessageEnvelope, NumericPropertyRange, OptionAndChoice, OptionType, PageUrl, Paging, PagingMetadata, PagingWithBigLimit, PercentageData, PlatformMedia, PlatformMediaMediaOneOf, PlatformPaging, PlatformPagingMetadata, PlatformQueryPagingMethodOneOf, PreorderInfo, PriceData, PricePerUnitData, ProductChanged, ProductCreated, ProductDeleted, ProductOption, ProductOptionsAvailabilityRequest, ProductType, 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, 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, VideoResolution, WebhookIdentityType } from './index.typings.js';
|
|
3
|
+
export { 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, 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, 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 } from './index.typings.js';
|
|
4
4
|
|
|
5
|
-
type ProductNonNullablePaths = `_id` | `slug` | `productType` | `weightRange.minValue` | `weightRange.maxValue` | `stock.trackInventory` | `stock.inStock` | `stock.inventoryStatus` | `price.currency` | `price.discountedPrice` | `price.formatted.price` | `price.formatted.discountedPrice` | `priceData.currency` | `priceData.discountedPrice` | `priceData.formatted.price` | `priceData.formatted.discountedPrice` | `convertedPriceData.currency` | `convertedPriceData.discountedPrice` | `convertedPriceData.formatted.price` | `convertedPriceData.formatted.discountedPrice` | `priceRange.minValue` | `priceRange.maxValue` | `costAndProfitData.formattedItemCost` | `costAndProfitData.profit` | `costAndProfitData.formattedProfit` | `costAndProfitData.profitMargin` | `costRange.minValue` | `costRange.maxValue` | `pricePerUnitData.totalQuantity` | `pricePerUnitData.totalMeasurementUnit` | `pricePerUnitData.baseQuantity` | `pricePerUnitData.baseMeasurementUnit` | `additionalInfoSections` | `additionalInfoSections.${number}.title` | `additionalInfoSections.${number}.description` | `ribbons` | `ribbons.${number}.text` | `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` | `customTextFields` | `customTextFields.${number}.title` | `customTextFields.${number}.maxLength` | `customTextFields.${number}.mandatory` | `productOptions` | `productOptions.${number}.optionType` | `productOptions.${number}.name` | `productPageUrl.base` | `productPageUrl.path` | `numericId` | `inventoryItemId` | `discount.type` | `discount.value` | `collectionIds` | `variants` | `variants.${number}._id` | `variants.${number}.variant.priceData.currency` | `variants.${number}.variant.priceData.discountedPrice` | `variants.${number}.variant.priceData.formatted.price` | `variants.${number}.variant.priceData.formatted.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` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain`;
|
|
6
5
|
declare function queryProducts$1(httpClient: HttpClient): QueryProductsSignature;
|
|
7
6
|
interface QueryProductsSignature {
|
|
8
7
|
/**
|
|
@@ -16,9 +15,7 @@ interface GetProductSignature {
|
|
|
16
15
|
* Retrieves a product with the provided ID.
|
|
17
16
|
* @param - Requested product ID.
|
|
18
17
|
*/
|
|
19
|
-
(_id: string, options?: GetProductOptions): Promise<NonNullablePaths<GetProductResponse, {
|
|
20
|
-
[P in ProductNonNullablePaths]: `product.${P}`;
|
|
21
|
-
}[ProductNonNullablePaths]>>;
|
|
18
|
+
(_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>>;
|
|
22
19
|
}
|
|
23
20
|
declare function getCollectionBySlug$1(httpClient: HttpClient): GetCollectionBySlugSignature;
|
|
24
21
|
interface GetCollectionBySlugSignature {
|
|
@@ -26,7 +23,7 @@ interface GetCollectionBySlugSignature {
|
|
|
26
23
|
* Retrieves a collection with the provided slug.
|
|
27
24
|
* @param - Slug of the collection to retrieve.
|
|
28
25
|
*/
|
|
29
|
-
(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
|
|
26
|
+
(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>>;
|
|
30
27
|
}
|
|
31
28
|
declare function getProductOptionsAvailability$1(httpClient: HttpClient): GetProductOptionsAvailabilitySignature;
|
|
32
29
|
interface GetProductOptionsAvailabilitySignature {
|
|
@@ -35,7 +32,7 @@ interface GetProductOptionsAvailabilitySignature {
|
|
|
35
32
|
* @param - Requested product ID.
|
|
36
33
|
* @param - Array containing the selected options. For example, `["color": "Blue", "size": "Large"]`.
|
|
37
34
|
*/
|
|
38
|
-
(_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
|
|
35
|
+
(_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>>;
|
|
39
36
|
}
|
|
40
37
|
declare function queryProductVariants$1(httpClient: HttpClient): QueryProductVariantsSignature;
|
|
41
38
|
interface QueryProductVariantsSignature {
|
|
@@ -44,7 +41,7 @@ interface QueryProductVariantsSignature {
|
|
|
44
41
|
* See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.
|
|
45
42
|
* @param - Requested product ID.
|
|
46
43
|
*/
|
|
47
|
-
(_id: string, options?: QueryProductVariantsOptions): Promise<NonNullablePaths<QueryProductVariantsResponse, `variants` | `variants.${number}._id` | `variants.${number}.variant.priceData.currency` | `variants.${number}.variant.priceData.discountedPrice` | `variants.${number}.variant.
|
|
44
|
+
(_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>>;
|
|
48
45
|
}
|
|
49
46
|
declare function queryStoreVariants$1(httpClient: HttpClient): QueryStoreVariantsSignature;
|
|
50
47
|
interface QueryStoreVariantsSignature {
|
|
@@ -52,7 +49,7 @@ interface QueryStoreVariantsSignature {
|
|
|
52
49
|
* Retrieves up to 100 store variants, given the provided paging, filtering, and sorting.
|
|
53
50
|
* @param - Query options.
|
|
54
51
|
*/
|
|
55
|
-
(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
|
|
52
|
+
(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>>;
|
|
56
53
|
}
|
|
57
54
|
declare function getStoreVariant$1(httpClient: HttpClient): GetStoreVariantSignature;
|
|
58
55
|
interface GetStoreVariantSignature {
|
|
@@ -60,7 +57,7 @@ interface GetStoreVariantSignature {
|
|
|
60
57
|
* Retrieves a store variant with the provided ID.
|
|
61
58
|
* @param - Store variant ID. Comprised of the `productId` and the `variantId`, separated by a hyphen. For example, `{productId}-{variantId}`.
|
|
62
59
|
*/
|
|
63
|
-
(_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
|
|
60
|
+
(_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>>;
|
|
64
61
|
}
|
|
65
62
|
declare function createProduct$1(httpClient: HttpClient): CreateProductSignature;
|
|
66
63
|
interface CreateProductSignature {
|
|
@@ -68,9 +65,7 @@ interface CreateProductSignature {
|
|
|
68
65
|
* Creates a new product.
|
|
69
66
|
* @param - Product information.
|
|
70
67
|
*/
|
|
71
|
-
(product: NonNullablePaths<Product, `costAndProfitData.itemCost` | `name` | `priceData` | `priceData.price
|
|
72
|
-
[P in ProductNonNullablePaths]: `product.${P}`;
|
|
73
|
-
}[ProductNonNullablePaths]>>;
|
|
68
|
+
(product: NonNullablePaths<Product, `costAndProfitData.itemCost` | `name` | `priceData` | `priceData.price`, 3>): Promise<NonNullablePaths<CreateProductResponse, `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>>;
|
|
74
69
|
}
|
|
75
70
|
declare function updateProduct$1(httpClient: HttpClient): UpdateProductSignature;
|
|
76
71
|
interface UpdateProductSignature {
|
|
@@ -81,9 +76,7 @@ interface UpdateProductSignature {
|
|
|
81
76
|
* @param - Product ID (generated automatically by the catalog).
|
|
82
77
|
* @param - Product info to update.
|
|
83
78
|
*/
|
|
84
|
-
(_id: string, product: UpdateProduct): Promise<NonNullablePaths<UpdateProductResponse, {
|
|
85
|
-
[P in ProductNonNullablePaths]: `product.${P}`;
|
|
86
|
-
}[ProductNonNullablePaths]>>;
|
|
79
|
+
(_id: string, product: UpdateProduct): Promise<NonNullablePaths<UpdateProductResponse, `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>>;
|
|
87
80
|
}
|
|
88
81
|
declare function deleteProduct$1(httpClient: HttpClient): DeleteProductSignature;
|
|
89
82
|
interface DeleteProductSignature {
|
|
@@ -100,7 +93,7 @@ interface UpdateProductVariantsSignature {
|
|
|
100
93
|
* @param - ID of the product with managed variants.
|
|
101
94
|
* @param - Variant info to update.
|
|
102
95
|
*/
|
|
103
|
-
(_id: string, variants: VariantOverride[]): Promise<NonNullablePaths<UpdateVariantsResponse, `variants` | `variants.${number}._id` | `variants.${number}.variant.priceData.currency` | `variants.${number}.variant.priceData.discountedPrice` | `variants.${number}.variant.
|
|
96
|
+
(_id: string, variants: VariantOverride[]): Promise<NonNullablePaths<UpdateVariantsResponse, `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`, 6>>;
|
|
104
97
|
}
|
|
105
98
|
declare function resetAllProductVariantData$1(httpClient: HttpClient): ResetAllProductVariantDataSignature;
|
|
106
99
|
interface ResetAllProductVariantDataSignature {
|
|
@@ -160,7 +153,7 @@ interface AddProductMediaToChoicesSignature {
|
|
|
160
153
|
* @param - Product ID.
|
|
161
154
|
* @param - Product media items and the choices to add the media to.
|
|
162
155
|
*/
|
|
163
|
-
(_id: string, media: NonNullablePaths<MediaAssignmentToChoice, `choice` | `option
|
|
156
|
+
(_id: string, media: NonNullablePaths<MediaAssignmentToChoice, `choice` | `option`, 2>[]): Promise<void>;
|
|
164
157
|
}
|
|
165
158
|
declare function removeProductMediaFromChoices$1(httpClient: HttpClient): RemoveProductMediaFromChoicesSignature;
|
|
166
159
|
interface RemoveProductMediaFromChoicesSignature {
|
|
@@ -194,7 +187,7 @@ interface CreateCollectionSignature {
|
|
|
194
187
|
* Creates a new collection.
|
|
195
188
|
* @param - Collection info.
|
|
196
189
|
*/
|
|
197
|
-
(collection: NonNullablePaths<Collection, `name
|
|
190
|
+
(collection: NonNullablePaths<Collection, `name`, 2>): Promise<NonNullablePaths<CreateCollectionResponse, `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>>;
|
|
198
191
|
}
|
|
199
192
|
declare function updateCollection$1(httpClient: HttpClient): UpdateCollectionSignature;
|
|
200
193
|
interface UpdateCollectionSignature {
|
|
@@ -203,7 +196,7 @@ interface UpdateCollectionSignature {
|
|
|
203
196
|
* @param - Collection ID (generated automatically by the catalog).
|
|
204
197
|
* @param - Collection info to update.
|
|
205
198
|
*/
|
|
206
|
-
(_id: string, collection: UpdateCollection): Promise<NonNullablePaths<UpdateCollectionResponse, `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
|
|
199
|
+
(_id: string, collection: UpdateCollection): Promise<NonNullablePaths<UpdateCollectionResponse, `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>>;
|
|
207
200
|
}
|
|
208
201
|
declare function deleteCollection$1(httpClient: HttpClient): DeleteCollectionSignature;
|
|
209
202
|
interface DeleteCollectionSignature {
|
|
@@ -228,7 +221,7 @@ interface BulkUpdateProductsPropertySignature {
|
|
|
228
221
|
* @param - Product IDs.
|
|
229
222
|
* @param - Field to update.
|
|
230
223
|
*/
|
|
231
|
-
(ids: string[], set: SetValue): Promise<NonNullablePaths<BulkUpdateProductsResponse, `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
|
|
224
|
+
(ids: string[], set: SetValue): Promise<NonNullablePaths<BulkUpdateProductsResponse, `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>>;
|
|
232
225
|
}
|
|
233
226
|
declare function bulkAdjustProductProperty$1(httpClient: HttpClient): BulkAdjustProductPropertySignature;
|
|
234
227
|
interface BulkAdjustProductPropertySignature {
|
|
@@ -238,7 +231,7 @@ interface BulkAdjustProductPropertySignature {
|
|
|
238
231
|
* @param - Numerical property to adjust.
|
|
239
232
|
* @param - Product IDs.
|
|
240
233
|
*/
|
|
241
|
-
(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
|
|
234
|
+
(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>>;
|
|
242
235
|
}
|
|
243
236
|
declare const onProductCollectionChanged$1: EventDefinition<ProductCollectionChangedEnvelope, "com.wix.ecommerce.catalog.api.v1.CollectionChanged">;
|
|
244
237
|
declare const onProductCollectionCreated$1: EventDefinition<ProductCollectionCreatedEnvelope, "com.wix.ecommerce.catalog.api.v1.CollectionCreated">;
|