@wix/auto_sdk_benefit-programs_pool-definitions 1.0.10 → 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} +85 -298
  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} +85 -298
  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} +85 -298
  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} +85 -298
  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 -805
  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 -805
  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 -805
  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 -805
  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,5 +1,4 @@
1
- import { NonNullablePaths } from '@wix/sdk-types';
2
- export interface PoolDefinition {
1
+ interface PoolDefinition {
3
2
  /**
4
3
  * Pool definition ID.
5
4
  * @format GUID
@@ -53,7 +52,7 @@ export interface PoolDefinition {
53
52
  */
54
53
  extendedFields?: ExtendedFields;
55
54
  }
56
- export interface Details {
55
+ interface Details {
57
56
  /**
58
57
  * List of benefits.
59
58
  * @maxSize 10
@@ -68,7 +67,7 @@ export interface Details {
68
67
  /** Additional information relating to this object. */
69
68
  additionalData?: Record<string, any> | null;
70
69
  }
71
- export interface Benefit {
70
+ interface Benefit {
72
71
  /**
73
72
  * Unique identifier for this benefit.
74
73
  *
@@ -107,7 +106,7 @@ export interface Benefit {
107
106
  */
108
107
  description?: string | null;
109
108
  }
110
- export interface PolicyExpression extends PolicyExpressionExpressionOneOf {
109
+ interface PolicyExpression extends PolicyExpressionExpressionOneOf {
111
110
  /** Benefits can be redeemed if the expression in this object is not fulfilled. */
112
111
  operatorNotOptions?: PolicyExpressionNot;
113
112
  /** Benefits can be redeemed if all the expression in this object's array are fulfilled. */
@@ -120,7 +119,7 @@ export interface PolicyExpression extends PolicyExpressionExpressionOneOf {
120
119
  type?: PolicyExpressionType;
121
120
  }
122
121
  /** @oneof */
123
- export interface PolicyExpressionExpressionOneOf {
122
+ interface PolicyExpressionExpressionOneOf {
124
123
  /** Benefits can be redeemed if the expression in this object is not fulfilled. */
125
124
  operatorNotOptions?: PolicyExpressionNot;
126
125
  /** Benefits can be redeemed if all the expression in this object's array are fulfilled. */
@@ -130,7 +129,7 @@ export interface PolicyExpressionExpressionOneOf {
130
129
  /** Defines when benefits can be redeemed or how many benefits can be redeemed in a specific time period. */
131
130
  policyOptions?: Policy;
132
131
  }
133
- export declare enum PolicyExpressionType {
132
+ declare enum PolicyExpressionType {
134
133
  UNKNOWN = "UNKNOWN",
135
134
  /** Use with `operatorNotOptions`. */
136
135
  OPERATOR_NOT = "OPERATOR_NOT",
@@ -141,11 +140,11 @@ export declare enum PolicyExpressionType {
141
140
  /** Use with `policyOptions`. */
142
141
  POLICY = "POLICY"
143
142
  }
144
- export interface PolicyExpressionNot {
143
+ interface PolicyExpressionNot {
145
144
  /** Policy expression. If this expression is not fulfilled, benefits can be redeemed. */
146
145
  expression?: PolicyExpression;
147
146
  }
148
- export interface PolicyExpressionAnd {
147
+ interface PolicyExpressionAnd {
149
148
  /**
150
149
  * Array of policy expressions. If all expressions are fulfilled, benefits can be redeemed.
151
150
  * @minSize 2
@@ -153,7 +152,7 @@ export interface PolicyExpressionAnd {
153
152
  */
154
153
  expressions?: PolicyExpression[];
155
154
  }
156
- export interface PolicyExpressionOr {
155
+ interface PolicyExpressionOr {
157
156
  /**
158
157
  * Array of policy expressions. If at least one expression is fulfilled, benefits can be redeemed.
159
158
  * @minSize 2
@@ -161,7 +160,7 @@ export interface PolicyExpressionOr {
161
160
  */
162
161
  expressions?: PolicyExpression[];
163
162
  }
164
- export interface Policy extends PolicyPolicyOneOf {
163
+ interface Policy extends PolicyPolicyOneOf {
165
164
  /**
166
165
  * Defines an interval during which the policy expression is fulfilled.
167
166
  *
@@ -176,7 +175,7 @@ export interface Policy extends PolicyPolicyOneOf {
176
175
  type?: Type;
177
176
  }
178
177
  /** @oneof */
179
- export interface PolicyPolicyOneOf {
178
+ interface PolicyPolicyOneOf {
180
179
  /**
181
180
  * Defines an interval during which the policy expression is fulfilled.
182
181
  *
@@ -188,7 +187,7 @@ export interface PolicyPolicyOneOf {
188
187
  /** Custom policy defined by a different app. */
189
188
  customOptions?: CustomPolicy;
190
189
  }
191
- export declare enum Type {
190
+ declare enum Type {
192
191
  /** Unknown policy type. */
193
192
  UNKNOWN = "UNKNOWN",
194
193
  /** Use with `fixedIntervalOptions`. */
@@ -198,7 +197,7 @@ export declare enum Type {
198
197
  /** Use with `customOptions`. */
199
198
  CUSTOM = "CUSTOM"
200
199
  }
201
- export interface FixedIntervalPolicy {
200
+ interface FixedIntervalPolicy {
202
201
  /** Weekday that this interval starts from. If this field is defined, then `toWeekDay` is required. */
203
202
  fromWeekDay?: WeekDay;
204
203
  /** Weekday that this interval ends at. If this field is defined, then `fromWeekDay` is required. */
@@ -224,7 +223,7 @@ export interface FixedIntervalPolicy {
224
223
  */
225
224
  toMinute?: number | null;
226
225
  }
227
- export declare enum WeekDay {
226
+ declare enum WeekDay {
228
227
  /** Unknown weekday. */
229
228
  UNKNOWN = "UNKNOWN",
230
229
  /** Monday. */
@@ -242,7 +241,7 @@ export declare enum WeekDay {
242
241
  /** Sunday. */
243
242
  SUNDAY = "SUNDAY"
244
243
  }
245
- export interface RateLimitedPolicy extends RateLimitedPolicyPeriodOneOf {
244
+ interface RateLimitedPolicy extends RateLimitedPolicyPeriodOneOf {
246
245
  /** Fixed interval used to limit benefit redemption. */
247
246
  fixedIntervalOptions?: FixedIntervalPolicy;
248
247
  /** Maximum number of times a benefit can be redeemed per specified time period. */
@@ -251,11 +250,11 @@ export interface RateLimitedPolicy extends RateLimitedPolicyPeriodOneOf {
251
250
  type?: RateLimitedPolicyType;
252
251
  }
253
252
  /** @oneof */
254
- export interface RateLimitedPolicyPeriodOneOf {
253
+ interface RateLimitedPolicyPeriodOneOf {
255
254
  /** Fixed interval used to limit benefit redemption. */
256
255
  fixedIntervalOptions?: FixedIntervalPolicy;
257
256
  }
258
- export declare enum RateLimitedPolicyType {
257
+ declare enum RateLimitedPolicyType {
259
258
  /** Unknown rate limit method. */
260
259
  UNKNOWN = "UNKNOWN",
261
260
  /** Time period is defined using `fixedIntervalOptions`. */
@@ -264,7 +263,7 @@ export declare enum RateLimitedPolicyType {
264
263
  PER_CYCLE = "PER_CYCLE"
265
264
  }
266
265
  /** Custom policy as implemented by the Entitlement Policy Provider */
267
- export interface CustomPolicy {
266
+ interface CustomPolicy {
268
267
  /**
269
268
  * Policy ID.
270
269
  * @format GUID
@@ -278,7 +277,7 @@ export interface CustomPolicy {
278
277
  /** Additional information for this custom policy. */
279
278
  additionalData?: Record<string, any> | null;
280
279
  }
281
- export interface CreditConfiguration {
280
+ interface CreditConfiguration {
282
281
  /**
283
282
  * Initial available amount for associated balances.
284
283
  * @decimalValue options { gte:0, maxScale:4 }
@@ -292,7 +291,7 @@ export interface CreditConfiguration {
292
291
  */
293
292
  unitDisplayName?: string | null;
294
293
  }
295
- export interface RolloverConfiguration {
294
+ interface RolloverConfiguration {
296
295
  /** Whether unused credits roll over to a new cycle when a program renews. */
297
296
  enabled?: boolean | null;
298
297
  /**
@@ -301,7 +300,7 @@ export interface RolloverConfiguration {
301
300
  */
302
301
  balanceCap?: string | null;
303
302
  }
304
- export interface ExtendedFields {
303
+ interface ExtendedFields {
305
304
  /**
306
305
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
307
306
  * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -312,7 +311,7 @@ export interface ExtendedFields {
312
311
  */
313
312
  namespaces?: Record<string, Record<string, any>>;
314
313
  }
315
- export interface PoolDefinitionAddedToProgramDefinition {
314
+ interface PoolDefinitionAddedToProgramDefinition {
316
315
  /** PoolDefinition that was added to the program definition */
317
316
  poolDefinition?: PoolDefinition;
318
317
  /**
@@ -323,7 +322,7 @@ export interface PoolDefinitionAddedToProgramDefinition {
323
322
  /** Type of cascade */
324
323
  cascadeType?: Cascade;
325
324
  }
326
- export declare enum Cascade {
325
+ declare enum Cascade {
327
326
  /** Unknown cascade. */
328
327
  UNKNOWN_CASCADE = "UNKNOWN_CASCADE",
329
328
  /** Changes are applied to existing programs and pools when they are next renewed. */
@@ -333,7 +332,7 @@ export declare enum Cascade {
333
332
  /** Changes are not applied to existing associated programs and pools. They are only applied to future programs and pools. */
334
333
  FUTURE_PROVISIONS = "FUTURE_PROVISIONS"
335
334
  }
336
- export interface PoolDefinitionRemovedFromProgramDefinition {
335
+ interface PoolDefinitionRemovedFromProgramDefinition {
337
336
  /** PoolDefinition that was removed from the program definition */
338
337
  poolDefinition?: PoolDefinition;
339
338
  /**
@@ -345,18 +344,18 @@ export interface PoolDefinitionRemovedFromProgramDefinition {
345
344
  cascadeType?: Cascade;
346
345
  }
347
346
  /** This event is needed to support legacy benefit notification event. Should be only consumed in the proxy. */
348
- export interface PoolDefinitionUpdatedProxySupport {
347
+ interface PoolDefinitionUpdatedProxySupport {
349
348
  /** PoolDefinition after the update */
350
349
  currentPoolDefinition?: PoolDefinition;
351
350
  /** PoolDefinition before the update */
352
351
  previousPoolDefinition?: PoolDefinition;
353
352
  }
354
353
  /** This event is needed to support legacy benefit notification event. Should be only consumed in the proxy. */
355
- export interface PoolDefinitionDeletedProxySupport {
354
+ interface PoolDefinitionDeletedProxySupport {
356
355
  /** PoolDefinition which was deleted */
357
356
  deletedPoolDefinition?: PoolDefinition;
358
357
  }
359
- export interface CreatePoolDefinitionRequest {
358
+ interface CreatePoolDefinitionRequest {
360
359
  /** Pool definition to create. */
361
360
  poolDefinition: PoolDefinition;
362
361
  /**
@@ -366,11 +365,11 @@ export interface CreatePoolDefinitionRequest {
366
365
  */
367
366
  cascade?: Cascade;
368
367
  }
369
- export interface CreatePoolDefinitionResponse {
368
+ interface CreatePoolDefinitionResponse {
370
369
  /** Created pool definition. */
371
370
  poolDefinition?: PoolDefinition;
372
371
  }
373
- export interface BulkCreatePoolDefinitionsRequest {
372
+ interface BulkCreatePoolDefinitionsRequest {
374
373
  /**
375
374
  * Pool definitions to create.
376
375
  * @minSize 1
@@ -390,7 +389,7 @@ export interface BulkCreatePoolDefinitionsRequest {
390
389
  */
391
390
  returnEntity?: boolean;
392
391
  }
393
- export interface BulkCreatePoolDefinitionsResponse {
392
+ interface BulkCreatePoolDefinitionsResponse {
394
393
  /**
395
394
  * List of created pool definitions and associated metadata.
396
395
  * @minSize 1
@@ -400,13 +399,13 @@ export interface BulkCreatePoolDefinitionsResponse {
400
399
  /** Bulk action metadata. */
401
400
  bulkActionMetadata?: BulkActionMetadata;
402
401
  }
403
- export interface BulkPoolDefinitionResult {
402
+ interface BulkPoolDefinitionResult {
404
403
  /** Item metadata. */
405
404
  itemMetadata?: ItemMetadata;
406
405
  /** Pool definition. */
407
406
  poolDefinition?: PoolDefinition;
408
407
  }
409
- export interface ItemMetadata {
408
+ interface ItemMetadata {
410
409
  /**
411
410
  * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
412
411
  * @format GUID
@@ -419,7 +418,7 @@ export interface ItemMetadata {
419
418
  /** Details about the error in case of failure. */
420
419
  error?: ApplicationError;
421
420
  }
422
- export interface ApplicationError {
421
+ interface ApplicationError {
423
422
  /** Error code. */
424
423
  code?: string;
425
424
  /** Description of the error. */
@@ -427,7 +426,7 @@ export interface ApplicationError {
427
426
  /** Data related to the error. */
428
427
  data?: Record<string, any> | null;
429
428
  }
430
- export interface BulkActionMetadata {
429
+ interface BulkActionMetadata {
431
430
  /** Number of items that were successfully processed. */
432
431
  totalSuccesses?: number;
433
432
  /** Number of items that couldn't be processed. */
@@ -435,17 +434,17 @@ export interface BulkActionMetadata {
435
434
  /** Number of failures without details because detailed failure threshold was exceeded. */
436
435
  undetailedFailures?: number;
437
436
  }
438
- export interface UpdatePoolDefinitionRequest {
437
+ interface UpdatePoolDefinitionRequest {
439
438
  /** Pool definition to update. */
440
439
  poolDefinition: PoolDefinition;
441
440
  /** *Required.** Determines when the changes to this pool definition and program definitions containing it will be applied to associated programs and pools. */
442
441
  cascade?: Cascade;
443
442
  }
444
- export interface UpdatePoolDefinitionResponse {
443
+ interface UpdatePoolDefinitionResponse {
445
444
  /** Updated pool definition. */
446
445
  poolDefinition?: PoolDefinition;
447
446
  }
448
- export interface BulkUpdatePoolDefinitionsRequest {
447
+ interface BulkUpdatePoolDefinitionsRequest {
449
448
  /**
450
449
  * Pool definitions to update.
451
450
  * @minSize 1
@@ -461,13 +460,13 @@ export interface BulkUpdatePoolDefinitionsRequest {
461
460
  */
462
461
  returnEntity?: boolean;
463
462
  }
464
- export interface MaskedPoolDefinition {
463
+ interface MaskedPoolDefinition {
465
464
  /** Pool definition to update. */
466
465
  poolDefinition?: PoolDefinition;
467
466
  /** Explicit list of fields to update. */
468
467
  fieldMask?: string[];
469
468
  }
470
- export interface BulkUpdatePoolDefinitionsResponse {
469
+ interface BulkUpdatePoolDefinitionsResponse {
471
470
  /**
472
471
  * List of updated pool definitions and associated metadata.
473
472
  * @minSize 1
@@ -477,7 +476,7 @@ export interface BulkUpdatePoolDefinitionsResponse {
477
476
  /** Bulk action metadata. */
478
477
  bulkActionMetadata?: BulkActionMetadata;
479
478
  }
480
- export interface DeletePoolDefinitionRequest {
479
+ interface DeletePoolDefinitionRequest {
481
480
  /**
482
481
  * ID of the pool definition to delete.
483
482
  * @format GUID
@@ -486,9 +485,9 @@ export interface DeletePoolDefinitionRequest {
486
485
  /** *Required**. Determines when the changes to this pool definition the program definitions containing it will be applied to associated programs and pools. */
487
486
  cascade?: Cascade;
488
487
  }
489
- export interface DeletePoolDefinitionResponse {
488
+ interface DeletePoolDefinitionResponse {
490
489
  }
491
- export interface BulkDeletePoolDefinitionsRequest {
490
+ interface BulkDeletePoolDefinitionsRequest {
492
491
  /**
493
492
  * List of IDs of the pool definitions to delete.
494
493
  * @minSize 1
@@ -499,7 +498,7 @@ export interface BulkDeletePoolDefinitionsRequest {
499
498
  /** *Required**. Determines when the changes to these pool definitions the program definitions containing it will be applied to associated programs and pools. */
500
499
  cascade?: Cascade;
501
500
  }
502
- export interface BulkDeletePoolDefinitionsResponse {
501
+ interface BulkDeletePoolDefinitionsResponse {
503
502
  /**
504
503
  * List of deleted pool definitions and associated metadata.
505
504
  * @minSize 1
@@ -509,22 +508,22 @@ export interface BulkDeletePoolDefinitionsResponse {
509
508
  /** Bulk action metadata. */
510
509
  bulkActionMetadata?: BulkActionMetadata;
511
510
  }
512
- export interface GetPoolDefinitionRequest {
511
+ interface GetPoolDefinitionRequest {
513
512
  /**
514
513
  * ID of the pool definition to retrieve.
515
514
  * @format GUID
516
515
  */
517
516
  poolDefinitionId: string;
518
517
  }
519
- export interface GetPoolDefinitionResponse {
518
+ interface GetPoolDefinitionResponse {
520
519
  /** Retrieved pool definition. */
521
520
  poolDefinition?: PoolDefinition;
522
521
  }
523
- export interface QueryPoolDefinitionsRequest {
522
+ interface QueryPoolDefinitionsRequest {
524
523
  /** Filter, sort, and paging to apply to the query. */
525
524
  query?: CursorQuery;
526
525
  }
527
- export interface CursorQuery extends CursorQueryPagingMethodOneOf {
526
+ interface CursorQuery extends CursorQueryPagingMethodOneOf {
528
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`. */
529
528
  cursorPaging?: CursorPaging;
530
529
  /**
@@ -540,11 +539,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
540
539
  sort?: Sorting[];
541
540
  }
542
541
  /** @oneof */
543
- export interface CursorQueryPagingMethodOneOf {
542
+ interface CursorQueryPagingMethodOneOf {
544
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`. */
545
544
  cursorPaging?: CursorPaging;
546
545
  }
547
- export interface Sorting {
546
+ interface Sorting {
548
547
  /**
549
548
  * Field to sort by.
550
549
  * @maxLength 512
@@ -557,13 +556,13 @@ export interface Sorting {
557
556
  */
558
557
  order?: SortOrder;
559
558
  }
560
- export declare enum SortOrder {
559
+ declare enum SortOrder {
561
560
  /** Ascending sort order. */
562
561
  ASC = "ASC",
563
562
  /** Descending sort order. */
564
563
  DESC = "DESC"
565
564
  }
566
- export interface CursorPaging {
565
+ interface CursorPaging {
567
566
  /**
568
567
  * Maximum number of items to return.
569
568
  * @max 100
@@ -578,13 +577,13 @@ export interface CursorPaging {
578
577
  */
579
578
  cursor?: string | null;
580
579
  }
581
- export interface QueryPoolDefinitionsResponse {
580
+ interface QueryPoolDefinitionsResponse {
582
581
  /** List of retrieved pool definitions. */
583
582
  poolDefinitions?: PoolDefinition[];
584
583
  /** Metadata for the paginated results. */
585
584
  metadata?: CursorPagingMetadata;
586
585
  }
587
- export interface CursorPagingMetadata {
586
+ interface CursorPagingMetadata {
588
587
  /** Number of items returned in the response. */
589
588
  count?: number | null;
590
589
  /** Cursor strings that point to the next page, previous page, or both. */
@@ -597,7 +596,7 @@ export interface CursorPagingMetadata {
597
596
  */
598
597
  hasNext?: boolean | null;
599
598
  }
600
- export interface Cursors {
599
+ interface Cursors {
601
600
  /**
602
601
  * Cursor string pointing to the next page in the list of results.
603
602
  * @maxLength 16000
@@ -609,7 +608,7 @@ export interface Cursors {
609
608
  */
610
609
  prev?: string | null;
611
610
  }
612
- export interface AddPoolDefinitionToProgramDefinitionRequest {
611
+ interface AddPoolDefinitionToProgramDefinitionRequest {
613
612
  /**
614
613
  * ID of the pool definition to add to the program definition.
615
614
  * @format GUID
@@ -623,11 +622,11 @@ export interface AddPoolDefinitionToProgramDefinitionRequest {
623
622
  /** Determines when the changes to this program definition and pool definition will be applied to associated programs and pools. */
624
623
  cascade: Cascade;
625
624
  }
626
- export interface AddPoolDefinitionToProgramDefinitionResponse {
625
+ interface AddPoolDefinitionToProgramDefinitionResponse {
627
626
  /** Updated pool definition. */
628
627
  poolDefinition?: PoolDefinition;
629
628
  }
630
- export interface RemovePoolDefinitionFromProgramDefinitionRequest {
629
+ interface RemovePoolDefinitionFromProgramDefinitionRequest {
631
630
  /**
632
631
  * ID of the pool definition to remove from the program definition.
633
632
  * @format GUID
@@ -641,11 +640,11 @@ export interface RemovePoolDefinitionFromProgramDefinitionRequest {
641
640
  /** Determines when the changes to this program definition and pool definition will be applied to associated programs and pools. */
642
641
  cascade: Cascade;
643
642
  }
644
- export interface RemovePoolDefinitionFromProgramDefinitionResponse {
643
+ interface RemovePoolDefinitionFromProgramDefinitionResponse {
645
644
  /** Updated pool definition. */
646
645
  poolDefinition?: PoolDefinition;
647
646
  }
648
- export interface FindPoolDefinitionsByProgramDefinitionRequest {
647
+ interface FindPoolDefinitionsByProgramDefinitionRequest {
649
648
  /**
650
649
  * ID of the program definition to retrieve its pool definitions.
651
650
  * @format GUID
@@ -658,11 +657,11 @@ export interface FindPoolDefinitionsByProgramDefinitionRequest {
658
657
  */
659
658
  namespace: string;
660
659
  }
661
- export interface FindPoolDefinitionsByProgramDefinitionResponse {
660
+ interface FindPoolDefinitionsByProgramDefinitionResponse {
662
661
  /** Retrieved pool definitions. */
663
662
  poolDefinitions?: PoolDefinition[];
664
663
  }
665
- export interface DomainEvent extends DomainEventBodyOneOf {
664
+ interface DomainEvent extends DomainEventBodyOneOf {
666
665
  createdEvent?: EntityCreatedEvent;
667
666
  updatedEvent?: EntityUpdatedEvent;
668
667
  deletedEvent?: EntityDeletedEvent;
@@ -705,19 +704,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
705
704
  entityEventSequence?: string | null;
706
705
  }
707
706
  /** @oneof */
708
- export interface DomainEventBodyOneOf {
707
+ interface DomainEventBodyOneOf {
709
708
  createdEvent?: EntityCreatedEvent;
710
709
  updatedEvent?: EntityUpdatedEvent;
711
710
  deletedEvent?: EntityDeletedEvent;
712
711
  actionEvent?: ActionEvent;
713
712
  }
714
- export interface EntityCreatedEvent {
713
+ interface EntityCreatedEvent {
715
714
  entity?: string;
716
715
  }
717
- export interface RestoreInfo {
716
+ interface RestoreInfo {
718
717
  deletedDate?: Date | null;
719
718
  }
720
- export interface EntityUpdatedEvent {
719
+ interface EntityUpdatedEvent {
721
720
  /**
722
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.
723
722
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
@@ -725,14 +724,14 @@ export interface EntityUpdatedEvent {
725
724
  */
726
725
  currentEntity?: string;
727
726
  }
728
- export interface EntityDeletedEvent {
727
+ interface EntityDeletedEvent {
729
728
  /** Entity that was deleted */
730
729
  deletedEntity?: string | null;
731
730
  }
732
- export interface ActionEvent {
731
+ interface ActionEvent {
733
732
  body?: string;
734
733
  }
735
- export interface MessageEnvelope {
734
+ interface MessageEnvelope {
736
735
  /**
737
736
  * App instance ID.
738
737
  * @format GUID
@@ -748,7 +747,7 @@ export interface MessageEnvelope {
748
747
  /** Stringify payload. */
749
748
  data?: string;
750
749
  }
751
- export interface IdentificationData extends IdentificationDataIdOneOf {
750
+ interface IdentificationData extends IdentificationDataIdOneOf {
752
751
  /**
753
752
  * ID of a site visitor that has not logged in to the site.
754
753
  * @format GUID
@@ -773,7 +772,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
773
772
  identityType?: WebhookIdentityType;
774
773
  }
775
774
  /** @oneof */
776
- export interface IdentificationDataIdOneOf {
775
+ interface IdentificationDataIdOneOf {
777
776
  /**
778
777
  * ID of a site visitor that has not logged in to the site.
779
778
  * @format GUID
@@ -795,34 +794,14 @@ export interface IdentificationDataIdOneOf {
795
794
  */
796
795
  appId?: string;
797
796
  }
798
- export declare enum WebhookIdentityType {
797
+ declare enum WebhookIdentityType {
799
798
  UNKNOWN = "UNKNOWN",
800
799
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
801
800
  MEMBER = "MEMBER",
802
801
  WIX_USER = "WIX_USER",
803
802
  APP = "APP"
804
803
  }
805
- type PoolDefinitionNonNullablePaths = `displayName` | `programDefinitionIds` | `details.benefits` | `details.benefits.${number}.benefitKey` | `details.creditConfiguration.amount`;
806
- /**
807
- * Creates a pool definition.
808
- * @param poolDefinition - Pool definition to create.
809
- * @public
810
- * @documentationMaturity preview
811
- * @requiredField poolDefinition
812
- * @requiredField poolDefinition.details
813
- * @requiredField poolDefinition.details.benefits
814
- * @requiredField poolDefinition.details.benefits.benefitKey
815
- * @requiredField poolDefinition.details.benefits.providerAppId
816
- * @requiredField poolDefinition.namespace
817
- * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_CREATE
818
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
819
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
820
- * @applicableIdentity APP
821
- * @returns Created pool definition.
822
- * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.CreatePoolDefinition
823
- */
824
- export declare function createPoolDefinition(poolDefinition: NonNullablePaths<PoolDefinition, `details` | `details.benefits` | `details.benefits.${number}.benefitKey` | `details.benefits.${number}.providerAppId` | `namespace`>, options?: CreatePoolDefinitionOptions): Promise<NonNullablePaths<PoolDefinition, PoolDefinitionNonNullablePaths>>;
825
- export interface CreatePoolDefinitionOptions {
804
+ interface CreatePoolDefinitionOptions {
826
805
  /**
827
806
  * Determines when the changes to the program definitions containing this pool definition will be applied to associated programs.
828
807
  *
@@ -830,27 +809,7 @@ export interface CreatePoolDefinitionOptions {
830
809
  */
831
810
  cascade?: Cascade;
832
811
  }
833
- /**
834
- * Creates pool definitions.
835
- * @param poolDefinitions - Pool definitions to create.
836
- * @public
837
- * @documentationMaturity preview
838
- * @requiredField poolDefinitions
839
- * @requiredField poolDefinitions.details
840
- * @requiredField poolDefinitions.details.benefits
841
- * @requiredField poolDefinitions.details.benefits.benefitKey
842
- * @requiredField poolDefinitions.details.benefits.providerAppId
843
- * @requiredField poolDefinitions.namespace
844
- * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_CREATE
845
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
846
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
847
- * @applicableIdentity APP
848
- * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.BulkCreatePoolDefinitions
849
- */
850
- export declare function bulkCreatePoolDefinitions(poolDefinitions: NonNullablePaths<PoolDefinition, `details` | `details.benefits` | `details.benefits.${number}.benefitKey` | `details.benefits.${number}.providerAppId` | `namespace`>[], options?: BulkCreatePoolDefinitionsOptions): Promise<NonNullablePaths<BulkCreatePoolDefinitionsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
851
- [P in PoolDefinitionNonNullablePaths]: `results.${number}.poolDefinition.${P}`;
852
- }[PoolDefinitionNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
853
- export interface BulkCreatePoolDefinitionsOptions {
812
+ interface BulkCreatePoolDefinitionsOptions {
854
813
  /**
855
814
  * Determines when the changes to the program definitions containing these pool definitions will be applied to associated programs.
856
815
  *
@@ -864,29 +823,7 @@ export interface BulkCreatePoolDefinitionsOptions {
864
823
  */
865
824
  returnEntity?: boolean;
866
825
  }
867
- /**
868
- * Updates a pool definition.
869
- *
870
- * Each time the pool definition is updated,
871
- * `revision` increments by 1.
872
- * The current `revision` must be passed when updating the pool definition.
873
- * This ensures you're working with the latest pool definition
874
- * and prevents unintended overwrites.
875
- * @param _id - Pool definition ID.
876
- * @public
877
- * @documentationMaturity preview
878
- * @requiredField _id
879
- * @requiredField poolDefinition
880
- * @requiredField poolDefinition.revision
881
- * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_UPDATE
882
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
883
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
884
- * @applicableIdentity APP
885
- * @returns Updated pool definition.
886
- * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.UpdatePoolDefinition
887
- */
888
- export declare function updatePoolDefinition(_id: string, poolDefinition: NonNullablePaths<UpdatePoolDefinition, `revision`>, options?: UpdatePoolDefinitionOptions): Promise<NonNullablePaths<PoolDefinition, PoolDefinitionNonNullablePaths>>;
889
- export interface UpdatePoolDefinition {
826
+ interface UpdatePoolDefinition {
890
827
  /**
891
828
  * Pool definition ID.
892
829
  * @format GUID
@@ -940,27 +877,11 @@ export interface UpdatePoolDefinition {
940
877
  */
941
878
  extendedFields?: ExtendedFields;
942
879
  }
943
- export interface UpdatePoolDefinitionOptions {
880
+ interface UpdatePoolDefinitionOptions {
944
881
  /** Required.** Determines when the changes to this pool definition and program definitions containing it will be applied to associated programs and pools. */
945
882
  cascade?: Cascade;
946
883
  }
947
- /**
948
- * Updates pool definitions.
949
- * @public
950
- * @documentationMaturity preview
951
- * @requiredField options.poolDefinitions.poolDefinition
952
- * @requiredField options.poolDefinitions.poolDefinition._id
953
- * @requiredField options.poolDefinitions.poolDefinition.revision
954
- * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_UPDATE
955
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
956
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
957
- * @applicableIdentity APP
958
- * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.BulkUpdatePoolDefinitions
959
- */
960
- export declare function bulkUpdatePoolDefinitions(options?: NonNullablePaths<BulkUpdatePoolDefinitionsOptions, `poolDefinitions.${number}.poolDefinition` | `poolDefinitions.${number}.poolDefinition._id` | `poolDefinitions.${number}.poolDefinition.revision`>): Promise<NonNullablePaths<BulkUpdatePoolDefinitionsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
961
- [P in PoolDefinitionNonNullablePaths]: `results.${number}.poolDefinition.${P}`;
962
- }[PoolDefinitionNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
963
- export interface BulkUpdatePoolDefinitionsOptions {
884
+ interface BulkUpdatePoolDefinitionsOptions {
964
885
  /**
965
886
  * Pool definitions to update.
966
887
  * @minSize 1
@@ -976,87 +897,14 @@ export interface BulkUpdatePoolDefinitionsOptions {
976
897
  */
977
898
  returnEntity?: boolean;
978
899
  }
979
- /**
980
- * Deletes a pool definition.
981
- * @param poolDefinitionId - ID of the pool definition to delete.
982
- * @public
983
- * @documentationMaturity preview
984
- * @requiredField poolDefinitionId
985
- * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_DELETE
986
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
987
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
988
- * @applicableIdentity APP
989
- * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.DeletePoolDefinition
990
- */
991
- export declare function deletePoolDefinition(poolDefinitionId: string, options?: DeletePoolDefinitionOptions): Promise<void>;
992
- export interface DeletePoolDefinitionOptions {
900
+ interface DeletePoolDefinitionOptions {
993
901
  /** Required**. Determines when the changes to this pool definition the program definitions containing it will be applied to associated programs and pools. */
994
902
  cascade?: Cascade;
995
903
  }
996
- /**
997
- * Deletes pool definitions.
998
- * @param poolDefinitionIds - List of IDs of the pool definitions to delete.
999
- * @public
1000
- * @documentationMaturity preview
1001
- * @requiredField poolDefinitionIds
1002
- * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_DELETE
1003
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
1004
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
1005
- * @applicableIdentity APP
1006
- * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.BulkDeletePoolDefinitions
1007
- */
1008
- export declare function bulkDeletePoolDefinitions(poolDefinitionIds: string[], options?: BulkDeletePoolDefinitionsOptions): Promise<NonNullablePaths<BulkDeletePoolDefinitionsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
1009
- [P in PoolDefinitionNonNullablePaths]: `results.${number}.poolDefinition.${P}`;
1010
- }[PoolDefinitionNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
1011
- export interface BulkDeletePoolDefinitionsOptions {
904
+ interface BulkDeletePoolDefinitionsOptions {
1012
905
  /** Required**. Determines when the changes to these pool definitions the program definitions containing it will be applied to associated programs and pools. */
1013
906
  cascade?: Cascade;
1014
907
  }
1015
- /**
1016
- * Retrieves a pool definition.
1017
- * @param poolDefinitionId - ID of the pool definition to retrieve.
1018
- * @public
1019
- * @documentationMaturity preview
1020
- * @requiredField poolDefinitionId
1021
- * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_READ
1022
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
1023
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
1024
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
1025
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
1026
- * @permissionScope Manage Events
1027
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1028
- * @applicableIdentity APP
1029
- * @applicableIdentity VISITOR
1030
- * @returns Retrieved pool definition.
1031
- * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.GetPoolDefinition
1032
- */
1033
- export declare function getPoolDefinition(poolDefinitionId: string): Promise<NonNullablePaths<PoolDefinition, PoolDefinitionNonNullablePaths>>;
1034
- /**
1035
- * Creates a query to retrieve a list of pool definitions.
1036
- *
1037
- * The Query Pool Definitions method builds a query to retrieve a list of pool definitions and returns a `PoolDefinitionsQueryBuilder` object.
1038
- *
1039
- * The returned object contains the query definition, which is used to run the query using the `find()` method.
1040
- *
1041
- * 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.
1042
- *
1043
- * Query Pool Definitions has a default paging limit of 50, which you can override.
1044
- *
1045
- * For a full description of the item object, see the object returned for the `items` property in `PoolDefinitionsQueryResult`.
1046
- * @public
1047
- * @documentationMaturity preview
1048
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
1049
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
1050
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
1051
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
1052
- * @permissionScope Manage Events
1053
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1054
- * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_READ
1055
- * @applicableIdentity APP
1056
- * @applicableIdentity VISITOR
1057
- * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.QueryPoolDefinitions
1058
- */
1059
- export declare function queryPoolDefinitions(): PoolDefinitionsQueryBuilder;
1060
908
  interface QueryCursorResult {
1061
909
  cursors: Cursors;
1062
910
  hasNext: () => boolean;
@@ -1064,13 +912,13 @@ interface QueryCursorResult {
1064
912
  length: number;
1065
913
  pageSize: number;
1066
914
  }
1067
- export interface PoolDefinitionsQueryResult extends QueryCursorResult {
915
+ interface PoolDefinitionsQueryResult extends QueryCursorResult {
1068
916
  items: PoolDefinition[];
1069
917
  query: PoolDefinitionsQueryBuilder;
1070
918
  next: () => Promise<PoolDefinitionsQueryResult>;
1071
919
  prev: () => Promise<PoolDefinitionsQueryResult>;
1072
920
  }
1073
- export interface PoolDefinitionsQueryBuilder {
921
+ interface PoolDefinitionsQueryBuilder {
1074
922
  /** @param propertyName - Property whose value is compared with `value`.
1075
923
  * @param value - Value to compare against.
1076
924
  * @documentationMaturity preview
@@ -1139,27 +987,7 @@ export interface PoolDefinitionsQueryBuilder {
1139
987
  /** @documentationMaturity preview */
1140
988
  find: () => Promise<PoolDefinitionsQueryResult>;
1141
989
  }
1142
- /**
1143
- * Adds a pool definition to a program definition.
1144
- *
1145
- * Pool definitions can be contained by multiple program definitions, so this doesn't affect other program definitions that contain this pool definition.
1146
- * @param poolDefinitionId - ID of the pool definition to add to the program definition.
1147
- * @public
1148
- * @documentationMaturity preview
1149
- * @requiredField options
1150
- * @requiredField options.cascade
1151
- * @requiredField options.programDefinitionId
1152
- * @requiredField poolDefinitionId
1153
- * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_UPDATE
1154
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
1155
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
1156
- * @applicableIdentity APP
1157
- * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.AddPoolDefinitionToProgramDefinition
1158
- */
1159
- export declare function addPoolDefinitionToProgramDefinition(poolDefinitionId: string, options: NonNullablePaths<AddPoolDefinitionToProgramDefinitionOptions, `cascade` | `programDefinitionId`>): Promise<NonNullablePaths<AddPoolDefinitionToProgramDefinitionResponse, {
1160
- [P in PoolDefinitionNonNullablePaths]: `poolDefinition.${P}`;
1161
- }[PoolDefinitionNonNullablePaths]>>;
1162
- export interface AddPoolDefinitionToProgramDefinitionOptions {
990
+ interface AddPoolDefinitionToProgramDefinitionOptions {
1163
991
  /**
1164
992
  * ID of the program definition to add the pool definition to.
1165
993
  * @format GUID
@@ -1168,27 +996,7 @@ export interface AddPoolDefinitionToProgramDefinitionOptions {
1168
996
  /** Determines when the changes to this program definition and pool definition will be applied to associated programs and pools. */
1169
997
  cascade: Cascade;
1170
998
  }
1171
- /**
1172
- * Removes a pool definition from a program definition.
1173
- *
1174
- * Pool definitions don't need to be contained by a program definition, so this doesn't affect the usability of this pool definition.
1175
- * @param poolDefinitionId - ID of the pool definition to remove from the program definition.
1176
- * @public
1177
- * @documentationMaturity preview
1178
- * @requiredField options
1179
- * @requiredField options.cascade
1180
- * @requiredField options.programDefinitionId
1181
- * @requiredField poolDefinitionId
1182
- * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_UPDATE
1183
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
1184
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
1185
- * @applicableIdentity APP
1186
- * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.RemovePoolDefinitionFromProgramDefinition
1187
- */
1188
- export declare function removePoolDefinitionFromProgramDefinition(poolDefinitionId: string, options: NonNullablePaths<RemovePoolDefinitionFromProgramDefinitionOptions, `cascade` | `programDefinitionId`>): Promise<NonNullablePaths<RemovePoolDefinitionFromProgramDefinitionResponse, {
1189
- [P in PoolDefinitionNonNullablePaths]: `poolDefinition.${P}`;
1190
- }[PoolDefinitionNonNullablePaths]>>;
1191
- export interface RemovePoolDefinitionFromProgramDefinitionOptions {
999
+ interface RemovePoolDefinitionFromProgramDefinitionOptions {
1192
1000
  /**
1193
1001
  * ID of the program definition to remove the pool definition from.
1194
1002
  * @format GUID
@@ -1197,29 +1005,7 @@ export interface RemovePoolDefinitionFromProgramDefinitionOptions {
1197
1005
  /** Determines when the changes to this program definition and pool definition will be applied to associated programs and pools. */
1198
1006
  cascade: Cascade;
1199
1007
  }
1200
- /**
1201
- * Retrieve all a program definition's pool definitions.
1202
- * @param programDefinitionId - ID of the program definition to retrieve its pool definitions.
1203
- * @public
1204
- * @documentationMaturity preview
1205
- * @requiredField options
1206
- * @requiredField options.namespace
1207
- * @requiredField programDefinitionId
1208
- * @permissionId BENEFIT_PROGRAMS.POOL_DEFINITION_READ
1209
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
1210
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
1211
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
1212
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
1213
- * @permissionScope Manage Events
1214
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1215
- * @applicableIdentity APP
1216
- * @applicableIdentity VISITOR
1217
- * @fqn wix.benefit_programs.v1.pool_definition.PoolDefinitionService.FindPoolDefinitionsByProgramDefinition
1218
- */
1219
- export declare function findPoolDefinitionsByProgramDefinition(programDefinitionId: string, options: NonNullablePaths<FindPoolDefinitionsByProgramDefinitionOptions, `namespace`>): Promise<NonNullablePaths<FindPoolDefinitionsByProgramDefinitionResponse, {
1220
- [P in PoolDefinitionNonNullablePaths]: `poolDefinitions.${number}.${P}`;
1221
- }[PoolDefinitionNonNullablePaths]>>;
1222
- export interface FindPoolDefinitionsByProgramDefinitionOptions {
1008
+ interface FindPoolDefinitionsByProgramDefinitionOptions {
1223
1009
  /**
1224
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.
1225
1011
  * @minLength 1
@@ -1227,4 +1013,5 @@ export interface FindPoolDefinitionsByProgramDefinitionOptions {
1227
1013
  */
1228
1014
  namespace: string;
1229
1015
  }
1230
- 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 };