@wix/auto_sdk_stores_customizations-v-3 1.0.57 → 1.0.59

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.
@@ -44,6 +44,15 @@ interface Customization extends CustomizationCustomizationSettingsOneOf {
44
44
  * @readonly
45
45
  */
46
46
  _updatedDate?: Date | null;
47
+ /**
48
+ * A read-only identifier generated from the customization name.
49
+ *
50
+ * Use `key` in the `catalogReference.options` object when [integrating Catalog V3 with eCommerce APIs](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/e-commerce-integration).
51
+ * @readonly
52
+ * @minLength 1
53
+ * @maxLength 50
54
+ */
55
+ key?: string | null;
47
56
  /**
48
57
  * Customization name for options (for example, `"color"`, `"size"`) and modifiers (for example, `"greeting card"`).
49
58
  * @minLength 1
@@ -122,6 +131,15 @@ interface FreeTextSettings {
122
131
  * @maxLength 100
123
132
  */
124
133
  title?: string;
134
+ /**
135
+ * A read-only identifier generated from the title.
136
+ *
137
+ * Use `key` in the `catalogReference.options` object when [integrating Catalog V3 with eCommerce APIs](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/e-commerce-integration).
138
+ * @readonly
139
+ * @minLength 1
140
+ * @maxLength 150
141
+ */
142
+ key?: string | null;
125
143
  }
126
144
  interface ChoicesSettings {
127
145
  /**
@@ -156,7 +174,9 @@ interface Choice extends ChoiceValueOneOf {
156
174
  */
157
175
  choiceType?: ChoiceTypeWithLiterals;
158
176
  /**
159
- * A read-only key generated based on choice name. Used for eCommerce integration.
177
+ * A read-only identifier generated from the choice name.
178
+ *
179
+ * Use `key` in the `catalogReference.options` object when [integrating Catalog V3 with eCommerce APIs](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/e-commerce-integration).
160
180
  * @readonly
161
181
  * @minLength 1
162
182
  * @maxLength 50
@@ -1081,6 +1101,8 @@ interface CustomizationCreatedEnvelope {
1081
1101
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1082
1102
  * @permissionScope Manage Stores
1083
1103
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1104
+ * @permissionScope Read customizations in v3 catalog (PII)
1105
+ * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_READ_LIMITED
1084
1106
  * @permissionScope Read v3 catalog
1085
1107
  * @permissionScopeId SCOPE.STORES.CATALOG_READ
1086
1108
  * @permissionScope Manage Products
@@ -1097,6 +1119,8 @@ interface CustomizationCreatedEnvelope {
1097
1119
  * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_READ
1098
1120
  * @permissionScope Manage v3 catalog
1099
1121
  * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
1122
+ * @permissionScope Read v3 catalog (PII)
1123
+ * @permissionScopeId SCOPE.STORES.CATALOG_READ_LIMITED
1100
1124
  * @permissionScope Manage Orders
1101
1125
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1102
1126
  * @permissionId WIX_STORES.CUSTOMIZATION_READ
@@ -1116,6 +1140,8 @@ interface CustomizationDeletedEnvelope {
1116
1140
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1117
1141
  * @permissionScope Manage Stores
1118
1142
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1143
+ * @permissionScope Read customizations in v3 catalog (PII)
1144
+ * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_READ_LIMITED
1119
1145
  * @permissionScope Read v3 catalog
1120
1146
  * @permissionScopeId SCOPE.STORES.CATALOG_READ
1121
1147
  * @permissionScope Manage Products
@@ -1132,6 +1158,8 @@ interface CustomizationDeletedEnvelope {
1132
1158
  * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_READ
1133
1159
  * @permissionScope Manage v3 catalog
1134
1160
  * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
1161
+ * @permissionScope Read v3 catalog (PII)
1162
+ * @permissionScopeId SCOPE.STORES.CATALOG_READ_LIMITED
1135
1163
  * @permissionScope Manage Orders
1136
1164
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1137
1165
  * @permissionId WIX_STORES.CUSTOMIZATION_READ
@@ -1153,6 +1181,8 @@ interface CustomizationUpdatedEnvelope {
1153
1181
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1154
1182
  * @permissionScope Manage Stores
1155
1183
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1184
+ * @permissionScope Read customizations in v3 catalog (PII)
1185
+ * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_READ_LIMITED
1156
1186
  * @permissionScope Read v3 catalog
1157
1187
  * @permissionScopeId SCOPE.STORES.CATALOG_READ
1158
1188
  * @permissionScope Manage Products
@@ -1169,6 +1199,8 @@ interface CustomizationUpdatedEnvelope {
1169
1199
  * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_READ
1170
1200
  * @permissionScope Manage v3 catalog
1171
1201
  * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
1202
+ * @permissionScope Read v3 catalog (PII)
1203
+ * @permissionScopeId SCOPE.STORES.CATALOG_READ_LIMITED
1172
1204
  * @permissionScope Manage Orders
1173
1205
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1174
1206
  * @permissionId WIX_STORES.CUSTOMIZATION_READ
@@ -1274,6 +1306,15 @@ interface UpdateCustomization {
1274
1306
  * @readonly
1275
1307
  */
1276
1308
  _updatedDate?: Date | null;
1309
+ /**
1310
+ * A read-only identifier generated from the customization name.
1311
+ *
1312
+ * Use `key` in the `catalogReference.options` object when [integrating Catalog V3 with eCommerce APIs](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/e-commerce-integration).
1313
+ * @readonly
1314
+ * @minLength 1
1315
+ * @maxLength 50
1316
+ */
1317
+ key?: string | null;
1277
1318
  /**
1278
1319
  * Customization name for options (for example, `"color"`, `"size"`) and modifiers (for example, `"greeting card"`).
1279
1320
  * @minLength 1