@wix/auto_sdk_benefit-programs_program-definitions 1.0.2 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.http.d.ts +8 -10
- package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.http.js +8 -10
- package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.http.js.map +1 -1
- package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.public.d.ts +10 -10
- package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.public.js.map +1 -1
- package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.types.d.ts +15 -29
- package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.types.js +3 -15
- package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.types.js.map +1 -1
- package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.universal.d.ts +31 -47
- package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.universal.js +13 -25
- package/build/cjs/src/benefit-programs-v1-program-definition-program-definitions.universal.js.map +1 -1
- package/build/es/src/benefit-programs-v1-program-definition-program-definitions.http.d.ts +8 -10
- package/build/es/src/benefit-programs-v1-program-definition-program-definitions.http.js +8 -10
- package/build/es/src/benefit-programs-v1-program-definition-program-definitions.http.js.map +1 -1
- package/build/es/src/benefit-programs-v1-program-definition-program-definitions.public.d.ts +10 -10
- package/build/es/src/benefit-programs-v1-program-definition-program-definitions.public.js.map +1 -1
- package/build/es/src/benefit-programs-v1-program-definition-program-definitions.types.d.ts +15 -29
- package/build/es/src/benefit-programs-v1-program-definition-program-definitions.types.js +3 -15
- package/build/es/src/benefit-programs-v1-program-definition-program-definitions.types.js.map +1 -1
- package/build/es/src/benefit-programs-v1-program-definition-program-definitions.universal.d.ts +31 -47
- package/build/es/src/benefit-programs-v1-program-definition-program-definitions.universal.js +13 -25
- package/build/es/src/benefit-programs-v1-program-definition-program-definitions.universal.js.map +1 -1
- package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.http.d.ts +8 -10
- package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.http.js +8 -10
- package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.http.js.map +1 -1
- package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.public.d.ts +10 -10
- package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.public.js.map +1 -1
- package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.types.d.ts +15 -29
- package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.types.js +3 -15
- package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.types.js.map +1 -1
- package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.universal.d.ts +31 -47
- package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.universal.js +13 -25
- package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.universal.js.map +1 -1
- package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.http.d.ts +8 -10
- package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.http.js +8 -10
- package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.http.js.map +1 -1
- package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.public.d.ts +10 -10
- package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.public.js.map +1 -1
- package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.types.d.ts +15 -29
- package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.types.js +3 -15
- package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.types.js.map +1 -1
- package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.universal.d.ts +31 -47
- package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.universal.js +13 -25
- package/build/internal/es/src/benefit-programs-v1-program-definition-program-definitions.universal.js.map +1 -1
- package/package.json +2 -2
package/build/es/src/benefit-programs-v1-program-definition-program-definitions.universal.js
CHANGED
|
@@ -6,23 +6,11 @@ export var Cascade;
|
|
|
6
6
|
(function (Cascade) {
|
|
7
7
|
/** Unknown cascade. */
|
|
8
8
|
Cascade["UNKNOWN_CASCADE"] = "UNKNOWN_CASCADE";
|
|
9
|
-
/**
|
|
10
|
-
* 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.
|
|
11
|
-
*
|
|
12
|
-
* Existing programs will be updated in their next renewal cycle.
|
|
13
|
-
*/
|
|
9
|
+
/** Changes are applied to existing programs and pools when they are next renewed. */
|
|
14
10
|
Cascade["NEXT_RENEWAL"] = "NEXT_RENEWAL";
|
|
15
|
-
/**
|
|
16
|
-
* Updates the associated benefit pools to reflect the new or modified pool definition immediately.
|
|
17
|
-
*
|
|
18
|
-
* Existing programs will be updated immediately.
|
|
19
|
-
*/
|
|
11
|
+
/** Changes are applied to associated programs and pools immediately. */
|
|
20
12
|
Cascade["IMMEDIATELY"] = "IMMEDIATELY";
|
|
21
|
-
/**
|
|
22
|
-
* Updates the associated benefit pools to reflect the new or modified pool definition the next time the benefit pools are provisioned to a program.
|
|
23
|
-
*
|
|
24
|
-
* Existing programs will remain unaffected. Only newly purchased programs will display the benefits of this pool definition.
|
|
25
|
-
*/
|
|
13
|
+
/** Changes are not applied to existing associated programs and pools. They are only applied to future programs and pools. */
|
|
26
14
|
Cascade["FUTURE_PROVISIONS"] = "FUTURE_PROVISIONS";
|
|
27
15
|
})(Cascade || (Cascade = {}));
|
|
28
16
|
export var SortOrder;
|
|
@@ -41,7 +29,7 @@ export var WebhookIdentityType;
|
|
|
41
29
|
WebhookIdentityType["APP"] = "APP";
|
|
42
30
|
})(WebhookIdentityType || (WebhookIdentityType = {}));
|
|
43
31
|
/**
|
|
44
|
-
* Creates a
|
|
32
|
+
* Creates a program definition.
|
|
45
33
|
* @param programDefinition - Program definition to create.
|
|
46
34
|
* @public
|
|
47
35
|
* @documentationMaturity preview
|
|
@@ -126,7 +114,7 @@ export async function updateProgramDefinition(_id, programDefinition) {
|
|
|
126
114
|
}
|
|
127
115
|
/**
|
|
128
116
|
* Deletes a program definition.
|
|
129
|
-
* @param programDefinitionId - ID of the
|
|
117
|
+
* @param programDefinitionId - ID of the program definition to delete.
|
|
130
118
|
* @public
|
|
131
119
|
* @documentationMaturity preview
|
|
132
120
|
* @requiredField programDefinitionId
|
|
@@ -205,10 +193,8 @@ export async function getProgramDefinition(programDefinitionId) {
|
|
|
205
193
|
}
|
|
206
194
|
}
|
|
207
195
|
/**
|
|
208
|
-
* Retrieves a program definition
|
|
209
|
-
*
|
|
210
|
-
* Use this method when you need to retrieve a program definition without its program definition ID.
|
|
211
|
-
* @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.
|
|
196
|
+
* Retrieves a program definition with the specified external ID and namespace.
|
|
197
|
+
* @param namespace - Namespace for your app or site's benefit programs.
|
|
212
198
|
* @public
|
|
213
199
|
* @documentationMaturity preview
|
|
214
200
|
* @requiredField namespace
|
|
@@ -255,13 +241,15 @@ export async function getProgramDefinitionByExternalIdAndNamespace(namespace, op
|
|
|
255
241
|
/**
|
|
256
242
|
* Creates a query to retrieve a list of program definitions.
|
|
257
243
|
*
|
|
258
|
-
* The
|
|
244
|
+
* The Query Program Definitions method builds a query to retrieve a list of program definitions and returns a `ProgramDefinitionsQueryBuilder` object.
|
|
245
|
+
*
|
|
246
|
+
* The returned object contains the query definition, which is used to run the query using the `find()` method.
|
|
259
247
|
*
|
|
260
|
-
*
|
|
248
|
+
* 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.
|
|
261
249
|
*
|
|
262
|
-
*
|
|
250
|
+
* Query Program Definitions has a default paging limit of 50, which you can override.
|
|
263
251
|
*
|
|
264
|
-
*
|
|
252
|
+
* For a full description of the item object, see the object returned for the `items` property in `ProgramDefinitionsQueryResult`.
|
|
265
253
|
* @public
|
|
266
254
|
* @documentationMaturity preview
|
|
267
255
|
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
package/build/es/src/benefit-programs-v1-program-definition-program-definitions.universal.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"benefit-programs-v1-program-definition-program-definitions.universal.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-program-definition-program-definitions.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAC9D,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,+CAA+C,MAAM,sEAAsE,CAAC;
|
|
1
|
+
{"version":3,"file":"benefit-programs-v1-program-definition-program-definitions.universal.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-program-definition-program-definitions.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAC9D,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,+CAA+C,MAAM,sEAAsE,CAAC;AAiGxI,MAAM,CAAN,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,KAAP,OAAO,QASlB;AA6ED,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,4BAA4B;IAC5B,wBAAW,CAAA;IACX,6BAA6B;IAC7B,0BAAa,CAAA;AACf,CAAC,EALW,SAAS,KAAT,SAAS,QAKpB;AAgOD,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC3C,iBAAoC;IAEpC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,iBAAiB,EAAE,iBAAiB;KACrC,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,+CAA+C,CAAC,uBAAuB,CACrE,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAC;YACzD,EAAE,iBAAkB,CAAC;IACzB,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,iBAAiB,EAAE,MAAM,EAAE;YACvD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,mBAAmB,CAAC,CACtB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC3C,GAAkB,EAClB,iBAA0C;IAE1C,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,iBAAiB,EAAE,EAAE,GAAG,iBAAiB,EAAE,EAAE,EAAE,GAAG,EAAE;KACrD,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,+CAA+C,CAAC,uBAAuB,CACrE,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAC;YACzD,EAAE,iBAAkB,CAAC;IACzB,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE,iBAAiB,EAAE,MAAM,EAAE;YACrD,wBAAwB,EAAE,EAAE,sBAAsB,EAAE,MAAM,EAAE;YAC5D,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,KAAK,EAAE,mBAAmB,CAAC,CAC7B,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAsDD;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC3C,mBAA2B,EAC3B,OAAwC;IAExC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,mBAAmB,EAAE,mBAAmB;QACxC,WAAW,EAAE,OAAO,EAAE,WAAW;KAClC,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,+CAA+C,CAAC,uBAAuB,CACrE,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE;gBACxB,mBAAmB,EAAE,MAAM;gBAC3B,WAAW,EAAE,kBAAkB;aAChC;YACD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,qBAAqB,EAAE,SAAS,CAAC,CACnC,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAOD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,mBAA2B;IAE3B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,mBAAmB,EAAE,mBAAmB;KACzC,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,+CAA+C,CAAC,oBAAoB,CAClE,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAC;YACzD,EAAE,iBAAkB,CAAC;IACzB,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,mBAAmB,EAAE,MAAM,EAAE;YACzD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,qBAAqB,CAAC,CACxB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,KAAK,UAAU,4CAA4C,CAChE,SAAiB,EACjB,OAA4D;IAE5D,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,SAAS,EAAE,SAAS;QACpB,UAAU,EAAE,OAAO,EAAE,UAAU;KAChC,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,+CAA+C,CAAC,4CAA4C,CAC1F,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE;gBACxB,SAAS,EAAE,MAAM;gBACjB,UAAU,EAAE,iBAAiB;aAC9B;YACD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,WAAW,EAAE,SAAS,CAAC,CACzB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAUD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,uBAAuB;IACrC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,OAAO,YAAY,CAKjB;QACA,IAAI,EAAE,KAAK,EAAE,OAAuC,EAAE,EAAE;YACtD,MAAM,OAAO,GACX,+CAA+C,CAAC,uBAAuB,CACrE,OAAO,CACR,CAAC;YAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;YAC5B,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;gBACjC,OAAO,MAAM,CAAC;YAChB,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;gBAC5B,MAAM,GAAG,CAAC;YACZ,CAAC;QACH,CAAC;QACD,kBAAkB,EAAE,CAAC,KAA8C,EAAE,EAAE;YACrE,MAAM,IAAI,GAAG,CAAC,KAAK,EAAE,EAAE,CAAkD,CAAC;YAC1E,OAAO,qCAAqC,CAAC;gBAC3C,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC;gBACZ,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;aACjB,CAAC,CAAC;QACL,CAAC;QACD,mBAAmB,EAAE,CAAC,EACpB,IAAI,GAC0C,EAAE,EAAE;YAClD,MAAM,eAAe,GAAG,uCAAuC,CAAC,IAAI,CAAC,CAAC;YAEtE,OAAO;gBACL,KAAK,EAAE,eAAe,EAAE,kBAAkB;gBAC1C,cAAc,EAAE,eAAe,EAAE,QAAQ;aAC1C,CAAC;QACJ,CAAC;QACD,gBAAgB,EAAE,CAAC,GAAY,EAAE,EAAE;YACjC,MAAM,gBAAgB,GAAG,iBAAiB,CAAC,GAAG,EAAE;gBAC9C,sBAAsB,EAAE,EAAE;gBAC1B,wBAAwB,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE;gBAC3C,uBAAuB,EAAE,KAAK;aAC/B,CAAC,CAAC;YAEH,MAAM,gBAAgB,CAAC;QACzB,CAAC;QACD,YAAY,EAAE,QAAQ;QACtB,mBAAmB,EAAE,EAAE;KACxB,CAAC,CAAC;AACL,CAAC"}
|
package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.http.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { RequestOptionsFactory } from '@wix/sdk-types';
|
|
2
|
-
/** Creates a
|
|
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
|
|
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
|
-
*
|
|
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
|
-
*
|
|
29
|
+
* Query Program Definitions has a default paging limit of 50, which you can override.
|
|
32
30
|
*
|
|
33
|
-
*
|
|
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>;
|
package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.http.js
CHANGED
|
@@ -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
|
|
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
|
|
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
|
-
*
|
|
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
|
-
*
|
|
285
|
+
* Query Program Definitions has a default paging limit of 50, which you can override.
|
|
288
286
|
*
|
|
289
|
-
*
|
|
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,
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
-
*
|
|
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
|
-
*
|
|
66
|
+
* Query Program Definitions has a default paging limit of 50, which you can override.
|
|
67
67
|
*
|
|
68
|
-
*
|
|
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;
|
|
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"}
|
package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.types.d.ts
CHANGED
|
@@ -25,12 +25,12 @@ export interface ProgramDefinition {
|
|
|
25
25
|
*/
|
|
26
26
|
updatedDate?: Date | null;
|
|
27
27
|
/**
|
|
28
|
-
*
|
|
28
|
+
* Program definition name.
|
|
29
29
|
* @maxLength 64
|
|
30
30
|
*/
|
|
31
31
|
displayName?: string | null;
|
|
32
32
|
/**
|
|
33
|
-
*
|
|
33
|
+
* Namespace for your app or site's benefit programs.
|
|
34
34
|
* @immutable
|
|
35
35
|
* @minLength 1
|
|
36
36
|
* @maxLength 50
|
|
@@ -38,11 +38,12 @@ export interface ProgramDefinition {
|
|
|
38
38
|
namespace?: string | null;
|
|
39
39
|
/**
|
|
40
40
|
* Custom field data for the program definition object.
|
|
41
|
+
*
|
|
41
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.
|
|
42
43
|
*/
|
|
43
44
|
extendedFields?: ExtendedFields;
|
|
44
45
|
/**
|
|
45
|
-
*
|
|
46
|
+
* ID for the program definition defined by you. You can use `externalId` to filter queries.
|
|
46
47
|
* @format GUID
|
|
47
48
|
* @immutable
|
|
48
49
|
*/
|
|
@@ -68,7 +69,7 @@ export interface CreateProgramDefinitionResponse {
|
|
|
68
69
|
programDefinition?: ProgramDefinition;
|
|
69
70
|
}
|
|
70
71
|
export interface UpdateProgramDefinitionRequest {
|
|
71
|
-
/** Program definition to
|
|
72
|
+
/** Program definition to update. */
|
|
72
73
|
programDefinition: ProgramDefinition;
|
|
73
74
|
}
|
|
74
75
|
export interface UpdateProgramDefinitionResponse {
|
|
@@ -77,36 +78,21 @@ export interface UpdateProgramDefinitionResponse {
|
|
|
77
78
|
}
|
|
78
79
|
export interface DeleteProgramDefinitionRequest {
|
|
79
80
|
/**
|
|
80
|
-
* ID of the
|
|
81
|
+
* ID of the program definition to delete.
|
|
81
82
|
* @format GUID
|
|
82
83
|
*/
|
|
83
84
|
programDefinitionId: string;
|
|
84
|
-
/**
|
|
85
|
-
* Specifies the timing of ending the active benefit pools associated with this program definition.
|
|
86
|
-
* Determines how and when changes are applied to benefit pools.
|
|
87
|
-
*/
|
|
85
|
+
/** Determines when the changes to this program definition will be applied to associated programs and pools. */
|
|
88
86
|
cascadeType?: Cascade;
|
|
89
87
|
}
|
|
90
88
|
export declare enum Cascade {
|
|
91
89
|
/** Unknown cascade. */
|
|
92
90
|
UNKNOWN_CASCADE = "UNKNOWN_CASCADE",
|
|
93
|
-
/**
|
|
94
|
-
* 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.
|
|
95
|
-
*
|
|
96
|
-
* Existing programs will be updated in their next renewal cycle.
|
|
97
|
-
*/
|
|
91
|
+
/** Changes are applied to existing programs and pools when they are next renewed. */
|
|
98
92
|
NEXT_RENEWAL = "NEXT_RENEWAL",
|
|
99
|
-
/**
|
|
100
|
-
* Updates the associated benefit pools to reflect the new or modified pool definition immediately.
|
|
101
|
-
*
|
|
102
|
-
* Existing programs will be updated immediately.
|
|
103
|
-
*/
|
|
93
|
+
/** Changes are applied to associated programs and pools immediately. */
|
|
104
94
|
IMMEDIATELY = "IMMEDIATELY",
|
|
105
|
-
/**
|
|
106
|
-
* Updates the associated benefit pools to reflect the new or modified pool definition the next time the benefit pools are provisioned to a program.
|
|
107
|
-
*
|
|
108
|
-
* Existing programs will remain unaffected. Only newly purchased programs will display the benefits of this pool definition.
|
|
109
|
-
*/
|
|
95
|
+
/** Changes are not applied to existing associated programs and pools. They are only applied to future programs and pools. */
|
|
110
96
|
FUTURE_PROVISIONS = "FUTURE_PROVISIONS"
|
|
111
97
|
}
|
|
112
98
|
export interface DeleteProgramDefinitionResponse {
|
|
@@ -124,23 +110,23 @@ export interface GetProgramDefinitionResponse {
|
|
|
124
110
|
}
|
|
125
111
|
export interface GetProgramDefinitionByExternalIdAndNamespaceRequest {
|
|
126
112
|
/**
|
|
127
|
-
*
|
|
113
|
+
* Namespace for your app or site's benefit programs.
|
|
128
114
|
* @minLength 1
|
|
129
115
|
* @maxLength 50
|
|
130
116
|
*/
|
|
131
117
|
namespace: string;
|
|
132
118
|
/**
|
|
133
|
-
*
|
|
119
|
+
* Program definition external ID.
|
|
134
120
|
* @format GUID
|
|
135
121
|
*/
|
|
136
122
|
externalId: string;
|
|
137
123
|
}
|
|
138
124
|
export interface GetProgramDefinitionByExternalIdAndNamespaceResponse {
|
|
139
|
-
/**
|
|
125
|
+
/** Retrieved program definition. */
|
|
140
126
|
programDefinition?: ProgramDefinition;
|
|
141
127
|
}
|
|
142
128
|
export interface QueryProgramDefinitionsRequest {
|
|
143
|
-
/**
|
|
129
|
+
/** Filter, sort, and paging to apply to the query. */
|
|
144
130
|
query?: CursorQuery;
|
|
145
131
|
}
|
|
146
132
|
export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
@@ -198,7 +184,7 @@ export interface CursorPaging {
|
|
|
198
184
|
cursor?: string | null;
|
|
199
185
|
}
|
|
200
186
|
export interface QueryProgramDefinitionsResponse {
|
|
201
|
-
/** List of program definitions. */
|
|
187
|
+
/** List of retrieved program definitions. */
|
|
202
188
|
programDefinitions?: ProgramDefinition[];
|
|
203
189
|
/** Metadata for the paginated results. */
|
|
204
190
|
metadata?: CursorPagingMetadata;
|
package/build/internal/cjs/src/benefit-programs-v1-program-definition-program-definitions.types.js
CHANGED
|
@@ -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":";;;
|
|
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"}
|