@wix/auto_sdk_stores_products 1.0.106 → 1.0.108
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 +49 -20
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +20 -3
- package/build/cjs/meta.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 +49 -20
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +20 -3
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +14 -14
- package/build/internal/cjs/index.typings.d.ts +49 -20
- package/build/internal/cjs/meta.d.ts +20 -3
- package/build/internal/es/index.d.mts +14 -14
- package/build/internal/es/index.typings.d.mts +49 -20
- package/build/internal/es/meta.d.mts +20 -3
- package/package.json +2 -2
package/build/cjs/index.d.ts
CHANGED
|
@@ -8,7 +8,7 @@ interface CreateProductSignature {
|
|
|
8
8
|
* Creates a new product.
|
|
9
9
|
* @param - Product information.
|
|
10
10
|
*/
|
|
11
|
-
(product: NonNullablePaths<Product, `costAndProfitData.itemCost` | `name` | `priceData` | `priceData.price`,
|
|
11
|
+
(product: NonNullablePaths<Product, `costAndProfitData.itemCost` | `name` | `priceData` | `priceData.price`, 1>): Promise<NonNullablePaths<CreateProductResponse, `product._id` | `product.slug` | `product.productType` | `product.weightRange.minValue` | `product.weightRange.maxValue` | `product.productDimensions.unit` | `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`, 5>>;
|
|
12
12
|
}
|
|
13
13
|
declare function updateProduct$1(httpClient: HttpClient): UpdateProductSignature;
|
|
14
14
|
interface UpdateProductSignature {
|
|
@@ -19,7 +19,7 @@ interface UpdateProductSignature {
|
|
|
19
19
|
* @param - Product ID (generated automatically by the catalog).
|
|
20
20
|
* @param - Product info to update.
|
|
21
21
|
*/
|
|
22
|
-
(_id: string, product: UpdateProduct): Promise<NonNullablePaths<UpdateProductResponse, `product._id` | `product.slug` | `product.productType` | `product.weightRange.minValue` | `product.weightRange.maxValue` | `product.productDimensions.unit` | `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`,
|
|
22
|
+
(_id: string, product: UpdateProduct): Promise<NonNullablePaths<UpdateProductResponse, `product._id` | `product.slug` | `product.productType` | `product.weightRange.minValue` | `product.weightRange.maxValue` | `product.productDimensions.unit` | `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`, 5>>;
|
|
23
23
|
}
|
|
24
24
|
declare function deleteProduct$1(httpClient: HttpClient): DeleteProductSignature;
|
|
25
25
|
interface DeleteProductSignature {
|
|
@@ -36,7 +36,7 @@ interface UpdateProductVariantsSignature {
|
|
|
36
36
|
* @param - ID of the product with managed variants.
|
|
37
37
|
* @param - Variant info to update.
|
|
38
38
|
*/
|
|
39
|
-
(_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}.variant.productDimensions.unit` | `variants.${number}.stock.trackQuantity` | `variants.${number}.stock.inStock`,
|
|
39
|
+
(_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}.variant.productDimensions.unit` | `variants.${number}.stock.trackQuantity` | `variants.${number}.stock.inStock`, 4>>;
|
|
40
40
|
}
|
|
41
41
|
declare function resetAllProductVariantData$1(httpClient: HttpClient): ResetAllProductVariantDataSignature;
|
|
42
42
|
interface ResetAllProductVariantDataSignature {
|
|
@@ -96,7 +96,7 @@ interface AddProductMediaToChoicesSignature {
|
|
|
96
96
|
* @param - Product ID.
|
|
97
97
|
* @param - Product media items and the choices to add the media to.
|
|
98
98
|
*/
|
|
99
|
-
(_id: string, media: NonNullablePaths<MediaAssignmentToChoice, `choice` | `option`,
|
|
99
|
+
(_id: string, media: NonNullablePaths<MediaAssignmentToChoice, `choice` | `option`, 0>[]): Promise<void>;
|
|
100
100
|
}
|
|
101
101
|
declare function removeProductMediaFromChoices$1(httpClient: HttpClient): RemoveProductMediaFromChoicesSignature;
|
|
102
102
|
interface RemoveProductMediaFromChoicesSignature {
|
|
@@ -130,7 +130,7 @@ interface CreateCollectionSignature {
|
|
|
130
130
|
* Creates a new collection.
|
|
131
131
|
* @param - Collection info.
|
|
132
132
|
*/
|
|
133
|
-
(collection: NonNullablePaths<Collection, `name`,
|
|
133
|
+
(collection: NonNullablePaths<Collection, `name`, 0>): 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`, 4>>;
|
|
134
134
|
}
|
|
135
135
|
declare function updateCollection$1(httpClient: HttpClient): UpdateCollectionSignature;
|
|
136
136
|
interface UpdateCollectionSignature {
|
|
@@ -139,7 +139,7 @@ interface UpdateCollectionSignature {
|
|
|
139
139
|
* @param - Collection ID (generated automatically by the catalog).
|
|
140
140
|
* @param - Collection info to update.
|
|
141
141
|
*/
|
|
142
|
-
(_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`,
|
|
142
|
+
(_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`, 4>>;
|
|
143
143
|
}
|
|
144
144
|
declare function deleteCollection$1(httpClient: HttpClient): DeleteCollectionSignature;
|
|
145
145
|
interface DeleteCollectionSignature {
|
|
@@ -164,7 +164,7 @@ interface BulkUpdateProductsPropertySignature {
|
|
|
164
164
|
* @param - Product IDs.
|
|
165
165
|
* @param - Field to update.
|
|
166
166
|
*/
|
|
167
|
-
(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`,
|
|
167
|
+
(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`, 4>>;
|
|
168
168
|
}
|
|
169
169
|
declare function bulkAdjustProductProperty$1(httpClient: HttpClient): BulkAdjustProductPropertySignature;
|
|
170
170
|
interface BulkAdjustProductPropertySignature {
|
|
@@ -174,7 +174,7 @@ interface BulkAdjustProductPropertySignature {
|
|
|
174
174
|
* @param - Numerical property to adjust.
|
|
175
175
|
* @param - Product IDs.
|
|
176
176
|
*/
|
|
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`,
|
|
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`, 4>>;
|
|
178
178
|
}
|
|
179
179
|
declare function getProduct$1(httpClient: HttpClient): GetProductSignature;
|
|
180
180
|
interface GetProductSignature {
|
|
@@ -182,7 +182,7 @@ interface GetProductSignature {
|
|
|
182
182
|
* Retrieves a product with the provided ID.
|
|
183
183
|
* @param - Requested product ID.
|
|
184
184
|
*/
|
|
185
|
-
(_id: string, options?: GetProductOptions): Promise<NonNullablePaths<GetProductResponse, `product._id` | `product.slug` | `product.productType` | `product.weightRange.minValue` | `product.weightRange.maxValue` | `product.productDimensions.unit` | `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`,
|
|
185
|
+
(_id: string, options?: GetProductOptions): Promise<NonNullablePaths<GetProductResponse, `product._id` | `product.slug` | `product.productType` | `product.weightRange.minValue` | `product.weightRange.maxValue` | `product.productDimensions.unit` | `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`, 5>>;
|
|
186
186
|
}
|
|
187
187
|
declare function getCollectionBySlug$1(httpClient: HttpClient): GetCollectionBySlugSignature;
|
|
188
188
|
interface GetCollectionBySlugSignature {
|
|
@@ -190,7 +190,7 @@ interface GetCollectionBySlugSignature {
|
|
|
190
190
|
* Retrieves a collection with the provided slug.
|
|
191
191
|
* @param - Slug of the collection to retrieve.
|
|
192
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`,
|
|
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`, 4>>;
|
|
194
194
|
}
|
|
195
195
|
declare function getProductOptionsAvailability$1(httpClient: HttpClient): GetProductOptionsAvailabilitySignature;
|
|
196
196
|
interface GetProductOptionsAvailabilitySignature {
|
|
@@ -199,7 +199,7 @@ interface GetProductOptionsAvailabilitySignature {
|
|
|
199
199
|
* @param - Requested product ID.
|
|
200
200
|
* @param - Array containing the selected options. For example, `{"color": "Blue", "size": "Large"}`.
|
|
201
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` | `selectedVariant.productDimensions.unit` | `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`,
|
|
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` | `selectedVariant.productDimensions.unit` | `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`, 3>>;
|
|
203
203
|
}
|
|
204
204
|
declare function queryProductVariants$1(httpClient: HttpClient): QueryProductVariantsSignature;
|
|
205
205
|
interface QueryProductVariantsSignature {
|
|
@@ -208,7 +208,7 @@ interface QueryProductVariantsSignature {
|
|
|
208
208
|
* See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.
|
|
209
209
|
* @param - Requested product ID.
|
|
210
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}.variant.productDimensions.unit` | `variants.${number}.stock.trackQuantity` | `variants.${number}.stock.inStock` | `metadata.items` | `metadata.offset` | `totalResults`,
|
|
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}.variant.productDimensions.unit` | `variants.${number}.stock.trackQuantity` | `variants.${number}.stock.inStock` | `metadata.items` | `metadata.offset` | `totalResults`, 4>>;
|
|
212
212
|
}
|
|
213
213
|
declare function queryStoreVariants$1(httpClient: HttpClient): QueryStoreVariantsSignature;
|
|
214
214
|
interface QueryStoreVariantsSignature {
|
|
@@ -216,7 +216,7 @@ interface QueryStoreVariantsSignature {
|
|
|
216
216
|
* Retrieves up to 100 store variants, given the provided paging, filtering, and sorting.
|
|
217
217
|
* @param - Query options.
|
|
218
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`,
|
|
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`, 3>>;
|
|
220
220
|
}
|
|
221
221
|
declare function getStoreVariant$1(httpClient: HttpClient): GetStoreVariantSignature;
|
|
222
222
|
interface GetStoreVariantSignature {
|
|
@@ -224,7 +224,7 @@ interface GetStoreVariantSignature {
|
|
|
224
224
|
* Retrieves a store variant with the provided ID.
|
|
225
225
|
* @param - Store variant ID. Comprised of the `productId` and the `variantId`, separated by a hyphen. For example, `{productId}-{variantId}`.
|
|
226
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`,
|
|
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`, 2>>;
|
|
228
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">;
|