@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,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 {
@@ -276,9 +310,15 @@ export interface ActionEvent {
276
310
  body?: string;
277
311
  }
278
312
  export interface MessageEnvelope {
279
- /** App instance ID. */
313
+ /**
314
+ * App instance ID.
315
+ * @format GUID
316
+ */
280
317
  instanceId?: string | null;
281
- /** Event type. */
318
+ /**
319
+ * Event type.
320
+ * @maxLength 150
321
+ */
282
322
  eventType?: string;
283
323
  /** The identification type and identity data. */
284
324
  identity?: IdentificationData;
@@ -286,26 +326,50 @@ export interface MessageEnvelope {
286
326
  data?: string;
287
327
  }
288
328
  export interface IdentificationData extends IdentificationDataIdOneOf {
289
- /** ID of a site visitor that has not logged in to the site. */
329
+ /**
330
+ * ID of a site visitor that has not logged in to the site.
331
+ * @format GUID
332
+ */
290
333
  anonymousVisitorId?: string;
291
- /** ID of a site visitor that has logged in to the site. */
334
+ /**
335
+ * ID of a site visitor that has logged in to the site.
336
+ * @format GUID
337
+ */
292
338
  memberId?: string;
293
- /** ID of a Wix user (site owner, contributor, etc.). */
339
+ /**
340
+ * ID of a Wix user (site owner, contributor, etc.).
341
+ * @format GUID
342
+ */
294
343
  wixUserId?: string;
295
- /** ID of an app. */
344
+ /**
345
+ * ID of an app.
346
+ * @format GUID
347
+ */
296
348
  appId?: string;
297
349
  /** @readonly */
298
350
  identityType?: WebhookIdentityType;
299
351
  }
300
352
  /** @oneof */
301
353
  export interface IdentificationDataIdOneOf {
302
- /** ID of a site visitor that has not logged in to the site. */
354
+ /**
355
+ * ID of a site visitor that has not logged in to the site.
356
+ * @format GUID
357
+ */
303
358
  anonymousVisitorId?: string;
304
- /** ID of a site visitor that has logged in to the site. */
359
+ /**
360
+ * ID of a site visitor that has logged in to the site.
361
+ * @format GUID
362
+ */
305
363
  memberId?: string;
306
- /** ID of a Wix user (site owner, contributor, etc.). */
364
+ /**
365
+ * ID of a Wix user (site owner, contributor, etc.).
366
+ * @format GUID
367
+ */
307
368
  wixUserId?: string;
308
- /** ID of an app. */
369
+ /**
370
+ * ID of an app.
371
+ * @format GUID
372
+ */
309
373
  appId?: string;
310
374
  }
311
375
  export declare enum WebhookIdentityType {
@@ -316,7 +380,7 @@ export declare enum WebhookIdentityType {
316
380
  APP = "APP"
317
381
  }
318
382
  /**
319
- * Creates a new program definition.
383
+ * Creates a program definition.
320
384
  * @param programDefinition - Program definition to create.
321
385
  * @public
322
386
  * @documentationMaturity preview
@@ -356,6 +420,8 @@ export declare function updateProgramDefinition(_id: string | null, programDefin
356
420
  export interface UpdateProgramDefinition {
357
421
  /**
358
422
  * Program definition ID.
423
+ * @format GUID
424
+ * @immutable
359
425
  * @readonly
360
426
  */
361
427
  _id?: string | null;
@@ -377,21 +443,34 @@ export interface UpdateProgramDefinition {
377
443
  * @readonly
378
444
  */
379
445
  _updatedDate?: Date | null;
380
- /** Name of the program associated with this program definition. This name will be the same for all programs provisioned from this program definition. */
446
+ /**
447
+ * Program definition name.
448
+ * @maxLength 64
449
+ */
381
450
  displayName?: string | null;
382
- /** 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. */
451
+ /**
452
+ * Namespace for your app or site's benefit programs.
453
+ * @immutable
454
+ * @minLength 1
455
+ * @maxLength 50
456
+ */
383
457
  namespace?: string | null;
384
458
  /**
385
459
  * Custom field data for the program definition object.
460
+ *
386
461
  * [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.
387
462
  */
388
463
  extendedFields?: ExtendedFields;
389
- /** External program definition ID designated by the app owner. */
464
+ /**
465
+ * ID for the program definition defined by you. You can use `externalId` to filter queries.
466
+ * @format GUID
467
+ * @immutable
468
+ */
390
469
  externalId?: string | null;
391
470
  }
392
471
  /**
393
472
  * Deletes a program definition.
394
- * @param programDefinitionId - ID of the ProgramDefinition to delete.
473
+ * @param programDefinitionId - ID of the program definition to delete.
395
474
  * @public
396
475
  * @documentationMaturity preview
397
476
  * @requiredField programDefinitionId
@@ -403,10 +482,7 @@ export interface UpdateProgramDefinition {
403
482
  */
404
483
  export declare function deleteProgramDefinition(programDefinitionId: string, options?: DeleteProgramDefinitionOptions): Promise<void>;
405
484
  export interface DeleteProgramDefinitionOptions {
406
- /**
407
- * Specifies the timing of ending the active benefit pools associated with this program definition.
408
- * Determines how and when changes are applied to benefit pools.
409
- */
485
+ /** Determines when the changes to this program definition will be applied to associated programs and pools. */
410
486
  cascadeType?: Cascade;
411
487
  }
412
488
  /**
@@ -420,6 +496,8 @@ export interface DeleteProgramDefinitionOptions {
420
496
  * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
421
497
  * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
422
498
  * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
499
+ * @permissionScope Manage Events
500
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
423
501
  * @applicableIdentity APP
424
502
  * @applicableIdentity VISITOR
425
503
  * @returns Retrieved program definition.
@@ -427,10 +505,8 @@ export interface DeleteProgramDefinitionOptions {
427
505
  */
428
506
  export declare function getProgramDefinition(programDefinitionId: string): Promise<ProgramDefinition>;
429
507
  /**
430
- * Retrieves a program definition by specifying the program definition's external ID and associated namespace.
431
- *
432
- * Use this method when you need to retrieve a program definition without its program definition ID.
433
- * @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.
508
+ * Retrieves a program definition with the specified external ID and namespace.
509
+ * @param namespace - Namespace for your app or site's benefit programs.
434
510
  * @public
435
511
  * @documentationMaturity preview
436
512
  * @requiredField namespace
@@ -441,31 +517,40 @@ export declare function getProgramDefinition(programDefinitionId: string): Promi
441
517
  * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
442
518
  * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
443
519
  * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
520
+ * @permissionScope Manage Events
521
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
444
522
  * @applicableIdentity APP
445
523
  * @applicableIdentity VISITOR
446
524
  * @fqn wix.benefit_programs.v1.program_definition.ProgramDefinitionService.GetProgramDefinitionByExternalIdAndNamespace
447
525
  */
448
526
  export declare function getProgramDefinitionByExternalIdAndNamespace(namespace: string, options: GetProgramDefinitionByExternalIdAndNamespaceOptions): Promise<GetProgramDefinitionByExternalIdAndNamespaceResponse>;
449
527
  export interface GetProgramDefinitionByExternalIdAndNamespaceOptions {
450
- /** External program definition ID. */
528
+ /**
529
+ * Program definition external ID.
530
+ * @format GUID
531
+ */
451
532
  externalId: string;
452
533
  }
453
534
  /**
454
535
  * Creates a query to retrieve a list of program definitions.
455
536
  *
456
- * The `queryProgramDefinitions()` method builds a query to retrieve a list of program definitions and returns a `ProgramDefinitionsQueryBuilder` object.
537
+ * The Query Program Definitions method builds a query to retrieve a list of program definitions and returns a `ProgramDefinitionsQueryBuilder` object.
538
+ *
539
+ * The returned object contains the query definition, which is used to run the query using the `find()` method.
457
540
  *
458
- * 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.
541
+ * 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.
459
542
  *
460
- * 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.
543
+ * Query Program Definitions has a default paging limit of 50, which you can override.
461
544
  *
462
- * 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`.
545
+ * For a full description of the item object, see the object returned for the `items` property in `ProgramDefinitionsQueryResult`.
463
546
  * @public
464
547
  * @documentationMaturity preview
465
548
  * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
466
549
  * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
467
550
  * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
468
551
  * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
552
+ * @permissionScope Manage Events
553
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
469
554
  * @permissionId BENEFIT_PROGRAMS.PROGRAM_DEFINITION_READ
470
555
  * @applicableIdentity APP
471
556
  * @applicableIdentity VISITOR
@@ -32,23 +32,11 @@ var Cascade;
32
32
  (function (Cascade) {
33
33
  /** Unknown cascade. */
34
34
  Cascade["UNKNOWN_CASCADE"] = "UNKNOWN_CASCADE";
35
- /**
36
- * 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.
37
- *
38
- * Existing programs will be updated in their next renewal cycle.
39
- */
35
+ /** Changes are applied to existing programs and pools when they are next renewed. */
40
36
  Cascade["NEXT_RENEWAL"] = "NEXT_RENEWAL";
41
- /**
42
- * Updates the associated benefit pools to reflect the new or modified pool definition immediately.
43
- *
44
- * Existing programs will be updated immediately.
45
- */
37
+ /** Changes are applied to associated programs and pools immediately. */
46
38
  Cascade["IMMEDIATELY"] = "IMMEDIATELY";
47
- /**
48
- * Updates the associated benefit pools to reflect the new or modified pool definition the next time the benefit pools are provisioned to a program.
49
- *
50
- * Existing programs will remain unaffected. Only newly purchased programs will display the benefits of this pool definition.
51
- */
39
+ /** Changes are not applied to existing associated programs and pools. They are only applied to future programs and pools. */
52
40
  Cascade["FUTURE_PROVISIONS"] = "FUTURE_PROVISIONS";
53
41
  })(Cascade || (exports.Cascade = Cascade = {}));
54
42
  var SortOrder;
@@ -67,7 +55,7 @@ var WebhookIdentityType;
67
55
  WebhookIdentityType["APP"] = "APP";
68
56
  })(WebhookIdentityType || (exports.WebhookIdentityType = WebhookIdentityType = {}));
