@wix/auto_sdk_benefit-programs_pool-definitions 1.0.9 → 1.0.11

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-definition-pool-definitions.universal.d.ts → benefit-programs-v1-pool-definition-pool-definitions.universal-C-P5ex9L.d.mts} +92 -393
  2. package/build/{internal/es/src/benefit-programs-v1-pool-definition-pool-definitions.universal.d.ts → benefit-programs-v1-pool-definition-pool-definitions.universal-C-P5ex9L.d.ts} +92 -393
  3. package/build/index.d.mts +127 -0
  4. package/build/index.d.ts +127 -0
  5. package/build/index.js +1050 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +1009 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/{cjs/src/benefit-programs-v1-pool-definition-pool-definitions.universal.d.ts → internal/benefit-programs-v1-pool-definition-pool-definitions.universal-C-P5ex9L.d.mts} +92 -393
  10. package/build/{es/src/benefit-programs-v1-pool-definition-pool-definitions.universal.d.ts → internal/benefit-programs-v1-pool-definition-pool-definitions.universal-C-P5ex9L.d.ts} +92 -393
  11. package/build/internal/index.d.mts +127 -0
  12. package/build/internal/index.d.ts +127 -0
  13. package/build/internal/index.js +1050 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +1009 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +490 -0
  18. package/build/internal/meta.d.ts +490 -0
  19. package/build/internal/meta.js +734 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +697 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +490 -0
  24. package/build/meta.d.ts +490 -0
  25. package/build/meta.js +734 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +697 -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-definition-pool-definitions.context.d.ts +0 -15
  40. package/build/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.context.js +0 -25
  41. package/build/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.context.js.map +0 -1
  42. package/build/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.http.d.ts +0 -51
  43. package/build/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.http.js +0 -524
  44. package/build/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.http.js.map +0 -1
  45. package/build/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.meta.d.ts +0 -29
  46. package/build/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.meta.js +0 -237
  47. package/build/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.meta.js.map +0 -1
  48. package/build/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.public.d.ts +0 -115
  49. package/build/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.public.js +0 -80
  50. package/build/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.public.js.map +0 -1
  51. package/build/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.types.d.ts +0 -908
  52. package/build/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.types.js +0 -81
  53. package/build/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.types.js.map +0 -1
  54. package/build/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.universal.js +0 -627
  55. package/build/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.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-definition-pool-definitions.context.d.ts +0 -15
  67. package/build/es/src/benefit-programs-v1-pool-definition-pool-definitions.context.js +0 -15
  68. package/build/es/src/benefit-programs-v1-pool-definition-pool-definitions.context.js.map +0 -1
  69. package/build/es/src/benefit-programs-v1-pool-definition-pool-definitions.http.d.ts +0 -51
  70. package/build/es/src/benefit-programs-v1-pool-definition-pool-definitions.http.js +0 -510
  71. package/build/es/src/benefit-programs-v1-pool-definition-pool-definitions.http.js.map +0 -1
  72. package/build/es/src/benefit-programs-v1-pool-definition-pool-definitions.meta.d.ts +0 -29
  73. package/build/es/src/benefit-programs-v1-pool-definition-pool-definitions.meta.js +0 -200
  74. package/build/es/src/benefit-programs-v1-pool-definition-pool-definitions.meta.js.map +0 -1
  75. package/build/es/src/benefit-programs-v1-pool-definition-pool-definitions.public.d.ts +0 -115
  76. package/build/es/src/benefit-programs-v1-pool-definition-pool-definitions.public.js +0 -59
  77. package/build/es/src/benefit-programs-v1-pool-definition-pool-definitions.public.js.map +0 -1
  78. package/build/es/src/benefit-programs-v1-pool-definition-pool-definitions.types.d.ts +0 -908
  79. package/build/es/src/benefit-programs-v1-pool-definition-pool-definitions.types.js +0 -78
  80. package/build/es/src/benefit-programs-v1-pool-definition-pool-definitions.types.js.map +0 -1
  81. package/build/es/src/benefit-programs-v1-pool-definition-pool-definitions.universal.js +0 -590
  82. package/build/es/src/benefit-programs-v1-pool-definition-pool-definitions.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-definition-pool-definitions.context.d.ts +0 -15
  93. package/build/internal/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.context.js +0 -25
  94. package/build/internal/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.context.js.map +0 -1
  95. package/build/internal/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.http.d.ts +0 -51
  96. package/build/internal/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.http.js +0 -524
  97. package/build/internal/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.http.js.map +0 -1
  98. package/build/internal/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.meta.d.ts +0 -29
  99. package/build/internal/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.meta.js +0 -237
  100. package/build/internal/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.meta.js.map +0 -1
  101. package/build/internal/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.public.d.ts +0 -115
  102. package/build/internal/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.public.js +0 -80
  103. package/build/internal/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.public.js.map +0 -1
  104. package/build/internal/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.types.d.ts +0 -908
  105. package/build/internal/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.types.js +0 -81
  106. package/build/internal/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.types.js.map +0 -1
  107. package/build/internal/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.universal.js +0 -627
  108. package/build/internal/cjs/src/benefit-programs-v1-pool-definition-pool-definitions.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-definition-pool-definitions.context.d.ts +0 -15
  119. package/build/internal/es/src/benefit-programs-v1-pool-definition-pool-definitions.context.js +0 -15
  120. package/build/internal/es/src/benefit-programs-v1-pool-definition-pool-definitions.context.js.map +0 -1
  121. package/build/internal/es/src/benefit-programs-v1-pool-definition-pool-definitions.http.d.ts +0 -51
  122. package/build/internal/es/src/benefit-programs-v1-pool-definition-pool-definitions.http.js +0 -510
  123. package/build/internal/es/src/benefit-programs-v1-pool-definition-pool-definitions.http.js.map +0 -1
  124. package/build/internal/es/src/benefit-programs-v1-pool-definition-pool-definitions.meta.d.ts +0 -29
  125. package/build/internal/es/src/benefit-programs-v1-pool-definition-pool-definitions.meta.js +0 -200
  126. package/build/internal/es/src/benefit-programs-v1-pool-definition-pool-definitions.meta.js.map +0 -1
  127. package/build/internal/es/src/benefit-programs-v1-pool-definition-pool-definitions.public.d.ts +0 -115
  128. package/build/internal/es/src/benefit-programs-v1-pool-definition-pool-definitions.public.js +0 -59
  129. package/build/internal/es/src/benefit-programs-v1-pool-definition-pool-definitions.public.js.map +0 -1
  130. package/build/internal/es/src/benefit-programs-v1-pool-definition-pool-definitions.types.d.ts +0 -908
  131. package/build/internal/es/src/benefit-programs-v1-pool-definition-pool-definitions.types.js +0 -78
  132. package/build/internal/es/src/benefit-programs-v1-pool-definition-pool-definitions.types.js.map +0 -1
  133. package/build/internal/es/src/benefit-programs-v1-pool-definition-pool-definitions.universal.js +0 -590
  134. package/build/internal/es/src/benefit-programs-v1-pool-definition-pool-definitions.universal.js.map +0 -1
