@wix/auto_sdk_benefit-programs_program-definitions 1.0.1 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.http.d.ts +8 -10
  2. package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.http.js +8 -10
  3. package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.http.js.map +1 -1
  4. package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.public.d.ts +10 -10
  5. package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.public.js.map +1 -1
  6. package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.types.d.ts +109 -45
  7. package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.types.js +3 -15
  8. package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.types.js.map +1 -1
  9. package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.universal.d.ts +148 -63
  10. package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.universal.js +19 -25
  11. package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.universal.js.map +1 -1
  12. package/build/es/src/benefit-programs-v1-program-definition-program-definitions.http.d.ts +8 -10
  13. package/build/es/src/benefit-programs-v1-program-definition-program-definitions.http.js +8 -10
  14. package/build/es/src/benefit-programs-v1-program-definition-program-definitions.http.js.map +1 -1
  15. package/build/es/src/benefit-programs-v1-program-definition-program-definitions.public.d.ts +10 -10
  16. package/build/es/src/benefit-programs-v1-program-definition-program-definitions.public.js.map +1 -1
  17. package/build/es/src/benefit-programs-v1-program-definition-program-definitions.types.d.ts +109 -45
  18. package/build/es/src/benefit-programs-v1-program-definition-program-definitions.types.js +3 -15
  19. package/build/es/src/benefit-programs-v1-program-definition-program-definitions.types.js.map +1 -1
  20. package/build/es/src/benefit-programs-v1-program-definition-program-definitions.universal.d.ts +148 -63
  21. package/build/es/src/benefit-programs-v1-program-definition-program-definitions.universal.js +19 -25
  22. package/build/es/src/benefit-programs-v1-program-definition-program-definitions.universal.js.map +1 -1
  23. package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.http.d.ts +8 -10
  24. package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.http.js +8 -10
  25. package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.http.js.map +1 -1
  26. package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.public.d.ts +10 -10
  27. package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.public.js.map +1 -1
  28. package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.types.d.ts +109 -45
  29. package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.types.js +3 -15
  30. package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.types.js.map +1 -1
  31. package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.universal.d.ts +148 -63
  32. package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.universal.js +19 -25
  33. package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.universal.js.map +1 -1
  34. package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.http.d.ts +8 -10
  35. package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.http.js +8 -10
  36. package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.http.js.map +1 -1
  37. package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.public.d.ts +10 -10
  38. package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.public.js.map +1 -1
  39. package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.types.d.ts +109 -45
  40. package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.types.js +3 -15
  41. package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.types.js.map +1 -1
  42. package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.universal.d.ts +148 -63
  43. package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.universal.js +19 -25
  44. package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.universal.js.map +1 -1
  45. package/package.json +2 -2
@@ -1,5 +1,5 @@
1
1
  import { RequestOptionsFactory } from '@wix/sdk-types';
2
- /** Creates a new program definition. */
2
+ /** Creates a program definition. */
3
3
  export declare function createProgramDefinition(payload: object): RequestOptionsFactory<any>;
4
4
  /**
5
5
  * Updates a program definition.
@@ -15,21 +15,19 @@ export declare function updateProgramDefinition(payload: object): RequestOptions
15
15
  export declare function deleteProgramDefinition(payload: object): RequestOptionsFactory<any>;
16
16
  /** Retrieves a program definition. */
17
17
  export declare function getProgramDefinition(payload: object): RequestOptionsFactory<any>;
18
- /**
19
- * Retrieves a program definition by specifying the program definition's external ID and associated namespace.
20
- *
21
- * Use this method when you need to retrieve a program definition without its program definition ID.
22
- */
18
+ /** Retrieves a program definition with the specified external ID and namespace. */
23
19
  export declare function getProgramDefinitionByExternalIdAndNamespace(payload: object): RequestOptionsFactory<any>;
24
20
  /**
25
21
  * Creates a query to retrieve a list of program definitions.
26
22
  *
27
- * The `queryProgramDefinitions()` method builds a query to retrieve a list of program definitions and returns a `ProgramDefinitionsQueryBuilder` object.
23
+ * The Query Program Definitions method builds a query to retrieve a list of program definitions and returns a `ProgramDefinitionsQueryBuilder` object.
24
+ *
25
+ * The returned object contains the query definition, which is used to run the query using the `find()` method.
28
26
  *
29
- * 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.
27
+ * 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.
30
28
  *
31
- * 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.
29
+ * Query Program Definitions has a default paging limit of 50, which you can override.
32
30
  *
33
- * 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`.
31
+ * For a full description of the item object, see the object returned for the `items` property in `ProgramDefinitionsQueryResult`.
34
32
  */
