@wix/auto_sdk_benefit-programs_program-definitions 1.0.2 → 1.0.4

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

@@ -1,5 +1,5 @@
 import { RequestOptionsFactory } from '@wix/sdk-types';
-/** Creates a new program definition. */
+/** Creates a program definition. */
 export declare function createProgramDefinition(payload: object): RequestOptionsFactory<any>;
 /**
  * Updates a program definition.
@@ -15,21 +15,19 @@ export declare function updateProgramDefinition(payload: object): RequestOptions
 export declare function deleteProgramDefinition(payload: object): RequestOptionsFactory<any>;
 /** Retrieves a program definition. */
 export declare function getProgramDefinition(payload: object): RequestOptionsFactory<any>;
-/**
- * Retrieves a program definition by specifying the program definition's external ID and associated namespace.
- *
- * Use this method when you need to retrieve a program definition without its program definition ID.
- */
+/** Retrieves a program definition with the specified external ID and namespace. */
 export declare function getProgramDefinitionByExternalIdAndNamespace(payload: object): RequestOptionsFactory<any>;
 /**
  * Creates a query to retrieve a list of program definitions.
  *
- * The `queryProgramDefinitions()` method builds a query to retrieve a list of program definitions and returns a `ProgramDefinitionsQueryBuilder` object.
+ * The Query Program Definitions method builds a query to retrieve a list of program definitions and returns a `ProgramDefinitionsQueryBuilder` 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()`](/program-definitions/program-definitions-query-builder/find) function.
+ * You can refine the query by chaining `ProgramDefinitionsQueryBuilder` methods onto the query. `ProgramDefinitionsQueryBuilder` methods enable you to filter, sort, and control the results that Query Program Definitions returns.
  *
- * You can refine the query by chaining `ProgramDefinitionsQueryBuilder` methods onto the query. `ProgramDefinitionsQueryBuilder` methods enable you to filter, sort, and control the results that `queryProgramDefinitions()` returns.
+ * Query Program Definitions has a default paging limit of 50, which you can override.
  *
- * The following `ProgramDefinitionsQueryBuilder` functions are supported for `queryProgramDefinitions()`. For a full description of the program definition object, see the object returned for the [`items`](/program-definitions/program-definitions-query-result/items) property in `ProgramDefinitionsQueryResult`.
+ *  For a full description of the item object, see the object returned for the `items` property in `ProgramDefinitionsQueryResult`.
  */
 export declare function queryProgramDefinitions(payload: object): RequestOptionsFactory<any>;

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

@@ -111,7 +111,7 @@ function resolveWixBenefitProgramsV1ProgramDefinitionProgramDefinitionServiceUrl
     return (0, rest_modules_2.resolveUrl)(Object.assign(opts, { domainToMappings }));
 }
 const PACKAGE_NAME = '@wix/auto_sdk_benefit-programs_program-definitions';
