@wix/auto_sdk_stores_customizations-v-3 1.0.24 → 1.0.26

package/build/cjs/index.d.ts

@@ -1,7 +1,8 @@
-import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
 import { Customization, CreateCustomizationApplicationErrors, CreateCustomizationValidationErrors, GetCustomizationOptions, UpdateCustomization, UpdateCustomizationOptions, DeleteCustomizationValidationErrors, QueryCustomizationsOptions, CustomizationsQueryBuilder, BulkCreateCustomizationsOptions, BulkCreateCustomizationsResponse, BulkCreateCustomizationsApplicationErrors, BulkCreateCustomizationsValidationErrors, Choice, AddCustomizationChoicesOptions, AddCustomizationChoicesResponse, AddCustomizationChoicesApplicationErrors, AddCustomizationChoicesValidationErrors, SetCustomizationChoicesOptions, SetCustomizationChoicesResponse, SetCustomizationChoicesApplicationErrors, SetCustomizationChoicesValidationErrors, RemoveCustomizationChoicesOptions, RemoveCustomizationChoicesResponse, RemoveCustomizationChoicesApplicationErrors, RemoveCustomizationChoicesValidationErrors, CustomizationChoices, BulkAddCustomizationChoicesOptions, BulkAddCustomizationChoicesResponse, BulkAddCustomizationChoicesApplicationErrors, BulkAddCustomizationChoicesValidationErrors, MaskedCustomization, BulkUpdateCustomizationsOptions, BulkUpdateCustomizationsResponse, CustomizationCreatedEnvelope, CustomizationDeletedEnvelope, CustomizationUpdatedEnvelope } from './index.typings.js';
 export { ActionEvent, AddCustomizationChoicesRequest, App, ApplicationError, BaseEventMetadata, BulkActionMetadata, BulkAddCustomizationChoicesRequest, BulkCreateCustomizationsRequest, BulkCustomizationResult, BulkUpdateCustomizationsRequest, ChoiceType, ChoiceValueOneOf, ChoicesSettings, CreateCustomizationRequest, CreateCustomizationResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, CustomTag, CustomizationCustomizationSettingsOneOf, CustomizationIdsWrapper, CustomizationRenderType, CustomizationType, CustomizationsQueryResult, DeleteCustomizationRequest, DeleteCustomizationResponse, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, File, FocalPoint, FreeTextSettings, GetCustomizationRequest, GetCustomizationResponse, IdentificationData, IdentificationDataIdOneOf, InvalidateCache, InvalidateCacheGetByOneOf, ItemMetadata, MessageEnvelope, MultipleColors, Page, QueryCustomizationsRequest, QueryCustomizationsResponse, RemoveCustomizationChoicesRequest, RequestedFields, RestoreInfo, SetCustomizationChoicesRequest, SortOrder, Sorting, URI, UpdateCustomizationRequest, UpdateCustomizationResponse, WebhookIdentityType } from './index.typings.js';
 
