@wix/auto_sdk_stores_customizations-v-3 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.
@@ -7,8 +7,9 @@ import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
7
7
  */
8
8
  interface Customization extends CustomizationTypeSpecificSettingsOneOf, CustomizationCustomizationSettingsOneOf {
9
9
  /**
10
- * Modifier-specific settings. Not supported for product options.
11
- * @internal
10
+ * Modifier-specific settings.
11
+ *
12
+ * Only supported when `customizationType` is `MODIFIER`.
12
13
  */
13
14
  modifierSettings?: ModifierSettings;
14
15
  /**
@@ -86,8 +87,9 @@ interface Customization extends CustomizationTypeSpecificSettingsOneOf, Customiz
86
87
  /** @oneof */
87
88
  interface CustomizationTypeSpecificSettingsOneOf {
88
89
  /**
89
- * Modifier-specific settings. Not supported for product options.
90
- * @internal
90
+ * Modifier-specific settings.
91
+ *
92
+ * Only supported when `customizationType` is `MODIFIER`.
91
93
  */
92
94
  modifierSettings?: ModifierSettings;
93
95
  }
@@ -122,10 +124,15 @@ declare enum CustomizationRenderType {
122
124
  }
123
125
  /** @enumType */
124
126
  type CustomizationRenderTypeWithLiterals = CustomizationRenderType | 'FREE_TEXT' | 'TEXT_CHOICES' | 'SWATCH_CHOICES';
127
+ /** Settings specific to modifier customizations. */
125
128
  interface ModifierSettings {
126
129
  /**
127
- * Whether the modifier is mandatory by default.
128
- * @internal
130
+ * Whether customer input is required for this modifier by default.
131
+ *
132
+ * Applies to `modifiers.mandatory` on a product that uses this modifier without setting
133
+ * `mandatory` explicitly. A product that sets `modifiers.mandatory` overrides this default.
134
+ *
135
+ * Default: `false`
129
136
  */
130
137
  defaultMandatory?: boolean | null;
131
138
  }
@@ -1375,6 +1382,10 @@ type UpdateCustomizationChoicesApplicationErrors = {
1375
1382
  code?: 'CHOICE_NOT_FOUND';
1376
1383
  description?: string;
1377
1384
  data?: Record<string, any>;
1385
+ } | {
1386
+ code?: 'CHOICE_PRICE_NOT_SUPPORTED';
1387
+ description?: string;
1388
+ data?: Record<string, any>;
1378
1389
  };
1379
1390
  /** @docsIgnore */
1380
1391
  type UpdateCustomizationChoicesValidationErrors = {
@@ -1672,8 +1683,9 @@ declare function updateCustomization(_id: string, customization: NonNullablePath
1672
1683
  }>;
1673
1684
  interface UpdateCustomization {
1674
1685
  /**
1675
- * Modifier-specific settings. Not supported for product options.
1676
- * @internal
1686
+ * Modifier-specific settings.
1687
+ *
1688
+ * Only supported when `customizationType` is `MODIFIER`.
1677
1689
  */
1678
1690
  modifierSettings?: ModifierSettings;
1679
1691
  /**
@@ -2057,7 +2069,8 @@ interface RemoveCustomizationChoicesOptions {
2057
2069
  * Updates properties of existing choices in a customization.
2058
2070
  * Choices are identified by their IDs. Only the fields specified in `fieldMask` are updated.
2059
2071
  *
2060
- * Currently supports updating `primaryChoiceIds`.
2072
+ * Supports updating `name`, `primaryChoiceIds`, `colorCode`, and `displayImage`.
2073
+ * Updating `addedPrice` is supported only for `MODIFIER` customizations.
2061
2074
  * @param customizationId - Customization ID.
2062
2075
  * @param revision - Revision number, which increments by 1 each time the customization is updated.
2063
2076
  * To prevent conflicting changes,
@@ -7,8 +7,9 @@ import '@wix/sdk-types';
7
7
  */
8
8
  interface Customization extends CustomizationTypeSpecificSettingsOneOf, CustomizationCustomizationSettingsOneOf {
9
9
  /**
10
- * Modifier-specific settings. Not supported for product options.
11
- * @internal
10
+ * Modifier-specific settings.
11
+ *
12
+ * Only supported when `customizationType` is `MODIFIER`.
12
13
  */
13
14
  modifierSettings?: ModifierSettings;
14
15
  /**
@@ -86,8 +87,9 @@ interface Customization extends CustomizationTypeSpecificSettingsOneOf, Customiz
86
87
  /** @oneof */
87
88
  interface CustomizationTypeSpecificSettingsOneOf {
88
89
  /**
89
- * Modifier-specific settings. Not supported for product options.
90
- * @internal
90
+ * Modifier-specific settings.
91
+ *
92
+ * Only supported when `customizationType` is `MODIFIER`.
91
93
  */
92
94
  modifierSettings?: ModifierSettings;
93
95
  }
@@ -122,10 +124,15 @@ declare enum CustomizationRenderType {
122
124
  }
123
125
  /** @enumType */
124
126
  type CustomizationRenderTypeWithLiterals = CustomizationRenderType | 'FREE_TEXT' | 'TEXT_CHOICES' | 'SWATCH_CHOICES';
127
+ /** Settings specific to modifier customizations. */
125
128
  interface ModifierSettings {
126
129
  /**
127
- * Whether the modifier is mandatory by default.
128
- * @internal
130
+ * Whether customer input is required for this modifier by default.
131
+ *
132
+ * Applies to `modifiers.mandatory` on a product that uses this modifier without setting
133
+ * `mandatory` explicitly. A product that sets `modifiers.mandatory` overrides this default.
134
+ *
135
+ * Default: `false`
129
136
  */
130
137
  defaultMandatory?: boolean | null;
131
138
  }
@@ -1506,6 +1513,10 @@ type UpdateCustomizationChoicesApplicationErrors = {
1506
1513
  code?: 'CHOICE_NOT_FOUND';
1507
1514
  description?: string;
1508
1515
  data?: Record<string, any>;
1516
+ } | {
1517
+ code?: 'CHOICE_PRICE_NOT_SUPPORTED';
1518
+ description?: string;
1519
+ data?: Record<string, any>;
1509
1520
  };
1510
1521
  /** @docsIgnore */
1511
1522
  type UpdateCustomizationChoicesValidationErrors = {
@@ -119,7 +119,8 @@ interface UpdateCustomizationChoicesSignature {
119
119
  * Updates properties of existing choices in a customization.
120
120
  * Choices are identified by their IDs. Only the fields specified in `fieldMask` are updated.
121
121
  *
122
- * Currently supports updating `primaryChoiceIds`.
122
+ * Supports updating `name`, `primaryChoiceIds`, `colorCode`, and `displayImage`.
123
+ * Updating `addedPrice` is supported only for `MODIFIER` customizations.
123
124
  * @param - Customization ID.
124
125
  * @param - Revision number, which increments by 1 each time the customization is updated.
125
126
  * To prevent conflicting changes,
@@ -7,8 +7,9 @@ import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
7
7
  */
8
8
  interface Customization extends CustomizationTypeSpecificSettingsOneOf, CustomizationCustomizationSettingsOneOf {
9
9
  /**
10
- * Modifier-specific settings. Not supported for product options.
11
- * @internal
10
+ * Modifier-specific settings.
11
+ *
12
+ * Only supported when `customizationType` is `MODIFIER`.
12
13
  */
13
14
  modifierSettings?: ModifierSettings;
14
15
  /**
@@ -86,8 +87,9 @@ interface Customization extends CustomizationTypeSpecificSettingsOneOf, Customiz
86
87
  /** @oneof */
87
88
  interface CustomizationTypeSpecificSettingsOneOf {
88
89
  /**
89
- * Modifier-specific settings. Not supported for product options.
90
- * @internal
90
+ * Modifier-specific settings.
91
+ *
92
+ * Only supported when `customizationType` is `MODIFIER`.
91
93
  */
92
94
  modifierSettings?: ModifierSettings;
93
95
  }
@@ -122,10 +124,15 @@ declare enum CustomizationRenderType {
122
124
  }
123
125
  /** @enumType */
124
126
  type CustomizationRenderTypeWithLiterals = CustomizationRenderType | 'FREE_TEXT' | 'TEXT_CHOICES' | 'SWATCH_CHOICES';
127
+ /** Settings specific to modifier customizations. */
125
128
  interface ModifierSettings {
126
129
  /**
127
- * Whether the modifier is mandatory by default.
128
- * @internal
130
+ * Whether customer input is required for this modifier by default.
131
+ *
132
+ * Applies to `modifiers.mandatory` on a product that uses this modifier without setting
133
+ * `mandatory` explicitly. A product that sets `modifiers.mandatory` overrides this default.
134
+ *
135
+ * Default: `false`
129
136
  */
130
137
  defaultMandatory?: boolean | null;
131
138
  }
@@ -1375,6 +1382,10 @@ type UpdateCustomizationChoicesApplicationErrors = {
1375
1382
  code?: 'CHOICE_NOT_FOUND';
1376
1383
  description?: string;
1377
1384
  data?: Record<string, any>;
1385
+ } | {
1386
+ code?: 'CHOICE_PRICE_NOT_SUPPORTED';
1387
+ description?: string;
1388
+ data?: Record<string, any>;
1378
1389
  };
1379
1390
  /** @docsIgnore */
1380
1391
  type UpdateCustomizationChoicesValidationErrors = {
@@ -1672,8 +1683,9 @@ declare function updateCustomization(_id: string, customization: NonNullablePath
1672
1683
  }>;
1673
1684
  interface UpdateCustomization {
1674
1685
  /**
1675
- * Modifier-specific settings. Not supported for product options.
1676
- * @internal
1686
+ * Modifier-specific settings.
1687
+ *
1688
+ * Only supported when `customizationType` is `MODIFIER`.
1677
1689
  */
1678
1690
  modifierSettings?: ModifierSettings;
1679
1691
  /**
@@ -2057,7 +2069,8 @@ interface RemoveCustomizationChoicesOptions {
2057
2069
  * Updates properties of existing choices in a customization.
2058
2070
  * Choices are identified by their IDs. Only the fields specified in `fieldMask` are updated.
2059
2071
  *
2060
- * Currently supports updating `primaryChoiceIds`.
2072
+ * Supports updating `name`, `primaryChoiceIds`, `colorCode`, and `displayImage`.
2073
+ * Updating `addedPrice` is supported only for `MODIFIER` customizations.
2061
2074
  * @param customizationId - Customization ID.
2062
2075
  * @param revision - Revision number, which increments by 1 each time the customization is updated.
2063
2076
  * To prevent conflicting changes,
@@ -7,8 +7,9 @@ import '@wix/sdk-types';
7
7
  */
8
8
  interface Customization extends CustomizationTypeSpecificSettingsOneOf, CustomizationCustomizationSettingsOneOf {
9
9
  /**
10
- * Modifier-specific settings. Not supported for product options.
11
- * @internal
10
+ * Modifier-specific settings.
11
+ *
12
+ * Only supported when `customizationType` is `MODIFIER`.
12
13
  */
13
14
  modifierSettings?: ModifierSettings;
14
15
  /**
@@ -86,8 +87,9 @@ interface Customization extends CustomizationTypeSpecificSettingsOneOf, Customiz
86
87
  /** @oneof */
87
88
  interface CustomizationTypeSpecificSettingsOneOf {
88
89
  /**
89
- * Modifier-specific settings. Not supported for product options.
90
- * @internal
90
+ * Modifier-specific settings.
91
+ *
92
+ * Only supported when `customizationType` is `MODIFIER`.
91
93
  */
92
94
  modifierSettings?: ModifierSettings;
93
95
  }
@@ -122,10 +124,15 @@ declare enum CustomizationRenderType {
122
124
  }
123
125
  /** @enumType */
124
126
  type CustomizationRenderTypeWithLiterals = CustomizationRenderType | 'FREE_TEXT' | 'TEXT_CHOICES' | 'SWATCH_CHOICES';
127
+ /** Settings specific to modifier customizations. */
125
128
  interface ModifierSettings {
126
129
  /**
127
- * Whether the modifier is mandatory by default.
128
- * @internal
130
+ * Whether customer input is required for this modifier by default.
131
+ *
132
+ * Applies to `modifiers.mandatory` on a product that uses this modifier without setting
133
+ * `mandatory` explicitly. A product that sets `modifiers.mandatory` overrides this default.
134
+ *
135
+ * Default: `false`
129
136
  */
130
137
  defaultMandatory?: boolean | null;
131
138
  }
@@ -1506,6 +1513,10 @@ type UpdateCustomizationChoicesApplicationErrors = {
1506
1513
  code?: 'CHOICE_NOT_FOUND';
1507
1514
  description?: string;
1508
1515
  data?: Record<string, any>;
1516
+ } | {
1517
+ code?: 'CHOICE_PRICE_NOT_SUPPORTED';
1518
+ description?: string;
1519
+ data?: Record<string, any>;
1509
1520
  };
1510
1521
  /** @docsIgnore */
1511
1522
  type UpdateCustomizationChoicesValidationErrors = {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/auto_sdk_stores_customizations-v-3",
3
- "version": "1.0.106",
3
+ "version": "1.0.108",
4
4
  "license": "MIT",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/",
@@ -50,5 +50,5 @@
50
50
  "fqdn": "wix.stores.catalog.v3.customization"
51
51
  }
52
52
  },
53
- "falconPackageHash": "06cf7dbe1979db19e0e8c09df801bf12ceb794bf27e9d1db4ce11736"
53
+ "falconPackageHash": "b18fa68dc1f2310513233d77261c0fcd622a2f9e1e1d04aa21728b2d"
54
54
  }