@wix/auto_sdk_benefit-programs_pools 1.0.8 → 1.0.10

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 (134) hide show
  1. package/build/{internal/cjs/src/benefit-programs-v1-pool-pools.universal.d.ts → benefit-programs-v1-pool-pools.universal-C7Pd1Zor.d.mts} +164 -489
  2. package/build/{cjs/src/benefit-programs-v1-pool-pools.universal.d.ts → benefit-programs-v1-pool-pools.universal-C7Pd1Zor.d.ts} +164 -489
  3. package/build/index.d.mts +105 -0
  4. package/build/index.d.ts +105 -0
  5. package/build/index.js +901 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +857 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/internal/{es/src/benefit-programs-v1-pool-pools.universal.d.ts → benefit-programs-v1-pool-pools.universal-C7Pd1Zor.d.mts} +164 -489
  10. package/build/{es/src/benefit-programs-v1-pool-pools.universal.d.ts → internal/benefit-programs-v1-pool-pools.universal-C7Pd1Zor.d.ts} +164 -489
  11. package/build/internal/index.d.mts +105 -0
  12. package/build/internal/index.d.ts +105 -0
  13. package/build/internal/index.js +901 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +857 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +776 -0
  18. package/build/internal/meta.d.ts +776 -0
  19. package/build/internal/meta.js +579 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +545 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +776 -0
  24. package/build/meta.d.ts +776 -0
  25. package/build/meta.js +579 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +545 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +13 -12
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/benefit-programs-v1-pool-pools.context.d.ts +0 -12
  40. package/build/cjs/src/benefit-programs-v1-pool-pools.context.js +0 -28
  41. package/build/cjs/src/benefit-programs-v1-pool-pools.context.js.map +0 -1
  42. package/build/cjs/src/benefit-programs-v1-pool-pools.http.d.ts +0 -54
  43. package/build/cjs/src/benefit-programs-v1-pool-pools.http.js +0 -444
  44. package/build/cjs/src/benefit-programs-v1-pool-pools.http.js.map +0 -1
  45. package/build/cjs/src/benefit-programs-v1-pool-pools.meta.d.ts +0 -24
  46. package/build/cjs/src/benefit-programs-v1-pool-pools.meta.js +0 -180
  47. package/build/cjs/src/benefit-programs-v1-pool-pools.meta.js.map +0 -1
  48. package/build/cjs/src/benefit-programs-v1-pool-pools.public.d.ts +0 -94
  49. package/build/cjs/src/benefit-programs-v1-pool-pools.public.js +0 -68
  50. package/build/cjs/src/benefit-programs-v1-pool-pools.public.js.map +0 -1
  51. package/build/cjs/src/benefit-programs-v1-pool-pools.types.d.ts +0 -1746
  52. package/build/cjs/src/benefit-programs-v1-pool-pools.types.js +0 -140
  53. package/build/cjs/src/benefit-programs-v1-pool-pools.types.js.map +0 -1
  54. package/build/cjs/src/benefit-programs-v1-pool-pools.universal.js +0 -585
  55. package/build/cjs/src/benefit-programs-v1-pool-pools.universal.js.map +0 -1
  56. package/build/es/index.d.ts +0 -1
  57. package/build/es/index.js +0 -2
  58. package/build/es/index.js.map +0 -1
  59. package/build/es/index.typings.d.ts +0 -1
  60. package/build/es/index.typings.js +0 -2
  61. package/build/es/index.typings.js.map +0 -1
  62. package/build/es/meta.d.ts +0 -1
  63. package/build/es/meta.js +0 -2
  64. package/build/es/meta.js.map +0 -1
  65. package/build/es/package.json +0 -3
  66. package/build/es/src/benefit-programs-v1-pool-pools.context.d.ts +0 -12
  67. package/build/es/src/benefit-programs-v1-pool-pools.context.js +0 -12
  68. package/build/es/src/benefit-programs-v1-pool-pools.context.js.map +0 -1
  69. package/build/es/src/benefit-programs-v1-pool-pools.http.d.ts +0 -54
  70. package/build/es/src/benefit-programs-v1-pool-pools.http.js +0 -433
  71. package/build/es/src/benefit-programs-v1-pool-pools.http.js.map +0 -1
  72. package/build/es/src/benefit-programs-v1-pool-pools.meta.d.ts +0 -24
  73. package/build/es/src/benefit-programs-v1-pool-pools.meta.js +0 -146
  74. package/build/es/src/benefit-programs-v1-pool-pools.meta.js.map +0 -1
  75. package/build/es/src/benefit-programs-v1-pool-pools.public.d.ts +0 -94
  76. package/build/es/src/benefit-programs-v1-pool-pools.public.js +0 -44
  77. package/build/es/src/benefit-programs-v1-pool-pools.public.js.map +0 -1
  78. package/build/es/src/benefit-programs-v1-pool-pools.types.d.ts +0 -1746
  79. package/build/es/src/benefit-programs-v1-pool-pools.types.js +0 -137
  80. package/build/es/src/benefit-programs-v1-pool-pools.types.js.map +0 -1
  81. package/build/es/src/benefit-programs-v1-pool-pools.universal.js +0 -551
  82. package/build/es/src/benefit-programs-v1-pool-pools.universal.js.map +0 -1
  83. package/build/internal/cjs/index.d.ts +0 -1
  84. package/build/internal/cjs/index.js +0 -18
  85. package/build/internal/cjs/index.js.map +0 -1
  86. package/build/internal/cjs/index.typings.d.ts +0 -1
  87. package/build/internal/cjs/index.typings.js +0 -18
  88. package/build/internal/cjs/index.typings.js.map +0 -1
  89. package/build/internal/cjs/meta.d.ts +0 -1
  90. package/build/internal/cjs/meta.js +0 -18
  91. package/build/internal/cjs/meta.js.map +0 -1
  92. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.context.d.ts +0 -12
  93. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.context.js +0 -28
  94. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.context.js.map +0 -1
  95. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.http.d.ts +0 -54
  96. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.http.js +0 -444
  97. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.http.js.map +0 -1
  98. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.meta.d.ts +0 -24
  99. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.meta.js +0 -180
  100. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.meta.js.map +0 -1
  101. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.public.d.ts +0 -94
  102. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.public.js +0 -68
  103. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.public.js.map +0 -1
  104. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.types.d.ts +0 -1746
  105. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.types.js +0 -140
  106. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.types.js.map +0 -1
  107. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.universal.js +0 -585
  108. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.universal.js.map +0 -1
  109. package/build/internal/es/index.d.ts +0 -1
  110. package/build/internal/es/index.js +0 -2
  111. package/build/internal/es/index.js.map +0 -1
  112. package/build/internal/es/index.typings.d.ts +0 -1
  113. package/build/internal/es/index.typings.js +0 -2
  114. package/build/internal/es/index.typings.js.map +0 -1
  115. package/build/internal/es/meta.d.ts +0 -1
  116. package/build/internal/es/meta.js +0 -2
  117. package/build/internal/es/meta.js.map +0 -1
  118. package/build/internal/es/src/benefit-programs-v1-pool-pools.context.d.ts +0 -12
  119. package/build/internal/es/src/benefit-programs-v1-pool-pools.context.js +0 -12
  120. package/build/internal/es/src/benefit-programs-v1-pool-pools.context.js.map +0 -1
  121. package/build/internal/es/src/benefit-programs-v1-pool-pools.http.d.ts +0 -54
  122. package/build/internal/es/src/benefit-programs-v1-pool-pools.http.js +0 -433
  123. package/build/internal/es/src/benefit-programs-v1-pool-pools.http.js.map +0 -1
  124. package/build/internal/es/src/benefit-programs-v1-pool-pools.meta.d.ts +0 -24
  125. package/build/internal/es/src/benefit-programs-v1-pool-pools.meta.js +0 -146
  126. package/build/internal/es/src/benefit-programs-v1-pool-pools.meta.js.map +0 -1
  127. package/build/internal/es/src/benefit-programs-v1-pool-pools.public.d.ts +0 -94
  128. package/build/internal/es/src/benefit-programs-v1-pool-pools.public.js +0 -44
  129. package/build/internal/es/src/benefit-programs-v1-pool-pools.public.js.map +0 -1
  130. package/build/internal/es/src/benefit-programs-v1-pool-pools.types.d.ts +0 -1746
  131. package/build/internal/es/src/benefit-programs-v1-pool-pools.types.js +0 -137
  132. package/build/internal/es/src/benefit-programs-v1-pool-pools.types.js.map +0 -1
  133. package/build/internal/es/src/benefit-programs-v1-pool-pools.universal.js +0 -551
  134. package/build/internal/es/src/benefit-programs-v1-pool-pools.universal.js.map +0 -1