35
33
  export declare function queryProgramDefinitions(payload: object): RequestOptionsFactory<any>;
@@ -111,7 +111,7 @@ function resolveWixBenefitProgramsV1ProgramDefinitionProgramDefinitionServiceUrl
111
111
  return (0, rest_modules_2.resolveUrl)(Object.assign(opts, { domainToMappings }));
112
112
  }
113
113
  const PACKAGE_NAME = '@wix/auto_sdk_benefit-programs_program-definitions';
114
- /** Creates a new program definition. */
114
+ /** Creates a program definition. */
115
115
  function createProgramDefinition(payload) {
116
116
  function __createProgramDefinition({ host }) {
117
117
  const serializedData = (0, transform_paths_1.transformPaths)(payload, [
@@ -244,11 +244,7 @@ function getProgramDefinition(payload) {
244
244
  return __getProgramDefinition;
245
245
  }
246
246
  exports.getProgramDefinition = getProgramDefinition;
247
- /**
248
- * Retrieves a program definition by specifying the program definition's external ID and associated namespace.
249
- *
250
- * Use this method when you need to retrieve a program definition without its program definition ID.
251
- */
247
+ /** Retrieves a program definition with the specified external ID and namespace. */
252
248
  function getProgramDefinitionByExternalIdAndNamespace(payload) {
253
249
  function __getProgramDefinitionByExternalIdAndNamespace({ host }) {
254
250
  const metadata = {
@@ -280,13 +276,15 @@ exports.getProgramDefinitionByExternalIdAndNamespace = getProgramDefinitionByExt
280
276
  /**
281
277
  * Creates a query to retrieve a list of program definitions.
282
278
  *
283
- * The `queryProgramDefinitions()` method builds a query to retrieve a list of program definitions and returns a `ProgramDefinitionsQueryBuilder` object.
279
+ * The Query Program Definitions method builds a query to retrieve a list of program definitions and returns a `ProgramDefinitionsQueryBuilder` object.
280
+ *
281
+ * The returned object contains the query definition, which is used to run the query using the `find()` method.
284
282
  *
285
- * 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.
283
+ * 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.
286
284
  *
287
- * 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.
285
+ * Query Program Definitions has a default paging limit of 50, which you can override.
288
286
  *
289
- * 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`.
287
+ * For a full description of the item object, see the object returned for the `items` property in `ProgramDefinitionsQueryResult`.
290
288
  */
291
289
  function queryProgramDefinitions(payload) {
292
290
  function __queryProgramDefinitions({ host }) {
@@ -1 +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"}
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,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"}
@@ -6,7 +6,7 @@ export declare const __metadata: {
6
6
  export declare function createProgramDefinition(httpClient: HttpClient): CreateProgramDefinitionSignature;
7
7
  interface CreateProgramDefinitionSignature {
8
8
  /**
9
- * Creates a new program definition.
9
+ * Creates a program definition.
10
10
  * @param - Program definition to create.
11
11
  * @returns Created program definition.
12
12
  */
@@ -31,7 +31,7 @@ export declare function deleteProgramDefinition(httpClient: HttpClient): DeleteP
31
31
  interface DeleteProgramDefinitionSignature {
32
32
  /**
33
33
  * Deletes a program definition.
34
- * @param - ID of the ProgramDefinition to delete.
34
+ * @param - ID of the program definition to delete.
35
35
  */
36
36
  (programDefinitionId: string, options?: DeleteProgramDefinitionOptions | undefined): Promise<void>;
37
37
  }
@@ -47,10 +47,8 @@ interface GetProgramDefinitionSignature {
47
47
  export declare function getProgramDefinitionByExternalIdAndNamespace(httpClient: HttpClient): GetProgramDefinitionByExternalIdAndNamespaceSignature;
48
48
  interface GetProgramDefinitionByExternalIdAndNamespaceSignature {
49
49
  /**
50
- * Retrieves a program definition by specifying the program definition's external ID and associated namespace.
51
- *
52
- * Use this method when you need to retrieve a program definition without its program definition ID.
53
- * @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.
50
+ * Retrieves a program definition with the specified external ID and namespace.
51
+ * @param - Namespace for your app or site's benefit programs.
54
52
  */
55
53
  (namespace: string, options: GetProgramDefinitionByExternalIdAndNamespaceOptions): Promise<GetProgramDefinitionByExternalIdAndNamespaceResponse>;
56
54
  }
@@ -59,13 +57,15 @@ interface QueryProgramDefinitionsSignature {
59
57
  /**
60
58
  * Creates a query to retrieve a list of program definitions.
61
59
  *
62
- * The `queryProgramDefinitions()` method builds a query to retrieve a list of program definitions and returns a `ProgramDefinitionsQueryBuilder` object.
60
+ * The Query Program Definitions method builds a query to retrieve a list of program definitions and returns a `ProgramDefinitionsQueryBuilder` object.
61
+ *
62
+ * The returned object contains the query definition, which is used to run the query using the `find()` method.
63
63
  *
64
- * 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.
64
+ * 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.
65
65
  *
66
- * 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.
66
+ * Query Program Definitions has a default paging limit of 50, which you can override.
67
67
  *
68
- * 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`.
68
+ * For a full description of the item object, see the object returned for the `items` property in `ProgramDefinitionsQueryResult`.
69
69
  */
70
70
  (): ProgramDefinitionsQueryBuilder;
71
71
  }
@@ -1 +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"}
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;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"}
@@ -1,6 +1,8 @@
1
1
  export interface ProgramDefinition {
2
2
  /**
3
3
  * Program definition ID.
4
+ * @format GUID
5
+ * @immutable
4
6
  * @readonly
5
7
  */
6
8
  id?: string | null;
@@ -22,16 +24,29 @@ export interface ProgramDefinition {
22
24
  * @readonly
23
25
  */
24
26
  updatedDate?: Date | null;
25
- /** Name of the program associated with this program definition. This name will be the same for all programs provisioned from this program definition. */
27
+ /**
28
+ * Program definition name.
29
+ * @maxLength 64
30
+ */
26
31
  displayName?: string | null;
27
- /** 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. */
32
+ /**
33
+ * Namespace for your app or site's benefit programs.
34
+ * @immutable
35
+ * @minLength 1
36
+ * @maxLength 50
37
+ */
28
38
  namespace?: string | null;
29
39
  /**
30
40
  * Custom field data for the program definition object.
41
+ *
31
42
  * [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.
32
43
  */
33
44
  extendedFields?: ExtendedFields;
34
- /** External program definition ID designated by the app owner. */
45
+ /**
46
+ * ID for the program definition defined by you. You can use `externalId` to filter queries.
47
+ * @format GUID
48
+ * @immutable
49
+ */
35
50
  externalId?: string | null;
36
51
  }
37
52
  export interface ExtendedFields {
@@ -54,7 +69,7 @@ export interface CreateProgramDefinitionResponse {
54
69
  programDefinition?: ProgramDefinition;
55
70
  }
56
71
  export interface UpdateProgramDefinitionRequest {
57
- /** Program definition to updated. */
72
+ /** Program definition to update. */
58
73
  programDefinition: ProgramDefinition;
59
74
  }
60
75
  export interface UpdateProgramDefinitionResponse {
@@ -62,40 +77,31 @@ export interface UpdateProgramDefinitionResponse {
62
77
  programDefinition?: ProgramDefinition;
63
78
  }
64
79
  export interface DeleteProgramDefinitionRequest {
65
- /** ID of the ProgramDefinition to delete. */
66
- programDefinitionId: string;
67
80
  /**
68
- * Specifies the timing of ending the active benefit pools associated with this program definition.
69
- * Determines how and when changes are applied to benefit pools.
81
+ * ID of the program definition to delete.
82
+ * @format GUID
70
83
  */
84
+ programDefinitionId: string;
85
+ /** Determines when the changes to this program definition will be applied to associated programs and pools. */
71
86
  cascadeType?: Cascade;
72
87
  }
73
88
  export declare enum Cascade {
74
89
  /** Unknown cascade. */
75
90
  UNKNOWN_CASCADE = "UNKNOWN_CASCADE",
76
- /**
77
- * 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.
78
- *
79
- * Existing programs will be updated in their next renewal cycle.
80
- */
91
+ /** Changes are applied to existing programs and pools when they are next renewed. */
81
92
  NEXT_RENEWAL = "NEXT_RENEWAL",
82
- /**
83
- * Updates the associated benefit pools to reflect the new or modified pool definition immediately.
84
- *
85
- * Existing programs will be updated immediately.
86
- */
93
+ /** Changes are applied to associated programs and pools immediately. */
87
94
  IMMEDIATELY = "IMMEDIATELY",
88
- /**
89
- * Updates the associated benefit pools to reflect the new or modified pool definition the next time the benefit pools are provisioned to a program.
90
- *
91
- * Existing programs will remain unaffected. Only newly purchased programs will display the benefits of this pool definition.
92
- */
95
+ /** Changes are not applied to existing associated programs and pools. They are only applied to future programs and pools. */
93
96
  FUTURE_PROVISIONS = "FUTURE_PROVISIONS"
94
97
  }
95
98
  export interface DeleteProgramDefinitionResponse {
96
99
  }
97
100
  export interface GetProgramDefinitionRequest {
98
- /** ID of the program definition to retrieve. */
101
+ /**
102
+ * ID of the program definition to retrieve.
103
+ * @format GUID
104
+ */
99
105
  programDefinitionId: string;
100
106
  }
101
107
  export interface GetProgramDefinitionResponse {
@@ -103,17 +109,24 @@ export interface GetProgramDefinitionResponse {
103
109
  programDefinition?: ProgramDefinition;
104
110
  }
105
111
  export interface GetProgramDefinitionByExternalIdAndNamespaceRequest {
106
- /** 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. */
112
+ /**
113
+ * Namespace for your app or site's benefit programs.
114
+ * @minLength 1
115
+ * @maxLength 50
116
+ */
107
117
  namespace: string;
108
- /** External program definition ID. */
118
+ /**
119
+ * Program definition external ID.
120
+ * @format GUID
121
+ */
109
122
  externalId: string;
110
123
  }
111
124
  export interface GetProgramDefinitionByExternalIdAndNamespaceResponse {
112
- /** The retrieved program definition. */
125
+ /** Retrieved program definition. */
113
126
  programDefinition?: ProgramDefinition;
114
127
  }
115
128
  export interface QueryProgramDefinitionsRequest {
116
- /** Query to select program definitions. */
129
+ /** Filter, sort, and paging to apply to the query. */
117
130
  query?: CursorQuery;
118
131
  }
119
132
  export interface CursorQuery extends CursorQueryPagingMethodOneOf {
@@ -131,6 +144,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
131
144
  /**
132
145
  * Sort object in the following format:
133
146
  * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
147
+ * @maxSize 5
134
148
  */
135
149
  sort?: Sorting[];
136
150
  }
@@ -140,7 +154,10 @@ export interface CursorQueryPagingMethodOneOf {
140
154
  cursorPaging?: CursorPaging;
141
155
  }
142
156
  export interface Sorting {
143
- /** Name of the field to sort by. */
157
+ /**
158
+ * Name of the field to sort by.
159
+ * @maxLength 512
160
+ */
144
161
  fieldName?: string;
145
162
  /** Sort order. */
146
163
  order?: SortOrder;
@@ -152,18 +169,22 @@ export declare enum SortOrder {
152
169
  DESC = "DESC"
153
170
  }
154
171
  export interface CursorPaging {
155
- /** Maximum number of items to return in the results. */
172
+ /**
173
+ * Maximum number of items to return in the results.
174
+ * @max 100
175
+ */
156
176
  limit?: number | null;
157
177
  /**
158
178
  * Pointer to the next or previous page in the list of results.
159
179
  *
160
180
  * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
161
181
  * Not relevant for the first request.
182
+ * @maxLength 16000
162
183
  */
163
184
  cursor?: string | null;
164
185
  }
165
186
  export interface QueryProgramDefinitionsResponse {
166
- /** List of program definitions. */
187
+ /** List of retrieved program definitions. */
167
188
  programDefinitions?: ProgramDefinition[];
168
189
  /** Metadata for the paginated results. */
169
190
  metadata?: CursorPagingMetadata;
@@ -182,9 +203,15 @@ export interface CursorPagingMetadata {
182
203
  hasNext?: boolean | null;
183
204
  }
184
205
  export interface Cursors {
185
- /** Cursor string pointing to the next page in the list of results. */
206
+ /**
207
+ * Cursor string pointing to the next page in the list of results.
208
+ * @maxLength 16000
209
+ */
186
210
  next?: string | null;
187
- /** Cursor pointing to the previous page in the list of results. */
211
+ /**
212
+ * Cursor pointing to the previous page in the list of results.
213
+ * @maxLength 16000
214
+ */
188
215
  prev?: string | null;
189
216
  }
190
217
  export interface UpsertProgramDefinitionRequest {
@@ -196,9 +223,16 @@ export interface UpsertProgramDefinitionResponse {
196
223
  programDefinition?: ProgramDefinition;
197
224
  }
198
225
  export interface GetOrCreateProgramDefinitionRequest {
199
- /** 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. */
226
+ /**
227
+ * 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.
228
+ * @minLength 1
229
+ * @maxLength 50
230
+ */
200
231
  namespace?: string;
201
- /** External program definition ID. */
232
+ /**
233
+ * External program definition ID.
234
+ * @format GUID
235
+ */
202
236
  externalId?: string;
203
237
  }
204
238
  export interface GetOrCreateProgramDefinitionResponse {
@@ -278,9 +312,15 @@ export interface ActionEvent {
278
312
  bodyAsJson?: string;
279
313
  }
280
314
  export interface MessageEnvelope {
281
- /** App instance ID. */
315
+ /**
316
+ * App instance ID.
317
+ * @format GUID
318
+ */
282
319
  instanceId?: string | null;
283
- /** Event type. */
320
+ /**
321
+ * Event type.
322
+ * @maxLength 150
323
+ */
284
324
  eventType?: string;
285
325
  /** The identification type and identity data. */
286
326
  identity?: IdentificationData;
@@ -288,26 +328,50 @@ export interface MessageEnvelope {
288
328
  data?: string;
289
329
  }
290
330
  export interface IdentificationData extends IdentificationDataIdOneOf {
291
- /** ID of a site visitor that has not logged in to the site. */
331
+ /**
332
+ * ID of a site visitor that has not logged in to the site.
333
+ * @format GUID
334
+ */
292
335
  anonymousVisitorId?: string;
293
- /** ID of a site visitor that has logged in to the site. */
336
+ /**
337
+ * ID of a site visitor that has logged in to the site.
338
+ * @format GUID
339
+ */
294
340
  memberId?: string;
295
- /** ID of a Wix user (site owner, contributor, etc.). */
341
+ /**
342
+ * ID of a Wix user (site owner, contributor, etc.).
343
+ * @format GUID
344
+ */
296
345
  wixUserId?: string;
297
- /** ID of an app. */
346
+ /**
347
+ * ID of an app.
348
+ * @format GUID
349
+ */
298
350
  appId?: string;
299
351
  /** @readonly */
300
352
  identityType?: WebhookIdentityType;
301
353
  }
302
354
  /** @oneof */
303
355
  export interface IdentificationDataIdOneOf {
304
- /** ID of a site visitor that has not logged in to the site. */
356
+ /**
357
+ * ID of a site visitor that has not logged in to the site.
358
+ * @format GUID
359
+ */
305
360
  anonymousVisitorId?: string;
306
- /** ID of a site visitor that has logged in to the site. */
361
+ /**
362
+ * ID of a site visitor that has logged in to the site.
363
+ * @format GUID
364
+ */
307
365
  memberId?: string;
308
- /** ID of a Wix user (site owner, contributor, etc.). */
366
+ /**
367
+ * ID of a Wix user (site owner, contributor, etc.).
368
+ * @format GUID
369
+ */
309
370
  wixUserId?: string;
310
- /** ID of an app. */
371
+ /**
372
+ * ID of an app.
373
+ * @format GUID
374
+ */
311
375
  appId?: string;
312
376
  }
313
377
  export declare enum WebhookIdentityType {
@@ -5,23 +5,11 @@ var Cascade;
5
5
  (function (Cascade) {
6
6
  /** Unknown cascade. */
7
7
  Cascade["UNKNOWN_CASCADE"] = "UNKNOWN_CASCADE";
8
- /**
9
- * 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.
10
- *
11
- * Existing programs will be updated in their next renewal cycle.
12
- */
8
+ /** Changes are applied to existing programs and pools when they are next renewed. */
13
9
  Cascade["NEXT_RENEWAL"] = "NEXT_RENEWAL";
14
- /**
15
- * Updates the associated benefit pools to reflect the new or modified pool definition immediately.
16
- *
17
- * Existing programs will be updated immediately.
18
- */
10
+ /** Changes are applied to associated programs and pools immediately. */
19
11
  Cascade["IMMEDIATELY"] = "IMMEDIATELY";
20
- /**
21
- * Updates the associated benefit pools to reflect the new or modified pool definition the next time the benefit pools are provisioned to a program.
22
- *
23
- * Existing programs will remain unaffected. Only newly purchased programs will display the benefits of this pool definition.
24
- */
12
+ /** Changes are not applied to existing associated programs and pools. They are only applied to future programs and pools. */
25
13
  Cascade["FUTURE_PROVISIONS"] = "FUTURE_PROVISIONS";
26
14
  })(Cascade || (exports.Cascade = Cascade = {}));
27
15
  var SortOrder;
@@ -1 +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":";;;AA+EA,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;AA+DD,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,4BAA4B;IAC5B,wBAAW,CAAA;IACX,6BAA6B;IAC7B,0BAAa,CAAA;AACf,CAAC,EALW,SAAS,yBAAT,SAAS,QAKpB;AAmLD,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"}
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":";;;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"}