@wix/auto_sdk_benefit-programs_programs 1.0.1 → 1.0.2

package/build/cjs/src/benefit-programs-v1-program-programs.http.d.ts

@@ -1,31 +1,23 @@
 import { RequestOptionsFactory } from '@wix/sdk-types';
-/** Creates active programs consisting of benefits derived from their underlying program definitions and pool definitions. */
-export declare function provisionProgram(payload: object): RequestOptionsFactory<any>;
 /**
- * Updates the benefit pools within a program.
- *
- * Adjusts each pool in the program according to its unique credit configuration as specified in the pool definition.
+ * Creates a program for the specified beneficiary. Creating a program is also referred to as provisioning a program.
  *
- * Use this method to reset each benefit pool renewal cycle.
+ * You can provision a program from a program definition or a pool definition:
+ * - **Program definition**: The program has associated pools that are created from the pool definitions associated with the program definition.
+ * - **Pool definition**: The program has 1 associated pool that is created from the pool definition.
  */
-export declare function renewProgram(payload: object): RequestOptionsFactory<any>;
+export declare function provisionProgram(payload: object): RequestOptionsFactory<any>;
 /**
- * Pauses the benefit pools within a program.
+ * Renews the specified program.
  *
- * Changes the program status to `PAUSED`, preventing the redemption or reservation of benefits.
+ * Balances are handled for each pool in the program as defined in the pool's credit configuration.
  */
+export declare function renewProgram(payload: object): RequestOptionsFactory<any>;
+/** Pauses the specified program. Benefits in the program's pools can't be redeemed until the program is resumed. */
 export declare function pauseProgram(payload: object): RequestOptionsFactory<any>;
-/**
- * Resumes the benefit pools within a program.
- *
- * Changes the program status to `ACTIVE`, allowing the redemption or reservation of benefits to continue.
- */
+/** Resumes the specified program. Call this method for paused programs. */
 export declare function resumeProgram(payload: object): RequestOptionsFactory<any>;
-/**
- * Prevents the benefit pools in the provided package from being redeemed or reserved.
- *
- * After ending a program, it can't be restarted.
- */
+/** Ends the specified program. Benefits in the program's pools can't be redeemed until the program is resumed. */
 export declare function endProgram(payload: object): RequestOptionsFactory<any>;
 /**
  * Updates a program.
@@ -42,14 +34,16 @@ export declare function getProgram(payload: object): RequestOptionsFactory<any>;
 /**
  * Creates a query to retrieve a list of programs.
  *
- * The `queryPrograms()` method builds a query to retrieve a list of programs and returns a `ProgramsQueryBuilder` object.
+ * The Query Programs method builds a query to retrieve a list of programs and returns a `ProgramsQueryBuilder` object.
+ *
+ * The returned object contains the query definition, which is used to run the query using the `find()` method.
  *
- * The returned object contains the query definition, which is used to run the query using the [`find()`](/programs/programs-query-builder/find) function.
+ * 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.
  *
- * You can refine the query by chaining `ProgramsQueryBuilder` methods onto the query. `ProgramsQueryBuilder` methods enable you to filter, sort, and control the results that `queryPrograms()` returns.
+ * Query Programs has a default paging limit of 50, which you can override.
  *
- * The following `ProgramsQueryBuilder` functions are supported for `queryPrograms()`. For a full description of the program object, see the object returned for the [`items`](/programs/programs-query-result/items) property in `ProgramsQueryResult`.
+ *  For a full description of the item object, see the object returned for the `items` property in `ProgramsQueryResult`.
  */
 export declare function queryPrograms(payload: object): RequestOptionsFactory<any>;
-/** Retrieves a program by program external ID and corresponding namespace. */
+/** Retrieves a program with the specified external ID and namespace. */
 export declare function getProgramByExternalIdAndNamespace(payload: object): RequestOptionsFactory<any>;

package/build/cjs/src/benefit-programs-v1-program-programs.http.js

@@ -111,7 +111,13 @@ function resolveWixBenefitProgramsV1ProgramProgramServiceUrl(opts) {
     return (0, rest_modules_2.resolveUrl)(Object.assign(opts, { domainToMappings }));
 }
 const PACKAGE_NAME = '@wix/auto_sdk_benefit-programs_programs';
