@wix/auto_sdk_stores_customizations-v-3 1.0.94 → 1.0.96

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.
@@ -10,7 +10,6 @@ interface Customization extends CustomizationCustomizationSettingsOneOf {
10
10
  * Free text input settings.
11
11
  *
12
12
  * > **Note:** To be passed along with `customizationRenderType: FREE_TEXT`.
13
- * @immutable
14
13
  */
15
14
  freeTextInput?: FreeTextSettings;
16
15
  /**
@@ -85,7 +84,6 @@ interface CustomizationCustomizationSettingsOneOf {
85
84
  * Free text input settings.
86
85
  *
87
86
  * > **Note:** To be passed along with `customizationRenderType: FREE_TEXT`.
88
- * @immutable
89
87
  */
90
88
  freeTextInput?: FreeTextSettings;
91
89
  /**
@@ -1126,6 +1124,16 @@ type CreateCustomizationValidationErrors = {
1126
1124
  ruleName?: 'PRIMARY_CHOICE_HIERARCHY_VIOLATION';
1127
1125
  };
1128
1126
  /** @docsIgnore */
1127
+ type UpdateCustomizationApplicationErrors = {
1128
+ code?: 'INVALID_FREE_TEXT_SETTINGS';
1129
+ description?: string;
1130
+ data?: Record<string, any>;
1131
+ } | {
1132
+ code?: 'DOESNT_SUPPORT_FREE_TEXT';
1133
+ description?: string;
1134
+ data?: Record<string, any>;
1135
+ };
1136
+ /** @docsIgnore */
1129
1137
  type DeleteCustomizationValidationErrors = {
1130
1138
  ruleName?: 'NOT_ALLOWED_DELETE_CUSTOMIZATION_ASSIGNED_TO_PRODUCT';
1131
1139
  };
@@ -1221,6 +1229,10 @@ type SetCustomizationChoicesValidationErrors = {
1221
1229
  };
1222
1230
  /** @docsIgnore */
1223
1231
  type RemoveCustomizationChoicesApplicationErrors = {
1232
+ code?: 'CHOICE_NOT_FOUND';
1233
+ description?: string;
1234
+ data?: Record<string, any>;
1235
+ } | {
1224
1236
  code?: 'CHOICE_ASSIGNED_TO_PRODUCT';
1225
1237
  description?: string;
1226
1238
  data?: Record<string, any>;
@@ -1279,6 +1291,16 @@ type BulkAddCustomizationChoicesValidationErrors = {
1279
1291
  } | {
1280
1292
  ruleName?: 'PRIMARY_CHOICE_HIERARCHY_VIOLATION';
1281
1293
  };
1294
+ /** @docsIgnore */
1295
+ type BulkUpdateCustomizationsApplicationErrors = {
1296
+ code?: 'INVALID_FREE_TEXT_SETTINGS';
1297
+ description?: string;
1298
+ data?: Record<string, any>;
1299
+ } | {
1300
+ code?: 'DOESNT_SUPPORT_FREE_TEXT';
1301
+ description?: string;
1302
+ data?: Record<string, any>;
1303
+ };
1282
1304
  interface BaseEventMetadata {
1283
1305
  /**
1284
1306
  * App instance ID.
@@ -1514,13 +1536,14 @@ interface GetCustomizationOptions {
1514
1536
  * @returns Updated customization.
1515
1537
  * @fqn wix.stores.catalog.customization.v3.CustomizationService.UpdateCustomization
1516
1538
  */
1517
- declare function updateCustomization(_id: string, customization: NonNullablePaths<UpdateCustomization, `revision`, 2>, options?: UpdateCustomizationOptions): Promise<NonNullablePaths<Customization, `freeTextInput.minCharCount` | `freeTextInput.maxCharCount` | `freeTextInput.title` | `choicesSettings.choices` | `choicesSettings.choices.${number}.colorCode` | `choicesSettings.choices.${number}._id` | `choicesSettings.choices.${number}.choiceType` | `choicesSettings.choices.${number}.name` | `name` | `customizationType` | `customizationRenderType`, 5>>;
1539
+ declare function updateCustomization(_id: string, customization: NonNullablePaths<UpdateCustomization, `revision`, 2>, options?: UpdateCustomizationOptions): Promise<NonNullablePaths<Customization, `freeTextInput.minCharCount` | `freeTextInput.maxCharCount` | `freeTextInput.title` | `choicesSettings.choices` | `choicesSettings.choices.${number}.colorCode` | `choicesSettings.choices.${number}._id` | `choicesSettings.choices.${number}.choiceType` | `choicesSettings.choices.${number}.name` | `name` | `customizationType` | `customizationRenderType`, 5> & {
1540
+ __applicationErrorsType?: UpdateCustomizationApplicationErrors;
1541
+ }>;
1518
1542
  interface UpdateCustomization {
1519
1543
  /**
1520
1544
  * Free text input settings.
1521
1545
  *
1522
1546
  * > **Note:** To be passed along with `customizationRenderType: FREE_TEXT`.
1523
- * @immutable
1524
1547
  */
1525
1548
  freeTextInput?: FreeTextSettings;
1526
1549
  /**
@@ -1999,7 +2022,9 @@ interface BulkAddCustomizationChoicesOptions {
1999
2022
  * @applicableIdentity APP
2000
2023
  * @fqn wix.stores.catalog.customization.v3.CustomizationService.BulkUpdateCustomizations
2001
2024
  */
2002
- declare function bulkUpdateCustomizations(customizations: NonNullablePaths<MaskedCustomization, `customization._id` | `customization.name` | `customization.revision`, 3>[], options?: BulkUpdateCustomizationsOptions): Promise<NonNullablePaths<BulkUpdateCustomizationsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.customization.freeTextInput.minCharCount` | `results.${number}.customization.freeTextInput.maxCharCount` | `results.${number}.customization.freeTextInput.title` | `results.${number}.customization.name` | `results.${number}.customization.customizationType` | `results.${number}.customization.customizationRenderType` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
2025
+ declare function bulkUpdateCustomizations(customizations: NonNullablePaths<MaskedCustomization, `customization._id` | `customization.name` | `customization.revision`, 3>[], options?: BulkUpdateCustomizationsOptions): Promise<NonNullablePaths<BulkUpdateCustomizationsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.customization.freeTextInput.minCharCount` | `results.${number}.customization.freeTextInput.maxCharCount` | `results.${number}.customization.freeTextInput.title` | `results.${number}.customization.name` | `results.${number}.customization.customizationType` | `results.${number}.customization.customizationRenderType` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6> & {
2026
+ __applicationErrorsType?: BulkUpdateCustomizationsApplicationErrors;
2027
+ }>;
2003
2028
  interface BulkUpdateCustomizationsOptions {
2004
2029
  /**
2005
2030
  * Whether to return the full customization entities in the response.
@@ -2016,4 +2041,4 @@ interface BulkUpdateCustomizationsOptions {
2016
2041
  fields?: RequestedFieldsWithLiterals[];
2017
2042
  }
2018
2043
 
2019
- export { type AccountInfo, type AccountInfoMetadata, 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 BulkCreateCustomizationsForMigrationRequest, type BulkCreateCustomizationsForMigrationResponse, type BulkCreateCustomizationsOptions, type BulkCreateCustomizationsRequest, type BulkCreateCustomizationsResponse, type BulkCreateCustomizationsValidationErrors, type BulkCustomizationResult, type BulkUpdateCustomizationsOptions, type BulkUpdateCustomizationsRequest, type BulkUpdateCustomizationsResponse, type CatalogRollbackRequested, type Choice, type ChoiceIdsMismatchData, ChoiceSortStrategy, type ChoiceSortStrategyWithLiterals, ChoiceType, type ChoiceTypeWithLiterals, type ChoiceValueOneOf, type ChoicesSettings, type CommonQueryWithEntityContext, type CountCustomizationsOptions, type CountCustomizationsRequest, type CountCustomizationsResponse, 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 MaskedChoice, type MaskedCustomization, type MessageEnvelope, type MultipleColors, type Page, type Pages, type QueryCustomizationsOptions, type QueryCustomizationsRequest, type QueryCustomizationsResponse, type RecloneSiteRequest, type RecloneSiteResponse, type RemoveCustomizationChoicesApplicationErrors, type RemoveCustomizationChoicesOptions, type RemoveCustomizationChoicesRequest, type RemoveCustomizationChoicesResponse, type RemoveCustomizationChoicesValidationErrors, type ReorderCustomizationChoicesApplicationErrors, type ReorderCustomizationChoicesOptions, type ReorderCustomizationChoicesRequest, type ReorderCustomizationChoicesResponse, RequestedFields, type RequestedFieldsWithLiterals, type RestoreInfo, type SetCustomizationChoicesApplicationErrors, type SetCustomizationChoicesOptions, type SetCustomizationChoicesRequest, type SetCustomizationChoicesResponse, type SetCustomizationChoicesValidationErrors, SortOrder, type SortOrderWithLiterals, type Sorting, type URI, type URIs, type UpdateCustomization, type UpdateCustomizationChoicesApplicationErrors, type UpdateCustomizationChoicesOptions, type UpdateCustomizationChoicesRequest, type UpdateCustomizationChoicesResponse, type UpdateCustomizationChoicesValidationErrors, type UpdateCustomizationOptions, type UpdateCustomizationRequest, type UpdateCustomizationResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, addCustomizationChoices, bulkAddCustomizationChoices, bulkCreateCustomizations, bulkUpdateCustomizations, countCustomizations, createCustomization, deleteCustomization, getCustomization, onCustomizationCreated, onCustomizationDeleted, onCustomizationUpdated, queryCustomizations, removeCustomizationChoices, reorderCustomizationChoices, setCustomizationChoices, typedQueryCustomizations, updateCustomization, updateCustomizationChoices, utils };
2044
+ export { type AccountInfo, type AccountInfoMetadata, 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 BulkCreateCustomizationsForMigrationRequest, type BulkCreateCustomizationsForMigrationResponse, type BulkCreateCustomizationsOptions, type BulkCreateCustomizationsRequest, type BulkCreateCustomizationsResponse, type BulkCreateCustomizationsValidationErrors, type BulkCustomizationResult, type BulkUpdateCustomizationsApplicationErrors, type BulkUpdateCustomizationsOptions, type BulkUpdateCustomizationsRequest, type BulkUpdateCustomizationsResponse, type CatalogRollbackRequested, type Choice, type ChoiceIdsMismatchData, ChoiceSortStrategy, type ChoiceSortStrategyWithLiterals, ChoiceType, type ChoiceTypeWithLiterals, type ChoiceValueOneOf, type ChoicesSettings, type CommonQueryWithEntityContext, type CountCustomizationsOptions, type CountCustomizationsRequest, type CountCustomizationsResponse, 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 MaskedChoice, type MaskedCustomization, type MessageEnvelope, type MultipleColors, type Page, type Pages, type QueryCustomizationsOptions, type QueryCustomizationsRequest, type QueryCustomizationsResponse, type RecloneSiteRequest, type RecloneSiteResponse, type RemoveCustomizationChoicesApplicationErrors, type RemoveCustomizationChoicesOptions, type RemoveCustomizationChoicesRequest, type RemoveCustomizationChoicesResponse, type RemoveCustomizationChoicesValidationErrors, type ReorderCustomizationChoicesApplicationErrors, type ReorderCustomizationChoicesOptions, type ReorderCustomizationChoicesRequest, type ReorderCustomizationChoicesResponse, RequestedFields, type RequestedFieldsWithLiterals, type RestoreInfo, type SetCustomizationChoicesApplicationErrors, type SetCustomizationChoicesOptions, type SetCustomizationChoicesRequest, type SetCustomizationChoicesResponse, type SetCustomizationChoicesValidationErrors, SortOrder, type SortOrderWithLiterals, type Sorting, type URI, type URIs, type UpdateCustomization, type UpdateCustomizationApplicationErrors, type UpdateCustomizationChoicesApplicationErrors, type UpdateCustomizationChoicesOptions, type UpdateCustomizationChoicesRequest, type UpdateCustomizationChoicesResponse, type UpdateCustomizationChoicesValidationErrors, type UpdateCustomizationOptions, type UpdateCustomizationRequest, type UpdateCustomizationResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, addCustomizationChoices, bulkAddCustomizationChoices, bulkCreateCustomizations, bulkUpdateCustomizations, countCustomizations, createCustomization, deleteCustomization, getCustomization, onCustomizationCreated, onCustomizationDeleted, onCustomizationUpdated, queryCustomizations, removeCustomizationChoices, reorderCustomizationChoices, setCustomizationChoices, typedQueryCustomizations, updateCustomization, updateCustomizationChoices, utils };