@wix/auto_sdk_benefit-programs_programs 1.0.17 → 1.0.19

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 (130) hide show
  1. package/build/{internal/cjs/src/benefit-programs-v1-program-programs.universal.d.ts → benefit-programs-v1-program-programs.universal-CoT_YS3k.d.mts} +90 -250
  2. package/build/{cjs/src/benefit-programs-v1-program-programs.universal.d.ts → benefit-programs-v1-program-programs.universal-CoT_YS3k.d.ts} +90 -250
  3. package/build/index.d.mts +113 -0
  4. package/build/index.d.ts +113 -0
  5. package/build/index.js +782 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +744 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/{es/src/benefit-programs-v1-program-programs.universal.d.ts → internal/benefit-programs-v1-program-programs.universal-CoT_YS3k.d.mts} +90 -250
  10. package/build/internal/{es/src/benefit-programs-v1-program-programs.universal.d.ts → benefit-programs-v1-program-programs.universal-CoT_YS3k.d.ts} +90 -250
  11. package/build/internal/index.d.mts +113 -0
  12. package/build/internal/index.d.ts +113 -0
  13. package/build/internal/index.js +782 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +744 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/{es/src/benefit-programs-v1-program-programs.types.d.ts → meta.d.mts} +72 -283
  18. package/build/{es/src/benefit-programs-v1-program-programs.types.d.ts → internal/meta.d.ts} +72 -283
  19. package/build/internal/meta.js +530 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +495 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/{cjs/src/benefit-programs-v1-program-programs.types.d.ts → meta.d.mts} +72 -283
  24. package/build/{internal/cjs/src/benefit-programs-v1-program-programs.types.d.ts → meta.d.ts} +72 -283
  25. package/build/meta.js +530 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +495 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +12 -11
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/benefit-programs-v1-program-programs.context.d.ts +0 -13
  40. package/build/cjs/src/benefit-programs-v1-program-programs.context.js +0 -22
  41. package/build/cjs/src/benefit-programs-v1-program-programs.context.js.map +0 -1
  42. package/build/cjs/src/benefit-programs-v1-program-programs.http.d.ts +0 -53
  43. package/build/cjs/src/benefit-programs-v1-program-programs.http.js +0 -372
  44. package/build/cjs/src/benefit-programs-v1-program-programs.http.js.map +0 -1
  45. package/build/cjs/src/benefit-programs-v1-program-programs.meta.d.ts +0 -25
  46. package/build/cjs/src/benefit-programs-v1-program-programs.meta.js +0 -199
  47. package/build/cjs/src/benefit-programs-v1-program-programs.meta.js.map +0 -1
  48. package/build/cjs/src/benefit-programs-v1-program-programs.public.d.ts +0 -103
  49. package/build/cjs/src/benefit-programs-v1-program-programs.public.js +0 -67
  50. package/build/cjs/src/benefit-programs-v1-program-programs.public.js.map +0 -1
  51. package/build/cjs/src/benefit-programs-v1-program-programs.types.js +0 -63
  52. package/build/cjs/src/benefit-programs-v1-program-programs.types.js.map +0 -1
  53. package/build/cjs/src/benefit-programs-v1-program-programs.universal.js +0 -503
  54. package/build/cjs/src/benefit-programs-v1-program-programs.universal.js.map +0 -1
  55. package/build/es/index.d.ts +0 -1
  56. package/build/es/index.js +0 -2
  57. package/build/es/index.js.map +0 -1
  58. package/build/es/index.typings.d.ts +0 -1
  59. package/build/es/index.typings.js +0 -2
  60. package/build/es/index.typings.js.map +0 -1
  61. package/build/es/meta.d.ts +0 -1
  62. package/build/es/meta.js +0 -2
  63. package/build/es/meta.js.map +0 -1
  64. package/build/es/package.json +0 -3
  65. package/build/es/src/benefit-programs-v1-program-programs.context.d.ts +0 -13
  66. package/build/es/src/benefit-programs-v1-program-programs.context.js +0 -13
  67. package/build/es/src/benefit-programs-v1-program-programs.context.js.map +0 -1
  68. package/build/es/src/benefit-programs-v1-program-programs.http.d.ts +0 -53
  69. package/build/es/src/benefit-programs-v1-program-programs.http.js +0 -360
  70. package/build/es/src/benefit-programs-v1-program-programs.http.js.map +0 -1
  71. package/build/es/src/benefit-programs-v1-program-programs.meta.d.ts +0 -25
  72. package/build/es/src/benefit-programs-v1-program-programs.meta.js +0 -164
  73. package/build/es/src/benefit-programs-v1-program-programs.meta.js.map +0 -1
  74. package/build/es/src/benefit-programs-v1-program-programs.public.d.ts +0 -103
  75. package/build/es/src/benefit-programs-v1-program-programs.public.js +0 -49
  76. package/build/es/src/benefit-programs-v1-program-programs.public.js.map +0 -1
  77. package/build/es/src/benefit-programs-v1-program-programs.types.js +0 -60
  78. package/build/es/src/benefit-programs-v1-program-programs.types.js.map +0 -1
  79. package/build/es/src/benefit-programs-v1-program-programs.universal.js +0 -468
  80. package/build/es/src/benefit-programs-v1-program-programs.universal.js.map +0 -1
  81. package/build/internal/cjs/index.d.ts +0 -1
  82. package/build/internal/cjs/index.js +0 -18
  83. package/build/internal/cjs/index.js.map +0 -1
  84. package/build/internal/cjs/index.typings.d.ts +0 -1
  85. package/build/internal/cjs/index.typings.js +0 -18
  86. package/build/internal/cjs/index.typings.js.map +0 -1
  87. package/build/internal/cjs/meta.d.ts +0 -1
  88. package/build/internal/cjs/meta.js +0 -18
  89. package/build/internal/cjs/meta.js.map +0 -1
  90. package/build/internal/cjs/src/benefit-programs-v1-program-programs.context.d.ts +0 -13
  91. package/build/internal/cjs/src/benefit-programs-v1-program-programs.context.js +0 -22
  92. package/build/internal/cjs/src/benefit-programs-v1-program-programs.context.js.map +0 -1
  93. package/build/internal/cjs/src/benefit-programs-v1-program-programs.http.d.ts +0 -53
  94. package/build/internal/cjs/src/benefit-programs-v1-program-programs.http.js +0 -372
  95. package/build/internal/cjs/src/benefit-programs-v1-program-programs.http.js.map +0 -1
  96. package/build/internal/cjs/src/benefit-programs-v1-program-programs.meta.d.ts +0 -25
  97. package/build/internal/cjs/src/benefit-programs-v1-program-programs.meta.js +0 -199
  98. package/build/internal/cjs/src/benefit-programs-v1-program-programs.meta.js.map +0 -1
  99. package/build/internal/cjs/src/benefit-programs-v1-program-programs.public.d.ts +0 -103
  100. package/build/internal/cjs/src/benefit-programs-v1-program-programs.public.js +0 -67
  101. package/build/internal/cjs/src/benefit-programs-v1-program-programs.public.js.map +0 -1
  102. package/build/internal/cjs/src/benefit-programs-v1-program-programs.types.js +0 -63
  103. package/build/internal/cjs/src/benefit-programs-v1-program-programs.types.js.map +0 -1
  104. package/build/internal/cjs/src/benefit-programs-v1-program-programs.universal.js +0 -503
  105. package/build/internal/cjs/src/benefit-programs-v1-program-programs.universal.js.map +0 -1
  106. package/build/internal/es/index.d.ts +0 -1
  107. package/build/internal/es/index.js +0 -2
  108. package/build/internal/es/index.js.map +0 -1
  109. package/build/internal/es/index.typings.d.ts +0 -1
  110. package/build/internal/es/index.typings.js +0 -2
  111. package/build/internal/es/index.typings.js.map +0 -1
  112. package/build/internal/es/meta.d.ts +0 -1
  113. package/build/internal/es/meta.js +0 -2
  114. package/build/internal/es/meta.js.map +0 -1
  115. package/build/internal/es/src/benefit-programs-v1-program-programs.context.d.ts +0 -13
  116. package/build/internal/es/src/benefit-programs-v1-program-programs.context.js +0 -13
  117. package/build/internal/es/src/benefit-programs-v1-program-programs.context.js.map +0 -1
  118. package/build/internal/es/src/benefit-programs-v1-program-programs.http.d.ts +0 -53
  119. package/build/internal/es/src/benefit-programs-v1-program-programs.http.js +0 -360
  120. package/build/internal/es/src/benefit-programs-v1-program-programs.http.js.map +0 -1
  121. package/build/internal/es/src/benefit-programs-v1-program-programs.meta.d.ts +0 -25
  122. package/build/internal/es/src/benefit-programs-v1-program-programs.meta.js +0 -164
  123. package/build/internal/es/src/benefit-programs-v1-program-programs.meta.js.map +0 -1
  124. package/build/internal/es/src/benefit-programs-v1-program-programs.public.d.ts +0 -103
  125. package/build/internal/es/src/benefit-programs-v1-program-programs.public.js +0 -49
  126. package/build/internal/es/src/benefit-programs-v1-program-programs.public.js.map +0 -1
  127. package/build/internal/es/src/benefit-programs-v1-program-programs.types.js +0 -60
  128. package/build/internal/es/src/benefit-programs-v1-program-programs.types.js.map +0 -1
  129. package/build/internal/es/src/benefit-programs-v1-program-programs.universal.js +0 -468
  130. package/build/internal/es/src/benefit-programs-v1-program-programs.universal.js.map +0 -1
