@wix/auto_sdk_stores_product-groups-v-3 1.0.0

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.
Files changed (43) hide show
  1. package/build/cjs/index.d.ts +11 -0
  2. package/build/cjs/index.js +1279 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +7 -0
  5. package/build/cjs/index.typings.js +1141 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1393 -0
  8. package/build/cjs/meta.js +939 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/stores-catalog-v3-product-group-product-groups-v-3.universal-BSxpFEZE.d.ts +1824 -0
  11. package/build/es/index.d.mts +11 -0
  12. package/build/es/index.mjs +1226 -0
  13. package/build/es/index.mjs.map +1 -0
  14. package/build/es/index.typings.d.mts +7 -0
  15. package/build/es/index.typings.mjs +1087 -0
  16. package/build/es/index.typings.mjs.map +1 -0
  17. package/build/es/meta.d.mts +1393 -0
  18. package/build/es/meta.mjs +884 -0
  19. package/build/es/meta.mjs.map +1 -0
  20. package/build/es/package.json +3 -0
  21. package/build/es/stores-catalog-v3-product-group-product-groups-v-3.universal-BSxpFEZE.d.mts +1824 -0
  22. package/build/internal/cjs/index.d.ts +162 -0
  23. package/build/internal/cjs/index.js +1279 -0
  24. package/build/internal/cjs/index.js.map +1 -0
  25. package/build/internal/cjs/index.typings.d.ts +21 -0
  26. package/build/internal/cjs/index.typings.js +1141 -0
  27. package/build/internal/cjs/index.typings.js.map +1 -0
  28. package/build/internal/cjs/meta.d.ts +1393 -0
  29. package/build/internal/cjs/meta.js +939 -0
  30. package/build/internal/cjs/meta.js.map +1 -0
  31. package/build/internal/cjs/stores-catalog-v3-product-group-product-groups-v-3.universal-4XnTTWRs.d.ts +1986 -0
  32. package/build/internal/es/index.d.mts +162 -0
  33. package/build/internal/es/index.mjs +1226 -0
  34. package/build/internal/es/index.mjs.map +1 -0
  35. package/build/internal/es/index.typings.d.mts +21 -0
  36. package/build/internal/es/index.typings.mjs +1087 -0
  37. package/build/internal/es/index.typings.mjs.map +1 -0
  38. package/build/internal/es/meta.d.mts +1393 -0
  39. package/build/internal/es/meta.mjs +884 -0
  40. package/build/internal/es/meta.mjs.map +1 -0
  41. package/build/internal/es/stores-catalog-v3-product-group-product-groups-v-3.universal-4XnTTWRs.d.mts +1986 -0
  42. package/meta/package.json +3 -0
  43. package/package.json +55 -0
