@wix/auto_sdk_stores_products 1.0.23 → 1.0.24

package/build/cjs/index.d.ts

@@ -1,14 +1,17 @@
-import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
 import { Product, CreateProductResponse, UpdateProduct, UpdateProductResponse, VariantOverride, UpdateVariantsResponse, MediaDataForWrite, MediaAssignmentToChoice, Collection, CreateCollectionResponse, UpdateCollection, UpdateCollectionResponse, SetValue, BulkUpdateProductsResponse, AdjustValue, BulkAdjustProductPropertiesResponse, ProductsQueryBuilder, GetProductOptions, GetProductResponse, GetCollectionBySlugResponse, ProductOptionsAvailabilityResponse, QueryProductVariantsOptions, QueryProductVariantsResponse, PlatformQuery, QueryStoreVariantsResponse, GetStoreVariantResponse, ProductCollectionChangedEnvelope, ProductCollectionCreatedEnvelope, ProductCollectionDeletedEnvelope, ProductChangedEnvelope, ProductCreatedEnvelope, ProductDeletedEnvelope, ProductVariantsChangedEnvelope } from './index.typings.js';
 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';
 
+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`;
 declare function createProduct$1(httpClient: HttpClient): CreateProductSignature;
 interface CreateProductSignature {
     /**
      * Creates a new product.
      * @param - Product information.
      */
-    (product: Product): Promise<CreateProductResponse>;
+    (product: NonNullablePaths<Product, `costAndProfitData.itemCost` | `name` | `priceData` | `priceData.price`>): Promise<NonNullablePaths<CreateProductResponse, {
+        [P in ProductNonNullablePaths]: `product.${P}`;
+    }[ProductNonNullablePaths]>>;
 }
 declare function updateProduct$1(httpClient: HttpClient): UpdateProductSignature;
 interface UpdateProductSignature {
@@ -19,7 +22,9 @@ interface UpdateProductSignature {
      * @param - Product ID (generated automatically by the catalog).
      * @param - Product info to update.
      */
-    (_id: string, product: UpdateProduct): Promise<UpdateProductResponse>;
+    (_id: string, product: UpdateProduct): Promise<NonNullablePaths<UpdateProductResponse, {
+        [P in ProductNonNullablePaths]: `product.${P}`;
+    }[ProductNonNullablePaths]>>;
 }
 declare function deleteProduct$1(httpClient: HttpClient): DeleteProductSignature;
 interface DeleteProductSignature {
@@ -36,7 +41,7 @@ interface UpdateProductVariantsSignature {
      * @param - ID of the product with managed variants.
      * @param - Variant info to update.
      */
-    (_id: string, variants: VariantOverride[]): Promise<UpdateVariantsResponse>;
+    (_id: string, variants: VariantOverride[]): Promise<NonNullablePaths<UpdateVariantsResponse, `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`>>;
 }
 declare function resetAllProductVariantData$1(httpClient: HttpClient): ResetAllProductVariantDataSignature;
 interface ResetAllProductVariantDataSignature {
@@ -96,7 +101,7 @@ interface AddProductMediaToChoicesSignature {
      * @param - Product ID.
      * @param - Product media items and the choices to add the media to.
      */
-    (_id: string, media: MediaAssignmentToChoice[]): Promise<void>;
+    (_id: string, media: NonNullablePaths<MediaAssignmentToChoice, `choice` | `option`>[]): Promise<void>;
 }
 declare function removeProductMediaFromChoices$1(httpClient: HttpClient): RemoveProductMediaFromChoicesSignature;
 interface RemoveProductMediaFromChoicesSignature {
@@ -130,7 +135,7 @@ interface CreateCollectionSignature {
      * Creates a new collection.
      * @param - Collection info.
      */
-    (collection: Collection): Promise<CreateCollectionResponse>;
+    (collection: NonNullablePaths<Collection, `name`>): 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`>>;
 }
 declare function updateCollection$1(httpClient: HttpClient): UpdateCollectionSignature;
 interface UpdateCollectionSignature {
@@ -139,7 +144,7 @@ interface UpdateCollectionSignature {
      * @param - Collection ID (generated automatically by the catalog).
      * @param - Collection info to update.
      */
-    (_id: string, collection: UpdateCollection): Promise<UpdateCollectionResponse>;
+    (_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`>>;
 }
 declare function deleteCollection$1(httpClient: HttpClient): DeleteCollectionSignature;
 interface DeleteCollectionSignature {
@@ -164,7 +169,7 @@ interface BulkUpdateProductsPropertySignature {
      * @param - Product IDs.
      * @param - Field to update.
      */
-    (ids: string[], set: SetValue): Promise<BulkUpdateProductsResponse>;
+    (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`>>;
 }
 declare function bulkAdjustProductProperty$1(httpClient: HttpClient): BulkAdjustProductPropertySignature;
 interface BulkAdjustProductPropertySignature {
@@ -174,7 +179,7 @@ interface BulkAdjustProductPropertySignature {
      * @param - Numerical property to adjust.
      * @param - Product IDs.
      */
-    (adjust: AdjustValue, ids: string[]): Promise<BulkAdjustProductPropertiesResponse>;
+    (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`>>;
 }
 declare function queryProducts$1(httpClient: HttpClient): QueryProductsSignature;
 interface QueryProductsSignature {
@@ -189,7 +194,9 @@ interface GetProductSignature {
      * Retrieves a product with the provided ID.
      * @param - Requested product ID.
      */
-    (_id: string, options?: GetProductOptions | undefined): Promise<GetProductResponse>;
+    (_id: string, options?: GetProductOptions): Promise<NonNullablePaths<GetProductResponse, {
+        [P in ProductNonNullablePaths]: `product.${P}`;
+    }[ProductNonNullablePaths]>>;
 }
 declare function getCollectionBySlug$1(httpClient: HttpClient): GetCollectionBySlugSignature;
 interface GetCollectionBySlugSignature {
@@ -197,7 +204,7 @@ interface GetCollectionBySlugSignature {
      * Retrieves a collection with the provided slug.
      * @param - Slug of the collection to retrieve.
      */
-    (slug: string): Promise<GetCollectionBySlugResponse>;
+    (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`>>;
 }
 declare function getProductOptionsAvailability$1(httpClient: HttpClient): GetProductOptionsAvailabilitySignature;
 interface GetProductOptionsAvailabilitySignature {
@@ -206,7 +213,7 @@ interface GetProductOptionsAvailabilitySignature {
      * @param - Requested product ID.
      * @param - Array containing the selected options. For example, `["color": "Blue", "size": "Large"]`.
      */
-    (_id: string, options: Record<string, string>): Promise<ProductOptionsAvailabilityResponse>;
+    (_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`>>;
 }
 declare function queryProductVariants$1(httpClient: HttpClient): QueryProductVariantsSignature;
 interface QueryProductVariantsSignature {
@@ -215,7 +222,7 @@ interface QueryProductVariantsSignature {
      * See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.
      * @param - Requested product ID.
      */
-    (_id: string, options?: QueryProductVariantsOptions | undefined): Promise<QueryProductVariantsResponse>;
+    (_id: string, options?: QueryProductVariantsOptions): Promise<NonNullablePaths<QueryProductVariantsResponse, `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` | `metadata.items` | `metadata.offset` | `totalResults`>>;
 }
 declare function queryStoreVariants$1(httpClient: HttpClient): QueryStoreVariantsSignature;
 interface QueryStoreVariantsSignature {
@@ -223,7 +230,7 @@ interface QueryStoreVariantsSignature {
      * Retrieves up to 100 store variants, given the provided paging, filtering, and sorting.
      * @param - Query options.
      */
-    (query: PlatformQuery): Promise<QueryStoreVariantsResponse>;
+    (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`>>;
 }
 declare function getStoreVariant$1(httpClient: HttpClient): GetStoreVariantSignature;
 interface GetStoreVariantSignature {
@@ -231,7 +238,7 @@ interface GetStoreVariantSignature {
      * Retrieves a store variant with the provided ID.
      * @param - Store variant ID. Comprised of the `productId` and the `variantId`, separated by a hyphen. For example, `{productId}-{variantId}`.
      */
-    (_id: string): Promise<GetStoreVariantResponse>;
+    (_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`>>;
 }
 declare const onProductCollectionChanged$1: EventDefinition<ProductCollectionChangedEnvelope, "com.wix.ecommerce.catalog.api.v1.CollectionChanged">;
 declare const onProductCollectionCreated$1: EventDefinition<ProductCollectionCreatedEnvelope, "com.wix.ecommerce.catalog.api.v1.CollectionCreated">;