+type CustomizationNonNullablePaths = `freeTextInput.minCharCount` | `freeTextInput.maxCharCount` | `freeTextInput.title` | `choicesSettings.choices` | `choicesSettings.choices.${number}.colorCode` | `choicesSettings.choices.${number}._id` | `choicesSettings.choices.${number}.choiceType` | `choicesSettings.choices.${number}.name` | `choicesSettings.choices.${number}.assignedProductsCount` | `name` | `customizationType` | `customizationRenderType`;
 declare function createCustomization$1(httpClient: HttpClient): CreateCustomizationSignature;
 interface CreateCustomizationSignature {
     /**
@@ -9,9 +10,9 @@ interface CreateCustomizationSignature {
      * @param - Customization to create.
      * @returns Created customization.
      */
-    (customization: Customization): Promise<Customization & {
-        __applicationErrorsType?: CreateCustomizationApplicationErrors | undefined;
-        __validationErrorsType?: CreateCustomizationValidationErrors | undefined;
+    (customization: NonNullablePaths<Customization, `choicesSettings.choices` | `customizationRenderType` | `customizationType` | `freeTextInput.title` | `name`>): Promise<NonNullablePaths<Customization, CustomizationNonNullablePaths> & {
+        __applicationErrorsType?: CreateCustomizationApplicationErrors;
+        __validationErrorsType?: CreateCustomizationValidationErrors;
     }>;
 }
 declare function getCustomization$1(httpClient: HttpClient): GetCustomizationSignature;
@@ -21,7 +22,7 @@ interface GetCustomizationSignature {
      * @param - Customization ID.
      * @returns Customization.
      */
-    (customizationId: string, options?: GetCustomizationOptions | undefined): Promise<Customization>;
+    (customizationId: string, options?: GetCustomizationOptions): Promise<NonNullablePaths<Customization, CustomizationNonNullablePaths>>;
 }
 declare function updateCustomization$1(httpClient: HttpClient): UpdateCustomizationSignature;
 interface UpdateCustomizationSignature {
@@ -34,7 +35,7 @@ interface UpdateCustomizationSignature {
      * @param - Customization ID.
      * @returns Updated customization.
      */
-    (_id: string, customization: UpdateCustomization, options?: UpdateCustomizationOptions | undefined): Promise<Customization>;
+    (_id: string, customization: NonNullablePaths<UpdateCustomization, `revision`>, options?: UpdateCustomizationOptions): Promise<NonNullablePaths<Customization, CustomizationNonNullablePaths>>;
 }
 declare function deleteCustomization$1(httpClient: HttpClient): DeleteCustomizationSignature;
 interface DeleteCustomizationSignature {
@@ -45,7 +46,7 @@ interface DeleteCustomizationSignature {
      * @param - Customization ID.
      */
     (customizationId: string): Promise<void & {
-        __validationErrorsType?: DeleteCustomizationValidationErrors | undefined;
+        __validationErrorsType?: DeleteCustomizationValidationErrors;
     }>;
 }
 declare function queryCustomizations$1(httpClient: HttpClient): QueryCustomizationsSignature;
@@ -67,7 +68,7 @@ interface QueryCustomizationsSignature {
      * [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),
      * and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
      */
-    (options?: QueryCustomizationsOptions | undefined): CustomizationsQueryBuilder;
+    (options?: QueryCustomizationsOptions): CustomizationsQueryBuilder;
 }
 declare function bulkCreateCustomizations$1(httpClient: HttpClient): BulkCreateCustomizationsSignature;
 interface BulkCreateCustomizationsSignature {
@@ -75,9 +76,11 @@ interface BulkCreateCustomizationsSignature {
      * Creates multiple brands.
      * @param - Customizations to create.
      */
-    (customizations: Customization[], options?: BulkCreateCustomizationsOptions | undefined): Promise<BulkCreateCustomizationsResponse & {
-        __applicationErrorsType?: BulkCreateCustomizationsApplicationErrors | undefined;
-        __validationErrorsType?: BulkCreateCustomizationsValidationErrors | undefined;
+    (customizations: Customization[], options?: BulkCreateCustomizationsOptions): Promise<NonNullablePaths<BulkCreateCustomizationsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
+        [P in CustomizationNonNullablePaths]: `results.${number}.customization.${P}`;
+    }[CustomizationNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`> & {
+        __applicationErrorsType?: BulkCreateCustomizationsApplicationErrors;
+        __validationErrorsType?: BulkCreateCustomizationsValidationErrors;
     }>;
 }
 declare function addCustomizationChoices$1(httpClient: HttpClient): AddCustomizationChoicesSignature;
@@ -87,9 +90,11 @@ interface AddCustomizationChoicesSignature {
      * @param - Customization ID.
      * @param - Choices to add.
      */
-    (customizationId: string, choices: Choice[], options?: AddCustomizationChoicesOptions | undefined): Promise<AddCustomizationChoicesResponse & {
-        __applicationErrorsType?: AddCustomizationChoicesApplicationErrors | undefined;
-        __validationErrorsType?: AddCustomizationChoicesValidationErrors | undefined;
+    (customizationId: string, choices: Choice[], options?: AddCustomizationChoicesOptions): Promise<NonNullablePaths<AddCustomizationChoicesResponse, {
+        [P in CustomizationNonNullablePaths]: `customization.${P}`;
+    }[CustomizationNonNullablePaths]> & {
+        __applicationErrorsType?: AddCustomizationChoicesApplicationErrors;
+        __validationErrorsType?: AddCustomizationChoicesValidationErrors;
     }>;
 }
 declare function setCustomizationChoices$1(httpClient: HttpClient): SetCustomizationChoicesSignature;
@@ -101,9 +106,11 @@ interface SetCustomizationChoicesSignature {
      * @param - Customization ID.
      * @param - Choices to set.
      */
-    (customizationId: string, choices: Choice[], options?: SetCustomizationChoicesOptions | undefined): Promise<SetCustomizationChoicesResponse & {
-        __applicationErrorsType?: SetCustomizationChoicesApplicationErrors | undefined;
-        __validationErrorsType?: SetCustomizationChoicesValidationErrors | undefined;
+    (customizationId: string, choices: Choice[], options?: SetCustomizationChoicesOptions): Promise<NonNullablePaths<SetCustomizationChoicesResponse, {
+        [P in CustomizationNonNullablePaths]: `customization.${P}`;
+    }[CustomizationNonNullablePaths]> & {
+        __applicationErrorsType?: SetCustomizationChoicesApplicationErrors;
+        __validationErrorsType?: SetCustomizationChoicesValidationErrors;
     }>;
 }
 declare function removeCustomizationChoices$1(httpClient: HttpClient): RemoveCustomizationChoicesSignature;
@@ -115,9 +122,11 @@ interface RemoveCustomizationChoicesSignature {
      * @param - Customization ID.
      * @param - IDs of choices to remove.
      */
-    (customizationId: string, choiceIds: string[], options?: RemoveCustomizationChoicesOptions | undefined): Promise<RemoveCustomizationChoicesResponse & {
-        __applicationErrorsType?: RemoveCustomizationChoicesApplicationErrors | undefined;
-        __validationErrorsType?: RemoveCustomizationChoicesValidationErrors | undefined;
+    (customizationId: string, choiceIds: string[], options?: RemoveCustomizationChoicesOptions): Promise<NonNullablePaths<RemoveCustomizationChoicesResponse, {
+        [P in CustomizationNonNullablePaths]: `customization.${P}`;
+    }[CustomizationNonNullablePaths]> & {
+        __applicationErrorsType?: RemoveCustomizationChoicesApplicationErrors;
+        __validationErrorsType?: RemoveCustomizationChoicesValidationErrors;
     }>;
 }
 declare function bulkAddCustomizationChoices$1(httpClient: HttpClient): BulkAddCustomizationChoicesSignature;
@@ -126,9 +135,11 @@ interface BulkAddCustomizationChoicesSignature {
      * Adds choices to multiple customizations.
      * @param - List of customization IDs and choices.
      */
-    (customizationsChoices: CustomizationChoices[], options?: BulkAddCustomizationChoicesOptions | undefined): Promise<BulkAddCustomizationChoicesResponse & {
-        __applicationErrorsType?: BulkAddCustomizationChoicesApplicationErrors | undefined;
-        __validationErrorsType?: BulkAddCustomizationChoicesValidationErrors | undefined;
+    (customizationsChoices: NonNullablePaths<CustomizationChoices, `choices` | `customizationId`>[], options?: BulkAddCustomizationChoicesOptions): Promise<NonNullablePaths<BulkAddCustomizationChoicesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
+        [P in CustomizationNonNullablePaths]: `results.${number}.customization.${P}`;
+    }[CustomizationNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`> & {
+        __applicationErrorsType?: BulkAddCustomizationChoicesApplicationErrors;
+        __validationErrorsType?: BulkAddCustomizationChoicesValidationErrors;
     }>;
 }
 declare function bulkUpdateCustomizations$1(httpClient: HttpClient): BulkUpdateCustomizationsSignature;
@@ -141,7 +152,9 @@ interface BulkUpdateCustomizationsSignature {
      * This ensures you're working with the latest customization and prevents unintended overwrites.
      * @param - List of customizations to update.
      */
-    (customizations: MaskedCustomization[], options?: BulkUpdateCustomizationsOptions | undefined): Promise<BulkUpdateCustomizationsResponse>;
+    (customizations: NonNullablePaths<MaskedCustomization, `customization._id` | `customization.name` | `customization.revision`>[], options?: BulkUpdateCustomizationsOptions): Promise<NonNullablePaths<BulkUpdateCustomizationsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
+        [P in CustomizationNonNullablePaths]: `results.${number}.customization.${P}`;
+    }[CustomizationNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
 }
 declare const onCustomizationCreated$1: EventDefinition<CustomizationCreatedEnvelope, "wix.stores.catalog.v3.customization_created">;
 declare const onCustomizationDeleted$1: EventDefinition<CustomizationDeletedEnvelope, "wix.stores.catalog.v3.customization_deleted">;