@@ -0,0 +1,1393 @@
1
+ import { _ as CreateProductGroupRequest$1, $ as CreateProductGroupResponse$1, a0 as UpdateProductGroupRequest$1, a1 as UpdateProductGroupResponse$1, a2 as DeleteProductGroupRequest$1, a3 as DeleteProductGroupResponse$1, a4 as GetProductGroupRequest$1, a5 as GetProductGroupResponse$1, a6 as QueryProductGroupsRequest$1, ab as QueryProductGroupsResponse$1, ae as SearchProductGroupsRequest$1, c as SearchProductGroupsResponse$1, aP as BulkCreateProductGroupsRequest$1, d as BulkCreateProductGroupsResponse$1, aU as BulkUpdateProductGroupsRequest$1, f as BulkUpdateProductGroupsResponse$1, aW as AssignProductsToProductGroupRequest$1, g as AssignProductsToProductGroupResponse$1, aY as UnassignProductsFromProductGroupRequest$1, i as UnassignProductsFromProductGroupResponse$1, a_ as BulkDeleteProductGroupsRequest$1, j as BulkDeleteProductGroupsResponse$1, b0 as BulkUpdateProductGroupTagsRequest$1, l as BulkUpdateProductGroupTagsResponse$1, ba as BulkUpdateProductGroupTagsByFilterRequest$1, o as BulkUpdateProductGroupTagsByFilterResponse$1 } from './stores-catalog-v3-product-group-product-groups-v-3.universal-4XnTTWRs.js';
2
+ import '@wix/sdk-types';
3
+
4
+ /**
5
+ * A product group aggregates related products based on a shared customization
6
+ * (option or modifier). Each member product is automatically assigned to
7
+ * represent a specific choice of that customization.
8
+ */
9
+ interface ProductGroup {
10
+ /**
11
+ * Product group ID.
12
+ * @format GUID
13
+ * @readonly
14
+ */
15
+ id?: string | null;
16
+ /**
17
+ * Revision number, which increments by 1 each time the product group is updated.
18
+ * To prevent conflicting changes,
19
+ * the current revision must be passed when updating the product group.
20
+ *
21
+ * Ignored when creating a product group.
22
+ * @readonly
23
+ */
24
+ revision?: string | null;
25
+ /**
26
+ * Date and time the product group was created.
27
+ * @readonly
28
+ */
29
+ createdDate?: Date | null;
30
+ /**
31
+ * Date and time the product group was last updated.
32
+ * @readonly
33
+ */
34
+ updatedDate?: Date | null;
35
+ /**
36
+ * Product group name.
37
+ * @minLength 1
38
+ * @maxLength 100
39
+ */
40
+ name?: string | null;
41
+ /**
42
+ * ID of the shared customization (option or modifier) that defines
43
+ * the grouping attribute. Can't be changed after creation.
44
+ * @minLength 1
45
+ * @maxLength 36
46
+ * @readonly
47
+ * @immutable
48
+ */
49
+ groupingCustomizationId?: string | null;
50
+ /**
51
+ * Ordered list of choice IDs that defines the display order of choices in the storefront.
52
+ * Choices not listed here will appear after the listed ones.
53
+ * @maxSize 100
54
+ * @format GUID
55
+ */
56
+ choiceOrder?: string[];
57
+ /**
58
+ * Products that belong to this group, with their derived choice and status.
59
+ * Ordered according to `choice_order`.
60
+ * @readonly
61
+ * @maxSize 100
62
+ */
63
+ members?: ProductGroupMember[];
64
+ /**
65
+ * Unique human-friendly identifier for the product group.
66
+ *
67
+ * Unlike the auto-generated `id`, the handle can be set when creating a product group.
68
+ * Useful for external catalog sync systems. Unique per site.
69
+ * If not provided during creation, a random UUID is automatically generated. Can't be changed after creation.
70
+ * @minLength 1
71
+ * @maxLength 100
72
+ * @readonly
73
+ * @immutable
74
+ */
75
+ handle?: string | null;
76
+ /**
77
+ * Details of the catalog [customization](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/customizations-v3/introduction) referenced by `grouping_customization_id` (for example, name and render type).
78
+ *
79
+ * > **Note:** Returned only when you pass `"GROUPING_CUSTOMIZATION"` to the `fields` array in Product Groups API requests.
80
+ * @readonly
81
+ */
82
+ groupingCustomization?: GroupingCustomization;
83
+ /**
84
+ * Custom field data for the product group.
85
+ * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)
86
+ * must be configured in the app dashboard before they can be accessed with API calls.
87
+ */
88
+ extendedFields?: ExtendedFields;
89
+ /** Tags */
90
+ tags?: Tags;
91
+ }
92
+ /** Represents a product within a product group, with its derived choice and status. */
93
+ interface ProductGroupMember {
94
+ /**
95
+ * The member product ID.
96
+ * @minLength 1
97
+ * @maxLength 36
98
+ */
99
+ productId?: string;
100
+ /**
101
+ * The choice derived from the product's option or modifier data
102
+ * for the group's `grouping_customization_id`.
103
+ */
104
+ choice?: ProductChoice;
105
+ /**
106
+ * The product's URL slug, for storefront navigation between siblings.
107
+ * @minLength 1
108
+ * @maxLength 200
109
+ */
110
+ slug?: string | null;
111
+ /** The product's inventory availability status, for rendering out-of-stock choices as disabled. */
112
+ inventoryAvailabilityStatus?: AvailabilityStatusWithLiterals;
113
+ /**
114
+ * Membership status. Indicates whether the product qualifies for display in the group.
115
+ * + `ACTIVE` — Product has exactly one choice for the group's customization and is visible.
116
+ * + `HIDDEN` — Merchant manually hid this product from site visitors.
117
+ * + `OUT_OF_SYNC` — Product no longer qualifies for the group. For example, the group's
118
+ * customization was removed from the product, or the product has multiple choices for it.
119
+ */
120
+ status?: MembershipStatusWithLiterals;
121
+ /**
122
+ * The product's name, materialized for search indexing.
123
+ * @maxLength 100
124
+ */
125
+ productName?: string | null;
126
+ }
127
+ interface ProductChoice extends ProductChoiceValueOneOf {
128
+ /**
129
+ * Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).
130
+ * @minLength 3
131
+ * @maxLength 20
132
+ * @format COLOR_HEX
133
+ */
134
+ colorCode?: string;
135
+ /**
136
+ * Choice ID.
137
+ * @format GUID
138
+ * @readonly
139
+ */
140
+ id?: string;
141
+ /**
142
+ * Choice type.
143
+ *
144
+ * > **Notes:**
145
+ * > + For `customizationRenderType: SWATCH_CHOICES`, the supported `choiceType` value is: `ONE_COLOR`.
146
+ * > + For a `customizationRenderType` of `TEXT_CHOICES`, the supported `choiceType` value is: `CHOICE_TEXT`.
147
+ * @immutable
148
+ */
149
+ choiceType?: ChoiceTypeWithLiterals;
150
+ /**
151
+ * A read-only identifier generated from the choice name.
152
+ *
153
+ * 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).
154
+ * @readonly
155
+ * @minLength 1
156
+ * @maxLength 50
157
+ */
158
+ key?: string | null;
159
+ /**
160
+ * Choice name.
161
+ * @minLength 1
162
+ * @maxLength 50
163
+ */
164
+ name?: string;
165
+ }
166
+ /** @oneof */
167
+ interface ProductChoiceValueOneOf {
168
+ /**
169
+ * Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).
170
+ * @minLength 3
171
+ * @maxLength 20
172
+ * @format COLOR_HEX
173
+ */
174
+ colorCode?: string;
175
+ }
176
+ declare enum ChoiceType {
177
+ /** For a `customizationRenderType` of `TEXT_CHOICES`. */
178
+ CHOICE_TEXT = "CHOICE_TEXT",
179
+ /** For `customizationRenderType: SWATCH_CHOICES`. */
180
+ ONE_COLOR = "ONE_COLOR"
181
+ }
182
+ /** @enumType */
183
+ type ChoiceTypeWithLiterals = ChoiceType | 'CHOICE_TEXT' | 'ONE_COLOR';
184
+ declare enum AvailabilityStatus {
185
+ /** All variants are in stock and available for purchase. */
186
+ IN_STOCK = "IN_STOCK",
187
+ /** All variants are out of stock. */
188
+ OUT_OF_STOCK = "OUT_OF_STOCK",
189
+ /** Some variants are out of stock and some are in stock and available for purchase. */
190
+ PARTIALLY_OUT_OF_STOCK = "PARTIALLY_OUT_OF_STOCK"
191
+ }
192
+ /** @enumType */
193
+ type AvailabilityStatusWithLiterals = AvailabilityStatus | 'IN_STOCK' | 'OUT_OF_STOCK' | 'PARTIALLY_OUT_OF_STOCK';
194
+ declare enum MembershipStatus {
195
+ /** Product is active and visible in the group. */
196
+ ACTIVE = "ACTIVE",
197
+ /** Merchant manually hid this product from site visitors. */
198
+ HIDDEN = "HIDDEN",
199
+ /** Product no longer qualifies (missing customization, multiple choices, etc.). */
200
+ OUT_OF_SYNC = "OUT_OF_SYNC"
201
+ }
202
+ /** @enumType */
203
+ type MembershipStatusWithLiterals = MembershipStatus | 'ACTIVE' | 'HIDDEN' | 'OUT_OF_SYNC';
204
+ interface GroupingCustomization {
205
+ /**
206
+ * @minLength 1
207
+ * @maxLength 36
208
+ */
209
+ id?: string | null;
210
+ /**
211
+ * @minLength 1
212
+ * @maxLength 50
213
+ */
214
+ key?: string | null;
215
+ /**
216
+ * @minLength 1
217
+ * @maxLength 50
218
+ */
219
+ name?: string;
220
+ customizationType?: CustomizationTypeWithLiterals;
221
+ customizationRenderType?: CustomizationRenderTypeWithLiterals;
222
+ }
223
+ declare enum CustomizationType {
224
+ PRODUCT_OPTION = "PRODUCT_OPTION",
225
+ MODIFIER = "MODIFIER"
226
+ }
227
+ /** @enumType */
228
+ type CustomizationTypeWithLiterals = CustomizationType | 'PRODUCT_OPTION' | 'MODIFIER';
229
+ declare enum CustomizationRenderType {
230
+ FREE_TEXT = "FREE_TEXT",
231
+ TEXT_CHOICES = "TEXT_CHOICES",
232
+ SWATCH_CHOICES = "SWATCH_CHOICES"
233
+ }
234
+ /** @enumType */
235
+ type CustomizationRenderTypeWithLiterals = CustomizationRenderType | 'FREE_TEXT' | 'TEXT_CHOICES' | 'SWATCH_CHOICES';
236
+ interface ExtendedFields {
237
+ /**
238
+ * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
239
+ * The value of each key is structured according to the schema defined when the extended fields were configured.
240
+ *
241
+ * You can only access fields for which you have the appropriate permissions.
242
+ *
243
+ * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
244
+ */
245
+ namespaces?: Record<string, Record<string, any>>;
246
+ }
247
+ /**
248
+ * Common object for tags.
249
+ * Should be use as in this example:
250
+ * message Foo {
251
+ * option (.wix.api.decomposite_of) = "wix.commons.v2.tags.Foo";
252
+ * string id = 1;
253
+ * ...
254
+ * Tags tags = 5
255
+ * }
256
+ *
257
+ * example of taggable entity
258
+ * {
259
+ * id: "123"
260
+ * tags: {
261
+ * public_tags: {
262
+ * tag_ids:["11","22"]
263
+ * },
264
+ * private_tags: {
265
+ * tag_ids: ["33", "44"]
266
+ * }
267
+ * }
268
+ * }
269
+ */
270
+ interface Tags {
271
+ /** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
272
+ privateTags?: TagList;
273
+ /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
274
+ publicTags?: TagList;
275
+ }
276
+ interface TagList {
277
+ /**
278
+ * List of tag IDs.
279
+ * @maxSize 100
280
+ * @maxLength 5
281
+ */
282
+ tagIds?: string[];
283
+ }
284
+ interface ProductGroupTagsModified {
285
+ /** Updated ProductGroup. */
286
+ productGroup?: ProductGroup;
287
+ /** Tags that were assigned to the ProductGroup. */
288
+ assignedTags?: Tags;
289
+ /** Tags that were unassigned from the ProductGroup. */
290
+ unassignedTags?: Tags;
291
+ }
292
+ interface CreateProductGroupRequest {
293
+ /** The product group to create. */
294
+ productGroup: ProductGroup;
295
+ /**
296
+ * Fields to include on the returned `product_group` (e.g. `GROUPING_CUSTOMIZATION`).
297
+ * @maxSize 10
298
+ */
299
+ fields?: ProductGroupRequestedFieldsWithLiterals[];
300
+ }
301
+ declare enum ProductGroupRequestedFields {
302
+ /** Provides details of the customization referenced by `grouping_customization_id` (see `ProductGroup.grouping_customization`). */
303
+ GROUPING_CUSTOMIZATION = "GROUPING_CUSTOMIZATION"
304
+ }
305
+ /** @enumType */
306
+ type ProductGroupRequestedFieldsWithLiterals = ProductGroupRequestedFields | 'GROUPING_CUSTOMIZATION';
307
+ interface CreateProductGroupResponse {
308
+ /** The created product group. */
309
+ productGroup?: ProductGroup;
310
+ /**
311
+ * Fields to include on the returned `product_group` (e.g. `GROUPING_CUSTOMIZATION`).
312
+ * @maxSize 10
313
+ */
314
+ fields?: ProductGroupRequestedFieldsWithLiterals[];
315
+ }
316
+ interface UpdateProductGroupRequest {
317
+ /** The product group to update with the desired field values. */
318
+ productGroup: ProductGroup;
319
+ /**
320
+ * Fields to include on the returned `product_group` (e.g. `GROUPING_CUSTOMIZATION`).
321
+ * @maxSize 10
322
+ */
323
+ fields?: ProductGroupRequestedFieldsWithLiterals[];
324
+ }
325
+ interface UpdateProductGroupResponse {
326
+ /** The updated product group. */
327
+ productGroup?: ProductGroup;
328
+ /**
329
+ * Fields to include on the returned product_group (e.g. GROUPING_CUSTOMIZATION).
330
+ * @maxSize 10
331
+ */
332
+ fields?: ProductGroupRequestedFieldsWithLiterals[];
333
+ }
334
+ interface DeleteProductGroupRequest {
335
+ /**
336
+ * ID of the product group to delete.
337
+ * @format GUID
338
+ */
339
+ productGroupId: string;
340
+ }
341
+ interface DeleteProductGroupResponse {
342
+ }
343
+ interface GetProductGroupRequest {
344
+ /**
345
+ * ID of the product group to retrieve.
346
+ * @format GUID
347
+ */
348
+ productGroupId: string;
349
+ /**
350
+ * Fields to include on the returned product group (e.g. `GROUPING_CUSTOMIZATION`).
351
+ * @maxSize 10
352
+ */
353
+ fields?: ProductGroupRequestedFieldsWithLiterals[];
354
+ }
355
+ interface GetProductGroupResponse {
356
+ /** The requested product group. */
357
+ productGroup?: ProductGroup;
358
+ /**
359
+ * Optional expansions on each returned product group (e.g. `GROUPING_CUSTOMIZATION`).
360
+ * @maxSize 10
361
+ */
362
+ fields?: ProductGroupRequestedFieldsWithLiterals[];
363
+ }
364
+ interface QueryProductGroupsRequest {
365
+ /** WQL query — filter, sort, and cursor-based paging criteria. */
366
+ query?: CursorQuery;
367
+ /**
368
+ * Optional expansions on each returned product group (e.g. `GROUPING_CUSTOMIZATION`).
369
+ * @maxSize 10
370
+ */
371
+ fields?: ProductGroupRequestedFieldsWithLiterals[];
372
+ }
373
+ interface CursorQuery extends CursorQueryPagingMethodOneOf {
374
+ /**
375
+ * Cursor paging options.
376
+ *
377
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
378
+ */
379
+ cursorPaging?: CursorPaging;
380
+ /**
381
+ * Filter object.
382
+ *
383
+ * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
384
+ */
385
+ filter?: Record<string, any> | null;
386
+ /**
387
+ * Sort object.
388
+ *
389
+ * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
390
+ * @maxSize 5
391
+ */
392
+ sort?: Sorting[];
393
+ }
394
+ /** @oneof */
395
+ interface CursorQueryPagingMethodOneOf {
396
+ /**
397
+ * Cursor paging options.
398
+ *
399
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
400
+ */
401
+ cursorPaging?: CursorPaging;
402
+ }
403
+ interface Sorting {
404
+ /**
405
+ * Name of the field to sort by.
406
+ * @maxLength 512
407
+ */
408
+ fieldName?: string;
409
+ /** Sort order. */
410
+ order?: SortOrderWithLiterals;
411
+ }
412
+ declare enum SortOrder {
413
+ ASC = "ASC",
414
+ DESC = "DESC"
415
+ }
416
+ /** @enumType */
417
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
418
+ interface CursorPaging {
419
+ /**
420
+ * Maximum number of items to return in the results.
421
+ * @max 100
422
+ */
423
+ limit?: number | null;
424
+ /**
425
+ * Pointer to the next or previous page in the list of results.
426
+ *
427
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
428
+ * Not relevant for the first request.
429
+ * @maxLength 16000
430
+ */
431
+ cursor?: string | null;
432
+ }
433
+ interface QueryProductGroupsResponse {
434
+ /** List of product groups matching the query. */
435
+ productGroups?: ProductGroup[];
436
+ /** Paging metadata for the next cursor. */
437
+ pagingMetadata?: CursorPagingMetadata;
438
+ /**
439
+ * Optional expansions on each returned product group (e.g. `GROUPING_CUSTOMIZATION`).
440
+ * @maxSize 10
441
+ */
442
+ fields?: ProductGroupRequestedFieldsWithLiterals[];
443
+ }
444
+ interface CursorPagingMetadata {
445
+ /** Number of items returned in current page. */
446
+ count?: number | null;
447
+ /** Cursor strings that point to the next page, previous page, or both. */
448
+ cursors?: Cursors;
449
+ /**
450
+ * Whether there are more pages to retrieve following the current page.
451
+ *
452
+ * + `true`: Another page of results can be retrieved.
453
+ * + `false`: This is the last page.
454
+ */
455
+ hasNext?: boolean | null;
456
+ }
457
+ interface Cursors {
458
+ /**
459
+ * Cursor string pointing to the next page in the list of results.
460
+ * @maxLength 16000
461
+ */
462
+ next?: string | null;
463
+ /**
464
+ * Cursor pointing to the previous page in the list of results.
465
+ * @maxLength 16000
466
+ */
467
+ prev?: string | null;
468
+ }
469
+ interface SearchProductGroupsRequest {
470
+ /** WQL search — filter, free-text search, sort, and cursor-based paging. */
471
+ search?: CursorSearch;
472
+ /**
473
+ * Optional expansions on each returned product group (e.g. `GROUPING_CUSTOMIZATION`).
474
+ * @maxSize 10
475
+ */
476
+ fields?: ProductGroupRequestedFieldsWithLiterals[];
477
+ }
478
+ interface CursorSearch extends CursorSearchPagingMethodOneOf {
479
+ /**
480
+ * Cursor paging options.
481
+ *
482
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
483
+ */
484
+ cursorPaging?: CursorPaging;
485
+ /**
486
+ * Filter object.
487
+ *
488
+ * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
489
+ */
490
+ filter?: Record<string, any> | null;
491
+ /**
492
+ * List of sort objects.
493
+ *
494
+ * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
495
+ * @maxSize 10
496
+ */
497
+ sort?: Sorting[];
498
+ /**
499
+ * Aggregations are a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.
500
+ * @maxSize 10
501
+ */
502
+ aggregations?: Aggregation[];
503
+ /** Free text to match in searchable fields. */
504
+ search?: SearchDetails;
505
+ /**
506
+ * UTC offset or IANA time zone. Valid values are
507
+ * ISO 8601 UTC offsets, such as +02:00 or -06:00,
508
+ * and IANA time zone IDs, such as Europe/Rome.
509
+ *
510
+ * Affects all filters and aggregations returned values.
511
+ * You may override this behavior in a specific filter by providing
512
+ * timestamps including time zone. For example, `"2023-12-20T10:52:34.795Z"`.
513
+ * @maxLength 50
514
+ */
515
+ timeZone?: string | null;
516
+ }
517
+ /** @oneof */
518
+ interface CursorSearchPagingMethodOneOf {
519
+ /**
520
+ * Cursor paging options.
521
+ *
522
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
523
+ */
524
+ cursorPaging?: CursorPaging;
525
+ }
526
+ interface Aggregation extends AggregationKindOneOf {
527
+ /** Value aggregation. */
528
+ value?: ValueAggregation;
529
+ /** Range aggregation. */
530
+ range?: RangeAggregation;
531
+ /** Scalar aggregation. */
532
+ scalar?: ScalarAggregation;
533
+ /** Date histogram aggregation. */
534
+ dateHistogram?: DateHistogramAggregation;
535
+ /** Nested aggregation. */
536
+ nested?: NestedAggregation;
537
+ /**
538
+ * User-defined name of aggregation, should be unique, will appear in aggregation results.
539
+ * @maxLength 100
540
+ */
541
+ name?: string | null;
542
+ /** Type of aggregation, client must provide matching aggregation field below. */
543
+ type?: AggregationTypeWithLiterals;
544
+ /**
545
+ * Field to aggregate by, use dot notation to specify json path.
546
+ * @maxLength 200
547
+ */
548
+ fieldPath?: string;
549
+ }
550
+ /** @oneof */
551
+ interface AggregationKindOneOf {
552
+ /** Value aggregation. */
553
+ value?: ValueAggregation;
554
+ /** Range aggregation. */
555
+ range?: RangeAggregation;
556
+ /** Scalar aggregation. */
557
+ scalar?: ScalarAggregation;
558
+ /** Date histogram aggregation. */
559
+ dateHistogram?: DateHistogramAggregation;
560
+ /** Nested aggregation. */
561
+ nested?: NestedAggregation;
562
+ }
563
+ interface RangeBucket {
564
+ /** Inclusive lower bound of the range. Required if `to` is not provided. */
565
+ from?: number | null;
566
+ /** Exclusive upper bound of the range. Required if `from` is not provided. */
567
+ to?: number | null;
568
+ }
569
+ declare enum SortType {
570
+ /** Sort by number of matches. */
571
+ COUNT = "COUNT",
572
+ /** Sort by value of the field alphabetically. */
573
+ VALUE = "VALUE"
574
+ }
575
+ /** @enumType */
576
+ type SortTypeWithLiterals = SortType | 'COUNT' | 'VALUE';
577
+ declare enum SortDirection {
578
+ /** Sort in descending order. */
579
+ DESC = "DESC",
580
+ /** Sort in ascending order. */
581
+ ASC = "ASC"
582
+ }
583
+ /** @enumType */
584
+ type SortDirectionWithLiterals = SortDirection | 'DESC' | 'ASC';
585
+ declare enum MissingValues {
586
+ /** Exclude missing values from the aggregation results. */
587
+ EXCLUDE = "EXCLUDE",
588
+ /** Include missing values in the aggregation results. */
589
+ INCLUDE = "INCLUDE"
590
+ }
591
+ /** @enumType */
592
+ type MissingValuesWithLiterals = MissingValues | 'EXCLUDE' | 'INCLUDE';
593
+ interface IncludeMissingValuesOptions {
594
+ /**
595
+ * Specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ...
596
+ * @maxLength 20
597
+ */
598
+ addToBucket?: string;
599
+ }
600
+ declare enum ScalarType {
601
+ /** Count of distinct values. */
602
+ COUNT_DISTINCT = "COUNT_DISTINCT",
603
+ /** Minimum value. */
604
+ MIN = "MIN",
605
+ /** Maximum value. */
606
+ MAX = "MAX"
607
+ }
608
+ /** @enumType */
609
+ type ScalarTypeWithLiterals = ScalarType | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
610
+ interface ValueAggregation extends ValueAggregationOptionsOneOf {
611
+ /** Options for including missing values. */
612
+ includeOptions?: IncludeMissingValuesOptions;
613
+ /** Whether to sort by number of matches or value of the field. */
614
+ sortType?: SortTypeWithLiterals;
615
+ /** Whether to sort in ascending or descending order. */
616
+ sortDirection?: SortDirectionWithLiterals;
617
+ /** How many aggregations to return. Can be between 1 and 250. 10 is the default. */
618
+ limit?: number | null;
619
+ /** Whether to include or exclude missing values from the aggregation results. Default: `EXCLUDE`. */
620
+ missingValues?: MissingValuesWithLiterals;
621
+ }
622
+ /** @oneof */
623
+ interface ValueAggregationOptionsOneOf {
624
+ /** Options for including missing values. */
625
+ includeOptions?: IncludeMissingValuesOptions;
626
+ }
627
+ declare enum NestedAggregationType {
628
+ /** An aggregation where result buckets are dynamically built - one per unique value. */
629
+ VALUE = "VALUE",
630
+ /** An aggregation, where user can define set of ranges - each representing a bucket. */
631
+ RANGE = "RANGE",
632
+ /** A single-value metric aggregation. For example, min, max, sum, avg. */
633
+ SCALAR = "SCALAR",
634
+ /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.). */
635
+ DATE_HISTOGRAM = "DATE_HISTOGRAM"
636
+ }
637
+ /** @enumType */
638
+ type NestedAggregationTypeWithLiterals = NestedAggregationType | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
639
+ interface RangeAggregation {
640
+ /**
641
+ * List of range buckets, where during aggregation each entity will be placed in the first bucket its value falls into, based on the provided range bounds.
642
+ * @maxSize 50
643
+ */
644
+ buckets?: RangeBucket[];
645
+ }
646
+ interface ScalarAggregation {
647
+ /** Define the operator for the scalar aggregation. */
648
+ type?: ScalarTypeWithLiterals;
649
+ }
650
+ interface DateHistogramAggregation {
651
+ /** Interval for date histogram aggregation. */
652
+ interval?: IntervalWithLiterals;
653
+ }
654
+ declare enum Interval {
655
+ /** Yearly interval */
656
+ YEAR = "YEAR",
657
+ /** Monthly interval */
658
+ MONTH = "MONTH",
659
+ /** Weekly interval */
660
+ WEEK = "WEEK",
661
+ /** Daily interval */
662
+ DAY = "DAY",
663
+ /** Hourly interval */
664
+ HOUR = "HOUR",
665
+ /** Minute interval */
666
+ MINUTE = "MINUTE",
667
+ /** Second interval */
668
+ SECOND = "SECOND"
669
+ }
670
+ /** @enumType */
671
+ type IntervalWithLiterals = Interval | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
672
+ interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
673
+ /** Value aggregation. */
674
+ value?: ValueAggregation;
675
+ /** Range aggregation. */
676
+ range?: RangeAggregation;
677
+ /** Scalar aggregation. */
678
+ scalar?: ScalarAggregation;
679
+ /** Date histogram aggregation. */
680
+ dateHistogram?: DateHistogramAggregation;
681
+ /**
682
+ * User-defined name of aggregation, should be unique, will appear in aggregation results.
683
+ * @maxLength 100
684
+ */
685
+ name?: string | null;
686
+ /** Type of aggregation, client must provide matching aggregation field below. */
687
+ type?: NestedAggregationTypeWithLiterals;
688
+ /**
689
+ * Field to aggregate by, use dot notation to specify json path.
690
+ * @maxLength 200
691
+ */
692
+ fieldPath?: string;
693
+ }
694
+ /** @oneof */
695
+ interface NestedAggregationItemKindOneOf {
696
+ /** Value aggregation. */
697
+ value?: ValueAggregation;
698
+ /** Range aggregation. */
699
+ range?: RangeAggregation;
700
+ /** Scalar aggregation. */
701
+ scalar?: ScalarAggregation;
702
+ /** Date histogram aggregation. */
703
+ dateHistogram?: DateHistogramAggregation;
704
+ }
705
+ declare enum AggregationType {
706
+ /** An aggregation where result buckets are dynamically built - one per unique value. */
707
+ VALUE = "VALUE",
708
+ /** An aggregation, where user can define set of ranges - each representing a bucket. */
709
+ RANGE = "RANGE",
710
+ /** A single-value metric aggregation. For example, min, max, sum, avg. */
711
+ SCALAR = "SCALAR",
712
+ /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
713
+ DATE_HISTOGRAM = "DATE_HISTOGRAM",
714
+ /** Multi-level aggregation, where each next aggregation is nested within previous one. */
715
+ NESTED = "NESTED"
716
+ }
717
+ /** @enumType */
718
+ type AggregationTypeWithLiterals = AggregationType | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
719
+ /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one. */
720
+ interface NestedAggregation {
721
+ /**
722
+ * Flattened list of aggregations, where each next aggregation is nested within previous one.
723
+ * @minSize 2
724
+ * @maxSize 3
725
+ */
726
+ nestedAggregations?: NestedAggregationItem[];
727
+ }
728
+ interface SearchDetails {
729
+ /** Defines how separate search terms in `expression` are combined. */
730
+ mode?: ModeWithLiterals;
731
+ /**
732
+ * Search term or expression.
733
+ * @maxLength 100
734
+ */
735
+ expression?: string | null;
736
+ /**
737
+ * Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path.
738
+ * @maxLength 200
739
+ * @maxSize 20
740
+ */
741
+ fields?: string[];
742
+ /** Whether to use auto fuzzy search (allowing typos by a managed proximity algorithm). */
743
+ fuzzy?: boolean;
744
+ }
745
+ declare enum Mode {
746
+ /** Any of the search terms must be present. */
747
+ OR = "OR",
748
+ /** All search terms must be present. */
749
+ AND = "AND"
750
+ }
751
+ /** @enumType */
752
+ type ModeWithLiterals = Mode | 'OR' | 'AND';
753
+ interface SearchProductGroupsResponse {
754
+ /** List of product groups matching the search. */
755
+ productGroups?: ProductGroup[];
756
+ /** Paging metadata for the next cursor. */
757
+ pagingMetadata?: CursorPagingMetadata;
758
+ /** Aggregation data from the search. */
759
+ aggregationData?: AggregationData;
760
+ /**
761
+ * Optional expansions on each returned product group (e.g. `GROUPING_CUSTOMIZATION`).
762
+ * @maxSize 10
763
+ */
764
+ fields?: ProductGroupRequestedFieldsWithLiterals[];
765
+ }
766
+ interface AggregationData {
767
+ /**
768
+ * key = aggregation name (as derived from search request).
769
+ * @maxSize 10000
770
+ */
771
+ results?: AggregationResults[];
772
+ }
773
+ interface ValueAggregationResult {
774
+ /**
775
+ * Value of the field.
776
+ * @maxLength 100
777
+ */
778
+ value?: string;
779
+ /** Count of entities with this value. */
780
+ count?: number;
781
+ }
782
+ interface RangeAggregationResult {
783
+ /** Inclusive lower bound of the range. */
784
+ from?: number | null;
785
+ /** Exclusive upper bound of the range. */
786
+ to?: number | null;
787
+ /** Count of entities in this range. */
788
+ count?: number;
789
+ }
790
+ interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
791
+ /** Value aggregation results. */
792
+ values?: ValueResults;
793
+ /** Range aggregation results. */
794
+ ranges?: RangeResults;
795
+ /** Scalar aggregation results. */
796
+ scalar?: AggregationResultsScalarResult;
797
+ /**
798
+ * User-defined name of aggregation, matches the one provided in request.
799
+ * @maxLength 100
800
+ */
801
+ name?: string;
802
+ /** Type of aggregation that matches result. */
803
+ type?: AggregationTypeWithLiterals;
804
+ /**
805
+ * Field to aggregate by, matches the one provided in request.
806
+ * @maxLength 200
807
+ */
808
+ fieldPath?: string;
809
+ }
810
+ /** @oneof */
811
+ interface NestedAggregationResultsResultOneOf {
812
+ /** Value aggregation results. */
813
+ values?: ValueResults;
814
+ /** Range aggregation results. */
815
+ ranges?: RangeResults;
816
+ /** Scalar aggregation results. */
817
+ scalar?: AggregationResultsScalarResult;
818
+ }
819
+ interface ValueResults {
820
+ /**
821
+ * List of value aggregations.
822
+ * @maxSize 250
823
+ */
824
+ results?: ValueAggregationResult[];
825
+ }
826
+ interface RangeResults {
827
+ /**
828
+ * List of ranges returned in same order as requested.
829
+ * @maxSize 50
830
+ */
831
+ results?: RangeAggregationResult[];
832
+ }
833
+ interface AggregationResultsScalarResult {
834
+ /** Type of scalar aggregation. */
835
+ type?: ScalarTypeWithLiterals;
836
+ /** Value of the scalar aggregation. */
837
+ value?: number;
838
+ }
839
+ interface NestedValueAggregationResult {
840
+ /**
841
+ * Value of the field.
842
+ * @maxLength 1000
843
+ */
844
+ value?: string;
845
+ /** Nested aggregations. */
846
+ nestedResults?: NestedAggregationResults;
847
+ }
848
+ interface ValueResult {
849
+ /**
850
+ * Value of the field.
851
+ * @maxLength 1000
852
+ */
853
+ value?: string;
854
+ /** Count of entities with this value. */
855
+ count?: number | null;
856
+ }
857
+ interface RangeResult {
858
+ /** Inclusive lower bound of the range. */
859
+ from?: number | null;
860
+ /** Exclusive upper bound of the range. */
861
+ to?: number | null;
862
+ /** Count of entities in this range. */
863
+ count?: number | null;
864
+ }
865
+ interface ScalarResult {
866
+ /** Value of the scalar aggregation. */
867
+ value?: number;
868
+ }
869
+ interface NestedResultValue extends NestedResultValueResultOneOf {
870
+ /** Value aggregation result. */
871
+ value?: ValueResult;
872
+ /** Range aggregation result. */
873
+ range?: RangeResult;
874
+ /** Scalar aggregation result. */
875
+ scalar?: ScalarResult;
876
+ /** Date histogram aggregation result. */
877
+ dateHistogram?: ValueResult;
878
+ }
879
+ /** @oneof */
880
+ interface NestedResultValueResultOneOf {
881
+ /** Value aggregation result. */
882
+ value?: ValueResult;
883
+ /** Range aggregation result. */
884
+ range?: RangeResult;
885
+ /** Scalar aggregation result. */
886
+ scalar?: ScalarResult;
887
+ /** Date histogram aggregation result. */
888
+ dateHistogram?: ValueResult;
889
+ }
890
+ interface Results {
891
+ /** List of nested aggregations. */
892
+ results?: Record<string, NestedResultValue>;
893
+ }
894
+ interface DateHistogramResult {
895
+ /**
896
+ * Date in ISO 8601 format.
897
+ * @maxLength 100
898
+ */
899
+ value?: string;
900
+ /** Count of documents in the bucket. */
901
+ count?: number;
902
+ }
903
+ interface GroupByValueResults {
904
+ /**
905
+ * List of value aggregations.
906
+ * @maxSize 1000
907
+ */
908
+ results?: NestedValueAggregationResult[];
909
+ }
910
+ interface DateHistogramResults {
911
+ /**
912
+ * List of date histogram aggregations.
913
+ * @maxSize 200
914
+ */
915
+ results?: DateHistogramResult[];
916
+ }
917
+ /**
918
+ * Results of `NESTED` aggregation type in a flattened form.
919
+ * Aggregations in resulting array are keyed by requested aggregation `name`.
920
+ */
921
+ interface NestedResults {
922
+ /**
923
+ * List of nested aggregations.
924
+ * @maxSize 1000
925
+ */
926
+ results?: Results[];
927
+ }
928
+ interface AggregationResults extends AggregationResultsResultOneOf {
929
+ /** Value aggregation results. */
930
+ values?: ValueResults;
931
+ /** Range aggregation results. */
932
+ ranges?: RangeResults;
933
+ /** Scalar aggregation results. */
934
+ scalar?: AggregationResultsScalarResult;
935
+ /** Group by value aggregation results. */
936
+ groupedByValue?: GroupByValueResults;
937
+ /** Date histogram aggregation results. */
938
+ dateHistogram?: DateHistogramResults;
939
+ /** Nested aggregation results. */
940
+ nested?: NestedResults;
941
+ /**
942
+ * User-defined name of aggregation as derived from search request.
943
+ * @maxLength 100
944
+ */
945
+ name?: string;
946
+ /** Type of aggregation that must match provided kind as derived from search request. */
947
+ type?: AggregationTypeWithLiterals;
948
+ /**
949
+ * Field to aggregate by as derived from search request.
950
+ * @maxLength 200
951
+ */
952
+ fieldPath?: string;
953
+ }
954
+ /** @oneof */
955
+ interface AggregationResultsResultOneOf {
956
+ /** Value aggregation results. */
957
+ values?: ValueResults;
958
+ /** Range aggregation results. */
959
+ ranges?: RangeResults;
960
+ /** Scalar aggregation results. */
961
+ scalar?: AggregationResultsScalarResult;
962
+ /** Group by value aggregation results. */
963
+ groupedByValue?: GroupByValueResults;
964
+ /** Date histogram aggregation results. */
965
+ dateHistogram?: DateHistogramResults;
966
+ /** Nested aggregation results. */
967
+ nested?: NestedResults;
968
+ }
969
+ interface BulkCreateProductGroupsRequest {
970
+ /**
971
+ * List of product groups to create.
972
+ * @minSize 1
973
+ * @maxSize 100
974
+ */
975
+ productGroups: ProductGroup[];
976
+ /** Whether to return the created product group entities in the response. */
977
+ returnEntity?: boolean;
978
+ /**
979
+ * Fields to include on each returned `item` (e.g. `GROUPING_CUSTOMIZATION`).
980
+ * @maxSize 10
981
+ */
982
+ fields?: ProductGroupRequestedFieldsWithLiterals[];
983
+ }
984
+ interface BulkCreateProductGroupsResponse {
985
+ /**
986
+ * Results for each product group creation attempt, in request order.
987
+ * @minSize 1
988
+ * @maxSize 100
989
+ */
990
+ results?: BulkProductGroupResult[];
991
+ /** Aggregated success/failure counts. */
992
+ bulkActionMetadata?: BulkActionMetadata;
993
+ /**
994
+ * Fields to include on each returned `item` (e.g. `GROUPING_CUSTOMIZATION`).
995
+ * @maxSize 10
996
+ */
997
+ fields?: ProductGroupRequestedFieldsWithLiterals[];
998
+ }
999
+ interface ItemMetadata {
1000
+ /**
1001
+ * Item ID. Provided only whenever possible. For example, `itemId` can't be provided when item creation has failed.
1002
+ * @format GUID
1003
+ */
1004
+ id?: string | null;
1005
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
1006
+ originalIndex?: number;
1007
+ /** Whether the requested action for this item was successful. When `false`, the `error` field is returned. */
1008
+ success?: boolean;
1009
+ /** Details about the error in case of failure. */
1010
+ error?: ApplicationError;
1011
+ }
1012
+ interface ApplicationError {
1013
+ /** Error code. */
1014
+ code?: string;
1015
+ /** Description of the error. */
1016
+ description?: string;
1017
+ /** Data related to the error. */
1018
+ data?: Record<string, any> | null;
1019
+ }
1020
+ /** The result of a single item in a bulk create operation. */
1021
+ interface BulkProductGroupResult {
1022
+ itemMetadata?: ItemMetadata;
1023
+ /** Only populated if `return_entity` was `true` and the operation succeeded. */
1024
+ item?: ProductGroup;
1025
+ }
1026
+ interface BulkActionMetadata {
1027
+ /** Number of items that were successfully processed. */
1028
+ totalSuccesses?: number;
1029
+ /** Number of items that couldn't be processed. */
1030
+ totalFailures?: number;
1031
+ /** Number of failures without details because detailed failure threshold was exceeded. */
1032
+ undetailedFailures?: number;
1033
+ }
1034
+ interface BulkUpdateProductGroupsRequest {
1035
+ /**
1036
+ * List of product groups to update, each with its own field mask.
1037
+ * @minSize 1
1038
+ * @maxSize 100
1039
+ */
1040
+ productGroups: MaskedProductGroup[];
1041
+ /** Whether to return the updated product group entities in the response. */
1042
+ returnEntity?: boolean;
1043
+ /**
1044
+ * Fields to include on each returned `item` (e.g. `GROUPING_CUSTOMIZATION`).
1045
+ * @maxSize 10
1046
+ */
1047
+ fields?: ProductGroupRequestedFieldsWithLiterals[];
1048
+ }
1049
+ interface MaskedProductGroup {
1050
+ /** The product group to update. `product_group.id` and `product_group.revision` are required. */
1051
+ productGroup?: ProductGroup;
1052
+ }
1053
+ interface BulkUpdateProductGroupsResponse {
1054
+ /**
1055
+ * Results for each product group update attempt, in request order.
1056
+ * @minSize 1
1057
+ * @maxSize 100
1058
+ */
1059
+ results?: BulkUpdateProductGroupsResponseBulkProductGroupResult[];
1060
+ /** Aggregated success/failure counts. */
1061
+ bulkActionMetadata?: BulkActionMetadata;
1062
+ }
1063
+ /** The result of a single item in a bulk update operation. */
1064
+ interface BulkUpdateProductGroupsResponseBulkProductGroupResult {
1065
+ itemMetadata?: ItemMetadata;
1066
+ /** Only populated if `return_entity` was `true` and the operation succeeded. */
1067
+ item?: ProductGroup;
1068
+ }
1069
+ interface AssignProductsToProductGroupRequest {
1070
+ /**
1071
+ * ID of the product group to assign products to.
1072
+ * @format GUID
1073
+ */
1074
+ productGroupId: string;
1075
+ /**
1076
+ * IDs of the products to assign. Duplicates are silently de-duplicated. Products already in the group are skipped.
1077
+ * @minSize 1
1078
+ * @maxSize 100
1079
+ * @minLength 1
1080
+ * @maxLength 36
1081
+ */
1082
+ productIds: string[];
1083
+ }
1084
+ interface AssignProductsToProductGroupResponse {
1085
+ /** Per-item results, one entry per product ID in the request. */
1086
+ results?: ProductAssignmentResult[];
1087
+ }
1088
+ interface ProductAssignmentResult {
1089
+ /** ID of the product. */
1090
+ productId?: string;
1091
+ /** Whether the assignment succeeded. */
1092
+ success?: boolean;
1093
+ /** Error details if the assignment failed. */
1094
+ error?: ApplicationError;
1095
+ }
1096
+ interface UnassignProductsFromProductGroupRequest {
1097
+ /**
1098
+ * ID of the product group to unassign products from.
1099
+ * @format GUID
1100
+ */
1101
+ productGroupId: string;
1102
+ /**
1103
+ * IDs of the products to unassign. Duplicates are silently de-duplicated. All products must currently be members of the group.
1104
+ * @minSize 1
1105
+ * @maxSize 100
1106
+ * @minLength 1
1107
+ * @maxLength 36
1108
+ */
1109
+ productIds: string[];
1110
+ }
1111
+ interface UnassignProductsFromProductGroupResponse {
1112
+ /** Per-item results, one entry per product ID in the request. */
1113
+ results?: ProductUnassignmentResult[];
1114
+ }
1115
+ interface ProductUnassignmentResult {
1116
+ /** ID of the product */
1117
+ productId?: string;
1118
+ /** Whether the unassignment succeeded. */
1119
+ success?: boolean;
1120
+ /** Error details if the unassignment failed. */
1121
+ error?: ApplicationError;
1122
+ }
1123
+ interface BulkDeleteProductGroupsRequest {
1124
+ /**
1125
+ * IDs of the product groups to delete.
1126
+ * @format GUID
1127
+ * @minSize 1
1128
+ * @maxSize 100
1129
+ */
1130
+ productGroupIds: string[];
1131
+ }
1132
+ interface BulkDeleteProductGroupsResponse {
1133
+ /**
1134
+ * Results for each product group deletion attempt, in request order.
1135
+ * @minSize 1
1136
+ * @maxSize 100
1137
+ */
1138
+ results?: BulkDeleteProductGroupsResponseBulkProductGroupResult[];
1139
+ /** Aggregated success/failure counts. */
1140
+ bulkActionMetadata?: BulkActionMetadata;
1141
+ }
1142
+ interface BulkDeleteProductGroupsResponseBulkProductGroupResult {
1143
+ /** Metadata regarding the specific single delete operation. */
1144
+ itemMetadata?: ItemMetadata;
1145
+ }
1146
+ interface BulkUpdateProductGroupTagsRequest {
1147
+ /**
1148
+ * List of product group IDs whose tags will be updated.
1149
+ * @minSize 1
1150
+ * @maxSize 100
1151
+ * @format GUID
1152
+ */
1153
+ productGroupIds: string[];
1154
+ /** List of tags to assign. */
1155
+ assignTags?: Tags;
1156
+ /** List of tags to unassign. */
1157
+ unassignTags?: Tags;
1158
+ }
1159
+ interface BulkUpdateProductGroupTagsResponse {
1160
+ /**
1161
+ * Results.
1162
+ * @minSize 1
1163
+ * @maxSize 100
1164
+ */
1165
+ results?: BulkUpdateProductGroupTagsResult[];
1166
+ /** Aggregated success/failure counts. */
1167
+ bulkActionMetadata?: BulkActionMetadata;
1168
+ }
1169
+ interface BulkUpdateProductGroupTagsResult {
1170
+ /** Metadata regarding the specific single update operation. */
1171
+ itemMetadata?: ItemMetadata;
1172
+ }
1173
+ interface DomainEvent extends DomainEventBodyOneOf {
1174
+ createdEvent?: EntityCreatedEvent;
1175
+ updatedEvent?: EntityUpdatedEvent;
1176
+ deletedEvent?: EntityDeletedEvent;
1177
+ actionEvent?: ActionEvent;
1178
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
1179
+ id?: string;
1180
+ /**
1181
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
1182
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
1183
+ */
1184
+ entityFqdn?: string;
1185
+ /**
1186
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
1187
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
1188
+ */
1189
+ slug?: string;
1190
+ /** ID of the entity associated with the event. */
1191
+ entityId?: string;
1192
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
1193
+ eventTime?: Date | null;
1194
+ /**
1195
+ * Whether the event was triggered as a result of a privacy regulation application
1196
+ * (for example, GDPR).
1197
+ */
1198
+ triggeredByAnonymizeRequest?: boolean | null;
1199
+ /** If present, indicates the action that triggered the event. */
1200
+ originatedFrom?: string | null;
1201
+ /**
1202
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
1203
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
1204
+ */
1205
+ entityEventSequence?: string | null;
1206
+ }
1207
+ /** @oneof */
1208
+ interface DomainEventBodyOneOf {
1209
+ createdEvent?: EntityCreatedEvent;
1210
+ updatedEvent?: EntityUpdatedEvent;
1211
+ deletedEvent?: EntityDeletedEvent;
1212
+ actionEvent?: ActionEvent;
1213
+ }
1214
+ interface EntityCreatedEvent {
1215
+ entityAsJson?: string;
1216
+ /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
1217
+ restoreInfo?: RestoreInfo;
1218
+ }
1219
+ interface RestoreInfo {
1220
+ deletedDate?: Date | null;
1221
+ }
1222
+ interface EntityUpdatedEvent {
1223
+ /**
1224
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1225
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1226
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1227
+ */
1228
+ currentEntityAsJson?: string;
1229
+ }
1230
+ interface EntityDeletedEvent {
1231
+ /** Entity that was deleted. */
1232
+ deletedEntityAsJson?: string | null;
1233
+ }
1234
+ interface ActionEvent {
1235
+ bodyAsJson?: string;
1236
+ }
1237
+ interface Empty {
1238
+ }
1239
+ interface BulkUpdateProductGroupTagsByFilterRequest {
1240
+ /**
1241
+ * Filter object. Supported fields for filtering: `id`, `handle`.
1242
+ * Pass an empty object `{}` to target all product groups.
1243
+ */
1244
+ filter: Record<string, any> | null;
1245
+ /** List of tags to assign. */
1246
+ assignTags?: Tags;
1247
+ /** List of tags to unassign. */
1248
+ unassignTags?: Tags;
1249
+ }
1250
+ interface BulkUpdateProductGroupTagsByFilterResponse {
1251
+ /**
1252
+ * Job ID.
1253
+ *
1254
+ * Pass this ID to [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/introduction) to retrieve job details and metadata..
1255
+ * @format GUID
1256
+ */
1257
+ jobId?: string;
1258
+ }
1259
+ interface MessageEnvelope {
1260
+ /**
1261
+ * App instance ID.
1262
+ * @format GUID
1263
+ */
1264
+ instanceId?: string | null;
1265
+ /**
1266
+ * Event type.
1267
+ * @maxLength 150
1268
+ */
1269
+ eventType?: string;
1270
+ /** The identification type and identity data. */
1271
+ identity?: IdentificationData;
1272
+ /** Stringify payload. */
1273
+ data?: string;
1274
+ /** Details related to the account */
1275
+ accountInfo?: AccountInfo;
1276
+ }
1277
+ interface IdentificationData extends IdentificationDataIdOneOf {
1278
+ /**
1279
+ * ID of a site visitor that has not logged in to the site.
1280
+ * @format GUID
1281
+ */
1282
+ anonymousVisitorId?: string;
1283
+ /**
1284
+ * ID of a site visitor that has logged in to the site.
1285
+ * @format GUID
1286
+ */
1287
+ memberId?: string;
1288
+ /**
1289
+ * ID of a Wix user (site owner, contributor, etc.).
1290
+ * @format GUID
1291
+ */
1292
+ wixUserId?: string;
1293
+ /**
1294
+ * ID of an app.
1295
+ * @format GUID
1296
+ */
1297
+ appId?: string;
1298
+ /** @readonly */
1299
+ identityType?: WebhookIdentityTypeWithLiterals;
1300
+ }
1301
+ /** @oneof */
1302
+ interface IdentificationDataIdOneOf {
1303
+ /**
1304
+ * ID of a site visitor that has not logged in to the site.
1305
+ * @format GUID
1306
+ */
1307
+ anonymousVisitorId?: string;
1308
+ /**
1309
+ * ID of a site visitor that has logged in to the site.
1310
+ * @format GUID
1311
+ */
1312
+ memberId?: string;
1313
+ /**
1314
+ * ID of a Wix user (site owner, contributor, etc.).
1315
+ * @format GUID
1316
+ */
1317
+ wixUserId?: string;
1318
+ /**
1319
+ * ID of an app.
1320
+ * @format GUID
1321
+ */
1322
+ appId?: string;
1323
+ }
1324
+ declare enum WebhookIdentityType {
1325
+ UNKNOWN = "UNKNOWN",
1326
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1327
+ MEMBER = "MEMBER",
1328
+ WIX_USER = "WIX_USER",
1329
+ APP = "APP"
1330
+ }
1331
+ /** @enumType */
1332
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1333
+ interface AccountInfo {
1334
+ /**
1335
+ * ID of the Wix account associated with the event.
1336
+ * @format GUID
1337
+ */
1338
+ accountId?: string | null;
1339
+ /**
1340
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
1341
+ * @format GUID
1342
+ */
1343
+ parentAccountId?: string | null;
1344
+ /**
1345
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
1346
+ * @format GUID
1347
+ */
1348
+ siteId?: string | null;
1349
+ }
1350
+ /** @docsIgnore */
1351
+ type BulkUpdateProductGroupTagsApplicationErrors = {
1352
+ code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
1353
+ description?: string;
1354
+ data?: Record<string, any>;
1355
+ };
1356
+ /** @docsIgnore */
1357
+ type BulkUpdateProductGroupTagsByFilterApplicationErrors = {
1358
+ code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
1359
+ description?: string;
1360
+ data?: Record<string, any>;
1361
+ };
1362
+
1363
+ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1364
+ getUrl: (context: any) => string;
1365
+ httpMethod: K;
1366
+ path: string;
1367
+ pathParams: M;
1368
+ __requestType: T;
1369
+ __originalRequestType: S;
1370
+ __responseType: Q;
1371
+ __originalResponseType: R;
1372
+ };
1373
+ declare function createProductGroup(): __PublicMethodMetaInfo<'POST', {}, CreateProductGroupRequest$1, CreateProductGroupRequest, CreateProductGroupResponse$1, CreateProductGroupResponse>;
1374
+ declare function updateProductGroup(): __PublicMethodMetaInfo<'PATCH', {
1375
+ productGroupId: string;
1376
+ }, UpdateProductGroupRequest$1, UpdateProductGroupRequest, UpdateProductGroupResponse$1, UpdateProductGroupResponse>;
1377
+ declare function deleteProductGroup(): __PublicMethodMetaInfo<'DELETE', {
1378
+ productGroupId: string;
1379
+ }, DeleteProductGroupRequest$1, DeleteProductGroupRequest, DeleteProductGroupResponse$1, DeleteProductGroupResponse>;
1380
+ declare function getProductGroup(): __PublicMethodMetaInfo<'GET', {
1381
+ productGroupId: string;
1382
+ }, GetProductGroupRequest$1, GetProductGroupRequest, GetProductGroupResponse$1, GetProductGroupResponse>;
1383
+ declare function queryProductGroups(): __PublicMethodMetaInfo<'GET', {}, QueryProductGroupsRequest$1, QueryProductGroupsRequest, QueryProductGroupsResponse$1, QueryProductGroupsResponse>;
1384
+ declare function searchProductGroups(): __PublicMethodMetaInfo<'GET', {}, SearchProductGroupsRequest$1, SearchProductGroupsRequest, SearchProductGroupsResponse$1, SearchProductGroupsResponse>;
1385
+ declare function bulkCreateProductGroups(): __PublicMethodMetaInfo<'POST', {}, BulkCreateProductGroupsRequest$1, BulkCreateProductGroupsRequest, BulkCreateProductGroupsResponse$1, BulkCreateProductGroupsResponse>;
1386
+ declare function bulkUpdateProductGroups(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateProductGroupsRequest$1, BulkUpdateProductGroupsRequest, BulkUpdateProductGroupsResponse$1, BulkUpdateProductGroupsResponse>;
1387
+ declare function assignProductsToProductGroup(): __PublicMethodMetaInfo<'POST', {}, AssignProductsToProductGroupRequest$1, AssignProductsToProductGroupRequest, AssignProductsToProductGroupResponse$1, AssignProductsToProductGroupResponse>;
1388
+ declare function unassignProductsFromProductGroup(): __PublicMethodMetaInfo<'POST', {}, UnassignProductsFromProductGroupRequest$1, UnassignProductsFromProductGroupRequest, UnassignProductsFromProductGroupResponse$1, UnassignProductsFromProductGroupResponse>;
1389
+ declare function bulkDeleteProductGroups(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteProductGroupsRequest$1, BulkDeleteProductGroupsRequest, BulkDeleteProductGroupsResponse$1, BulkDeleteProductGroupsResponse>;
1390
+ declare function bulkUpdateProductGroupTags(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateProductGroupTagsRequest$1, BulkUpdateProductGroupTagsRequest, BulkUpdateProductGroupTagsResponse$1, BulkUpdateProductGroupTagsResponse>;
1391
+ declare function bulkUpdateProductGroupTagsByFilter(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateProductGroupTagsByFilterRequest$1, BulkUpdateProductGroupTagsByFilterRequest, BulkUpdateProductGroupTagsByFilterResponse$1, BulkUpdateProductGroupTagsByFilterResponse>;
1392
+
1393
+ export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AggregationData as AggregationDataOriginal, type AggregationKindOneOf as AggregationKindOneOfOriginal, type Aggregation as AggregationOriginal, type AggregationResults as AggregationResultsOriginal, type AggregationResultsResultOneOf as AggregationResultsResultOneOfOriginal, type AggregationResultsScalarResult as AggregationResultsScalarResultOriginal, AggregationType as AggregationTypeOriginal, type AggregationTypeWithLiterals as AggregationTypeWithLiteralsOriginal, type ApplicationError as ApplicationErrorOriginal, type AssignProductsToProductGroupRequest as AssignProductsToProductGroupRequestOriginal, type AssignProductsToProductGroupResponse as AssignProductsToProductGroupResponseOriginal, AvailabilityStatus as AvailabilityStatusOriginal, type AvailabilityStatusWithLiterals as AvailabilityStatusWithLiteralsOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkCreateProductGroupsRequest as BulkCreateProductGroupsRequestOriginal, type BulkCreateProductGroupsResponse as BulkCreateProductGroupsResponseOriginal, type BulkDeleteProductGroupsRequest as BulkDeleteProductGroupsRequestOriginal, type BulkDeleteProductGroupsResponseBulkProductGroupResult as BulkDeleteProductGroupsResponseBulkProductGroupResultOriginal, type BulkDeleteProductGroupsResponse as BulkDeleteProductGroupsResponseOriginal, type BulkProductGroupResult as BulkProductGroupResultOriginal, type BulkUpdateProductGroupTagsApplicationErrors as BulkUpdateProductGroupTagsApplicationErrorsOriginal, type BulkUpdateProductGroupTagsByFilterApplicationErrors as BulkUpdateProductGroupTagsByFilterApplicationErrorsOriginal, type BulkUpdateProductGroupTagsByFilterRequest as BulkUpdateProductGroupTagsByFilterRequestOriginal, type BulkUpdateProductGroupTagsByFilterResponse as BulkUpdateProductGroupTagsByFilterResponseOriginal, type BulkUpdateProductGroupTagsRequest as BulkUpdateProductGroupTagsRequestOriginal, type BulkUpdateProductGroupTagsResponse as BulkUpdateProductGroupTagsResponseOriginal, type BulkUpdateProductGroupTagsResult as BulkUpdateProductGroupTagsResultOriginal, type BulkUpdateProductGroupsRequest as BulkUpdateProductGroupsRequestOriginal, type BulkUpdateProductGroupsResponseBulkProductGroupResult as BulkUpdateProductGroupsResponseBulkProductGroupResultOriginal, type BulkUpdateProductGroupsResponse as BulkUpdateProductGroupsResponseOriginal, ChoiceType as ChoiceTypeOriginal, type ChoiceTypeWithLiterals as ChoiceTypeWithLiteralsOriginal, type CreateProductGroupRequest as CreateProductGroupRequestOriginal, type CreateProductGroupResponse as CreateProductGroupResponseOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type CursorSearch as CursorSearchOriginal, type CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, CustomizationRenderType as CustomizationRenderTypeOriginal, type CustomizationRenderTypeWithLiterals as CustomizationRenderTypeWithLiteralsOriginal, CustomizationType as CustomizationTypeOriginal, type CustomizationTypeWithLiterals as CustomizationTypeWithLiteralsOriginal, type DateHistogramAggregation as DateHistogramAggregationOriginal, type DateHistogramResult as DateHistogramResultOriginal, type DateHistogramResults as DateHistogramResultsOriginal, type DeleteProductGroupRequest as DeleteProductGroupRequestOriginal, type DeleteProductGroupResponse as DeleteProductGroupResponseOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type GetProductGroupRequest as GetProductGroupRequestOriginal, type GetProductGroupResponse as GetProductGroupResponseOriginal, type GroupByValueResults as GroupByValueResultsOriginal, type GroupingCustomization as GroupingCustomizationOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type IncludeMissingValuesOptions as IncludeMissingValuesOptionsOriginal, Interval as IntervalOriginal, type IntervalWithLiterals as IntervalWithLiteralsOriginal, type ItemMetadata as ItemMetadataOriginal, type MaskedProductGroup as MaskedProductGroupOriginal, MembershipStatus as MembershipStatusOriginal, type MembershipStatusWithLiterals as MembershipStatusWithLiteralsOriginal, type MessageEnvelope as MessageEnvelopeOriginal, MissingValues as MissingValuesOriginal, type MissingValuesWithLiterals as MissingValuesWithLiteralsOriginal, Mode as ModeOriginal, type ModeWithLiterals as ModeWithLiteralsOriginal, type NestedAggregationItemKindOneOf as NestedAggregationItemKindOneOfOriginal, type NestedAggregationItem as NestedAggregationItemOriginal, type NestedAggregation as NestedAggregationOriginal, type NestedAggregationResults as NestedAggregationResultsOriginal, type NestedAggregationResultsResultOneOf as NestedAggregationResultsResultOneOfOriginal, NestedAggregationType as NestedAggregationTypeOriginal, type NestedAggregationTypeWithLiterals as NestedAggregationTypeWithLiteralsOriginal, type NestedResultValue as NestedResultValueOriginal, type NestedResultValueResultOneOf as NestedResultValueResultOneOfOriginal, type NestedResults as NestedResultsOriginal, type NestedValueAggregationResult as NestedValueAggregationResultOriginal, type ProductAssignmentResult as ProductAssignmentResultOriginal, type ProductChoice as ProductChoiceOriginal, type ProductChoiceValueOneOf as ProductChoiceValueOneOfOriginal, type ProductGroupMember as ProductGroupMemberOriginal, type ProductGroup as ProductGroupOriginal, ProductGroupRequestedFields as ProductGroupRequestedFieldsOriginal, type ProductGroupRequestedFieldsWithLiterals as ProductGroupRequestedFieldsWithLiteralsOriginal, type ProductGroupTagsModified as ProductGroupTagsModifiedOriginal, type ProductUnassignmentResult as ProductUnassignmentResultOriginal, type QueryProductGroupsRequest as QueryProductGroupsRequestOriginal, type QueryProductGroupsResponse as QueryProductGroupsResponseOriginal, type RangeAggregation as RangeAggregationOriginal, type RangeAggregationResult as RangeAggregationResultOriginal, type RangeBucket as RangeBucketOriginal, type RangeResult as RangeResultOriginal, type RangeResults as RangeResultsOriginal, type RestoreInfo as RestoreInfoOriginal, type Results as ResultsOriginal, type ScalarAggregation as ScalarAggregationOriginal, type ScalarResult as ScalarResultOriginal, ScalarType as ScalarTypeOriginal, type ScalarTypeWithLiterals as ScalarTypeWithLiteralsOriginal, type SearchDetails as SearchDetailsOriginal, type SearchProductGroupsRequest as SearchProductGroupsRequestOriginal, type SearchProductGroupsResponse as SearchProductGroupsResponseOriginal, SortDirection as SortDirectionOriginal, type SortDirectionWithLiterals as SortDirectionWithLiteralsOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, SortType as SortTypeOriginal, type SortTypeWithLiterals as SortTypeWithLiteralsOriginal, type Sorting as SortingOriginal, type TagList as TagListOriginal, type Tags as TagsOriginal, type UnassignProductsFromProductGroupRequest as UnassignProductsFromProductGroupRequestOriginal, type UnassignProductsFromProductGroupResponse as UnassignProductsFromProductGroupResponseOriginal, type UpdateProductGroupRequest as UpdateProductGroupRequestOriginal, type UpdateProductGroupResponse as UpdateProductGroupResponseOriginal, type ValueAggregationOptionsOneOf as ValueAggregationOptionsOneOfOriginal, type ValueAggregation as ValueAggregationOriginal, type ValueAggregationResult as ValueAggregationResultOriginal, type ValueResult as ValueResultOriginal, type ValueResults as ValueResultsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, assignProductsToProductGroup, bulkCreateProductGroups, bulkDeleteProductGroups, bulkUpdateProductGroupTags, bulkUpdateProductGroupTagsByFilter, bulkUpdateProductGroups, createProductGroup, deleteProductGroup, getProductGroup, queryProductGroups, searchProductGroups, unassignProductsFromProductGroup, updateProductGroup };