@wix/auto_sdk_stores_customizations-v-3 1.0.43 → 1.0.45

package/build/es/index.typings.d.mts

@@ -1,4 +1,4 @@
-import { NonNullablePaths } from '@wix/sdk-types';
+import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
 
 /**
  * Customizations include options and modifiers which can later be applied to products.
@@ -150,8 +150,8 @@ interface Choice extends ChoiceValueOneOf {
      * Choice type.
      *
      * > **Notes:**
-     * > + For `customizationRenderType: SWATCH_CHOICES`, the supported `choiceType` values are: `ONE_COLOR`, `MULTIPLE_COLORS`, or `IMAGE`.
-     * > + For a `customizationRenderType` of `TEXT_CHOICES` and `FREE_TEXT`, the supported `choiceType` value is: `CHOICE_TEXT`.
+     * > + For `customizationRenderType: SWATCH_CHOICES`, the supported `choiceType` value is: `ONE_COLOR`.
+     * > + For a `customizationRenderType` of `TEXT_CHOICES`, the supported `choiceType` value is: `CHOICE_TEXT`.
      * @immutable
      */
     choiceType?: ChoiceTypeWithLiterals;
@@ -191,17 +191,13 @@ interface ChoiceValueOneOf {
 }
 declare enum ChoiceType {
     UNKNOWN_CHOICE_TYPE = "UNKNOWN_CHOICE_TYPE",
-    /** For a `customizationRenderType` of `TEXT_CHOICES` and `FREE_TEXT`. */
+    /** For a `customizationRenderType` of `TEXT_CHOICES`. */
     CHOICE_TEXT = "CHOICE_TEXT",
     /** For `customizationRenderType: SWATCH_CHOICES`. */
-    ONE_COLOR = "ONE_COLOR",
-    /** For `customizationRenderType: SWATCH_CHOICES`. */
-    MULTIPLE_COLORS = "MULTIPLE_COLORS",
-    /** For `customizationRenderType: SWATCH_CHOICES`. */
-    IMAGE = "IMAGE"
+    ONE_COLOR = "ONE_COLOR"
 }
 /** @enumType */
