@wix/auto_sdk_stores_customizations-v-3 1.0.25 → 1.0.27
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.
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +4 -37
- package/build/cjs/index.typings.js.map +1 -1
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +4 -37
- package/build/es/index.typings.mjs.map +1 -1
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +4 -37
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +4 -37
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/package.json +3 -2
|
@@ -1047,7 +1047,6 @@ interface CustomizationCreatedEnvelope {
|
|
|
1047
1047
|
* @eventType wix.stores.catalog.v3.customization_created
|
|
1048
1048
|
* @serviceIdentifier wix.stores.catalog.customization.v3.CustomizationService
|
|
1049
1049
|
* @slug created
|
|
1050
|
-
* @documentationMaturity preview
|
|
1051
1050
|
*/
|
|
1052
1051
|
declare function onCustomizationCreated(handler: (event: CustomizationCreatedEnvelope) => void | Promise<void>): void;
|
|
1053
1052
|
interface CustomizationDeletedEnvelope {
|
|
@@ -1083,7 +1082,6 @@ interface CustomizationDeletedEnvelope {
|
|
|
1083
1082
|
* @eventType wix.stores.catalog.v3.customization_deleted
|
|
1084
1083
|
* @serviceIdentifier wix.stores.catalog.customization.v3.CustomizationService
|
|
1085
1084
|
* @slug deleted
|
|
1086
|
-
* @documentationMaturity preview
|
|
1087
1085
|
*/
|
|
1088
1086
|
declare function onCustomizationDeleted(handler: (event: CustomizationDeletedEnvelope) => void | Promise<void>): void;
|
|
1089
1087
|
interface CustomizationUpdatedEnvelope {
|
|
@@ -1119,7 +1117,6 @@ interface CustomizationUpdatedEnvelope {
|
|
|
1119
1117
|
* @eventType wix.stores.catalog.v3.customization_updated
|
|
1120
1118
|
* @serviceIdentifier wix.stores.catalog.customization.v3.CustomizationService
|
|
1121
1119
|
* @slug updated
|
|
1122
|
-
* @documentationMaturity preview
|
|
1123
1120
|
*/
|
|
1124
1121
|
declare function onCustomizationUpdated(handler: (event: CustomizationUpdatedEnvelope) => void | Promise<void>): void;
|
|
1125
1122
|
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`;
|
|
@@ -1127,7 +1124,6 @@ type CustomizationNonNullablePaths = `freeTextInput.minCharCount` | `freeTextInp
|
|
|
1127
1124
|
* Creates a customization.
|
|
1128
1125
|
* @param customization - Customization to create.
|
|
1129
1126
|
* @public
|
|
1130
|
-
* @documentationMaturity preview
|
|
1131
1127
|
* @requiredField customization
|
|
1132
1128
|
* @requiredField customization.choicesSettings.choices
|
|
1133
1129
|
* @requiredField customization.customizationRenderType
|
|
@@ -1147,7 +1143,6 @@ declare function createCustomization(customization: NonNullablePaths<Customizati
|
|
|
1147
1143
|
* Retrieves a customization.
|
|
1148
1144
|
* @param customizationId - Customization ID.
|
|
1149
1145
|
* @public
|
|
1150
|
-
* @documentationMaturity preview
|
|
1151
1146
|
* @requiredField customizationId
|
|
1152
1147
|
* @permissionId WIX_STORES.CUSTOMIZATION_READ
|
|
1153
1148
|
* @applicableIdentity APP
|
|
@@ -1173,7 +1168,6 @@ interface GetCustomizationOptions {
|
|
|
1173
1168
|
* This ensures you're working with the latest customization and prevents unintended overwrites.
|
|
1174
1169
|
* @param _id - Customization ID.
|
|
1175
1170
|
* @public
|
|
1176
|
-
* @documentationMaturity preview
|
|
1177
1171
|
* @requiredField _id
|
|
1178
1172
|
* @requiredField customization
|
|
1179
1173
|
* @requiredField customization.revision
|
|
@@ -1263,7 +1257,6 @@ interface UpdateCustomizationOptions {
|
|
|
1263
1257
|
* > **Note:** A customization cannot be deleted if it is assigned to one or more products.
|
|
1264
1258
|
* @param customizationId - Customization ID.
|
|
1265
1259
|
* @public
|
|
1266
|
-
* @documentationMaturity preview
|
|
1267
1260
|
* @requiredField customizationId
|
|
1268
1261
|
* @permissionId WIX_STORES.CUSTOMIZATION_DELETE
|
|
1269
1262
|
* @applicableIdentity APP
|
|
@@ -1289,7 +1282,6 @@ declare function deleteCustomization(customizationId: string): Promise<void & {
|
|
|
1289
1282
|
* [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),
|
|
1290
1283
|
* and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
1291
1284
|
* @public
|
|
1292
|
-
* @documentationMaturity preview
|
|
1293
1285
|
* @permissionId WIX_STORES.CUSTOMIZATION_READ
|
|
1294
1286
|
* @applicableIdentity APP
|
|
1295
1287
|
* @applicableIdentity VISITOR
|
|
@@ -1321,72 +1313,52 @@ interface CustomizationsQueryResult extends QueryCursorResult {
|
|
|
1321
1313
|
interface CustomizationsQueryBuilder {
|
|
1322
1314
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1323
1315
|
* @param value - Value to compare against.
|
|
1324
|
-
* @documentationMaturity preview
|
|
1325
1316
|
*/
|
|
1326
1317
|
eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'customizationType' | 'customizationRenderType', value: any) => CustomizationsQueryBuilder;
|
|
1327
1318
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1328
1319
|
* @param value - Value to compare against.
|
|
1329
|
-
* @documentationMaturity preview
|
|
1330
1320
|
*/
|
|
1331
1321
|
ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'customizationType' | 'customizationRenderType', value: any) => CustomizationsQueryBuilder;
|
|
1332
1322
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1333
1323
|
* @param value - Value to compare against.
|
|
1334
|
-
* @documentationMaturity preview
|
|
1335
1324
|
*/
|
|
1336
1325
|
ge: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name', value: any) => CustomizationsQueryBuilder;
|
|
1337
1326
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1338
1327
|
* @param value - Value to compare against.
|
|
1339
|
-
* @documentationMaturity preview
|
|
1340
1328
|
*/
|
|
1341
1329
|
gt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name', value: any) => CustomizationsQueryBuilder;
|
|
1342
1330
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1343
1331
|
* @param value - Value to compare against.
|
|
1344
|
-
* @documentationMaturity preview
|
|
1345
1332
|
*/
|
|
1346
1333
|
le: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name', value: any) => CustomizationsQueryBuilder;
|
|
1347
1334
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1348
1335
|
* @param value - Value to compare against.
|
|
1349
|
-
* @documentationMaturity preview
|
|
1350
1336
|
*/
|
|
1351
1337
|
lt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name', value: any) => CustomizationsQueryBuilder;
|
|
1352
1338
|
/** @param propertyName - Property whose value is compared with `string`.
|
|
1353
1339
|
* @param string - String to compare against. Case-insensitive.
|
|
1354
|
-
* @documentationMaturity preview
|
|
1355
1340
|
*/
|
|
1356
1341
|
startsWith: (propertyName: '_id' | 'name', value: string) => CustomizationsQueryBuilder;
|
|
1357
1342
|
/** @param propertyName - Property whose value is compared with `values`.
|
|
1358
1343
|
* @param values - List of values to compare against.
|
|
1359
|
-
* @documentationMaturity preview
|
|
1360
1344
|
*/
|
|
1361
1345
|
hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'customizationType' | 'customizationRenderType', value: any[]) => CustomizationsQueryBuilder;
|
|
1362
|
-
/** @documentationMaturity preview */
|
|
1363
1346
|
in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'customizationType' | 'customizationRenderType', value: any) => CustomizationsQueryBuilder;
|
|
1364
|
-
/** @documentationMaturity preview */
|
|
1365
1347
|
exists: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'customizationType' | 'customizationRenderType', value: boolean) => CustomizationsQueryBuilder;
|
|
1366
|
-
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
1367
|
-
* @documentationMaturity preview
|
|
1368
|
-
*/
|
|
1348
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
1369
1349
|
ascending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate' | 'name'>) => CustomizationsQueryBuilder;
|
|
1370
|
-
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
1371
|
-
* @documentationMaturity preview
|
|
1372
|
-
*/
|
|
1350
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
1373
1351
|
descending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate' | 'name'>) => CustomizationsQueryBuilder;
|
|
1374
|
-
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
1375
|
-
* @documentationMaturity preview
|
|
1376
|
-
*/
|
|
1352
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
|
|
1377
1353
|
limit: (limit: number) => CustomizationsQueryBuilder;
|
|
1378
|
-
/** @param cursor - A pointer to specific record
|
|
1379
|
-
* @documentationMaturity preview
|
|
1380
|
-
*/
|
|
1354
|
+
/** @param cursor - A pointer to specific record */
|
|
1381
1355
|
skipTo: (cursor: string) => CustomizationsQueryBuilder;
|
|
1382
|
-
/** @documentationMaturity preview */
|
|
1383
1356
|
find: () => Promise<CustomizationsQueryResult>;
|
|
1384
1357
|
}
|
|
1385
1358
|
/**
|
|
1386
1359
|
* Creates multiple brands.
|
|
1387
1360
|
* @param customizations - Customizations to create.
|
|
1388
1361
|
* @public
|
|
1389
|
-
* @documentationMaturity preview
|
|
1390
1362
|
* @requiredField customizations
|
|
1391
1363
|
* @permissionId WIX_STORES.CUSTOMIZATION_CREATE
|
|
1392
1364
|
* @applicableIdentity APP
|
|
@@ -1411,7 +1383,6 @@ interface BulkCreateCustomizationsOptions {
|
|
|
1411
1383
|
* @param customizationId - Customization ID.
|
|
1412
1384
|
* @param choices - Choices to add.
|
|
1413
1385
|
* @public
|
|
1414
|
-
* @documentationMaturity preview
|
|
1415
1386
|
* @requiredField choices
|
|
1416
1387
|
* @requiredField customizationId
|
|
1417
1388
|
* @permissionId WIX_STORES.CUSTOMIZATION_UPDATE
|
|
@@ -1440,7 +1411,6 @@ interface AddCustomizationChoicesOptions {
|
|
|
1440
1411
|
* @param customizationId - Customization ID.
|
|
1441
1412
|
* @param choices - Choices to set.
|
|
1442
1413
|
* @public
|
|
1443
|
-
* @documentationMaturity preview
|
|
1444
1414
|
* @requiredField choices
|
|
1445
1415
|
* @requiredField customizationId
|
|
1446
1416
|
* @permissionId WIX_STORES.CUSTOMIZATION_UPDATE
|
|
@@ -1469,7 +1439,6 @@ interface SetCustomizationChoicesOptions {
|
|
|
1469
1439
|
* @param customizationId - Customization ID.
|
|
1470
1440
|
* @param choiceIds - IDs of choices to remove.
|
|
1471
1441
|
* @public
|
|
1472
|
-
* @documentationMaturity preview
|
|
1473
1442
|
* @requiredField choiceIds
|
|
1474
1443
|
* @requiredField customizationId
|
|
1475
1444
|
* @permissionId WIX_STORES.CUSTOMIZATION_UPDATE
|
|
@@ -1497,7 +1466,6 @@ interface RemoveCustomizationChoicesOptions {
|
|
|
1497
1466
|
* Adds choices to multiple customizations.
|
|
1498
1467
|
* @param customizationsChoices - List of customization IDs and choices.
|
|
1499
1468
|
* @public
|
|
1500
|
-
* @documentationMaturity preview
|
|
1501
1469
|
* @requiredField customizationsChoices
|
|
1502
1470
|
* @requiredField customizationsChoices.choices
|
|
1503
1471
|
* @requiredField customizationsChoices.customizationId
|
|
@@ -1534,7 +1502,6 @@ interface BulkAddCustomizationChoicesOptions {
|
|
|
1534
1502
|
* This ensures you're working with the latest customization and prevents unintended overwrites.
|
|
1535
1503
|
* @param customizations - List of customizations to update.
|
|
1536
1504
|
* @public
|
|
1537
|
-
* @documentationMaturity preview
|
|
1538
1505
|
* @requiredField customizations
|
|
1539
1506
|
* @requiredField customizations.customization._id
|
|
1540
1507
|
* @requiredField customizations.customization.name
|