@@ -1,4 +1,4 @@
1
- export interface Pool {
1
+ interface Pool {
2
2
  /**
3
3
  * Pool ID.
4
4
  * @format GUID
@@ -66,7 +66,7 @@ export interface Pool {
66
66
  */
67
67
  displayName?: string;
68
68
  /**
69
- * Namespace for your app or site's benefit programs.
69
+ * Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
70
70
  * @readonly
71
71
  * @immutable
72
72
  * @minLength 1
@@ -100,7 +100,7 @@ export interface Pool {
100
100
  */
101
101
  renewalCount?: number | null;
102
102
  }
103
- export declare enum PoolStatus {
103
+ declare enum PoolStatus {
104
104
  /** Undefined pool status. */
105
105
  UNDEFINED = "UNDEFINED",
106
106
  /** Pool is active. */
@@ -109,12 +109,12 @@ export declare enum PoolStatus {
109
109
  PAUSED = "PAUSED",
110
110
  /** Pool is ended. It can't be resumed. */
111
111
  ENDED = "ENDED",
112
- /** Pool is provisioning. This status will be true for a negligible amount of time. */
112
+ /** Pool provisioning is in progress. This status exists for a short time during processing. */
113
113
  PROVISIONING = "PROVISIONING",
114
- /** Pool is renewing. This status will be true for a negligible amount of time. */
114
+ /** Pool renewing is in progress. This status exists for a short time during processing. */
115
115
  RENEWING = "RENEWING"
116
116
  }
117
- export interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
117
+ interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
118
118
  /**
119
119
  * ID of a site visitor that hasn't logged in to the site.
120
120
  * @format GUID
@@ -132,7 +132,7 @@ export interface CommonIdentificationData extends CommonIdentificationDataIdOneO
132
132
  wixUserId?: string;
133
133
  }
134
134
  /** @oneof */
135
- export interface CommonIdentificationDataIdOneOf {
135
+ interface CommonIdentificationDataIdOneOf {
136
136
  /**
137
137
  * ID of a site visitor that hasn't logged in to the site.
138
138
  * @format GUID
@@ -149,7 +149,7 @@ export interface CommonIdentificationDataIdOneOf {
149
149
  */
150
150
  wixUserId?: string;
151
151
  }
152
- export declare enum IdentityType {
152
+ declare enum IdentityType {
153
153
  /** Unknown type. This value is not used. */
154
154
  UNKNOWN = "UNKNOWN",
155
155
  /** A site visitor who has not logged in. */
@@ -159,7 +159,7 @@ export declare enum IdentityType {
159
159
  /** A Wix account holder, such as a site owner or contributor. */
160
160
  WIX_USER = "WIX_USER"
161
161
  }
162
- export interface Details {
162
+ interface Details {
163
163
  /**
164
164
  * List of benefits.
165
165
  * @maxSize 10
@@ -174,7 +174,7 @@ export interface Details {
174
174
  /** Additional information relating to this object. */
175
175
  additionalData?: Record<string, any> | null;
176
176
  }
177
- export interface Benefit {
177
+ interface Benefit {
178
178
  /**
179
179
  * Unique identifier for this benefit.
180
180
  *
@@ -213,7 +213,7 @@ export interface Benefit {
213
213
  */
214
214
  description?: string | null;
215
215
  }
216
- export interface PolicyExpression extends PolicyExpressionExpressionOneOf {
216
+ interface PolicyExpression extends PolicyExpressionExpressionOneOf {
217
217
  /** Benefits can be redeemed if the expression in this object is not fulfilled. */
218
218
  operatorNotOptions?: PolicyExpressionNot;
219
219
  /** Benefits can be redeemed if all the expression in this object's array are fulfilled. */
@@ -226,7 +226,7 @@ export interface PolicyExpression extends PolicyExpressionExpressionOneOf {
226
226
  type?: PolicyExpressionType;
227
227
  }
228
228
  /** @oneof */
229
- export interface PolicyExpressionExpressionOneOf {
229
+ interface PolicyExpressionExpressionOneOf {
230
230
  /** Benefits can be redeemed if the expression in this object is not fulfilled. */
231
231
  operatorNotOptions?: PolicyExpressionNot;
232
232
  /** Benefits can be redeemed if all the expression in this object's array are fulfilled. */
@@ -236,7 +236,7 @@ export interface PolicyExpressionExpressionOneOf {
236
236
  /** Defines when benefits can be redeemed or how many benefits can be redeemed in a specific time period. */
237
237
  policyOptions?: Policy;
238
238
  }
239
- export declare enum PolicyExpressionType {
239
+ declare enum PolicyExpressionType {
240
240
  UNKNOWN = "UNKNOWN",
241
241
  /** Use with `operatorNotOptions`. */
242
242
  OPERATOR_NOT = "OPERATOR_NOT",
@@ -247,11 +247,11 @@ export declare enum PolicyExpressionType {
247
247
  /** Use with `policyOptions`. */
248
248
  POLICY = "POLICY"
249
249
  }
250
- export interface PolicyExpressionNot {
250
+ interface PolicyExpressionNot {
251
251
  /** Policy expression. If this expression is not fulfilled, benefits can be redeemed. */
252
252
  expression?: PolicyExpression;
253
253
  }
254
- export interface PolicyExpressionAnd {
254
+ interface PolicyExpressionAnd {
255
255
  /**
256
256
  * Array of policy expressions. If all expressions are fulfilled, benefits can be redeemed.
257
257
  * @minSize 2
@@ -259,7 +259,7 @@ export interface PolicyExpressionAnd {
259
259
  */
260
260
  expressions?: PolicyExpression[];
261
261
  }
262
- export interface PolicyExpressionOr {
262
+ interface PolicyExpressionOr {
263
263
  /**
264
264
  * Array of policy expressions. If at least one expression is fulfilled, benefits can be redeemed.
265
265
  * @minSize 2
@@ -267,7 +267,7 @@ export interface PolicyExpressionOr {
267
267
  */
268
268
  expressions?: PolicyExpression[];
269
269
  }
270
- export interface Policy extends PolicyPolicyOneOf {
270
+ interface Policy extends PolicyPolicyOneOf {
271
271
  /**
272
272
  * Defines an interval during which the policy expression is fulfilled.
273
273
  *
@@ -282,7 +282,7 @@ export interface Policy extends PolicyPolicyOneOf {
282
282
  type?: Type;
283
283
  }
284
284
  /** @oneof */
285
- export interface PolicyPolicyOneOf {
285
+ interface PolicyPolicyOneOf {
286
286
  /**
287
287
  * Defines an interval during which the policy expression is fulfilled.
288
288
  *
@@ -294,7 +294,7 @@ export interface PolicyPolicyOneOf {
294
294
  /** Custom policy defined by a different app. */
295
295
  customOptions?: CustomPolicy;
296
296
  }
297
- export declare enum Type {
297
+ declare enum Type {
298
298
  /** Unknown policy type. */
299
299
  UNKNOWN = "UNKNOWN",
300
300
  /** Use with `fixedIntervalOptions`. */
@@ -304,7 +304,7 @@ export declare enum Type {
304
304
  /** Use with `customOptions`. */
305
305
  CUSTOM = "CUSTOM"
306
306
  }
307
- export interface FixedIntervalPolicy {
307
+ interface FixedIntervalPolicy {
308
308
  /** Weekday that this interval starts from. If this field is defined, then `toWeekDay` is required. */
309
309
  fromWeekDay?: WeekDay;
310
310
  /** Weekday that this interval ends at. If this field is defined, then `fromWeekDay` is required. */
@@ -330,7 +330,7 @@ export interface FixedIntervalPolicy {
330
330
  */
331
331
  toMinute?: number | null;
332
332
  }
333
- export declare enum WeekDay {
333
+ declare enum WeekDay {
334
334
  /** Unknown weekday. */
335
335
  UNKNOWN = "UNKNOWN",
336
336
  /** Monday. */
@@ -348,7 +348,7 @@ export declare enum WeekDay {
348
348
  /** Sunday. */
349
349
  SUNDAY = "SUNDAY"
350
350
  }
351
- export interface RateLimitedPolicy extends RateLimitedPolicyPeriodOneOf {
351
+ interface RateLimitedPolicy extends RateLimitedPolicyPeriodOneOf {
352
352
  /** Fixed interval used to limit benefit redemption. */
353
353
  fixedIntervalOptions?: FixedIntervalPolicy;
354
354
  /** Maximum number of times a benefit can be redeemed per specified time period. */
@@ -357,11 +357,11 @@ export interface RateLimitedPolicy extends RateLimitedPolicyPeriodOneOf {
357
357
  type?: RateLimitedPolicyType;
358
358
  }
359
359
  /** @oneof */
360
- export interface RateLimitedPolicyPeriodOneOf {
360
+ interface RateLimitedPolicyPeriodOneOf {
361
361
  /** Fixed interval used to limit benefit redemption. */
362
362
  fixedIntervalOptions?: FixedIntervalPolicy;
363
363
  }
364
- export declare enum RateLimitedPolicyType {
364
+ declare enum RateLimitedPolicyType {
365
365
  /** Unknown rate limit method. */
366
366
  UNKNOWN = "UNKNOWN",
367
367
  /** Time period is defined using `fixedIntervalOptions`. */
@@ -370,7 +370,7 @@ export declare enum RateLimitedPolicyType {
370
370
  PER_CYCLE = "PER_CYCLE"
371
371
  }
372
372
  /** Custom policy as implemented by the Entitlement Policy Provider */
373
- export interface CustomPolicy {
373
+ interface CustomPolicy {
374
374
  /**
375
375
  * Policy ID.
376
376
  * @format GUID
@@ -384,7 +384,7 @@ export interface CustomPolicy {
384
384
  /** Additional information for this custom policy. */
385
385
  additionalData?: Record<string, any> | null;
386
386
  }
387
- export interface CreditConfiguration {
387
+ interface CreditConfiguration {
388
388
  /**
389
389
  * Initial available amount for associated balances.
390
390
  * @decimalValue options { gte:0, maxScale:4 }
@@ -398,16 +398,16 @@ export interface CreditConfiguration {
398
398
  */
399
399
  unitDisplayName?: string | null;
400
400
  }
401
- export interface RolloverConfiguration {
402
- /** Whether unused credits rollover to a new cycle when a program renews. */
401
+ interface RolloverConfiguration {
402
+ /** Whether unused credits roll over to a new cycle when a program renews. */
403
403
  enabled?: boolean | null;
404
404
  /**
405
- * Maximum amount of credits that can rollover to the next cycle when a program renews.
405
+ * Maximum number of credits that can roll over to the next cycle when a program renews.
406
406
  * @decimalValue options { gte:0, maxScale:4 }
407
407
  */
408
408
  balanceCap?: string | null;
409
409
  }
410
- export interface ExtendedFields {
410
+ interface ExtendedFields {
411
411
  /**
412
412
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
413
413
  * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -418,7 +418,7 @@ export interface ExtendedFields {
418
418
  */
419
419
  namespaces?: Record<string, Record<string, any>>;
420
420
  }
421
- export interface ProgramDefinitionInfo {
421
+ interface ProgramDefinitionInfo {
422
422
  /**
423
423
  * Program definition ID.
424
424
  * @format GUID
@@ -432,7 +432,7 @@ export interface ProgramDefinitionInfo {
432
432
  */
433
433
  externalId?: string | null;
434
434
  }
435
- export interface PoolProgramInfo {
435
+ interface PoolProgramInfo {
436
436
  /**
437
437
  * Program ID.
438
438
  * @format GUID
@@ -446,7 +446,7 @@ export interface PoolProgramInfo {
446
446
  */
447
447
  externalId?: string | null;
448
448
  }
449
- export declare enum PoolOrigin {
449
+ declare enum PoolOrigin {
450
450
  /** Unknown pool origin. */
451
451
  UNKNOWN = "UNKNOWN",
452
452
  /** Benefit pool created by a program provision. */
@@ -454,21 +454,21 @@ export declare enum PoolOrigin {
454
454
  /** Benefit pool was created when pool definition was added to program definition. */
455
455
  CASCADE = "CASCADE"
456
456
  }
457
- export interface PoolProvisioned {
457
+ interface PoolProvisioned {
458
458
  /** Pool which has been provisioned */
459
459
  pool?: Pool;
460
460
  }
461
- export interface PoolRenewed {
461
+ interface PoolRenewed {
462
462
  /** Pool which has been granted */
463
463
  pool?: Pool;
464
464
  }
465
- export interface BenefitRedeemed {
465
+ interface BenefitRedeemed {
466
466
  /** Pool which has been redeemed */
467
467
  pool?: Pool;
468
468
  /** Details of the redemption */
469
469
  redemptionDetails?: RedemptionDetails;
470
470
  }
471
- export interface RedemptionDetails {
471
+ interface RedemptionDetails {
472
472
  /**
473
473
  * Id of the redemption transaction
474
474
  * @format GUID
@@ -496,7 +496,7 @@ export interface RedemptionDetails {
496
496
  /** Beneficiary of the entitlement */
497
497
  beneficiary?: CommonIdentificationData;
498
498
  }
499
- export interface ItemReference {
499
+ interface ItemReference {
500
500
  /**
501
501
  * External ID of the item.
502
502
  * @format GUID
@@ -513,25 +513,25 @@ export interface ItemReference {
513
513
  */
514
514
  providerAppId?: string;
515
515
  }
516
- export interface PoolPaused {
516
+ interface PoolPaused {
517
517
  /** Pool which has been paused */
518
518
  pool?: Pool;
519
519
  }
520
- export interface PoolResumed {
520
+ interface PoolResumed {
521
521
  /** Pool which has been resumed */
522
522
  pool?: Pool;
523
523
  }
524
- export interface PoolEnded {
524
+ interface PoolEnded {
525
525
  /** Pool which has been ended */
526
526
  pool?: Pool;
527
527
  }
528
- export interface BenefitReserved {
528
+ interface BenefitReserved {
529
529
  /** Pool which was used to perform this transaction */
530
530
  pool?: Pool;
531
531
  /** Details of the redemption */
532
532
  redemptionDetails?: RedemptionDetails;
533
533
  }
534
- export interface BenefitReservationCanceled {
534
+ interface BenefitReservationCanceled {
535
535
  /** Pool which was used to perform this transaction */
536
536
  pool?: Pool;
537
537
  /**
@@ -540,7 +540,7 @@ export interface BenefitReservationCanceled {
540
540
  */
541
541
  transactionId?: string;
542
542
  }
543
- export interface BenefitReservationReleased {
543
+ interface BenefitReservationReleased {
544
544
  /** Pool which was used to perform this transaction */
545
545
  pool?: Pool;
546
546
  /**
@@ -549,7 +549,7 @@ export interface BenefitReservationReleased {
549
549
  */
550
550
  transactionId?: string;
551
551
  }
552
- export interface PoolProvisionJobFinished {
552
+ interface PoolProvisionJobFinished {
553
553
  /**
554
554
  * Program id
555
555
  * @format GUID
@@ -560,7 +560,7 @@ export interface PoolProvisionJobFinished {
560
560
  /** Origin of the pool */
561
561
  origin?: PoolOrigin;
562
562
  }
563
- export interface PoolStatusUpdateJobFinished extends PoolStatusUpdateJobFinishedContextOneOf {
563
+ interface PoolStatusUpdateJobFinished extends PoolStatusUpdateJobFinishedContextOneOf {
564
564
  /** The id of the pool definition that is being updated */
565
565
  poolDefinitionAndProgramDefinition?: PoolDefinitionAndProgramDefinition;
566
566
  /** Update the status of all pools in the program */
@@ -571,13 +571,13 @@ export interface PoolStatusUpdateJobFinished extends PoolStatusUpdateJobFinished
571
571
  processedItemCount?: number;
572
572
  }
573
573
  /** @oneof */
574
- export interface PoolStatusUpdateJobFinishedContextOneOf {
574
+ interface PoolStatusUpdateJobFinishedContextOneOf {
575
575
  /** The id of the pool definition that is being updated */
576
576
  poolDefinitionAndProgramDefinition?: PoolDefinitionAndProgramDefinition;
577
577
  /** Update the status of all pools in the program */
578
578
  programInfo?: ProgramInfo;
579
579
  }
580
- export interface PoolDefinitionAndProgramDefinition {
580
+ interface PoolDefinitionAndProgramDefinition {
581
581
  /**
582
582
  * The id of the pool definition that is being updated
583
583
  * @format GUID
@@ -590,7 +590,7 @@ export interface PoolDefinitionAndProgramDefinition {
590
590
  */
591
591
  programDefinitionId?: string | null;
592
592
  }
593
- export interface ProgramInfo {
593
+ interface ProgramInfo {
594
594
  /**
595
595
  * The key of the program that is being updated
596
596
  * @format GUID
@@ -599,47 +599,47 @@ export interface ProgramInfo {
599
599
  /** Additional data that was provided when the job was submitted */
600
600
  additionalData?: Record<string, any> | null;
601
601
  }
602
- export interface CreatePoolRequest {
602
+ interface CreatePoolRequest {
603
603
  /** Pool to be created. */
604
604
  pool?: Pool;
605
605
  }
606
- export interface CreatePoolResponse {
606
+ interface CreatePoolResponse {
607
607
  /** Created pool. */
608
608
  pool?: Pool;
609
609
  }
610
- export interface GetPoolRequest {
610
+ interface GetPoolRequest {
611
611
  /**
612
612
  * ID of the pool to retrieve.
613
613
  * @format GUID
614
614
  */
615
615
  poolId: string;
616
616
  }
617
- export interface GetPoolResponse {
617
+ interface GetPoolResponse {
618
618
  /** Retrieved pool. */
619
619
  pool?: Pool;
620
620
  }
621
- export interface UpdatePoolRequest {
621
+ interface UpdatePoolRequest {
622
622
  /** Pool to update. */
623
623
  pool: Pool;
624
624
  }
625
- export interface UpdatePoolResponse {
625
+ interface UpdatePoolResponse {
626
626
  /** Updated pool. */
627
627
  pool?: Pool;
628
628
  }
629
- export interface DeletePoolRequest {
629
+ interface DeletePoolRequest {
630
630
  /**
631
631
  * ID of the pool to delete.
632
632
  * @format GUID
633
633
  */
634
634
  poolId?: string;
635
635
  }
636
- export interface DeletePoolResponse {
636
+ interface DeletePoolResponse {
637
637
  }
638
- export interface QueryPoolsRequest {
638
+ interface QueryPoolsRequest {
639
639
  /** Filter, sort, and paging to apply to the query. */
640
640
  query: CursorQuery;
641
641
  }
642
- export interface CursorQuery extends CursorQueryPagingMethodOneOf {
642
+ interface CursorQuery extends CursorQueryPagingMethodOneOf {
643
643
  /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
644
644
  cursorPaging?: CursorPaging;
645
645
  /**
@@ -655,11 +655,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
655
655
  sort?: Sorting[];
656
656
  }
657
657
  /** @oneof */
658
- export interface CursorQueryPagingMethodOneOf {
658
+ interface CursorQueryPagingMethodOneOf {
659
659
  /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
660
660
  cursorPaging?: CursorPaging;
661
661
  }
662
- export interface Sorting {
662
+ interface Sorting {
663
663
  /**
664
664
  * Field to sort by.
665
665
  * @maxLength 512
@@ -672,13 +672,13 @@ export interface Sorting {
672
672
  */
673
673
  order?: SortOrder;
674
674
  }
675
- export declare enum SortOrder {
675
+ declare enum SortOrder {
676
676
  /** Ascending sort order. */
677
677
  ASC = "ASC",
678
678
  /** Descending sort order. */
679
679
  DESC = "DESC"
680
680
  }
681
- export interface CursorPaging {
681
+ interface CursorPaging {
682
682
  /**
683
683
  * Maximum number of items to return.
684
684
  * @max 100
@@ -693,13 +693,13 @@ export interface CursorPaging {
693
693
  */
694
694
  cursor?: string | null;
695
695
  }
696
- export interface QueryPoolsResponse {
696
+ interface QueryPoolsResponse {
697
697
  /** List of retrieved pools. */
698
698
  pools?: Pool[];
699
699
  /** Metadata for the paginated results. */
700
700
  metadata?: CursorPagingMetadata;
701
701
  }
702
- export interface CursorPagingMetadata {
702
+ interface CursorPagingMetadata {
703
703
  /** Number of items returned in the response. */
704
704
  count?: number | null;
705
705
  /** Cursor strings that point to the next page, previous page, or both. */
@@ -712,7 +712,7 @@ export interface CursorPagingMetadata {
712
712
  */
713
713
  hasNext?: boolean | null;
714
714
  }
715
- export interface Cursors {
715
+ interface Cursors {
716
716
  /**
717
717
  * Cursor string pointing to the next page in the list of results.
718
718
  * @maxLength 16000
@@ -724,13 +724,13 @@ export interface Cursors {
724
724
  */
725
725
  prev?: string | null;
726
726
  }
727
- export interface RedeemBenefitRequest {
727
+ interface RedeemBenefitRequest {
728
728
  /**
729
- * ID of the pool that benefit to redeem belongs to.
729
+ * ID of the pool that contains the benefit to redeem.
730
730
  * @format GUID
731
731
  */
732
732
  poolId: string;
733
- /** Information about the item being to redeem. */
733
+ /** Information about the item to redeem. */
734
734
  itemReference: ItemReference;
735
735
  /**
736
736
  * Key of the benefit to redeem.
@@ -759,20 +759,20 @@ export interface RedeemBenefitRequest {
759
759
  /** Beneficiary of the pool containing the benefit to redeem. */
760
760
  beneficiary?: CommonIdentificationData;
761
761
  /**
762
- * Namespace for your app or site's benefit programs.
762
+ * Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
763
763
  * @minLength 1
764
764
  * @maxLength 50
765
765
  */
766
766
  namespace: string;
767
767
  }
768
- export interface RedeemBenefitResponse {
768
+ interface RedeemBenefitResponse {
769
769
  /**
770
770
  * ID of the transaction recording the associated change in balance.
771
771
  * @format GUID
772
772
  */
773
773
  transactionId?: string;
774
774
  }
775
- export interface NotEnoughBalance {
775
+ interface NotEnoughBalance {
776
776
  /**
777
777
  * Pool ID.
778
778
  * @format GUID
@@ -791,7 +791,7 @@ export interface NotEnoughBalance {
791
791
  */
792
792
  requestedBalance?: string;
793
793
  }
794
- export interface PolicyExpressionEvaluatedToFalse {
794
+ interface PolicyExpressionEvaluatedToFalse {
795
795
  /**
796
796
  * Pool ID.
797
797
  * @format GUID
@@ -805,7 +805,7 @@ export interface PolicyExpressionEvaluatedToFalse {
805
805
  */
806
806
  failureDetails?: FailureDetails[];
807
807
  }
808
- export interface FailureDetails {
808
+ interface FailureDetails {
809
809
  /**
810
810
  * Failure code
811
811
  * @minLength 1
@@ -830,7 +830,7 @@ export interface FailureDetails {
830
830
  /** Information provided by the policy */
831
831
  errorData?: Record<string, any> | null;
832
832
  }
833
- export interface PoolNotActive {
833
+ interface PoolNotActive {
834
834
  /**
835
835
  * Pool ID.
836
836
  * @format GUID
@@ -839,14 +839,14 @@ export interface PoolNotActive {
839
839
  /** Pool status. */
840
840
  poolStatus?: PoolStatus;
841
841
  }
842
- export interface PoolNotFound {
842
+ interface PoolNotFound {
843
843
  /**
844
844
  * Pool ID.
845
845
  * @format GUID
846
846
  */
847
847
  poolId?: string;
848
848
  }
849
- export interface BenefitAlreadyRedeemed {
849
+ interface BenefitAlreadyRedeemed {
850
850
  /**
851
851
  * Pool ID
852
852
  * @format GUID
@@ -858,7 +858,7 @@ export interface BenefitAlreadyRedeemed {
858
858
  */
859
859
  idempotencyKey?: string;
860
860
  }
861
- export interface BenefitNotFound {
861
+ interface BenefitNotFound {
862
862
  /**
863
863
  * Pool ID.
864
864
  * @format GUID
@@ -870,7 +870,7 @@ export interface BenefitNotFound {
870
870
  */
871
871
  benefitKey?: string | null;
872
872
  }
873
- export interface ReserveBenefitRequest {
873
+ interface ReserveBenefitRequest {
874
874
  /**
875
875
  * Id of the pool that is being redeemed from
876
876
  * @format GUID
@@ -920,42 +920,42 @@ export interface ReserveBenefitRequest {
920
920
  */
921
921
  namespace?: string;
922
922
  }
923
- export interface ReserveBenefitResponse {
923
+ interface ReserveBenefitResponse {
924
924
  /**
925
925
  * Id of the transaction that was created as a result of this request
926
926
  * @format GUID
927
927
  */
928
928
  transactionId?: string;
929
929
  }
930
- export interface CancelBenefitReservationRequest {
930
+ interface CancelBenefitReservationRequest {
931
931
  /**
932
932
  * Id of the transaction that was created as a result of this request
933
933
  * @format GUID
934
934
  */
935
935
  transactionId?: string;
936
936
  }
937
- export interface CancelBenefitReservationResponse {
937
+ interface CancelBenefitReservationResponse {
938
938
  /**
939
939
  * Id of the transaction that was created as a result of this request
940
940
  * @format GUID
941
941
  */
942
942
  transactionId?: string;
943
943
  }
944
- export interface ReleaseBenefitReservationRequest {
944
+ interface ReleaseBenefitReservationRequest {
945
945
  /**
946
946
  * Id of the transaction that was created as a result of this request
947
947
  * @format GUID
948
948
  */
949
949
  transactionId?: string;
950
950
  }
951
- export interface ReleaseBenefitReservationResponse {
951
+ interface ReleaseBenefitReservationResponse {
952
952
  /**
953
953
  * Id of the transaction that was created as a result of this request
954
954
  * @format GUID
955
955
  */
956
956
  transactionId?: string;
957
957
  }
958
- export interface CheckBenefitEligibilityRequest {
958
+ interface CheckBenefitEligibilityRequest {
959
959
  /**
960
960
  * ID of the pool that the benefit to check belongs to.
961
961
  * @format GUID
@@ -986,17 +986,17 @@ export interface CheckBenefitEligibilityRequest {
986
986
  /** Beneficiary of the pool containing the benefit to check. */
987
987
  beneficiary?: CommonIdentificationData;
988
988
  /**
989
- * Namespace for your app or site's benefit programs.
989
+ * Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
990
990
  * @minLength 1
991
991
  * @maxLength 50
992
992
  */
993
993
  namespace: string;
994
994
  }
995
- export interface CheckBenefitEligibilityResponse {
995
+ interface CheckBenefitEligibilityResponse {
996
996
  /** Result of the eligibility check. */
997
997
  result?: EligibilityCheckResult;
998
998
  }
999
- export interface EligibilityCheckResult extends EligibilityCheckResultResultOneOf {
999
+ interface EligibilityCheckResult extends EligibilityCheckResultResultOneOf {
1000
1000
  /** Returned when item is eligible to be redeemed. */
1001
1001
  eligibleOptions?: Eligible;
1002
1002
  /** Returned when the pool's associated balance is lower than the cost of redeeming the items. */
@@ -1011,7 +1011,7 @@ export interface EligibilityCheckResult extends EligibilityCheckResultResultOneO
1011
1011
  type?: EligibilityCheckResultType;
1012
1012
  }
1013
1013
  /** @oneof */
1014
- export interface EligibilityCheckResultResultOneOf {
1014
+ interface EligibilityCheckResultResultOneOf {
1015
1015
  /** Returned when item is eligible to be redeemed. */
1016
1016
  eligibleOptions?: Eligible;
1017
1017
  /** Returned when the pool's associated balance is lower than the cost of redeeming the items. */
@@ -1023,7 +1023,7 @@ export interface EligibilityCheckResultResultOneOf {
1023
1023
  /** Returned when invalid pool details are provided. */
1024
1024
  poolNotFoundOptions?: PoolNotFound;
1025
1025
  }
1026
- export interface EligibleBenefit {
1026
+ interface EligibleBenefit {
1027
1027
  /**
1028
1028
  * Pool ID.
1029
1029
  * @format GUID
@@ -1043,7 +1043,7 @@ export interface EligibleBenefit {
1043
1043
  */
1044
1044
  price?: string | null;
1045
1045
  }
1046
- export declare enum EligibilityCheckResultType {
1046
+ declare enum EligibilityCheckResultType {
1047
1047
  /** Unknown eligibility. */
1048
1048
  UNKNOWN = "UNKNOWN",
1049
1049
  /** Item is eligible to be redeemed. */
@@ -1057,14 +1057,14 @@ export declare enum EligibilityCheckResultType {
1057
1057
  /** Invalid pool details provided. */
1058
1058
  POOL_NOT_FOUND = "POOL_NOT_FOUND"
1059
1059
  }
1060
- export interface Eligible {
1060
+ interface Eligible {
1061
1061
  /**
1062
1062
  * Benefits that are eligible to be redeemed.
1063
1063
  * @maxSize 100
1064
1064
  */
1065
1065
  eligibleBenefits?: EligibleBenefit[];
1066
1066
  }
1067
- export interface BulkCheckBenefitEligibilityRequest {
1067
+ interface BulkCheckBenefitEligibilityRequest {
1068
1068
  /**
1069
1069
  * List of benefits to check.
1070
1070
  * @minSize 1
@@ -1072,7 +1072,7 @@ export interface BulkCheckBenefitEligibilityRequest {
1072
1072
  */
1073
1073
  benefitSelectors?: BenefitSelector[];
1074
1074
  /**
1075
- * Namespace for your app or site's benefit programs.
1075
+ * Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
1076
1076
  * @minLength 1
1077
1077
  * @maxLength 50
1078
1078
  */
@@ -1080,7 +1080,7 @@ export interface BulkCheckBenefitEligibilityRequest {
1080
1080
  /** Pool beneficiary. */
1081
1081
  beneficiary?: CommonIdentificationData;
1082
1082
  }
1083
- export interface BenefitSelector {
1083
+ interface BenefitSelector {
1084
1084
  /**
1085
1085
  * ID of the pool that the benefit to check belongs to.
1086
1086
  * @format GUID
@@ -1109,7 +1109,7 @@ export interface BenefitSelector {
1109
1109
  /** Additional information. */
1110
1110
  additionalData?: Record<string, any> | null;
1111
1111
  }
1112
- export interface BulkCheckBenefitEligibilityResponse {
1112
+ interface BulkCheckBenefitEligibilityResponse {
1113
1113
  /**
1114
1114
  * List of results checking each benefit.
1115
1115
  * @minSize 1
@@ -1117,13 +1117,13 @@ export interface BulkCheckBenefitEligibilityResponse {
1117
1117
  */
1118
1118
  results?: BulkEligibilityCheckResult[];
1119
1119
  }
1120
- export interface BulkEligibilityCheckResult {
1120
+ interface BulkEligibilityCheckResult {
1121
1121
  /** Benefit information specified in API call. */
1122
1122
  benefitSelector?: BenefitSelector;
1123
1123
  /** Result of the eligibility check. */
1124
1124
  result?: EligibilityCheckResult;
1125
1125
  }
1126
- export interface GetEligibleBenefitsRequest {
1126
+ interface GetEligibleBenefitsRequest {
1127
1127
  /** Item reference. */
1128
1128
  itemReference: ItemReference;
1129
1129
  /**
@@ -1142,27 +1142,27 @@ export interface GetEligibleBenefitsRequest {
1142
1142
  /** Filter request by beneficiary. */
1143
1143
  beneficiary?: CommonIdentificationData;
1144
1144
  /**
1145
- * Namespace for your app or site's benefit programs.
1145
+ * Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
1146
1146
  * @minLength 1
1147
1147
  * @maxLength 50
1148
1148
  */
1149
1149
  namespace: string;
1150
1150
  }
1151
- export interface GetEligibleBenefitsResponse {
1151
+ interface GetEligibleBenefitsResponse {
1152
1152
  /** Retrieved benefits that can be redeemed. */
1153
1153
  eligibleBenefits?: EligibleBenefit[];
1154
1154
  }
1155
- export interface ListPoolsRequest {
1155
+ interface ListPoolsRequest {
1156
1156
  /** The filter */
1157
1157
  filter?: Filter;
1158
1158
  /** Cursor paging */
1159
1159
  cursorPaging?: CursorPaging;
1160
1160
  }
1161
- export declare enum ListPoolsRequestType {
1161
+ declare enum ListPoolsRequestType {
1162
1162
  UNKNOWN_FILTER = "UNKNOWN_FILTER",
1163
1163
  BY_ITEM_REFERENCE = "BY_ITEM_REFERENCE"
1164
1164
  }
1165
- export interface ByItemReference {
1165
+ interface ByItemReference {
1166
1166
  /**
1167
1167
  * A list of filters
1168
1168
  * @maxSize 100
@@ -1176,11 +1176,11 @@ export interface ByItemReference {
1176
1176
  */
1177
1177
  poolStatuses?: PoolStatus[];
1178
1178
  }
1179
- export interface ByItemReferenceFilter {
1179
+ interface ByItemReferenceFilter {
1180
1180
  /** Reference of the item */
1181
1181
  itemReference?: ItemReference;
1182
1182
  }
1183
- export interface Filter extends FilterFilterOneOf {
1183
+ interface Filter extends FilterFilterOneOf {
1184
1184
  /** A list of filters by reference */
1185
1185
  byItemReferenceOptions?: ByItemReference;
1186
1186
  /** Type of the filter */
@@ -1196,11 +1196,11 @@ export interface Filter extends FilterFilterOneOf {
1196
1196
  namespace?: string;
1197
1197
  }
1198
1198
  /** @oneof */
1199
- export interface FilterFilterOneOf {
1199
+ interface FilterFilterOneOf {
1200
1200
  /** A list of filters by reference */
1201
1201
  byItemReferenceOptions?: ByItemReference;
1202
1202
  }
1203
- export interface ListPoolsResponse {
1203
+ interface ListPoolsResponse {
1204
1204
  /**
1205
1205
  * The retrieved pools
1206
1206
  * @maxSize 100
@@ -1209,7 +1209,7 @@ export interface ListPoolsResponse {
1209
1209
  /** Paging information */
1210
1210
  metadata?: CursorPagingMetadata;
1211
1211
  }
1212
- export interface PoolWithItems {
1212
+ interface PoolWithItems {
1213
1213
  /** The pool */
1214
1214
  pool?: Pool;
1215
1215
  /**
@@ -1218,7 +1218,7 @@ export interface PoolWithItems {
1218
1218
  */
1219
1219
  itemReference?: ItemReference[];
1220
1220
  }
1221
- export interface BulkUpdatePoolsRequest {
1221
+ interface BulkUpdatePoolsRequest {
1222
1222
  /**
1223
1223
  * Pools to update.
1224
1224
  * @minSize 1
@@ -1232,13 +1232,13 @@ export interface BulkUpdatePoolsRequest {
1232
1232
  */
1233
1233
  returnEntity?: boolean;
1234
1234
  }
1235
- export interface MaskedPool {
1235
+ interface MaskedPool {
1236
1236
  /** Pool to update. */
1237
1237
  pool?: Pool;
1238
1238
  /** Explicit list of fields to update. */
1239
1239
  fieldMask?: string[];
1240
1240
  }
1241
- export interface BulkUpdatePoolsResponse {
1241
+ interface BulkUpdatePoolsResponse {
1242
1242
  /**
1243
1243
  * List of updated pools and associated metadata.
1244
1244
  * @minSize 1
@@ -1248,13 +1248,13 @@ export interface BulkUpdatePoolsResponse {
1248
1248
  /** Bulk action metadata. */
1249
1249
  bulkActionMetadata?: BulkActionMetadata;
1250
1250
  }
1251
- export interface BulkPoolResult {
1251
+ interface BulkPoolResult {
1252
1252
  /** Pool metadata. */
1253
1253
  poolMetadata?: ItemMetadata;
1254
1254
  /** Pool data. */
1255
1255
  pool?: Pool;
1256
1256
  }
1257
- export interface ItemMetadata {
1257
+ interface ItemMetadata {
1258
1258
  /**
1259
1259
  * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
1260
1260
  * @format GUID
@@ -1267,7 +1267,7 @@ export interface ItemMetadata {
1267
1267
  /** Details about the error in case of failure. */
1268
1268
  error?: ApplicationError;
1269
1269
  }
1270
- export interface ApplicationError {
1270
+ interface ApplicationError {
1271
1271
  /** Error code. */
1272
1272
  code?: string;
1273
1273
  /** Description of the error. */
@@ -1275,7 +1275,7 @@ export interface ApplicationError {
1275
1275
  /** Data related to the error. */
1276
1276
  data?: Record<string, any> | null;
1277
1277
  }
1278
- export interface BulkActionMetadata {
1278
+ interface BulkActionMetadata {
1279
1279
  /** Number of items that were successfully processed. */
1280
1280
  totalSuccesses?: number;
1281
1281
  /** Number of items that couldn't be processed. */
@@ -1283,7 +1283,7 @@ export interface BulkActionMetadata {
1283
1283
  /** Number of failures without details because detailed failure threshold was exceeded. */
1284
1284
  undetailedFailures?: number;
1285
1285
  }
1286
- export interface ProvisionPoolsForProgramRequest {
1286
+ interface ProvisionPoolsForProgramRequest {
1287
1287
  /** Reference of the template that is used to provision the pools */
1288
1288
  poolDefinitionLookupId?: PoolDefinitionLookupId;
1289
1289
  /**
@@ -1292,7 +1292,7 @@ export interface ProvisionPoolsForProgramRequest {
1292
1292
  */
1293
1293
  programId?: string;
1294
1294
  }
1295
- export interface PoolDefinitionLookupId extends PoolDefinitionLookupIdIdOneOf {
1295
+ interface PoolDefinitionLookupId extends PoolDefinitionLookupIdIdOneOf {
1296
1296
  /**
1297
1297
  * Pool definition ID.
1298
1298
  * @format GUID
@@ -1305,7 +1305,7 @@ export interface PoolDefinitionLookupId extends PoolDefinitionLookupIdIdOneOf {
1305
1305
  programDefinitionId?: string;
1306
1306
  }
1307
1307
  /** @oneof */
1308
- export interface PoolDefinitionLookupIdIdOneOf {
1308
+ interface PoolDefinitionLookupIdIdOneOf {
1309
1309
  /**
1310
1310
  * Pool definition ID.
1311
1311
  * @format GUID
@@ -1317,13 +1317,13 @@ export interface PoolDefinitionLookupIdIdOneOf {
1317
1317
  */
1318
1318
  programDefinitionId?: string;
1319
1319
  }
1320
- export interface ProvisionPoolsForProgramResponse extends ProvisionPoolsForProgramResponseResultOneOf {
1320
+ interface ProvisionPoolsForProgramResponse extends ProvisionPoolsForProgramResponseResultOneOf {
1321
1321
  /** Sync result */
1322
1322
  syncOptions?: SyncResult;
1323
1323
  /** Async result */
1324
1324
  asyncOptions?: AsyncResult;
1325
1325
  /**
1326
- * Job ID of the program provision associated with this pool.
1326
+ * Job ID of the program provision associated with this pool. Retrieve job details using the Async Job API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)).
1327
1327
  * @format GUID
1328
1328
  */
1329
1329
  jobId?: string;
@@ -1331,13 +1331,13 @@ export interface ProvisionPoolsForProgramResponse extends ProvisionPoolsForProgr
1331
1331
  type?: ProvisionPoolsForProgramResponseType;
1332
1332
  }
1333
1333
  /** @oneof */
1334
- export interface ProvisionPoolsForProgramResponseResultOneOf {
1334
+ interface ProvisionPoolsForProgramResponseResultOneOf {
1335
1335
  /** Sync result */
1336
1336
  syncOptions?: SyncResult;
1337
1337
  /** Async result */
1338
1338
  asyncOptions?: AsyncResult;
1339
1339
  }
1340
- export declare enum ProvisionPoolsForProgramResponseType {
1340
+ declare enum ProvisionPoolsForProgramResponseType {
1341
1341
  /** Unknown result type */
1342
1342
  UNKNOWN = "UNKNOWN",
1343
1343
  /** Sync result */
@@ -1345,36 +1345,36 @@ export declare enum ProvisionPoolsForProgramResponseType {
1345
1345
  /** Async result */
1346
1346
  ASYNC = "ASYNC"
1347
1347
  }
1348
- export interface SyncResult {
1348
+ interface SyncResult {
1349
1349
  /** Indicates if the operation was successful */
1350
1350
  success?: boolean;
1351
1351
  }
1352
- export interface AsyncResult {
1352
+ interface AsyncResult {
1353
1353
  /**
1354
- * Job ID of the program provision associated with this pool.
1354
+ * Job ID of the program provision associated with this pool. Retrieve job details using the Async Job API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)).
1355
1355
  * @format GUID
1356
1356
  */
1357
1357
  jobId?: string;
1358
1358
  }
1359
- export interface InvalidPoolDefinitionReference {
1359
+ interface InvalidPoolDefinitionReference {
1360
1360
  /** Reference of the template that didn't find any pool definitions */
1361
1361
  poolDefinitionLookupId?: PoolDefinitionLookupId;
1362
1362
  }
1363
- export interface RenewPoolsForProgramRequest {
1363
+ interface RenewPoolsForProgramRequest {
1364
1364
  /**
1365
1365
  * Package of pools to grant. Package id should be the same that was used to provision programs.
1366
1366
  * @format GUID
1367
1367
  */
1368
1368
  programId?: string;
1369
1369
  }
1370
- export interface RenewPoolsForProgramResponse {
1370
+ interface RenewPoolsForProgramResponse {
1371
1371
  /**
1372
1372
  * Job id of the renewal job
1373
1373
  * @format GUID
1374
1374
  */
1375
1375
  jobId?: string;
1376
1376
  }
1377
- export interface UpdatePoolStatusRequest extends UpdatePoolStatusRequestPoolSelectorOneOf {
1377
+ interface UpdatePoolStatusRequest extends UpdatePoolStatusRequestPoolSelectorOneOf {
1378
1378
  /** Pool selector by pool definition id and program definition id */
1379
1379
  byPoolDefinitionIdAndProgramDefinitionIdOptions?: ByPoolDefinitionIdAndProgramDefinitionIdOptions;
1380
1380
  /** Pool selector by program id */
@@ -1385,18 +1385,18 @@ export interface UpdatePoolStatusRequest extends UpdatePoolStatusRequestPoolSele
1385
1385
  poolSelectorType?: PoolSelectorType;
1386
1386
  }
1387
1387
  /** @oneof */
1388
- export interface UpdatePoolStatusRequestPoolSelectorOneOf {
1388
+ interface UpdatePoolStatusRequestPoolSelectorOneOf {
1389
1389
  /** Pool selector by pool definition id and program definition id */
1390
1390
  byPoolDefinitionIdAndProgramDefinitionIdOptions?: ByPoolDefinitionIdAndProgramDefinitionIdOptions;
1391
1391
  /** Pool selector by program id */
1392
1392
  byProgramIdOptions?: ByProgramIdOptions;
1393
1393
  }
1394
- export declare enum PoolSelectorType {
1394
+ declare enum PoolSelectorType {
1395
1395
  UNKNOWN_SELECTOR = "UNKNOWN_SELECTOR",
1396
1396
  BY_POOL_DEFINITION_ID_AND_PROGRAM_DEFINITION_ID = "BY_POOL_DEFINITION_ID_AND_PROGRAM_DEFINITION_ID",
1397
1397
  BY_PROGRAM_ID = "BY_PROGRAM_ID"
1398
1398
  }
1399
- export interface ByPoolDefinitionIdAndProgramDefinitionIdOptions {
1399
+ interface ByPoolDefinitionIdAndProgramDefinitionIdOptions {
1400
1400
  /**
1401
1401
  * Pool definition id
1402
1402
  * @format GUID
@@ -1408,7 +1408,7 @@ export interface ByPoolDefinitionIdAndProgramDefinitionIdOptions {
1408
1408
  */
1409
1409
  programDefinitionId?: string | null;
1410
1410
  }
1411
- export interface ByProgramIdOptions {
1411
+ interface ByProgramIdOptions {
1412
1412
  /**
1413
1413
  * Program id
1414
1414
  * @format GUID
@@ -1417,25 +1417,25 @@ export interface ByProgramIdOptions {
1417
1417
  /** Additional data that gets added to the event once the async job completes */
1418
1418
  additionalData?: Record<string, any> | null;
1419
1419
  }
1420
- export interface UpdatePoolStatusResponse {
1420
+ interface UpdatePoolStatusResponse {
1421
1421
  /**
1422
- * Job ID of the program provision associated with this pool.
1422
+ * Job ID of the program provision associated with this pool. Retrieve job details using the Async Job API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)).
1423
1423
  * @format GUID
1424
1424
  */
1425
1425
  jobId?: string;
1426
1426
  }
1427
- export interface CountNumberOfPoolsInProvisioningStatusRequest {
1427
+ interface CountNumberOfPoolsInProvisioningStatusRequest {
1428
1428
  /**
1429
1429
  * Program id
1430
1430
  * @format GUID
1431
1431
  */
1432
1432
  programId?: string;
1433
1433
  }
1434
- export interface CountNumberOfPoolsInProvisioningStatusResponse {
1434
+ interface CountNumberOfPoolsInProvisioningStatusResponse {
1435
1435
  /** Number of pools in provisioning status */
1436
1436
  count?: number;
1437
1437
  }
1438
- export interface DomainEvent extends DomainEventBodyOneOf {
1438
+ interface DomainEvent extends DomainEventBodyOneOf {
1439
1439
  createdEvent?: EntityCreatedEvent;
1440
1440
  updatedEvent?: EntityUpdatedEvent;
1441
1441
  deletedEvent?: EntityDeletedEvent;
@@ -1478,19 +1478,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
1478
1478
  entityEventSequence?: string | null;
1479
1479
  }
1480
1480
  /** @oneof */
1481
- export interface DomainEventBodyOneOf {
1481
+ interface DomainEventBodyOneOf {
1482
1482
  createdEvent?: EntityCreatedEvent;
1483
1483
  updatedEvent?: EntityUpdatedEvent;
1484
1484
  deletedEvent?: EntityDeletedEvent;
1485
1485
  actionEvent?: ActionEvent;
1486
1486
  }
1487
- export interface EntityCreatedEvent {
1487
+ interface EntityCreatedEvent {
1488
1488
  entity?: string;
1489
1489
  }
1490
- export interface RestoreInfo {
1490
+ interface RestoreInfo {
1491
1491
  deletedDate?: Date | null;
1492
1492
  }
1493
- export interface EntityUpdatedEvent {
1493
+ interface EntityUpdatedEvent {
1494
1494
  /**
1495
1495
  * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1496
1496
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
@@ -1498,14 +1498,14 @@ export interface EntityUpdatedEvent {
1498
1498
  */
1499
1499
  currentEntity?: string;
1500
1500
  }
1501
- export interface EntityDeletedEvent {
1501
+ interface EntityDeletedEvent {
1502
1502
  /** Entity that was deleted */
1503
1503
  deletedEntity?: string | null;
1504
1504
  }
1505
- export interface ActionEvent {
1505
+ interface ActionEvent {
1506
1506
  body?: string;
1507
1507
  }
1508
- export interface MessageEnvelope {
1508
+ interface MessageEnvelope {
1509
1509
  /**
1510
1510
  * App instance ID.
1511
1511
  * @format GUID
@@ -1521,7 +1521,7 @@ export interface MessageEnvelope {
1521
1521
  /** Stringify payload. */
1522
1522
  data?: string;
1523
1523
  }
1524
- export interface IdentificationData extends IdentificationDataIdOneOf {
1524
+ interface IdentificationData extends IdentificationDataIdOneOf {
1525
1525
  /**
1526
1526
  * ID of a site visitor that has not logged in to the site.
1527
1527
  * @format GUID
@@ -1546,7 +1546,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
1546
1546
  identityType?: WebhookIdentityType;
1547
1547
  }
1548
1548
  /** @oneof */
1549
- export interface IdentificationDataIdOneOf {
1549
+ interface IdentificationDataIdOneOf {
1550
1550
  /**
1551
1551
  * ID of a site visitor that has not logged in to the site.
1552
1552
  * @format GUID
@@ -1568,220 +1568,14 @@ export interface IdentificationDataIdOneOf {
1568
1568
  */
1569
1569
  appId?: string;
1570
1570
  }
1571
- export declare enum WebhookIdentityType {
1571
+ declare enum WebhookIdentityType {
1572
1572
  UNKNOWN = "UNKNOWN",
1573
1573
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1574
1574
  MEMBER = "MEMBER",
1575
1575
  WIX_USER = "WIX_USER",
1576
1576
  APP = "APP"
1577
1577
  }
1578
- interface CommonIdentificationDataNonNullableFields {
1579
- anonymousVisitorId: string;
1580
- memberId: string;
1581
- wixUserId: string;
1582
- identityType: IdentityType;
1583
- }
1584
- interface PolicyExpressionNotNonNullableFields {
1585
- expression?: PolicyExpressionNonNullableFields;
1586
- }
1587
- interface PolicyExpressionAndNonNullableFields {
1588
- expressions: PolicyExpressionNonNullableFields[];
1589
- }
1590
- interface PolicyExpressionOrNonNullableFields {
1591
- expressions: PolicyExpressionNonNullableFields[];
1592
- }
1593
- interface FixedIntervalPolicyNonNullableFields {
1594
- fromWeekDay: WeekDay;
1595
- toWeekDay: WeekDay;
1596
- }
1597
- interface RateLimitedPolicyNonNullableFields {
1598
- fixedIntervalOptions?: FixedIntervalPolicyNonNullableFields;
1599
- times: number;
1600
- type: RateLimitedPolicyType;
1601
- }
1602
- interface CustomPolicyNonNullableFields {
1603
- _id: string;
1604
- }
1605
- interface PolicyNonNullableFields {
1606
- fixedIntervalOptions?: FixedIntervalPolicyNonNullableFields;
1607
- rateLimitedOptions?: RateLimitedPolicyNonNullableFields;
1608
- customOptions?: CustomPolicyNonNullableFields;
1609
- type: Type;
1610
- }
1611
- interface PolicyExpressionNonNullableFields {
1612
- operatorNotOptions?: PolicyExpressionNotNonNullableFields;
1613
- operatorAndOptions?: PolicyExpressionAndNonNullableFields;
1614
- operatorOrOptions?: PolicyExpressionOrNonNullableFields;
1615
- policyOptions?: PolicyNonNullableFields;
1616
- type: PolicyExpressionType;
1617
- }
1618
- interface BenefitNonNullableFields {
1619
- benefitKey: string;
1620
- policyExpression?: PolicyExpressionNonNullableFields;
1621
- }
1622
- interface CreditConfigurationNonNullableFields {
1623
- amount: string;
1624
- }
1625
- interface DetailsNonNullableFields {
1626
- benefits: BenefitNonNullableFields[];
1627
- creditConfiguration?: CreditConfigurationNonNullableFields;
1628
- policyExpression?: PolicyExpressionNonNullableFields;
1629
- }
1630
- interface ProgramDefinitionInfoNonNullableFields {
1631
- _id: string;
1632
- }
1633
- interface PoolProgramInfoNonNullableFields {
1634
- _id: string;
1635
- }
1636
- export interface PoolNonNullableFields {
1637
- status: PoolStatus;
1638
- beneficiary?: CommonIdentificationDataNonNullableFields;
1639
- details?: DetailsNonNullableFields;
1640
- displayName: string;
1641
- programDefinition?: ProgramDefinitionInfoNonNullableFields;
1642
- program?: PoolProgramInfoNonNullableFields;
1643
- previousStatus: PoolStatus;
1644
- origin: PoolOrigin;
1645
- }
1646
- export interface GetPoolResponseNonNullableFields {
1647
- pool?: PoolNonNullableFields;
1648
- }
1649
- export interface UpdatePoolResponseNonNullableFields {
1650
- pool?: PoolNonNullableFields;
1651
- }
1652
- export interface QueryPoolsResponseNonNullableFields {
1653
- pools: PoolNonNullableFields[];
1654
- }
1655
- export interface RedeemBenefitResponseNonNullableFields {
1656
- transactionId: string;
1657
- }
1658
- interface ItemReferenceNonNullableFields {
1659
- externalId: string;
1660
- category: string;
1661
- providerAppId: string;
1662
- }
1663
- interface EligibleBenefitNonNullableFields {
1664
- poolId: string;
1665
- benefitKey: string;
1666
- itemReference?: ItemReferenceNonNullableFields;
1667
- }
1668
- interface EligibleNonNullableFields {
1669
- eligibleBenefits: EligibleBenefitNonNullableFields[];
1670
- }
1671
- interface NotEnoughBalanceNonNullableFields {
1672
- poolId: string;
1673
- itemReference?: ItemReferenceNonNullableFields;
1674
- availableBalance: string;
1675
- requestedBalance: string;
1676
- }
1677
- interface FailureDetailsNonNullableFields {
1678
- code: string;
1679
- }
1680
- interface PolicyExpressionEvaluatedToFalseNonNullableFields {
1681
- poolId: string;
1682
- itemReference?: ItemReferenceNonNullableFields;
1683
- failureDetails: FailureDetailsNonNullableFields[];
1684
- }
1685
- interface PoolNotActiveNonNullableFields {
1686
- poolId: string;
1687
- poolStatus: PoolStatus;
1688
- }
1689
- interface BenefitNotFoundNonNullableFields {
1690
- poolId: string;
1691
- }
1692
- interface PoolNotFoundNonNullableFields {
1693
- poolId: string;
1694
- }
1695
- interface EligibilityCheckResultNonNullableFields {
1696
- eligibleOptions?: EligibleNonNullableFields;
1697
- notEnoughBalanceOptions?: NotEnoughBalanceNonNullableFields;
1698
- policyExpressionEvaluatedToFalseOptions?: PolicyExpressionEvaluatedToFalseNonNullableFields;
1699
- poolNotActiveOptions?: PoolNotActiveNonNullableFields;
1700
- benefitNotFoundOptions?: BenefitNotFoundNonNullableFields;
1701
- poolNotFoundOptions?: PoolNotFoundNonNullableFields;
1702
- type: EligibilityCheckResultType;
1703
- }
1704
- export interface CheckBenefitEligibilityResponseNonNullableFields {
1705
- result?: EligibilityCheckResultNonNullableFields;
1706
- }
1707
- interface BenefitSelectorNonNullableFields {
1708
- poolId: string;
1709
- itemReference?: ItemReferenceNonNullableFields;
1710
- count: number;
1711
- }
1712
- interface BulkEligibilityCheckResultNonNullableFields {
1713
- benefitSelector?: BenefitSelectorNonNullableFields;
1714
- result?: EligibilityCheckResultNonNullableFields;
1715
- }
1716
- export interface BulkCheckBenefitEligibilityResponseNonNullableFields {
1717
- results: BulkEligibilityCheckResultNonNullableFields[];
1718
- }
1719
- export interface GetEligibleBenefitsResponseNonNullableFields {
1720
- eligibleBenefits: EligibleBenefitNonNullableFields[];
1721
- }
1722
- interface ApplicationErrorNonNullableFields {
1723
- code: string;
1724
- description: string;
1725
- }
1726
- interface ItemMetadataNonNullableFields {
1727
- originalIndex: number;
1728
- success: boolean;
1729
- error?: ApplicationErrorNonNullableFields;
1730
- }
1731
- interface BulkPoolResultNonNullableFields {
1732
- poolMetadata?: ItemMetadataNonNullableFields;
1733
- pool?: PoolNonNullableFields;
1734
- }
1735
- interface BulkActionMetadataNonNullableFields {
1736
- totalSuccesses: number;
1737
- totalFailures: number;
1738
- undetailedFailures: number;
1739
- }
1740
- export interface BulkUpdatePoolsResponseNonNullableFields {
1741
- results: BulkPoolResultNonNullableFields[];
1742
- bulkActionMetadata?: BulkActionMetadataNonNullableFields;
1743
- }
1744
- /**
1745
- * Retrieves a pool.
1746
- * @param poolId - ID of the pool to retrieve.
1747
- * @public
1748
- * @documentationMaturity preview
1749
- * @requiredField poolId
1750
- * @permissionId BENEFIT_PROGRAMS.POOL_READ
1751
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
1752
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
1753
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
1754
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
1755
- * @permissionScope Manage Events
1756
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1757
- * @applicableIdentity APP
1758
- * @returns Retrieved pool.
1759
- * @fqn wix.benefit_programs.v1.pool.PoolService.GetPool
1760
- */
1761
- export declare function getPool(poolId: string): Promise<Pool & PoolNonNullableFields>;
1762
- /**
1763
- * Updates a pool.
1764
- *
1765
- * Each time the pool is updated,
1766
- * `revision` increments by 1.
1767
- * The current `revision` must be passed when updating the pool.
1768
- * This ensures you're working with the latest pool
1769
- * and prevents unintended overwrites.
1770
- * @param _id - Pool ID.
1771
- * @public
1772
- * @documentationMaturity preview
1773
- * @requiredField _id
1774
- * @requiredField pool
1775
- * @requiredField pool.revision
1776
- * @permissionId BENEFIT_PROGRAMS.POOL_UPDATE
1777
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
1778
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
1779
- * @applicableIdentity APP
1780
- * @returns Updated pool.
1781
- * @fqn wix.benefit_programs.v1.pool.PoolService.UpdatePool
1782
- */
1783
- export declare function updatePool(_id: string | null, pool: UpdatePool): Promise<Pool & PoolNonNullableFields>;
1784
- export interface UpdatePool {
1578
+ interface UpdatePool {
1785
1579
  /**
1786
1580
  * Pool ID.
1787
1581
  * @format GUID
@@ -1849,7 +1643,7 @@ export interface UpdatePool {
1849
1643
  */
1850
1644
  displayName?: string;
1851
1645
  /**
1852
- * Namespace for your app or site's benefit programs.
1646
+ * Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
1853
1647
  * @readonly
1854
1648
  * @immutable
1855
1649
  * @minLength 1
@@ -1883,31 +1677,6 @@ export interface UpdatePool {
1883
1677
  */
1884
1678
  renewalCount?: number | null;
1885
1679
  }
1886
- /**
1887
- * Creates a query to retrieve a list of pools.
1888
- *
1889
- * The Query Pools method builds a query to retrieve a list of pools and returns a `PoolsQueryBuilder` object.
1890
- *
1891
- * The returned object contains the query definition, which is used to run the query using the `find()` method.
1892
- *
1893
- * You can refine the query by chaining `PoolsQueryBuilder` methods onto the query. `PoolsQueryBuilder` methods enable you to filter, sort, and control the results that Query Pools returns.
1894
- *
1895
- * Query Pools has a default paging limit of 50, which you can override.
1896
- *
1897
- * For a full description of the item object, see the object returned for the `items` property in `PoolsQueryResult`.
1898
- * @public
1899
- * @documentationMaturity preview
1900
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
1901
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
1902
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
1903
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
1904
- * @permissionScope Manage Events
1905
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1906
- * @permissionId BENEFIT_PROGRAMS.POOL_READ
1907
- * @applicableIdentity APP
1908
- * @fqn wix.benefit_programs.v1.pool.PoolService.QueryPools
1909
- */
1910
- export declare function queryPools(): PoolsQueryBuilder;
1911
1680
  interface QueryCursorResult {
1912
1681
  cursors: Cursors;
1913
1682
  hasNext: () => boolean;
@@ -1915,13 +1684,13 @@ interface QueryCursorResult {
1915
1684
  length: number;
1916
1685
  pageSize: number;
1917
1686
  }
1918
- export interface PoolsQueryResult extends QueryCursorResult {
1687
+ interface PoolsQueryResult extends QueryCursorResult {
1919
1688
  items: Pool[];
1920
1689
  query: PoolsQueryBuilder;
1921
1690
  next: () => Promise<PoolsQueryResult>;
1922
1691
  prev: () => Promise<PoolsQueryResult>;
1923
1692
  }
1924
- export interface PoolsQueryBuilder {
1693
+ interface PoolsQueryBuilder {
1925
1694
  /** @param propertyName - Property whose value is compared with `value`.
1926
1695
  * @param value - Value to compare against.
1927
1696
  * @documentationMaturity preview
@@ -1985,29 +1754,8 @@ export interface PoolsQueryBuilder {
1985
1754
  /** @documentationMaturity preview */
1986
1755
  find: () => Promise<PoolsQueryResult>;
1987
1756
  }
1988
- /**
1989
- * Redeems a specified benefit.
1990
- *
1991
- * Calling this method records redemption of the benefit and adjusts the pool's associated balance. You still need to handle providing the beneficiary with the item.
1992
- * @param poolId - ID of the pool that benefit to redeem belongs to.
1993
- * @public
1994
- * @documentationMaturity preview
1995
- * @requiredField options.benefitKey
1996
- * @requiredField options.idempotencyKey
1997
- * @requiredField options.itemReference
1998
- * @requiredField options.itemReference.externalId
1999
- * @requiredField options.itemReference.providerAppId
2000
- * @requiredField options.namespace
2001
- * @requiredField poolId
2002
- * @permissionId BENEFIT_PROGRAMS.POOL_REDEEM
2003
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
2004
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
2005
- * @applicableIdentity APP
2006
- * @fqn wix.benefit_programs.v1.pool.PoolService.RedeemBenefit
2007
- */
2008
- export declare function redeemBenefit(poolId: string, options?: RedeemBenefitOptions): Promise<RedeemBenefitResponse & RedeemBenefitResponseNonNullableFields>;
2009
- export interface RedeemBenefitOptions {
2010
- /** Information about the item being to redeem. */
1757
+ interface RedeemBenefitOptions {
1758
+ /** Information about the item to redeem. */
2011
1759
  itemReference: ItemReference;
2012
1760
  /**
2013
1761
  * Key of the benefit to redeem.
@@ -2036,32 +1784,13 @@ export interface RedeemBenefitOptions {
2036
1784
  /** Beneficiary of the pool containing the benefit to redeem. */
2037
1785
  beneficiary?: CommonIdentificationData;
2038
1786
  /**
2039
- * Namespace for your app or site's benefit programs.
1787
+ * Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
2040
1788
  * @minLength 1
2041
1789
  * @maxLength 50
2042
1790
  */
2043
1791
  namespace: string;
2044
1792
  }
2045
- /**
2046
- * Checks if a benefit can currently be redeemed.
2047
- *
2048
- * In order to be a redeemed, a benefit's pool must be active and the associated balance must greater than the cost of the benefit.
2049
- * @param poolId - ID of the pool that the benefit to check belongs to.
2050
- * @public
2051
- * @documentationMaturity preview
2052
- * @requiredField options.itemReference
2053
- * @requiredField options.itemReference.externalId
2054
- * @requiredField options.itemReference.providerAppId
2055
- * @requiredField options.namespace
2056
- * @requiredField poolId
2057
- * @permissionId BENEFIT_PROGRAMS.POOL_REDEEM
2058
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
2059
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
2060
- * @applicableIdentity APP
2061
- * @fqn wix.benefit_programs.v1.pool.PoolService.CheckBenefitEligibility
2062
- */
2063
- export declare function checkBenefitEligibility(poolId: string, options?: CheckBenefitEligibilityOptions): Promise<CheckBenefitEligibilityResponse & CheckBenefitEligibilityResponseNonNullableFields>;
2064
- export interface CheckBenefitEligibilityOptions {
1793
+ interface CheckBenefitEligibilityOptions {
2065
1794
  /**
2066
1795
  * Key of the benefit to check.
2067
1796
  * @maxLength 64
@@ -2087,31 +1816,13 @@ export interface CheckBenefitEligibilityOptions {
2087
1816
  /** Beneficiary of the pool containing the benefit to check. */
2088
1817
  beneficiary?: CommonIdentificationData;
2089
1818
  /**
2090
- * Namespace for your app or site's benefit programs.
1819
+ * Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
2091
1820
  * @minLength 1
2092
1821
  * @maxLength 50
2093
1822
  */
2094
1823
  namespace: string;
2095
1824
  }
2096
- /**
2097
- * Checks if benefits can currently be redeemed.
2098
- *
2099
- * In order to be a redeemed, a benefit's pool must be active and the associated balance must greater than the cost of the benefit. Each benefit is checked independently.
2100
- * @public
2101
- * @documentationMaturity preview
2102
- * @requiredField options.benefitSelectors.itemReference
2103
- * @requiredField options.benefitSelectors.itemReference.externalId
2104
- * @requiredField options.benefitSelectors.itemReference.providerAppId
2105
- * @requiredField options.benefitSelectors.poolId
2106
- * @requiredField options.namespace
2107
- * @permissionId BENEFIT_PROGRAMS.POOL_REDEEM
2108
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
2109
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
2110
- * @applicableIdentity APP
2111
- * @fqn wix.benefit_programs.v1.pool.PoolService.BulkCheckBenefitEligibility
2112
- */
2113
- export declare function bulkCheckBenefitEligibility(options?: BulkCheckBenefitEligibilityOptions): Promise<BulkCheckBenefitEligibilityResponse & BulkCheckBenefitEligibilityResponseNonNullableFields>;
2114
- export interface BulkCheckBenefitEligibilityOptions {
1825
+ interface BulkCheckBenefitEligibilityOptions {
2115
1826
  /**
2116
1827
  * List of benefits to check.
2117
1828
  * @minSize 1
@@ -2119,7 +1830,7 @@ export interface BulkCheckBenefitEligibilityOptions {
2119
1830
  */
2120
1831
  benefitSelectors?: BenefitSelector[];
2121
1832
  /**
2122
- * Namespace for your app or site's benefit programs.
1833
+ * Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
2123
1834
  * @minLength 1
2124
1835
  * @maxLength 50
2125
1836
  */
@@ -2127,30 +1838,7 @@ export interface BulkCheckBenefitEligibilityOptions {
2127
1838
  /** Pool beneficiary. */
2128
1839
  beneficiary?: CommonIdentificationData;
2129
1840
  }
2130
- /**
2131
- * Retrieves benefits that can be redeemed for a specific item.
2132
- *
2133
- * Each item can only be linked to 1 benefit in 1 pool definition. However, each pool created from that pool definition contains a benefit with this item.
2134
- * This method checks each pool containing a benefit with this item, and returns the benefits that can be redeemed.
2135
- * @param itemReference - Item reference.
2136
- * @public
2137
- * @documentationMaturity preview
2138
- * @requiredField itemReference
2139
- * @requiredField itemReference.externalId
2140
- * @requiredField itemReference.providerAppId
2141
- * @requiredField options.namespace
2142
- * @permissionId BENEFIT_PROGRAMS.POOL_READ
2143
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
2144
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
2145
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
2146
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
2147
- * @permissionScope Manage Events
2148
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
2149
- * @applicableIdentity APP
2150
- * @fqn wix.benefit_programs.v1.pool.PoolService.GetEligibleBenefits
2151
- */
2152
- export declare function getEligibleBenefits(itemReference: ItemReference, options?: GetEligibleBenefitsOptions): Promise<GetEligibleBenefitsResponse & GetEligibleBenefitsResponseNonNullableFields>;
2153
- export interface GetEligibleBenefitsOptions {
1841
+ interface GetEligibleBenefitsOptions {
2154
1842
  /**
2155
1843
  * Amount of items to check. This ensures the balance is high enough to redeem this many items.
2156
1844
  * @min 1
@@ -2167,27 +1855,13 @@ export interface GetEligibleBenefitsOptions {
2167
1855
  /** Filter request by beneficiary. */
2168
1856
  beneficiary?: CommonIdentificationData;
2169
1857
  /**
2170
- * Namespace for your app or site's benefit programs.
1858
+ * Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
2171
1859
  * @minLength 1
2172
1860
  * @maxLength 50
2173
1861
  */
2174
1862
  namespace: string;
2175
1863
  }
2176
- /**
2177
- * Updates pools.
2178
- * @public
2179
- * @documentationMaturity preview
2180
- * @requiredField options.pools.pool
2181
- * @requiredField options.pools.pool._id
2182
- * @requiredField options.pools.pool.revision
2183
- * @permissionId BENEFIT_PROGRAMS.POOL_UPDATE
2184
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
2185
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
2186
- * @applicableIdentity APP
2187
- * @fqn wix.benefit_programs.v1.pool.PoolService.BulkUpdatePools
2188
- */
2189
- export declare function bulkUpdatePools(options?: BulkUpdatePoolsOptions): Promise<BulkUpdatePoolsResponse & BulkUpdatePoolsResponseNonNullableFields>;
2190
- export interface BulkUpdatePoolsOptions {
1864
+ interface BulkUpdatePoolsOptions {
2191
1865
  /**
2192
1866
  * Pools to update.
2193
1867
  * @minSize 1
@@ -2201,4 +1875,5 @@ export interface BulkUpdatePoolsOptions {
2201
1875
  */
2202
1876
  returnEntity?: boolean;
2203
1877
  }
2204
- export {};
1878
+
1879
+ export { type PoolEnded as $, type RateLimitedPolicyPeriodOneOf as A, type BulkCheckBenefitEligibilityOptions as B, type CheckBenefitEligibilityOptions as C, type Details as D, EligibilityCheckResultType as E, type FixedIntervalPolicy as F, type GetEligibleBenefitsOptions as G, type CustomPolicy as H, type ItemReference as I, type CreditConfiguration as J, type RolloverConfiguration as K, ListPoolsRequestType as L, type ExtendedFields as M, type ProgramDefinitionInfo as N, type PoolProgramInfo as O, type Pool as P, type PoolProvisioned as Q, type RedeemBenefitOptions as R, SortOrder as S, Type as T, type UpdatePool as U, type PoolRenewed as V, WeekDay as W, type BenefitRedeemed as X, type RedemptionDetails as Y, type PoolPaused as Z, type PoolResumed as _, type PoolsQueryBuilder as a, type ProvisionPoolsForProgramResponse as a$, type BenefitReserved as a0, type BenefitReservationCanceled as a1, type BenefitReservationReleased as a2, type PoolProvisionJobFinished as a3, type PoolStatusUpdateJobFinished as a4, type PoolStatusUpdateJobFinishedContextOneOf as a5, type PoolDefinitionAndProgramDefinition as a6, type ProgramInfo as a7, type CreatePoolRequest as a8, type CreatePoolResponse as a9, type ReleaseBenefitReservationRequest as aA, type ReleaseBenefitReservationResponse as aB, type CheckBenefitEligibilityRequest as aC, type EligibilityCheckResult as aD, type EligibilityCheckResultResultOneOf as aE, type EligibleBenefit as aF, type Eligible as aG, type BulkCheckBenefitEligibilityRequest as aH, type BenefitSelector as aI, type BulkEligibilityCheckResult as aJ, type GetEligibleBenefitsRequest as aK, type ListPoolsRequest as aL, type ByItemReference as aM, type ByItemReferenceFilter as aN, type Filter as aO, type FilterFilterOneOf as aP, type ListPoolsResponse as aQ, type PoolWithItems as aR, type BulkUpdatePoolsRequest as aS, type MaskedPool as aT, type BulkPoolResult as aU, type ItemMetadata as aV, type ApplicationError as aW, type BulkActionMetadata as aX, type ProvisionPoolsForProgramRequest as aY, type PoolDefinitionLookupId as aZ, type PoolDefinitionLookupIdIdOneOf as a_, type GetPoolRequest as aa, type GetPoolResponse as ab, type UpdatePoolRequest as ac, type UpdatePoolResponse as ad, type DeletePoolRequest as ae, type DeletePoolResponse as af, type QueryPoolsRequest as ag, type CursorQuery as ah, type CursorQueryPagingMethodOneOf as ai, type Sorting as aj, type CursorPaging as ak, type QueryPoolsResponse as al, type CursorPagingMetadata as am, type Cursors as an, type RedeemBenefitRequest as ao, type NotEnoughBalance as ap, type PolicyExpressionEvaluatedToFalse as aq, type FailureDetails as ar, type PoolNotActive as as, type PoolNotFound as at, type BenefitAlreadyRedeemed as au, type BenefitNotFound as av, type ReserveBenefitRequest as aw, type ReserveBenefitResponse as ax, type CancelBenefitReservationRequest as ay, type CancelBenefitReservationResponse as az, type RedeemBenefitResponse as b, type ProvisionPoolsForProgramResponseResultOneOf as b0, type SyncResult as b1, type AsyncResult as b2, type InvalidPoolDefinitionReference as b3, type RenewPoolsForProgramRequest as b4, type RenewPoolsForProgramResponse as b5, type UpdatePoolStatusRequest as b6, type UpdatePoolStatusRequestPoolSelectorOneOf as b7, type ByPoolDefinitionIdAndProgramDefinitionIdOptions as b8, type ByProgramIdOptions as b9, type UpdatePoolStatusResponse as ba, type CountNumberOfPoolsInProvisioningStatusRequest as bb, type CountNumberOfPoolsInProvisioningStatusResponse as bc, type DomainEvent as bd, type DomainEventBodyOneOf as be, type EntityCreatedEvent as bf, type RestoreInfo as bg, type EntityUpdatedEvent as bh, type EntityDeletedEvent as bi, type ActionEvent as bj, type MessageEnvelope as bk, type IdentificationData as bl, type IdentificationDataIdOneOf as bm, type PoolsQueryResult as bn, type CheckBenefitEligibilityResponse as c, type BulkCheckBenefitEligibilityResponse as d, type GetEligibleBenefitsResponse as e, type BulkUpdatePoolsOptions as f, type BulkUpdatePoolsResponse as g, PoolStatus as h, IdentityType as i, PolicyExpressionType as j, RateLimitedPolicyType as k, PoolOrigin as l, ProvisionPoolsForProgramResponseType as m, PoolSelectorType as n, WebhookIdentityType as o, type CommonIdentificationData as p, type CommonIdentificationDataIdOneOf as q, type Benefit as r, type PolicyExpression as s, type PolicyExpressionExpressionOneOf as t, type PolicyExpressionNot as u, type PolicyExpressionAnd as v, type PolicyExpressionOr as w, type Policy as x, type PolicyPolicyOneOf as y, type RateLimitedPolicy as z };