69
57
  /**
70
- * Creates a new program definition.
58
+ * Creates a program definition.
71
59
  * @param programDefinition - Program definition to create.
72
60
  * @public
73
61
  * @documentationMaturity preview
@@ -154,7 +142,7 @@ async function updateProgramDefinition(_id, programDefinition) {
154
142
  exports.updateProgramDefinition = updateProgramDefinition;
155
143
  /**
156
144
  * Deletes a program definition.
157
- * @param programDefinitionId - ID of the ProgramDefinition to delete.
145
+ * @param programDefinitionId - ID of the program definition to delete.
158
146
  * @public
159
147
  * @documentationMaturity preview
160
148
  * @requiredField programDefinitionId
@@ -202,6 +190,8 @@ exports.deleteProgramDefinition = deleteProgramDefinition;
202
190
  * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
203
191
  * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
204
192
  * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
193
+ * @permissionScope Manage Events
194
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
205
195
  * @applicableIdentity APP
206
196
  * @applicableIdentity VISITOR
207
197
  * @returns Retrieved program definition.
@@ -233,10 +223,8 @@ async function getProgramDefinition(programDefinitionId) {
233
223
  }
234
224
  exports.getProgramDefinition = getProgramDefinition;
235
225
  /**
236
- * Retrieves a program definition by specifying the program definition's external ID and associated namespace.
237
- *
238
- * Use this method when you need to retrieve a program definition without its program definition ID.
239
- * @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.
226
+ * Retrieves a program definition with the specified external ID and namespace.
227
+ * @param namespace - Namespace for your app or site's benefit programs.
240
228
  * @public
241
229
  * @documentationMaturity preview
242
230
  * @requiredField namespace
@@ -247,6 +235,8 @@ exports.getProgramDefinition = getProgramDefinition;
247
235
  * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
248
236
  * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
249
237
  * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
238
+ * @permissionScope Manage Events
239
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
250
240
  * @applicableIdentity APP
251
241
  * @applicableIdentity VISITOR
252
242
  * @fqn wix.benefit_programs.v1.program_definition.ProgramDefinitionService.GetProgramDefinitionByExternalIdAndNamespace
@@ -282,19 +272,23 @@ exports.getProgramDefinitionByExternalIdAndNamespace = getProgramDefinitionByExt
282
272
  /**
283
273
  * Creates a query to retrieve a list of program definitions.
284
274
  *
285
- * The `queryProgramDefinitions()` method builds a query to retrieve a list of program definitions and returns a `ProgramDefinitionsQueryBuilder` object.
275
+ * The Query Program Definitions method builds a query to retrieve a list of program definitions and returns a `ProgramDefinitionsQueryBuilder` object.
276
+ *
277
+ * The returned object contains the query definition, which is used to run the query using the `find()` method.
286
278
  *
287
- * 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.
279
+ * 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.
288
280
  *
289
- * 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.
281
+ * Query Program Definitions has a default paging limit of 50, which you can override.
290
282
  *
291
- * 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`.
283
+ * For a full description of the item object, see the object returned for the `items` property in `ProgramDefinitionsQueryResult`.
292
284
  * @public
293
285
  * @documentationMaturity preview
294
286
  * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
295
287
  * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
296
288
  * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
297
289
  * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
290
+ * @permissionScope Manage Events
291
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
298
292
  * @permissionId BENEFIT_PROGRAMS.PROGRAM_DEFINITION_READ
299
293
  * @applicableIdentity APP
300
294
  * @applicableIdentity VISITOR
@@ -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,sEAAuF;AACvF,kEAA8D;AAC9D,oFAGiD;AAEjD,sJAAwI;AAkFxI,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;AAiLD,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;AAED;;;;;;;;;;;;;;GAcG;AACI,KAAK,UAAU,uBAAuB,CAC3C,iBAAoC;IAEpC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;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,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAC;YACzD,EAAE,iBAAkB,CAAC;IACzB,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,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;AAvCD,0DAuCC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACI,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,IAAA,8DAAqC,EAAC;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,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAC;YACzD,EAAE,iBAAkB,CAAC;IACzB,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,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;AAxCD,0DAwCC;AAuCD;;;;;;;;;;;GAWG;AACI,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,IAAA,8DAAqC,EAAC;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,IAAA,gCAAiB,EACxC,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;AAzCD,0DAyCC;AAUD;;;;;;;;;;;;;;;GAeG;AACI,KAAK,UAAU,oBAAoB,CACxC,mBAA2B;IAE3B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;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,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAC;YACzD,EAAE,iBAAkB,CAAC;IACzB,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,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;AAvCD,oDAuCC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACI,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,IAAA,8DAAqC,EAAC;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,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,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;AA3CD,oGA2CC;AAOD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAgB,uBAAuB;IACrC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,OAAO,IAAA,4BAAY,EAKjB;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,IAAA,8DAAqC,EAAC;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,IAAA,gEAAuC,EAAC,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,IAAA,gCAAiB,EAAC,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;AA1DD,0DA0DC"}
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,sEAAuF;AACvF,kEAA8D;AAC9D,oFAGiD;AAEjD,sJAAwI;AAiGxI,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;AAgOD,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;AAED;;;;;;;;;;;;;;GAcG;AACI,KAAK,UAAU,uBAAuB,CAC3C,iBAAoC;IAEpC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;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,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAC;YACzD,EAAE,iBAAkB,CAAC;IACzB,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,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;AAvCD,0DAuCC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACI,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,IAAA,8DAAqC,EAAC;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,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAC;YACzD,EAAE,iBAAkB,CAAC;IACzB,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,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;AAxCD,0DAwCC;AAsDD;;;;;;;;;;;GAWG;AACI,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,IAAA,8DAAqC,EAAC;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,IAAA,gCAAiB,EACxC,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;AAzCD,0DAyCC;AAOD;;;;;;;;;;;;;;;;;GAiBG;AACI,KAAK,UAAU,oBAAoB,CACxC,mBAA2B;IAE3B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;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,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAC;YACzD,EAAE,iBAAkB,CAAC;IACzB,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,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;AAvCD,oDAuCC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACI,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,IAAA,8DAAqC,EAAC;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,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,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;AA3CD,oGA2CC;AAUD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,SAAgB,uBAAuB;IACrC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,OAAO,IAAA,4BAAY,EAKjB;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,IAAA,8DAAqC,EAAC;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,IAAA,gEAAuC,EAAC,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,IAAA,gCAAiB,EAAC,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;AA1DD,0DA0DC"}
@@ -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>;
@@ -108,7 +108,7 @@ function resolveWixBenefitProgramsV1ProgramDefinitionProgramDefinitionServiceUrl
108
108
  return resolveUrl(Object.assign(opts, { domainToMappings }));
109
109
  }
110
110
  const PACKAGE_NAME = '@wix/auto_sdk_benefit-programs_program-definitions';
111
- /** Creates a new program definition. */
111
+ /** Creates a program definition. */
112
112
  export function createProgramDefinition(payload) {
113
113
  function __createProgramDefinition({ host }) {
114
114
  const serializedData = transformPaths(payload, [
@@ -237,11 +237,7 @@ export function getProgramDefinition(payload) {
237
237
  }
238
238
  return __getProgramDefinition;
239
239
  }
240
- /**
241
- * Retrieves a program definition by specifying the program definition's external ID and associated namespace.
242
- *
243
- * Use this method when you need to retrieve a program definition without its program definition ID.
244
- */
240
+ /** Retrieves a program definition with the specified external ID and namespace. */
245
241
  export function getProgramDefinitionByExternalIdAndNamespace(payload) {
246
242
  function __getProgramDefinitionByExternalIdAndNamespace({ host }) {
247
243
  const metadata = {
@@ -272,13 +268,15 @@ export function getProgramDefinitionByExternalIdAndNamespace(payload) {
272
268
  /**
273
269
  * Creates a query to retrieve a list of program definitions.
274
270
  *
275
- * The `queryProgramDefinitions()` method builds a query to retrieve a list of program definitions and returns a `ProgramDefinitionsQueryBuilder` object.
271
+ * The Query Program Definitions method builds a query to retrieve a list of program definitions and returns a `ProgramDefinitionsQueryBuilder` object.
272
+ *
273
+ * The returned object contains the query definition, which is used to run the query using the `find()` method.
276
274
  *
277
- * 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.
275
+ * 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.
278
276
  *
279
- * 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.
277
+ * Query Program Definitions has a default paging limit of 50, which you can override.
280
278
  *
281
- * 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`.
279
+ * For a full description of the item object, see the object returned for the `items` property in `ProgramDefinitionsQueryResult`.
282
280
  */
283
281
  export function queryProgramDefinitions(payload) {
284
282
  function __queryProgramDefinitions({ host }) {