@wix/auto_sdk_benefit-programs_items 1.0.0 → 1.0.1
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/src/benefit-programs-v1-item-items.types.d.ts +205 -44
- package/build/cjs/src/benefit-programs-v1-item-items.types.js.map +1 -1
- package/build/cjs/src/benefit-programs-v1-item-items.universal.d.ts +276 -47
- package/build/cjs/src/benefit-programs-v1-item-items.universal.js +49 -0
- package/build/cjs/src/benefit-programs-v1-item-items.universal.js.map +1 -1
- package/build/es/src/benefit-programs-v1-item-items.types.d.ts +205 -44
- package/build/es/src/benefit-programs-v1-item-items.types.js.map +1 -1
- package/build/es/src/benefit-programs-v1-item-items.universal.d.ts +276 -47
- package/build/es/src/benefit-programs-v1-item-items.universal.js +49 -0
- package/build/es/src/benefit-programs-v1-item-items.universal.js.map +1 -1
- package/build/internal/cjs/src/benefit-programs-v1-item-items.types.d.ts +205 -44
- package/build/internal/cjs/src/benefit-programs-v1-item-items.types.js.map +1 -1
- package/build/internal/cjs/src/benefit-programs-v1-item-items.universal.d.ts +276 -47
- package/build/internal/cjs/src/benefit-programs-v1-item-items.universal.js +49 -0
- package/build/internal/cjs/src/benefit-programs-v1-item-items.universal.js.map +1 -1
- package/build/internal/es/src/benefit-programs-v1-item-items.types.d.ts +205 -44
- package/build/internal/es/src/benefit-programs-v1-item-items.types.js.map +1 -1
- package/build/internal/es/src/benefit-programs-v1-item-items.universal.d.ts +276 -47
- package/build/internal/es/src/benefit-programs-v1-item-items.universal.js +49 -0
- package/build/internal/es/src/benefit-programs-v1-item-items.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
export interface Item {
|
|
2
2
|
/**
|
|
3
3
|
* Benefit item ID.
|
|
4
|
+
* @format GUID
|
|
4
5
|
* @readonly
|
|
5
6
|
*/
|
|
6
7
|
_id?: string | null;
|
|
@@ -26,9 +27,13 @@ export interface Item {
|
|
|
26
27
|
* External item ID assigned by the provider of the items.
|
|
27
28
|
*
|
|
28
29
|
* For example, if the benefit items are products, this ID corresponds to the specific product ID in the supplier's system.
|
|
30
|
+
* @format GUID
|
|
29
31
|
*/
|
|
30
32
|
externalId?: string;
|
|
31
|
-
/**
|
|
33
|
+
/**
|
|
34
|
+
* Item category. Groups benefit items together for organization and management purposes. For example, classes, posts, groups.
|
|
35
|
+
* @maxLength 20
|
|
36
|
+
*/
|
|
32
37
|
category?: string | null;
|
|
33
38
|
/**
|
|
34
39
|
* ID that is a shared reference between a benefit pool and a specific item.
|
|
@@ -36,14 +41,21 @@ export interface Item {
|
|
|
36
41
|
* This ID is returned when calling the Create Pool Definition method in the Pool Definitions API.
|
|
37
42
|
*
|
|
38
43
|
* It is used to link the specific benefit item to its corresponding location within the benefit pool.
|
|
44
|
+
* @format GUID
|
|
45
|
+
* @immutable
|
|
39
46
|
*/
|
|
40
47
|
itemSetId?: string;
|
|
41
|
-
/**
|
|
48
|
+
/**
|
|
49
|
+
* Display name of the item. For example, a concert ticket or an exercise session with a personal trainer.
|
|
50
|
+
* @maxLength 64
|
|
51
|
+
*/
|
|
42
52
|
displayName?: string | null;
|
|
43
53
|
/**
|
|
44
54
|
* ID of the application providing the benefit item.
|
|
45
55
|
*
|
|
46
56
|
* ID of the external application supplying the items. Each item's external ID is unique to its respective provider's application.
|
|
57
|
+
* @format GUID
|
|
58
|
+
* @immutable
|
|
47
59
|
*/
|
|
48
60
|
providerAppId?: string | null;
|
|
49
61
|
/**
|
|
@@ -55,6 +67,9 @@ export interface Item {
|
|
|
55
67
|
* Module name of the item provider's application that originated the items.
|
|
56
68
|
*
|
|
57
69
|
* For example, `store-inventory` or `fitness-resources`.
|
|
70
|
+
* @minLength 1
|
|
71
|
+
* @maxLength 50
|
|
72
|
+
* @immutable
|
|
58
73
|
*/
|
|
59
74
|
namespace?: string | null;
|
|
60
75
|
}
|
|
@@ -70,7 +85,10 @@ export interface ExtendedFields {
|
|
|
70
85
|
namespaces?: Record<string, Record<string, any>>;
|
|
71
86
|
}
|
|
72
87
|
export interface ItemsCloned {
|
|
73
|
-
/**
|
|
88
|
+
/**
|
|
89
|
+
* ID of the pool that had its items provisioned
|
|
90
|
+
* @format GUID
|
|
91
|
+
*/
|
|
74
92
|
itemSetId?: string;
|
|
75
93
|
}
|
|
76
94
|
export interface CreateItemRequest {
|
|
@@ -82,7 +100,11 @@ export interface CreateItemResponse {
|
|
|
82
100
|
item?: Item;
|
|
83
101
|
}
|
|
84
102
|
export interface BulkCreateItemsRequest {
|
|
85
|
-
/**
|
|
103
|
+
/**
|
|
104
|
+
* Items to be created.
|
|
105
|
+
* @minSize 1
|
|
106
|
+
* @maxSize 100
|
|
107
|
+
*/
|
|
86
108
|
items: Item[];
|
|
87
109
|
/**
|
|
88
110
|
* Whether to return the full item entities.
|
|
@@ -96,6 +118,8 @@ export interface BulkCreateItemsResponse {
|
|
|
96
118
|
* List of results for each item.
|
|
97
119
|
*
|
|
98
120
|
* Includes the item and whether the operation was successful.
|
|
121
|
+
* @minSize 1
|
|
122
|
+
* @maxSize 100
|
|
99
123
|
*/
|
|
100
124
|
results?: BulkItemResult[];
|
|
101
125
|
/** Bulk action metadata. */
|
|
@@ -108,7 +132,10 @@ export interface BulkItemResult {
|
|
|
108
132
|
item?: Item;
|
|
109
133
|
}
|
|
110
134
|
export interface ItemMetadata {
|
|
111
|
-
/**
|
|
135
|
+
/**
|
|
136
|
+
* Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
|
|
137
|
+
* @format GUID
|
|
138
|
+
*/
|
|
112
139
|
_id?: string | null;
|
|
113
140
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
114
141
|
originalIndex?: number;
|
|
@@ -134,13 +161,21 @@ export interface BulkActionMetadata {
|
|
|
134
161
|
undetailedFailures?: number;
|
|
135
162
|
}
|
|
136
163
|
export interface DeleteItemRequest {
|
|
137
|
-
/**
|
|
164
|
+
/**
|
|
165
|
+
* Item ID.
|
|
166
|
+
* @format GUID
|
|
167
|
+
*/
|
|
138
168
|
itemId: string;
|
|
139
169
|
}
|
|
140
170
|
export interface DeleteItemResponse {
|
|
141
171
|
}
|
|
142
172
|
export interface BulkDeleteItemsRequest {
|
|
143
|
-
/**
|
|
173
|
+
/**
|
|
174
|
+
* ID of the items to delete.
|
|
175
|
+
* @minSize 1
|
|
176
|
+
* @maxSize 100
|
|
177
|
+
* @format GUID
|
|
178
|
+
*/
|
|
144
179
|
itemIds: string[];
|
|
145
180
|
}
|
|
146
181
|
export interface BulkDeleteItemsResponse {
|
|
@@ -148,13 +183,19 @@ export interface BulkDeleteItemsResponse {
|
|
|
148
183
|
* List of results for each item.
|
|
149
184
|
*
|
|
150
185
|
* Includes the item and whether the deletion was successful.
|
|
186
|
+
* @minSize 1
|
|
187
|
+
* @maxSize 100
|
|
151
188
|
*/
|
|
152
189
|
results?: BulkItemResult[];
|
|
153
190
|
/** Bulk action metadata. */
|
|
154
191
|
bulkActionMetadata?: BulkActionMetadata;
|
|
155
192
|
}
|
|
156
193
|
export interface BulkDeleteItemsByFilterRequest {
|
|
157
|
-
/**
|
|
194
|
+
/**
|
|
195
|
+
* Sub-module name of the item provider's application that originated the items.
|
|
196
|
+
* @minLength 1
|
|
197
|
+
* @maxLength 50
|
|
198
|
+
*/
|
|
158
199
|
namespace: string;
|
|
159
200
|
/** Filter options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language). */
|
|
160
201
|
filter?: Record<string, any> | null;
|
|
@@ -164,6 +205,7 @@ export interface BulkDeleteItemsByFilterResponse {
|
|
|
164
205
|
* Job ID. Use the Async Job API to retrieve bulk delete results.
|
|
165
206
|
*
|
|
166
207
|
* Specify this job ID in the Get Async Job method to retrieve job details and metadata.
|
|
208
|
+
* @format GUID
|
|
167
209
|
*/
|
|
168
210
|
jobId?: string;
|
|
169
211
|
}
|
|
@@ -176,7 +218,11 @@ export interface UpdateItemResponse {
|
|
|
176
218
|
item?: Item;
|
|
177
219
|
}
|
|
178
220
|
export interface BulkUpdateItemsRequest {
|
|
179
|
-
/**
|
|
221
|
+
/**
|
|
222
|
+
* Items to update.
|
|
223
|
+
* @minSize 1
|
|
224
|
+
* @maxSize 100
|
|
225
|
+
*/
|
|
180
226
|
items?: MaskedItem[];
|
|
181
227
|
/**
|
|
182
228
|
* Whether to return the full item entities.
|
|
@@ -192,13 +238,20 @@ export interface MaskedItem {
|
|
|
192
238
|
fieldMask?: string[];
|
|
193
239
|
}
|
|
194
240
|
export interface BulkUpdateItemsResponse {
|
|
195
|
-
/**
|
|
241
|
+
/**
|
|
242
|
+
* Items that were updated.
|
|
243
|
+
* @minSize 1
|
|
244
|
+
* @maxSize 100
|
|
245
|
+
*/
|
|
196
246
|
results?: BulkItemResult[];
|
|
197
247
|
/** Bulk action metadata. */
|
|
198
248
|
bulkActionMetadata?: BulkActionMetadata;
|
|
199
249
|
}
|
|
200
250
|
export interface GetItemRequest {
|
|
201
|
-
/**
|
|
251
|
+
/**
|
|
252
|
+
* ID of the item to retrieve.
|
|
253
|
+
* @format GUID
|
|
254
|
+
*/
|
|
202
255
|
itemId: string;
|
|
203
256
|
}
|
|
204
257
|
export interface GetItemResponse {
|
|
@@ -231,29 +284,58 @@ export declare enum Type {
|
|
|
231
284
|
BY_REFERENCE = "BY_REFERENCE"
|
|
232
285
|
}
|
|
233
286
|
export interface ByItemSetIdAndReference {
|
|
234
|
-
/**
|
|
287
|
+
/**
|
|
288
|
+
* Filter list.
|
|
289
|
+
* @minSize 1
|
|
290
|
+
* @maxSize 100
|
|
291
|
+
*/
|
|
235
292
|
filters?: ByItemSetIdAndReferenceFilter[];
|
|
236
293
|
}
|
|
237
294
|
export interface ByItemSetIdAndReferenceFilter {
|
|
238
|
-
/**
|
|
295
|
+
/**
|
|
296
|
+
* ID that is a shared reference between a benefit pool and a specific item.
|
|
297
|
+
* @format GUID
|
|
298
|
+
*/
|
|
239
299
|
itemSetId?: string;
|
|
240
|
-
/**
|
|
300
|
+
/**
|
|
301
|
+
* External item ID assigned by the provider of the items.
|
|
302
|
+
* @format GUID
|
|
303
|
+
*/
|
|
241
304
|
externalId?: string;
|
|
242
|
-
/**
|
|
305
|
+
/**
|
|
306
|
+
* Item category. Groups benefit items together for organization and management purposes. For example, classes, posts, groups.
|
|
307
|
+
* @maxLength 20
|
|
308
|
+
*/
|
|
243
309
|
category?: string;
|
|
244
|
-
/**
|
|
310
|
+
/**
|
|
311
|
+
* ID of the external application supplying the items.
|
|
312
|
+
* @format GUID
|
|
313
|
+
*/
|
|
245
314
|
providerAppId?: string;
|
|
246
315
|
}
|
|
247
316
|
export interface ByReference {
|
|
248
|
-
/**
|
|
317
|
+
/**
|
|
318
|
+
* Filter list.
|
|
319
|
+
* @minSize 1
|
|
320
|
+
* @maxSize 100
|
|
321
|
+
*/
|
|
249
322
|
filters?: ByReferenceFilter[];
|
|
250
323
|
}
|
|
251
324
|
export interface ByReferenceFilter {
|
|
252
|
-
/**
|
|
325
|
+
/**
|
|
326
|
+
* External item ID assigned by the provider of the items.
|
|
327
|
+
* @format GUID
|
|
328
|
+
*/
|
|
253
329
|
externalId?: string;
|
|
254
|
-
/**
|
|
330
|
+
/**
|
|
331
|
+
* Item category. Groups benefit items together for organization and management purposes. For example, classes, posts, groups.
|
|
332
|
+
* @maxLength 20
|
|
333
|
+
*/
|
|
255
334
|
category?: string;
|
|
256
|
-
/**
|
|
335
|
+
/**
|
|
336
|
+
* ID of the external application supplying the items.
|
|
337
|
+
* @format GUID
|
|
338
|
+
*/
|
|
257
339
|
providerAppId?: string;
|
|
258
340
|
}
|
|
259
341
|
export interface Filter extends FilterFilterOneOf {
|
|
@@ -274,7 +356,11 @@ export interface Filter extends FilterFilterOneOf {
|
|
|
274
356
|
byReferenceOptions?: ByReference;
|
|
275
357
|
/** Filter type. */
|
|
276
358
|
type?: Type;
|
|
277
|
-
/**
|
|
359
|
+
/**
|
|
360
|
+
* Filter items by the item's namespace.
|
|
361
|
+
* @minLength 1
|
|
362
|
+
* @maxLength 50
|
|
363
|
+
*/
|
|
278
364
|
namespace?: string;
|
|
279
365
|
}
|
|
280
366
|
/** @oneof */
|
|
@@ -296,13 +382,17 @@ export interface FilterFilterOneOf {
|
|
|
296
382
|
byReferenceOptions?: ByReference;
|
|
297
383
|
}
|
|
298
384
|
export interface CursorPaging {
|
|
299
|
-
/**
|
|
385
|
+
/**
|
|
386
|
+
* Maximum number of items to return in the results.
|
|
387
|
+
* @max 1000
|
|
388
|
+
*/
|
|
300
389
|
limit?: number | null;
|
|
301
390
|
/**
|
|
302
391
|
* Pointer to the next or previous page in the list of results.
|
|
303
392
|
*
|
|
304
393
|
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
305
394
|
* Not relevant for the first request.
|
|
395
|
+
* @maxLength 16000
|
|
306
396
|
*/
|
|
307
397
|
cursor?: string | null;
|
|
308
398
|
}
|
|
@@ -326,9 +416,15 @@ export interface CursorPagingMetadata {
|
|
|
326
416
|
hasNext?: boolean | null;
|
|
327
417
|
}
|
|
328
418
|
export interface Cursors {
|
|
329
|
-
/**
|
|
419
|
+
/**
|
|
420
|
+
* Cursor string pointing to the next page in the list of results.
|
|
421
|
+
* @maxLength 16000
|
|
422
|
+
*/
|
|
330
423
|
next?: string | null;
|
|
331
|
-
/**
|
|
424
|
+
/**
|
|
425
|
+
* Cursor pointing to the previous page in the list of results.
|
|
426
|
+
* @maxLength 16000
|
|
427
|
+
*/
|
|
332
428
|
prev?: string | null;
|
|
333
429
|
}
|
|
334
430
|
export interface QueryItemsRequest {
|
|
@@ -350,6 +446,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
350
446
|
/**
|
|
351
447
|
* Sort object in the following format:
|
|
352
448
|
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
449
|
+
* @maxSize 5
|
|
353
450
|
*/
|
|
354
451
|
sort?: Sorting[];
|
|
355
452
|
}
|
|
@@ -359,7 +456,10 @@ export interface CursorQueryPagingMethodOneOf {
|
|
|
359
456
|
cursorPaging?: CursorPaging;
|
|
360
457
|
}
|
|
361
458
|
export interface Sorting {
|
|
362
|
-
/**
|
|
459
|
+
/**
|
|
460
|
+
* Name of the field to sort by.
|
|
461
|
+
* @maxLength 512
|
|
462
|
+
*/
|
|
363
463
|
fieldName?: string;
|
|
364
464
|
/** Sort order. */
|
|
365
465
|
order?: SortOrder;
|
|
@@ -387,39 +487,70 @@ export interface CountItemsResponse {
|
|
|
387
487
|
count?: number;
|
|
388
488
|
}
|
|
389
489
|
export interface CloneItemsRequest {
|
|
390
|
-
/**
|
|
490
|
+
/**
|
|
491
|
+
* Id of the item set to be cloned
|
|
492
|
+
* @format GUID
|
|
493
|
+
*/
|
|
391
494
|
itemSetId?: string;
|
|
392
495
|
}
|
|
393
496
|
export interface CloneItemsResponse {
|
|
394
|
-
/**
|
|
497
|
+
/**
|
|
498
|
+
* Id of the item set that these items were added to
|
|
499
|
+
* @format GUID
|
|
500
|
+
*/
|
|
395
501
|
clonedItemSetId?: string;
|
|
396
|
-
/**
|
|
502
|
+
/**
|
|
503
|
+
* Id of the job that is cloning the item set
|
|
504
|
+
* @format GUID
|
|
505
|
+
*/
|
|
397
506
|
cloneJobId?: string;
|
|
398
507
|
}
|
|
399
508
|
export interface BulkCloneItemSetsRequest {
|
|
400
|
-
/**
|
|
509
|
+
/**
|
|
510
|
+
* Id of the item sets to be cloned
|
|
511
|
+
* @format GUID
|
|
512
|
+
* @minSize 1
|
|
513
|
+
* @maxSize 1000
|
|
514
|
+
*/
|
|
401
515
|
itemSetIds?: string[];
|
|
402
516
|
}
|
|
403
517
|
export interface BulkCloneItemSetsResponse {
|
|
404
|
-
/**
|
|
518
|
+
/**
|
|
519
|
+
* Results
|
|
520
|
+
* @minSize 1
|
|
521
|
+
* @maxSize 1000
|
|
522
|
+
*/
|
|
405
523
|
results?: BulkCloneItemSetsResult[];
|
|
406
524
|
/** Bulk action metadata */
|
|
407
525
|
bulkActionMetadata?: BulkActionMetadata;
|
|
408
|
-
/**
|
|
526
|
+
/**
|
|
527
|
+
* Id of the job that is cloning the item set
|
|
528
|
+
* @format GUID
|
|
529
|
+
*/
|
|
409
530
|
jobId?: string;
|
|
410
531
|
}
|
|
411
532
|
export interface BulkCloneItemSetsResult {
|
|
412
533
|
/** Item metadata */
|
|
413
534
|
itemMetadata?: ItemMetadata;
|
|
414
|
-
/**
|
|
535
|
+
/**
|
|
536
|
+
* Id of the item set that these items were added to
|
|
537
|
+
* @format GUID
|
|
538
|
+
*/
|
|
415
539
|
clonedItemSetId?: string;
|
|
416
540
|
}
|
|
417
541
|
export interface AllocateItemSetsRequest {
|
|
418
|
-
/**
|
|
542
|
+
/**
|
|
543
|
+
* Number of sets to allocate
|
|
544
|
+
* @min 1
|
|
545
|
+
* @max 1000
|
|
546
|
+
*/
|
|
419
547
|
numberOfSets?: number;
|
|
420
548
|
}
|
|
421
549
|
export interface AllocateItemSetsResponse {
|
|
422
|
-
/**
|
|
550
|
+
/**
|
|
551
|
+
* ID that is a shared reference between a benefit pool and a specific item.
|
|
552
|
+
* @format GUID
|
|
553
|
+
*/
|
|
423
554
|
itemSetIds?: string[];
|
|
424
555
|
}
|
|
425
556
|
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
@@ -493,9 +624,15 @@ export interface ActionEvent {
|
|
|
493
624
|
body?: string;
|
|
494
625
|
}
|
|
495
626
|
export interface MessageEnvelope {
|
|
496
|
-
/**
|
|
627
|
+
/**
|
|
628
|
+
* App instance ID.
|
|
629
|
+
* @format GUID
|
|
630
|
+
*/
|
|
497
631
|
instanceId?: string | null;
|
|
498
|
-
/**
|
|
632
|
+
/**
|
|
633
|
+
* Event type.
|
|
634
|
+
* @maxLength 150
|
|
635
|
+
*/
|
|
499
636
|
eventType?: string;
|
|
500
637
|
/** The identification type and identity data. */
|
|
501
638
|
identity?: IdentificationData;
|
|
@@ -503,26 +640,50 @@ export interface MessageEnvelope {
|
|
|
503
640
|
data?: string;
|
|
504
641
|
}
|
|
505
642
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
506
|
-
/**
|
|
643
|
+
/**
|
|
644
|
+
* ID of a site visitor that has not logged in to the site.
|
|
645
|
+
* @format GUID
|
|
646
|
+
*/
|
|
507
647
|
anonymousVisitorId?: string;
|
|
508
|
-
/**
|
|
648
|
+
/**
|
|
649
|
+
* ID of a site visitor that has logged in to the site.
|
|
650
|
+
* @format GUID
|
|
651
|
+
*/
|
|
509
652
|
memberId?: string;
|
|
510
|
-
/**
|
|
653
|
+
/**
|
|
654
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
655
|
+
* @format GUID
|
|
656
|
+
*/
|
|
511
657
|
wixUserId?: string;
|
|
512
|
-
/**
|
|
658
|
+
/**
|
|
659
|
+
* ID of an app.
|
|
660
|
+
* @format GUID
|
|
661
|
+
*/
|
|
513
662
|
appId?: string;
|
|
514
663
|
/** @readonly */
|
|
515
664
|
identityType?: WebhookIdentityType;
|
|
516
665
|
}
|
|
517
666
|
/** @oneof */
|
|
518
667
|
export interface IdentificationDataIdOneOf {
|
|
519
|
-
/**
|
|
668
|
+
/**
|
|
669
|
+
* ID of a site visitor that has not logged in to the site.
|
|
670
|
+
* @format GUID
|
|
671
|
+
*/
|
|
520
672
|
anonymousVisitorId?: string;
|
|
521
|
-
/**
|
|
673
|
+
/**
|
|
674
|
+
* ID of a site visitor that has logged in to the site.
|
|
675
|
+
* @format GUID
|
|
676
|
+
*/
|
|
522
677
|
memberId?: string;
|
|
523
|
-
/**
|
|
678
|
+
/**
|
|
679
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
680
|
+
* @format GUID
|
|
681
|
+
*/
|
|
524
682
|
wixUserId?: string;
|
|
525
|
-
/**
|
|
683
|
+
/**
|
|
684
|
+
* ID of an app.
|
|
685
|
+
* @format GUID
|
|
686
|
+
*/
|
|
526
687
|
appId?: string;
|
|
527
688
|
}
|
|
528
689
|
export declare enum WebhookIdentityType {
|
|
@@ -600,6 +761,9 @@ export interface CountItemsResponseNonNullableFields {
|
|
|
600
761
|
* @requiredField item.namespace
|
|
601
762
|
* @requiredField item.providerAppId
|
|
602
763
|
* @permissionId BENEFIT_PROGRAMS.ITEM_CREATE
|
|
764
|
+
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
765
|
+
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
766
|
+
* @applicableIdentity APP
|
|
603
767
|
* @returns Created item.
|
|
604
768
|
* @fqn wix.benefit_programs.v1.item.ItemService.CreateItem
|
|
605
769
|
*/
|
|
@@ -619,6 +783,9 @@ export declare function createItem(item: Item): Promise<Item & ItemNonNullableFi
|
|
|
619
783
|
* @requiredField items.namespace
|
|
620
784
|
* @requiredField items.providerAppId
|
|
621
785
|
* @permissionId BENEFIT_PROGRAMS.ITEM_CREATE
|
|
786
|
+
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
787
|
+
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
788
|
+
* @applicableIdentity APP
|
|
622
789
|
* @fqn wix.benefit_programs.v1.item.ItemService.BulkCreateItems
|
|
623
790
|
*/
|
|
624
791
|
export declare function bulkCreateItems(items: Item[], options?: BulkCreateItemsOptions): Promise<BulkCreateItemsResponse & BulkCreateItemsResponseNonNullableFields>;
|
|
@@ -639,6 +806,9 @@ export interface BulkCreateItemsOptions {
|
|
|
639
806
|
* @documentationMaturity preview
|
|
640
807
|
* @requiredField itemId
|
|
641
808
|
* @permissionId BENEFIT_PROGRAMS.ITEM_DELETE
|
|
809
|
+
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
810
|
+
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
811
|
+
* @applicableIdentity APP
|
|
642
812
|
* @fqn wix.benefit_programs.v1.item.ItemService.DeleteItem
|
|
643
813
|
*/
|
|
644
814
|
export declare function deleteItem(itemId: string): Promise<void>;
|
|
@@ -651,6 +821,9 @@ export declare function deleteItem(itemId: string): Promise<void>;
|
|
|
651
821
|
* @documentationMaturity preview
|
|
652
822
|
* @requiredField itemIds
|
|
653
823
|
* @permissionId BENEFIT_PROGRAMS.ITEM_DELETE
|
|
824
|
+
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
825
|
+
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
826
|
+
* @applicableIdentity APP
|
|
654
827
|
* @fqn wix.benefit_programs.v1.item.ItemService.BulkDeleteItems
|
|
655
828
|
*/
|
|
656
829
|
export declare function bulkDeleteItems(itemIds: string[]): Promise<BulkDeleteItemsResponse & BulkDeleteItemsResponseNonNullableFields>;
|
|
@@ -663,6 +836,9 @@ export declare function bulkDeleteItems(itemIds: string[]): Promise<BulkDeleteIt
|
|
|
663
836
|
* @documentationMaturity preview
|
|
664
837
|
* @requiredField namespace
|
|
665
838
|
* @permissionId BENEFIT_PROGRAMS.ITEM_DELETE
|
|
839
|
+
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
840
|
+
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
841
|
+
* @applicableIdentity APP
|
|
666
842
|
* @fqn wix.benefit_programs.v1.item.ItemService.BulkDeleteItemsByFilter
|
|
667
843
|
*/
|
|
668
844
|
export declare function bulkDeleteItemsByFilter(namespace: string, options?: BulkDeleteItemsByFilterOptions): Promise<BulkDeleteItemsByFilterResponse & BulkDeleteItemsByFilterResponseNonNullableFields>;
|
|
@@ -685,6 +861,9 @@ export interface BulkDeleteItemsByFilterOptions {
|
|
|
685
861
|
* @requiredField item
|
|
686
862
|
* @requiredField item.revision
|
|
687
863
|
* @permissionId BENEFIT_PROGRAMS.ITEM_UPDATE
|
|
864
|
+
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
865
|
+
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
866
|
+
* @applicableIdentity APP
|
|
688
867
|
* @returns Updated item.
|
|
689
868
|
* @fqn wix.benefit_programs.v1.item.ItemService.UpdateItem
|
|
690
869
|
*/
|
|
@@ -692,6 +871,7 @@ export declare function updateItem(_id: string | null, item: UpdateItem): Promis
|
|
|
692
871
|
export interface UpdateItem {
|
|
693
872
|
/**
|
|
694
873
|
* Benefit item ID.
|
|
874
|
+
* @format GUID
|
|
695
875
|
* @readonly
|
|
696
876
|
*/
|
|
697
877
|
_id?: string | null;
|
|
@@ -717,9 +897,13 @@ export interface UpdateItem {
|
|
|
717
897
|
* External item ID assigned by the provider of the items.
|
|
718
898
|
*
|
|
719
899
|
* For example, if the benefit items are products, this ID corresponds to the specific product ID in the supplier's system.
|
|
900
|
+
* @format GUID
|
|
720
901
|
*/
|
|
721
902
|
externalId?: string;
|
|
722
|
-
/**
|
|
903
|
+
/**
|
|
904
|
+
* Item category. Groups benefit items together for organization and management purposes. For example, classes, posts, groups.
|
|
905
|
+
* @maxLength 20
|
|
906
|
+
*/
|
|
723
907
|
category?: string | null;
|
|
724
908
|
/**
|
|
725
909
|
* ID that is a shared reference between a benefit pool and a specific item.
|
|
@@ -727,14 +911,21 @@ export interface UpdateItem {
|
|
|
727
911
|
* This ID is returned when calling the Create Pool Definition method in the Pool Definitions API.
|
|
728
912
|
*
|
|
729
913
|
* It is used to link the specific benefit item to its corresponding location within the benefit pool.
|
|
914
|
+
* @format GUID
|
|
915
|
+
* @immutable
|
|
730
916
|
*/
|
|
731
917
|
itemSetId?: string;
|
|
732
|
-
/**
|
|
918
|
+
/**
|
|
919
|
+
* Display name of the item. For example, a concert ticket or an exercise session with a personal trainer.
|
|
920
|
+
* @maxLength 64
|
|
921
|
+
*/
|
|
733
922
|
displayName?: string | null;
|
|
734
923
|
/**
|
|
735
924
|
* ID of the application providing the benefit item.
|
|
736
925
|
*
|
|
737
926
|
* ID of the external application supplying the items. Each item's external ID is unique to its respective provider's application.
|
|
927
|
+
* @format GUID
|
|
928
|
+
* @immutable
|
|
738
929
|
*/
|
|
739
930
|
providerAppId?: string | null;
|
|
740
931
|
/**
|
|
@@ -746,6 +937,9 @@ export interface UpdateItem {
|
|
|
746
937
|
* Module name of the item provider's application that originated the items.
|
|
747
938
|
*
|
|
748
939
|
* For example, `store-inventory` or `fitness-resources`.
|
|
940
|
+
* @minLength 1
|
|
941
|
+
* @maxLength 50
|
|
942
|
+
* @immutable
|
|
749
943
|
*/
|
|
750
944
|
namespace?: string | null;
|
|
751
945
|
}
|
|
@@ -757,11 +951,18 @@ export interface UpdateItem {
|
|
|
757
951
|
* @requiredField options.items.item._id
|
|
758
952
|
* @requiredField options.items.item.revision
|
|
759
953
|
* @permissionId BENEFIT_PROGRAMS.ITEM_UPDATE
|
|
954
|
+
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
955
|
+
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
956
|
+
* @applicableIdentity APP
|
|
760
957
|
* @fqn wix.benefit_programs.v1.item.ItemService.BulkUpdateItems
|
|
761
958
|
*/
|
|
762
959
|
export declare function bulkUpdateItems(options?: BulkUpdateItemsOptions): Promise<BulkUpdateItemsResponse & BulkUpdateItemsResponseNonNullableFields>;
|
|
763
960
|
export interface BulkUpdateItemsOptions {
|
|
764
|
-
/**
|
|
961
|
+
/**
|
|
962
|
+
* Items to update.
|
|
963
|
+
* @minSize 1
|
|
964
|
+
* @maxSize 100
|
|
965
|
+
*/
|
|
765
966
|
items?: MaskedItem[];
|
|
766
967
|
/**
|
|
767
968
|
* Whether to return the full item entities.
|
|
@@ -777,6 +978,13 @@ export interface BulkUpdateItemsOptions {
|
|
|
777
978
|
* @documentationMaturity preview
|
|
778
979
|
* @requiredField itemId
|
|
779
980
|
* @permissionId BENEFIT_PROGRAMS.ITEM_READ
|
|
981
|
+
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
982
|
+
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
983
|
+
* @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
|
|
984
|
+
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
|
|
985
|
+
* @permissionScope Manage Events
|
|
986
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
987
|
+
* @applicableIdentity APP
|
|
780
988
|
* @returns Retrieved item.
|
|
781
989
|
* @fqn wix.benefit_programs.v1.item.ItemService.GetItem
|
|
782
990
|
*/
|
|
@@ -786,6 +994,13 @@ export declare function getItem(itemId: string): Promise<Item & ItemNonNullableF
|
|
|
786
994
|
* @public
|
|
787
995
|
* @documentationMaturity preview
|
|
788
996
|
* @permissionId BENEFIT_PROGRAMS.ITEM_READ
|
|
997
|
+
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
998
|
+
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
999
|
+
* @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
|
|
1000
|
+
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
|
|
1001
|
+
* @permissionScope Manage Events
|
|
1002
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1003
|
+
* @applicableIdentity APP
|
|
789
1004
|
* @fqn wix.benefit_programs.v1.item.ItemService.ListItems
|
|
790
1005
|
*/
|
|
791
1006
|
export declare function listItems(options?: ListItemsOptions): Promise<ListItemsResponse & ListItemsResponseNonNullableFields>;
|
|
@@ -807,7 +1022,14 @@ export interface ListItemsOptions {
|
|
|
807
1022
|
* The following `ItemsQueryBuilder` functions are supported for `queryItems()`. For a full description of the item object, see the object returned for the [`items`](/items/items-query-result/items) property in `ItemsQueryResult`.
|
|
808
1023
|
* @public
|
|
809
1024
|
* @documentationMaturity preview
|
|
1025
|
+
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
1026
|
+
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
1027
|
+
* @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
|
|
1028
|
+
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
|
|
1029
|
+
* @permissionScope Manage Events
|
|
1030
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
810
1031
|
* @permissionId BENEFIT_PROGRAMS.ITEM_READ
|
|
1032
|
+
* @applicableIdentity APP
|
|
811
1033
|
* @fqn wix.benefit_programs.v1.item.ItemService.QueryItems
|
|
812
1034
|
*/
|
|
813
1035
|
export declare function queryItems(): ItemsQueryBuilder;
|
|
@@ -895,6 +1117,13 @@ export interface ItemsQueryBuilder {
|
|
|
895
1117
|
* @public
|
|
896
1118
|
* @documentationMaturity preview
|
|
897
1119
|
* @permissionId BENEFIT_PROGRAMS.ITEM_READ
|
|
1120
|
+
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
1121
|
+
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
1122
|
+
* @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
|
|
1123
|
+
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
|
|
1124
|
+
* @permissionScope Manage Events
|
|
1125
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1126
|
+
* @applicableIdentity APP
|
|
898
1127
|
* @fqn wix.benefit_programs.v1.item.ItemService.CountItems
|
|
899
1128
|
*/
|
|
900
1129
|
export declare function countItems(options?: CountItemsOptions): Promise<CountItemsResponse & CountItemsResponseNonNullableFields>;
|