@@ -1,4 +1,4 @@
1
- export interface PoolDefinition {
1
+ interface PoolDefinition {
2
2
  /**
3
3
  * Pool definition ID.
4
4
  * @format GUID
@@ -38,7 +38,7 @@ export interface PoolDefinition {
38
38
  /** Pool definition benefits and settings. */
39
39
  details?: Details;
40
40
  /**
41
- * Namespace for your app or site's benefit programs.
41
+ * 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.
42
42
  * @immutable
43
43
  * @readonly
44
44
  * @minLength 1
@@ -52,7 +52,7 @@ export interface PoolDefinition {
52
52
  */
53
53
  extendedFields?: ExtendedFields;
54
54
  }
55
- export interface Details {
55
+ interface Details {
56
56
  /**
57
57
  * List of benefits.
58
58
  * @maxSize 10
@@ -67,7 +67,7 @@ export interface Details {
67
67
  /** Additional information relating to this object. */
68
68
  additionalData?: Record<string, any> | null;
69
69
  }
70
- export interface Benefit {
70
+ interface Benefit {
71
71
  /**
72
72
  * Unique identifier for this benefit.
73
73
  *
@@ -106,7 +106,7 @@ export interface Benefit {
106
106
  */
107
107
  description?: string | null;
108
108
  }
109
- export interface PolicyExpression extends PolicyExpressionExpressionOneOf {
109
+ interface PolicyExpression extends PolicyExpressionExpressionOneOf {
110
110
  /** Benefits can be redeemed if the expression in this object is not fulfilled. */
111
111
  operatorNotOptions?: PolicyExpressionNot;
112
112
  /** Benefits can be redeemed if all the expression in this object's array are fulfilled. */
@@ -119,7 +119,7 @@ export interface PolicyExpression extends PolicyExpressionExpressionOneOf {
119
119
  type?: PolicyExpressionType;
120
120
  }
121
121
  /** @oneof */
122
- export interface PolicyExpressionExpressionOneOf {
122
+ interface PolicyExpressionExpressionOneOf {
123
123
  /** Benefits can be redeemed if the expression in this object is not fulfilled. */
124
124
  operatorNotOptions?: PolicyExpressionNot;
125
125
  /** Benefits can be redeemed if all the expression in this object's array are fulfilled. */
@@ -129,7 +129,7 @@ export interface PolicyExpressionExpressionOneOf {
129
129
  /** Defines when benefits can be redeemed or how many benefits can be redeemed in a specific time period. */
130
130
  policyOptions?: Policy;
131
131
  }
132
- export declare enum PolicyExpressionType {
132
+ declare enum PolicyExpressionType {
133
133
  UNKNOWN = "UNKNOWN",
134
134
  /** Use with `operatorNotOptions`. */
135
135
  OPERATOR_NOT = "OPERATOR_NOT",
@@ -140,11 +140,11 @@ export declare enum PolicyExpressionType {
140
140
  /** Use with `policyOptions`. */
141
141
  POLICY = "POLICY"
142
142
  }
143
- export interface PolicyExpressionNot {
143
+ interface PolicyExpressionNot {
144
144
  /** Policy expression. If this expression is not fulfilled, benefits can be redeemed. */
145
145
  expression?: PolicyExpression;
146
146
  }
147
- export interface PolicyExpressionAnd {
147
+ interface PolicyExpressionAnd {
148
148
  /**
149
149
  * Array of policy expressions. If all expressions are fulfilled, benefits can be redeemed.
150
150
  * @minSize 2
@@ -152,7 +152,7 @@ export interface PolicyExpressionAnd {
152
152
  */
153
153
  expressions?: PolicyExpression[];
154
154
  }
155
- export interface PolicyExpressionOr {
155
+ interface PolicyExpressionOr {
156
156
  /**
157
157
  * Array of policy expressions. If at least one expression is fulfilled, benefits can be redeemed.
158
158
  * @minSize 2
@@ -160,7 +160,7 @@ export interface PolicyExpressionOr {
160
160
  */
161
161
  expressions?: PolicyExpression[];
162
162
  }
163
- export interface Policy extends PolicyPolicyOneOf {
163
+ interface Policy extends PolicyPolicyOneOf {
164
164
  /**
165
165
  * Defines an interval during which the policy expression is fulfilled.
166
166
  *
@@ -175,7 +175,7 @@ export interface Policy extends PolicyPolicyOneOf {
175
175
  type?: Type;
176
176
  }
177
177
  /** @oneof */
178
- export interface PolicyPolicyOneOf {
178
+ interface PolicyPolicyOneOf {
179
179
  /**
180
180
  * Defines an interval during which the policy expression is fulfilled.
181
181
  *
@@ -187,7 +187,7 @@ export interface PolicyPolicyOneOf {
187
187
  /** Custom policy defined by a different app. */
188
188
  customOptions?: CustomPolicy;
189
189
  }
190
- export declare enum Type {
190
+ declare enum Type {
191
191
  /** Unknown policy type. */
192
192
  UNKNOWN = "UNKNOWN",
193
193
  /** Use with `fixedIntervalOptions`. */
@@ -197,7 +197,7 @@ export declare enum Type {
197
197
  /** Use with `customOptions`. */
198
198
  CUSTOM = "CUSTOM"
199
199
  }
200
- export interface FixedIntervalPolicy {
200
+ interface FixedIntervalPolicy {
201
201
  /** Weekday that this interval starts from. If this field is defined, then `toWeekDay` is required. */
202
202
  fromWeekDay?: WeekDay;
203
203
  /** Weekday that this interval ends at. If this field is defined, then `fromWeekDay` is required. */
@@ -223,7 +223,7 @@ export interface FixedIntervalPolicy {
223
223
  */
224
224
  toMinute?: number | null;
225
225
  }
226
- export declare enum WeekDay {
226
+ declare enum WeekDay {
227
227
  /** Unknown weekday. */
228
228
  UNKNOWN = "UNKNOWN",
229
229
  /** Monday. */
@@ -241,7 +241,7 @@ export declare enum WeekDay {
241
241
  /** Sunday. */
242
242
  SUNDAY = "SUNDAY"
243
243
  }
244
- export interface RateLimitedPolicy extends RateLimitedPolicyPeriodOneOf {
244
+ interface RateLimitedPolicy extends RateLimitedPolicyPeriodOneOf {
245
245
  /** Fixed interval used to limit benefit redemption. */
246
246
  fixedIntervalOptions?: FixedIntervalPolicy;
247
247
  /** Maximum number of times a benefit can be redeemed per specified time period. */
@@ -250,11 +250,11 @@ export interface RateLimitedPolicy extends RateLimitedPolicyPeriodOneOf {
250
250
  type?: RateLimitedPolicyType;
251
251
  }
252
252
  /** @oneof */
253
- export interface RateLimitedPolicyPeriodOneOf {
253
+ interface RateLimitedPolicyPeriodOneOf {
254
254
  /** Fixed interval used to limit benefit redemption. */
255
255
  fixedIntervalOptions?: FixedIntervalPolicy;
256
256
  }
257
- export declare enum RateLimitedPolicyType {
257
+ declare enum RateLimitedPolicyType {
258
258
  /** Unknown rate limit method. */
259
259
  UNKNOWN = "UNKNOWN",
260
260
  /** Time period is defined using `fixedIntervalOptions`. */
@@ -263,7 +263,7 @@ export declare enum RateLimitedPolicyType {
263
263
  PER_CYCLE = "PER_CYCLE"
264
264
  }
265
265
  /** Custom policy as implemented by the Entitlement Policy Provider */
266
- export interface CustomPolicy {
266
+ interface CustomPolicy {
267
267
  /**
268
268
  * Policy ID.
269
269
  * @format GUID
@@ -277,7 +277,7 @@ export interface CustomPolicy {
277
277
  /** Additional information for this custom policy. */
278
278
  additionalData?: Record<string, any> | null;
279
279
  }
280
- export interface CreditConfiguration {
280
+ interface CreditConfiguration {
281
281
  /**
282
282
  * Initial available amount for associated balances.
283
283
  * @decimalValue options { gte:0, maxScale:4 }
@@ -291,16 +291,16 @@ export interface CreditConfiguration {
291
291
  */
292
292
  unitDisplayName?: string | null;
293
293
  }
294
- export interface RolloverConfiguration {
295
- /** Whether unused credits rollover to a new cycle when a program renews. */
294
+ interface RolloverConfiguration {
295
+ /** Whether unused credits roll over to a new cycle when a program renews. */
296
296
  enabled?: boolean | null;
297
297
  /**
298
- * Maximum amount of credits that can rollover to the next cycle when a program renews.
298
+ * Maximum number of credits that can roll over to the next cycle when a program renews.
299
299
  * @decimalValue options { gte:0, maxScale:4 }
300
300
  */
301
301
  balanceCap?: string | null;
302
302
  }
303
- export interface ExtendedFields {
303
+ interface ExtendedFields {
304
304
  /**
305
305
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
306
306
  * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -311,7 +311,7 @@ export interface ExtendedFields {
311
311
  */
312
312
  namespaces?: Record<string, Record<string, any>>;
313
313
  }
314
- export interface PoolDefinitionAddedToProgramDefinition {
314
+ interface PoolDefinitionAddedToProgramDefinition {
315
315
  /** PoolDefinition that was added to the program definition */
316
316
  poolDefinition?: PoolDefinition;
317
317
  /**
@@ -322,7 +322,7 @@ export interface PoolDefinitionAddedToProgramDefinition {
322
322
  /** Type of cascade */
323
323
  cascadeType?: Cascade;
324
324
  }
325
- export declare enum Cascade {
325
+ declare enum Cascade {
326
326
  /** Unknown cascade. */
327
327
  UNKNOWN_CASCADE = "UNKNOWN_CASCADE",
328
328
  /** Changes are applied to existing programs and pools when they are next renewed. */
@@ -332,7 +332,7 @@ export declare enum Cascade {
332
332
  /** Changes are not applied to existing associated programs and pools. They are only applied to future programs and pools. */
333
333
  FUTURE_PROVISIONS = "FUTURE_PROVISIONS"
334
334
  }
335
- export interface PoolDefinitionRemovedFromProgramDefinition {
335
+ interface PoolDefinitionRemovedFromProgramDefinition {
336
336
  /** PoolDefinition that was removed from the program definition */
337
337
  poolDefinition?: PoolDefinition;
338
338
  /**
@@ -344,18 +344,18 @@ export interface PoolDefinitionRemovedFromProgramDefinition {
344
344
  cascadeType?: Cascade;
345
345
  }
346
346
  /** This event is needed to support legacy benefit notification event. Should be only consumed in the proxy. */
347
- export interface PoolDefinitionUpdatedProxySupport {
347
+ interface PoolDefinitionUpdatedProxySupport {
348
348
  /** PoolDefinition after the update */
349
349
  currentPoolDefinition?: PoolDefinition;
350
350
  /** PoolDefinition before the update */
351
351
  previousPoolDefinition?: PoolDefinition;
352
352
  }
353
353
  /** This event is needed to support legacy benefit notification event. Should be only consumed in the proxy. */
354
- export interface PoolDefinitionDeletedProxySupport {
354
+ interface PoolDefinitionDeletedProxySupport {
355
355
  /** PoolDefinition which was deleted */
356
356
  deletedPoolDefinition?: PoolDefinition;
357
357
  }
358
- export interface CreatePoolDefinitionRequest {
358
+ interface CreatePoolDefinitionRequest {
359
359
  /** Pool definition to create. */
360
360
  poolDefinition: PoolDefinition;
361
361
  /**
@@ -365,11 +365,11 @@ export interface CreatePoolDefinitionRequest {
365
365
  */
366
366
  cascade?: Cascade;
367
367
  }
368
- export interface CreatePoolDefinitionResponse {
368
+ interface CreatePoolDefinitionResponse {
369
369
  /** Created pool definition. */
370
370
  poolDefinition?: PoolDefinition;
371
371
  }
372
- export interface BulkCreatePoolDefinitionsRequest {
372
+ interface BulkCreatePoolDefinitionsRequest {
373
373
  /**
374
374
  * Pool definitions to create.
375
375
  * @minSize 1
@@ -389,7 +389,7 @@ export interface BulkCreatePoolDefinitionsRequest {
389
389
  */
390
390
  returnEntity?: boolean;
391
391
  }
392
- export interface BulkCreatePoolDefinitionsResponse {
392
+ interface BulkCreatePoolDefinitionsResponse {
393
393
  /**
394
394
  * List of created pool definitions and associated metadata.
395
395
  * @minSize 1
@@ -399,13 +399,13 @@ export interface BulkCreatePoolDefinitionsResponse {
399
399
  /** Bulk action metadata. */
400
400
  bulkActionMetadata?: BulkActionMetadata;
401
401
  }
402
- export interface BulkPoolDefinitionResult {
402
+ interface BulkPoolDefinitionResult {
403
403
  /** Item metadata. */
404
404
  itemMetadata?: ItemMetadata;
405
405
  /** Pool definition. */
406
406
  poolDefinition?: PoolDefinition;
407
407
  }
408
- export interface ItemMetadata {
408
+ interface ItemMetadata {
409
409
  /**
410
410
  * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
411
411
  * @format GUID
@@ -418,7 +418,7 @@ export interface ItemMetadata {
418
418
  /** Details about the error in case of failure. */
419
419
  error?: ApplicationError;
420
420
  }
421
- export interface ApplicationError {
421
+ interface ApplicationError {
422
422
  /** Error code. */
423
423
  code?: string;
424
424
  /** Description of the error. */
@@ -426,7 +426,7 @@ export interface ApplicationError {
426
426
  /** Data related to the error. */
427
427
  data?: Record<string, any> | null;
428
428
  }
429
- export interface BulkActionMetadata {
429
+ interface BulkActionMetadata {
430
430
  /** Number of items that were successfully processed. */
431
431
  totalSuccesses?: number;
432
432
  /** Number of items that couldn't be processed. */
@@ -434,17 +434,17 @@ export interface BulkActionMetadata {
434
434
  /** Number of failures without details because detailed failure threshold was exceeded. */
435
435
  undetailedFailures?: number;
436
436
  }
437
- export interface UpdatePoolDefinitionRequest {
437
+ interface UpdatePoolDefinitionRequest {
438
438
  /** Pool definition to update. */
439
439
  poolDefinition: PoolDefinition;
440
440
  /** *Required.** Determines when the changes to this pool definition and program definitions containing it will be applied to associated programs and pools. */
441
441
  cascade?: Cascade;
442
442
  }
443
- export interface UpdatePoolDefinitionResponse {
443
+ interface UpdatePoolDefinitionResponse {
444
444
  /** Updated pool definition. */
445
445
  poolDefinition?: PoolDefinition;
446
446
  }
447
- export interface BulkUpdatePoolDefinitionsRequest {
447
+ interface BulkUpdatePoolDefinitionsRequest {
448
448
  /**
449
449
  * Pool definitions to update.
450
450
  * @minSize 1
@@ -460,13 +460,13 @@ export interface BulkUpdatePoolDefinitionsRequest {
460
460
  */
461
461
  returnEntity?: boolean;
462
462
  }
463
- export interface MaskedPoolDefinition {
463
+ interface MaskedPoolDefinition {
464
464
  /** Pool definition to update. */
465
465
  poolDefinition?: PoolDefinition;
466
466
  /** Explicit list of fields to update. */
467
467
  fieldMask?: string[];
468
468
  }
469
- export interface BulkUpdatePoolDefinitionsResponse {
469
+ interface BulkUpdatePoolDefinitionsResponse {
470
470
  /**
471
471
  * List of updated pool definitions and associated metadata.
472
472
  * @minSize 1
@@ -476,7 +476,7 @@ export interface BulkUpdatePoolDefinitionsResponse {
476
476
  /** Bulk action metadata. */
477
477
  bulkActionMetadata?: BulkActionMetadata;
478
478
  }
479
- export interface DeletePoolDefinitionRequest {
479
+ interface DeletePoolDefinitionRequest {
480
480
  /**
481
481
  * ID of the pool definition to delete.
482
482
  * @format GUID
@@ -485,9 +485,9 @@ export interface DeletePoolDefinitionRequest {
485
485
  /** *Required**. Determines when the changes to this pool definition the program definitions containing it will be applied to associated programs and pools. */
486
486
  cascade?: Cascade;
487
487
  }
488
- export interface DeletePoolDefinitionResponse {
488
+ interface DeletePoolDefinitionResponse {
489
489
  }
490
- export interface BulkDeletePoolDefinitionsRequest {
490
+ interface BulkDeletePoolDefinitionsRequest {
491
491
  /**
492
492
  * List of IDs of the pool definitions to delete.
493
493
  * @minSize 1
@@ -498,7 +498,7 @@ export interface BulkDeletePoolDefinitionsRequest {
498
498
  /** *Required**. Determines when the changes to these pool definitions the program definitions containing it will be applied to associated programs and pools. */
499
499
  cascade?: Cascade;
500
500
  }
501
- export interface BulkDeletePoolDefinitionsResponse {
501
+ interface BulkDeletePoolDefinitionsResponse {
502
502
  /**
503
503
  * List of deleted pool definitions and associated metadata.
504
504
  * @minSize 1
@@ -508,22 +508,22 @@ export interface BulkDeletePoolDefinitionsResponse {
508
508
  /** Bulk action metadata. */
509
509
  bulkActionMetadata?: BulkActionMetadata;
510
510
  }
511
- export interface GetPoolDefinitionRequest {
511
+ interface GetPoolDefinitionRequest {
512
512
  /**
513
513
  * ID of the pool definition to retrieve.
514
514
  * @format GUID
515
515
  */
516
516
  poolDefinitionId: string;
517
517
  }
518
- export interface GetPoolDefinitionResponse {
518
+ interface GetPoolDefinitionResponse {
519
519
  /** Retrieved pool definition. */
520
520
  poolDefinition?: PoolDefinition;
521
521
  }
522
- export interface QueryPoolDefinitionsRequest {
522
+ interface QueryPoolDefinitionsRequest {
523
523
  /** Filter, sort, and paging to apply to the query. */
524
524
  query?: CursorQuery;
525
525
  }
526
- export interface CursorQuery extends CursorQueryPagingMethodOneOf {
526
+ interface CursorQuery extends CursorQueryPagingMethodOneOf {
527
527
  /** 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`. */
528
528
  cursorPaging?: CursorPaging;
529
529
  /**
@@ -539,11 +539,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
539
539
  sort?: Sorting[];
540
540
  }
541
541
  /** @oneof */
542
- export interface CursorQueryPagingMethodOneOf {
542
+ interface CursorQueryPagingMethodOneOf {
543
543
  /** 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`. */
544
544
  cursorPaging?: CursorPaging;
545
545
  }
546
- export interface Sorting {
546
+ interface Sorting {
547
547
  /**
548
548
  * Field to sort by.
549
549
  * @maxLength 512
@@ -556,13 +556,13 @@ export interface Sorting {
556
556
  */
557
557
  order?: SortOrder;
558
558
  }
559
- export declare enum SortOrder {
559
+ declare enum SortOrder {
560
560
  /** Ascending sort order. */
561
561
  ASC = "ASC",
562
562
  /** Descending sort order. */
563
563
  DESC = "DESC"
564
564
  }
565
- export interface CursorPaging {
565
+ interface CursorPaging {
566
566
  /**
567
567
  * Maximum number of items to return.
568
568
  * @max 100
@@ -577,13 +577,13 @@ export interface CursorPaging {
577
577
  */
578
578
  cursor?: string | null;
579
579
  }
580
- export interface QueryPoolDefinitionsResponse {
580
+ interface QueryPoolDefinitionsResponse {
581
581
  /** List of retrieved pool definitions. */
582
582
  poolDefinitions?: PoolDefinition[];
583
583
  /** Metadata for the paginated results. */
584
584
  metadata?: CursorPagingMetadata;
585
585
  }
586
- export interface CursorPagingMetadata {
586
+ interface CursorPagingMetadata {
587
587
  /** Number of items returned in the response. */
588
588
  count?: number | null;
589
589
  /** Cursor strings that point to the next page, previous page, or both. */
@@ -596,7 +596,7 @@ export interface CursorPagingMetadata {
596
596
  */
597
597
  hasNext?: boolean | null;
598
598
  }
599
- export interface Cursors {
599
+ interface Cursors {
600
600
  /**
601
601
  * Cursor string pointing to the next page in the list of results.
602
602
  * @maxLength 16000
@@ -608,7 +608,7 @@ export interface Cursors {
608
608
  */
609
609
  prev?: string | null;
610
610
  }
611
- export interface AddPoolDefinitionToProgramDefinitionRequest {
611
+ interface AddPoolDefinitionToProgramDefinitionRequest {
612
612
  /**
613
613
  * ID of the pool definition to add to the program definition.
614
614
  * @format GUID
@@ -622,11 +622,11 @@ export interface AddPoolDefinitionToProgramDefinitionRequest {
622
622
  /** Determines when the changes to this program definition and pool definition will be applied to associated programs and pools. */
623
623
  cascade: Cascade;
624
624
  }
625
- export interface AddPoolDefinitionToProgramDefinitionResponse {
625
+ interface AddPoolDefinitionToProgramDefinitionResponse {
626
626
  /** Updated pool definition. */
627
627
  poolDefinition?: PoolDefinition;
628
628
  }
629
- export interface RemovePoolDefinitionFromProgramDefinitionRequest {
629
+ interface RemovePoolDefinitionFromProgramDefinitionRequest {
630
630
  /**
631
631
  * ID of the pool definition to remove from the program definition.
632
632
  * @format GUID
@@ -640,28 +640,28 @@ export interface RemovePoolDefinitionFromProgramDefinitionRequest {
640
640
  /** Determines when the changes to this program definition and pool definition will be applied to associated programs and pools. */
641
641
  cascade: Cascade;
642
642
  }
643
- export interface RemovePoolDefinitionFromProgramDefinitionResponse {
643
+ interface RemovePoolDefinitionFromProgramDefinitionResponse {
644
644
  /** Updated pool definition. */
645
645
  poolDefinition?: PoolDefinition;
646
646
  }
647
- export interface FindPoolDefinitionsByProgramDefinitionRequest {
647
+ interface FindPoolDefinitionsByProgramDefinitionRequest {
648
648
  /**
649
649
  * ID of the program definition to retrieve its pool definitions.
650
650
  * @format GUID
651
651
  */
652
652
  programDefinitionId: string;
653
653
  /**
654
- * Namespace for your app or site's benefit programs.
654
+ * 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.
655
655
  * @minLength 1
656
656
  * @maxLength 50
657
657
  */
658
658
  namespace: string;
659
659
  }
660
- export interface FindPoolDefinitionsByProgramDefinitionResponse {
660
+ interface FindPoolDefinitionsByProgramDefinitionResponse {
661
661
  /** Retrieved pool definitions. */
662
662
  poolDefinitions?: PoolDefinition[];
663
663
  }
664
- export interface DomainEvent extends DomainEventBodyOneOf {
664
+ interface DomainEvent extends DomainEventBodyOneOf {
665
665
  createdEvent?: EntityCreatedEvent;
666
666
  updatedEvent?: EntityUpdatedEvent;
667
667
  deletedEvent?: EntityDeletedEvent;
@@ -704,19 +704,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
704
704
  entityEventSequence?: string | null;
705
705
  }
706
706
  /** @oneof */
707
- export interface DomainEventBodyOneOf {
707
+ interface DomainEventBodyOneOf {
708
708
  createdEvent?: EntityCreatedEvent;
709
709
  updatedEvent?: EntityUpdatedEvent;
710
710
  deletedEvent?: EntityDeletedEvent;
711
711
  actionEvent?: ActionEvent;
712
712
  }
713
- export interface EntityCreatedEvent {
713
+ interface EntityCreatedEvent {
714
714
  entity?: string;
715
715
  }
716
- export interface RestoreInfo {
716
+ interface RestoreInfo {
717
717
  deletedDate?: Date | null;
718
718
  }
719
- export interface EntityUpdatedEvent {
719
+ interface EntityUpdatedEvent {
720
720
  /**
721
721
  * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
722
722
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
@@ -724,14 +724,14 @@ export interface EntityUpdatedEvent {
724
724
  */
725
725
  currentEntity?: string;
726
726
  }
727
- export interface EntityDeletedEvent {
727
+ interface EntityDeletedEvent {
728
728
  /** Entity that was deleted */
729
729
  deletedEntity?: string | null;
730
730
  }
731
- export interface ActionEvent {
731
+ interface ActionEvent {
732
732
  body?: string;
733
733
  }
734
- export interface MessageEnvelope {
734
+ interface MessageEnvelope {
735
735
  /**
736
736
  * App instance ID.
737
737
  * @format GUID
@@ -747,7 +747,7 @@ export interface MessageEnvelope {
747
747
  /** Stringify payload. */
748
748
  data?: string;
749
749
  }
750
- export interface IdentificationData extends IdentificationDataIdOneOf {
750
+ interface IdentificationData extends IdentificationDataIdOneOf {
751
751
  /**
752
752
  * ID of a site visitor that has not logged in to the site.
753
753
  * @format GUID
@@ -772,7 +772,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
772
772
  identityType?: WebhookIdentityType;
773
773
  }
774
774
  /** @oneof */
775
- export interface IdentificationDataIdOneOf {
775
+ interface IdentificationDataIdOneOf {
776
776
  /**
777
777
  * ID of a site visitor that has not logged in to the site.
778
778
  * @format GUID
@@ -794,135 +794,14 @@ export interface IdentificationDataIdOneOf {
794
794
  */
795
795
  appId?: string;
796
796
  }
797
- export declare enum WebhookIdentityType {
797
+ declare enum WebhookIdentityType {
798
798
  UNKNOWN = "UNKNOWN",
799
799
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
800
800
  MEMBER = "MEMBER",
801
801
  WIX_USER = "WIX_USER",
802
802
  APP = "APP"
803
803
  }
804
- interface PolicyExpressionNotNonNullableFields {
805
- expression?: PolicyExpressionNonNullableFields;
806
- }
807
- interface PolicyExpressionAndNonNullableFields {
808
- expressions: PolicyExpressionNonNullableFields[];
809
- }
810
- interface PolicyExpressionOrNonNullableFields {
811
- expressions: PolicyExpressionNonNullableFields[];
812
- }
813
- interface FixedIntervalPolicyNonNullableFields {
814
- fromWeekDay: WeekDay;
815
- toWeekDay: WeekDay;
816
- }
817
- interface RateLimitedPolicyNonNullableFields {
818
- fixedIntervalOptions?: FixedIntervalPolicyNonNullableFields;
819
- times: number;
820
- type: RateLimitedPolicyType;
821
- }
822
- interface CustomPolicyNonNullableFields {
823
- _id: string;
824
- }
825
- interface PolicyNonNullableFields {
826
- fixedIntervalOptions?: FixedIntervalPolicyNonNullableFields;
827
- rateLimitedOptions?: RateLimitedPolicyNonNullableFields;
828
- customOptions?: CustomPolicyNonNullableFields;
829
- type: Type;
830
- }
831
- interface PolicyExpressionNonNullableFields {
832
- operatorNotOptions?: PolicyExpressionNotNonNullableFields;
833
- operatorAndOptions?: PolicyExpressionAndNonNullableFields;
834
- operatorOrOptions?: PolicyExpressionOrNonNullableFields;
835
- policyOptions?: PolicyNonNullableFields;
836
- type: PolicyExpressionType;
837
- }
838
- interface BenefitNonNullableFields {
839
- benefitKey: string;
840
- policyExpression?: PolicyExpressionNonNullableFields;
841
- }
842
- interface CreditConfigurationNonNullableFields {
843
- amount: string;
844
- }
845
- interface DetailsNonNullableFields {
846
- benefits: BenefitNonNullableFields[];
847
- creditConfiguration?: CreditConfigurationNonNullableFields;
848
- policyExpression?: PolicyExpressionNonNullableFields;
849
- }
850
- export interface PoolDefinitionNonNullableFields {
851
- displayName: string;
852
- programDefinitionIds: string[];
853
- details?: DetailsNonNullableFields;
854
- }
855
- export interface CreatePoolDefinitionResponseNonNullableFields {
856
- poolDefinition?: PoolDefinitionNonNullableFields;
857
- }
858
- interface ApplicationErrorNonNullableFields {
859
- code: string;
860
- description: string;
861
- }
862
- interface ItemMetadataNonNullableFields {
863
- originalIndex: number;
864
- success: boolean;
865
- error?: ApplicationErrorNonNullableFields;
866
- }
867
- interface BulkPoolDefinitionResultNonNullableFields {
868
- itemMetadata?: ItemMetadataNonNullableFields;
869
- poolDefinition?: PoolDefinitionNonNullableFields;
870
- }
871
- interface BulkActionMetadataNonNullableFields {
872
- totalSuccesses: number;
873
- totalFailures: number;
874
- undetailedFailures: number;
875
- }
876
- export interface BulkCreatePoolDefinitionsResponseNonNullableFields {
877
- results: BulkPoolDefinitionResultNonNullableFields[];
878
- bulkActionMetadata?: BulkActionMetadataNonNullableFields;
879
- }
880
- export interface UpdatePoolDefinitionResponseNonNullableFields {
881
- poolDefinition?: PoolDefinitionNonNullableFields;
882
- }
883
- export interface BulkUpdatePoolDefinitionsResponseNonNullableFields {
884
- results: BulkPoolDefinitionResultNonNullableFields[];
885
- bulkActionMetadata?: BulkActionMetadataNonNullableFields;
886
- }
887
- export interface BulkDeletePoolDefinitionsResponseNonNullableFields {
888
- results: BulkPoolDefinitionResultNonNullableFields[];
889
- bulkActionMetadata?: BulkActionMetadataNonNullableFields;
890
- }
891
- export interface GetPoolDefinitionResponseNonNullableFields {
892
- poolDefinition?: PoolDefinitionNonNullableFields;
893
- }
894
- export interface QueryPoolDefinitionsResponseNonNullableFields {
895
- poolDefinitions: PoolDefinitionNonNullableFields[];
896
- }
897
- export interface AddPoolDefinitionToProgramDefinitionResponseNonNullableFields {
898
- poolDefinition?: PoolDefinitionNonNullableFields;
899
- }
900
- export interface RemovePoolDefinitionFromProgramDefinitionResponseNonNullableFields {
901
- poolDefinition?: PoolDefinitionNonNullableFields;
902
- }
903
- export interface FindPoolDefinitionsByProgramDefinitionResponseNonNullableFields {
904
- poolDefinitions: PoolDefinitionNonNullableFields[];
905
- }
906
- /**
907
- * Creates a pool definition.
908
- * @param poolDefinition - Pool definition to create.
909
- * @public
910
- * @documentationMaturity preview
911
- * @requiredField poolDefinition
912
- * @requiredField poolDefinition.details
913
- * @requiredField poolDefinition.details.benefits
914
- * @requiredField poolDefinition.details.benefits.benefitKey
915
- * @requiredField poolDefinition.details.benefits.providerAppId
916
- * @requiredField poolDefinition.namespace
917
- * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_CREATE
918
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
919
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
920
- * @applicableIdentity APP
921
- * @returns Created pool definition.
922
- * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.CreatePoolDefinition
923
- */
924
- export declare function createPoolDefinition(poolDefinition: PoolDefinition, options?: CreatePoolDefinitionOptions): Promise<PoolDefinition & PoolDefinitionNonNullableFields>;
925
- export interface CreatePoolDefinitionOptions {
804
+ interface CreatePoolDefinitionOptions {
926
805
  /**
927
806
  * Determines when the changes to the program definitions containing this pool definition will be applied to associated programs.
928
807
  *
@@ -930,25 +809,7 @@ export interface CreatePoolDefinitionOptions {
930
809
  */
931
810
  cascade?: Cascade;
932
811
  }
933
- /**
934
- * Creates pool definitions.
935
- * @param poolDefinitions - Pool definitions to create.
936
- * @public
937
- * @documentationMaturity preview
938
- * @requiredField poolDefinitions
939
- * @requiredField poolDefinitions.details
940
- * @requiredField poolDefinitions.details.benefits
941
- * @requiredField poolDefinitions.details.benefits.benefitKey
942
- * @requiredField poolDefinitions.details.benefits.providerAppId
943
- * @requiredField poolDefinitions.namespace
944
- * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_CREATE
945
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
946
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
947
- * @applicableIdentity APP
948
- * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.BulkCreatePoolDefinitions
949
- */
950
- export declare function bulkCreatePoolDefinitions(poolDefinitions: PoolDefinition[], options?: BulkCreatePoolDefinitionsOptions): Promise<BulkCreatePoolDefinitionsResponse & BulkCreatePoolDefinitionsResponseNonNullableFields>;
951
- export interface BulkCreatePoolDefinitionsOptions {
812
+ interface BulkCreatePoolDefinitionsOptions {
952
813
  /**
953
814
  * Determines when the changes to the program definitions containing these pool definitions will be applied to associated programs.
954
815
  *
@@ -962,29 +823,7 @@ export interface BulkCreatePoolDefinitionsOptions {
962
823
  */
963
824
  returnEntity?: boolean;
964
825
  }
965
- /**
966
- * Updates a pool definition.
967
- *
968
- * Each time the pool definition is updated,
969
- * `revision` increments by 1.
970
- * The current `revision` must be passed when updating the pool definition.
971
- * This ensures you're working with the latest pool definition
972
- * and prevents unintended overwrites.
973
- * @param _id - Pool definition ID.
974
- * @public
975
- * @documentationMaturity preview
976
- * @requiredField _id
977
- * @requiredField poolDefinition
978
- * @requiredField poolDefinition.revision
979
- * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_UPDATE
980
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
981
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
982
- * @applicableIdentity APP
983
- * @returns Updated pool definition.
984
- * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.UpdatePoolDefinition
985
- */
986
- export declare function updatePoolDefinition(_id: string | null, poolDefinition: UpdatePoolDefinition, options?: UpdatePoolDefinitionOptions): Promise<PoolDefinition & PoolDefinitionNonNullableFields>;
987
- export interface UpdatePoolDefinition {
826
+ interface UpdatePoolDefinition {
988
827
  /**
989
828
  * Pool definition ID.
990
829
  * @format GUID
@@ -1024,7 +863,7 @@ export interface UpdatePoolDefinition {
1024
863
  /** Pool definition benefits and settings. */
1025
864
  details?: Details;
1026
865
  /**
1027
- * Namespace for your app or site's benefit programs.
866
+ * 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.
1028
867
  * @immutable
1029
868
  * @readonly
1030
869
  * @minLength 1
@@ -1038,25 +877,11 @@ export interface UpdatePoolDefinition {
1038
877
  */
1039
878
  extendedFields?: ExtendedFields;
1040
879
  }
1041
- export interface UpdatePoolDefinitionOptions {
880
+ interface UpdatePoolDefinitionOptions {
1042
881
  /** Required.** Determines when the changes to this pool definition and program definitions containing it will be applied to associated programs and pools. */
1043
882
  cascade?: Cascade;
1044
883
  }
1045
- /**
1046
- * Updates pool definitions.
1047
- * @public
1048
- * @documentationMaturity preview
1049
- * @requiredField options.poolDefinitions.poolDefinition
1050
- * @requiredField options.poolDefinitions.poolDefinition._id
1051
- * @requiredField options.poolDefinitions.poolDefinition.revision
1052
- * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_UPDATE
1053
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
1054
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
1055
- * @applicableIdentity APP
1056
- * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.BulkUpdatePoolDefinitions
1057
- */
1058
- export declare function bulkUpdatePoolDefinitions(options?: BulkUpdatePoolDefinitionsOptions): Promise<BulkUpdatePoolDefinitionsResponse & BulkUpdatePoolDefinitionsResponseNonNullableFields>;
1059
- export interface BulkUpdatePoolDefinitionsOptions {
884
+ interface BulkUpdatePoolDefinitionsOptions {
1060
885
  /**
1061
886
  * Pool definitions to update.
1062
887
  * @minSize 1
@@ -1072,85 +897,14 @@ export interface BulkUpdatePoolDefinitionsOptions {
1072
897
  */
1073
898
  returnEntity?: boolean;
1074
899
  }
1075
- /**
1076
- * Deletes a pool definition.
1077
- * @param poolDefinitionId - ID of the pool definition to delete.
1078
- * @public
1079
- * @documentationMaturity preview
1080
- * @requiredField poolDefinitionId
1081
- * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_DELETE
1082
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
1083
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
1084
- * @applicableIdentity APP
1085
- * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.DeletePoolDefinition
1086
- */
1087
- export declare function deletePoolDefinition(poolDefinitionId: string, options?: DeletePoolDefinitionOptions): Promise<void>;
1088
- export interface DeletePoolDefinitionOptions {
900
+ interface DeletePoolDefinitionOptions {
1089
901
  /** Required**. Determines when the changes to this pool definition the program definitions containing it will be applied to associated programs and pools. */
1090
902
  cascade?: Cascade;
1091
903
  }
1092
- /**
1093
- * Deletes pool definitions.
1094
- * @param poolDefinitionIds - List of IDs of the pool definitions to delete.
1095
- * @public
1096
- * @documentationMaturity preview
1097
- * @requiredField poolDefinitionIds
1098
- * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_DELETE
1099
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
1100
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
1101
- * @applicableIdentity APP
1102
- * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.BulkDeletePoolDefinitions
1103
- */
1104
- export declare function bulkDeletePoolDefinitions(poolDefinitionIds: string[], options?: BulkDeletePoolDefinitionsOptions): Promise<BulkDeletePoolDefinitionsResponse & BulkDeletePoolDefinitionsResponseNonNullableFields>;
1105
- export interface BulkDeletePoolDefinitionsOptions {
904
+ interface BulkDeletePoolDefinitionsOptions {
1106
905
  /** Required**. Determines when the changes to these pool definitions the program definitions containing it will be applied to associated programs and pools. */
1107
906
  cascade?: Cascade;
1108
907
  }
1109
- /**
1110
- * Retrieves a pool definition.
1111
- * @param poolDefinitionId - ID of the pool definition to retrieve.
1112
- * @public
1113
- * @documentationMaturity preview
1114
- * @requiredField poolDefinitionId
1115
- * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_READ
1116
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
1117
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
1118
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
1119
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
1120
- * @permissionScope Manage Events
1121
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1122
- * @applicableIdentity APP
1123
- * @applicableIdentity VISITOR
1124
- * @returns Retrieved pool definition.
1125
- * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.GetPoolDefinition
1126
- */
1127
- export declare function getPoolDefinition(poolDefinitionId: string): Promise<PoolDefinition & PoolDefinitionNonNullableFields>;
1128
- /**
1129
- * Creates a query to retrieve a list of pool definitions.
1130
- *
1131
- * The Query Pool Definitions method builds a query to retrieve a list of pool definitions and returns a `PoolDefinitionsQueryBuilder` object.
1132
- *
1133
- * The returned object contains the query definition, which is used to run the query using the `find()` method.
1134
- *
1135
- * You can refine the query by chaining `PoolDefinitionsQueryBuilder` methods onto the query. `PoolDefinitionsQueryBuilder` methods enable you to filter, sort, and control the results that Query Pool Definitions returns.
1136
- *
1137
- * Query Pool Definitions has a default paging limit of 50, which you can override.
1138
- *
1139
- * For a full description of the item object, see the object returned for the `items` property in `PoolDefinitionsQueryResult`.
1140
- * @public
1141
- * @documentationMaturity preview
1142
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
1143
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
1144
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
1145
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
1146
- * @permissionScope Manage Events
1147
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1148
- * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_READ
1149
- * @applicableIdentity APP
1150
- * @applicableIdentity VISITOR
1151
- * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.QueryPoolDefinitions
1152
- */
1153
- export declare function queryPoolDefinitions(): PoolDefinitionsQueryBuilder;
1154
908
  interface QueryCursorResult {
1155
909
  cursors: Cursors;
1156
910
  hasNext: () => boolean;
@@ -1158,13 +912,13 @@ interface QueryCursorResult {
1158
912
  length: number;
1159
913
  pageSize: number;
1160
914
  }
1161
- export interface PoolDefinitionsQueryResult extends QueryCursorResult {
915
+ interface PoolDefinitionsQueryResult extends QueryCursorResult {
1162
916
  items: PoolDefinition[];
1163
917
  query: PoolDefinitionsQueryBuilder;
1164
918
  next: () => Promise<PoolDefinitionsQueryResult>;
1165
919
  prev: () => Promise<PoolDefinitionsQueryResult>;
1166
920
  }
1167
- export interface PoolDefinitionsQueryBuilder {
921
+ interface PoolDefinitionsQueryBuilder {
1168
922
  /** @param propertyName - Property whose value is compared with `value`.
1169
923
  * @param value - Value to compare against.
1170
924
  * @documentationMaturity preview
@@ -1233,25 +987,7 @@ export interface PoolDefinitionsQueryBuilder {
1233
987
  /** @documentationMaturity preview */
1234
988
  find: () => Promise<PoolDefinitionsQueryResult>;
1235
989
  }
1236
- /**
1237
- * Adds a pool definition to a program definition.
1238
- *
1239
- * Pool definitions can be contained by multiple program definitions, so this doesn't affect other program definitions that contain this pool definition.
1240
- * @param poolDefinitionId - ID of the pool definition to add to the program definition.
1241
- * @public
1242
- * @documentationMaturity preview
1243
- * @requiredField options
1244
- * @requiredField options.cascade
1245
- * @requiredField options.programDefinitionId
1246
- * @requiredField poolDefinitionId
1247
- * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_UPDATE
1248
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
1249
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
1250
- * @applicableIdentity APP
1251
- * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.AddPoolDefinitionToProgramDefinition
1252
- */
1253
- export declare function addPoolDefinitionToProgramDefinition(poolDefinitionId: string, options: AddPoolDefinitionToProgramDefinitionOptions): Promise<AddPoolDefinitionToProgramDefinitionResponse & AddPoolDefinitionToProgramDefinitionResponseNonNullableFields>;
1254
- export interface AddPoolDefinitionToProgramDefinitionOptions {
990
+ interface AddPoolDefinitionToProgramDefinitionOptions {
1255
991
  /**
1256
992
  * ID of the program definition to add the pool definition to.
1257
993
  * @format GUID
@@ -1260,25 +996,7 @@ export interface AddPoolDefinitionToProgramDefinitionOptions {
1260
996
  /** Determines when the changes to this program definition and pool definition will be applied to associated programs and pools. */
1261
997
  cascade: Cascade;
1262
998
  }
1263
- /**
1264
- * Removes a pool definition from a program definition.
1265
- *
1266
- * Pool definitions don't need to be contained by a program definition, so this doesn't affect the usability of this pool definition.
1267
- * @param poolDefinitionId - ID of the pool definition to remove from the program definition.
1268
- * @public
1269
- * @documentationMaturity preview
1270
- * @requiredField options
1271
- * @requiredField options.cascade
1272
- * @requiredField options.programDefinitionId
1273
- * @requiredField poolDefinitionId
1274
- * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_UPDATE
1275
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
1276
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
1277
- * @applicableIdentity APP
1278
- * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.RemovePoolDefinitionFromProgramDefinition
1279
- */
1280
- export declare function removePoolDefinitionFromProgramDefinition(poolDefinitionId: string, options: RemovePoolDefinitionFromProgramDefinitionOptions): Promise<RemovePoolDefinitionFromProgramDefinitionResponse & RemovePoolDefinitionFromProgramDefinitionResponseNonNullableFields>;
1281
- export interface RemovePoolDefinitionFromProgramDefinitionOptions {
999
+ interface RemovePoolDefinitionFromProgramDefinitionOptions {
1282
1000
  /**
1283
1001
  * ID of the program definition to remove the pool definition from.
1284
1002
  * @format GUID
@@ -1287,32 +1005,13 @@ export interface RemovePoolDefinitionFromProgramDefinitionOptions {
1287
1005
  /** Determines when the changes to this program definition and pool definition will be applied to associated programs and pools. */
1288
1006
  cascade: Cascade;
1289
1007
  }
1290
- /**
1291
- * Retrieve all a program definition's pool definitions.
1292
- * @param programDefinitionId - ID of the program definition to retrieve its pool definitions.
1293
- * @public
1294
- * @documentationMaturity preview
1295
- * @requiredField options
1296
- * @requiredField options.namespace
1297
- * @requiredField programDefinitionId
1298
- * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_READ
1299
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
1300
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
1301
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
1302
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
1303
- * @permissionScope Manage Events
1304
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1305
- * @applicableIdentity APP
1306
- * @applicableIdentity VISITOR
1307
- * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.FindPoolDefinitionsByProgramDefinition
1308
- */
1309
- export declare function findPoolDefinitionsByProgramDefinition(programDefinitionId: string, options: FindPoolDefinitionsByProgramDefinitionOptions): Promise<FindPoolDefinitionsByProgramDefinitionResponse & FindPoolDefinitionsByProgramDefinitionResponseNonNullableFields>;
1310
- export interface FindPoolDefinitionsByProgramDefinitionOptions {
1311
- /**
1312
- * Namespace for your app or site's benefit programs.
1008
+ interface FindPoolDefinitionsByProgramDefinitionOptions {
1009
+ /**
1010
+ * 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.
1313
1011
  * @minLength 1
1314
1012
  * @maxLength 50
1315
1013
  */
1316
1014
  namespace: string;
1317
1015
  }
1318
- export {};
1016
+
1017
+ export { type UpdatePoolDefinitionResponse as $, type AddPoolDefinitionToProgramDefinitionOptions as A, type BulkCreatePoolDefinitionsOptions as B, type CreatePoolDefinitionOptions as C, type DeletePoolDefinitionOptions as D, type CustomPolicy as E, type FindPoolDefinitionsByProgramDefinitionOptions as F, type CreditConfiguration as G, type RolloverConfiguration as H, type ExtendedFields as I, type PoolDefinitionAddedToProgramDefinition as J, type PoolDefinitionRemovedFromProgramDefinition as K, type PoolDefinitionUpdatedProxySupport as L, type PoolDefinitionDeletedProxySupport as M, type CreatePoolDefinitionRequest as N, type CreatePoolDefinitionResponse as O, type PoolDefinition as P, type BulkCreatePoolDefinitionsRequest as Q, type RemovePoolDefinitionFromProgramDefinitionOptions as R, SortOrder as S, Type as T, type UpdatePoolDefinition as U, type BulkPoolDefinitionResult as V, WeekDay as W, type ItemMetadata as X, type ApplicationError as Y, type BulkActionMetadata as Z, type UpdatePoolDefinitionRequest as _, type BulkCreatePoolDefinitionsResponse as a, type BulkUpdatePoolDefinitionsRequest as a0, type MaskedPoolDefinition as a1, type DeletePoolDefinitionRequest as a2, type DeletePoolDefinitionResponse as a3, type BulkDeletePoolDefinitionsRequest as a4, type GetPoolDefinitionRequest as a5, type GetPoolDefinitionResponse as a6, type QueryPoolDefinitionsRequest as a7, type CursorQuery as a8, type CursorQueryPagingMethodOneOf as a9, type Sorting as aa, type CursorPaging as ab, type QueryPoolDefinitionsResponse as ac, type CursorPagingMetadata as ad, type Cursors as ae, type AddPoolDefinitionToProgramDefinitionRequest as af, type RemovePoolDefinitionFromProgramDefinitionRequest as ag, type FindPoolDefinitionsByProgramDefinitionRequest as ah, type DomainEvent as ai, type DomainEventBodyOneOf as aj, type EntityCreatedEvent as ak, type RestoreInfo as al, type EntityUpdatedEvent as am, type EntityDeletedEvent as an, type ActionEvent as ao, type MessageEnvelope as ap, type IdentificationData as aq, type IdentificationDataIdOneOf as ar, type PoolDefinitionsQueryResult as as, type UpdatePoolDefinitionOptions as b, type BulkUpdatePoolDefinitionsOptions as c, type BulkUpdatePoolDefinitionsResponse as d, type BulkDeletePoolDefinitionsOptions as e, type BulkDeletePoolDefinitionsResponse as f, type PoolDefinitionsQueryBuilder as g, type AddPoolDefinitionToProgramDefinitionResponse as h, type RemovePoolDefinitionFromProgramDefinitionResponse as i, type FindPoolDefinitionsByProgramDefinitionResponse as j, PolicyExpressionType as k, RateLimitedPolicyType as l, Cascade as m, WebhookIdentityType as n, type Details as o, type Benefit as p, type PolicyExpression as q, type PolicyExpressionExpressionOneOf as r, type PolicyExpressionNot as s, type PolicyExpressionAnd as t, type PolicyExpressionOr as u, type Policy as v, type PolicyPolicyOneOf as w, type FixedIntervalPolicy as x, type RateLimitedPolicy as y, type RateLimitedPolicyPeriodOneOf as z };