@@ -1,5 +1,4 @@
1
- import { NonNullablePaths } from '@wix/sdk-types';
2
- export interface Program {
1
+ interface Program {
3
2
  /**
4
3
  * Program ID.
5
4
  * @format GUID
@@ -77,7 +76,7 @@ export interface Program {
77
76
  */
78
77
  programDefinition?: ProgramDefinitionInfo;
79
78
  }
80
- export declare enum ProgramStatus {
79
+ declare enum ProgramStatus {
81
80
  /** Undefined program status. */
82
81
  UNDEFINED = "UNDEFINED",
83
82
  /** Program is active. */
@@ -96,8 +95,8 @@ export declare enum ProgramStatus {
96
95
  ENDING = "ENDING"
97
96
  }
98
97
  /** @enumType */
99
- export type ProgramStatusWithLiterals = ProgramStatus | 'UNDEFINED' | 'ACTIVE' | 'PAUSED' | 'ENDED' | 'PROVISIONING' | 'PAUSING' | 'RESUMING' | 'ENDING';
100
- export interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
98
+ type ProgramStatusWithLiterals = ProgramStatus | 'UNDEFINED' | 'ACTIVE' | 'PAUSED' | 'ENDED' | 'PROVISIONING' | 'PAUSING' | 'RESUMING' | 'ENDING';
99
+ interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
101
100
  /**
102
101
  * ID of a site visitor that hasn't logged in to the site.
103
102
  * @format GUID
@@ -115,7 +114,7 @@ export interface CommonIdentificationData extends CommonIdentificationDataIdOneO
115
114
  wixUserId?: string;
116
115
  }
117
116
  /** @oneof */
118
- export interface CommonIdentificationDataIdOneOf {
117
+ interface CommonIdentificationDataIdOneOf {
119
118
  /**
120
119
  * ID of a site visitor that hasn't logged in to the site.
121
120
  * @format GUID
@@ -132,7 +131,7 @@ export interface CommonIdentificationDataIdOneOf {
132
131
  */
133
132
  wixUserId?: string;
134
133
  }
135
- export declare enum IdentityType {
134
+ declare enum IdentityType {
136
135
  /** Unknown type. This value is not used. */
137
136
  UNKNOWN = "UNKNOWN",
138
137
  /** A site visitor who has not logged in. */
@@ -142,9 +141,7 @@ export declare enum IdentityType {
142
141
  /** A Wix account holder, such as a site owner or contributor. */
143
142
  WIX_USER = "WIX_USER"
144
143
  }
145
- /** @enumType */
146
- export type IdentityTypeWithLiterals = IdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER';
147
- export interface ExtendedFields {
144
+ interface ExtendedFields {
148
145
  /**
149
146
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
150
147
  * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -155,7 +152,7 @@ export interface ExtendedFields {
155
152
  */
156
153
  namespaces?: Record<string, Record<string, any>>;
157
154
  }
158
- export interface ProgramDefinitionInfo {
155
+ interface ProgramDefinitionInfo {
159
156
  /**
160
157
  * Program definition ID.
161
158
  * @format GUID
@@ -169,28 +166,28 @@ export interface ProgramDefinitionInfo {
169
166
  */
170
167
  externalId?: string | null;
171
168
  }
172
- export interface ProgramProvisioned {
169
+ interface ProgramProvisioned {
173
170
  /** Program which has been provisioned */
174
171
  program?: Program;
175
172
  }
176
- export interface ProgramRenewed {
173
+ interface ProgramRenewed {
177
174
  /** Program which has been renewed */
178
175
  program?: Program;
179
176
  }
180
- export interface ProgramEnded {
177
+ interface ProgramEnded {
181
178
  /** Program which has been ended */
182
179
  program?: Program;
183
180
  }
184
- export interface ProgramPaused {
181
+ interface ProgramPaused {
185
182
  /** Program which has been paused */
186
183
  program?: Program;
187
184
  }
188
- export interface ProgramResumed {
185
+ interface ProgramResumed {
189
186
  /** Program which has been resumed */
190
187
  program?: Program;
191
188
  }
192
189
  /** In case pool_definition_id is provided should test if it's part of a package. If it is, reject the request */
193
- export interface ProvisionProgramRequest {
190
+ interface ProvisionProgramRequest {
194
191
  /** The program definition or pool definition to use to provision the program. */
195
192
  poolDefinitionLookupId: PoolDefinitionLookupId;
196
193
  /** Program beneficiary. */
@@ -220,7 +217,7 @@ export interface ProvisionProgramRequest {
220
217
  */
221
218
  externalProgramId: string;
222
219
  }
223
- export interface PoolDefinitionLookupId extends PoolDefinitionLookupIdIdOneOf {
220
+ interface PoolDefinitionLookupId extends PoolDefinitionLookupIdIdOneOf {
224
221
  /**
225
222
  * Pool definition ID.
226
223
  * @format GUID
@@ -233,7 +230,7 @@ export interface PoolDefinitionLookupId extends PoolDefinitionLookupIdIdOneOf {
233
230
  programDefinitionId?: string;
234
231
  }
235
232
  /** @oneof */
236
- export interface PoolDefinitionLookupIdIdOneOf {
233
+ interface PoolDefinitionLookupIdIdOneOf {
237
234
  /**
238
235
  * Pool definition ID.
239
236
  * @format GUID
@@ -245,15 +242,15 @@ export interface PoolDefinitionLookupIdIdOneOf {
245
242
  */
246
243
  programDefinitionId?: string;
247
244
  }
248
- export declare enum ProvisionProgramRequestProgramStatus {
245
+ declare enum ProvisionProgramRequestProgramStatus {
249
246
  /** Program is active. */
250
247
  ACTIVE = "ACTIVE",
251
248
  /** Program is paused. */
252
249
  PAUSED = "PAUSED"
253
250
  }
254
251
  /** @enumType */
255
- export type ProvisionProgramRequestProgramStatusWithLiterals = ProvisionProgramRequestProgramStatus | 'ACTIVE' | 'PAUSED';
256
- export interface ProvisionProgramResponse {
252
+ type ProvisionProgramRequestProgramStatusWithLiterals = ProvisionProgramRequestProgramStatus | 'ACTIVE' | 'PAUSED';
253
+ interface ProvisionProgramResponse {
257
254
  /**
258
255
  * Job ID of the provisioning of the program. Retrieve job details using the Async Job API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)).
259
256
  * @format GUID
@@ -262,7 +259,7 @@ export interface ProvisionProgramResponse {
262
259
  /** Provisioned program. */
263
260
  program?: Program;
264
261
  }
265
- export interface ProgramAlreadyExists {
262
+ interface ProgramAlreadyExists {
266
263
  /**
267
264
  * Key of a program that already exists
268
265
  * @format GUID
@@ -275,26 +272,26 @@ export interface ProgramAlreadyExists {
275
272
  namespace?: string;
276
273
  }
277
274
  /** Updates the pool credit amount according to the configuration. */
278
- export interface RenewProgramRequest {
275
+ interface RenewProgramRequest {
279
276
  /**
280
277
  * ID of the program to renew.
281
278
  * @format GUID
282
279
  */
283
280
  programId: string;
281
+ /**
282
+ * Idempotency key to ensure that the request is processed only once.
283
+ * @maxLength 64
284
+ */
285
+ idempotencyKey: string;
284
286
  }
285
- export interface RenewProgramResponse {
287
+ interface RenewProgramResponse {
286
288
  /**
287
289
  * Job ID of the program renewal. Retrieve job details using the Async Job API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)).
288
290
  * @format GUID
289
291
  */
290
292
  jobId?: string;
291
- /**
292
- * Idempotency key to ensure that the request is processed only once.
293
- * @maxLength 64
294
- */
295
- idempotencyKey?: string;
296
293
  }
297
- export interface PauseProgramRequest {
294
+ interface PauseProgramRequest {
298
295
  /**
299
296
  * ID of the program to pause.
300
297
  * @format GUID
@@ -304,22 +301,22 @@ export interface PauseProgramRequest {
304
301
  * Idempotency key to ensure that the request is processed only once.
305
302
  * @maxLength 64
306
303
  */
307
- idempotencyKey?: string;
304
+ idempotencyKey: string;
308
305
  }
309
- export interface PauseProgramResponse {
306
+ interface PauseProgramResponse {
310
307
  /**
311
308
  * Job ID of the pausing of the program. Retrieve job details using the Async Job API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)).
312
309
  * @format GUID
313
310
  */
314
311
  jobId?: string;
315
312
  }
316
- export interface ProgramStatusTransitionNotAllowed {
313
+ interface ProgramStatusTransitionNotAllowed {
317
314
  /** Current status of the program */
318
315
  currentStatus?: ProgramStatusWithLiterals;
319
316
  /** Status to which the program is being transitioned */
320
317
  requestedStatus?: ProgramStatusWithLiterals;
321
318
  }
322
- export interface ResumeProgramRequest {
319
+ interface ResumeProgramRequest {
323
320
  /**
324
321
  * ID of program to resume.
325
322
  * @format GUID
@@ -329,30 +326,30 @@ export interface ResumeProgramRequest {
329
326
  * Idempotency key to ensure that the request is processed only once.
330
327
  * @maxLength 64
331
328
  */
332
- idempotencyKey?: string;
329
+ idempotencyKey: string;
333
330
  }
334
- export interface ResumeProgramResponse {
331
+ interface ResumeProgramResponse {
335
332
  /**
336
333
  * Job ID of the resuming of the program. Retrieve job details using the Async Job API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)).
337
334
  * @format GUID
338
335
  */
339
336
  jobId?: string;
340
337
  }
341
- export interface EndProgramRequest {
338
+ interface EndProgramRequest {
342
339
  /**
343
340
  * ID of the program to end.
344
341
  * @format GUID
345
342
  */
346
343
  programId: string;
347
344
  }
348
- export interface EndProgramResponse {
345
+ interface EndProgramResponse {
349
346
  /**
350
347
  * Job ID of the ending of the program. Retrieve job details using the Async Job API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)).
351
348
  * @format GUID
352
349
  */
353
350
  jobId?: string;
354
351
  }
355
- export interface UpdateProgramStatusRequest {
352
+ interface UpdateProgramStatusRequest {
356
353
  /**
357
354
  * Program to update
358
355
  * @format GUID
@@ -365,11 +362,11 @@ export interface UpdateProgramStatusRequest {
365
362
  /** Status to update */
366
363
  targetStatus?: ProgramStatusWithLiterals;
367
364
  }
368
- export interface UpdateProgramStatusResponse {
365
+ interface UpdateProgramStatusResponse {
369
366
  /** The updated Program */
370
367
  program?: Program;
371
368
  }
372
- export interface UpsertMigratedProgramRequest {
369
+ interface UpsertMigratedProgramRequest {
373
370
  /**
374
371
  * Order id
375
372
  * @format GUID
@@ -393,42 +390,42 @@ export interface UpsertMigratedProgramRequest {
393
390
  */
394
391
  planName?: string;
395
392
  }
396
- export declare enum OrderStatus {
393
+ declare enum OrderStatus {
397
394
  UNKNOWN = "UNKNOWN",
398
395
  ACTIVE = "ACTIVE",
399
396
  PAUSED = "PAUSED",
400
397
  ENDED = "ENDED"
401
398
  }
402
399
  /** @enumType */
403
- export type OrderStatusWithLiterals = OrderStatus | 'UNKNOWN' | 'ACTIVE' | 'PAUSED' | 'ENDED';
404
- export interface UpsertMigratedProgramResponse {
400
+ type OrderStatusWithLiterals = OrderStatus | 'UNKNOWN' | 'ACTIVE' | 'PAUSED' | 'ENDED';
401
+ interface UpsertMigratedProgramResponse {
405
402
  /** Inserted or updated program */
406
403
  program?: Program;
407
404
  }
408
- export interface UpdateProgramRequest {
405
+ interface UpdateProgramRequest {
409
406
  /** Program to update. */
410
407
  program: Program;
411
408
  }
412
- export interface UpdateProgramResponse {
409
+ interface UpdateProgramResponse {
413
410
  /** Updated program. */
414
411
  program?: Program;
415
412
  }
416
- export interface GetProgramRequest {
413
+ interface GetProgramRequest {
417
414
  /**
418
415
  * ID of the program to retrieve.
419
416
  * @format GUID
420
417
  */
421
418
  programId: string;
422
419
  }
423
- export interface GetProgramResponse {
420
+ interface GetProgramResponse {
424
421
  /** Retrieved program. */
425
422
  program?: Program;
426
423
  }
427
- export interface QueryProgramsRequest {
424
+ interface QueryProgramsRequest {
428
425
  /** Filter, sort, and paging to apply to the query. */
429
426
  query?: CursorQuery;
430
427
  }
431
- export interface CursorQuery extends CursorQueryPagingMethodOneOf {
428
+ interface CursorQuery extends CursorQueryPagingMethodOneOf {
432
429
  /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
433
430
  cursorPaging?: CursorPaging;
434
431
  /**
@@ -444,11 +441,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
444
441
  sort?: Sorting[];
445
442
  }
446
443
  /** @oneof */
447
- export interface CursorQueryPagingMethodOneOf {
444
+ interface CursorQueryPagingMethodOneOf {
448
445
  /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
449
446
  cursorPaging?: CursorPaging;
450
447
  }
451
- export interface Sorting {
448
+ interface Sorting {
452
449
  /**
453
450
  * Field to sort by.
454
451
  * @maxLength 512
@@ -461,15 +458,15 @@ export interface Sorting {
461
458
  */
462
459
  order?: SortOrderWithLiterals;
463
460
  }
464
- export declare enum SortOrder {
461
+ declare enum SortOrder {
465
462
  /** Ascending sort order. */
466
463
  ASC = "ASC",
467
464
  /** Descending sort order. */
468
465
  DESC = "DESC"
469
466
  }
470
467
  /** @enumType */
471
- export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
472
- export interface CursorPaging {
468
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
469
+ interface CursorPaging {
473
470
  /**
474
471
  * Maximum number of items to return.
475
472
  * @max 100
@@ -484,13 +481,13 @@ export interface CursorPaging {
484
481
  */
485
482
  cursor?: string | null;
486
483
  }
487
- export interface QueryProgramsResponse {
484
+ interface QueryProgramsResponse {
488
485
  /** List of retrieved programs. */
489
486
  programs?: Program[];
490
487
  /** Metadata for the paginated results. */
491
488
  metadata?: CursorPagingMetadata;
492
489
  }
493
- export interface CursorPagingMetadata {
490
+ interface CursorPagingMetadata {
494
491
  /** Number of items returned in the response. */
495
492
  count?: number | null;
496
493
  /** Cursor strings that point to the next page, previous page, or both. */
@@ -503,7 +500,7 @@ export interface CursorPagingMetadata {
503
500
  */
504
501
  hasNext?: boolean | null;
505
502
  }
506
- export interface Cursors {
503
+ interface Cursors {
507
504
  /**
508
505
  * Cursor string pointing to the next page in the list of results.
509
506
  * @maxLength 16000
@@ -515,7 +512,7 @@ export interface Cursors {
515
512
  */
516
513
  prev?: string | null;
517
514
  }
518
- export interface GetProgramByExternalIdAndNamespaceRequest {
515
+ interface GetProgramByExternalIdAndNamespaceRequest {
519
516
  /**
520
517
  * Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
521
518
  * @minLength 1
@@ -528,11 +525,11 @@ export interface GetProgramByExternalIdAndNamespaceRequest {
528
525
  */
529
526
  externalId: string;
530
527
  }
531
- export interface GetProgramByExternalIdAndNamespaceResponse {
528
+ interface GetProgramByExternalIdAndNamespaceResponse {
532
529
  /** Retrieved program. */
533
530
  program?: Program;
534
531
  }
535
- export interface DomainEvent extends DomainEventBodyOneOf {
532
+ interface DomainEvent extends DomainEventBodyOneOf {
536
533
  createdEvent?: EntityCreatedEvent;
537
534
  updatedEvent?: EntityUpdatedEvent;
538
535
  deletedEvent?: EntityDeletedEvent;
@@ -567,19 +564,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
567
564
  entityEventSequence?: string | null;
568
565
  }
569
566
  /** @oneof */
570
- export interface DomainEventBodyOneOf {
567
+ interface DomainEventBodyOneOf {
571
568
  createdEvent?: EntityCreatedEvent;
572
569
  updatedEvent?: EntityUpdatedEvent;
573
570
  deletedEvent?: EntityDeletedEvent;
574
571
  actionEvent?: ActionEvent;
575
572
  }
576
- export interface EntityCreatedEvent {
573
+ interface EntityCreatedEvent {
577
574
  entity?: string;
578
575
  }
579
- export interface RestoreInfo {
576
+ interface RestoreInfo {
580
577
  deletedDate?: Date | null;
581
578
  }
582
- export interface EntityUpdatedEvent {
579
+ interface EntityUpdatedEvent {
583
580
  /**
584
581
  * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
585
582
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
@@ -587,14 +584,14 @@ export interface EntityUpdatedEvent {
587
584
  */
588
585
  currentEntity?: string;
589
586
  }
590
- export interface EntityDeletedEvent {
587
+ interface EntityDeletedEvent {
591
588
  /** Entity that was deleted. */
592
589
  deletedEntity?: string | null;
593
590
  }
594
- export interface ActionEvent {
591
+ interface ActionEvent {
595
592
  body?: string;
596
593
  }
597
- export interface MessageEnvelope {
594
+ interface MessageEnvelope {
598
595
  /**
599
596
  * App instance ID.
600
597
  * @format GUID
@@ -610,7 +607,7 @@ export interface MessageEnvelope {
610
607
  /** Stringify payload. */
611
608
  data?: string;
612
609
  }
613
- export interface IdentificationData extends IdentificationDataIdOneOf {
610
+ interface IdentificationData extends IdentificationDataIdOneOf {
614
611
  /**
615
612
  * ID of a site visitor that has not logged in to the site.
616
613
  * @format GUID
@@ -635,7 +632,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
635
632
  identityType?: WebhookIdentityTypeWithLiterals;
636
633
  }
637
634
  /** @oneof */
638
- export interface IdentificationDataIdOneOf {
635
+ interface IdentificationDataIdOneOf {
639
636
  /**
640
637
  * ID of a site visitor that has not logged in to the site.
641
638
  * @format GUID
@@ -657,7 +654,7 @@ export interface IdentificationDataIdOneOf {
657
654
  */
658
655
  appId?: string;
659
656
  }
660
- export declare enum WebhookIdentityType {
657
+ declare enum WebhookIdentityType {
661
658
  UNKNOWN = "UNKNOWN",
662
659
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
663
660
  MEMBER = "MEMBER",
@@ -665,31 +662,8 @@ export declare enum WebhookIdentityType {
665
662
  APP = "APP"
666
663
  }
667
664
  /** @enumType */
668
- export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
669
- type ProgramNonNullablePaths = `status` | `beneficiary.anonymousVisitorId` | `beneficiary.memberId` | `beneficiary.wixUserId` | `programDefinition._id`;
670
- /**
671
- * Creates a program for the specified beneficiary. Creating a program is also referred to as provisioning a program.
672
- *
673
- * You can provision a program from a program definition or a pool definition:
674
- * - **Program definition**: The provisioned program has pools that are created from the pool definitions in the program definition.
675
- * - **Pool definition**: The provisioned program has 1 pool that is created from the pool definition.
676
- * @param poolDefinitionLookupId - The program definition or pool definition to use to provision the program.
677
- * @public
678
- * @documentationMaturity preview
679
- * @requiredField options.beneficiary
680
- * @requiredField options.externalProgramId
681
- * @requiredField options.namespace
682
- * @requiredField poolDefinitionLookupId
683
- * @permissionId BENEFIT_PROGRAMS.PROGRAM_PROVISION
684
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
685
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
686
- * @applicableIdentity APP
687
- * @fqn wix.benefit_programs.v1.program.ProgramService.ProvisionProgram
688
- */
689
- export declare function provisionProgram(poolDefinitionLookupId: PoolDefinitionLookupId, options?: NonNullablePaths<ProvisionProgramOptions, `beneficiary` | `externalProgramId` | `namespace`>): Promise<NonNullablePaths<ProvisionProgramResponse, `jobId` | {
690
- [P in ProgramNonNullablePaths]: `program.${P}`;
691
- }[ProgramNonNullablePaths]>>;
692
- export interface ProvisionProgramOptions {
665
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
666
+ interface ProvisionProgramOptions {
693
667
  /** Program beneficiary. */
694
668
  beneficiary: CommonIdentificationData;
695
669
  /**
@@ -717,99 +691,28 @@ export interface ProvisionProgramOptions {
717
691
  */
718
692
  externalProgramId: string;
719
693
  }
720
- /**
721
- * Renews the specified program.
722
- *
723
- * The number of available credits in each pool in the program is defined in the corresponding pool's credit configuration.
724
- * @param programId - ID of the program to renew.
725
- * @public
726
- * @documentationMaturity preview
727
- * @requiredField programId
728
- * @permissionId BENEFIT_PROGRAMS.PROGRAM_RENEW
729
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
730
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
731
- * @applicableIdentity APP
732
- * @fqn wix.benefit_programs.v1.program.ProgramService.RenewProgram
733
- */
734
- export declare function renewProgram(programId: string): Promise<NonNullablePaths<RenewProgramResponse, `jobId` | `idempotencyKey`>>;
735
- /**
736
- * Pauses the specified program. Benefits in the program's pools can't be redeemed until the program is resumed.
737
- * @param programId - ID of the program to pause.
738
- * @public
739
- * @documentationMaturity preview
740
- * @requiredField programId
741
- * @permissionId BENEFIT_PROGRAMS.PROGRAM_PAUSE
742
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
743
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
744
- * @applicableIdentity APP
745
- * @fqn wix.benefit_programs.v1.program.ProgramService.PauseProgram
746
- */
747
- export declare function pauseProgram(programId: string, options?: PauseProgramOptions): Promise<NonNullablePaths<PauseProgramResponse, `jobId`>>;
748
- export interface PauseProgramOptions {
694
+ interface RenewProgramOptions {
695
+ /**
696
+ * Idempotency key to ensure that the request is processed only once.
697
+ * @maxLength 64
698
+ */
699
+ idempotencyKey: string;
700
+ }
701
+ interface PauseProgramOptions {
749
702
  /**
750
703
  * Idempotency key to ensure that the request is processed only once.
751
704
  * @maxLength 64
752
705
  */
753
- idempotencyKey?: string;
754
- }
755
- /**
756
- * Resumes the specified program.
757
- *
758
- * Call this method for paused programs.
759
- * @param programId - ID of program to resume.
760
- * @public
761
- * @documentationMaturity preview
762
- * @requiredField programId
763
- * @permissionId BENEFIT_PROGRAMS.PROGRAM_RESUME
764
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
765
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
766
- * @applicableIdentity APP
767
- * @fqn wix.benefit_programs.v1.program.ProgramService.ResumeProgram
768
- */
769
- export declare function resumeProgram(programId: string, options?: ResumeProgramOptions): Promise<NonNullablePaths<ResumeProgramResponse, `jobId`>>;
770
- export interface ResumeProgramOptions {
706
+ idempotencyKey: string;
707
+ }
708
+ interface ResumeProgramOptions {
771
709
  /**
772
710
  * Idempotency key to ensure that the request is processed only once.
773
711
  * @maxLength 64
774
712
  */
775
- idempotencyKey?: string;
776
- }
777
- /**
778
- * Ends the specified program.
779
- * @param programId - ID of the program to end.
780
- * @public
781
- * @documentationMaturity preview
782
- * @requiredField programId
783
- * @permissionId BENEFIT_PROGRAMS.PROGRAM_END
784
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
785
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
786
- * @applicableIdentity APP
787
- * @fqn wix.benefit_programs.v1.program.ProgramService.EndProgram
788
- */
789
- export declare function endProgram(programId: string): Promise<NonNullablePaths<EndProgramResponse, `jobId`>>;
790
- /**
791
- * Updates a program.
792
- *
793
- * Each time the program definition is updated,
794
- * `revision` increments by 1.
795
- * The current `revision` must be passed when updating the program definition.
796
- * This ensures you're working with the latest program definition
797
- * and prevents unintended overwrites.
798
- * @param _id - Program ID.
799
- * @public
800
- * @documentationMaturity preview
801
- * @requiredField _id
802
- * @requiredField program
803
- * @requiredField program.revision
804
- * @permissionId BENEFIT_PROGRAMS.PROGRAM_UPDATE
805
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
806
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
807
- * @applicableIdentity APP
808
- * @returns Updated program.
809
- * @fqn wix.benefit_programs.v1.program.ProgramService.UpdateProgram
810
- */
811
- export declare function updateProgram(_id: string, program: NonNullablePaths<UpdateProgram, `revision`>): Promise<NonNullablePaths<Program, ProgramNonNullablePaths>>;
812
- export interface UpdateProgram {
713
+ idempotencyKey: string;
714
+ }
715
+ interface UpdateProgram {
813
716
  /**
814
717
  * Program ID.
815
718
  * @format GUID
@@ -887,49 +790,6 @@ export interface UpdateProgram {
887
790
  */
888
791
  programDefinition?: ProgramDefinitionInfo;
889
792
  }
890
- /**
891
- * Retrieves a program.
892
- * @param programId - ID of the program to retrieve.
893
- * @public
894
- * @documentationMaturity preview
895
- * @requiredField programId
896
- * @permissionId BENEFIT_PROGRAMS.PROGRAM_READ
897
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
898
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
899
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
900
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
901
- * @permissionScope Manage Events
902
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
903
- * @applicableIdentity APP
904
- * @returns Retrieved program.
905
- * @fqn wix.benefit_programs.v1.program.ProgramService.GetProgram
906
- */
907
- export declare function getProgram(programId: string): Promise<NonNullablePaths<Program, ProgramNonNullablePaths>>;
908
- /**
909
- * Creates a query to retrieve a list of programs.
910
- *
911
- * The Query Programs method builds a query to retrieve a list of programs and returns a `ProgramsQueryBuilder` object.
912
- *
913
- * The returned object contains the query definition, which is used to run the query using the `find()` method.
914
- *
915
- * You can refine the query by chaining `ProgramsQueryBuilder` methods onto the query. `ProgramsQueryBuilder` methods enable you to filter, sort, and control the results that Query Programs returns.
916
- *
917
- * Query Programs has a default paging limit of 50, which you can override.
918
- *
919
- * For a full description of the item object, see the object returned for the `items` property in `ProgramsQueryResult`.
920
- * @public
921
- * @documentationMaturity preview
922
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
923
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
924
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
925
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
926
- * @permissionScope Manage Events
927
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
928
- * @permissionId BENEFIT_PROGRAMS.PROGRAM_READ
929
- * @applicableIdentity APP
930
- * @fqn wix.benefit_programs.v1.program.ProgramService.QueryPrograms
931
- */
932
- export declare function queryPrograms(): ProgramsQueryBuilder;
933
793
  interface QueryCursorResult {
934
794
  cursors: Cursors;
935
795
  hasNext: () => boolean;
@@ -937,13 +797,13 @@ interface QueryCursorResult {
937
797
  length: number;
938
798
  pageSize: number;
939
799
  }
940
- export interface ProgramsQueryResult extends QueryCursorResult {
800
+ interface ProgramsQueryResult extends QueryCursorResult {
941
801
  items: Program[];
942
802
  query: ProgramsQueryBuilder;
943
803
  next: () => Promise<ProgramsQueryResult>;
944
804
  prev: () => Promise<ProgramsQueryResult>;
945
805
  }
946
- export interface ProgramsQueryBuilder {
806
+ interface ProgramsQueryBuilder {
947
807
  /** @param propertyName - Property whose value is compared with `value`.
948
808
  * @param value - Value to compare against.
949
809
  * @documentationMaturity preview
@@ -1007,32 +867,12 @@ export interface ProgramsQueryBuilder {
1007
867
  /** @documentationMaturity preview */
1008
868
  find: () => Promise<ProgramsQueryResult>;
1009
869
  }
1010
- /**
1011
- * Retrieves a program with the specified external ID and namespace.
1012
- * @param namespace - Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
1013
- * @public
1014
- * @documentationMaturity preview
1015
- * @requiredField namespace
1016
- * @requiredField options
1017
- * @requiredField options.externalId
1018
- * @permissionId BENEFIT_PROGRAMS.PROGRAM_READ
1019
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
1020
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
1021
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
1022
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
1023
- * @permissionScope Manage Events
1024
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1025
- * @applicableIdentity APP
1026
- * @fqn wix.benefit_programs.v1.program.ProgramService.GetProgramByExternalIdAndNamespace
1027
- */
1028
- export declare function getProgramByExternalIdAndNamespace(namespace: string, options: NonNullablePaths<GetProgramByExternalIdAndNamespaceOptions, `externalId`>): Promise<NonNullablePaths<GetProgramByExternalIdAndNamespaceResponse, {
1029
- [P in ProgramNonNullablePaths]: `program.${P}`;
1030
- }[ProgramNonNullablePaths]>>;
1031
- export interface GetProgramByExternalIdAndNamespaceOptions {
870
+ interface GetProgramByExternalIdAndNamespaceOptions {
1032
871
  /**
1033
872
  * Program's external ID.
1034
873
  * @format GUID
1035
874
  */
1036
875
  externalId: string;
1037
876
  }
1038
- export {};
877
+
878
+ export { type Cursors as $, type ResumeProgramRequest as A, type EndProgramRequest as B, type CommonIdentificationData as C, type UpdateProgramStatusRequest as D, type EndProgramResponse as E, type UpdateProgramStatusResponse as F, type GetProgramByExternalIdAndNamespaceOptions as G, type UpsertMigratedProgramRequest as H, IdentityType as I, type UpsertMigratedProgramResponse as J, type UpdateProgramRequest as K, type UpdateProgramResponse as L, type GetProgramRequest as M, type GetProgramResponse as N, OrderStatus as O, type PoolDefinitionLookupId as P, type QueryProgramsRequest as Q, type RenewProgramOptions as R, SortOrder as S, type CursorQuery as T, type UpdateProgram as U, type CursorQueryPagingMethodOneOf as V, WebhookIdentityType as W, type Sorting as X, type CursorPaging as Y, type QueryProgramsResponse as Z, type CursorPagingMetadata as _, type ProvisionProgramOptions as a, type GetProgramByExternalIdAndNamespaceRequest as a0, type DomainEvent as a1, type DomainEventBodyOneOf as a2, type EntityCreatedEvent as a3, type RestoreInfo as a4, type EntityUpdatedEvent as a5, type EntityDeletedEvent as a6, type ActionEvent as a7, type MessageEnvelope as a8, type IdentificationData as a9, type IdentificationDataIdOneOf as aa, type ProgramsQueryResult as ab, type ProvisionProgramResponse as b, type RenewProgramResponse as c, type PauseProgramOptions as d, type PauseProgramResponse as e, type ResumeProgramOptions as f, type ResumeProgramResponse as g, type Program as h, type ProgramsQueryBuilder as i, type GetProgramByExternalIdAndNamespaceResponse as j, ProgramStatus as k, ProvisionProgramRequestProgramStatus as l, type CommonIdentificationDataIdOneOf as m, type ExtendedFields as n, type ProgramDefinitionInfo as o, type ProgramProvisioned as p, type ProgramRenewed as q, type ProgramEnded as r, type ProgramPaused as s, type ProgramResumed as t, type ProvisionProgramRequest as u, type PoolDefinitionLookupIdIdOneOf as v, type ProgramAlreadyExists as w, type RenewProgramRequest as x, type PauseProgramRequest as y, type ProgramStatusTransitionNotAllowed as z };