@wix/auto_sdk_benefit-programs_programs 1.0.1 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/benefit-programs-v1-program-programs.http.d.ts +20 -18
- package/build/cjs/src/benefit-programs-v1-program-programs.http.js +21 -19
- package/build/cjs/src/benefit-programs-v1-program-programs.http.js.map +1 -1
- package/build/cjs/src/benefit-programs-v1-program-programs.public.d.ts +21 -25
- package/build/cjs/src/benefit-programs-v1-program-programs.public.js.map +1 -1
- package/build/cjs/src/benefit-programs-v1-program-programs.types.d.ts +52 -83
- package/build/cjs/src/benefit-programs-v1-program-programs.types.js +9 -13
- package/build/cjs/src/benefit-programs-v1-program-programs.types.js.map +1 -1
- package/build/cjs/src/benefit-programs-v1-program-programs.universal.d.ts +86 -138
- package/build/cjs/src/benefit-programs-v1-program-programs.universal.js +30 -38
- package/build/cjs/src/benefit-programs-v1-program-programs.universal.js.map +1 -1
- package/build/es/src/benefit-programs-v1-program-programs.http.d.ts +20 -18
- package/build/es/src/benefit-programs-v1-program-programs.http.js +21 -19
- package/build/es/src/benefit-programs-v1-program-programs.http.js.map +1 -1
- package/build/es/src/benefit-programs-v1-program-programs.public.d.ts +21 -25
- package/build/es/src/benefit-programs-v1-program-programs.public.js.map +1 -1
- package/build/es/src/benefit-programs-v1-program-programs.types.d.ts +52 -83
- package/build/es/src/benefit-programs-v1-program-programs.types.js +9 -13
- package/build/es/src/benefit-programs-v1-program-programs.types.js.map +1 -1
- package/build/es/src/benefit-programs-v1-program-programs.universal.d.ts +86 -138
- package/build/es/src/benefit-programs-v1-program-programs.universal.js +30 -38
- package/build/es/src/benefit-programs-v1-program-programs.universal.js.map +1 -1
- package/build/internal/cjs/src/benefit-programs-v1-program-programs.http.d.ts +20 -18
- package/build/internal/cjs/src/benefit-programs-v1-program-programs.http.js +21 -19
- package/build/internal/cjs/src/benefit-programs-v1-program-programs.http.js.map +1 -1
- package/build/internal/cjs/src/benefit-programs-v1-program-programs.public.d.ts +21 -25
- package/build/internal/cjs/src/benefit-programs-v1-program-programs.public.js.map +1 -1
- package/build/internal/cjs/src/benefit-programs-v1-program-programs.types.d.ts +52 -83
- package/build/internal/cjs/src/benefit-programs-v1-program-programs.types.js +9 -13
- package/build/internal/cjs/src/benefit-programs-v1-program-programs.types.js.map +1 -1
- package/build/internal/cjs/src/benefit-programs-v1-program-programs.universal.d.ts +86 -138
- package/build/internal/cjs/src/benefit-programs-v1-program-programs.universal.js +30 -38
- package/build/internal/cjs/src/benefit-programs-v1-program-programs.universal.js.map +1 -1
- package/build/internal/es/src/benefit-programs-v1-program-programs.http.d.ts +20 -18
- package/build/internal/es/src/benefit-programs-v1-program-programs.http.js +21 -19
- package/build/internal/es/src/benefit-programs-v1-program-programs.http.js.map +1 -1
- package/build/internal/es/src/benefit-programs-v1-program-programs.public.d.ts +21 -25
- package/build/internal/es/src/benefit-programs-v1-program-programs.public.js.map +1 -1
- package/build/internal/es/src/benefit-programs-v1-program-programs.types.d.ts +52 -83
- package/build/internal/es/src/benefit-programs-v1-program-programs.types.js +9 -13
- package/build/internal/es/src/benefit-programs-v1-program-programs.types.js.map +1 -1
- package/build/internal/es/src/benefit-programs-v1-program-programs.universal.d.ts +86 -138
- package/build/internal/es/src/benefit-programs-v1-program-programs.universal.js +30 -38
- package/build/internal/es/src/benefit-programs-v1-program-programs.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -1,30 +1,30 @@
|
|
|
1
1
|
import { RequestOptionsFactory } from '@wix/sdk-types';
|
|
2
|
-
/** Creates active programs consisting of benefits derived from their underlying program definitions and pool definitions. */
|
|
3
|
-
export declare function provisionProgram(payload: object): RequestOptionsFactory<any>;
|
|
4
2
|
/**
|
|
5
|
-
*
|
|
6
|
-
*
|
|
7
|
-
* Adjusts each pool in the program according to its unique credit configuration as specified in the pool definition.
|
|
3
|
+
* Creates a program for the specified beneficiary. Creating a program is also referred to as provisioning a program.
|
|
8
4
|
*
|
|
9
|
-
*
|
|
5
|
+
* You can provision a program from a program definition or a pool definition:
|
|
6
|
+
* - **Program definition**: The program has pools that are created from the pool definitions in the program definition.
|
|
7
|
+
* - **Pool definition**: The program has 1 pool that is created from the pool definition.
|
|
10
8
|
*/
|
|
11
|
-
export declare function
|
|
9
|
+
export declare function provisionProgram(payload: object): RequestOptionsFactory<any>;
|
|
12
10
|
/**
|
|
13
|
-
*
|
|
11
|
+
* Renews the specified program.
|
|
14
12
|
*
|
|
15
|
-
*
|
|
13
|
+
* Balances are handled for each pool in the program as defined in the pool's credit configuration.
|
|
16
14
|
*/
|
|
15
|
+
export declare function renewProgram(payload: object): RequestOptionsFactory<any>;
|
|
16
|
+
/** Pauses the specified program. Benefits in the program's pools can't be redeemed until the program is resumed. */
|
|
17
17
|
export declare function pauseProgram(payload: object): RequestOptionsFactory<any>;
|
|
18
18
|
/**
|
|
19
|
-
* Resumes the
|
|
19
|
+
* Resumes the specified program.
|
|
20
20
|
*
|
|
21
|
-
*
|
|
21
|
+
* Call this method for paused programs.
|
|
22
22
|
*/
|
|
23
23
|
export declare function resumeProgram(payload: object): RequestOptionsFactory<any>;
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
25
|
+
* Ends the specified program.
|
|
26
26
|
*
|
|
27
|
-
*
|
|
27
|
+
* Benefits in the program's pools can't be redeemed until the program is resumed.
|
|
28
28
|
*/
|
|
29
29
|
export declare function endProgram(payload: object): RequestOptionsFactory<any>;
|
|
30
30
|
/**
|
|
@@ -42,14 +42,16 @@ export declare function getProgram(payload: object): RequestOptionsFactory<any>;
|
|
|
42
42
|
/**
|
|
43
43
|
* Creates a query to retrieve a list of programs.
|
|
44
44
|
*
|
|
45
|
-
* The
|
|
45
|
+
* The Query Programs method builds a query to retrieve a list of programs and returns a `ProgramsQueryBuilder` object.
|
|
46
|
+
*
|
|
47
|
+
* The returned object contains the query definition, which is used to run the query using the `find()` method.
|
|
46
48
|
*
|
|
47
|
-
*
|
|
49
|
+
* You can refine the query by chaining `ProgramsQueryBuilder` methods onto the query. `ProgramsQueryBuilder` methods enable you to filter, sort, and control the results that Query Programs returns.
|
|
48
50
|
*
|
|
49
|
-
*
|
|
51
|
+
* Query Programs has a default paging limit of 50, which you can override.
|
|
50
52
|
*
|
|
51
|
-
*
|
|
53
|
+
* For a full description of the item object, see the object returned for the `items` property in `ProgramsQueryResult`.
|
|
52
54
|
*/
|
|
53
55
|
export declare function queryPrograms(payload: object): RequestOptionsFactory<any>;
|
|
54
|
-
/** Retrieves a program
|
|
56
|
+
/** Retrieves a program with the specified external ID and namespace. */
|
|
55
57
|
export declare function getProgramByExternalIdAndNamespace(payload: object): RequestOptionsFactory<any>;
|
|
@@ -111,7 +111,13 @@ function resolveWixBenefitProgramsV1ProgramProgramServiceUrl(opts) {
|
|
|
111
111
|
return (0, rest_modules_2.resolveUrl)(Object.assign(opts, { domainToMappings }));
|
|
112
112
|
}
|
|
113
113
|
const PACKAGE_NAME = '@wix/auto_sdk_benefit-programs_programs';
|
|
114
|
-
/**
|
|
114
|
+
/**
|
|
115
|
+
* Creates a program for the specified beneficiary. Creating a program is also referred to as provisioning a program.
|
|
116
|
+
*
|
|
117
|
+
* You can provision a program from a program definition or a pool definition:
|
|
118
|
+
* - **Program definition**: The program has pools that are created from the pool definitions in the program definition.
|
|
119
|
+
* - **Pool definition**: The program has 1 pool that is created from the pool definition.
|
|
120
|
+
*/
|
|
115
121
|
function provisionProgram(payload) {
|
|
116
122
|
function __provisionProgram({ host }) {
|
|
117
123
|
const metadata = {
|
|
@@ -141,11 +147,9 @@ function provisionProgram(payload) {
|
|
|
141
147
|
}
|
|
142
148
|
exports.provisionProgram = provisionProgram;
|
|
143
149
|
/**
|
|
144
|
-
*
|
|
145
|
-
*
|
|
146
|
-
* Adjusts each pool in the program according to its unique credit configuration as specified in the pool definition.
|
|
150
|
+
* Renews the specified program.
|
|
147
151
|
*
|
|
148
|
-
*
|
|
152
|
+
* Balances are handled for each pool in the program as defined in the pool's credit configuration.
|
|
149
153
|
*/
|
|
150
154
|
function renewProgram(payload) {
|
|
151
155
|
function __renewProgram({ host }) {
|
|
@@ -166,11 +170,7 @@ function renewProgram(payload) {
|
|
|
166
170
|
return __renewProgram;
|
|
167
171
|
}
|
|
168
172
|
exports.renewProgram = renewProgram;
|
|
169
|
-
/**
|
|
170
|
-
* Pauses the benefit pools within a program.
|
|
171
|
-
*
|
|
172
|
-
* Changes the program status to `PAUSED`, preventing the redemption or reservation of benefits.
|
|
173
|
-
*/
|
|
173
|
+
/** Pauses the specified program. Benefits in the program's pools can't be redeemed until the program is resumed. */
|
|
174
174
|
function pauseProgram(payload) {
|
|
175
175
|
function __pauseProgram({ host }) {
|
|
176
176
|
const metadata = {
|
|
@@ -191,9 +191,9 @@ function pauseProgram(payload) {
|
|
|
191
191
|
}
|
|
192
192
|
exports.pauseProgram = pauseProgram;
|
|
193
193
|
/**
|
|
194
|
-
* Resumes the
|
|
194
|
+
* Resumes the specified program.
|
|
195
195
|
*
|
|
196
|
-
*
|
|
196
|
+
* Call this method for paused programs.
|
|
197
197
|
*/
|
|
198
198
|
function resumeProgram(payload) {
|
|
199
199
|
function __resumeProgram({ host }) {
|
|
@@ -215,9 +215,9 @@ function resumeProgram(payload) {
|
|
|
215
215
|
}
|
|
216
216
|
exports.resumeProgram = resumeProgram;
|
|
217
217
|
/**
|
|
218
|
-
*
|
|
218
|
+
* Ends the specified program.
|
|
219
219
|
*
|
|
220
|
-
*
|
|
220
|
+
* Benefits in the program's pools can't be redeemed until the program is resumed.
|
|
221
221
|
*/
|
|
222
222
|
function endProgram(payload) {
|
|
223
223
|
function __endProgram({ host }) {
|
|
@@ -320,13 +320,15 @@ exports.getProgram = getProgram;
|
|
|
320
320
|
/**
|
|
321
321
|
* Creates a query to retrieve a list of programs.
|
|
322
322
|
*
|
|
323
|
-
* The
|
|
323
|
+
* The Query Programs method builds a query to retrieve a list of programs and returns a `ProgramsQueryBuilder` object.
|
|
324
|
+
*
|
|
325
|
+
* The returned object contains the query definition, which is used to run the query using the `find()` method.
|
|
324
326
|
*
|
|
325
|
-
*
|
|
327
|
+
* You can refine the query by chaining `ProgramsQueryBuilder` methods onto the query. `ProgramsQueryBuilder` methods enable you to filter, sort, and control the results that Query Programs returns.
|
|
326
328
|
*
|
|
327
|
-
*
|
|
329
|
+
* Query Programs has a default paging limit of 50, which you can override.
|
|
328
330
|
*
|
|
329
|
-
*
|
|
331
|
+
* For a full description of the item object, see the object returned for the `items` property in `ProgramsQueryResult`.
|
|
330
332
|
*/
|
|
331
333
|
function queryPrograms(payload) {
|
|
332
334
|
function __queryPrograms({ host }) {
|
|
@@ -356,7 +358,7 @@ function queryPrograms(payload) {
|
|
|
356
358
|
return __queryPrograms;
|
|
357
359
|
}
|
|
358
360
|
exports.queryPrograms = queryPrograms;
|
|
359
|
-
/** Retrieves a program
|
|
361
|
+
/** Retrieves a program with the specified external ID and namespace. */
|
|
360
362
|
function getProgramByExternalIdAndNamespace(payload) {
|
|
361
363
|
function __getProgramByExternalIdAndNamespace({ host }) {
|
|
362
364
|
const metadata = {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"benefit-programs-v1-program-programs.http.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-program-programs.http.ts"],"names":[],"mappings":";;;AAAA,gEAAkE;AAClE,0EAAkG;AAClG,0EAAkG;AAClG,4EAAmG;AACnG,sFAAkF;AAClF,gEAA2D;AAI3D,SAAS,mDAAmD,CAC1D,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,uBAAuB,EAAE;YACvB;gBACE,OAAO,EAAE,WAAW;gBACpB,QAAQ,EAAE,EAAE;aACb;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,oCAAoC;gBAC7C,QAAQ,EAAE,cAAc;aACzB;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,EAAE;aACb;SACF;QACD,CAAC,EAAE;YACD;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,EAAE;aACb;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,oCAAoC;gBAC7C,QAAQ,EAAE,cAAc;aACzB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,oCAAoC;gBAC7C,QAAQ,EAAE,cAAc;aACzB;SACF;QACD,gBAAgB,EAAE;YAChB;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,oCAAoC;gBAC7C,QAAQ,EAAE,cAAc;aACzB;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,oCAAoC;gBAC7C,QAAQ,EAAE,cAAc;aACzB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,oCAAoC;gBAC7C,QAAQ,EAAE,cAAc;aACzB;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,oCAAoC;gBAC7C,QAAQ,EAAE,cAAc;aACzB;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,oCAAoC;gBAC7C,QAAQ,EAAE,cAAc;aACzB;SACF;KACF,CAAC;IAEF,OAAO,IAAA,yBAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,MAAM,YAAY,GAAG,yCAAyC,CAAC;AAE/D
|
|
1
|
+
{"version":3,"file":"benefit-programs-v1-program-programs.http.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-program-programs.http.ts"],"names":[],"mappings":";;;AAAA,gEAAkE;AAClE,0EAAkG;AAClG,0EAAkG;AAClG,4EAAmG;AACnG,sFAAkF;AAClF,gEAA2D;AAI3D,SAAS,mDAAmD,CAC1D,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,uBAAuB,EAAE;YACvB;gBACE,OAAO,EAAE,WAAW;gBACpB,QAAQ,EAAE,EAAE;aACb;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,oCAAoC;gBAC7C,QAAQ,EAAE,cAAc;aACzB;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,EAAE;aACb;SACF;QACD,CAAC,EAAE;YACD;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,EAAE;aACb;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,oCAAoC;gBAC7C,QAAQ,EAAE,cAAc;aACzB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,oCAAoC;gBAC7C,QAAQ,EAAE,cAAc;aACzB;SACF;QACD,gBAAgB,EAAE;YAChB;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,oCAAoC;gBAC7C,QAAQ,EAAE,cAAc;aACzB;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,oCAAoC;gBAC7C,QAAQ,EAAE,cAAc;aACzB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,oCAAoC;gBAC7C,QAAQ,EAAE,cAAc;aACzB;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,oCAAoC;gBAC7C,QAAQ,EAAE,cAAc;aACzB;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,iCAAiC;gBAC1C,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,oCAAoC;gBAC7C,QAAQ,EAAE,cAAc;aACzB;SACF;KACF,CAAC;IAEF,OAAO,IAAA,yBAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,MAAM,YAAY,GAAG,yCAAyC,CAAC;AAE/D;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAAC,OAAe;IAC9C,SAAS,kBAAkB,CAAC,EAAE,IAAI,EAAO;QACvC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,iCAAiC;YAC7C,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,iEAAiE;YACnE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,mDAAmD,CAAC;gBACvD,SAAS,EAAE,wBAAwB;gBACnC,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,IAAI,EAAE,OAAO;YACb,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,qBAAqB,EAAE;wBAC/B,EAAE,IAAI,EAAE,qBAAqB,EAAE;qBAChC;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AA9BD,4CA8BC;AAED;;;;GAIG;AACH,SAAgB,YAAY,CAAC,OAAe;IAC1C,SAAS,cAAc,CAAC,EAAE,IAAI,EAAO;QACnC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,iCAAiC;YAC7C,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,6DAA6D;YACxE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,mDAAmD,CAAC;gBACvD,SAAS,EAAE,oBAAoB;gBAC/B,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,IAAI,EAAE,OAAO;SACd,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,cAAc,CAAC;AACxB,CAAC;AAnBD,oCAmBC;AAED,oHAAoH;AACpH,SAAgB,YAAY,CAAC,OAAe;IAC1C,SAAS,cAAc,CAAC,EAAE,IAAI,EAAO;QACnC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,iCAAiC;YAC7C,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,6DAA6D;YACxE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,mDAAmD,CAAC;gBACvD,SAAS,EAAE,oBAAoB;gBAC/B,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,IAAI,EAAE,OAAO;SACd,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,cAAc,CAAC;AACxB,CAAC;AAnBD,oCAmBC;AAED;;;;GAIG;AACH,SAAgB,aAAa,CAAC,OAAe;IAC3C,SAAS,eAAe,CAAC,EAAE,IAAI,EAAO;QACpC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,iCAAiC;YAC7C,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,8DAA8D;YACzE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,mDAAmD,CAAC;gBACvD,SAAS,EAAE,qBAAqB;gBAChC,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,IAAI,EAAE,OAAO;SACd,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,eAAe,CAAC;AACzB,CAAC;AAnBD,sCAmBC;AAED;;;;GAIG;AACH,SAAgB,UAAU,CAAC,OAAe;IACxC,SAAS,YAAY,CAAC,EAAE,IAAI,EAAO;QACjC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,iCAAiC;YAC7C,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,2DAA2D;YACtE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,mDAAmD,CAAC;gBACvD,SAAS,EAAE,kBAAkB;gBAC7B,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,IAAI,EAAE,OAAO;SACd,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAnBD,gCAmBC;AAED;;;;;;;;GAQG;AACH,SAAgB,aAAa,CAAC,OAAe;IAC3C,SAAS,eAAe,CAAC,EAAE,IAAI,EAAO;QACpC,MAAM,cAAc,GAAG,IAAA,gCAAc,EAAC,OAAO,EAAE;YAC7C;gBACE,WAAW,EAAE,iDAAoC;gBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;aAC/B;YACD;gBACE,WAAW,EAAE,gDAAoC;gBACjD,KAAK,EAAE;oBACL,EAAE,IAAI,EAAE,qBAAqB,EAAE;oBAC/B,EAAE,IAAI,EAAE,qBAAqB,EAAE;iBAChC;aACF;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,iCAAiC;YAC7C,MAAM,EAAE,OAAc;YACtB,SAAS,EAAE,8DAA8D;YACzE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,mDAAmD,CAAC;gBACvD,SAAS,EAAE,2BAA2B;gBACtC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,qBAAqB,EAAE;wBAC/B,EAAE,IAAI,EAAE,qBAAqB,EAAE;qBAChC;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,eAAe,CAAC;AACzB,CAAC;AA1CD,sCA0CC;AAED,2BAA2B;AAC3B,SAAgB,UAAU,CAAC,OAAe;IACxC,SAAS,YAAY,CAAC,EAAE,IAAI,EAAO;QACjC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,iCAAiC;YAC7C,MAAM,EAAE,KAAY;YACpB,SAAS,EAAE,2DAA2D;YACtE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,mDAAmD,CAAC;gBACvD,SAAS,EAAE,0BAA0B;gBACrC,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,gCAAiB,EAAC,OAAO,CAAC;YAClC,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,qBAAqB,EAAE;wBAC/B,EAAE,IAAI,EAAE,qBAAqB,EAAE;qBAChC;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AA7BD,gCA6BC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,aAAa,CAAC,OAAe;IAC3C,SAAS,eAAe,CAAC,EAAE,IAAI,EAAO;QACpC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,iCAAiC;YAC7C,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,8DAA8D;YACzE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,mDAAmD,CAAC;gBACvD,SAAS,EAAE,oBAAoB;gBAC/B,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,IAAI,EAAE,OAAO;YACb,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,sBAAsB,EAAE;wBAChC,EAAE,IAAI,EAAE,sBAAsB,EAAE;qBACjC;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,eAAe,CAAC;AACzB,CAAC;AA7BD,sCA6BC;AAED,wEAAwE;AACxE,SAAgB,kCAAkC,CAChD,OAAe;IAEf,SAAS,oCAAoC,CAAC,EAAE,IAAI,EAAO;QACzD,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,iCAAiC;YAC7C,MAAM,EAAE,KAAY;YACpB,SAAS,EACP,mFAAmF;YACrF,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,mDAAmD,CAAC;gBACvD,SAAS,EAAE,2CAA2C;gBACtD,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,gCAAiB,EAAC,OAAO,CAAC;YAClC,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,qBAAqB,EAAE;wBAC/B,EAAE,IAAI,EAAE,qBAAqB,EAAE;qBAChC;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,oCAAoC,CAAC;AAC9C,CAAC;AAhCD,gFAgCC"}
|
|
@@ -6,23 +6,21 @@ export declare const __metadata: {
|
|
|
6
6
|
export declare function provisionProgram(httpClient: HttpClient): ProvisionProgramSignature;
|
|
7
7
|
interface ProvisionProgramSignature {
|
|
8
8
|
/**
|
|
9
|
-
* Creates
|
|
10
|
-
* @param - Used to locate the pool definition for creating its benefit pools within the program.
|
|
9
|
+
* Creates a program for the specified beneficiary. Creating a program is also referred to as provisioning a program.
|
|
11
10
|
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
11
|
+
* You can provision a program from a program definition or a pool definition:
|
|
12
|
+
* - **Program definition**: The program has pools that are created from the pool definitions in the program definition.
|
|
13
|
+
* - **Pool definition**: The program has 1 pool that is created from the pool definition.
|
|
14
|
+
* @param - The program definition or pool definition to use to provision the program.
|
|
15
15
|
*/
|
|
16
16
|
(poolDefinitionLookupId: PoolDefinitionLookupId, options?: ProvisionProgramOptions | undefined): Promise<ProvisionProgramResponse & ProvisionProgramResponseNonNullableFields>;
|
|
17
17
|
}
|
|
18
18
|
export declare function renewProgram(httpClient: HttpClient): RenewProgramSignature;
|
|
19
19
|
interface RenewProgramSignature {
|
|
20
20
|
/**
|
|
21
|
-
*
|
|
21
|
+
* Renews the specified program.
|
|
22
22
|
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
* Use this method to reset each benefit pool renewal cycle.
|
|
23
|
+
* Balances are handled for each pool in the program as defined in the pool's credit configuration.
|
|
26
24
|
* @param - ID of the program to renew.
|
|
27
25
|
*/
|
|
28
26
|
(programId: string): Promise<RenewProgramResponse & RenewProgramResponseNonNullableFields>;
|
|
@@ -30,9 +28,7 @@ interface RenewProgramSignature {
|
|
|
30
28
|
export declare function pauseProgram(httpClient: HttpClient): PauseProgramSignature;
|
|
31
29
|
interface PauseProgramSignature {
|
|
32
30
|
/**
|
|
33
|
-
* Pauses the
|
|
34
|
-
*
|
|
35
|
-
* Changes the program status to `PAUSED`, preventing the redemption or reservation of benefits.
|
|
31
|
+
* Pauses the specified program. Benefits in the program's pools can't be redeemed until the program is resumed.
|
|
36
32
|
* @param - ID of the program to pause.
|
|
37
33
|
*/
|
|
38
34
|
(programId: string): Promise<PauseProgramResponse & PauseProgramResponseNonNullableFields>;
|
|
@@ -40,9 +36,9 @@ interface PauseProgramSignature {
|
|
|
40
36
|
export declare function resumeProgram(httpClient: HttpClient): ResumeProgramSignature;
|
|
41
37
|
interface ResumeProgramSignature {
|
|
42
38
|
/**
|
|
43
|
-
* Resumes the
|
|
39
|
+
* Resumes the specified program.
|
|
44
40
|
*
|
|
45
|
-
*
|
|
41
|
+
* Call this method for paused programs.
|
|
46
42
|
* @param - ID of program to resume.
|
|
47
43
|
*/
|
|
48
44
|
(programId: string): Promise<ResumeProgramResponse & ResumeProgramResponseNonNullableFields>;
|
|
@@ -50,10 +46,10 @@ interface ResumeProgramSignature {
|
|
|
50
46
|
export declare function endProgram(httpClient: HttpClient): EndProgramSignature;
|
|
51
47
|
interface EndProgramSignature {
|
|
52
48
|
/**
|
|
53
|
-
*
|
|
49
|
+
* Ends the specified program.
|
|
54
50
|
*
|
|
55
|
-
*
|
|
56
|
-
* @param -
|
|
51
|
+
* Benefits in the program's pools can't be redeemed until the program is resumed.
|
|
52
|
+
* @param - ID of the program to end.
|
|
57
53
|
*/
|
|
58
54
|
(programId: string): Promise<EndProgramResponse & EndProgramResponseNonNullableFields>;
|
|
59
55
|
}
|
|
@@ -86,23 +82,23 @@ interface QueryProgramsSignature {
|
|
|
86
82
|
/**
|
|
87
83
|
* Creates a query to retrieve a list of programs.
|
|
88
84
|
*
|
|
89
|
-
* The
|
|
85
|
+
* The Query Programs method builds a query to retrieve a list of programs and returns a `ProgramsQueryBuilder` object.
|
|
90
86
|
*
|
|
91
|
-
* The returned object contains the query definition, which is used to run the query using the
|
|
87
|
+
* The returned object contains the query definition, which is used to run the query using the `find()` method.
|
|
92
88
|
*
|
|
93
|
-
* You can refine the query by chaining `ProgramsQueryBuilder` methods onto the query. `ProgramsQueryBuilder` methods enable you to filter, sort, and control the results that
|
|
89
|
+
* You can refine the query by chaining `ProgramsQueryBuilder` methods onto the query. `ProgramsQueryBuilder` methods enable you to filter, sort, and control the results that Query Programs returns.
|
|
94
90
|
*
|
|
95
|
-
*
|
|
91
|
+
* Query Programs has a default paging limit of 50, which you can override.
|
|
92
|
+
*
|
|
93
|
+
* For a full description of the item object, see the object returned for the `items` property in `ProgramsQueryResult`.
|
|
96
94
|
*/
|
|
97
95
|
(): ProgramsQueryBuilder;
|
|
98
96
|
}
|
|
99
97
|
export declare function getProgramByExternalIdAndNamespace(httpClient: HttpClient): GetProgramByExternalIdAndNamespaceSignature;
|
|
100
98
|
interface GetProgramByExternalIdAndNamespaceSignature {
|
|
101
99
|
/**
|
|
102
|
-
* Retrieves a program
|
|
103
|
-
* @param -
|
|
104
|
-
*
|
|
105
|
-
* Use the namespace that was designated to the program definition.
|
|
100
|
+
* Retrieves a program with the specified external ID and namespace.
|
|
101
|
+
* @param - Namespace for your app or site's benefit programs.
|
|
106
102
|
*/
|
|
107
103
|
(namespace: string, options: GetProgramByExternalIdAndNamespaceOptions): Promise<GetProgramByExternalIdAndNamespaceResponse & GetProgramByExternalIdAndNamespaceResponseNonNullableFields>;
|
|
108
104
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"benefit-programs-v1-program-programs.public.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-program-programs.public.ts"],"names":[],"mappings":";;;AACA,2HA6B6D;AAEhD,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,uBAAuB,EAAE,CAAC;AAEpE,SAAgB,gBAAgB,CAC9B,UAAsB;IAEtB,OAAO,CACL,sBAA8C,EAC9C,OAAiC,EACjC,EAAE,CACF,IAAA,oEAAyB,EACvB,sBAAsB,EACtB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAbD,4CAaC;AAmBD,SAAgB,YAAY,CAAC,UAAsB;IACjD,OAAO,CAAC,SAAiB,EAAE,EAAE,CAC3B,IAAA,gEAAqB,EACnB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,oCAOC;
|
|
1
|
+
{"version":3,"file":"benefit-programs-v1-program-programs.public.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-program-programs.public.ts"],"names":[],"mappings":";;;AACA,2HA6B6D;AAEhD,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,uBAAuB,EAAE,CAAC;AAEpE,SAAgB,gBAAgB,CAC9B,UAAsB;IAEtB,OAAO,CACL,sBAA8C,EAC9C,OAAiC,EACjC,EAAE,CACF,IAAA,oEAAyB,EACvB,sBAAsB,EACtB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAbD,4CAaC;AAmBD,SAAgB,YAAY,CAAC,UAAsB;IACjD,OAAO,CAAC,SAAiB,EAAE,EAAE,CAC3B,IAAA,gEAAqB,EACnB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,oCAOC;AAcD,SAAgB,YAAY,CAAC,UAAsB;IACjD,OAAO,CAAC,SAAiB,EAAE,EAAE,CAC3B,IAAA,gEAAqB,EACnB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,oCAOC;AAYD,SAAgB,aAAa,CAAC,UAAsB;IAClD,OAAO,CAAC,SAAiB,EAAE,EAAE,CAC3B,IAAA,iEAAsB,EACpB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,sCAOC;AAcD,SAAgB,UAAU,CAAC,UAAsB;IAC/C,OAAO,CAAC,SAAiB,EAAE,EAAE,CAC3B,IAAA,8DAAmB,EACjB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,gCAOC;AAcD,SAAgB,aAAa,CAAC,UAAsB;IAClD,OAAO,CAAC,GAAkB,EAAE,OAAsB,EAAE,EAAE,CACpD,IAAA,iEAAsB,EACpB,GAAG,EACH,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,sCAQC;AAmBD,SAAgB,UAAU,CAAC,UAAsB;IAC/C,OAAO,CAAC,SAAiB,EAAE,EAAE,CAC3B,IAAA,8DAAmB,EACjB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,gCAOC;AAWD,SAAgB,aAAa,CAAC,UAAsB;IAClD,OAAO,GAAG,EAAE,CACV,IAAA,iEAAsB;IACpB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAND,sCAMC;AAmBD,SAAgB,kCAAkC,CAChD,UAAsB;IAEtB,OAAO,CACL,SAAiB,EACjB,OAAkD,EAClD,EAAE,CACF,IAAA,sFAA2C,EACzC,SAAS,EACT,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAbD,gFAaC;AAgBD,yHA0E6D;AA/C3D,iJAAA,YAAY,OAAA;AAEZ,gJAAA,WAAW,OAAA;AAeX,kJAAA,aAAa,OAAA;AAMb,yKAAA,oCAAoC,OAAA;AAapC,8IAAA,SAAS,OAAA;AAUT,wJAAA,mBAAmB,OAAA"}
|