-/** Creates active programs consisting of benefits derived from their underlying program definitions and pool definitions. */
+/**
+ * Creates a program for the specified beneficiary. Creating a program is also referred to as provisioning a program.
+ *
+ * You can provision a program from a program definition or a pool definition:
+ * - **Program definition**: The program has associated pools that are created from the pool definitions associated with the program definition.
+ * - **Pool definition**: The program has 1 associated pool that is created from the pool definition.
+ */
 function provisionProgram(payload) {
     function __provisionProgram({ host }) {
         const metadata = {
@@ -141,11 +147,9 @@ function provisionProgram(payload) {
 }
 exports.provisionProgram = provisionProgram;
 /**
- * Updates the benefit pools within a program.
- *
- * Adjusts each pool in the program according to its unique credit configuration as specified in the pool definition.
+ * Renews the specified program.
  *
- * Use this method to reset each benefit pool renewal cycle.
+ * Balances are handled for each pool in the program as defined in the pool's credit configuration.
  */
 function renewProgram(payload) {
     function __renewProgram({ host }) {
@@ -166,11 +170,7 @@ function renewProgram(payload) {
     return __renewProgram;
 }
 exports.renewProgram = renewProgram;
-/**
- * Pauses the benefit pools within a program.
- *
- * Changes the program status to `PAUSED`, preventing the redemption or reservation of benefits.
- */
+/** Pauses the specified program. Benefits in the program's pools can't be redeemed until the program is resumed. */
 function pauseProgram(payload) {
     function __pauseProgram({ host }) {
         const metadata = {
@@ -190,11 +190,7 @@ function pauseProgram(payload) {
     return __pauseProgram;
 }
 exports.pauseProgram = pauseProgram;
-/**
- * Resumes the benefit pools within a program.
- *
- * Changes the program status to `ACTIVE`, allowing the redemption or reservation of benefits to continue.
- */
+/** Resumes the specified program. Call this method for paused programs. */
 function resumeProgram(payload) {
     function __resumeProgram({ host }) {
         const metadata = {
@@ -214,11 +210,7 @@ function resumeProgram(payload) {
     return __resumeProgram;
 }
 exports.resumeProgram = resumeProgram;
-/**
- * Prevents the benefit pools in the provided package from being redeemed or reserved.
- *
- * After ending a program, it can't be restarted.
- */
+/** Ends the specified program. Benefits in the program's pools can't be redeemed until the program is resumed. */
 function endProgram(payload) {
     function __endProgram({ host }) {
         const metadata = {
@@ -320,13 +312,15 @@ exports.getProgram = getProgram;
 /**
  * Creates a query to retrieve a list of programs.
  *
- * The `queryPrograms()` method builds a query to retrieve a list of programs and returns a `ProgramsQueryBuilder` object.
+ * The Query Programs method builds a query to retrieve a list of programs and returns a `ProgramsQueryBuilder` object.
+ *
+ * The returned object contains the query definition, which is used to run the query using the `find()` method.
  *
- * The returned object contains the query definition, which is used to run the query using the [`find()`](/programs/programs-query-builder/find) function.
+ * 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.
  *
- * You can refine the query by chaining `ProgramsQueryBuilder` methods onto the query. `ProgramsQueryBuilder` methods enable you to filter, sort, and control the results that `queryPrograms()` returns.
+ * Query Programs has a default paging limit of 50, which you can override.
  *
- * The following `ProgramsQueryBuilder` functions are supported for `queryPrograms()`. For a full description of the program object, see the object returned for the [`items`](/programs/programs-query-result/items) property in `ProgramsQueryResult`.
+ *  For a full description of the item object, see the object returned for the `items` property in `ProgramsQueryResult`.
  */
 function queryPrograms(payload) {
     function __queryPrograms({ host }) {
@@ -356,7 +350,7 @@ function queryPrograms(payload) {
     return __queryPrograms;
 }
 exports.queryPrograms = queryPrograms;
-/** Retrieves a program by program external ID and corresponding namespace. */
+/** Retrieves a program with the specified external ID and namespace. */
 function getProgramByExternalIdAndNamespace(payload) {
     function __getProgramByExternalIdAndNamespace({ host }) {
         const metadata = {

package/build/cjs/src/benefit-programs-v1-program-programs.http.js.map

@@ -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,6HAA6H;AAC7H,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;;;;;;GAMG;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;;;;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;;;;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;;;;;;;;;;GAUG;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,8EAA8E;AAC9E,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"}
+{"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,2EAA2E;AAC3E,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,kHAAkH;AAClH,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"}

package/build/cjs/src/benefit-programs-v1-program-programs.public.d.ts

@@ -6,23 +6,21 @@ export declare const __metadata: {
 export declare function provisionProgram(httpClient: HttpClient): ProvisionProgramSignature;
 interface ProvisionProgramSignature {
     /**
-     * Creates active programs consisting of benefits derived from their underlying program definitions and pool definitions.
-     * @param - Used to locate the pool definition for creating its benefit pools within the program.
+     * Creates a program for the specified beneficiary. Creating a program is also referred to as provisioning a program.
      *
-     * This object must contain either `programDefinitionId` or `poolDefinitionId`:
-     * + Use `programDefinitionId` for programs with multiple benefit pools.
-     * + Use `poolDefinitionId` for a program with just 1 benefit pool.
+     * You can provision a program from a program definition or a pool definition:
+     * - **Program definition**: The program has associated pools that are created from the pool definitions associated with the program definition.
+     * - **Pool definition**: The program has 1 associated pool that is created from the pool definition.
+     * @param - The program definition or pool definition to use to provision the program.
      */
     (poolDefinitionLookupId: PoolDefinitionLookupId, options?: ProvisionProgramOptions | undefined): Promise<ProvisionProgramResponse & ProvisionProgramResponseNonNullableFields>;
 }
 export declare function renewProgram(httpClient: HttpClient): RenewProgramSignature;
 interface RenewProgramSignature {
     /**
-     * Updates the benefit pools within a program.
+     * Renews the specified program.
      *
-     * Adjusts each pool in the program according to its unique credit configuration as specified in the pool definition.
-     *
-     * Use this method to reset each benefit pool renewal cycle.
+     * Balances are handled for each pool in the program as defined in the pool's credit configuration.
      * @param - ID of the program to renew.
      */
     (programId: string): Promise<RenewProgramResponse & RenewProgramResponseNonNullableFields>;
@@ -30,9 +28,7 @@ interface RenewProgramSignature {
 export declare function pauseProgram(httpClient: HttpClient): PauseProgramSignature;
 interface PauseProgramSignature {
     /**
-     * Pauses the benefit pools within a program.
-     *
-     * Changes the program status to `PAUSED`, preventing the redemption or reservation of benefits.
+     * Pauses the specified program. Benefits in the program's pools can't be redeemed until the program is resumed.
      * @param - ID of the program to pause.
      */
     (programId: string): Promise<PauseProgramResponse & PauseProgramResponseNonNullableFields>;
@@ -40,9 +36,7 @@ interface PauseProgramSignature {
 export declare function resumeProgram(httpClient: HttpClient): ResumeProgramSignature;
 interface ResumeProgramSignature {
     /**
-     * Resumes the benefit pools within a program.
-     *
-     * Changes the program status to `ACTIVE`, allowing the redemption or reservation of benefits to continue.
+     * Resumes the specified program. Call this method for paused programs.
      * @param - ID of program to resume.
      */
     (programId: string): Promise<ResumeProgramResponse & ResumeProgramResponseNonNullableFields>;
@@ -50,10 +44,8 @@ interface ResumeProgramSignature {
 export declare function endProgram(httpClient: HttpClient): EndProgramSignature;
 interface EndProgramSignature {
     /**
-     * Prevents the benefit pools in the provided package from being redeemed or reserved.
-     *
-     * After ending a program, it can't be restarted.
-     * @param - Package of pools
+     * Ends the specified program. Benefits in the program's pools can't be redeemed until the program is resumed.
+     * @param - ID of the program to end.
      */
     (programId: string): Promise<EndProgramResponse & EndProgramResponseNonNullableFields>;
 }
@@ -86,20 +78,22 @@ interface QueryProgramsSignature {
     /**
      * Creates a query to retrieve a list of programs.
      *
-     * The `queryPrograms()` method builds a query to retrieve a list of programs and returns a `ProgramsQueryBuilder` object.
+     * The Query Programs method builds a query to retrieve a list of programs and returns a `ProgramsQueryBuilder` object.
+     *
+     * The returned object contains the query definition, which is used to run the query using the `find()` method.
      *
-     * The returned object contains the query definition, which is used to run the query using the [`find()`](/programs/programs-query-builder/find) function.
+     * 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.
      *
-     * You can refine the query by chaining `ProgramsQueryBuilder` methods onto the query. `ProgramsQueryBuilder` methods enable you to filter, sort, and control the results that `queryPrograms()` returns.
+     * Query Programs has a default paging limit of 50, which you can override.
      *
-     * The following `ProgramsQueryBuilder` functions are supported for `queryPrograms()`. For a full description of the program object, see the object returned for the [`items`](/programs/programs-query-result/items) property in `ProgramsQueryResult`.
+     *  For a full description of the item object, see the object returned for the `items` property in `ProgramsQueryResult`.
      */
     (): ProgramsQueryBuilder;
 }
 export declare function getProgramByExternalIdAndNamespace(httpClient: HttpClient): GetProgramByExternalIdAndNamespaceSignature;
 interface GetProgramByExternalIdAndNamespaceSignature {
     /**
-     * Retrieves a program by program external ID and corresponding namespace.
+     * Retrieves a program with the specified external ID and namespace.
      * @param - Application sub-module that is the source of the program creation.
      *
      * Use the namespace that was designated to the program definition.

package/build/cjs/src/benefit-programs-v1-program-programs.public.js.map

@@ -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;AAgBD,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,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;AAiBD,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;AAkBD,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"}
+{"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;AAYD,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;AAYD,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;AAkBD,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"}

package/build/cjs/src/benefit-programs-v1-program-programs.types.d.ts

@@ -25,7 +25,7 @@ export interface Program {
      */
     updatedDate?: Date | null;
     /**
-     * ID of program definition that provisioned this benefit pool.
+     * ID of the associated program definition.
      * @format GUID
      * @readonly
      * @immutable
@@ -37,7 +37,7 @@ export interface Program {
      */
     status?: ProgramStatus;
     /**
-     * Identity of the individual that enrolled in the program, granting access to its associated benefits.
+     * Program beneficiary.
      * @readonly
      * @immutable
      */
@@ -45,12 +45,12 @@ export interface Program {
     /**
      * Program name.
      *
-     * Suggest setting the same value that was already specified in the program definition's `displayName`.
+     * You may want to use the same name that's used in the associated program definition, if it exists.
      * @maxLength 64
      */
     displayName?: string | null;
     /**
-     * External system that is the source of the program creation. For example, `wix-pricing-plans`, `wix-loyalty`.
+     * Namespace for your app or site's benefit programs.
      * @minLength 1
      * @maxLength 50
      * @immutable
@@ -59,63 +59,52 @@ export interface Program {
     /**
      * Custom field data for the program object.
      *
-     * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
+     * [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls.
      */
     extendedFields?: ExtendedFields;
     /**
-     * External program ID.
-     *
-     * Must be unique to every app's namespace.
+     * ID for the program defined by you. You can use `externalId` to filter queries.
      * @format GUID
      * @immutable
      */
     externalId?: string | null;
     /**
-     * Program definition info
+     * Associated program definition information.
      * @readonly
      */
     programDefinition?: ProgramDefinitionInfo;
-    /**
-     * Intended status of a program after the completion of an action.
-     * @readonly
-     */
-    targetStatus?: ProgramStatus;
 }
 export declare enum ProgramStatus {
     /** Undefined program status. */
     UNDEFINED = "UNDEFINED",
-    /** Active program. */
+    /** Program is active. */
     ACTIVE = "ACTIVE",
-    /** Paused program. */
+    /** Program is paused. It can be resumed. */
     PAUSED = "PAUSED",
-    /**
-     * Inactive program.
-     *
-     * Benefits of a program with an `ENDED` status can't be redeemed or reserved.
-     */
+    /** Program has ended. It can't be resumed. */
     ENDED = "ENDED",
-    /** Process state for programs that are currently being activated but have not yet completed the provisioning process. */
+    /** Program is being activated for the first time. This status will be true for a negligible amount of time. */
     PROVISIONING = "PROVISIONING",
-    /** Process state for programs that are currently pausing. */
+    /** Program is being paused. This status will be true for a negligible amount of time. */
     PAUSING = "PAUSING",
-    /** Process state for programs that are currently resuming. */
+    /** Program is being re-activated after being paused. This status will be true for a negligible amount of time. */
     RESUMING = "RESUMING",
-    /** Process state for programs that are currently ending. */
+    /** Program is being ended. This status will be true for a negligible amount of time. */
     ENDING = "ENDING"
 }
 export interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
     /**
-     * ID of a site visitor that has not logged in to the site.
+     * ID of a site visitor that hasn't logged in to the site.
      * @format GUID
      */
     anonymousVisitorId?: string;
     /**
-     * ID of a site visitor that has logged in to the site.
+     * ID of a site member.
      * @format GUID
      */
     memberId?: string;
     /**
-     * ID of a Wix user (site owner, contributor, etc.).
+     * ID of a Wix user.
      * @format GUID
      */
     wixUserId?: string;
@@ -123,17 +112,17 @@ export interface CommonIdentificationData extends CommonIdentificationDataIdOneO
 /** @oneof */
 export interface CommonIdentificationDataIdOneOf {
     /**
-     * ID of a site visitor that has not logged in to the site.
+     * ID of a site visitor that hasn't logged in to the site.
      * @format GUID
      */
     anonymousVisitorId?: string;
     /**
-     * ID of a site visitor that has logged in to the site.
+     * ID of a site member.
      * @format GUID
      */
     memberId?: string;
     /**
-     * ID of a Wix user (site owner, contributor, etc.).
+     * ID of a Wix user.
      * @format GUID
      */
     wixUserId?: string;
@@ -161,15 +150,13 @@ export interface ExtendedFields {
 }
 export interface ProgramDefinitionInfo {
     /**
-     * ID of the program definition that provisioned the program associated with this benefit pool.
+     * Program definition ID.
      * @format GUID
      * @readonly
      */
     id?: string;
     /**
-     * External ID of the program definition that provisioned this program.
-     *
-     * This identifies the source program definition in the external system.
+     * Program definition external ID.
      * @format GUID
      * @readonly
      */
@@ -197,30 +184,18 @@ export interface ProgramResumed {
 }
 /** In case pool_definition_id is provided should test if it's part of a package. If it is, reject the request */
 export interface ProvisionProgramRequest {
-    /**
-     * Used to locate the pool definition for creating its benefit pools within the program.
-     *
-     * This object must contain either `programDefinitionId` or `poolDefinitionId`:
-     * + Use `programDefinitionId` for programs with multiple benefit pools.
-     * + Use `poolDefinitionId` for a program with just 1 benefit pool.
-     */
+    /** The program definition or pool definition to use to provision the program. */
     poolDefinitionLookupId: PoolDefinitionLookupId;
-    /**
-     * Identity of the individual that enrolled in the program, granting access to its associated benefits.
-     *
-     * The beneficiary's identity information is in their access token. To retrieve their identity, pass the access token from your frontend site to your backend, then call the Token Info ([SDK](https://dev.wix.com/docs/sdk/core-modules/essentials/auth#gettokeninfo)|[REST](https://dev.wix.com/docs/rest/app-management/oauth-2/token-info)) method. The returned `subjectType` and `subjectId` correspond to the  identity type and ID of the beneficiary.
-     */
+    /** Program beneficiary. */
     beneficiary: CommonIdentificationData;
     /**
-     * Set the status of the program upon provision.
+     * Initial program status.
      *
      * Default: `ACTIVE`
      */
     programStatus?: ProvisionProgramRequestProgramStatus;
     /**
-     * Application sub-module that is the source of the program creation.
-     *
-     * Use the namespace that was designated to the program definition.
+     * Namespace for your app or site's benefit programs.
      * @minLength 1
      * @maxLength 50
      */
@@ -228,14 +203,12 @@ export interface ProvisionProgramRequest {
     /**
      * Program name.
      *
-     * Suggest using the same value that was already specified in the program definition's `displayName`.
+     * You may want to use the same name that's used in the associated program definition, if it exists.
      * @maxLength 64
      */
     displayName?: string | null;
     /**
-     * External program ID.
-     *
-     * Must be unique to every app owner's namespace.
+     * ID for the program defined by you. You can use `externalId` to filter queries.
      * @format GUID
      */
     externalProgramId: string;
@@ -266,14 +239,14 @@ export interface PoolDefinitionLookupIdIdOneOf {
     programDefinitionId?: string;
 }
 export declare enum ProvisionProgramRequestProgramStatus {
-    /** Active program. */
+    /** Program is active. */
     ACTIVE = "ACTIVE",
-    /** Paused program. */
+    /** Program is paused. */
     PAUSED = "PAUSED"
 }
 export interface ProvisionProgramResponse {
     /**
-     * Job ID of the provisioned program.
+     * Job ID of the provisioning of the program.
      * @format GUID
      */
     jobId?: string;
@@ -302,7 +275,7 @@ export interface RenewProgramRequest {
 }
 export interface RenewProgramResponse {
     /**
-     * Job ID of the renewed program.
+     * Job ID of the program renewal.
      * @format GUID
      */
     jobId?: string;
@@ -316,7 +289,7 @@ export interface PauseProgramRequest {
 }
 export interface PauseProgramResponse {
     /**
-     * Job ID of the paused program.
+     * Job ID of the pausing of the program.
      * @format GUID
      */
     jobId?: string;
@@ -336,21 +309,21 @@ export interface ResumeProgramRequest {
 }
 export interface ResumeProgramResponse {
     /**
-     * Job ID of the resumed program.
+     * Job ID of the resuming of the program.
      * @format GUID
      */
     jobId?: string;
 }
 export interface EndProgramRequest {
     /**
-     * Package of pools
+     * ID of the program to end.
      * @format GUID
      */
     programId: string;
 }
 export interface EndProgramResponse {
     /**
-     * Job ID of the discontinued program.
+     * Job ID of the ending of the program.
      * @format GUID
      */
     jobId?: string;
@@ -407,7 +380,7 @@ export interface UpsertMigratedProgramResponse {
     program?: Program;
 }
 export interface UpdateProgramRequest {
-    /** Program to be updated. */
+    /** Program to update. */
     program: Program;
 }
 export interface UpdateProgramResponse {
@@ -426,7 +399,7 @@ export interface GetProgramResponse {
     program?: Program;
 }
 export interface QueryProgramsRequest {
-    /** Query to select programs. */
+    /** Filter, sort, and paging to apply to the query. */
     query?: CursorQuery;
 }
 export interface CursorQuery extends CursorQueryPagingMethodOneOf {
@@ -484,7 +457,7 @@ export interface CursorPaging {
     cursor?: string | null;
 }
 export interface QueryProgramsResponse {
-    /** List of programs. */
+    /** List of retrieved programs. */
     programs?: Program[];
     /** Metadata for the paginated results. */
     metadata?: CursorPagingMetadata;

package/build/cjs/src/benefit-programs-v1-program-programs.types.js

@@ -5,23 +5,19 @@ var ProgramStatus;
 (function (ProgramStatus) {
     /** Undefined program status. */
     ProgramStatus["UNDEFINED"] = "UNDEFINED";
-    /** Active program. */
+    /** Program is active. */
     ProgramStatus["ACTIVE"] = "ACTIVE";
-    /** Paused program. */
+    /** Program is paused. It can be resumed. */
     ProgramStatus["PAUSED"] = "PAUSED";
-    /**
-     * Inactive program.
-     *
-     * Benefits of a program with an `ENDED` status can't be redeemed or reserved.
-     */
+    /** Program has ended. It can't be resumed. */
     ProgramStatus["ENDED"] = "ENDED";
-    /** Process state for programs that are currently being activated but have not yet completed the provisioning process. */
+    /** Program is being activated for the first time. This status will be true for a negligible amount of time. */
     ProgramStatus["PROVISIONING"] = "PROVISIONING";
-    /** Process state for programs that are currently pausing. */
+    /** Program is being paused. This status will be true for a negligible amount of time. */
     ProgramStatus["PAUSING"] = "PAUSING";
-    /** Process state for programs that are currently resuming. */
+    /** Program is being re-activated after being paused. This status will be true for a negligible amount of time. */
     ProgramStatus["RESUMING"] = "RESUMING";
-    /** Process state for programs that are currently ending. */
+    /** Program is being ended. This status will be true for a negligible amount of time. */
     ProgramStatus["ENDING"] = "ENDING";
 })(ProgramStatus || (exports.ProgramStatus = ProgramStatus = {}));
 var IdentityType;
@@ -37,9 +33,9 @@ var IdentityType;
 })(IdentityType || (exports.IdentityType = IdentityType = {}));
 var ProvisionProgramRequestProgramStatus;
 (function (ProvisionProgramRequestProgramStatus) {
-    /** Active program. */
+    /** Program is active. */
     ProvisionProgramRequestProgramStatus["ACTIVE"] = "ACTIVE";
-    /** Paused program. */
+    /** Program is paused. */
     ProvisionProgramRequestProgramStatus["PAUSED"] = "PAUSED";
 })(ProvisionProgramRequestProgramStatus || (exports.ProvisionProgramRequestProgramStatus = ProvisionProgramRequestProgramStatus = {}));
 var OrderStatus;