-type ChoiceTypeWithLiterals = ChoiceType | 'UNKNOWN_CHOICE_TYPE' | 'CHOICE_TEXT' | 'ONE_COLOR' | 'MULTIPLE_COLORS' | 'IMAGE';
+type ChoiceTypeWithLiterals = ChoiceType | 'UNKNOWN_CHOICE_TYPE' | 'CHOICE_TEXT' | 'ONE_COLOR';
 interface MultipleColors {
     /**
      * A list of color codes.
@@ -791,6 +787,12 @@ interface ActionEvent {
 }
 interface Empty {
 }
+interface RecloneSiteRequest {
+    /** @format GUID */
+    cloneFrom?: string;
+}
+interface RecloneSiteResponse {
+}
 interface MessageEnvelope {
     /**
      * App instance ID.
@@ -1112,6 +1114,7 @@ declare function onCustomizationDeleted(handler: (event: CustomizationDeletedEnv
 interface CustomizationUpdatedEnvelope {
     entity: Customization;
     metadata: EventMetadata;
+    modifiedFields: Record<string, any>;
 }
 /**
  * Triggered when a customization is updated.
@@ -1382,7 +1385,68 @@ interface CustomizationsQueryBuilder {
  * @fqn wix.stores.catalog.customization.v3.CustomizationService.QueryCustomizations
  * @requiredField query
  */
-declare function typedQueryCustomizations(query: CursorQuery, options?: QueryCustomizationsOptions): Promise<NonNullablePaths<QueryCustomizationsResponse, `customizations` | `customizations.${number}.freeTextInput.minCharCount` | `customizations.${number}.freeTextInput.maxCharCount` | `customizations.${number}.freeTextInput.title` | `customizations.${number}.name` | `customizations.${number}.customizationType` | `customizations.${number}.customizationRenderType`, 5>>;
+declare function typedQueryCustomizations(query: CustomizationQuery, options?: QueryCustomizationsOptions): Promise<NonNullablePaths<QueryCustomizationsResponse, `customizations` | `customizations.${number}.freeTextInput.minCharCount` | `customizations.${number}.freeTextInput.maxCharCount` | `customizations.${number}.freeTextInput.title` | `customizations.${number}.name` | `customizations.${number}.customizationType` | `customizations.${number}.customizationRenderType`, 5>>;
+interface CustomizationQuerySpec extends QuerySpec {
+    paging: 'cursor';
+    wql: [
+        {
+            fields: ['_createdDate', '_id', '_updatedDate', 'name'];
+            operators: '*';
+            sort: 'BOTH';
+        },
+        {
+            fields: ['customizationRenderType', 'customizationType'];
+            operators: '*';
+            sort: 'NONE';
+        }
+    ];
+}
+type CommonQueryWithEntityContext = Query<Customization, CustomizationQuerySpec>;
+type CustomizationQuery = {
+    /**
+    Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.
+    */
+    cursorPaging?: {
+        /**
+      Maximum number of items to return in the results.
+      @max: 100
+      */
+        limit?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['limit'] | null;
+        /**
+      Pointer to the next or previous page in the list of results.
+    
+      Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+      Not relevant for the first request.
+      @maxLength: 16000
+      */
+        cursor?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['cursor'] | null;
+    };
+    /**
+    Filter object in the following format:
+    `"filter" : {
+    "fieldName1": "value1",
+    "fieldName2":{"$operator":"value2"}
+    }`
+    Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+    */
+    filter?: CommonQueryWithEntityContext['filter'] | null;
+    /**
+    Sort object in the following format:
+    `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+    @maxSize: 5
+    */
+    sort?: {
+        /**
+      Name of the field to sort by.
+      @maxLength: 512
+      */
+        fieldName?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['fieldName'];
+        /**
+      Sort order.
+      */
+        order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
+    }[];
+};
 /**
  * Creates multiple brands.
  * @param customizations - Customizations to create.
@@ -1545,4 +1609,4 @@ interface BulkUpdateCustomizationsOptions {
     fields?: RequestedFieldsWithLiterals[];
 }
 
-export { type ActionEvent, type AddCustomizationChoicesApplicationErrors, type AddCustomizationChoicesOptions, type AddCustomizationChoicesRequest, type AddCustomizationChoicesResponse, type AddCustomizationChoicesValidationErrors, type App, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkAddCustomizationChoicesApplicationErrors, type BulkAddCustomizationChoicesOptions, type BulkAddCustomizationChoicesRequest, type BulkAddCustomizationChoicesResponse, type BulkAddCustomizationChoicesValidationErrors, type BulkCreateCustomizationsApplicationErrors, type BulkCreateCustomizationsOptions, type BulkCreateCustomizationsRequest, type BulkCreateCustomizationsResponse, type BulkCreateCustomizationsValidationErrors, type BulkCustomizationResult, type BulkUpdateCustomizationsOptions, type BulkUpdateCustomizationsRequest, type BulkUpdateCustomizationsResponse, type Choice, ChoiceType, type ChoiceTypeWithLiterals, type ChoiceValueOneOf, type ChoicesSettings, type CreateCustomizationApplicationErrors, type CreateCustomizationRequest, type CreateCustomizationResponse, type CreateCustomizationValidationErrors, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomTag, type Customization, type CustomizationChoices, type CustomizationCreatedEnvelope, type CustomizationCustomizationSettingsOneOf, type CustomizationDeletedEnvelope, type CustomizationIdsWrapper, CustomizationRenderType, type CustomizationRenderTypeWithLiterals, CustomizationType, type CustomizationTypeWithLiterals, type CustomizationUpdatedEnvelope, type CustomizationsQueryBuilder, type CustomizationsQueryResult, type DeleteCustomizationRequest, type DeleteCustomizationResponse, type DeleteCustomizationValidationErrors, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type File, type FocalPoint, type FreeTextSettings, type GetCustomizationOptions, type GetCustomizationRequest, type GetCustomizationResponse, type IdentificationData, type IdentificationDataIdOneOf, type InvalidateCache, type InvalidateCacheGetByOneOf, type ItemMetadata, type MaskedCustomization, type MessageEnvelope, type MultipleColors, type Page, type QueryCustomizationsOptions, type QueryCustomizationsRequest, type QueryCustomizationsResponse, type RemoveCustomizationChoicesApplicationErrors, type RemoveCustomizationChoicesOptions, type RemoveCustomizationChoicesRequest, type RemoveCustomizationChoicesResponse, type RemoveCustomizationChoicesValidationErrors, RequestedFields, type RequestedFieldsWithLiterals, type RestoreInfo, type SetCustomizationChoicesApplicationErrors, type SetCustomizationChoicesOptions, type SetCustomizationChoicesRequest, type SetCustomizationChoicesResponse, type SetCustomizationChoicesValidationErrors, SortOrder, type SortOrderWithLiterals, type Sorting, type URI, type UpdateCustomization, type UpdateCustomizationOptions, type UpdateCustomizationRequest, type UpdateCustomizationResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, addCustomizationChoices, bulkAddCustomizationChoices, bulkCreateCustomizations, bulkUpdateCustomizations, createCustomization, deleteCustomization, getCustomization, onCustomizationCreated, onCustomizationDeleted, onCustomizationUpdated, queryCustomizations, removeCustomizationChoices, setCustomizationChoices, typedQueryCustomizations, updateCustomization };
+export { type ActionEvent, type AddCustomizationChoicesApplicationErrors, type AddCustomizationChoicesOptions, type AddCustomizationChoicesRequest, type AddCustomizationChoicesResponse, type AddCustomizationChoicesValidationErrors, type App, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkAddCustomizationChoicesApplicationErrors, type BulkAddCustomizationChoicesOptions, type BulkAddCustomizationChoicesRequest, type BulkAddCustomizationChoicesResponse, type BulkAddCustomizationChoicesValidationErrors, type BulkCreateCustomizationsApplicationErrors, type BulkCreateCustomizationsOptions, type BulkCreateCustomizationsRequest, type BulkCreateCustomizationsResponse, type BulkCreateCustomizationsValidationErrors, type BulkCustomizationResult, type BulkUpdateCustomizationsOptions, type BulkUpdateCustomizationsRequest, type BulkUpdateCustomizationsResponse, type Choice, ChoiceType, type ChoiceTypeWithLiterals, type ChoiceValueOneOf, type ChoicesSettings, type CommonQueryWithEntityContext, type CreateCustomizationApplicationErrors, type CreateCustomizationRequest, type CreateCustomizationResponse, type CreateCustomizationValidationErrors, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomTag, type Customization, type CustomizationChoices, type CustomizationCreatedEnvelope, type CustomizationCustomizationSettingsOneOf, type CustomizationDeletedEnvelope, type CustomizationIdsWrapper, type CustomizationQuery, type CustomizationQuerySpec, CustomizationRenderType, type CustomizationRenderTypeWithLiterals, CustomizationType, type CustomizationTypeWithLiterals, type CustomizationUpdatedEnvelope, type CustomizationsQueryBuilder, type CustomizationsQueryResult, type DeleteCustomizationRequest, type DeleteCustomizationResponse, type DeleteCustomizationValidationErrors, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type File, type FocalPoint, type FreeTextSettings, type GetCustomizationOptions, type GetCustomizationRequest, type GetCustomizationResponse, type IdentificationData, type IdentificationDataIdOneOf, type InvalidateCache, type InvalidateCacheGetByOneOf, type ItemMetadata, type MaskedCustomization, type MessageEnvelope, type MultipleColors, type Page, type QueryCustomizationsOptions, type QueryCustomizationsRequest, type QueryCustomizationsResponse, type RecloneSiteRequest, type RecloneSiteResponse, type RemoveCustomizationChoicesApplicationErrors, type RemoveCustomizationChoicesOptions, type RemoveCustomizationChoicesRequest, type RemoveCustomizationChoicesResponse, type RemoveCustomizationChoicesValidationErrors, RequestedFields, type RequestedFieldsWithLiterals, type RestoreInfo, type SetCustomizationChoicesApplicationErrors, type SetCustomizationChoicesOptions, type SetCustomizationChoicesRequest, type SetCustomizationChoicesResponse, type SetCustomizationChoicesValidationErrors, SortOrder, type SortOrderWithLiterals, type Sorting, type URI, type UpdateCustomization, type UpdateCustomizationOptions, type UpdateCustomizationRequest, type UpdateCustomizationResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, addCustomizationChoices, bulkAddCustomizationChoices, bulkCreateCustomizations, bulkUpdateCustomizations, createCustomization, deleteCustomization, getCustomization, onCustomizationCreated, onCustomizationDeleted, onCustomizationUpdated, queryCustomizations, removeCustomizationChoices, setCustomizationChoices, typedQueryCustomizations, updateCustomization };

package/build/es/index.typings.mjs

@@ -690,8 +690,6 @@ var ChoiceType = /* @__PURE__ */ ((ChoiceType2) => {
   ChoiceType2["UNKNOWN_CHOICE_TYPE"] = "UNKNOWN_CHOICE_TYPE";
   ChoiceType2["CHOICE_TEXT"] = "CHOICE_TEXT";
   ChoiceType2["ONE_COLOR"] = "ONE_COLOR";
-  ChoiceType2["MULTIPLE_COLORS"] = "MULTIPLE_COLORS";
-  ChoiceType2["IMAGE"] = "IMAGE";
   return ChoiceType2;
 })(ChoiceType || {});
 var RequestedFields = /* @__PURE__ */ ((RequestedFields2) => {