@wix/auto_sdk_stores_products 1.0.28 → 1.0.30
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 +14 -14
- 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 +14 -14
- 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 +14 -14
- 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 +14 -14
- 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 +2 -2
package/build/cjs/index.d.ts
CHANGED
|
@@ -15,7 +15,7 @@ interface GetProductSignature {
|
|
|
15
15
|
* Retrieves a product with the provided ID.
|
|
16
16
|
* @param - Requested product ID.
|
|
17
17
|
*/
|
|
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
|
|
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>>;
|
|
19
19
|
}
|
|
20
20
|
declare function getCollectionBySlug$1(httpClient: HttpClient): GetCollectionBySlugSignature;
|
|
21
21
|
interface GetCollectionBySlugSignature {
|
|
@@ -23,7 +23,7 @@ interface GetCollectionBySlugSignature {
|
|
|
23
23
|
* Retrieves a collection with the provided slug.
|
|
24
24
|
* @param - Slug of the collection to retrieve.
|
|
25
25
|
*/
|
|
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
|
|
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>>;
|
|
27
27
|
}
|
|
28
28
|
declare function getProductOptionsAvailability$1(httpClient: HttpClient): GetProductOptionsAvailabilitySignature;
|
|
29
29
|
interface GetProductOptionsAvailabilitySignature {
|
|
@@ -32,7 +32,7 @@ interface GetProductOptionsAvailabilitySignature {
|
|
|
32
32
|
* @param - Requested product ID.
|
|
33
33
|
* @param - Array containing the selected options. For example, `["color": "Blue", "size": "Large"]`.
|
|
34
34
|
*/
|
|
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
|
|
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>>;
|
|
36
36
|
}
|
|
37
37
|
declare function queryProductVariants$1(httpClient: HttpClient): QueryProductVariantsSignature;
|
|
38
38
|
interface QueryProductVariantsSignature {
|
|
@@ -41,7 +41,7 @@ interface QueryProductVariantsSignature {
|
|
|
41
41
|
* See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.
|
|
42
42
|
* @param - Requested product ID.
|
|
43
43
|
*/
|
|
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
|
|
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>>;
|
|
45
45
|
}
|
|
46
46
|
declare function queryStoreVariants$1(httpClient: HttpClient): QueryStoreVariantsSignature;
|
|
47
47
|
interface QueryStoreVariantsSignature {
|
|
@@ -49,7 +49,7 @@ interface QueryStoreVariantsSignature {
|
|
|
49
49
|
* Retrieves up to 100 store variants, given the provided paging, filtering, and sorting.
|
|
50
50
|
* @param - Query options.
|
|
51
51
|
*/
|
|
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
|
|
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>>;
|
|
53
53
|
}
|
|
54
54
|
declare function getStoreVariant$1(httpClient: HttpClient): GetStoreVariantSignature;
|
|
55
55
|
interface GetStoreVariantSignature {
|
|
@@ -57,7 +57,7 @@ interface GetStoreVariantSignature {
|
|
|
57
57
|
* Retrieves a store variant with the provided ID.
|
|
58
58
|
* @param - Store variant ID. Comprised of the `productId` and the `variantId`, separated by a hyphen. For example, `{productId}-{variantId}`.
|
|
59
59
|
*/
|
|
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
|
|
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>>;
|
|
61
61
|
}
|
|
62
62
|
declare function createProduct$1(httpClient: HttpClient): CreateProductSignature;
|
|
63
63
|
interface CreateProductSignature {
|
|
@@ -65,7 +65,7 @@ interface CreateProductSignature {
|
|
|
65
65
|
* Creates a new product.
|
|
66
66
|
* @param - Product information.
|
|
67
67
|
*/
|
|
68
|
-
(product: NonNullablePaths<Product, `costAndProfitData.itemCost` | `name` | `priceData` | `priceData.price
|
|
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>>;
|
|
69
69
|
}
|
|
70
70
|
declare function updateProduct$1(httpClient: HttpClient): UpdateProductSignature;
|
|
71
71
|
interface UpdateProductSignature {
|
|
@@ -76,7 +76,7 @@ interface UpdateProductSignature {
|
|
|
76
76
|
* @param - Product ID (generated automatically by the catalog).
|
|
77
77
|
* @param - Product info to update.
|
|
78
78
|
*/
|
|
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
|
|
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>>;
|
|
80
80
|
}
|
|
81
81
|
declare function deleteProduct$1(httpClient: HttpClient): DeleteProductSignature;
|
|
82
82
|
interface DeleteProductSignature {
|
|
@@ -93,7 +93,7 @@ interface UpdateProductVariantsSignature {
|
|
|
93
93
|
* @param - ID of the product with managed variants.
|
|
94
94
|
* @param - Variant info to update.
|
|
95
95
|
*/
|
|
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
|
|
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>>;
|
|
97
97
|
}
|
|
98
98
|
declare function resetAllProductVariantData$1(httpClient: HttpClient): ResetAllProductVariantDataSignature;
|
|
99
99
|
interface ResetAllProductVariantDataSignature {
|
|
@@ -153,7 +153,7 @@ interface AddProductMediaToChoicesSignature {
|
|
|
153
153
|
* @param - Product ID.
|
|
154
154
|
* @param - Product media items and the choices to add the media to.
|
|
155
155
|
*/
|
|
156
|
-
(_id: string, media: NonNullablePaths<MediaAssignmentToChoice, `choice` | `option
|
|
156
|
+
(_id: string, media: NonNullablePaths<MediaAssignmentToChoice, `choice` | `option`, 2>[]): Promise<void>;
|
|
157
157
|
}
|
|
158
158
|
declare function removeProductMediaFromChoices$1(httpClient: HttpClient): RemoveProductMediaFromChoicesSignature;
|
|
159
159
|
interface RemoveProductMediaFromChoicesSignature {
|
|
@@ -187,7 +187,7 @@ interface CreateCollectionSignature {
|
|
|
187
187
|
* Creates a new collection.
|
|
188
188
|
* @param - Collection info.
|
|
189
189
|
*/
|
|
190
|
-
(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>>;
|
|
191
191
|
}
|
|
192
192
|
declare function updateCollection$1(httpClient: HttpClient): UpdateCollectionSignature;
|
|
193
193
|
interface UpdateCollectionSignature {
|
|
@@ -196,7 +196,7 @@ interface UpdateCollectionSignature {
|
|
|
196
196
|
* @param - Collection ID (generated automatically by the catalog).
|
|
197
197
|
* @param - Collection info to update.
|
|
198
198
|
*/
|
|
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
|
|
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>>;
|
|
200
200
|
}
|
|
201
201
|
declare function deleteCollection$1(httpClient: HttpClient): DeleteCollectionSignature;
|
|
202
202
|
interface DeleteCollectionSignature {
|
|
@@ -221,7 +221,7 @@ interface BulkUpdateProductsPropertySignature {
|
|
|
221
221
|
* @param - Product IDs.
|
|
222
222
|
* @param - Field to update.
|
|
223
223
|
*/
|
|
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
|
|
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>>;
|
|
225
225
|
}
|
|
226
226
|
declare function bulkAdjustProductProperty$1(httpClient: HttpClient): BulkAdjustProductPropertySignature;
|
|
227
227
|
interface BulkAdjustProductPropertySignature {
|
|
@@ -231,7 +231,7 @@ interface BulkAdjustProductPropertySignature {
|
|
|
231
231
|
* @param - Numerical property to adjust.
|
|
232
232
|
* @param - Product IDs.
|
|
233
233
|
*/
|
|
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
|
|
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>>;
|
|
235
235
|
}
|
|
236
236
|
declare const onProductCollectionChanged$1: EventDefinition<ProductCollectionChangedEnvelope, "com.wix.ecommerce.catalog.api.v1.CollectionChanged">;
|
|
237
237
|
declare const onProductCollectionCreated$1: EventDefinition<ProductCollectionCreatedEnvelope, "com.wix.ecommerce.catalog.api.v1.CollectionCreated">;
|