@wix/auto_sdk_benefit-programs_pools 1.0.15 → 1.0.17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +1 -0
- package/build/cjs/index.js +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +18 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +18 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/src/benefit-programs-v1-pool-pools.context.d.ts +12 -0
- package/build/cjs/src/benefit-programs-v1-pool-pools.context.js +28 -0
- package/build/cjs/src/benefit-programs-v1-pool-pools.context.js.map +1 -0
- package/build/cjs/src/benefit-programs-v1-pool-pools.http.d.ts +56 -0
- package/build/cjs/src/benefit-programs-v1-pool-pools.http.js +494 -0
- package/build/cjs/src/benefit-programs-v1-pool-pools.http.js.map +1 -0
- package/build/cjs/src/benefit-programs-v1-pool-pools.meta.d.ts +24 -0
- package/build/cjs/src/benefit-programs-v1-pool-pools.meta.js +180 -0
- package/build/cjs/src/benefit-programs-v1-pool-pools.meta.js.map +1 -0
- package/build/cjs/src/benefit-programs-v1-pool-pools.public.d.ts +96 -0
- package/build/cjs/src/benefit-programs-v1-pool-pools.public.js +68 -0
- package/build/cjs/src/benefit-programs-v1-pool-pools.public.js.map +1 -0
- package/build/cjs/src/benefit-programs-v1-pool-pools.types.d.ts +1579 -0
- package/build/cjs/src/benefit-programs-v1-pool-pools.types.js +140 -0
- package/build/cjs/src/benefit-programs-v1-pool-pools.types.js.map +1 -0
- package/build/{benefit-programs-v1-pool-pools.universal-C7Pd1Zor.d.mts → cjs/src/benefit-programs-v1-pool-pools.universal.d.ts} +309 -144
- package/build/cjs/src/benefit-programs-v1-pool-pools.universal.js +587 -0
- package/build/cjs/src/benefit-programs-v1-pool-pools.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +2 -0
- package/build/es/index.typings.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/package.json +3 -0
- package/build/es/src/benefit-programs-v1-pool-pools.context.d.ts +12 -0
- package/build/es/src/benefit-programs-v1-pool-pools.context.js +12 -0
- package/build/es/src/benefit-programs-v1-pool-pools.context.js.map +1 -0
- package/build/es/src/benefit-programs-v1-pool-pools.http.d.ts +56 -0
- package/build/es/src/benefit-programs-v1-pool-pools.http.js +483 -0
- package/build/es/src/benefit-programs-v1-pool-pools.http.js.map +1 -0
- package/build/es/src/benefit-programs-v1-pool-pools.meta.d.ts +24 -0
- package/build/es/src/benefit-programs-v1-pool-pools.meta.js +146 -0
- package/build/es/src/benefit-programs-v1-pool-pools.meta.js.map +1 -0
- package/build/es/src/benefit-programs-v1-pool-pools.public.d.ts +96 -0
- package/build/es/src/benefit-programs-v1-pool-pools.public.js +44 -0
- package/build/es/src/benefit-programs-v1-pool-pools.public.js.map +1 -0
- package/build/es/src/benefit-programs-v1-pool-pools.types.d.ts +1579 -0
- package/build/es/src/benefit-programs-v1-pool-pools.types.js +137 -0
- package/build/es/src/benefit-programs-v1-pool-pools.types.js.map +1 -0
- package/build/{benefit-programs-v1-pool-pools.universal-C7Pd1Zor.d.ts → es/src/benefit-programs-v1-pool-pools.universal.d.ts} +309 -144
- package/build/es/src/benefit-programs-v1-pool-pools.universal.js +553 -0
- package/build/es/src/benefit-programs-v1-pool-pools.universal.js.map +1 -0
- package/build/internal/cjs/index.d.ts +1 -0
- package/build/internal/cjs/index.js +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +1 -0
- package/build/internal/cjs/index.typings.js +18 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -0
- package/build/internal/cjs/meta.js +18 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/src/benefit-programs-v1-pool-pools.context.d.ts +12 -0
- package/build/internal/cjs/src/benefit-programs-v1-pool-pools.context.js +28 -0
- package/build/internal/cjs/src/benefit-programs-v1-pool-pools.context.js.map +1 -0
- package/build/internal/cjs/src/benefit-programs-v1-pool-pools.http.d.ts +56 -0
- package/build/internal/cjs/src/benefit-programs-v1-pool-pools.http.js +494 -0
- package/build/internal/cjs/src/benefit-programs-v1-pool-pools.http.js.map +1 -0
- package/build/internal/cjs/src/benefit-programs-v1-pool-pools.meta.d.ts +24 -0
- package/build/internal/cjs/src/benefit-programs-v1-pool-pools.meta.js +180 -0
- package/build/internal/cjs/src/benefit-programs-v1-pool-pools.meta.js.map +1 -0
- package/build/internal/cjs/src/benefit-programs-v1-pool-pools.public.d.ts +96 -0
- package/build/internal/cjs/src/benefit-programs-v1-pool-pools.public.js +68 -0
- package/build/internal/cjs/src/benefit-programs-v1-pool-pools.public.js.map +1 -0
- package/build/internal/cjs/src/benefit-programs-v1-pool-pools.types.d.ts +1579 -0
- package/build/internal/cjs/src/benefit-programs-v1-pool-pools.types.js +140 -0
- package/build/internal/cjs/src/benefit-programs-v1-pool-pools.types.js.map +1 -0
- package/build/internal/{benefit-programs-v1-pool-pools.universal-C7Pd1Zor.d.mts → cjs/src/benefit-programs-v1-pool-pools.universal.d.ts} +309 -144
- package/build/internal/cjs/src/benefit-programs-v1-pool-pools.universal.js +587 -0
- package/build/internal/cjs/src/benefit-programs-v1-pool-pools.universal.js.map +1 -0
- package/build/internal/es/index.d.ts +1 -0
- package/build/internal/es/index.js +2 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/index.typings.d.ts +1 -0
- package/build/internal/es/index.typings.js +2 -0
- package/build/internal/es/index.typings.js.map +1 -0
- package/build/internal/es/meta.d.ts +1 -0
- package/build/internal/es/meta.js +2 -0
- package/build/internal/es/meta.js.map +1 -0
- package/build/internal/es/src/benefit-programs-v1-pool-pools.context.d.ts +12 -0
- package/build/internal/es/src/benefit-programs-v1-pool-pools.context.js +12 -0
- package/build/internal/es/src/benefit-programs-v1-pool-pools.context.js.map +1 -0
- package/build/internal/es/src/benefit-programs-v1-pool-pools.http.d.ts +56 -0
- package/build/internal/es/src/benefit-programs-v1-pool-pools.http.js +483 -0
- package/build/internal/es/src/benefit-programs-v1-pool-pools.http.js.map +1 -0
- package/build/internal/es/src/benefit-programs-v1-pool-pools.meta.d.ts +24 -0
- package/build/internal/es/src/benefit-programs-v1-pool-pools.meta.js +146 -0
- package/build/internal/es/src/benefit-programs-v1-pool-pools.meta.js.map +1 -0
- package/build/internal/es/src/benefit-programs-v1-pool-pools.public.d.ts +96 -0
- package/build/internal/es/src/benefit-programs-v1-pool-pools.public.js +44 -0
- package/build/internal/es/src/benefit-programs-v1-pool-pools.public.js.map +1 -0
- package/build/internal/es/src/benefit-programs-v1-pool-pools.types.d.ts +1579 -0
- package/build/internal/es/src/benefit-programs-v1-pool-pools.types.js +137 -0
- package/build/internal/es/src/benefit-programs-v1-pool-pools.types.js.map +1 -0
- package/build/internal/{benefit-programs-v1-pool-pools.universal-C7Pd1Zor.d.ts → es/src/benefit-programs-v1-pool-pools.universal.d.ts} +309 -144
- package/build/internal/es/src/benefit-programs-v1-pool-pools.universal.js +553 -0
- package/build/internal/es/src/benefit-programs-v1-pool-pools.universal.js.map +1 -0
- package/package.json +13 -14
- package/build/index.d.mts +0 -105
- package/build/index.d.ts +0 -105
- package/build/index.js +0 -949
- package/build/index.js.map +0 -1
- package/build/index.mjs +0 -905
- package/build/index.mjs.map +0 -1
- package/build/internal/index.d.mts +0 -105
- package/build/internal/index.d.ts +0 -105
- package/build/internal/index.js +0 -949
- package/build/internal/index.js.map +0 -1
- package/build/internal/index.mjs +0 -905
- package/build/internal/index.mjs.map +0 -1
- package/build/internal/meta.d.mts +0 -776
- package/build/internal/meta.d.ts +0 -776
- package/build/internal/meta.js +0 -627
- package/build/internal/meta.js.map +0 -1
- package/build/internal/meta.mjs +0 -593
- package/build/internal/meta.mjs.map +0 -1
- package/build/meta.d.mts +0 -776
- package/build/meta.d.ts +0 -776
- package/build/meta.js +0 -627
- package/build/meta.js.map +0 -1
- package/build/meta.mjs +0 -593
- package/build/meta.mjs.map +0 -1
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
+
export interface Pool {
|
|
2
3
|
/**
|
|
3
4
|
* Pool ID.
|
|
4
5
|
* @format GUID
|
|
@@ -100,7 +101,7 @@ interface Pool {
|
|
|
100
101
|
*/
|
|
101
102
|
renewalCount?: number | null;
|
|
102
103
|
}
|
|
103
|
-
declare enum PoolStatus {
|
|
104
|
+
export declare enum PoolStatus {
|
|
104
105
|
/** Undefined pool status. */
|
|
105
106
|
UNDEFINED = "UNDEFINED",
|
|
106
107
|
/** Pool is active. */
|
|
@@ -114,7 +115,7 @@ declare enum PoolStatus {
|
|
|
114
115
|
/** Pool renewing is in progress. This status exists for a short time during processing. */
|
|
115
116
|
RENEWING = "RENEWING"
|
|
116
117
|
}
|
|
117
|
-
interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
|
|
118
|
+
export interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
|
|
118
119
|
/**
|
|
119
120
|
* ID of a site visitor that hasn't logged in to the site.
|
|
120
121
|
* @format GUID
|
|
@@ -132,7 +133,7 @@ interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
|
|
|
132
133
|
wixUserId?: string;
|
|
133
134
|
}
|
|
134
135
|
/** @oneof */
|
|
135
|
-
interface CommonIdentificationDataIdOneOf {
|
|
136
|
+
export interface CommonIdentificationDataIdOneOf {
|
|
136
137
|
/**
|
|
137
138
|
* ID of a site visitor that hasn't logged in to the site.
|
|
138
139
|
* @format GUID
|
|
@@ -149,7 +150,7 @@ interface CommonIdentificationDataIdOneOf {
|
|
|
149
150
|
*/
|
|
150
151
|
wixUserId?: string;
|
|
151
152
|
}
|
|
152
|
-
declare enum IdentityType {
|
|
153
|
+
export declare enum IdentityType {
|
|
153
154
|
/** Unknown type. This value is not used. */
|
|
154
155
|
UNKNOWN = "UNKNOWN",
|
|
155
156
|
/** A site visitor who has not logged in. */
|
|
@@ -159,7 +160,7 @@ declare enum IdentityType {
|
|
|
159
160
|
/** A Wix account holder, such as a site owner or contributor. */
|
|
160
161
|
WIX_USER = "WIX_USER"
|
|
161
162
|
}
|
|
162
|
-
interface Details {
|
|
163
|
+
export interface Details {
|
|
163
164
|
/**
|
|
164
165
|
* List of benefits.
|
|
165
166
|
* @maxSize 10
|
|
@@ -174,7 +175,7 @@ interface Details {
|
|
|
174
175
|
/** Additional information relating to this object. */
|
|
175
176
|
additionalData?: Record<string, any> | null;
|
|
176
177
|
}
|
|
177
|
-
interface Benefit {
|
|
178
|
+
export interface Benefit {
|
|
178
179
|
/**
|
|
179
180
|
* Unique identifier for this benefit.
|
|
180
181
|
*
|
|
@@ -213,7 +214,7 @@ interface Benefit {
|
|
|
213
214
|
*/
|
|
214
215
|
description?: string | null;
|
|
215
216
|
}
|
|
216
|
-
interface PolicyExpression extends PolicyExpressionExpressionOneOf {
|
|
217
|
+
export interface PolicyExpression extends PolicyExpressionExpressionOneOf {
|
|
217
218
|
/** Benefits can be redeemed if the expression in this object is not fulfilled. */
|
|
218
219
|
operatorNotOptions?: PolicyExpressionNot;
|
|
219
220
|
/** Benefits can be redeemed if all the expression in this object's array are fulfilled. */
|
|
@@ -226,7 +227,7 @@ interface PolicyExpression extends PolicyExpressionExpressionOneOf {
|
|
|
226
227
|
type?: PolicyExpressionType;
|
|
227
228
|
}
|
|
228
229
|
/** @oneof */
|
|
229
|
-
interface PolicyExpressionExpressionOneOf {
|
|
230
|
+
export interface PolicyExpressionExpressionOneOf {
|
|
230
231
|
/** Benefits can be redeemed if the expression in this object is not fulfilled. */
|
|
231
232
|
operatorNotOptions?: PolicyExpressionNot;
|
|
232
233
|
/** Benefits can be redeemed if all the expression in this object's array are fulfilled. */
|
|
@@ -236,7 +237,7 @@ interface PolicyExpressionExpressionOneOf {
|
|
|
236
237
|
/** Defines when benefits can be redeemed or how many benefits can be redeemed in a specific time period. */
|
|
237
238
|
policyOptions?: Policy;
|
|
238
239
|
}
|
|
239
|
-
declare enum PolicyExpressionType {
|
|
240
|
+
export declare enum PolicyExpressionType {
|
|
240
241
|
UNKNOWN = "UNKNOWN",
|
|
241
242
|
/** Use with `operatorNotOptions`. */
|
|
242
243
|
OPERATOR_NOT = "OPERATOR_NOT",
|
|
@@ -247,11 +248,11 @@ declare enum PolicyExpressionType {
|
|
|
247
248
|
/** Use with `policyOptions`. */
|
|
248
249
|
POLICY = "POLICY"
|
|
249
250
|
}
|
|
250
|
-
interface PolicyExpressionNot {
|
|
251
|
+
export interface PolicyExpressionNot {
|
|
251
252
|
/** Policy expression. If this expression is not fulfilled, benefits can be redeemed. */
|
|
252
253
|
expression?: PolicyExpression;
|
|
253
254
|
}
|
|
254
|
-
interface PolicyExpressionAnd {
|
|
255
|
+
export interface PolicyExpressionAnd {
|
|
255
256
|
/**
|
|
256
257
|
* Array of policy expressions. If all expressions are fulfilled, benefits can be redeemed.
|
|
257
258
|
* @minSize 2
|
|
@@ -259,7 +260,7 @@ interface PolicyExpressionAnd {
|
|
|
259
260
|
*/
|
|
260
261
|
expressions?: PolicyExpression[];
|
|
261
262
|
}
|
|
262
|
-
interface PolicyExpressionOr {
|
|
263
|
+
export interface PolicyExpressionOr {
|
|
263
264
|
/**
|
|
264
265
|
* Array of policy expressions. If at least one expression is fulfilled, benefits can be redeemed.
|
|
265
266
|
* @minSize 2
|
|
@@ -267,7 +268,7 @@ interface PolicyExpressionOr {
|
|
|
267
268
|
*/
|
|
268
269
|
expressions?: PolicyExpression[];
|
|
269
270
|
}
|
|
270
|
-
interface Policy extends PolicyPolicyOneOf {
|
|
271
|
+
export interface Policy extends PolicyPolicyOneOf {
|
|
271
272
|
/**
|
|
272
273
|
* Defines an interval during which the policy expression is fulfilled.
|
|
273
274
|
*
|
|
@@ -282,7 +283,7 @@ interface Policy extends PolicyPolicyOneOf {
|
|
|
282
283
|
type?: Type;
|
|
283
284
|
}
|
|
284
285
|
/** @oneof */
|
|
285
|
-
interface PolicyPolicyOneOf {
|
|
286
|
+
export interface PolicyPolicyOneOf {
|
|
286
287
|
/**
|
|
287
288
|
* Defines an interval during which the policy expression is fulfilled.
|
|
288
289
|
*
|
|
@@ -294,7 +295,7 @@ interface PolicyPolicyOneOf {
|
|
|
294
295
|
/** Custom policy defined by a different app. */
|
|
295
296
|
customOptions?: CustomPolicy;
|
|
296
297
|
}
|
|
297
|
-
declare enum Type {
|
|
298
|
+
export declare enum Type {
|
|
298
299
|
/** Unknown policy type. */
|
|
299
300
|
UNKNOWN = "UNKNOWN",
|
|
300
301
|
/** Use with `fixedIntervalOptions`. */
|
|
@@ -304,7 +305,7 @@ declare enum Type {
|
|
|
304
305
|
/** Use with `customOptions`. */
|
|
305
306
|
CUSTOM = "CUSTOM"
|
|
306
307
|
}
|
|
307
|
-
interface FixedIntervalPolicy {
|
|
308
|
+
export interface FixedIntervalPolicy {
|
|
308
309
|
/** Weekday that this interval starts from. If this field is defined, then `toWeekDay` is required. */
|
|
309
310
|
fromWeekDay?: WeekDay;
|
|
310
311
|
/** Weekday that this interval ends at. If this field is defined, then `fromWeekDay` is required. */
|
|
@@ -330,7 +331,7 @@ interface FixedIntervalPolicy {
|
|
|
330
331
|
*/
|
|
331
332
|
toMinute?: number | null;
|
|
332
333
|
}
|
|
333
|
-
declare enum WeekDay {
|
|
334
|
+
export declare enum WeekDay {
|
|
334
335
|
/** Unknown weekday. */
|
|
335
336
|
UNKNOWN = "UNKNOWN",
|
|
336
337
|
/** Monday. */
|
|
@@ -348,7 +349,7 @@ declare enum WeekDay {
|
|
|
348
349
|
/** Sunday. */
|
|
349
350
|
SUNDAY = "SUNDAY"
|
|
350
351
|
}
|
|
351
|
-
interface RateLimitedPolicy extends RateLimitedPolicyPeriodOneOf {
|
|
352
|
+
export interface RateLimitedPolicy extends RateLimitedPolicyPeriodOneOf {
|
|
352
353
|
/** Fixed interval used to limit benefit redemption. */
|
|
353
354
|
fixedIntervalOptions?: FixedIntervalPolicy;
|
|
354
355
|
/** Maximum number of times a benefit can be redeemed per specified time period. */
|
|
@@ -357,11 +358,11 @@ interface RateLimitedPolicy extends RateLimitedPolicyPeriodOneOf {
|
|
|
357
358
|
type?: RateLimitedPolicyType;
|
|
358
359
|
}
|
|
359
360
|
/** @oneof */
|
|
360
|
-
interface RateLimitedPolicyPeriodOneOf {
|
|
361
|
+
export interface RateLimitedPolicyPeriodOneOf {
|
|
361
362
|
/** Fixed interval used to limit benefit redemption. */
|
|
362
363
|
fixedIntervalOptions?: FixedIntervalPolicy;
|
|
363
364
|
}
|
|
364
|
-
declare enum RateLimitedPolicyType {
|
|
365
|
+
export declare enum RateLimitedPolicyType {
|
|
365
366
|
/** Unknown rate limit method. */
|
|
366
367
|
UNKNOWN = "UNKNOWN",
|
|
367
368
|
/** Time period is defined using `fixedIntervalOptions`. */
|
|
@@ -370,7 +371,7 @@ declare enum RateLimitedPolicyType {
|
|
|
370
371
|
PER_CYCLE = "PER_CYCLE"
|
|
371
372
|
}
|
|
372
373
|
/** Custom policy as implemented by the Entitlement Policy Provider */
|
|
373
|
-
interface CustomPolicy {
|
|
374
|
+
export interface CustomPolicy {
|
|
374
375
|
/**
|
|
375
376
|
* Policy ID.
|
|
376
377
|
* @format GUID
|
|
@@ -384,7 +385,7 @@ interface CustomPolicy {
|
|
|
384
385
|
/** Additional information for this custom policy. */
|
|
385
386
|
additionalData?: Record<string, any> | null;
|
|
386
387
|
}
|
|
387
|
-
interface CreditConfiguration {
|
|
388
|
+
export interface CreditConfiguration {
|
|
388
389
|
/**
|
|
389
390
|
* Initial available amount for associated balances.
|
|
390
391
|
* @decimalValue options { gte:0, maxScale:4 }
|
|
@@ -398,7 +399,7 @@ interface CreditConfiguration {
|
|
|
398
399
|
*/
|
|
399
400
|
unitDisplayName?: string | null;
|
|
400
401
|
}
|
|
401
|
-
interface RolloverConfiguration {
|
|
402
|
+
export interface RolloverConfiguration {
|
|
402
403
|
/** Whether unused credits roll over to a new cycle when a program renews. */
|
|
403
404
|
enabled?: boolean | null;
|
|
404
405
|
/**
|
|
@@ -407,7 +408,7 @@ interface RolloverConfiguration {
|
|
|
407
408
|
*/
|
|
408
409
|
balanceCap?: string | null;
|
|
409
410
|
}
|
|
410
|
-
interface ExtendedFields {
|
|
411
|
+
export interface ExtendedFields {
|
|
411
412
|
/**
|
|
412
413
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
413
414
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -418,7 +419,7 @@ interface ExtendedFields {
|
|
|
418
419
|
*/
|
|
419
420
|
namespaces?: Record<string, Record<string, any>>;
|
|
420
421
|
}
|
|
421
|
-
interface ProgramDefinitionInfo {
|
|
422
|
+
export interface ProgramDefinitionInfo {
|
|
422
423
|
/**
|
|
423
424
|
* Program definition ID.
|
|
424
425
|
* @format GUID
|
|
@@ -432,7 +433,7 @@ interface ProgramDefinitionInfo {
|
|
|
432
433
|
*/
|
|
433
434
|
externalId?: string | null;
|
|
434
435
|
}
|
|
435
|
-
interface PoolProgramInfo {
|
|
436
|
+
export interface PoolProgramInfo {
|
|
436
437
|
/**
|
|
437
438
|
* Program ID.
|
|
438
439
|
* @format GUID
|
|
@@ -446,7 +447,7 @@ interface PoolProgramInfo {
|
|
|
446
447
|
*/
|
|
447
448
|
externalId?: string | null;
|
|
448
449
|
}
|
|
449
|
-
declare enum PoolOrigin {
|
|
450
|
+
export declare enum PoolOrigin {
|
|
450
451
|
/** Unknown pool origin. */
|
|
451
452
|
UNKNOWN = "UNKNOWN",
|
|
452
453
|
/** Benefit pool created by a program provision. */
|
|
@@ -454,21 +455,21 @@ declare enum PoolOrigin {
|
|
|
454
455
|
/** Benefit pool was created when pool definition was added to program definition. */
|
|
455
456
|
CASCADE = "CASCADE"
|
|
456
457
|
}
|
|
457
|
-
interface PoolProvisioned {
|
|
458
|
+
export interface PoolProvisioned {
|
|
458
459
|
/** Pool which has been provisioned */
|
|
459
460
|
pool?: Pool;
|
|
460
461
|
}
|
|
461
|
-
interface PoolRenewed {
|
|
462
|
+
export interface PoolRenewed {
|
|
462
463
|
/** Pool which has been granted */
|
|
463
464
|
pool?: Pool;
|
|
464
465
|
}
|
|
465
|
-
interface BenefitRedeemed {
|
|
466
|
+
export interface BenefitRedeemed {
|
|
466
467
|
/** Pool which has been redeemed */
|
|
467
468
|
pool?: Pool;
|
|
468
469
|
/** Details of the redemption */
|
|
469
470
|
redemptionDetails?: RedemptionDetails;
|
|
470
471
|
}
|
|
471
|
-
interface RedemptionDetails {
|
|
472
|
+
export interface RedemptionDetails {
|
|
472
473
|
/**
|
|
473
474
|
* Id of the redemption transaction
|
|
474
475
|
* @format GUID
|
|
@@ -496,7 +497,7 @@ interface RedemptionDetails {
|
|
|
496
497
|
/** Beneficiary of the entitlement */
|
|
497
498
|
beneficiary?: CommonIdentificationData;
|
|
498
499
|
}
|
|
499
|
-
interface ItemReference {
|
|
500
|
+
export interface ItemReference {
|
|
500
501
|
/**
|
|
501
502
|
* External ID of the item.
|
|
502
503
|
* @format GUID
|
|
@@ -513,25 +514,25 @@ interface ItemReference {
|
|
|
513
514
|
*/
|
|
514
515
|
providerAppId?: string;
|
|
515
516
|
}
|
|
516
|
-
interface PoolPaused {
|
|
517
|
+
export interface PoolPaused {
|
|
517
518
|
/** Pool which has been paused */
|
|
518
519
|
pool?: Pool;
|
|
519
520
|
}
|
|
520
|
-
interface PoolResumed {
|
|
521
|
+
export interface PoolResumed {
|
|
521
522
|
/** Pool which has been resumed */
|
|
522
523
|
pool?: Pool;
|
|
523
524
|
}
|
|
524
|
-
interface PoolEnded {
|
|
525
|
+
export interface PoolEnded {
|
|
525
526
|
/** Pool which has been ended */
|
|
526
527
|
pool?: Pool;
|
|
527
528
|
}
|
|
528
|
-
interface BenefitReserved {
|
|
529
|
+
export interface BenefitReserved {
|
|
529
530
|
/** Pool which was used to perform this transaction */
|
|
530
531
|
pool?: Pool;
|
|
531
532
|
/** Details of the redemption */
|
|
532
533
|
redemptionDetails?: RedemptionDetails;
|
|
533
534
|
}
|
|
534
|
-
interface BenefitReservationCanceled {
|
|
535
|
+
export interface BenefitReservationCanceled {
|
|
535
536
|
/** Pool which was used to perform this transaction */
|
|
536
537
|
pool?: Pool;
|
|
537
538
|
/**
|
|
@@ -540,7 +541,7 @@ interface BenefitReservationCanceled {
|
|
|
540
541
|
*/
|
|
541
542
|
transactionId?: string;
|
|
542
543
|
}
|
|
543
|
-
interface BenefitReservationReleased {
|
|
544
|
+
export interface BenefitReservationReleased {
|
|
544
545
|
/** Pool which was used to perform this transaction */
|
|
545
546
|
pool?: Pool;
|
|
546
547
|
/**
|
|
@@ -549,7 +550,7 @@ interface BenefitReservationReleased {
|
|
|
549
550
|
*/
|
|
550
551
|
transactionId?: string;
|
|
551
552
|
}
|
|
552
|
-
interface PoolProvisionJobFinished {
|
|
553
|
+
export interface PoolProvisionJobFinished {
|
|
553
554
|
/**
|
|
554
555
|
* Program id
|
|
555
556
|
* @format GUID
|
|
@@ -560,7 +561,7 @@ interface PoolProvisionJobFinished {
|
|
|
560
561
|
/** Origin of the pool */
|
|
561
562
|
origin?: PoolOrigin;
|
|
562
563
|
}
|
|
563
|
-
interface PoolStatusUpdateJobFinished extends PoolStatusUpdateJobFinishedContextOneOf {
|
|
564
|
+
export interface PoolStatusUpdateJobFinished extends PoolStatusUpdateJobFinishedContextOneOf {
|
|
564
565
|
/** The id of the pool definition that is being updated */
|
|
565
566
|
poolDefinitionAndProgramDefinition?: PoolDefinitionAndProgramDefinition;
|
|
566
567
|
/** Update the status of all pools in the program */
|
|
@@ -571,13 +572,13 @@ interface PoolStatusUpdateJobFinished extends PoolStatusUpdateJobFinishedContext
|
|
|
571
572
|
processedItemCount?: number;
|
|
572
573
|
}
|
|
573
574
|
/** @oneof */
|
|
574
|
-
interface PoolStatusUpdateJobFinishedContextOneOf {
|
|
575
|
+
export interface PoolStatusUpdateJobFinishedContextOneOf {
|
|
575
576
|
/** The id of the pool definition that is being updated */
|
|
576
577
|
poolDefinitionAndProgramDefinition?: PoolDefinitionAndProgramDefinition;
|
|
577
578
|
/** Update the status of all pools in the program */
|
|
578
579
|
programInfo?: ProgramInfo;
|
|
579
580
|
}
|
|
580
|
-
interface PoolDefinitionAndProgramDefinition {
|
|
581
|
+
export interface PoolDefinitionAndProgramDefinition {
|
|
581
582
|
/**
|
|
582
583
|
* The id of the pool definition that is being updated
|
|
583
584
|
* @format GUID
|
|
@@ -590,7 +591,7 @@ interface PoolDefinitionAndProgramDefinition {
|
|
|
590
591
|
*/
|
|
591
592
|
programDefinitionId?: string | null;
|
|
592
593
|
}
|
|
593
|
-
interface ProgramInfo {
|
|
594
|
+
export interface ProgramInfo {
|
|
594
595
|
/**
|
|
595
596
|
* The key of the program that is being updated
|
|
596
597
|
* @format GUID
|
|
@@ -599,47 +600,47 @@ interface ProgramInfo {
|
|
|
599
600
|
/** Additional data that was provided when the job was submitted */
|
|
600
601
|
additionalData?: Record<string, any> | null;
|
|
601
602
|
}
|
|
602
|
-
interface CreatePoolRequest {
|
|
603
|
+
export interface CreatePoolRequest {
|
|
603
604
|
/** Pool to be created. */
|
|
604
605
|
pool?: Pool;
|
|
605
606
|
}
|
|
606
|
-
interface CreatePoolResponse {
|
|
607
|
+
export interface CreatePoolResponse {
|
|
607
608
|
/** Created pool. */
|
|
608
609
|
pool?: Pool;
|
|
609
610
|
}
|
|
610
|
-
interface GetPoolRequest {
|
|
611
|
+
export interface GetPoolRequest {
|
|
611
612
|
/**
|
|
612
613
|
* ID of the pool to retrieve.
|
|
613
614
|
* @format GUID
|
|
614
615
|
*/
|
|
615
616
|
poolId: string;
|
|
616
617
|
}
|
|
617
|
-
interface GetPoolResponse {
|
|
618
|
+
export interface GetPoolResponse {
|
|
618
619
|
/** Retrieved pool. */
|
|
619
620
|
pool?: Pool;
|
|
620
621
|
}
|
|
621
|
-
interface UpdatePoolRequest {
|
|
622
|
+
export interface UpdatePoolRequest {
|
|
622
623
|
/** Pool to update. */
|
|
623
624
|
pool: Pool;
|
|
624
625
|
}
|
|
625
|
-
interface UpdatePoolResponse {
|
|
626
|
+
export interface UpdatePoolResponse {
|
|
626
627
|
/** Updated pool. */
|
|
627
628
|
pool?: Pool;
|
|
628
629
|
}
|
|
629
|
-
interface DeletePoolRequest {
|
|
630
|
+
export interface DeletePoolRequest {
|
|
630
631
|
/**
|
|
631
632
|
* ID of the pool to delete.
|
|
632
633
|
* @format GUID
|
|
633
634
|
*/
|
|
634
635
|
poolId?: string;
|
|
635
636
|
}
|
|
636
|
-
interface DeletePoolResponse {
|
|
637
|
+
export interface DeletePoolResponse {
|
|
637
638
|
}
|
|
638
|
-
interface QueryPoolsRequest {
|
|
639
|
+
export interface QueryPoolsRequest {
|
|
639
640
|
/** Filter, sort, and paging to apply to the query. */
|
|
640
641
|
query: CursorQuery;
|
|
641
642
|
}
|
|
642
|
-
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
643
|
+
export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
643
644
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
644
645
|
cursorPaging?: CursorPaging;
|
|
645
646
|
/**
|
|
@@ -655,11 +656,11 @@ interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
655
656
|
sort?: Sorting[];
|
|
656
657
|
}
|
|
657
658
|
/** @oneof */
|
|
658
|
-
interface CursorQueryPagingMethodOneOf {
|
|
659
|
+
export interface CursorQueryPagingMethodOneOf {
|
|
659
660
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
660
661
|
cursorPaging?: CursorPaging;
|
|
661
662
|
}
|
|
662
|
-
interface Sorting {
|
|
663
|
+
export interface Sorting {
|
|
663
664
|
/**
|
|
664
665
|
* Field to sort by.
|
|
665
666
|
* @maxLength 512
|
|
@@ -672,13 +673,13 @@ interface Sorting {
|
|
|
672
673
|
*/
|
|
673
674
|
order?: SortOrder;
|
|
674
675
|
}
|
|
675
|
-
declare enum SortOrder {
|
|
676
|
+
export declare enum SortOrder {
|
|
676
677
|
/** Ascending sort order. */
|
|
677
678
|
ASC = "ASC",
|
|
678
679
|
/** Descending sort order. */
|
|
679
680
|
DESC = "DESC"
|
|
680
681
|
}
|
|
681
|
-
interface CursorPaging {
|
|
682
|
+
export interface CursorPaging {
|
|
682
683
|
/**
|
|
683
684
|
* Maximum number of items to return.
|
|
684
685
|
* @max 100
|
|
@@ -693,13 +694,13 @@ interface CursorPaging {
|
|
|
693
694
|
*/
|
|
694
695
|
cursor?: string | null;
|
|
695
696
|
}
|
|
696
|
-
interface QueryPoolsResponse {
|
|
697
|
+
export interface QueryPoolsResponse {
|
|
697
698
|
/** List of retrieved pools. */
|
|
698
699
|
pools?: Pool[];
|
|
699
700
|
/** Metadata for the paginated results. */
|
|
700
701
|
metadata?: CursorPagingMetadata;
|
|
701
702
|
}
|
|
702
|
-
interface CursorPagingMetadata {
|
|
703
|
+
export interface CursorPagingMetadata {
|
|
703
704
|
/** Number of items returned in the response. */
|
|
704
705
|
count?: number | null;
|
|
705
706
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -712,7 +713,7 @@ interface CursorPagingMetadata {
|
|
|
712
713
|
*/
|
|
713
714
|
hasNext?: boolean | null;
|
|
714
715
|
}
|
|
715
|
-
interface Cursors {
|
|
716
|
+
export interface Cursors {
|
|
716
717
|
/**
|
|
717
718
|
* Cursor string pointing to the next page in the list of results.
|
|
718
719
|
* @maxLength 16000
|
|
@@ -724,7 +725,7 @@ interface Cursors {
|
|
|
724
725
|
*/
|
|
725
726
|
prev?: string | null;
|
|
726
727
|
}
|
|
727
|
-
interface RedeemBenefitRequest {
|
|
728
|
+
export interface RedeemBenefitRequest {
|
|
728
729
|
/**
|
|
729
730
|
* ID of the pool that contains the benefit to redeem.
|
|
730
731
|
* @format GUID
|
|
@@ -765,14 +766,14 @@ interface RedeemBenefitRequest {
|
|
|
765
766
|
*/
|
|
766
767
|
namespace: string;
|
|
767
768
|
}
|
|
768
|
-
interface RedeemBenefitResponse {
|
|
769
|
+
export interface RedeemBenefitResponse {
|
|
769
770
|
/**
|
|
770
771
|
* ID of the transaction recording the associated change in balance.
|
|
771
772
|
* @format GUID
|
|
772
773
|
*/
|
|
773
774
|
transactionId?: string;
|
|
774
775
|
}
|
|
775
|
-
interface NotEnoughBalance {
|
|
776
|
+
export interface NotEnoughBalance {
|
|
776
777
|
/**
|
|
777
778
|
* Pool ID.
|
|
778
779
|
* @format GUID
|
|
@@ -791,7 +792,7 @@ interface NotEnoughBalance {
|
|
|
791
792
|
*/
|
|
792
793
|
requestedBalance?: string;
|
|
793
794
|
}
|
|
794
|
-
interface PolicyExpressionEvaluatedToFalse {
|
|
795
|
+
export interface PolicyExpressionEvaluatedToFalse {
|
|
795
796
|
/**
|
|
796
797
|
* Pool ID.
|
|
797
798
|
* @format GUID
|
|
@@ -805,7 +806,7 @@ interface PolicyExpressionEvaluatedToFalse {
|
|
|
805
806
|
*/
|
|
806
807
|
failureDetails?: FailureDetails[];
|
|
807
808
|
}
|
|
808
|
-
interface FailureDetails {
|
|
809
|
+
export interface FailureDetails {
|
|
809
810
|
/**
|
|
810
811
|
* Failure code
|
|
811
812
|
* @minLength 1
|
|
@@ -830,7 +831,7 @@ interface FailureDetails {
|
|
|
830
831
|
/** Information provided by the policy */
|
|
831
832
|
errorData?: Record<string, any> | null;
|
|
832
833
|
}
|
|
833
|
-
interface PoolNotActive {
|
|
834
|
+
export interface PoolNotActive {
|
|
834
835
|
/**
|
|
835
836
|
* Pool ID.
|
|
836
837
|
* @format GUID
|
|
@@ -839,14 +840,14 @@ interface PoolNotActive {
|
|
|
839
840
|
/** Pool status. */
|
|
840
841
|
poolStatus?: PoolStatus;
|
|
841
842
|
}
|
|
842
|
-
interface PoolNotFound {
|
|
843
|
+
export interface PoolNotFound {
|
|
843
844
|
/**
|
|
844
845
|
* Pool ID.
|
|
845
846
|
* @format GUID
|
|
846
847
|
*/
|
|
847
848
|
poolId?: string;
|
|
848
849
|
}
|
|
849
|
-
interface BenefitAlreadyRedeemed {
|
|
850
|
+
export interface BenefitAlreadyRedeemed {
|
|
850
851
|
/**
|
|
851
852
|
* Pool ID
|
|
852
853
|
* @format GUID
|
|
@@ -858,7 +859,7 @@ interface BenefitAlreadyRedeemed {
|
|
|
858
859
|
*/
|
|
859
860
|
idempotencyKey?: string;
|
|
860
861
|
}
|
|
861
|
-
interface BenefitNotFound {
|
|
862
|
+
export interface BenefitNotFound {
|
|
862
863
|
/**
|
|
863
864
|
* Pool ID.
|
|
864
865
|
* @format GUID
|
|
@@ -870,7 +871,7 @@ interface BenefitNotFound {
|
|
|
870
871
|
*/
|
|
871
872
|
benefitKey?: string | null;
|
|
872
873
|
}
|
|
873
|
-
interface ReserveBenefitRequest {
|
|
874
|
+
export interface ReserveBenefitRequest {
|
|
874
875
|
/**
|
|
875
876
|
* Id of the pool that is being redeemed from
|
|
876
877
|
* @format GUID
|
|
@@ -920,42 +921,42 @@ interface ReserveBenefitRequest {
|
|
|
920
921
|
*/
|
|
921
922
|
namespace?: string;
|
|
922
923
|
}
|
|
923
|
-
interface ReserveBenefitResponse {
|
|
924
|
+
export interface ReserveBenefitResponse {
|
|
924
925
|
/**
|
|
925
926
|
* Id of the transaction that was created as a result of this request
|
|
926
927
|
* @format GUID
|
|
927
928
|
*/
|
|
928
929
|
transactionId?: string;
|
|
929
930
|
}
|
|
930
|
-
interface CancelBenefitReservationRequest {
|
|
931
|
+
export interface CancelBenefitReservationRequest {
|
|
931
932
|
/**
|
|
932
933
|
* Id of the transaction that was created as a result of this request
|
|
933
934
|
* @format GUID
|
|
934
935
|
*/
|
|
935
936
|
transactionId?: string;
|
|
936
937
|
}
|
|
937
|
-
interface CancelBenefitReservationResponse {
|
|
938
|
+
export interface CancelBenefitReservationResponse {
|
|
938
939
|
/**
|
|
939
940
|
* Id of the transaction that was created as a result of this request
|
|
940
941
|
* @format GUID
|
|
941
942
|
*/
|
|
942
943
|
transactionId?: string;
|
|
943
944
|
}
|
|
944
|
-
interface ReleaseBenefitReservationRequest {
|
|
945
|
+
export interface ReleaseBenefitReservationRequest {
|
|
945
946
|
/**
|
|
946
947
|
* Id of the transaction that was created as a result of this request
|
|
947
948
|
* @format GUID
|
|
948
949
|
*/
|
|
949
950
|
transactionId?: string;
|
|
950
951
|
}
|
|
951
|
-
interface ReleaseBenefitReservationResponse {
|
|
952
|
+
export interface ReleaseBenefitReservationResponse {
|
|
952
953
|
/**
|
|
953
954
|
* Id of the transaction that was created as a result of this request
|
|
954
955
|
* @format GUID
|
|
955
956
|
*/
|
|
956
957
|
transactionId?: string;
|
|
957
958
|
}
|
|
958
|
-
interface CheckBenefitEligibilityRequest {
|
|
959
|
+
export interface CheckBenefitEligibilityRequest {
|
|
959
960
|
/**
|
|
960
961
|
* ID of the pool that the benefit to check belongs to.
|
|
961
962
|
* @format GUID
|
|
@@ -992,11 +993,11 @@ interface CheckBenefitEligibilityRequest {
|
|
|
992
993
|
*/
|
|
993
994
|
namespace: string;
|
|
994
995
|
}
|
|
995
|
-
interface CheckBenefitEligibilityResponse {
|
|
996
|
+
export interface CheckBenefitEligibilityResponse {
|
|
996
997
|
/** Result of the eligibility check. */
|
|
997
998
|
result?: EligibilityCheckResult;
|
|
998
999
|
}
|
|
999
|
-
interface EligibilityCheckResult extends EligibilityCheckResultResultOneOf {
|
|
1000
|
+
export interface EligibilityCheckResult extends EligibilityCheckResultResultOneOf {
|
|
1000
1001
|
/** Returned when item is eligible to be redeemed. */
|
|
1001
1002
|
eligibleOptions?: Eligible;
|
|
1002
1003
|
/** Returned when the pool's associated balance is lower than the cost of redeeming the items. */
|
|
@@ -1011,7 +1012,7 @@ interface EligibilityCheckResult extends EligibilityCheckResultResultOneOf {
|
|
|
1011
1012
|
type?: EligibilityCheckResultType;
|
|
1012
1013
|
}
|
|
1013
1014
|
/** @oneof */
|
|
1014
|
-
interface EligibilityCheckResultResultOneOf {
|
|
1015
|
+
export interface EligibilityCheckResultResultOneOf {
|
|
1015
1016
|
/** Returned when item is eligible to be redeemed. */
|
|
1016
1017
|
eligibleOptions?: Eligible;
|
|
1017
1018
|
/** Returned when the pool's associated balance is lower than the cost of redeeming the items. */
|
|
@@ -1023,7 +1024,7 @@ interface EligibilityCheckResultResultOneOf {
|
|
|
1023
1024
|
/** Returned when invalid pool details are provided. */
|
|
1024
1025
|
poolNotFoundOptions?: PoolNotFound;
|
|
1025
1026
|
}
|
|
1026
|
-
interface EligibleBenefit {
|
|
1027
|
+
export interface EligibleBenefit {
|
|
1027
1028
|
/**
|
|
1028
1029
|
* Pool ID.
|
|
1029
1030
|
* @format GUID
|
|
@@ -1043,7 +1044,7 @@ interface EligibleBenefit {
|
|
|
1043
1044
|
*/
|
|
1044
1045
|
price?: string | null;
|
|
1045
1046
|
}
|
|
1046
|
-
declare enum EligibilityCheckResultType {
|
|
1047
|
+
export declare enum EligibilityCheckResultType {
|
|
1047
1048
|
/** Unknown eligibility. */
|
|
1048
1049
|
UNKNOWN = "UNKNOWN",
|
|
1049
1050
|
/** Item is eligible to be redeemed. */
|
|
@@ -1057,14 +1058,14 @@ declare enum EligibilityCheckResultType {
|
|
|
1057
1058
|
/** Invalid pool details provided. */
|
|
1058
1059
|
POOL_NOT_FOUND = "POOL_NOT_FOUND"
|
|
1059
1060
|
}
|
|
1060
|
-
interface Eligible {
|
|
1061
|
+
export interface Eligible {
|
|
1061
1062
|
/**
|
|
1062
1063
|
* Benefits that are eligible to be redeemed.
|
|
1063
1064
|
* @maxSize 100
|
|
1064
1065
|
*/
|
|
1065
1066
|
eligibleBenefits?: EligibleBenefit[];
|
|
1066
1067
|
}
|
|
1067
|
-
interface BulkCheckBenefitEligibilityRequest {
|
|
1068
|
+
export interface BulkCheckBenefitEligibilityRequest {
|
|
1068
1069
|
/**
|
|
1069
1070
|
* List of benefits to check.
|
|
1070
1071
|
* @minSize 1
|
|
@@ -1080,7 +1081,7 @@ interface BulkCheckBenefitEligibilityRequest {
|
|
|
1080
1081
|
/** Pool beneficiary. */
|
|
1081
1082
|
beneficiary?: CommonIdentificationData;
|
|
1082
1083
|
}
|
|
1083
|
-
interface BenefitSelector {
|
|
1084
|
+
export interface BenefitSelector {
|
|
1084
1085
|
/**
|
|
1085
1086
|
* ID of the pool that the benefit to check belongs to.
|
|
1086
1087
|
* @format GUID
|
|
@@ -1109,7 +1110,7 @@ interface BenefitSelector {
|
|
|
1109
1110
|
/** Additional information. */
|
|
1110
1111
|
additionalData?: Record<string, any> | null;
|
|
1111
1112
|
}
|
|
1112
|
-
interface BulkCheckBenefitEligibilityResponse {
|
|
1113
|
+
export interface BulkCheckBenefitEligibilityResponse {
|
|
1113
1114
|
/**
|
|
1114
1115
|
* List of results checking each benefit.
|
|
1115
1116
|
* @minSize 1
|
|
@@ -1117,13 +1118,13 @@ interface BulkCheckBenefitEligibilityResponse {
|
|
|
1117
1118
|
*/
|
|
1118
1119
|
results?: BulkEligibilityCheckResult[];
|
|
1119
1120
|
}
|
|
1120
|
-
interface BulkEligibilityCheckResult {
|
|
1121
|
+
export interface BulkEligibilityCheckResult {
|
|
1121
1122
|
/** Benefit information specified in API call. */
|
|
1122
1123
|
benefitSelector?: BenefitSelector;
|
|
1123
1124
|
/** Result of the eligibility check. */
|
|
1124
1125
|
result?: EligibilityCheckResult;
|
|
1125
1126
|
}
|
|
1126
|
-
interface GetEligibleBenefitsRequest {
|
|
1127
|
+
export interface GetEligibleBenefitsRequest {
|
|
1127
1128
|
/** Item reference. */
|
|
1128
1129
|
itemReference: ItemReference;
|
|
1129
1130
|
/**
|
|
@@ -1148,21 +1149,21 @@ interface GetEligibleBenefitsRequest {
|
|
|
1148
1149
|
*/
|
|
1149
1150
|
namespace: string;
|
|
1150
1151
|
}
|
|
1151
|
-
interface GetEligibleBenefitsResponse {
|
|
1152
|
+
export interface GetEligibleBenefitsResponse {
|
|
1152
1153
|
/** Retrieved benefits that can be redeemed. */
|
|
1153
1154
|
eligibleBenefits?: EligibleBenefit[];
|
|
1154
1155
|
}
|
|
1155
|
-
interface ListPoolsRequest {
|
|
1156
|
+
export interface ListPoolsRequest {
|
|
1156
1157
|
/** The filter */
|
|
1157
1158
|
filter?: Filter;
|
|
1158
1159
|
/** Cursor paging */
|
|
1159
1160
|
cursorPaging?: CursorPaging;
|
|
1160
1161
|
}
|
|
1161
|
-
declare enum ListPoolsRequestType {
|
|
1162
|
+
export declare enum ListPoolsRequestType {
|
|
1162
1163
|
UNKNOWN_FILTER = "UNKNOWN_FILTER",
|
|
1163
1164
|
BY_ITEM_REFERENCE = "BY_ITEM_REFERENCE"
|
|
1164
1165
|
}
|
|
1165
|
-
interface ByItemReference {
|
|
1166
|
+
export interface ByItemReference {
|
|
1166
1167
|
/**
|
|
1167
1168
|
* A list of filters
|
|
1168
1169
|
* @maxSize 100
|
|
@@ -1176,11 +1177,11 @@ interface ByItemReference {
|
|
|
1176
1177
|
*/
|
|
1177
1178
|
poolStatuses?: PoolStatus[];
|
|
1178
1179
|
}
|
|
1179
|
-
interface ByItemReferenceFilter {
|
|
1180
|
+
export interface ByItemReferenceFilter {
|
|
1180
1181
|
/** Reference of the item */
|
|
1181
1182
|
itemReference?: ItemReference;
|
|
1182
1183
|
}
|
|
1183
|
-
interface Filter extends FilterFilterOneOf {
|
|
1184
|
+
export interface Filter extends FilterFilterOneOf {
|
|
1184
1185
|
/** A list of filters by reference */
|
|
1185
1186
|
byItemReferenceOptions?: ByItemReference;
|
|
1186
1187
|
/** Type of the filter */
|
|
@@ -1196,11 +1197,11 @@ interface Filter extends FilterFilterOneOf {
|
|
|
1196
1197
|
namespace?: string;
|
|
1197
1198
|
}
|
|
1198
1199
|
/** @oneof */
|
|
1199
|
-
interface FilterFilterOneOf {
|
|
1200
|
+
export interface FilterFilterOneOf {
|
|
1200
1201
|
/** A list of filters by reference */
|
|
1201
1202
|
byItemReferenceOptions?: ByItemReference;
|
|
1202
1203
|
}
|
|
1203
|
-
interface ListPoolsResponse {
|
|
1204
|
+
export interface ListPoolsResponse {
|
|
1204
1205
|
/**
|
|
1205
1206
|
* The retrieved pools
|
|
1206
1207
|
* @maxSize 100
|
|
@@ -1209,7 +1210,7 @@ interface ListPoolsResponse {
|
|
|
1209
1210
|
/** Paging information */
|
|
1210
1211
|
metadata?: CursorPagingMetadata;
|
|
1211
1212
|
}
|
|
1212
|
-
interface PoolWithItems {
|
|
1213
|
+
export interface PoolWithItems {
|
|
1213
1214
|
/** The pool */
|
|
1214
1215
|
pool?: Pool;
|
|
1215
1216
|
/**
|
|
@@ -1218,7 +1219,7 @@ interface PoolWithItems {
|
|
|
1218
1219
|
*/
|
|
1219
1220
|
itemReference?: ItemReference[];
|
|
1220
1221
|
}
|
|
1221
|
-
interface BulkUpdatePoolsRequest {
|
|
1222
|
+
export interface BulkUpdatePoolsRequest {
|
|
1222
1223
|
/**
|
|
1223
1224
|
* Pools to update.
|
|
1224
1225
|
* @minSize 1
|
|
@@ -1232,13 +1233,13 @@ interface BulkUpdatePoolsRequest {
|
|
|
1232
1233
|
*/
|
|
1233
1234
|
returnEntity?: boolean;
|
|
1234
1235
|
}
|
|
1235
|
-
interface MaskedPool {
|
|
1236
|
+
export interface MaskedPool {
|
|
1236
1237
|
/** Pool to update. */
|
|
1237
1238
|
pool?: Pool;
|
|
1238
1239
|
/** Explicit list of fields to update. */
|
|
1239
1240
|
fieldMask?: string[];
|
|
1240
1241
|
}
|
|
1241
|
-
interface BulkUpdatePoolsResponse {
|
|
1242
|
+
export interface BulkUpdatePoolsResponse {
|
|
1242
1243
|
/**
|
|
1243
1244
|
* List of updated pools and associated metadata.
|
|
1244
1245
|
* @minSize 1
|
|
@@ -1248,13 +1249,13 @@ interface BulkUpdatePoolsResponse {
|
|
|
1248
1249
|
/** Bulk action metadata. */
|
|
1249
1250
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1250
1251
|
}
|
|
1251
|
-
interface BulkPoolResult {
|
|
1252
|
+
export interface BulkPoolResult {
|
|
1252
1253
|
/** Pool metadata. */
|
|
1253
1254
|
poolMetadata?: ItemMetadata;
|
|
1254
1255
|
/** Pool data. */
|
|
1255
1256
|
pool?: Pool;
|
|
1256
1257
|
}
|
|
1257
|
-
interface ItemMetadata {
|
|
1258
|
+
export interface ItemMetadata {
|
|
1258
1259
|
/**
|
|
1259
1260
|
* Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
|
|
1260
1261
|
* @format GUID
|
|
@@ -1267,7 +1268,7 @@ interface ItemMetadata {
|
|
|
1267
1268
|
/** Details about the error in case of failure. */
|
|
1268
1269
|
error?: ApplicationError;
|
|
1269
1270
|
}
|
|
1270
|
-
interface ApplicationError {
|
|
1271
|
+
export interface ApplicationError {
|
|
1271
1272
|
/** Error code. */
|
|
1272
1273
|
code?: string;
|
|
1273
1274
|
/** Description of the error. */
|
|
@@ -1275,7 +1276,7 @@ interface ApplicationError {
|
|
|
1275
1276
|
/** Data related to the error. */
|
|
1276
1277
|
data?: Record<string, any> | null;
|
|
1277
1278
|
}
|
|
1278
|
-
interface BulkActionMetadata {
|
|
1279
|
+
export interface BulkActionMetadata {
|
|
1279
1280
|
/** Number of items that were successfully processed. */
|
|
1280
1281
|
totalSuccesses?: number;
|
|
1281
1282
|
/** Number of items that couldn't be processed. */
|
|
@@ -1283,7 +1284,7 @@ interface BulkActionMetadata {
|
|
|
1283
1284
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
1284
1285
|
undetailedFailures?: number;
|
|
1285
1286
|
}
|
|
1286
|
-
interface ProvisionPoolsForProgramRequest {
|
|
1287
|
+
export interface ProvisionPoolsForProgramRequest {
|
|
1287
1288
|
/** Reference of the template that is used to provision the pools */
|
|
1288
1289
|
poolDefinitionLookupId?: PoolDefinitionLookupId;
|
|
1289
1290
|
/**
|
|
@@ -1292,7 +1293,7 @@ interface ProvisionPoolsForProgramRequest {
|
|
|
1292
1293
|
*/
|
|
1293
1294
|
programId?: string;
|
|
1294
1295
|
}
|
|
1295
|
-
interface PoolDefinitionLookupId extends PoolDefinitionLookupIdIdOneOf {
|
|
1296
|
+
export interface PoolDefinitionLookupId extends PoolDefinitionLookupIdIdOneOf {
|
|
1296
1297
|
/**
|
|
1297
1298
|
* Pool definition ID.
|
|
1298
1299
|
* @format GUID
|
|
@@ -1305,7 +1306,7 @@ interface PoolDefinitionLookupId extends PoolDefinitionLookupIdIdOneOf {
|
|
|
1305
1306
|
programDefinitionId?: string;
|
|
1306
1307
|
}
|
|
1307
1308
|
/** @oneof */
|
|
1308
|
-
interface PoolDefinitionLookupIdIdOneOf {
|
|
1309
|
+
export interface PoolDefinitionLookupIdIdOneOf {
|
|
1309
1310
|
/**
|
|
1310
1311
|
* Pool definition ID.
|
|
1311
1312
|
* @format GUID
|
|
@@ -1317,7 +1318,7 @@ interface PoolDefinitionLookupIdIdOneOf {
|
|
|
1317
1318
|
*/
|
|
1318
1319
|
programDefinitionId?: string;
|
|
1319
1320
|
}
|
|
1320
|
-
interface ProvisionPoolsForProgramResponse extends ProvisionPoolsForProgramResponseResultOneOf {
|
|
1321
|
+
export interface ProvisionPoolsForProgramResponse extends ProvisionPoolsForProgramResponseResultOneOf {
|
|
1321
1322
|
/** Sync result */
|
|
1322
1323
|
syncOptions?: SyncResult;
|
|
1323
1324
|
/** Async result */
|
|
@@ -1331,13 +1332,13 @@ interface ProvisionPoolsForProgramResponse extends ProvisionPoolsForProgramRespo
|
|
|
1331
1332
|
type?: ProvisionPoolsForProgramResponseType;
|
|
1332
1333
|
}
|
|
1333
1334
|
/** @oneof */
|
|
1334
|
-
interface ProvisionPoolsForProgramResponseResultOneOf {
|
|
1335
|
+
export interface ProvisionPoolsForProgramResponseResultOneOf {
|
|
1335
1336
|
/** Sync result */
|
|
1336
1337
|
syncOptions?: SyncResult;
|
|
1337
1338
|
/** Async result */
|
|
1338
1339
|
asyncOptions?: AsyncResult;
|
|
1339
1340
|
}
|
|
1340
|
-
declare enum ProvisionPoolsForProgramResponseType {
|
|
1341
|
+
export declare enum ProvisionPoolsForProgramResponseType {
|
|
1341
1342
|
/** Unknown result type */
|
|
1342
1343
|
UNKNOWN = "UNKNOWN",
|
|
1343
1344
|
/** Sync result */
|
|
@@ -1345,36 +1346,36 @@ declare enum ProvisionPoolsForProgramResponseType {
|
|
|
1345
1346
|
/** Async result */
|
|
1346
1347
|
ASYNC = "ASYNC"
|
|
1347
1348
|
}
|
|
1348
|
-
interface SyncResult {
|
|
1349
|
+
export interface SyncResult {
|
|
1349
1350
|
/** Indicates if the operation was successful */
|
|
1350
1351
|
success?: boolean;
|
|
1351
1352
|
}
|
|
1352
|
-
interface AsyncResult {
|
|
1353
|
+
export interface AsyncResult {
|
|
1353
1354
|
/**
|
|
1354
1355
|
* Job ID of the program provision associated with this pool. Retrieve job details using the Async Job API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)).
|
|
1355
1356
|
* @format GUID
|
|
1356
1357
|
*/
|
|
1357
1358
|
jobId?: string;
|
|
1358
1359
|
}
|
|
1359
|
-
interface InvalidPoolDefinitionReference {
|
|
1360
|
+
export interface InvalidPoolDefinitionReference {
|
|
1360
1361
|
/** Reference of the template that didn't find any pool definitions */
|
|
1361
1362
|
poolDefinitionLookupId?: PoolDefinitionLookupId;
|
|
1362
1363
|
}
|
|
1363
|
-
interface RenewPoolsForProgramRequest {
|
|
1364
|
+
export interface RenewPoolsForProgramRequest {
|
|
1364
1365
|
/**
|
|
1365
1366
|
* Package of pools to grant. Package id should be the same that was used to provision programs.
|
|
1366
1367
|
* @format GUID
|
|
1367
1368
|
*/
|
|
1368
1369
|
programId?: string;
|
|
1369
1370
|
}
|
|
1370
|
-
interface RenewPoolsForProgramResponse {
|
|
1371
|
+
export interface RenewPoolsForProgramResponse {
|
|
1371
1372
|
/**
|
|
1372
1373
|
* Job id of the renewal job
|
|
1373
1374
|
* @format GUID
|
|
1374
1375
|
*/
|
|
1375
1376
|
jobId?: string;
|
|
1376
1377
|
}
|
|
1377
|
-
interface UpdatePoolStatusRequest extends UpdatePoolStatusRequestPoolSelectorOneOf {
|
|
1378
|
+
export interface UpdatePoolStatusRequest extends UpdatePoolStatusRequestPoolSelectorOneOf {
|
|
1378
1379
|
/** Pool selector by pool definition id and program definition id */
|
|
1379
1380
|
byPoolDefinitionIdAndProgramDefinitionIdOptions?: ByPoolDefinitionIdAndProgramDefinitionIdOptions;
|
|
1380
1381
|
/** Pool selector by program id */
|
|
@@ -1385,18 +1386,18 @@ interface UpdatePoolStatusRequest extends UpdatePoolStatusRequestPoolSelectorOne
|
|
|
1385
1386
|
poolSelectorType?: PoolSelectorType;
|
|
1386
1387
|
}
|
|
1387
1388
|
/** @oneof */
|
|
1388
|
-
interface UpdatePoolStatusRequestPoolSelectorOneOf {
|
|
1389
|
+
export interface UpdatePoolStatusRequestPoolSelectorOneOf {
|
|
1389
1390
|
/** Pool selector by pool definition id and program definition id */
|
|
1390
1391
|
byPoolDefinitionIdAndProgramDefinitionIdOptions?: ByPoolDefinitionIdAndProgramDefinitionIdOptions;
|
|
1391
1392
|
/** Pool selector by program id */
|
|
1392
1393
|
byProgramIdOptions?: ByProgramIdOptions;
|
|
1393
1394
|
}
|
|
1394
|
-
declare enum PoolSelectorType {
|
|
1395
|
+
export declare enum PoolSelectorType {
|
|
1395
1396
|
UNKNOWN_SELECTOR = "UNKNOWN_SELECTOR",
|
|
1396
1397
|
BY_POOL_DEFINITION_ID_AND_PROGRAM_DEFINITION_ID = "BY_POOL_DEFINITION_ID_AND_PROGRAM_DEFINITION_ID",
|
|
1397
1398
|
BY_PROGRAM_ID = "BY_PROGRAM_ID"
|
|
1398
1399
|
}
|
|
1399
|
-
interface ByPoolDefinitionIdAndProgramDefinitionIdOptions {
|
|
1400
|
+
export interface ByPoolDefinitionIdAndProgramDefinitionIdOptions {
|
|
1400
1401
|
/**
|
|
1401
1402
|
* Pool definition id
|
|
1402
1403
|
* @format GUID
|
|
@@ -1408,7 +1409,7 @@ interface ByPoolDefinitionIdAndProgramDefinitionIdOptions {
|
|
|
1408
1409
|
*/
|
|
1409
1410
|
programDefinitionId?: string | null;
|
|
1410
1411
|
}
|
|
1411
|
-
interface ByProgramIdOptions {
|
|
1412
|
+
export interface ByProgramIdOptions {
|
|
1412
1413
|
/**
|
|
1413
1414
|
* Program id
|
|
1414
1415
|
* @format GUID
|
|
@@ -1417,25 +1418,25 @@ interface ByProgramIdOptions {
|
|
|
1417
1418
|
/** Additional data that gets added to the event once the async job completes */
|
|
1418
1419
|
additionalData?: Record<string, any> | null;
|
|
1419
1420
|
}
|
|
1420
|
-
interface UpdatePoolStatusResponse {
|
|
1421
|
+
export interface UpdatePoolStatusResponse {
|
|
1421
1422
|
/**
|
|
1422
1423
|
* Job ID of the program provision associated with this pool. Retrieve job details using the Async Job API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)).
|
|
1423
1424
|
* @format GUID
|
|
1424
1425
|
*/
|
|
1425
1426
|
jobId?: string;
|
|
1426
1427
|
}
|
|
1427
|
-
interface CountNumberOfPoolsInProvisioningStatusRequest {
|
|
1428
|
+
export interface CountNumberOfPoolsInProvisioningStatusRequest {
|
|
1428
1429
|
/**
|
|
1429
1430
|
* Program id
|
|
1430
1431
|
* @format GUID
|
|
1431
1432
|
*/
|
|
1432
1433
|
programId?: string;
|
|
1433
1434
|
}
|
|
1434
|
-
interface CountNumberOfPoolsInProvisioningStatusResponse {
|
|
1435
|
+
export interface CountNumberOfPoolsInProvisioningStatusResponse {
|
|
1435
1436
|
/** Number of pools in provisioning status */
|
|
1436
1437
|
count?: number;
|
|
1437
1438
|
}
|
|
1438
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1439
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
1439
1440
|
createdEvent?: EntityCreatedEvent;
|
|
1440
1441
|
updatedEvent?: EntityUpdatedEvent;
|
|
1441
1442
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -1478,19 +1479,19 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1478
1479
|
entityEventSequence?: string | null;
|
|
1479
1480
|
}
|
|
1480
1481
|
/** @oneof */
|
|
1481
|
-
interface DomainEventBodyOneOf {
|
|
1482
|
+
export interface DomainEventBodyOneOf {
|
|
1482
1483
|
createdEvent?: EntityCreatedEvent;
|
|
1483
1484
|
updatedEvent?: EntityUpdatedEvent;
|
|
1484
1485
|
deletedEvent?: EntityDeletedEvent;
|
|
1485
1486
|
actionEvent?: ActionEvent;
|
|
1486
1487
|
}
|
|
1487
|
-
interface EntityCreatedEvent {
|
|
1488
|
+
export interface EntityCreatedEvent {
|
|
1488
1489
|
entity?: string;
|
|
1489
1490
|
}
|
|
1490
|
-
interface RestoreInfo {
|
|
1491
|
+
export interface RestoreInfo {
|
|
1491
1492
|
deletedDate?: Date | null;
|
|
1492
1493
|
}
|
|
1493
|
-
interface EntityUpdatedEvent {
|
|
1494
|
+
export interface EntityUpdatedEvent {
|
|
1494
1495
|
/**
|
|
1495
1496
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1496
1497
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -1498,14 +1499,14 @@ interface EntityUpdatedEvent {
|
|
|
1498
1499
|
*/
|
|
1499
1500
|
currentEntity?: string;
|
|
1500
1501
|
}
|
|
1501
|
-
interface EntityDeletedEvent {
|
|
1502
|
+
export interface EntityDeletedEvent {
|
|
1502
1503
|
/** Entity that was deleted */
|
|
1503
1504
|
deletedEntity?: string | null;
|
|
1504
1505
|
}
|
|
1505
|
-
interface ActionEvent {
|
|
1506
|
+
export interface ActionEvent {
|
|
1506
1507
|
body?: string;
|
|
1507
1508
|
}
|
|
1508
|
-
interface MessageEnvelope {
|
|
1509
|
+
export interface MessageEnvelope {
|
|
1509
1510
|
/**
|
|
1510
1511
|
* App instance ID.
|
|
1511
1512
|
* @format GUID
|
|
@@ -1521,7 +1522,7 @@ interface MessageEnvelope {
|
|
|
1521
1522
|
/** Stringify payload. */
|
|
1522
1523
|
data?: string;
|
|
1523
1524
|
}
|
|
1524
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1525
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1525
1526
|
/**
|
|
1526
1527
|
* ID of a site visitor that has not logged in to the site.
|
|
1527
1528
|
* @format GUID
|
|
@@ -1546,7 +1547,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1546
1547
|
identityType?: WebhookIdentityType;
|
|
1547
1548
|
}
|
|
1548
1549
|
/** @oneof */
|
|
1549
|
-
interface IdentificationDataIdOneOf {
|
|
1550
|
+
export interface IdentificationDataIdOneOf {
|
|
1550
1551
|
/**
|
|
1551
1552
|
* ID of a site visitor that has not logged in to the site.
|
|
1552
1553
|
* @format GUID
|
|
@@ -1568,14 +1569,55 @@ interface IdentificationDataIdOneOf {
|
|
|
1568
1569
|
*/
|
|
1569
1570
|
appId?: string;
|
|
1570
1571
|
}
|
|
1571
|
-
declare enum WebhookIdentityType {
|
|
1572
|
+
export declare enum WebhookIdentityType {
|
|
1572
1573
|
UNKNOWN = "UNKNOWN",
|
|
1573
1574
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1574
1575
|
MEMBER = "MEMBER",
|
|
1575
1576
|
WIX_USER = "WIX_USER",
|
|
1576
1577
|
APP = "APP"
|
|
1577
1578
|
}
|
|
1578
|
-
|
|
1579
|
+
type PoolNonNullablePaths = `status` | `beneficiary.anonymousVisitorId` | `beneficiary.memberId` | `beneficiary.wixUserId` | `details.benefits` | `details.benefits.${number}.benefitKey` | `details.creditConfiguration.amount` | `displayName` | `programDefinition._id` | `program._id`;
|
|
1580
|
+
/**
|
|
1581
|
+
* Retrieves a pool.
|
|
1582
|
+
* @param poolId - ID of the pool to retrieve.
|
|
1583
|
+
* @public
|
|
1584
|
+
* @documentationMaturity preview
|
|
1585
|
+
* @requiredField poolId
|
|
1586
|
+
* @permissionId BENEFIT_PROGRAMS.POOL_READ
|
|
1587
|
+
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
1588
|
+
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
1589
|
+
* @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
|
|
1590
|
+
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
|
|
1591
|
+
* @permissionScope Manage Events
|
|
1592
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1593
|
+
* @applicableIdentity APP
|
|
1594
|
+
* @returns Retrieved pool.
|
|
1595
|
+
* @fqn wix.benefit_programs.v1.pool.PoolService.GetPool
|
|
1596
|
+
*/
|
|
1597
|
+
export declare function getPool(poolId: string): Promise<NonNullablePaths<Pool, PoolNonNullablePaths>>;
|
|
1598
|
+
/**
|
|
1599
|
+
* Updates a pool.
|
|
1600
|
+
*
|
|
1601
|
+
* Each time the pool is updated,
|
|
1602
|
+
* `revision` increments by 1.
|
|
1603
|
+
* The current `revision` must be passed when updating the pool.
|
|
1604
|
+
* This ensures you're working with the latest pool
|
|
1605
|
+
* and prevents unintended overwrites.
|
|
1606
|
+
* @param _id - Pool ID.
|
|
1607
|
+
* @public
|
|
1608
|
+
* @documentationMaturity preview
|
|
1609
|
+
* @requiredField _id
|
|
1610
|
+
* @requiredField pool
|
|
1611
|
+
* @requiredField pool.revision
|
|
1612
|
+
* @permissionId BENEFIT_PROGRAMS.POOL_UPDATE
|
|
1613
|
+
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
1614
|
+
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
1615
|
+
* @applicableIdentity APP
|
|
1616
|
+
* @returns Updated pool.
|
|
1617
|
+
* @fqn wix.benefit_programs.v1.pool.PoolService.UpdatePool
|
|
1618
|
+
*/
|
|
1619
|
+
export declare function updatePool(_id: string, pool: NonNullablePaths<UpdatePool, `revision`>): Promise<NonNullablePaths<Pool, PoolNonNullablePaths>>;
|
|
1620
|
+
export interface UpdatePool {
|
|
1579
1621
|
/**
|
|
1580
1622
|
* Pool ID.
|
|
1581
1623
|
* @format GUID
|
|
@@ -1677,6 +1719,31 @@ interface UpdatePool {
|
|
|
1677
1719
|
*/
|
|
1678
1720
|
renewalCount?: number | null;
|
|
1679
1721
|
}
|
|
1722
|
+
/**
|
|
1723
|
+
* Creates a query to retrieve a list of pools.
|
|
1724
|
+
*
|
|
1725
|
+
* The Query Pools method builds a query to retrieve a list of pools and returns a `PoolsQueryBuilder` object.
|
|
1726
|
+
*
|
|
1727
|
+
* The returned object contains the query definition, which is used to run the query using the `find()` method.
|
|
1728
|
+
*
|
|
1729
|
+
* You can refine the query by chaining `PoolsQueryBuilder` methods onto the query. `PoolsQueryBuilder` methods enable you to filter, sort, and control the results that Query Pools returns.
|
|
1730
|
+
*
|
|
1731
|
+
* Query Pools has a default paging limit of 50, which you can override.
|
|
1732
|
+
*
|
|
1733
|
+
* For a full description of the item object, see the object returned for the `items` property in `PoolsQueryResult`.
|
|
1734
|
+
* @public
|
|
1735
|
+
* @documentationMaturity preview
|
|
1736
|
+
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
1737
|
+
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
1738
|
+
* @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
|
|
1739
|
+
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
|
|
1740
|
+
* @permissionScope Manage Events
|
|
1741
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1742
|
+
* @permissionId BENEFIT_PROGRAMS.POOL_READ
|
|
1743
|
+
* @applicableIdentity APP
|
|
1744
|
+
* @fqn wix.benefit_programs.v1.pool.PoolService.QueryPools
|
|
1745
|
+
*/
|
|
1746
|
+
export declare function queryPools(): PoolsQueryBuilder;
|
|
1680
1747
|
interface QueryCursorResult {
|
|
1681
1748
|
cursors: Cursors;
|
|
1682
1749
|
hasNext: () => boolean;
|
|
@@ -1684,13 +1751,13 @@ interface QueryCursorResult {
|
|
|
1684
1751
|
length: number;
|
|
1685
1752
|
pageSize: number;
|
|
1686
1753
|
}
|
|
1687
|
-
interface PoolsQueryResult extends QueryCursorResult {
|
|
1754
|
+
export interface PoolsQueryResult extends QueryCursorResult {
|
|
1688
1755
|
items: Pool[];
|
|
1689
1756
|
query: PoolsQueryBuilder;
|
|
1690
1757
|
next: () => Promise<PoolsQueryResult>;
|
|
1691
1758
|
prev: () => Promise<PoolsQueryResult>;
|
|
1692
1759
|
}
|
|
1693
|
-
interface PoolsQueryBuilder {
|
|
1760
|
+
export interface PoolsQueryBuilder {
|
|
1694
1761
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1695
1762
|
* @param value - Value to compare against.
|
|
1696
1763
|
* @documentationMaturity preview
|
|
@@ -1754,7 +1821,28 @@ interface PoolsQueryBuilder {
|
|
|
1754
1821
|
/** @documentationMaturity preview */
|
|
1755
1822
|
find: () => Promise<PoolsQueryResult>;
|
|
1756
1823
|
}
|
|
1757
|
-
|
|
1824
|
+
/**
|
|
1825
|
+
* Redeems a specified benefit.
|
|
1826
|
+
*
|
|
1827
|
+
* Calling this method records redemption of the benefit and adjusts the pool's associated balance. You still need to handle providing the beneficiary with the item.
|
|
1828
|
+
* @param poolId - ID of the pool that contains the benefit to redeem.
|
|
1829
|
+
* @public
|
|
1830
|
+
* @documentationMaturity preview
|
|
1831
|
+
* @requiredField options.benefitKey
|
|
1832
|
+
* @requiredField options.idempotencyKey
|
|
1833
|
+
* @requiredField options.itemReference
|
|
1834
|
+
* @requiredField options.itemReference.externalId
|
|
1835
|
+
* @requiredField options.itemReference.providerAppId
|
|
1836
|
+
* @requiredField options.namespace
|
|
1837
|
+
* @requiredField poolId
|
|
1838
|
+
* @permissionId BENEFIT_PROGRAMS.POOL_REDEEM
|
|
1839
|
+
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
1840
|
+
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
1841
|
+
* @applicableIdentity APP
|
|
1842
|
+
* @fqn wix.benefit_programs.v1.pool.PoolService.RedeemBenefit
|
|
1843
|
+
*/
|
|
1844
|
+
export declare function redeemBenefit(poolId: string, options?: NonNullablePaths<RedeemBenefitOptions, `benefitKey` | `idempotencyKey` | `itemReference` | `itemReference.externalId` | `itemReference.providerAppId` | `namespace`>): Promise<NonNullablePaths<RedeemBenefitResponse, `transactionId`>>;
|
|
1845
|
+
export interface RedeemBenefitOptions {
|
|
1758
1846
|
/** Information about the item to redeem. */
|
|
1759
1847
|
itemReference: ItemReference;
|
|
1760
1848
|
/**
|
|
@@ -1790,7 +1878,26 @@ interface RedeemBenefitOptions {
|
|
|
1790
1878
|
*/
|
|
1791
1879
|
namespace: string;
|
|
1792
1880
|
}
|
|
1793
|
-
|
|
1881
|
+
/**
|
|
1882
|
+
* Checks if a benefit can currently be redeemed.
|
|
1883
|
+
*
|
|
1884
|
+
* To be redeemed, a benefit's pool must be active and the associated balance must be greater than the cost of the benefit.
|
|
1885
|
+
* @param poolId - ID of the pool that the benefit to check belongs to.
|
|
1886
|
+
* @public
|
|
1887
|
+
* @documentationMaturity preview
|
|
1888
|
+
* @requiredField options.itemReference
|
|
1889
|
+
* @requiredField options.itemReference.externalId
|
|
1890
|
+
* @requiredField options.itemReference.providerAppId
|
|
1891
|
+
* @requiredField options.namespace
|
|
1892
|
+
* @requiredField poolId
|
|
1893
|
+
* @permissionId BENEFIT_PROGRAMS.POOL_REDEEM
|
|
1894
|
+
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
1895
|
+
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
1896
|
+
* @applicableIdentity APP
|
|
1897
|
+
* @fqn wix.benefit_programs.v1.pool.PoolService.CheckBenefitEligibility
|
|
1898
|
+
*/
|
|
1899
|
+
export declare function checkBenefitEligibility(poolId: string, options?: NonNullablePaths<CheckBenefitEligibilityOptions, `itemReference` | `itemReference.externalId` | `itemReference.providerAppId` | `namespace`>): Promise<NonNullablePaths<CheckBenefitEligibilityResponse, `result.eligibleOptions.eligibleBenefits` | `result.eligibleOptions.eligibleBenefits.${number}.poolId` | `result.eligibleOptions.eligibleBenefits.${number}.benefitKey` | `result.eligibleOptions.eligibleBenefits.${number}.itemReference.externalId` | `result.eligibleOptions.eligibleBenefits.${number}.itemReference.category` | `result.eligibleOptions.eligibleBenefits.${number}.itemReference.providerAppId` | `result.notEnoughBalanceOptions.poolId` | `result.notEnoughBalanceOptions.availableBalance` | `result.notEnoughBalanceOptions.requestedBalance` | `result.poolNotActiveOptions.poolId` | `result.poolNotActiveOptions.poolStatus` | `result.benefitNotFoundOptions.poolId` | `result.poolNotFoundOptions.poolId` | `result.type`>>;
|
|
1900
|
+
export interface CheckBenefitEligibilityOptions {
|
|
1794
1901
|
/**
|
|
1795
1902
|
* Key of the benefit to check.
|
|
1796
1903
|
* @maxLength 64
|
|
@@ -1822,7 +1929,27 @@ interface CheckBenefitEligibilityOptions {
|
|
|
1822
1929
|
*/
|
|
1823
1930
|
namespace: string;
|
|
1824
1931
|
}
|
|
1825
|
-
|
|
1932
|
+
/**
|
|
1933
|
+
* Checks if benefits can currently be redeemed.
|
|
1934
|
+
*
|
|
1935
|
+
* To be redeemed, a benefit's pool must be active and the associated balance must greater be than the cost of the benefit.
|
|
1936
|
+
*
|
|
1937
|
+
* Each benefit is checked independently. For example, if there is a benefit with a price of 3 credits and a benefit with a price of 4 credits, and there are 5 available credits, both benefits would be returned as eligible, but they can't both be redeemed.
|
|
1938
|
+
* @public
|
|
1939
|
+
* @documentationMaturity preview
|
|
1940
|
+
* @requiredField options.benefitSelectors.itemReference
|
|
1941
|
+
* @requiredField options.benefitSelectors.itemReference.externalId
|
|
1942
|
+
* @requiredField options.benefitSelectors.itemReference.providerAppId
|
|
1943
|
+
* @requiredField options.benefitSelectors.poolId
|
|
1944
|
+
* @requiredField options.namespace
|
|
1945
|
+
* @permissionId BENEFIT_PROGRAMS.POOL_REDEEM
|
|
1946
|
+
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
1947
|
+
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
1948
|
+
* @applicableIdentity APP
|
|
1949
|
+
* @fqn wix.benefit_programs.v1.pool.PoolService.BulkCheckBenefitEligibility
|
|
1950
|
+
*/
|
|
1951
|
+
export declare function bulkCheckBenefitEligibility(options?: NonNullablePaths<BulkCheckBenefitEligibilityOptions, `benefitSelectors.${number}.itemReference` | `benefitSelectors.${number}.itemReference.externalId` | `benefitSelectors.${number}.itemReference.providerAppId` | `benefitSelectors.${number}.poolId` | `namespace`>): Promise<NonNullablePaths<BulkCheckBenefitEligibilityResponse, `results` | `results.${number}.benefitSelector.poolId` | `results.${number}.benefitSelector.itemReference.externalId` | `results.${number}.benefitSelector.itemReference.category` | `results.${number}.benefitSelector.itemReference.providerAppId` | `results.${number}.benefitSelector.count` | `results.${number}.result.notEnoughBalanceOptions.poolId` | `results.${number}.result.notEnoughBalanceOptions.availableBalance` | `results.${number}.result.notEnoughBalanceOptions.requestedBalance` | `results.${number}.result.poolNotActiveOptions.poolId` | `results.${number}.result.poolNotActiveOptions.poolStatus` | `results.${number}.result.benefitNotFoundOptions.poolId` | `results.${number}.result.poolNotFoundOptions.poolId` | `results.${number}.result.type`>>;
|
|
1952
|
+
export interface BulkCheckBenefitEligibilityOptions {
|
|
1826
1953
|
/**
|
|
1827
1954
|
* List of benefits to check.
|
|
1828
1955
|
* @minSize 1
|
|
@@ -1838,7 +1965,30 @@ interface BulkCheckBenefitEligibilityOptions {
|
|
|
1838
1965
|
/** Pool beneficiary. */
|
|
1839
1966
|
beneficiary?: CommonIdentificationData;
|
|
1840
1967
|
}
|
|
1841
|
-
|
|
1968
|
+
/**
|
|
1969
|
+
* Retrieves benefits that can be redeemed for a specific benefit item.
|
|
1970
|
+
*
|
|
1971
|
+
* Each benefit item can only be linked to 1 benefit in 1 pool definition. However, each pool created from that pool definition contains the same benefits.
|
|
1972
|
+
* This method checks each pool containing a benefit with this benefit item, and returns the benefits that can be redeemed.
|
|
1973
|
+
* @param itemReference - Item reference.
|
|
1974
|
+
* @public
|
|
1975
|
+
* @documentationMaturity preview
|
|
1976
|
+
* @requiredField itemReference
|
|
1977
|
+
* @requiredField itemReference.externalId
|
|
1978
|
+
* @requiredField itemReference.providerAppId
|
|
1979
|
+
* @requiredField options.namespace
|
|
1980
|
+
* @permissionId BENEFIT_PROGRAMS.POOL_READ
|
|
1981
|
+
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
1982
|
+
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
1983
|
+
* @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
|
|
1984
|
+
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
|
|
1985
|
+
* @permissionScope Manage Events
|
|
1986
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1987
|
+
* @applicableIdentity APP
|
|
1988
|
+
* @fqn wix.benefit_programs.v1.pool.PoolService.GetEligibleBenefits
|
|
1989
|
+
*/
|
|
1990
|
+
export declare function getEligibleBenefits(itemReference: NonNullablePaths<ItemReference, `externalId` | `providerAppId`>, options?: NonNullablePaths<GetEligibleBenefitsOptions, `namespace`>): Promise<NonNullablePaths<GetEligibleBenefitsResponse, `eligibleBenefits` | `eligibleBenefits.${number}.poolId` | `eligibleBenefits.${number}.benefitKey` | `eligibleBenefits.${number}.itemReference.externalId` | `eligibleBenefits.${number}.itemReference.category` | `eligibleBenefits.${number}.itemReference.providerAppId`>>;
|
|
1991
|
+
export interface GetEligibleBenefitsOptions {
|
|
1842
1992
|
/**
|
|
1843
1993
|
* Amount of items to check. This ensures the balance is high enough to redeem this many items.
|
|
1844
1994
|
* @min 1
|
|
@@ -1861,7 +2011,23 @@ interface GetEligibleBenefitsOptions {
|
|
|
1861
2011
|
*/
|
|
1862
2012
|
namespace: string;
|
|
1863
2013
|
}
|
|
1864
|
-
|
|
2014
|
+
/**
|
|
2015
|
+
* Updates pools.
|
|
2016
|
+
* @public
|
|
2017
|
+
* @documentationMaturity preview
|
|
2018
|
+
* @requiredField options.pools.pool
|
|
2019
|
+
* @requiredField options.pools.pool._id
|
|
2020
|
+
* @requiredField options.pools.pool.revision
|
|
2021
|
+
* @permissionId BENEFIT_PROGRAMS.POOL_UPDATE
|
|
2022
|
+
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
2023
|
+
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
2024
|
+
* @applicableIdentity APP
|
|
2025
|
+
* @fqn wix.benefit_programs.v1.pool.PoolService.BulkUpdatePools
|
|
2026
|
+
*/
|
|
2027
|
+
export declare function bulkUpdatePools(options?: NonNullablePaths<BulkUpdatePoolsOptions, `pools.${number}.pool` | `pools.${number}.pool._id` | `pools.${number}.pool.revision`>): Promise<NonNullablePaths<BulkUpdatePoolsResponse, `results` | `results.${number}.poolMetadata.originalIndex` | `results.${number}.poolMetadata.success` | `results.${number}.poolMetadata.error.code` | `results.${number}.poolMetadata.error.description` | {
|
|
2028
|
+
[P in PoolNonNullablePaths]: `results.${number}.pool.${P}`;
|
|
2029
|
+
}[PoolNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
2030
|
+
export interface BulkUpdatePoolsOptions {
|
|
1865
2031
|
/**
|
|
1866
2032
|
* Pools to update.
|
|
1867
2033
|
* @minSize 1
|
|
@@ -1875,5 +2041,4 @@ interface BulkUpdatePoolsOptions {
|
|
|
1875
2041
|
*/
|
|
1876
2042
|
returnEntity?: boolean;
|
|
1877
2043
|
}
|
|
1878
|
-
|
|
1879
|
-
export { type PoolEnded as $, type RateLimitedPolicyPeriodOneOf as A, type BulkCheckBenefitEligibilityOptions as B, type CheckBenefitEligibilityOptions as C, type Details as D, EligibilityCheckResultType as E, type FixedIntervalPolicy as F, type GetEligibleBenefitsOptions as G, type CustomPolicy as H, type ItemReference as I, type CreditConfiguration as J, type RolloverConfiguration as K, ListPoolsRequestType as L, type ExtendedFields as M, type ProgramDefinitionInfo as N, type PoolProgramInfo as O, type Pool as P, type PoolProvisioned as Q, type RedeemBenefitOptions as R, SortOrder as S, Type as T, type UpdatePool as U, type PoolRenewed as V, WeekDay as W, type BenefitRedeemed as X, type RedemptionDetails as Y, type PoolPaused as Z, type PoolResumed as _, type PoolsQueryBuilder as a, type ProvisionPoolsForProgramResponse as a$, type BenefitReserved as a0, type BenefitReservationCanceled as a1, type BenefitReservationReleased as a2, type PoolProvisionJobFinished as a3, type PoolStatusUpdateJobFinished as a4, type PoolStatusUpdateJobFinishedContextOneOf as a5, type PoolDefinitionAndProgramDefinition as a6, type ProgramInfo as a7, type CreatePoolRequest as a8, type CreatePoolResponse as a9, type ReleaseBenefitReservationRequest as aA, type ReleaseBenefitReservationResponse as aB, type CheckBenefitEligibilityRequest as aC, type EligibilityCheckResult as aD, type EligibilityCheckResultResultOneOf as aE, type EligibleBenefit as aF, type Eligible as aG, type BulkCheckBenefitEligibilityRequest as aH, type BenefitSelector as aI, type BulkEligibilityCheckResult as aJ, type GetEligibleBenefitsRequest as aK, type ListPoolsRequest as aL, type ByItemReference as aM, type ByItemReferenceFilter as aN, type Filter as aO, type FilterFilterOneOf as aP, type ListPoolsResponse as aQ, type PoolWithItems as aR, type BulkUpdatePoolsRequest as aS, type MaskedPool as aT, type BulkPoolResult as aU, type ItemMetadata as aV, type ApplicationError as aW, type BulkActionMetadata as aX, type ProvisionPoolsForProgramRequest as aY, type PoolDefinitionLookupId as aZ, type PoolDefinitionLookupIdIdOneOf as a_, type GetPoolRequest as aa, type GetPoolResponse as ab, type UpdatePoolRequest as ac, type UpdatePoolResponse as ad, type DeletePoolRequest as ae, type DeletePoolResponse as af, type QueryPoolsRequest as ag, type CursorQuery as ah, type CursorQueryPagingMethodOneOf as ai, type Sorting as aj, type CursorPaging as ak, type QueryPoolsResponse as al, type CursorPagingMetadata as am, type Cursors as an, type RedeemBenefitRequest as ao, type NotEnoughBalance as ap, type PolicyExpressionEvaluatedToFalse as aq, type FailureDetails as ar, type PoolNotActive as as, type PoolNotFound as at, type BenefitAlreadyRedeemed as au, type BenefitNotFound as av, type ReserveBenefitRequest as aw, type ReserveBenefitResponse as ax, type CancelBenefitReservationRequest as ay, type CancelBenefitReservationResponse as az, type RedeemBenefitResponse as b, type ProvisionPoolsForProgramResponseResultOneOf as b0, type SyncResult as b1, type AsyncResult as b2, type InvalidPoolDefinitionReference as b3, type RenewPoolsForProgramRequest as b4, type RenewPoolsForProgramResponse as b5, type UpdatePoolStatusRequest as b6, type UpdatePoolStatusRequestPoolSelectorOneOf as b7, type ByPoolDefinitionIdAndProgramDefinitionIdOptions as b8, type ByProgramIdOptions as b9, type UpdatePoolStatusResponse as ba, type CountNumberOfPoolsInProvisioningStatusRequest as bb, type CountNumberOfPoolsInProvisioningStatusResponse as bc, type DomainEvent as bd, type DomainEventBodyOneOf as be, type EntityCreatedEvent as bf, type RestoreInfo as bg, type EntityUpdatedEvent as bh, type EntityDeletedEvent as bi, type ActionEvent as bj, type MessageEnvelope as bk, type IdentificationData as bl, type IdentificationDataIdOneOf as bm, type PoolsQueryResult as bn, type CheckBenefitEligibilityResponse as c, type BulkCheckBenefitEligibilityResponse as d, type GetEligibleBenefitsResponse as e, type BulkUpdatePoolsOptions as f, type BulkUpdatePoolsResponse as g, PoolStatus as h, IdentityType as i, PolicyExpressionType as j, RateLimitedPolicyType as k, PoolOrigin as l, ProvisionPoolsForProgramResponseType as m, PoolSelectorType as n, WebhookIdentityType as o, type CommonIdentificationData as p, type CommonIdentificationDataIdOneOf as q, type Benefit as r, type PolicyExpression as s, type PolicyExpressionExpressionOneOf as t, type PolicyExpressionNot as u, type PolicyExpressionAnd as v, type PolicyExpressionOr as w, type Policy as x, type PolicyPolicyOneOf as y, type RateLimitedPolicy as z };
|
|
2044
|
+
export {};
|