-/** Creates a new program definition. */
+/** Creates a program definition. */
 function createProgramDefinition(payload) {
     function __createProgramDefinition({ host }) {
         const serializedData = (0, transform_paths_1.transformPaths)(payload, [
@@ -244,11 +244,7 @@ function getProgramDefinition(payload) {
     return __getProgramDefinition;
 }
 exports.getProgramDefinition = getProgramDefinition;
-/**
- * Retrieves a program definition by specifying the program definition's external ID and associated namespace.
- *
- * Use this method when you need to retrieve a program definition without its program definition ID.
- */
+/** Retrieves a program definition with the specified external ID and namespace. */
 function getProgramDefinitionByExternalIdAndNamespace(payload) {
     function __getProgramDefinitionByExternalIdAndNamespace({ host }) {
         const metadata = {
@@ -280,13 +276,15 @@ exports.getProgramDefinitionByExternalIdAndNamespace = getProgramDefinitionByExt
 /**
  * Creates a query to retrieve a list of program definitions.
  *
- * The `queryProgramDefinitions()` method builds a query to retrieve a list of program definitions and returns a `ProgramDefinitionsQueryBuilder` object.
+ * The Query Program Definitions method builds a query to retrieve a list of program definitions and returns a `ProgramDefinitionsQueryBuilder` 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()`](/program-definitions/program-definitions-query-builder/find) function.
+ * You can refine the query by chaining `ProgramDefinitionsQueryBuilder` methods onto the query. `ProgramDefinitionsQueryBuilder` methods enable you to filter, sort, and control the results that Query Program Definitions returns.
  *
- * You can refine the query by chaining `ProgramDefinitionsQueryBuilder` methods onto the query. `ProgramDefinitionsQueryBuilder` methods enable you to filter, sort, and control the results that `queryProgramDefinitions()` returns.
+ * Query Program Definitions has a default paging limit of 50, which you can override.
  *
- * The following `ProgramDefinitionsQueryBuilder` functions are supported for `queryProgramDefinitions()`. For a full description of the program definition object, see the object returned for the [`items`](/program-definitions/program-definitions-query-result/items) property in `ProgramDefinitionsQueryResult`.
+ *  For a full description of the item object, see the object returned for the `items` property in `ProgramDefinitionsQueryResult`.
  */
 function queryProgramDefinitions(payload) {
     function __queryProgramDefinitions({ host }) {

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

@@ -1 +1 @@
-{"version":3,"file":"benefit-programs-v1-program-definition-program-definitions.http.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-program-definition-program-definitions.http.ts"],"names":[],"mappings":";;;AAAA,gEAAkE;AAClE,0EAAkG;AAClG,0EAAkG;AAClG,4EAAmG;AACnG,sFAAkF;AAClF,gEAA2D;AAI3D,SAAS,uEAAuE,CAC9E,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,uBAAuB,EAAE;YACvB;gBACE,OAAO,EAAE,sBAAsB;gBAC/B,QAAQ,EAAE,EAAE;aACb;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,4CAA4C;gBACrD,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,+CAA+C;gBACxD,QAAQ,EAAE,yBAAyB;aACpC;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,4CAA4C;gBACrD,QAAQ,EAAE,EAAE;aACb;SACF;QACD,CAAC,EAAE;YACD;gBACE,OAAO,EAAE,4CAA4C;gBACrD,QAAQ,EAAE,EAAE;aACb;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,4CAA4C;gBACrD,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,+CAA+C;gBACxD,QAAQ,EAAE,yBAAyB;aACpC;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,4CAA4C;gBACrD,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,+CAA+C;gBACxD,QAAQ,EAAE,yBAAyB;aACpC;SACF;QACD,gBAAgB,EAAE;YAChB;gBACE,OAAO,EAAE,4CAA4C;gBACrD,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,+CAA+C;gBACxD,QAAQ,EAAE,yBAAyB;aACpC;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,4CAA4C;gBACrD,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,+CAA+C;gBACxD,QAAQ,EAAE,yBAAyB;aACpC;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,4CAA4C;gBACrD,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,+CAA+C;gBACxD,QAAQ,EAAE,yBAAyB;aACpC;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,4CAA4C;gBACrD,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,+CAA+C;gBACxD,QAAQ,EAAE,yBAAyB;aACpC;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,4CAA4C;gBACrD,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,+CAA+C;gBACxD,QAAQ,EAAE,yBAAyB;aACpC;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,oDAAoD,CAAC;AAE1E,wCAAwC;AACxC,SAAgB,uBAAuB,CACrC,OAAe;IAEf,SAAS,yBAAyB,CAAC,EAAE,IAAI,EAAO;QAC9C,MAAM,cAAc,GAAG,IAAA,gCAAc,EAAC,OAAO,EAAE;YAC7C;gBACE,WAAW,EAAE,gDAAoC;gBACjD,KAAK,EAAE;oBACL,EAAE,IAAI,EAAE,+BAA+B,EAAE;oBACzC,EAAE,IAAI,EAAE,+BAA+B,EAAE;iBAC1C;aACF;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4CAA4C;YACxD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,6FAA6F;YAC/F,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,uEAAuE,CAC1E,EAAE,SAAS,EAAE,yBAAyB,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,CACrE;YACD,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,+BAA+B,EAAE;wBACzC,EAAE,IAAI,EAAE,+BAA+B,EAAE;qBAC1C;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,yBAAyB,CAAC;AACnC,CAAC;AAvCD,0DAuCC;AAED;;;;;;;;GAQG;AACH,SAAgB,uBAAuB,CACrC,OAAe;IAEf,SAAS,yBAAyB,CAAC,EAAE,IAAI,EAAO;QAC9C,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,+BAA+B,EAAE;oBACzC,EAAE,IAAI,EAAE,+BAA+B,EAAE;iBAC1C;aACF;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4CAA4C;YACxD,MAAM,EAAE,OAAc;YACtB,SAAS,EACP,6FAA6F;YAC/F,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,uEAAuE,CAC1E;gBACE,SAAS,EAAE,gDAAgD;gBAC3D,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CACF;YACD,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,+BAA+B,EAAE;wBACzC,EAAE,IAAI,EAAE,+BAA+B,EAAE;qBAC1C;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,yBAAyB,CAAC;AACnC,CAAC;AA/CD,0DA+CC;AAED,oCAAoC;AACpC,SAAgB,uBAAuB,CACrC,OAAe;IAEf,SAAS,yBAAyB,CAAC,EAAE,IAAI,EAAO;QAC9C,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4CAA4C;YACxD,MAAM,EAAE,QAAe;YACvB,SAAS,EACP,6FAA6F;YAC/F,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,uEAAuE,CAC1E;gBACE,SAAS,EAAE,+CAA+C;gBAC1D,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CACF;YACD,MAAM,EAAE,IAAA,gCAAiB,EAAC,OAAO,CAAC;SACnC,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,yBAAyB,CAAC;AACnC,CAAC;AAxBD,0DAwBC;AAED,sCAAsC;AACtC,SAAgB,oBAAoB,CAClC,OAAe;IAEf,SAAS,sBAAsB,CAAC,EAAE,IAAI,EAAO;QAC3C,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4CAA4C;YACxD,MAAM,EAAE,KAAY;YACpB,SAAS,EACP,0FAA0F;YAC5F,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,uEAAuE,CAC1E;gBACE,SAAS,EAAE,+CAA+C;gBAC1D,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CACF;YACD,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,+BAA+B,EAAE;wBACzC,EAAE,IAAI,EAAE,+BAA+B,EAAE;qBAC1C;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,sBAAsB,CAAC;AAChC,CAAC;AAlCD,oDAkCC;AAED;;;;GAIG;AACH,SAAgB,4CAA4C,CAC1D,OAAe;IAEf,SAAS,8CAA8C,CAAC,EAAE,IAAI,EAAO;QACnE,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4CAA4C;YACxD,MAAM,EAAE,KAAY;YACpB,SAAS,EACP,kHAAkH;YACpH,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,uEAAuE,CAC1E;gBACE,SAAS,EAAE,sDAAsD;gBACjE,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CACF;YACD,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,+BAA+B,EAAE;wBACzC,EAAE,IAAI,EAAE,+BAA+B,EAAE;qBAC1C;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,8CAA8C,CAAC;AACxD,CAAC;AAlCD,oGAkCC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,uBAAuB,CACrC,OAAe;IAEf,SAAS,yBAAyB,CAAC,EAAE,IAAI,EAAO;QAC9C,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4CAA4C;YACxD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,6FAA6F;YAC/F,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,uEAAuE,CAC1E,EAAE,SAAS,EAAE,+BAA+B,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CACpE;YACD,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,gCAAgC,EAAE;wBAC1C,EAAE,IAAI,EAAE,gCAAgC,EAAE;qBAC3C;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,yBAAyB,CAAC;AACnC,CAAC;AA9BD,0DA8BC"}
+{"version":3,"file":"benefit-programs-v1-program-definition-program-definitions.http.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-program-definition-program-definitions.http.ts"],"names":[],"mappings":";;;AAAA,gEAAkE;AAClE,0EAAkG;AAClG,0EAAkG;AAClG,4EAAmG;AACnG,sFAAkF;AAClF,gEAA2D;AAI3D,SAAS,uEAAuE,CAC9E,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,uBAAuB,EAAE;YACvB;gBACE,OAAO,EAAE,sBAAsB;gBAC/B,QAAQ,EAAE,EAAE;aACb;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,4CAA4C;gBACrD,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,+CAA+C;gBACxD,QAAQ,EAAE,yBAAyB;aACpC;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,4CAA4C;gBACrD,QAAQ,EAAE,EAAE;aACb;SACF;QACD,CAAC,EAAE;YACD;gBACE,OAAO,EAAE,4CAA4C;gBACrD,QAAQ,EAAE,EAAE;aACb;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,4CAA4C;gBACrD,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,+CAA+C;gBACxD,QAAQ,EAAE,yBAAyB;aACpC;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,4CAA4C;gBACrD,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,+CAA+C;gBACxD,QAAQ,EAAE,yBAAyB;aACpC;SACF;QACD,gBAAgB,EAAE;YAChB;gBACE,OAAO,EAAE,4CAA4C;gBACrD,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,+CAA+C;gBACxD,QAAQ,EAAE,yBAAyB;aACpC;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,4CAA4C;gBACrD,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,+CAA+C;gBACxD,QAAQ,EAAE,yBAAyB;aACpC;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,4CAA4C;gBACrD,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,+CAA+C;gBACxD,QAAQ,EAAE,yBAAyB;aACpC;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,4CAA4C;gBACrD,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,+CAA+C;gBACxD,QAAQ,EAAE,yBAAyB;aACpC;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,4CAA4C;gBACrD,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,+CAA+C;gBACxD,QAAQ,EAAE,yBAAyB;aACpC;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,oDAAoD,CAAC;AAE1E,oCAAoC;AACpC,SAAgB,uBAAuB,CACrC,OAAe;IAEf,SAAS,yBAAyB,CAAC,EAAE,IAAI,EAAO;QAC9C,MAAM,cAAc,GAAG,IAAA,gCAAc,EAAC,OAAO,EAAE;YAC7C;gBACE,WAAW,EAAE,gDAAoC;gBACjD,KAAK,EAAE;oBACL,EAAE,IAAI,EAAE,+BAA+B,EAAE;oBACzC,EAAE,IAAI,EAAE,+BAA+B,EAAE;iBAC1C;aACF;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4CAA4C;YACxD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,6FAA6F;YAC/F,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,uEAAuE,CAC1E,EAAE,SAAS,EAAE,yBAAyB,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,CACrE;YACD,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,+BAA+B,EAAE;wBACzC,EAAE,IAAI,EAAE,+BAA+B,EAAE;qBAC1C;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,yBAAyB,CAAC;AACnC,CAAC;AAvCD,0DAuCC;AAED;;;;;;;;GAQG;AACH,SAAgB,uBAAuB,CACrC,OAAe;IAEf,SAAS,yBAAyB,CAAC,EAAE,IAAI,EAAO;QAC9C,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,+BAA+B,EAAE;oBACzC,EAAE,IAAI,EAAE,+BAA+B,EAAE;iBAC1C;aACF;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4CAA4C;YACxD,MAAM,EAAE,OAAc;YACtB,SAAS,EACP,6FAA6F;YAC/F,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,uEAAuE,CAC1E;gBACE,SAAS,EAAE,gDAAgD;gBAC3D,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CACF;YACD,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,+BAA+B,EAAE;wBACzC,EAAE,IAAI,EAAE,+BAA+B,EAAE;qBAC1C;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,yBAAyB,CAAC;AACnC,CAAC;AA/CD,0DA+CC;AAED,oCAAoC;AACpC,SAAgB,uBAAuB,CACrC,OAAe;IAEf,SAAS,yBAAyB,CAAC,EAAE,IAAI,EAAO;QAC9C,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4CAA4C;YACxD,MAAM,EAAE,QAAe;YACvB,SAAS,EACP,6FAA6F;YAC/F,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,uEAAuE,CAC1E;gBACE,SAAS,EAAE,+CAA+C;gBAC1D,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CACF;YACD,MAAM,EAAE,IAAA,gCAAiB,EAAC,OAAO,CAAC;SACnC,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,yBAAyB,CAAC;AACnC,CAAC;AAxBD,0DAwBC;AAED,sCAAsC;AACtC,SAAgB,oBAAoB,CAClC,OAAe;IAEf,SAAS,sBAAsB,CAAC,EAAE,IAAI,EAAO;QAC3C,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4CAA4C;YACxD,MAAM,EAAE,KAAY;YACpB,SAAS,EACP,0FAA0F;YAC5F,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,uEAAuE,CAC1E;gBACE,SAAS,EAAE,+CAA+C;gBAC1D,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CACF;YACD,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,+BAA+B,EAAE;wBACzC,EAAE,IAAI,EAAE,+BAA+B,EAAE;qBAC1C;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,sBAAsB,CAAC;AAChC,CAAC;AAlCD,oDAkCC;AAED,mFAAmF;AACnF,SAAgB,4CAA4C,CAC1D,OAAe;IAEf,SAAS,8CAA8C,CAAC,EAAE,IAAI,EAAO;QACnE,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4CAA4C;YACxD,MAAM,EAAE,KAAY;YACpB,SAAS,EACP,kHAAkH;YACpH,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,uEAAuE,CAC1E;gBACE,SAAS,EAAE,sDAAsD;gBACjE,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CACF;YACD,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,+BAA+B,EAAE;wBACzC,EAAE,IAAI,EAAE,+BAA+B,EAAE;qBAC1C;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,8CAA8C,CAAC;AACxD,CAAC;AAlCD,oGAkCC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,uBAAuB,CACrC,OAAe;IAEf,SAAS,yBAAyB,CAAC,EAAE,IAAI,EAAO;QAC9C,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4CAA4C;YACxD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,6FAA6F;YAC/F,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,uEAAuE,CAC1E,EAAE,SAAS,EAAE,+BAA+B,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CACpE;YACD,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,gCAAgC,EAAE;wBAC1C,EAAE,IAAI,EAAE,gCAAgC,EAAE;qBAC3C;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,yBAAyB,CAAC;AACnC,CAAC;AA9BD,0DA8BC"}

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

@@ -6,7 +6,7 @@ export declare const __metadata: {
 export declare function createProgramDefinition(httpClient: HttpClient): CreateProgramDefinitionSignature;
 interface CreateProgramDefinitionSignature {
     /**
-     * Creates a new program definition.
+     * Creates a program definition.
      * @param - Program definition to create.
      * @returns Created program definition.
      */
@@ -31,7 +31,7 @@ export declare function deleteProgramDefinition(httpClient: HttpClient): DeleteP
 interface DeleteProgramDefinitionSignature {
     /**
      * Deletes a program definition.
-     * @param - ID of the ProgramDefinition to delete.
+     * @param - ID of the program definition to delete.
      */
     (programDefinitionId: string, options?: DeleteProgramDefinitionOptions | undefined): Promise<void>;
 }
@@ -47,10 +47,8 @@ interface GetProgramDefinitionSignature {
 export declare function getProgramDefinitionByExternalIdAndNamespace(httpClient: HttpClient): GetProgramDefinitionByExternalIdAndNamespaceSignature;
 interface GetProgramDefinitionByExternalIdAndNamespaceSignature {
     /**
-     * Retrieves a program definition by specifying the program definition's external ID and associated namespace.
-     *
-     * Use this method when you need to retrieve a program definition without its program definition ID.
-     * @param - Application sub-module that represents the source of the program definition. Specified by the external developer. This namespace is used to handle and retrieve program definition and associated programs.
+     * Retrieves a program definition with the specified external ID and namespace.
+     * @param - Namespace for your app or site's benefit programs.
      */
     (namespace: string, options: GetProgramDefinitionByExternalIdAndNamespaceOptions): Promise<GetProgramDefinitionByExternalIdAndNamespaceResponse>;
 }
@@ -59,13 +57,15 @@ interface QueryProgramDefinitionsSignature {
     /**
      * Creates a query to retrieve a list of program definitions.
      *
-     * The `queryProgramDefinitions()` method builds a query to retrieve a list of program definitions and returns a `ProgramDefinitionsQueryBuilder` object.
+     * The Query Program Definitions method builds a query to retrieve a list of program definitions and returns a `ProgramDefinitionsQueryBuilder` 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()`](/program-definitions/program-definitions-query-builder/find) function.
+     * You can refine the query by chaining `ProgramDefinitionsQueryBuilder` methods onto the query. `ProgramDefinitionsQueryBuilder` methods enable you to filter, sort, and control the results that Query Program Definitions returns.
      *
-     * You can refine the query by chaining `ProgramDefinitionsQueryBuilder` methods onto the query. `ProgramDefinitionsQueryBuilder` methods enable you to filter, sort, and control the results that `queryProgramDefinitions()` returns.
+     * Query Program Definitions has a default paging limit of 50, which you can override.
      *
-     * The following `ProgramDefinitionsQueryBuilder` functions are supported for `queryProgramDefinitions()`. For a full description of the program definition object, see the object returned for the [`items`](/program-definitions/program-definitions-query-result/items) property in `ProgramDefinitionsQueryResult`.
+     *  For a full description of the item object, see the object returned for the `items` property in `ProgramDefinitionsQueryResult`.
      */
     (): ProgramDefinitionsQueryBuilder;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"benefit-programs-v1-program-definition-program-definitions.public.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-program-definition-program-definitions.public.ts"],"names":[],"mappings":";;;AACA,uKAamF;AAEtE,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,uBAAuB,EAAE,CAAC;AAEpE,SAAgB,uBAAuB,CACrC,UAAsB;IAEtB,OAAO,CAAC,iBAAoC,EAAE,EAAE,CAC9C,IAAA,iGAAgC,EAC9B,iBAAiB;IACjB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,0DASC;AAWD,SAAgB,uBAAuB,CACrC,UAAsB;IAEtB,OAAO,CAAC,GAAkB,EAAE,iBAA0C,EAAE,EAAE,CACxE,IAAA,iGAAgC,EAC9B,GAAG,EACH,iBAAiB;IACjB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAVD,0DAUC;AAoBD,SAAgB,uBAAuB,CACrC,UAAsB;IAEtB,OAAO,CACL,mBAA2B,EAC3B,OAAwC,EACxC,EAAE,CACF,IAAA,iGAAgC,EAC9B,mBAAmB,EACnB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAbD,0DAaC;AAaD,SAAgB,oBAAoB,CAClC,UAAsB;IAEtB,OAAO,CAAC,mBAA2B,EAAE,EAAE,CACrC,IAAA,8FAA6B,EAC3B,mBAAmB;IACnB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,oDASC;AAWD,SAAgB,4CAA4C,CAC1D,UAAsB;IAEtB,OAAO,CACL,SAAiB,EACjB,OAA4D,EAC5D,EAAE,CACF,IAAA,sHAAqD,EACnD,SAAS,EACT,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAbD,oGAaC;AAeD,SAAgB,uBAAuB,CACrC,UAAsB;IAEtB,OAAO,GAAG,EAAE,CACV,IAAA,iGAAgC;IAC9B,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,0DAQC;AAiBD,qKA2CmF;AAzCjF,kKAAA,OAAO,OAAA;AAiCP,oKAAA,SAAS,OAAA;AAOT,8KAAA,mBAAmB,OAAA"}
+{"version":3,"file":"benefit-programs-v1-program-definition-program-definitions.public.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-program-definition-program-definitions.public.ts"],"names":[],"mappings":";;;AACA,uKAamF;AAEtE,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,uBAAuB,EAAE,CAAC;AAEpE,SAAgB,uBAAuB,CACrC,UAAsB;IAEtB,OAAO,CAAC,iBAAoC,EAAE,EAAE,CAC9C,IAAA,iGAAgC,EAC9B,iBAAiB;IACjB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,0DASC;AAWD,SAAgB,uBAAuB,CACrC,UAAsB;IAEtB,OAAO,CAAC,GAAkB,EAAE,iBAA0C,EAAE,EAAE,CACxE,IAAA,iGAAgC,EAC9B,GAAG,EACH,iBAAiB;IACjB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAVD,0DAUC;AAoBD,SAAgB,uBAAuB,CACrC,UAAsB;IAEtB,OAAO,CACL,mBAA2B,EAC3B,OAAwC,EACxC,EAAE,CACF,IAAA,iGAAgC,EAC9B,mBAAmB,EACnB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAbD,0DAaC;AAaD,SAAgB,oBAAoB,CAClC,UAAsB;IAEtB,OAAO,CAAC,mBAA2B,EAAE,EAAE,CACrC,IAAA,8FAA6B,EAC3B,mBAAmB;IACnB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,oDASC;AAWD,SAAgB,4CAA4C,CAC1D,UAAsB;IAEtB,OAAO,CACL,SAAiB,EACjB,OAA4D,EAC5D,EAAE,CACF,IAAA,sHAAqD,EACnD,SAAS,EACT,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAbD,oGAaC;AAaD,SAAgB,uBAAuB,CACrC,UAAsB;IAEtB,OAAO,GAAG,EAAE,CACV,IAAA,iGAAgC;IAC9B,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,0DAQC;AAmBD,qKA2CmF;AAzCjF,kKAAA,OAAO,OAAA;AAiCP,oKAAA,SAAS,OAAA;AAOT,8KAAA,mBAAmB,OAAA"}

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

@@ -25,12 +25,12 @@ export interface ProgramDefinition {
      */
     updatedDate?: Date | null;
     /**
-     * Name of the program associated with this program definition. This name will be the same for all programs provisioned from this program definition.
+     * Program definition name.
      * @maxLength 64
      */
     displayName?: string | null;
     /**
-     * Application sub-module that represents the source of the program definition. Specified by the external developer. This namespace is used to handle and retrieve program definition and associated programs.
+     * Namespace for your app or site's benefit programs.
      * @immutable
      * @minLength 1
      * @maxLength 50
@@ -38,11 +38,12 @@ export interface ProgramDefinition {
     namespace?: string | null;
     /**
      * Custom field data for the program definition object.
+     *
      * [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 definition ID designated by the app owner.
+     * ID for the program definition defined by you. You can use `externalId` to filter queries.
      * @format GUID
      * @immutable
      */
@@ -68,7 +69,7 @@ export interface CreateProgramDefinitionResponse {
     programDefinition?: ProgramDefinition;
 }
 export interface UpdateProgramDefinitionRequest {
-    /** Program definition to updated. */
+    /** Program definition to update. */
     programDefinition: ProgramDefinition;
 }
 export interface UpdateProgramDefinitionResponse {
@@ -77,36 +78,21 @@ export interface UpdateProgramDefinitionResponse {
 }
 export interface DeleteProgramDefinitionRequest {
     /**
-     * ID of the ProgramDefinition to delete.
+     * ID of the program definition to delete.
      * @format GUID
      */
     programDefinitionId: string;
-    /**
-     * Specifies the timing of ending the active benefit pools associated with this program definition.
-     * Determines how and when changes are applied to benefit pools.
-     */
+    /** Determines when the changes to this program definition will be applied to associated programs and pools. */
     cascadeType?: Cascade;
 }
 export declare enum Cascade {
     /** Unknown cascade. */
     UNKNOWN_CASCADE = "UNKNOWN_CASCADE",
-    /**
-     * Updates the associated benefit pools to reflect the new or modified pool definition. The benefits will appear in existing programs at the beginning of their next renewal cycle.
-     *
-     * Existing programs will be updated in their next renewal cycle.
-     */
+    /** Changes are applied to existing programs and pools when they are next renewed. */
     NEXT_RENEWAL = "NEXT_RENEWAL",
-    /**
-     * Updates the associated benefit pools to reflect the new or modified pool definition immediately.
-     *
-     * Existing programs will be updated immediately.
-     */
+    /** Changes are applied to associated programs and pools immediately. */
     IMMEDIATELY = "IMMEDIATELY",
-    /**
-     * Updates the associated benefit pools to reflect the new or modified pool definition the next time the benefit pools are provisioned to a program.
-     *
-     * Existing programs will remain unaffected. Only newly purchased programs will display the benefits of this pool definition.
-     */
+    /** Changes are not applied to existing associated programs and pools. They are only applied to future programs and pools. */
     FUTURE_PROVISIONS = "FUTURE_PROVISIONS"
 }
 export interface DeleteProgramDefinitionResponse {
@@ -124,40 +110,36 @@ export interface GetProgramDefinitionResponse {
 }
 export interface GetProgramDefinitionByExternalIdAndNamespaceRequest {
     /**
-     * Application sub-module that represents the source of the program definition. Specified by the external developer. This namespace is used to handle and retrieve program definition and associated programs.
+     * Namespace for your app or site's benefit programs.
      * @minLength 1
      * @maxLength 50
      */
     namespace: string;
     /**
-     * External program definition ID.
+     * Program definition external ID.
      * @format GUID
      */
     externalId: string;
 }
 export interface GetProgramDefinitionByExternalIdAndNamespaceResponse {
-    /** The retrieved program definition. */
+    /** Retrieved program definition. */
     programDefinition?: ProgramDefinition;
 }
 export interface QueryProgramDefinitionsRequest {
-    /** Query to select program definitions. */
+    /** Filter, sort, and paging to apply to the query. */
     query?: CursorQuery;
 }
 export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /** 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`. */
     cursorPaging?: CursorPaging;
     /**
-     * Filter object in the following format:
-     * `"filter" : {
-     * "fieldName1": "value1",
-     * "fieldName2":{"$operator":"value2"}
-     * }`
-     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     * Filter object.
+     * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
+     * for more information.
      */
     filter?: Record<string, any> | null;
     /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * List of sort objects.
      * @maxSize 5
      */
     sort?: Sorting[];
@@ -169,11 +151,15 @@ export interface CursorQueryPagingMethodOneOf {
 }
 export interface Sorting {
     /**
-     * Name of the field to sort by.
+     * Field to sort by.
      * @maxLength 512
      */
     fieldName?: string;
-    /** Sort order. */
+    /**
+     * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
+     *
+     * Default: `ASC`
+     */
     order?: SortOrder;
 }
 export declare enum SortOrder {
@@ -184,7 +170,7 @@ export declare enum SortOrder {
 }
 export interface CursorPaging {
     /**
-     * Maximum number of items to return in the results.
+     * Maximum number of items to return.
      * @max 100
      */
     limit?: number | null;
@@ -198,7 +184,7 @@ export interface CursorPaging {
     cursor?: string | null;
 }
 export interface QueryProgramDefinitionsResponse {
-    /** List of program definitions. */
+    /** List of retrieved program definitions. */
     programDefinitions?: ProgramDefinition[];
     /** Metadata for the paginated results. */
     metadata?: CursorPagingMetadata;

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

@@ -5,23 +5,11 @@ var Cascade;
 (function (Cascade) {
     /** Unknown cascade. */
     Cascade["UNKNOWN_CASCADE"] = "UNKNOWN_CASCADE";
-    /**
-     * Updates the associated benefit pools to reflect the new or modified pool definition. The benefits will appear in existing programs at the beginning of their next renewal cycle.
-     *
-     * Existing programs will be updated in their next renewal cycle.
-     */
+    /** Changes are applied to existing programs and pools when they are next renewed. */
     Cascade["NEXT_RENEWAL"] = "NEXT_RENEWAL";
-    /**
-     * Updates the associated benefit pools to reflect the new or modified pool definition immediately.
-     *
-     * Existing programs will be updated immediately.
-     */
+    /** Changes are applied to associated programs and pools immediately. */
     Cascade["IMMEDIATELY"] = "IMMEDIATELY";
-    /**
-     * Updates the associated benefit pools to reflect the new or modified pool definition the next time the benefit pools are provisioned to a program.
-     *
-     * Existing programs will remain unaffected. Only newly purchased programs will display the benefits of this pool definition.
-     */
+    /** Changes are not applied to existing associated programs and pools. They are only applied to future programs and pools. */
     Cascade["FUTURE_PROVISIONS"] = "FUTURE_PROVISIONS";
 })(Cascade || (exports.Cascade = Cascade = {}));
 var SortOrder;

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

@@ -1 +1 @@
-{"version":3,"file":"benefit-programs-v1-program-definition-program-definitions.types.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-program-definition-program-definitions.types.ts"],"names":[],"mappings":";;;AAgGA,IAAY,OAqBX;AArBD,WAAY,OAAO;IACjB,uBAAuB;IACvB,8CAAmC,CAAA;IACnC;;;;OAIG;IACH,wCAA6B,CAAA;IAC7B;;;;OAIG;IACH,sCAA2B,CAAA;IAC3B;;;;OAIG;IACH,kDAAuC,CAAA;AACzC,CAAC,EArBW,OAAO,uBAAP,OAAO,QAqBlB;AA6ED,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,4BAA4B;IAC5B,wBAAW,CAAA;IACX,6BAA6B;IAC7B,0BAAa,CAAA;AACf,CAAC,EALW,SAAS,yBAAT,SAAS,QAKpB;AAkOD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
+{"version":3,"file":"benefit-programs-v1-program-definition-program-definitions.types.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-program-definition-program-definitions.types.ts"],"names":[],"mappings":";;;AA8FA,IAAY,OASX;AATD,WAAY,OAAO;IACjB,uBAAuB;IACvB,8CAAmC,CAAA;IACnC,qFAAqF;IACrF,wCAA6B,CAAA;IAC7B,wEAAwE;IACxE,sCAA2B,CAAA;IAC3B,6HAA6H;IAC7H,kDAAuC,CAAA;AACzC,CAAC,EATW,OAAO,uBAAP,OAAO,QASlB;AA6ED,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,4BAA4B;IAC5B,wBAAW,CAAA;IACX,6BAA6B;IAC7B,0BAAa,CAAA;AACf,CAAC,EALW,SAAS,yBAAT,SAAS,QAKpB;AAkOD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}

package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.universal.d.ts

@@ -25,12 +25,12 @@ export interface ProgramDefinition {
      */
     _updatedDate?: Date | null;
     /**
-     * Name of the program associated with this program definition. This name will be the same for all programs provisioned from this program definition.
+     * Program definition name.
      * @maxLength 64
      */
     displayName?: string | null;
     /**
-     * Application sub-module that represents the source of the program definition. Specified by the external developer. This namespace is used to handle and retrieve program definition and associated programs.
+     * Namespace for your app or site's benefit programs.
      * @immutable
      * @minLength 1
      * @maxLength 50
@@ -38,11 +38,12 @@ export interface ProgramDefinition {
     namespace?: string | null;
     /**
      * Custom field data for the program definition object.
+     *
      * [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 definition ID designated by the app owner.
+     * ID for the program definition defined by you. You can use `externalId` to filter queries.
      * @format GUID
      * @immutable
      */
@@ -68,7 +69,7 @@ export interface CreateProgramDefinitionResponse {
     programDefinition?: ProgramDefinition;
 }
 export interface UpdateProgramDefinitionRequest {
-    /** Program definition to updated. */
+    /** Program definition to update. */
     programDefinition: ProgramDefinition;
 }
 export interface UpdateProgramDefinitionResponse {
@@ -77,36 +78,21 @@ export interface UpdateProgramDefinitionResponse {
 }
 export interface DeleteProgramDefinitionRequest {
     /**
-     * ID of the ProgramDefinition to delete.
+     * ID of the program definition to delete.
      * @format GUID
      */
     programDefinitionId: string;
-    /**
-     * Specifies the timing of ending the active benefit pools associated with this program definition.
-     * Determines how and when changes are applied to benefit pools.
-     */
+    /** Determines when the changes to this program definition will be applied to associated programs and pools. */
     cascadeType?: Cascade;
 }
 export declare enum Cascade {
     /** Unknown cascade. */
     UNKNOWN_CASCADE = "UNKNOWN_CASCADE",
-    /**
-     * Updates the associated benefit pools to reflect the new or modified pool definition. The benefits will appear in existing programs at the beginning of their next renewal cycle.
-     *
-     * Existing programs will be updated in their next renewal cycle.
-     */
+    /** Changes are applied to existing programs and pools when they are next renewed. */
     NEXT_RENEWAL = "NEXT_RENEWAL",
-    /**
-     * Updates the associated benefit pools to reflect the new or modified pool definition immediately.
-     *
-     * Existing programs will be updated immediately.
-     */
+    /** Changes are applied to associated programs and pools immediately. */
     IMMEDIATELY = "IMMEDIATELY",
-    /**
-     * Updates the associated benefit pools to reflect the new or modified pool definition the next time the benefit pools are provisioned to a program.
-     *
-     * Existing programs will remain unaffected. Only newly purchased programs will display the benefits of this pool definition.
-     */
+    /** Changes are not applied to existing associated programs and pools. They are only applied to future programs and pools. */
     FUTURE_PROVISIONS = "FUTURE_PROVISIONS"
 }
 export interface DeleteProgramDefinitionResponse {
@@ -124,40 +110,36 @@ export interface GetProgramDefinitionResponse {
 }
 export interface GetProgramDefinitionByExternalIdAndNamespaceRequest {
     /**
-     * Application sub-module that represents the source of the program definition. Specified by the external developer. This namespace is used to handle and retrieve program definition and associated programs.
+     * Namespace for your app or site's benefit programs.
      * @minLength 1
      * @maxLength 50
      */
     namespace: string;
     /**
-     * External program definition ID.
+     * Program definition external ID.
      * @format GUID
      */
     externalId: string;
 }
 export interface GetProgramDefinitionByExternalIdAndNamespaceResponse {
-    /** The retrieved program definition. */
+    /** Retrieved program definition. */
     programDefinition?: ProgramDefinition;
 }
 export interface QueryProgramDefinitionsRequest {
-    /** Query to select program definitions. */
+    /** Filter, sort, and paging to apply to the query. */
     query?: CursorQuery;
 }
 export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /** 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`. */
     cursorPaging?: CursorPaging;
     /**
-     * Filter object in the following format:
-     * `"filter" : {
-     * "fieldName1": "value1",
-     * "fieldName2":{"$operator":"value2"}
-     * }`
-     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     * Filter object.
+     * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
+     * for more information.
      */
     filter?: Record<string, any> | null;
     /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * List of sort objects.
      * @maxSize 5
      */
     sort?: Sorting[];
@@ -169,11 +151,15 @@ export interface CursorQueryPagingMethodOneOf {
 }
 export interface Sorting {
     /**
-     * Name of the field to sort by.
+     * Field to sort by.
      * @maxLength 512
      */
     fieldName?: string;
-    /** Sort order. */
+    /**
+     * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
+     *
+     * Default: `ASC`
+     */
     order?: SortOrder;
 }
 export declare enum SortOrder {
@@ -184,7 +170,7 @@ export declare enum SortOrder {
 }
 export interface CursorPaging {
     /**
-     * Maximum number of items to return in the results.
+     * Maximum number of items to return.
      * @max 100
      */
     limit?: number | null;
@@ -198,7 +184,7 @@ export interface CursorPaging {
     cursor?: string | null;
 }
 export interface QueryProgramDefinitionsResponse {
-    /** List of program definitions. */
+    /** List of retrieved program definitions. */
     programDefinitions?: ProgramDefinition[];
     /** Metadata for the paginated results. */
     metadata?: CursorPagingMetadata;
@@ -394,7 +380,7 @@ export declare enum WebhookIdentityType {
     APP = "APP"
 }
 /**
- * Creates a new program definition.
+ * Creates a program definition.
  * @param programDefinition - Program definition to create.
  * @public
  * @documentationMaturity preview
@@ -458,12 +444,12 @@ export interface UpdateProgramDefinition {
      */
     _updatedDate?: Date | null;
     /**
-     * Name of the program associated with this program definition. This name will be the same for all programs provisioned from this program definition.
+     * Program definition name.
      * @maxLength 64
      */
     displayName?: string | null;
     /**
-     * Application sub-module that represents the source of the program definition. Specified by the external developer. This namespace is used to handle and retrieve program definition and associated programs.
+     * Namespace for your app or site's benefit programs.
      * @immutable
      * @minLength 1
      * @maxLength 50
@@ -471,11 +457,12 @@ export interface UpdateProgramDefinition {
     namespace?: string | null;
     /**
      * Custom field data for the program definition object.
+     *
      * [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 definition ID designated by the app owner.
+     * ID for the program definition defined by you. You can use `externalId` to filter queries.
      * @format GUID
      * @immutable
      */
@@ -483,7 +470,7 @@ export interface UpdateProgramDefinition {
 }
 /**
  * Deletes a program definition.
- * @param programDefinitionId - ID of the ProgramDefinition to delete.
+ * @param programDefinitionId - ID of the program definition to delete.
  * @public
  * @documentationMaturity preview
  * @requiredField programDefinitionId
@@ -495,10 +482,7 @@ export interface UpdateProgramDefinition {
  */
 export declare function deleteProgramDefinition(programDefinitionId: string, options?: DeleteProgramDefinitionOptions): Promise<void>;
 export interface DeleteProgramDefinitionOptions {
-    /**
-     * Specifies the timing of ending the active benefit pools associated with this program definition.
-     * Determines how and when changes are applied to benefit pools.
-     */
+    /** Determines when the changes to this program definition will be applied to associated programs and pools. */
     cascadeType?: Cascade;
 }
 /**
@@ -521,10 +505,8 @@ export interface DeleteProgramDefinitionOptions {
  */
 export declare function getProgramDefinition(programDefinitionId: string): Promise<ProgramDefinition>;
 /**
- * Retrieves a program definition by specifying the program definition's external ID and associated namespace.
- *
- * Use this method when you need to retrieve a program definition without its program definition ID.
- * @param namespace - Application sub-module that represents the source of the program definition. Specified by the external developer. This namespace is used to handle and retrieve program definition and associated programs.
+ * Retrieves a program definition with the specified external ID and namespace.
+ * @param namespace - Namespace for your app or site's benefit programs.
  * @public
  * @documentationMaturity preview
  * @requiredField namespace
@@ -544,7 +526,7 @@ export declare function getProgramDefinition(programDefinitionId: string): Promi
 export declare function getProgramDefinitionByExternalIdAndNamespace(namespace: string, options: GetProgramDefinitionByExternalIdAndNamespaceOptions): Promise<GetProgramDefinitionByExternalIdAndNamespaceResponse>;
 export interface GetProgramDefinitionByExternalIdAndNamespaceOptions {
     /**
-     * External program definition ID.
+     * Program definition external ID.
      * @format GUID
      */
     externalId: string;
@@ -552,13 +534,15 @@ export interface GetProgramDefinitionByExternalIdAndNamespaceOptions {
 /**
  * Creates a query to retrieve a list of program definitions.
  *
- * The `queryProgramDefinitions()` method builds a query to retrieve a list of program definitions and returns a `ProgramDefinitionsQueryBuilder` object.
+ * The Query Program Definitions method builds a query to retrieve a list of program definitions and returns a `ProgramDefinitionsQueryBuilder` 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()`](/program-definitions/program-definitions-query-builder/find) function.
+ * You can refine the query by chaining `ProgramDefinitionsQueryBuilder` methods onto the query. `ProgramDefinitionsQueryBuilder` methods enable you to filter, sort, and control the results that Query Program Definitions returns.
  *
- * You can refine the query by chaining `ProgramDefinitionsQueryBuilder` methods onto the query. `ProgramDefinitionsQueryBuilder` methods enable you to filter, sort, and control the results that `queryProgramDefinitions()` returns.
+ * Query Program Definitions has a default paging limit of 50, which you can override.
  *
- * The following `ProgramDefinitionsQueryBuilder` functions are supported for `queryProgramDefinitions()`. For a full description of the program definition object, see the object returned for the [`items`](/program-definitions/program-definitions-query-result/items) property in `ProgramDefinitionsQueryResult`.
+ *  For a full description of the item object, see the object returned for the `items` property in `ProgramDefinitionsQueryResult`.
  * @public
  * @documentationMaturity preview
  * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE