@wix/auto_sdk_benefit-programs_pool-definitions 1.0.1 → 1.0.2
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-pool-definition-pool-definitions.context.d.ts +1 -1
- package/build/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.public.d.ts +1 -1
- package/build/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.public.js.map +1 -1
- package/build/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.types.d.ts +206 -43
- package/build/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.types.js.map +1 -1
- package/build/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.universal.d.ts +240 -48
- package/build/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.universal.js +6 -0
- package/build/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.universal.js.map +1 -1
- package/build/es/src/benefit-programs-v1-pool-definition-pool-definitions.context.d.ts +1 -1
- package/build/es/src/benefit-programs-v1-pool-definition-pool-definitions.public.d.ts +1 -1
- package/build/es/src/benefit-programs-v1-pool-definition-pool-definitions.public.js.map +1 -1
- package/build/es/src/benefit-programs-v1-pool-definition-pool-definitions.types.d.ts +206 -43
- package/build/es/src/benefit-programs-v1-pool-definition-pool-definitions.types.js.map +1 -1
- package/build/es/src/benefit-programs-v1-pool-definition-pool-definitions.universal.d.ts +240 -48
- package/build/es/src/benefit-programs-v1-pool-definition-pool-definitions.universal.js +6 -0
- package/build/es/src/benefit-programs-v1-pool-definition-pool-definitions.universal.js.map +1 -1
- package/build/internal/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.context.d.ts +1 -1
- package/build/internal/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.public.d.ts +1 -1
- package/build/internal/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.public.js.map +1 -1
- package/build/internal/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.types.d.ts +206 -43
- package/build/internal/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.types.js.map +1 -1
- package/build/internal/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.universal.d.ts +240 -48
- package/build/internal/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.universal.js +6 -0
- package/build/internal/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.universal.js.map +1 -1
- package/build/internal/es/src/benefit-programs-v1-pool-definition-pool-definitions.context.d.ts +1 -1
- package/build/internal/es/src/benefit-programs-v1-pool-definition-pool-definitions.public.d.ts +1 -1
- package/build/internal/es/src/benefit-programs-v1-pool-definition-pool-definitions.public.js.map +1 -1
- package/build/internal/es/src/benefit-programs-v1-pool-definition-pool-definitions.types.d.ts +206 -43
- package/build/internal/es/src/benefit-programs-v1-pool-definition-pool-definitions.types.js.map +1 -1
- package/build/internal/es/src/benefit-programs-v1-pool-definition-pool-definitions.universal.d.ts +240 -48
- package/build/internal/es/src/benefit-programs-v1-pool-definition-pool-definitions.universal.js +6 -0
- package/build/internal/es/src/benefit-programs-v1-pool-definition-pool-definitions.universal.js.map +1 -1
- package/package.json +2 -2
package/build/internal/es/src/benefit-programs-v1-pool-definition-pool-definitions.universal.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
export interface PoolDefinition {
|
|
2
2
|
/**
|
|
3
3
|
* Pool definition ID.
|
|
4
|
+
* @format GUID
|
|
4
5
|
* @readonly
|
|
5
6
|
*/
|
|
6
7
|
_id?: string | null;
|
|
@@ -22,9 +23,16 @@ export interface PoolDefinition {
|
|
|
22
23
|
* @readonly
|
|
23
24
|
*/
|
|
24
25
|
_updatedDate?: Date | null;
|
|
25
|
-
/**
|
|
26
|
+
/**
|
|
27
|
+
* Name of the pool definition.
|
|
28
|
+
* @maxLength 128
|
|
29
|
+
*/
|
|
26
30
|
displayName?: string;
|
|
27
|
-
/**
|
|
31
|
+
/**
|
|
32
|
+
* List of program definitions that are associated with this pool definition.
|
|
33
|
+
* @format GUID
|
|
34
|
+
* @maxSize 100
|
|
35
|
+
*/
|
|
28
36
|
programDefinitionIds?: string[];
|
|
29
37
|
/**
|
|
30
38
|
* Benefit pool information.
|
|
@@ -38,6 +46,9 @@ export interface PoolDefinition {
|
|
|
38
46
|
* This namespace is used to organize and retrieve pool definitions and their associated benefit pools.
|
|
39
47
|
*
|
|
40
48
|
* It should match the namespace used in the program definitions.
|
|
49
|
+
* @immutable
|
|
50
|
+
* @minLength 1
|
|
51
|
+
* @maxLength 50
|
|
41
52
|
*/
|
|
42
53
|
namespace?: string | null;
|
|
43
54
|
/**
|
|
@@ -48,7 +59,10 @@ export interface PoolDefinition {
|
|
|
48
59
|
extendedFields?: ExtendedFields;
|
|
49
60
|
}
|
|
50
61
|
export interface Details {
|
|
51
|
-
/**
|
|
62
|
+
/**
|
|
63
|
+
* Array of benefits, each containing price and policy settings specific to that benefit within the pool.
|
|
64
|
+
* @maxSize 10
|
|
65
|
+
*/
|
|
52
66
|
benefits?: Benefit[];
|
|
53
67
|
/**
|
|
54
68
|
* Settings that control the initial credits and renewal cycle configurations of the benefit pool.
|
|
@@ -78,6 +92,7 @@ export interface Benefit {
|
|
|
78
92
|
* An unique identifier for a pool benefit.
|
|
79
93
|
*
|
|
80
94
|
* This key is consistent across the pool definition and all its associated benefit pools.
|
|
95
|
+
* @maxLength 64
|
|
81
96
|
*/
|
|
82
97
|
benefitKey?: string;
|
|
83
98
|
/**
|
|
@@ -86,6 +101,8 @@ export interface Benefit {
|
|
|
86
101
|
* This ID is returned when calling Create Item.
|
|
87
102
|
*
|
|
88
103
|
* It is used to link the specific benefit item to its corresponding location within the benefit pool, ensuring proper association between the item and the pool definition.
|
|
104
|
+
* @format GUID
|
|
105
|
+
* @immutable
|
|
89
106
|
* @readonly
|
|
90
107
|
*/
|
|
91
108
|
itemSetId?: string | null;
|
|
@@ -94,6 +111,7 @@ export interface Benefit {
|
|
|
94
111
|
* Represents the cost to redeem the benefit.
|
|
95
112
|
*
|
|
96
113
|
* Don't set a price if the `details.creditConfiguration` is empty. Since the benefits have an unlimited redemption limit, they can't have an associated price.
|
|
114
|
+
* @decimalValue options { gte:0, maxScale:4 }
|
|
97
115
|
*/
|
|
98
116
|
price?: string | null;
|
|
99
117
|
/**
|
|
@@ -104,11 +122,21 @@ export interface Benefit {
|
|
|
104
122
|
policyExpression?: PolicyExpression;
|
|
105
123
|
/** Additional info that was set by the benefit provider. */
|
|
106
124
|
additionalData?: Record<string, any> | null;
|
|
107
|
-
/**
|
|
125
|
+
/**
|
|
126
|
+
* ID of the app providing the benefit.
|
|
127
|
+
* @format GUID
|
|
128
|
+
* @immutable
|
|
129
|
+
*/
|
|
108
130
|
providerAppId?: string | null;
|
|
109
|
-
/**
|
|
131
|
+
/**
|
|
132
|
+
* Benefit display name.
|
|
133
|
+
* @maxLength 40
|
|
134
|
+
*/
|
|
110
135
|
displayName?: string | null;
|
|
111
|
-
/**
|
|
136
|
+
/**
|
|
137
|
+
* Benefit description.
|
|
138
|
+
* @maxLength 255
|
|
139
|
+
*/
|
|
112
140
|
description?: string | null;
|
|
113
141
|
}
|
|
114
142
|
export interface PolicyExpression extends PolicyExpressionExpressionOneOf {
|
|
@@ -154,11 +182,19 @@ export interface PolicyExpressionNot {
|
|
|
154
182
|
expression?: PolicyExpression;
|
|
155
183
|
}
|
|
156
184
|
export interface PolicyExpressionAnd {
|
|
157
|
-
/**
|
|
185
|
+
/**
|
|
186
|
+
* Specify policy terms where all policy conditions must be met. Must specify an object with an `expressions` property.
|
|
187
|
+
* @minSize 2
|
|
188
|
+
* @maxSize 10
|
|
189
|
+
*/
|
|
158
190
|
expressions?: PolicyExpression[];
|
|
159
191
|
}
|
|
160
192
|
export interface PolicyExpressionOr {
|
|
161
|
-
/**
|
|
193
|
+
/**
|
|
194
|
+
* Specify policy terms where at least one of the possible specified policy conditions is met. Must specify an object with an `expressions` property.
|
|
195
|
+
* @minSize 2
|
|
196
|
+
* @maxSize 10
|
|
197
|
+
*/
|
|
162
198
|
expressions?: PolicyExpression[];
|
|
163
199
|
}
|
|
164
200
|
export interface Policy extends PolicyPolicyOneOf {
|
|
@@ -194,13 +230,25 @@ export interface FixedIntervalPolicy {
|
|
|
194
230
|
fromWeekDay?: WeekDay;
|
|
195
231
|
/** Weekday that this interval ends at. If this field is set, then `fromWeekDay` must also be set. */
|
|
196
232
|
toWeekDay?: WeekDay;
|
|
197
|
-
/**
|
|
233
|
+
/**
|
|
234
|
+
* Hour that this interval starts from. If this field is set, then `toHour` must also be set.
|
|
235
|
+
* @max 23
|
|
236
|
+
*/
|
|
198
237
|
fromHour?: number | null;
|
|
199
|
-
/**
|
|
238
|
+
/**
|
|
239
|
+
* Hour that this interval ends at. If this field is set, then `fromHour` must also be set.
|
|
240
|
+
* @max 23
|
|
241
|
+
*/
|
|
200
242
|
toHour?: number | null;
|
|
201
|
-
/**
|
|
243
|
+
/**
|
|
244
|
+
* Minute that this interval starts from. If this field is set, then `toMinute` must also be set.
|
|
245
|
+
* @max 59
|
|
246
|
+
*/
|
|
202
247
|
fromMinute?: number | null;
|
|
203
|
-
/**
|
|
248
|
+
/**
|
|
249
|
+
* Minute that this interval ends at. If this field is set, then `fromMinute` must also be set.
|
|
250
|
+
* @max 59
|
|
251
|
+
*/
|
|
204
252
|
toMinute?: number | null;
|
|
205
253
|
}
|
|
206
254
|
export declare enum WeekDay {
|
|
@@ -252,19 +300,31 @@ export declare enum RateLimitedPolicyType {
|
|
|
252
300
|
}
|
|
253
301
|
/** Custom policy as implemented by the Entitlement Policy Provider */
|
|
254
302
|
export interface CustomPolicy {
|
|
255
|
-
/**
|
|
303
|
+
/**
|
|
304
|
+
* References a specific custom policy on the provider's system
|
|
305
|
+
* @format GUID
|
|
306
|
+
*/
|
|
256
307
|
_id?: string;
|
|
257
|
-
/**
|
|
308
|
+
/**
|
|
309
|
+
* Custom policy provider id
|
|
310
|
+
* @format GUID
|
|
311
|
+
*/
|
|
258
312
|
appId?: string | null;
|
|
259
313
|
/** Additional info for this custom policy. It's going to be passed to the policy provider during eligibility checks */
|
|
260
314
|
additionalData?: Record<string, any> | null;
|
|
261
315
|
}
|
|
262
316
|
export interface CreditConfiguration {
|
|
263
|
-
/**
|
|
317
|
+
/**
|
|
318
|
+
* The initial total amount of credits available in this benefit pool.
|
|
319
|
+
* @decimalValue options { gte:0, maxScale:4 }
|
|
320
|
+
*/
|
|
264
321
|
amount?: string;
|
|
265
322
|
/** Rollover configuration. */
|
|
266
323
|
rolloverConfiguration?: RolloverConfiguration;
|
|
267
|
-
/**
|
|
324
|
+
/**
|
|
325
|
+
* Display name of the unit.
|
|
326
|
+
* @maxLength 32
|
|
327
|
+
*/
|
|
268
328
|
unitDisplayName?: string | null;
|
|
269
329
|
}
|
|
270
330
|
export interface RolloverConfiguration {
|
|
@@ -274,6 +334,7 @@ export interface RolloverConfiguration {
|
|
|
274
334
|
* The maximum amount of credits that can be transferred to the next benefit renewal cycle.
|
|
275
335
|
*
|
|
276
336
|
* If current balance exceeds this cap, no credits will transfer into the next renewal cycle until the balance is within the allowable limit.
|
|
337
|
+
* @decimalValue options { gte:0, maxScale:4 }
|
|
277
338
|
*/
|
|
278
339
|
balanceCap?: string | null;
|
|
279
340
|
}
|
|
@@ -291,7 +352,10 @@ export interface ExtendedFields {
|
|
|
291
352
|
export interface PoolDefinitionAddedToProgramDefinition {
|
|
292
353
|
/** PoolDefinition that was added to the program definition */
|
|
293
354
|
poolDefinition?: PoolDefinition;
|
|
294
|
-
/**
|
|
355
|
+
/**
|
|
356
|
+
* Program Definition that the pool definition was added to
|
|
357
|
+
* @format GUID
|
|
358
|
+
*/
|
|
295
359
|
programDefinitionId?: string;
|
|
296
360
|
/** Type of cascade */
|
|
297
361
|
cascadeType?: Cascade;
|
|
@@ -321,11 +385,21 @@ export declare enum Cascade {
|
|
|
321
385
|
export interface PoolDefinitionRemovedFromProgramDefinition {
|
|
322
386
|
/** PoolDefinition that was removed from the program definition */
|
|
323
387
|
poolDefinition?: PoolDefinition;
|
|
324
|
-
/**
|
|
388
|
+
/**
|
|
389
|
+
* Program Definition that the pool definition was removed from
|
|
390
|
+
* @format GUID
|
|
391
|
+
*/
|
|
325
392
|
programDefinitionId?: string;
|
|
326
393
|
/** Type of cascade */
|
|
327
394
|
cascadeType?: Cascade;
|
|
328
395
|
}
|
|
396
|
+
/** This event is needed to support legacy benefit notification event. Should be only consumed in the proxy. */
|
|
397
|
+
export interface PoolDefinitionUpdatedProxySupport {
|
|
398
|
+
/** PoolDefinition after the update */
|
|
399
|
+
currentPoolDefinition?: PoolDefinition;
|
|
400
|
+
/** PoolDefinition before the update */
|
|
401
|
+
previousPoolDefinition?: PoolDefinition;
|
|
402
|
+
}
|
|
329
403
|
export interface CreatePoolDefinitionRequest {
|
|
330
404
|
/** Pool definition to create. */
|
|
331
405
|
poolDefinition: PoolDefinition;
|
|
@@ -341,7 +415,11 @@ export interface CreatePoolDefinitionResponse {
|
|
|
341
415
|
poolDefinition?: PoolDefinition;
|
|
342
416
|
}
|
|
343
417
|
export interface BulkCreatePoolDefinitionsRequest {
|
|
344
|
-
/**
|
|
418
|
+
/**
|
|
419
|
+
* Pool definitions to create.
|
|
420
|
+
* @minSize 1
|
|
421
|
+
* @maxSize 100
|
|
422
|
+
*/
|
|
345
423
|
poolDefinitions: PoolDefinition[];
|
|
346
424
|
/**
|
|
347
425
|
* Specifies the timing of updates to associated benefit pools.
|
|
@@ -361,6 +439,8 @@ export interface BulkCreatePoolDefinitionsResponse {
|
|
|
361
439
|
* List of results for each pool definition.
|
|
362
440
|
*
|
|
363
441
|
* Includes the pool definition and whether the creation was successful.
|
|
442
|
+
* @minSize 1
|
|
443
|
+
* @maxSize 100
|
|
364
444
|
*/
|
|
365
445
|
results?: BulkPoolDefinitionResult[];
|
|
366
446
|
/** Bulk action metadata. */
|
|
@@ -373,7 +453,10 @@ export interface BulkPoolDefinitionResult {
|
|
|
373
453
|
poolDefinition?: PoolDefinition;
|
|
374
454
|
}
|
|
375
455
|
export interface ItemMetadata {
|
|
376
|
-
/**
|
|
456
|
+
/**
|
|
457
|
+
* Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
|
|
458
|
+
* @format GUID
|
|
459
|
+
*/
|
|
377
460
|
_id?: string | null;
|
|
378
461
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
379
462
|
originalIndex?: number;
|
|
@@ -413,7 +496,11 @@ export interface UpdatePoolDefinitionResponse {
|
|
|
413
496
|
poolDefinition?: PoolDefinition;
|
|
414
497
|
}
|
|
415
498
|
export interface BulkUpdatePoolDefinitionsRequest {
|
|
416
|
-
/**
|
|
499
|
+
/**
|
|
500
|
+
* Pool definitions to update.
|
|
501
|
+
* @minSize 1
|
|
502
|
+
* @maxSize 100
|
|
503
|
+
*/
|
|
417
504
|
poolDefinitions?: MaskedPoolDefinition[];
|
|
418
505
|
/**
|
|
419
506
|
* Specifies the timing of updates to associated benefit pools.
|
|
@@ -439,13 +526,18 @@ export interface BulkUpdatePoolDefinitionsResponse {
|
|
|
439
526
|
* List of results for each pool definition.
|
|
440
527
|
*
|
|
441
528
|
* Includes the pool definition and whether the update was successful.
|
|
529
|
+
* @minSize 1
|
|
530
|
+
* @maxSize 100
|
|
442
531
|
*/
|
|
443
532
|
results?: BulkPoolDefinitionResult[];
|
|
444
533
|
/** Bulk action metadata. */
|
|
445
534
|
bulkActionMetadata?: BulkActionMetadata;
|
|
446
535
|
}
|
|
447
536
|
export interface DeletePoolDefinitionRequest {
|
|
448
|
-
/**
|
|
537
|
+
/**
|
|
538
|
+
* ID of the pool definition to delete.
|
|
539
|
+
* @format GUID
|
|
540
|
+
*/
|
|
449
541
|
poolDefinitionId: string;
|
|
450
542
|
/**
|
|
451
543
|
* Defines how the delete operation cascades to related pools.
|
|
@@ -457,7 +549,12 @@ export interface DeletePoolDefinitionRequest {
|
|
|
457
549
|
export interface DeletePoolDefinitionResponse {
|
|
458
550
|
}
|
|
459
551
|
export interface BulkDeletePoolDefinitionsRequest {
|
|
460
|
-
/**
|
|
552
|
+
/**
|
|
553
|
+
* ID of the pool definitions to delete.
|
|
554
|
+
* @minSize 1
|
|
555
|
+
* @maxSize 100
|
|
556
|
+
* @format GUID
|
|
557
|
+
*/
|
|
461
558
|
poolDefinitionIds: string[];
|
|
462
559
|
/**
|
|
463
560
|
* Specifies the timing of updates to associated benefit pools.
|
|
@@ -470,13 +567,18 @@ export interface BulkDeletePoolDefinitionsResponse {
|
|
|
470
567
|
* List of results for each pool definition.
|
|
471
568
|
*
|
|
472
569
|
* Includes the pool definition and whether the deletion was successful.
|
|
570
|
+
* @minSize 1
|
|
571
|
+
* @maxSize 100
|
|
473
572
|
*/
|
|
474
573
|
results?: BulkPoolDefinitionResult[];
|
|
475
574
|
/** Bulk action metadata. */
|
|
476
575
|
bulkActionMetadata?: BulkActionMetadata;
|
|
477
576
|
}
|
|
478
577
|
export interface GetPoolDefinitionRequest {
|
|
479
|
-
/**
|
|
578
|
+
/**
|
|
579
|
+
* ID of the pool definition to retrieve.
|
|
580
|
+
* @format GUID
|
|
581
|
+
*/
|
|
480
582
|
poolDefinitionId: string;
|
|
481
583
|
}
|
|
482
584
|
export interface GetPoolDefinitionResponse {
|
|
@@ -502,6 +604,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
502
604
|
/**
|
|
503
605
|
* Sort object in the following format:
|
|
504
606
|
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
607
|
+
* @maxSize 5
|
|
505
608
|
*/
|
|
506
609
|
sort?: Sorting[];
|
|
507
610
|
}
|
|
@@ -511,7 +614,10 @@ export interface CursorQueryPagingMethodOneOf {
|
|
|
511
614
|
cursorPaging?: CursorPaging;
|
|
512
615
|
}
|
|
513
616
|
export interface Sorting {
|
|
514
|
-
/**
|
|
617
|
+
/**
|
|
618
|
+
* Name of the field to sort by.
|
|
619
|
+
* @maxLength 512
|
|
620
|
+
*/
|
|
515
621
|
fieldName?: string;
|
|
516
622
|
/** Sort order. */
|
|
517
623
|
order?: SortOrder;
|
|
@@ -523,13 +629,17 @@ export declare enum SortOrder {
|
|
|
523
629
|
DESC = "DESC"
|
|
524
630
|
}
|
|
525
631
|
export interface CursorPaging {
|
|
526
|
-
/**
|
|
632
|
+
/**
|
|
633
|
+
* Maximum number of items to return in the results.
|
|
634
|
+
* @max 100
|
|
635
|
+
*/
|
|
527
636
|
limit?: number | null;
|
|
528
637
|
/**
|
|
529
638
|
* Pointer to the next or previous page in the list of results.
|
|
530
639
|
*
|
|
531
640
|
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
532
641
|
* Not relevant for the first request.
|
|
642
|
+
* @maxLength 16000
|
|
533
643
|
*/
|
|
534
644
|
cursor?: string | null;
|
|
535
645
|
}
|
|
@@ -553,15 +663,27 @@ export interface CursorPagingMetadata {
|
|
|
553
663
|
hasNext?: boolean | null;
|
|
554
664
|
}
|
|
555
665
|
export interface Cursors {
|
|
556
|
-
/**
|
|
666
|
+
/**
|
|
667
|
+
* Cursor string pointing to the next page in the list of results.
|
|
668
|
+
* @maxLength 16000
|
|
669
|
+
*/
|
|
557
670
|
next?: string | null;
|
|
558
|
-
/**
|
|
671
|
+
/**
|
|
672
|
+
* Cursor pointing to the previous page in the list of results.
|
|
673
|
+
* @maxLength 16000
|
|
674
|
+
*/
|
|
559
675
|
prev?: string | null;
|
|
560
676
|
}
|
|
561
677
|
export interface AddPoolDefinitionToProgramDefinitionRequest {
|
|
562
|
-
/**
|
|
678
|
+
/**
|
|
679
|
+
* Pool definition to assign to the program definition.
|
|
680
|
+
* @format GUID
|
|
681
|
+
*/
|
|
563
682
|
poolDefinitionId: string;
|
|
564
|
-
/**
|
|
683
|
+
/**
|
|
684
|
+
* Program definition that the pool definition is assigned to.
|
|
685
|
+
* @format GUID
|
|
686
|
+
*/
|
|
565
687
|
programDefinitionId: string;
|
|
566
688
|
/**
|
|
567
689
|
* Specifies the timing of updates to associated benefit pools.
|
|
@@ -574,9 +696,15 @@ export interface AddPoolDefinitionToProgramDefinitionResponse {
|
|
|
574
696
|
poolDefinition?: PoolDefinition;
|
|
575
697
|
}
|
|
576
698
|
export interface RemovePoolDefinitionFromProgramDefinitionRequest {
|
|
577
|
-
/**
|
|
699
|
+
/**
|
|
700
|
+
* ID of the pool definition to be removed from the program definition.
|
|
701
|
+
* @format GUID
|
|
702
|
+
*/
|
|
578
703
|
poolDefinitionId: string;
|
|
579
|
-
/**
|
|
704
|
+
/**
|
|
705
|
+
* ID of the program definition being removed from the pool definition.
|
|
706
|
+
* @format GUID
|
|
707
|
+
*/
|
|
580
708
|
programDefinitionId: string;
|
|
581
709
|
/**
|
|
582
710
|
* Specifies the timing of updates to associated benefit pools.
|
|
@@ -589,7 +717,10 @@ export interface RemovePoolDefinitionFromProgramDefinitionResponse {
|
|
|
589
717
|
poolDefinition?: PoolDefinition;
|
|
590
718
|
}
|
|
591
719
|
export interface FindPoolDefinitionsByProgramDefinitionRequest {
|
|
592
|
-
/**
|
|
720
|
+
/**
|
|
721
|
+
* ID of the program definition of which its assigned pool definitions are retrieved.
|
|
722
|
+
* @format GUID
|
|
723
|
+
*/
|
|
593
724
|
programDefinitionId: string;
|
|
594
725
|
/**
|
|
595
726
|
* Application sub-module that represents the source of the pool definition. Specified by the external developer.
|
|
@@ -597,6 +728,8 @@ export interface FindPoolDefinitionsByProgramDefinitionRequest {
|
|
|
597
728
|
* This namespace is used to organize and retrieve pool definitions and their associated benefit pools.
|
|
598
729
|
*
|
|
599
730
|
* It should match the namespace used in the program definitions.
|
|
731
|
+
* @minLength 1
|
|
732
|
+
* @maxLength 50
|
|
600
733
|
*/
|
|
601
734
|
namespace: string;
|
|
602
735
|
}
|
|
@@ -675,9 +808,15 @@ export interface ActionEvent {
|
|
|
675
808
|
body?: string;
|
|
676
809
|
}
|
|
677
810
|
export interface MessageEnvelope {
|
|
678
|
-
/**
|
|
811
|
+
/**
|
|
812
|
+
* App instance ID.
|
|
813
|
+
* @format GUID
|
|
814
|
+
*/
|
|
679
815
|
instanceId?: string | null;
|
|
680
|
-
/**
|
|
816
|
+
/**
|
|
817
|
+
* Event type.
|
|
818
|
+
* @maxLength 150
|
|
819
|
+
*/
|
|
681
820
|
eventType?: string;
|
|
682
821
|
/** The identification type and identity data. */
|
|
683
822
|
identity?: IdentificationData;
|
|
@@ -685,26 +824,50 @@ export interface MessageEnvelope {
|
|
|
685
824
|
data?: string;
|
|
686
825
|
}
|
|
687
826
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
688
|
-
/**
|
|
827
|
+
/**
|
|
828
|
+
* ID of a site visitor that has not logged in to the site.
|
|
829
|
+
* @format GUID
|
|
830
|
+
*/
|
|
689
831
|
anonymousVisitorId?: string;
|
|
690
|
-
/**
|
|
832
|
+
/**
|
|
833
|
+
* ID of a site visitor that has logged in to the site.
|
|
834
|
+
* @format GUID
|
|
835
|
+
*/
|
|
691
836
|
memberId?: string;
|
|
692
|
-
/**
|
|
837
|
+
/**
|
|
838
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
839
|
+
* @format GUID
|
|
840
|
+
*/
|
|
693
841
|
wixUserId?: string;
|
|
694
|
-
/**
|
|
842
|
+
/**
|
|
843
|
+
* ID of an app.
|
|
844
|
+
* @format GUID
|
|
845
|
+
*/
|
|
695
846
|
appId?: string;
|
|
696
847
|
/** @readonly */
|
|
697
848
|
identityType?: WebhookIdentityType;
|
|
698
849
|
}
|
|
699
850
|
/** @oneof */
|
|
700
851
|
export interface IdentificationDataIdOneOf {
|
|
701
|
-
/**
|
|
852
|
+
/**
|
|
853
|
+
* ID of a site visitor that has not logged in to the site.
|
|
854
|
+
* @format GUID
|
|
855
|
+
*/
|
|
702
856
|
anonymousVisitorId?: string;
|
|
703
|
-
/**
|
|
857
|
+
/**
|
|
858
|
+
* ID of a site visitor that has logged in to the site.
|
|
859
|
+
* @format GUID
|
|
860
|
+
*/
|
|
704
861
|
memberId?: string;
|
|
705
|
-
/**
|
|
862
|
+
/**
|
|
863
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
864
|
+
* @format GUID
|
|
865
|
+
*/
|
|
706
866
|
wixUserId?: string;
|
|
707
|
-
/**
|
|
867
|
+
/**
|
|
868
|
+
* ID of an app.
|
|
869
|
+
* @format GUID
|
|
870
|
+
*/
|
|
708
871
|
appId?: string;
|
|
709
872
|
}
|
|
710
873
|
export declare enum WebhookIdentityType {
|
|
@@ -906,6 +1069,7 @@ export declare function updatePoolDefinition(_id: string | null, poolDefinition:
|
|
|
906
1069
|
export interface UpdatePoolDefinition {
|
|
907
1070
|
/**
|
|
908
1071
|
* Pool definition ID.
|
|
1072
|
+
* @format GUID
|
|
909
1073
|
* @readonly
|
|
910
1074
|
*/
|
|
911
1075
|
_id?: string | null;
|
|
@@ -927,9 +1091,16 @@ export interface UpdatePoolDefinition {
|
|
|
927
1091
|
* @readonly
|
|
928
1092
|
*/
|
|
929
1093
|
_updatedDate?: Date | null;
|
|
930
|
-
/**
|
|
1094
|
+
/**
|
|
1095
|
+
* Name of the pool definition.
|
|
1096
|
+
* @maxLength 128
|
|
1097
|
+
*/
|
|
931
1098
|
displayName?: string;
|
|
932
|
-
/**
|
|
1099
|
+
/**
|
|
1100
|
+
* List of program definitions that are associated with this pool definition.
|
|
1101
|
+
* @format GUID
|
|
1102
|
+
* @maxSize 100
|
|
1103
|
+
*/
|
|
933
1104
|
programDefinitionIds?: string[];
|
|
934
1105
|
/**
|
|
935
1106
|
* Benefit pool information.
|
|
@@ -943,6 +1114,9 @@ export interface UpdatePoolDefinition {
|
|
|
943
1114
|
* This namespace is used to organize and retrieve pool definitions and their associated benefit pools.
|
|
944
1115
|
*
|
|
945
1116
|
* It should match the namespace used in the program definitions.
|
|
1117
|
+
* @immutable
|
|
1118
|
+
* @minLength 1
|
|
1119
|
+
* @maxLength 50
|
|
946
1120
|
*/
|
|
947
1121
|
namespace?: string | null;
|
|
948
1122
|
/**
|
|
@@ -975,7 +1149,11 @@ export interface UpdatePoolDefinitionOptions {
|
|
|
975
1149
|
*/
|
|
976
1150
|
export declare function bulkUpdatePoolDefinitions(options?: BulkUpdatePoolDefinitionsOptions): Promise<BulkUpdatePoolDefinitionsResponse & BulkUpdatePoolDefinitionsResponseNonNullableFields>;
|
|
977
1151
|
export interface BulkUpdatePoolDefinitionsOptions {
|
|
978
|
-
/**
|
|
1152
|
+
/**
|
|
1153
|
+
* Pool definitions to update.
|
|
1154
|
+
* @minSize 1
|
|
1155
|
+
* @maxSize 100
|
|
1156
|
+
*/
|
|
979
1157
|
poolDefinitions?: MaskedPoolDefinition[];
|
|
980
1158
|
/**
|
|
981
1159
|
* Specifies the timing of updates to associated benefit pools.
|
|
@@ -1042,6 +1220,8 @@ export interface BulkDeletePoolDefinitionsOptions {
|
|
|
1042
1220
|
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
1043
1221
|
* @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
|
|
1044
1222
|
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
|
|
1223
|
+
* @permissionScope Manage Events
|
|
1224
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1045
1225
|
* @applicableIdentity APP
|
|
1046
1226
|
* @applicableIdentity VISITOR
|
|
1047
1227
|
* @returns Retrieved pool definition.
|
|
@@ -1064,6 +1244,8 @@ export declare function getPoolDefinition(poolDefinitionId: string): Promise<Poo
|
|
|
1064
1244
|
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
1065
1245
|
* @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
|
|
1066
1246
|
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
|
|
1247
|
+
* @permissionScope Manage Events
|
|
1248
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1067
1249
|
* @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_READ
|
|
1068
1250
|
* @applicableIdentity APP
|
|
1069
1251
|
* @applicableIdentity VISITOR
|
|
@@ -1171,7 +1353,10 @@ export interface PoolDefinitionsQueryBuilder {
|
|
|
1171
1353
|
*/
|
|
1172
1354
|
export declare function addPoolDefinitionToProgramDefinition(poolDefinitionId: string, options: AddPoolDefinitionToProgramDefinitionOptions): Promise<AddPoolDefinitionToProgramDefinitionResponse & AddPoolDefinitionToProgramDefinitionResponseNonNullableFields>;
|
|
1173
1355
|
export interface AddPoolDefinitionToProgramDefinitionOptions {
|
|
1174
|
-
/**
|
|
1356
|
+
/**
|
|
1357
|
+
* Program definition that the pool definition is assigned to.
|
|
1358
|
+
* @format GUID
|
|
1359
|
+
*/
|
|
1175
1360
|
programDefinitionId: string;
|
|
1176
1361
|
/**
|
|
1177
1362
|
* Specifies the timing of updates to associated benefit pools.
|
|
@@ -1200,7 +1385,10 @@ export interface AddPoolDefinitionToProgramDefinitionOptions {
|
|
|
1200
1385
|
*/
|
|
1201
1386
|
export declare function removePoolDefinitionFromProgramDefinition(poolDefinitionId: string, options: RemovePoolDefinitionFromProgramDefinitionOptions): Promise<RemovePoolDefinitionFromProgramDefinitionResponse & RemovePoolDefinitionFromProgramDefinitionResponseNonNullableFields>;
|
|
1202
1387
|
export interface RemovePoolDefinitionFromProgramDefinitionOptions {
|
|
1203
|
-
/**
|
|
1388
|
+
/**
|
|
1389
|
+
* ID of the program definition being removed from the pool definition.
|
|
1390
|
+
* @format GUID
|
|
1391
|
+
*/
|
|
1204
1392
|
programDefinitionId: string;
|
|
1205
1393
|
/**
|
|
1206
1394
|
* Specifies the timing of updates to associated benefit pools.
|
|
@@ -1223,6 +1411,8 @@ export interface RemovePoolDefinitionFromProgramDefinitionOptions {
|
|
|
1223
1411
|
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
1224
1412
|
* @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
|
|
1225
1413
|
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
|
|
1414
|
+
* @permissionScope Manage Events
|
|
1415
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1226
1416
|
* @applicableIdentity APP
|
|
1227
1417
|
* @applicableIdentity VISITOR
|
|
1228
1418
|
* @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.FindPoolDefinitionsByProgramDefinition
|
|
@@ -1235,6 +1425,8 @@ export interface FindPoolDefinitionsByProgramDefinitionOptions {
|
|
|
1235
1425
|
* This namespace is used to organize and retrieve pool definitions and their associated benefit pools.
|
|
1236
1426
|
*
|
|
1237
1427
|
* It should match the namespace used in the program definitions.
|
|
1428
|
+
* @minLength 1
|
|
1429
|
+
* @maxLength 50
|
|
1238
1430
|
*/
|
|
1239
1431
|
namespace: string;
|
|
1240
1432
|
}
|
package/build/internal/es/src/benefit-programs-v1-pool-definition-pool-definitions.universal.js
CHANGED
|
@@ -367,6 +367,8 @@ export async function bulkDeletePoolDefinitions(poolDefinitionIds, options) {
|
|
|
367
367
|
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
368
368
|
* @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
|
|
369
369
|
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
|
|
370
|
+
* @permissionScope Manage Events
|
|
371
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
370
372
|
* @applicableIdentity APP
|
|
371
373
|
* @applicableIdentity VISITOR
|
|
372
374
|
* @returns Retrieved pool definition.
|
|
@@ -412,6 +414,8 @@ export async function getPoolDefinition(poolDefinitionId) {
|
|
|
412
414
|
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
413
415
|
* @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
|
|
414
416
|
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
|
|
417
|
+
* @permissionScope Manage Events
|
|
418
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
415
419
|
* @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_READ
|
|
416
420
|
* @applicableIdentity APP
|
|
417
421
|
* @applicableIdentity VISITOR
|
|
@@ -569,6 +573,8 @@ export async function removePoolDefinitionFromProgramDefinition(poolDefinitionId
|
|
|
569
573
|
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
570
574
|
* @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
|
|
571
575
|
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
|
|
576
|
+
* @permissionScope Manage Events
|
|
577
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
572
578
|
* @applicableIdentity APP
|
|
573
579
|
* @applicableIdentity VISITOR
|
|
574
580
|
* @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.FindPoolDefinitionsByProgramDefinition
|