@wix/auto_sdk_online-programs_participants 1.0.3 → 1.0.5

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 (37) hide show
  1. package/build/cjs/index.d.ts +70 -99
  2. package/build/cjs/index.js +447 -705
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +291 -911
  5. package/build/cjs/index.typings.js +358 -514
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +213 -752
  8. package/build/cjs/meta.js +277 -418
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/es/index.d.mts +70 -99
  11. package/build/es/index.mjs +440 -682
  12. package/build/es/index.mjs.map +1 -1
  13. package/build/es/index.typings.d.mts +291 -911
  14. package/build/es/index.typings.mjs +379 -523
  15. package/build/es/index.typings.mjs.map +1 -1
  16. package/build/es/meta.d.mts +213 -752
  17. package/build/es/meta.mjs +261 -390
  18. package/build/es/meta.mjs.map +1 -1
  19. package/build/internal/cjs/index.d.ts +70 -99
  20. package/build/internal/cjs/index.js +447 -705
  21. package/build/internal/cjs/index.js.map +1 -1
  22. package/build/internal/cjs/index.typings.d.ts +291 -911
  23. package/build/internal/cjs/index.typings.js +358 -514
  24. package/build/internal/cjs/index.typings.js.map +1 -1
  25. package/build/internal/cjs/meta.d.ts +213 -752
  26. package/build/internal/cjs/meta.js +277 -418
  27. package/build/internal/cjs/meta.js.map +1 -1
  28. package/build/internal/es/index.d.mts +70 -99
  29. package/build/internal/es/index.mjs +440 -682
  30. package/build/internal/es/index.mjs.map +1 -1
  31. package/build/internal/es/index.typings.d.mts +291 -911
  32. package/build/internal/es/index.typings.mjs +379 -523
  33. package/build/internal/es/index.typings.mjs.map +1 -1
  34. package/build/internal/es/meta.d.mts +213 -752
  35. package/build/internal/es/meta.mjs +261 -390
  36. package/build/internal/es/meta.mjs.map +1 -1
  37. package/package.json +2 -2
@@ -1,14 +1,7 @@
1
- import { JoinProgramRequest as JoinProgramRequest$1, JoinProgramResponse as JoinProgramResponse$1, GetParticipantRequest as GetParticipantRequest$1, GetParticipantResponse as GetParticipantResponse$1, LeaveProgramRequest as LeaveProgramRequest$1, LeaveProgramResponse as LeaveProgramResponse$1, QueryParticipantsRequest as QueryParticipantsRequest$1, QueryParticipantsResponse as QueryParticipantsResponse$1, GetAccessStatusRequest as GetAccessStatusRequest$1, GetAccessStatusResponse as GetAccessStatusResponse$1, ApplyCouponRequest as ApplyCouponRequest$1, ApplyCouponResponse as ApplyCouponResponse$1, RevertCouponRequest as RevertCouponRequest$1, RevertCouponResponse as RevertCouponResponse$1, BulkInviteToProgramRequest as BulkInviteToProgramRequest$1, BulkInviteToProgramResponse as BulkInviteToProgramResponse$1, BulkInviteAllToProgramRequest as BulkInviteAllToProgramRequest$1, BulkInviteAllToProgramResponse as BulkInviteAllToProgramResponse$1, BulkAddToProgramRequest as BulkAddToProgramRequest$1, BulkAddToProgramResponse as BulkAddToProgramResponse$1, BulkAddAllToProgramRequest as BulkAddAllToProgramRequest$1, BulkAddAllToProgramResponse as BulkAddAllToProgramResponse$1, BulkApproveParticipantRequest as BulkApproveParticipantRequest$1, BulkApproveParticipantResponse as BulkApproveParticipantResponse$1, BulkApproveAllParticipantRequest as BulkApproveAllParticipantRequest$1, BulkApproveAllParticipantResponse as BulkApproveAllParticipantResponse$1, DeleteParticipantRequest as DeleteParticipantRequest$1, DeleteParticipantResponse as DeleteParticipantResponse$1, IssueCertificateRequest as IssueCertificateRequest$1, IssueCertificateResponse as IssueCertificateResponse$1, GetCompletionStatsRequest as GetCompletionStatsRequest$1, GetCompletionStatsResponse as GetCompletionStatsResponse$1, GetPremiumStatsRequest as GetPremiumStatsRequest$1, GetPremiumStatsResponse as GetPremiumStatsResponse$1, ExportParticipantsStatsRequest as ExportParticipantsStatsRequest$1, ExportParticipantsStatsResponse as ExportParticipantsStatsResponse$1 } from './index.typings.js';
1
+ import { CreateParticipantRequest as CreateParticipantRequest$1, CreateParticipantResponse as CreateParticipantResponse$1, BulkCreateParticipantRequest as BulkCreateParticipantRequest$1, BulkCreateParticipantResponse as BulkCreateParticipantResponse$1, BulkAddAllToProgramRequest as BulkAddAllToProgramRequest$1, BulkAddAllToProgramResponse as BulkAddAllToProgramResponse$1, DeleteParticipantRequest as DeleteParticipantRequest$1, DeleteParticipantResponse as DeleteParticipantResponse$1, IssueCertificateRequest as IssueCertificateRequest$1, IssueCertificateResponse as IssueCertificateResponse$1, GetCompletionStatsRequest as GetCompletionStatsRequest$1, GetCompletionStatsResponse as GetCompletionStatsResponse$1, GetPremiumStatsRequest as GetPremiumStatsRequest$1, GetPremiumStatsResponse as GetPremiumStatsResponse$1, GetParticipantRequest as GetParticipantRequest$1, GetParticipantResponse as GetParticipantResponse$1, QueryParticipantsRequest as QueryParticipantsRequest$1, QueryParticipantsResponse as QueryParticipantsResponse$1, GetAccessStatusRequest as GetAccessStatusRequest$1, GetAccessStatusResponse as GetAccessStatusResponse$1, BulkInviteToProgramRequest as BulkInviteToProgramRequest$1, BulkInviteToProgramResponse as BulkInviteToProgramResponse$1, BulkInviteAllToProgramRequest as BulkInviteAllToProgramRequest$1, BulkInviteAllToProgramResponse as BulkInviteAllToProgramResponse$1, BulkAddToProgramRequest as BulkAddToProgramRequest$1, BulkAddToProgramResponse as BulkAddToProgramResponse$1, BulkApproveParticipantRequest as BulkApproveParticipantRequest$1, BulkApproveParticipantResponse as BulkApproveParticipantResponse$1, BulkApproveAllParticipantRequest as BulkApproveAllParticipantRequest$1, BulkApproveAllParticipantResponse as BulkApproveAllParticipantResponse$1, ExportParticipantsStatsRequest as ExportParticipantsStatsRequest$1, ExportParticipantsStatsResponse as ExportParticipantsStatsResponse$1 } from './index.typings.js';
2
2
  import '@wix/sdk-types';
3
3
 
4
- interface Participant extends ParticipantStateOptionsOneOf {
5
- paymentPendingOptions?: PaymentPendingOptions;
6
- joinedOptions?: JoinedOptions;
7
- completedOptions?: CompletedOptions;
8
- failedOptions?: FailedOptions;
9
- suspendedOptions?: SuspendedOptions;
10
- /** options for auto removed participant */
11
- autoRemovedOptions?: AutoRemovedOptions;
4
+ interface Participant {
12
5
  /**
13
6
  * Participant ID.
14
7
  * @format GUID
@@ -42,18 +35,16 @@ interface Participant extends ParticipantStateOptionsOneOf {
42
35
  state?: StateWithLiterals;
43
36
  /** Certificate issued to participant */
44
37
  certificate?: Certificate;
38
+ /** @readonly */
39
+ paymentInfo?: PaymentInfo;
40
+ /** @readonly */
41
+ joinedInfo?: JoinedInfo;
42
+ /** @readonly */
43
+ member?: Member;
44
+ /** @readonly */
45
+ lastActivityDate?: Date | null;
45
46
  extendedFields?: ExtendedFields;
46
47
  }
47
- /** @oneof */
48
- interface ParticipantStateOptionsOneOf {
49
- paymentPendingOptions?: PaymentPendingOptions;
50
- joinedOptions?: JoinedOptions;
51
- completedOptions?: CompletedOptions;
52
- failedOptions?: FailedOptions;
53
- suspendedOptions?: SuspendedOptions;
54
- /** options for auto removed participant */
55
- autoRemovedOptions?: AutoRemovedOptions;
56
- }
57
48
  declare enum JoinPath {
58
49
  UNKNOWN_JOIN_PATH = "UNKNOWN_JOIN_PATH",
59
50
  /** Member joined to the program for free */
@@ -69,16 +60,6 @@ declare enum JoinPath {
69
60
  }
70
61
  /** @enumType */
71
62
  type JoinPathWithLiterals = JoinPath | 'UNKNOWN_JOIN_PATH' | 'FREE' | 'ADDED' | 'SINGLE_PAYMENT' | 'PAID_PLAN' | 'FREE_COUPON';
72
- interface SinglePaymentOptions {
73
- orderId?: string;
74
- }
75
- interface PaidPlanOptions {
76
- /** @maxSize 10 */
77
- planIds?: string[];
78
- }
79
- interface FreeCouponOptions {
80
- couponId?: string;
81
- }
82
63
  interface Progress {
83
64
  /** Number of program steps completed by member */
84
65
  totalStepsCompleted?: number;
@@ -93,11 +74,6 @@ interface Progress {
93
74
  declare enum State {
94
75
  /** Unknown state */
95
76
  UNKNOWN_STATE = "UNKNOWN_STATE",
96
- /** Member invited to participate in program */
97
- INVITED = "INVITED",
98
- /** Member asked owner to participate in program */
99
- APPROVAL_PENDING = "APPROVAL_PENDING",
100
- PAYMENT_PENDING = "PAYMENT_PENDING",
101
77
  /** Member joined the program and became participant */
102
78
  JOINED = "JOINED",
103
79
  /** Participant completed the program, and could join again */
@@ -107,10 +83,14 @@ declare enum State {
107
83
  /** Participant with ended pricing plan (PP), will be joined as renew PP */
108
84
  SUSPENDED = "SUSPENDED",
109
85
  /** Participant removed automatically after some program condition */
110
- AUTO_REMOVED = "AUTO_REMOVED"
86
+ AUTO_REMOVED = "AUTO_REMOVED",
87
+ /** Participant removed by site owner */
88
+ REMOVED = "REMOVED",
89
+ /** Participant left the program by himself */
90
+ LEFT = "LEFT"
111
91
  }
112
92
  /** @enumType */
113
- type StateWithLiterals = State | 'UNKNOWN_STATE' | 'INVITED' | 'APPROVAL_PENDING' | 'PAYMENT_PENDING' | 'JOINED' | 'COMPLETED' | 'FAILED' | 'SUSPENDED' | 'AUTO_REMOVED';
93
+ type StateWithLiterals = State | 'UNKNOWN_STATE' | 'JOINED' | 'COMPLETED' | 'FAILED' | 'SUSPENDED' | 'AUTO_REMOVED' | 'REMOVED' | 'LEFT';
114
94
  interface Certificate {
115
95
  /**
116
96
  * when certificate was issued, UTC
@@ -118,6 +98,51 @@ interface Certificate {
118
98
  */
119
99
  issuedDate?: Date | null;
120
100
  }
101
+ interface PaymentInfo {
102
+ /** @format GUID */
103
+ paymentOrderId?: string | null;
104
+ /** @format GUID */
105
+ offlineTrxId?: string | null;
106
+ /** @format GUID */
107
+ paidPlanId?: string | null;
108
+ /** @format GUID */
109
+ freeCouponId?: string | null;
110
+ }
111
+ interface JoinedInfo {
112
+ /** @maxLength 50 */
113
+ timeZone?: string;
114
+ /** @format LOCAL_DATE */
115
+ startDate?: string;
116
+ joinPath?: JoinPathWithLiterals;
117
+ /** @format LOCAL_DATE */
118
+ finishDate?: string | null;
119
+ /** @readonly */
120
+ joinedAt?: Date | null;
121
+ }
122
+ interface Member {
123
+ /**
124
+ * @readonly
125
+ * @maxLength 100
126
+ */
127
+ firstName?: string | null;
128
+ /**
129
+ * @readonly
130
+ * @maxLength 100
131
+ */
132
+ lastName?: string | null;
133
+ /**
134
+ * @readonly
135
+ * @format EMAIL
136
+ */
137
+ email?: string | null;
138
+ /** @format GUID */
139
+ contactId?: string;
140
+ /**
141
+ * @readonly
142
+ * @format WEB_URL
143
+ */
144
+ profileImageUrl?: string | null;
145
+ }
121
146
  interface ExtendedFields {
122
147
  /**
123
148
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
@@ -129,158 +154,184 @@ interface ExtendedFields {
129
154
  */
130
155
  namespaces?: Record<string, Record<string, any>>;
131
156
  }
132
- interface PaymentPendingOptions {
133
- /**
134
- * Payment order
135
- * @format GUID
136
- */
137
- paymentOrderId?: string | null;
157
+ interface ParticipantAdded {
138
158
  /**
139
- * Offline payment transaction
159
+ * Program ID which participant was added
140
160
  * @format GUID
141
161
  */
142
- offlineTrxId?: string | null;
162
+ programId?: string;
143
163
  /**
144
- * Pricing plans
164
+ * Member ID of participant on site
145
165
  * @format GUID
146
- * @maxSize 10
147
166
  */
148
- paidPlanIds?: string[];
167
+ memberId?: string;
149
168
  }
150
- interface JoinedOptions extends JoinedOptionsJoinPathOptionsOneOf {
151
- singlePaymentOptions?: SinglePaymentOptions;
152
- paidPlanOptions?: PaidPlanOptions;
153
- freeCouponOptions?: FreeCouponOptions;
154
- timeZone?: string;
155
- /** @format LOCAL_DATE */
156
- startDate?: string;
157
- joinPath?: JoinPathWithLiterals;
169
+ interface CreateParticipantRequest {
170
+ /** Participant to create */
171
+ participant: Participant;
158
172
  }
159
- /** @oneof */
160
- interface JoinedOptionsJoinPathOptionsOneOf {
161
- singlePaymentOptions?: SinglePaymentOptions;
162
- paidPlanOptions?: PaidPlanOptions;
163
- freeCouponOptions?: FreeCouponOptions;
173
+ interface CreateParticipantResponse {
174
+ /** Created participant */
175
+ participant?: Participant;
164
176
  }
165
- interface CompletedOptions {
177
+ interface BulkCreateParticipantRequest {
166
178
  /**
167
- * date participant started the program
168
- * @format LOCAL_DATE
179
+ * List of participants you want to create
180
+ * @minSize 1
181
+ * @maxSize 100
169
182
  */
170
- startDate?: string;
183
+ participants: Participant[];
184
+ /** Whether to return entities in response or not. */
185
+ returnEntity?: boolean;
171
186
  }
172
- interface FailedOptions {
187
+ interface BulkCreateParticipantResponse {
173
188
  /**
174
- * date participant started the program
175
- * @format LOCAL_DATE
189
+ * Results of bulk action.
190
+ * @minSize 1
191
+ * @maxSize 100
176
192
  */
177
- startDate?: string;
193
+ results?: BulkParticipantResult[];
194
+ /** Metadata about whole bulk action. */
195
+ bulkActionMetadata?: CommonBulkActionMetadata;
196
+ }
197
+ interface BulkParticipantResult {
198
+ /** Metadata of item. */
199
+ itemMetadata?: CommonItemMetadata;
200
+ /** Item itself (empty if return_entity in request is false). */
201
+ item?: Participant;
202
+ }
203
+ interface CommonItemMetadata {
204
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
205
+ id?: string | null;
206
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
207
+ originalIndex?: number;
208
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
209
+ success?: boolean;
210
+ /** Details about the error in case of failure. */
211
+ error?: ApplicationError;
178
212
  }
179
- interface SuspendedOptions {
213
+ interface ApplicationError {
214
+ /** Error code. */
215
+ code?: string;
216
+ /** Description of the error. */
217
+ description?: string;
218
+ /** Data related to the error. */
219
+ data?: Record<string, any> | null;
220
+ }
221
+ interface CommonBulkActionMetadata {
222
+ /** Number of items that were successfully processed. */
223
+ totalSuccesses?: number;
224
+ /** Number of items that couldn't be processed. */
225
+ totalFailures?: number;
226
+ /** Number of failures without details because detailed failure threshold was exceeded. */
227
+ undetailedFailures?: number;
228
+ }
229
+ interface BulkAddAllToProgramRequest {
180
230
  /**
181
- * date participant started the program
182
- * @format LOCAL_DATE
231
+ * Program to which bulk add participants.
232
+ * @format GUID
183
233
  */
184
- startDate?: string;
185
- }
186
- interface AutoRemovedOptions {
234
+ programId: string;
187
235
  /**
188
- * date participant started the program
189
- * @format LOCAL_DATE
236
+ * Exclude site members.
237
+ * @format GUID
238
+ * @maxSize 100
190
239
  */
191
- startDate?: string;
240
+ excludeMemberIds?: string[];
192
241
  }
193
- interface JoinProgramRequest {
242
+ interface BulkAddAllToProgramResponse {
194
243
  /**
195
- * Program to join
244
+ * Async infra job id which will process the request.
196
245
  * @format GUID
197
246
  */
198
- programId: string;
199
- }
200
- interface JoinProgramResponse {
201
- /** Created participant with corresponding state */
202
- participant?: Participant;
203
- }
204
- interface ParticipantJoined {
205
- /** Joined participant */
206
- participant?: Participant;
247
+ jobId?: string;
207
248
  }
208
- interface GetParticipantRequest {
249
+ interface DeleteParticipantRequest {
209
250
  /**
210
- * Participant id to fetch
251
+ * Participants to delete
211
252
  * @format GUID
212
253
  */
213
254
  participantId: string;
214
255
  }
215
- interface GetParticipantResponse {
216
- /** existing participant */
217
- participant?: Participant;
256
+ interface DeleteParticipantResponse {
218
257
  }
219
- interface LeaveProgramRequest {
258
+ interface IssueCertificateRequest {
220
259
  /**
221
- * Participant id to leave program
260
+ * Participant to get certificate
222
261
  * @format GUID
223
262
  */
224
263
  participantId: string;
225
264
  }
226
- interface LeaveProgramResponse {
265
+ interface IssueCertificateResponse {
266
+ /** Updated participant */
267
+ participant?: Participant;
227
268
  }
228
- interface ParticipantLeft {
229
- /**
230
- * Participant id who left
231
- * @format GUID
232
- */
233
- participantId?: string;
269
+ interface GetCompletionStatsRequest {
234
270
  /**
235
- * Program id participant left
271
+ * program id to get stats for
236
272
  * @format GUID
237
273
  */
238
- programId?: string;
274
+ programId: string;
275
+ }
276
+ interface GetCompletionStatsResponse {
277
+ /** Number of participants that completed the program */
278
+ completedAll?: number;
279
+ /** Percentage of participants that completed the program */
280
+ completionRate?: number;
281
+ }
282
+ interface GetPremiumStatsRequest {
283
+ }
284
+ interface GetPremiumStatsResponse {
285
+ /** True if site has Online Programs premium feature */
286
+ hasPremium?: boolean;
287
+ /** Count of active participants on the site */
288
+ activeParticipantsCount?: number;
289
+ /** Limit of active participants on a site without premium */
290
+ activeParticipantsLimit?: number;
291
+ }
292
+ interface GetParticipantRequest {
239
293
  /**
240
- * Participant's member id
294
+ * Participant id to fetch
241
295
  * @format GUID
242
296
  */
243
- memberId?: string;
244
- /** Reason for removal */
245
- removalReason?: RemovalReasonWithLiterals;
246
- }
247
- declare enum RemovalReason {
248
- /** Default for backward compatibility */
249
- UNKNOWN_REMOVAL_REASON = "UNKNOWN_REMOVAL_REASON",
250
- /** User-initiated leave */
251
- LEGITIMATE_LEAVE = "LEGITIMATE_LEAVE",
252
- /** Cleanup during rejoin flow */
253
- CLEANUP_FOR_REJOIN = "CLEANUP_FOR_REJOIN",
254
- /** Cleanup during manual addition */
255
- CLEANUP_FOR_MANUAL_ADD = "CLEANUP_FOR_MANUAL_ADD"
297
+ participantId: string;
298
+ }
299
+ interface GetParticipantResponse {
300
+ /** existing participant */
301
+ participant?: Participant;
256
302
  }
257
- /** @enumType */
258
- type RemovalReasonWithLiterals = RemovalReason | 'UNKNOWN_REMOVAL_REASON' | 'LEGITIMATE_LEAVE' | 'CLEANUP_FOR_REJOIN' | 'CLEANUP_FOR_MANUAL_ADD';
259
303
  interface QueryParticipantsRequest {
260
304
  /** Platformized query */
261
305
  query?: CursorQuery;
262
306
  }
263
307
  interface CursorQuery extends CursorQueryPagingMethodOneOf {
264
- /** 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`. */
308
+ /**
309
+ * Cursor paging options.
310
+ *
311
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
312
+ */
265
313
  cursorPaging?: CursorPaging;
266
314
  /**
267
- * Filter object in the following format:
268
- * `"filter" : {
269
- * "fieldName1": "value1",
270
- * "fieldName2":{"$operator":"value2"}
271
- * }`
272
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
315
+ * Filter object.
316
+ *
317
+ * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
273
318
  */
274
319
  filter?: Record<string, any> | null;
275
320
  /**
276
- * Sort object in the following format:
277
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
321
+ * Sort object.
322
+ *
323
+ * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
324
+ * @maxSize 5
278
325
  */
279
326
  sort?: Sorting[];
280
327
  }
281
328
  /** @oneof */
282
329
  interface CursorQueryPagingMethodOneOf {
283
- /** 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`. */
330
+ /**
331
+ * Cursor paging options.
332
+ *
333
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
334
+ */
284
335
  cursorPaging?: CursorPaging;
285
336
  }
286
337
  interface Sorting {
@@ -300,16 +351,16 @@ declare enum SortOrder {
300
351
  type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
301
352
  interface CursorPaging {
302
353
  /**
303
- * Number of items to load.
354
+ * Maximum number of items to return in the results.
304
355
  * @max 100
305
356
  */
306
357
  limit?: number | null;
307
358
  /**
308
359
  * Pointer to the next or previous page in the list of results.
309
360
  *
310
- * You can get the relevant cursor token
311
- * from the `pagingMetadata` object in the previous call's response.
361
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
312
362
  * Not relevant for the first request.
363
+ * @maxLength 16000
313
364
  */
314
365
  cursor?: string | null;
315
366
  }
@@ -320,21 +371,28 @@ interface QueryParticipantsResponse {
320
371
  pagingMetadata?: CursorPagingMetadata;
321
372
  }
322
373
  interface CursorPagingMetadata {
323
- /** Number of items returned in the response. */
374
+ /** Number of items returned in current page. */
324
375
  count?: number | null;
325
- /** Offset that was requested. */
376
+ /** Cursor strings that point to the next page, previous page, or both. */
326
377
  cursors?: Cursors;
327
378
  /**
328
- * Indicates if there are more results after the current page.
329
- * If `true`, another page of results can be retrieved.
330
- * If `false`, this is the last page.
379
+ * Whether there are more pages to retrieve following the current page.
380
+ *
381
+ * + `true`: Another page of results can be retrieved.
382
+ * + `false`: This is the last page.
331
383
  */
332
384
  hasNext?: boolean | null;
333
385
  }
334
386
  interface Cursors {
335
- /** Cursor pointing to next page in the list of results. */
387
+ /**
388
+ * Cursor string pointing to the next page in the list of results.
389
+ * @maxLength 16000
390
+ */
336
391
  next?: string | null;
337
- /** Cursor pointing to previous page in the list of results. */
392
+ /**
393
+ * Cursor pointing to the previous page in the list of results.
394
+ * @maxLength 16000
395
+ */
338
396
  prev?: string | null;
339
397
  }
340
398
  interface GetAccessStatusRequest {
@@ -343,503 +401,6 @@ interface GetAccessStatusResponse {
343
401
  /** True if participants cannot access online programs due to some limitations */
344
402
  isBlocked?: boolean;
345
403
  }
346
- interface ApplyCouponRequest {
347
- /** @format GUID */
348
- participantId: string;
349
- /** @format GUID */
350
- orderId: string;
351
- couponCode: string;
352
- }
353
- interface ApplyCouponResponse {
354
- /** @format GUID */
355
- couponId?: string;
356
- subTotal?: number;
357
- discount?: number;
358
- total?: number;
359
- }
360
- interface RevertCouponRequest {
361
- /** @format GUID */
362
- participantId: string;
363
- /** @format GUID */
364
- orderId: string;
365
- /** @format GUID */
366
- couponId: string;
367
- }
368
- interface RevertCouponResponse {
369
- total?: number;
370
- }
371
- /** This webhook is triggered whenever a payment transaction is updated (including refunds) via specific [Wix Apps](https://dev.wix.com/api/rest/wix-payments/about-wix-payments). */
372
- interface PaymentEvent extends PaymentEventEventOneOf {
373
- /** `TRANSACTION_STATUS_CHANGED` event details. */
374
- transactionStatusChangedEvent?: TransactionStatusChangedEvent;
375
- /** `REFUND_STATUS_CHANGED` event details. */
376
- refundStatusChangedEvent?: RefundStatusChangedEvent;
377
- /**
378
- * `RECURRING_PAYMENT_STATUS_CHANGED` event details.
379
- * @deprecated `RECURRING_PAYMENT_STATUS_CHANGED` event details.
380
- * @targetRemovalDate 2026-06-30
381
- */
382
- recurringPaymentStatusChangedEvent?: RecurringPaymentStatusChangedEvent;
383
- /** `TRANSACTION_UPDATED` event details. */
384
- transactionUpdatedEvent?: TransactionUpdatedEvent;
385
- /** `TRANSACTION_CREATED` event details. */
386
- transactionCreatedEvent?: TransactionCreatedEvent;
387
- /**
388
- * Unique event ID.
389
- * @format GUID
390
- */
391
- id?: string;
392
- /** Event timestamp */
393
- eventTime?: Date | null;
394
- /**
395
- * ID of the [Wix app](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions) that triggered this event.
396
- * @maxLength 100
397
- */
398
- wixAppId?: string;
399
- /**
400
- * Unique ID assigned to each Wix app in each site.
401
- * @format GUID
402
- */
403
- wixAppInstanceId?: string;
404
- /** Event type. */
405
- eventType?: EventTypeWithLiterals;
406
- /**
407
- * ID of Wix app that mediated between Wix Payments and the Wix app that triggered the event (if relevant).
408
- * @maxLength 100
409
- */
410
- managingWixAppId?: string | null;
411
- }
412
- /** @oneof */
413
- interface PaymentEventEventOneOf {
414
- /** `TRANSACTION_STATUS_CHANGED` event details. */
415
- transactionStatusChangedEvent?: TransactionStatusChangedEvent;
416
- /** `REFUND_STATUS_CHANGED` event details. */
417
- refundStatusChangedEvent?: RefundStatusChangedEvent;
418
- /**
419
- * `RECURRING_PAYMENT_STATUS_CHANGED` event details.
420
- * @deprecated `RECURRING_PAYMENT_STATUS_CHANGED` event details.
421
- * @targetRemovalDate 2026-06-30
422
- */
423
- recurringPaymentStatusChangedEvent?: RecurringPaymentStatusChangedEvent;
424
- /** `TRANSACTION_UPDATED` event details. */
425
- transactionUpdatedEvent?: TransactionUpdatedEvent;
426
- /** `TRANSACTION_CREATED` event details. */
427
- transactionCreatedEvent?: TransactionCreatedEvent;
428
- }
429
- declare enum EventType {
430
- UNDEFINED = "UNDEFINED",
431
- /** Fired when a transaction's status changes. */
432
- TRANSACTION_STATUS_CHANGED = "TRANSACTION_STATUS_CHANGED",
433
- /** Fired when a refund's status changes. */
434
- REFUND_STATUS_CHANGED = "REFUND_STATUS_CHANGED",
435
- /** Fired when a legacy subscription's status changes. */
436
- RECURRING_PAYMENT_STATUS_CHANGED = "RECURRING_PAYMENT_STATUS_CHANGED",
437
- /** Fired when a transaction is updated. */
438
- TRANSACTION_UPDATED = "TRANSACTION_UPDATED",
439
- /** Fired when a transaction is created. */
440
- TRANSACTION_CREATED = "TRANSACTION_CREATED"
441
- }
442
- /** @enumType */
443
- type EventTypeWithLiterals = EventType | 'UNDEFINED' | 'TRANSACTION_STATUS_CHANGED' | 'REFUND_STATUS_CHANGED' | 'RECURRING_PAYMENT_STATUS_CHANGED' | 'TRANSACTION_UPDATED' | 'TRANSACTION_CREATED';
444
- interface TransactionStatusChangedEvent {
445
- /** Order details (limited to 30 items). */
446
- order?: Order;
447
- /** New transaction details. */
448
- transaction?: Transaction;
449
- /** Previous transaction status. */
450
- previousStatus?: TransactionStatusWithLiterals;
451
- }
452
- interface Order {
453
- id?: string;
454
- /** Wix app order ID */
455
- wixAppOrderId?: string;
456
- /** Wix app buyer ID */
457
- wixAppBuyerId?: string | null;
458
- /** Items included in the order */
459
- items?: OrderItem[];
460
- /**
461
- * total number of items in order
462
- * items_total_count > `items`.size if `items` doesn't contain all items
463
- */
464
- itemsTotalCount?: number;
465
- /** Additional charges to the order - e.g., tax, shipping or discount (optional) */
466
- additionalCharges?: OrderAdditionalCharges;
467
- /** Customer's shipping address (optional) */
468
- shippingAddress?: Address;
469
- /** Customer's shipping address details (optional) */
470
- shippingAddressContacts?: FullAddressContactDetails;
471
- /** Order creation date */
472
- createdAt?: Date | null;
473
- /** External data which is stored with the order */
474
- externalData?: Record<string, string>;
475
- /**
476
- * Vertical invoice ID
477
- * @maxLength 200
478
- */
479
- verticalInvoiceId?: string | null;
480
- /** the part of total amount taken by platform from the amount sent to merchant */
481
- platformFee?: number | null;
482
- }
483
- /** Item included in order */
484
- interface OrderItem {
485
- /** Order item ID (required) */
486
- id?: string;
487
- /** Order item name (required) */
488
- name?: string;
489
- /** Quantity (required) */
490
- quantity?: number;
491
- /** Total price charged for this item in the order - quantity * price (required) */
492
- price?: number;
493
- /** Order item description */
494
- description?: string;
495
- /** Weight of one item */
496
- weightInKg?: number;
497
- /** Whether the item is a physical a digital product */
498
- category?: OrderItemCategoryWithLiterals;
499
- }
500
- /** Order item type */
501
- declare enum OrderItemCategory {
502
- UNDEFINED = "UNDEFINED",
503
- /** Physical product */
504
- PHYSICAL = "PHYSICAL",
505
- /** Digital product */
506
- DIGITAL = "DIGITAL"
507
- }
508
- /** @enumType */
509
- type OrderItemCategoryWithLiterals = OrderItemCategory | 'UNDEFINED' | 'PHYSICAL' | 'DIGITAL';
510
- /** Describing any additional charges in the order. They are not required, but can't be added later. */
511
- interface OrderAdditionalCharges {
512
- /** Absolute taxes charged to the order */
513
- tax?: number;
514
- /** Shipping cost charged to the order */
515
- shipping?: number;
516
- /** Discount amount applied to the order */
517
- discount?: number;
518
- /** Application fee */
519
- applicationFee?: number;
520
- }
521
- /** Physical address */
522
- interface Address extends AddressStreetOneOf {
523
- /** Street name and number. */
524
- streetAddress?: StreetAddress;
525
- /** Main address line, usually street and number as free text. */
526
- addressLine?: string | null;
527
- /**
528
- * Country code.
529
- * @format COUNTRY
530
- */
531
- country?: string | null;
532
- /** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
533
- subdivision?: string | null;
534
- /** City name. */
535
- city?: string | null;
536
- /** Zip/postal code. */
537
- postalCode?: string | null;
538
- /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
539
- addressLine2?: string | null;
540
- }
541
- /** @oneof */
542
- interface AddressStreetOneOf {
543
- /** Street name and number. */
544
- streetAddress?: StreetAddress;
545
- /** Main address line, usually street and number as free text. */
546
- addressLine?: string | null;
547
- }
548
- interface StreetAddress {
549
- /** Street number. */
550
- number?: string;
551
- /** Street name. */
552
- name?: string;
553
- }
554
- interface AddressLocation {
555
- /** Address latitude. */
556
- latitude?: number | null;
557
- /** Address longitude. */
558
- longitude?: number | null;
559
- }
560
- interface Subdivision {
561
- /** Short subdivision code. */
562
- code?: string;
563
- /** Subdivision full name. */
564
- name?: string;
565
- }
566
- declare enum SubdivisionType {
567
- UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
568
- /** State */
569
- ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
570
- /** County */
571
- ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
572
- /** City/town */
573
- ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
574
- /** Neighborhood/quarter */
575
- ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
576
- /** Street/block */
577
- ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
578
- /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
579
- COUNTRY = "COUNTRY"
580
- }
581
- /** @enumType */
582
- type SubdivisionTypeWithLiterals = SubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
583
- /** Subdivision Concordance values */
584
- interface StandardDetails {
585
- /**
586
- * subdivision iso-3166-2 code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). e.g. US-NY, GB-SCT, NO-30
587
- * @maxLength 20
588
- */
589
- iso31662?: string | null;
590
- }
591
- /** Full contact details for an address */
592
- interface FullAddressContactDetails {
593
- /** Contact's first name. */
594
- firstName?: string | null;
595
- /** Contact's last name. */
596
- lastName?: string | null;
597
- /**
598
- * Contact's phone number.
599
- * @format PHONE
600
- */
601
- phone?: string | null;
602
- /** Contact's company name. */
603
- company?: string | null;
604
- /**
605
- * Email associated with the address.
606
- * @format EMAIL
607
- */
608
- email?: string | null;
609
- /** Tax info. Currently usable only in Brazil. */
610
- vatId?: VatId;
611
- }
612
- interface VatId {
613
- /** Customer's tax ID. */
614
- id?: string;
615
- /**
616
- * Tax type.
617
- *
618
- * Supported values:
619
- * + `CPF`: for individual tax payers
620
- * + `CNPJ`: for corporations
621
- */
622
- type?: VatTypeWithLiterals;
623
- }
624
- /** tax info types */
625
- declare enum VatType {
626
- UNSPECIFIED = "UNSPECIFIED",
627
- /** CPF - for individual tax payers. */
628
- CPF = "CPF",
629
- /** CNPJ - for corporations */
630
- CNPJ = "CNPJ"
631
- }
632
- /** @enumType */
633
- type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
634
- interface Transaction extends TransactionPaymentMethodDataOneOf {
635
- creditCardPaymentMethodData?: CreditCardPaymentMethodData;
636
- /** Transaction ID */
637
- id?: string;
638
- /** Provider transaction ID */
639
- providerTransactionId?: string | null;
640
- /** Amount and currency of transaction */
641
- amount?: CurrencyAmount;
642
- /** Refunded amount and currency of transaction */
643
- refundedAmount?: CurrencyAmount;
644
- /** Updated transaction status */
645
- status?: TransactionStatusWithLiterals;
646
- /** Reason provided for status change */
647
- reasonCode?: string | null;
648
- /** Payment method */
649
- paymentMethod?: string;
650
- /** Payment service provider */
651
- paymentProvider?: string;
652
- /** Customer's billing address (optional) */
653
- billingAddress?: Address;
654
- /** Customer's billing address - contact details (optional) */
655
- billingAddressContacts?: FullAddressContactDetails;
656
- /** Details of subscription, which (if) the transaction is a part of */
657
- recurringPaymentDetails?: RecurringPaymentDetails;
658
- /** The details of a payment method account. */
659
- paymentMethodAccountInfo?: AccountInfo;
660
- /** Transaction creation date */
661
- createdAt?: Date | null;
662
- /** Total number of installments */
663
- installments?: number;
664
- /** Scheduled action for this transaction */
665
- scheduledAction?: ScheduledAction;
666
- /**
667
- * order id associated with the transaction on the vertical side
668
- * @minLength 1
669
- * @maxLength 100
670
- */
671
- verticalOrderId?: string | null;
672
- }
673
- /** @oneof */
674
- interface TransactionPaymentMethodDataOneOf {
675
- creditCardPaymentMethodData?: CreditCardPaymentMethodData;
676
- }
677
- interface CurrencyAmount {
678
- /** Amount */
679
- amount?: number;
680
- currency?: string;
681
- }
682
- declare enum TransactionStatus {
683
- UNDEFINED = "UNDEFINED",
684
- APPROVED = "APPROVED",
685
- PENDING = "PENDING",
686
- PENDING_MERCHANT = "PENDING_MERCHANT",
687
- CANCELED = "CANCELED",
688
- DECLINED = "DECLINED",
689
- REFUNDED = "REFUNDED",
690
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
691
- AUTHORIZED = "AUTHORIZED",
692
- VOIDED = "VOIDED"
693
- }
694
- /** @enumType */
695
- type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
696
- interface RecurringPaymentDetails {
697
- /** Current cycle number (Recurring payments only) */
698
- cycleNumber?: number;
699
- }
700
- interface CreditCardPaymentMethodData {
701
- /** Card issuing network */
702
- network?: string;
703
- /** Card number with only bin and last4 positions showed (non-PCI data) */
704
- maskedCreditCard?: string;
705
- /** Card holder's full name specified on the card. */
706
- holderName?: string;
707
- /** Card expiration month. */
708
- expiryMonth?: string;
709
- /**
710
- * Card expiration year.
711
- * @minLength 4
712
- * @maxLength 4
713
- */
714
- expiryYear?: string | null;
715
- /**
716
- * Card last 4 digits.
717
- * @minLength 4
718
- * @maxLength 4
719
- */
720
- lastFourDigits?: string | null;
721
- /**
722
- * Card BIN (Bank Identification Number). It's the first 4-8 digits of a card number.
723
- * @minLength 4
724
- * @maxLength 8
725
- */
726
- bin?: string | null;
727
- }
728
- interface AccountInfo {
729
- /**
730
- * The email of an Account used by Payment Method
731
- * @format EMAIL
732
- */
733
- email?: string | null;
734
- }
735
- interface ScheduledAction {
736
- /** type of the action */
737
- type?: ScheduledActionTypeWithLiterals;
738
- /** the date and time of the action */
739
- executionDate?: Date | null;
740
- }
741
- declare enum ScheduledActionType {
742
- VOID = "VOID",
743
- CAPTURE = "CAPTURE"
744
- }
745
- /** @enumType */
746
- type ScheduledActionTypeWithLiterals = ScheduledActionType | 'VOID' | 'CAPTURE';
747
- interface RefundStatusChangedEvent {
748
- /** Order details (limited to 30 items). */
749
- order?: Order;
750
- /** Updated transaction details. */
751
- transaction?: Transaction;
752
- /** Updated refund details. */
753
- refund?: Refund;
754
- /** Previous refund status. */
755
- previousStatus?: RefundStatusWithLiterals;
756
- }
757
- interface Refund {
758
- id?: string;
759
- /** Amount and currency of refund */
760
- amount?: CurrencyAmount;
761
- /** Updated refund status */
762
- status?: RefundStatusWithLiterals;
763
- /** Reason provided for status change */
764
- reasonCode?: string | null;
765
- /** Refund creation date */
766
- createdAt?: Date | null;
767
- }
768
- declare enum RefundStatus {
769
- UNDEFINED = "UNDEFINED",
770
- APPROVED = "APPROVED",
771
- PENDING = "PENDING",
772
- DECLINED = "DECLINED"
773
- }
774
- /** @enumType */
775
- type RefundStatusWithLiterals = RefundStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'DECLINED';
776
- interface RecurringPaymentStatusChangedEvent {
777
- /** Order details(limited to 30 items). */
778
- order?: Order;
779
- /** Recurring payment status. */
780
- status?: StatusWithLiterals;
781
- /** Previous recurring payment status. */
782
- previousStatus?: StatusWithLiterals;
783
- /** Details of RecurringPayment cancellation (empty if `status` is not CANCELLED). */
784
- cancellationDetails?: RecurringPaymentCancellationDetails;
785
- }
786
- declare enum Status {
787
- UNDEFINED = "UNDEFINED",
788
- PENDING = "PENDING",
789
- ACTIVE = "ACTIVE",
790
- CANCELLED = "CANCELLED",
791
- FINISHED = "FINISHED",
792
- SUSPENDED = "SUSPENDED"
793
- }
794
- /** @enumType */
795
- type StatusWithLiterals = Status | 'UNDEFINED' | 'PENDING' | 'ACTIVE' | 'CANCELLED' | 'FINISHED' | 'SUSPENDED';
796
- interface RecurringPaymentCancellationDetails {
797
- /** Initiator of cancellation */
798
- initiator?: InitiatorWithLiterals;
799
- /** Successfully paid recurring cycles count before the cancellation */
800
- paidRegularCycleCount?: number;
801
- }
802
- declare enum Initiator {
803
- UNDEFINED = "UNDEFINED",
804
- BUYER = "BUYER",
805
- MERCHANT = "MERCHANT",
806
- PAYMENT = "PAYMENT",
807
- SETUP = "SETUP"
808
- }
809
- /** @enumType */
810
- type InitiatorWithLiterals = Initiator | 'UNDEFINED' | 'BUYER' | 'MERCHANT' | 'PAYMENT' | 'SETUP';
811
- interface TransactionUpdatedEvent {
812
- /** Order details (limited to 30 items). */
813
- order?: Order;
814
- /** Updated transaction details. */
815
- transaction?: Transaction;
816
- /** Is event triggered by request to clean user data */
817
- triggeredByAnonymizeRequest?: boolean | null;
818
- }
819
- interface TransactionCreatedEvent {
820
- /** Order details (limited to 30 items). */
821
- order?: Order;
822
- /** Updated transaction details. */
823
- transaction?: Transaction;
824
- }
825
- interface Empty {
826
- }
827
- interface OfflinePaymentSent {
828
- /** Participant who started offline payment */
829
- participant?: Participant;
830
- }
831
- interface PaymentFailed {
832
- /** Participant whose payment was failed */
833
- participant?: Participant;
834
- }
835
- interface SinglePaymentConfirmed {
836
- /** Participant whose payment was confirmed */
837
- participant?: Participant;
838
- }
839
- interface SinglePaymentDeclined {
840
- /** Participant whose payment was declined */
841
- participant?: Participant;
842
- }
843
404
  interface DomainEvent extends DomainEventBodyOneOf {
844
405
  createdEvent?: EntityCreatedEvent;
845
406
  updatedEvent?: EntityUpdatedEvent;
@@ -904,6 +465,8 @@ interface EntityDeletedEvent {
904
465
  interface ActionEvent {
905
466
  bodyAsJson?: string;
906
467
  }
468
+ interface Empty {
469
+ }
907
470
  interface BenefitNotification {
908
471
  /**
909
472
  * Plan unique ID
@@ -1115,14 +678,6 @@ interface ItemMetadata {
1115
678
  /** Details about the error in case of failure. */
1116
679
  error?: ApplicationError;
1117
680
  }
1118
- interface ApplicationError {
1119
- /** Error code. */
1120
- code?: string;
1121
- /** Description of the error. */
1122
- description?: string;
1123
- /** Data related to the error. */
1124
- data?: Record<string, any> | null;
1125
- }
1126
681
  interface BulkInviteToProgramResult {
1127
682
  /** Invited participant metadata. */
1128
683
  itemMetadata?: ItemMetadata;
@@ -1194,35 +749,6 @@ interface BulkAddToProgramResult {
1194
749
  /** Added participant */
1195
750
  item?: Participant;
1196
751
  }
1197
- interface ParticipantAdded {
1198
- /**
1199
- * Program ID which participant was added
1200
- * @format GUID
1201
- */
1202
- programId?: string;
1203
- /**
1204
- * Member ID of participant on site
1205
- * @format GUID
1206
- */
1207
- memberId?: string;
1208
- }
1209
- interface BulkAddAllToProgramRequest {
1210
- /**
1211
- * Program to which bulk add participants.
1212
- * @format GUID
1213
- */
1214
- programId: string;
1215
- /**
1216
- * Exclude site members.
1217
- * @format GUID
1218
- * @maxSize 100
1219
- */
1220
- excludeMemberIds?: string[];
1221
- }
1222
- interface BulkAddAllToProgramResponse {
1223
- /** Bulk action metadata. */
1224
- bulkActionMetadata?: BulkActionMetadata;
1225
- }
1226
752
  interface BulkApproveParticipantRequest {
1227
753
  /**
1228
754
  * Participants to add
@@ -1282,61 +808,6 @@ interface BulkApproveAllParticipantResponse {
1282
808
  */
1283
809
  jobId?: string;
1284
810
  }
1285
- interface DeleteParticipantRequest {
1286
- /**
1287
- * Participants to delete
1288
- * @format GUID
1289
- */
1290
- participantId: string;
1291
- }
1292
- interface DeleteParticipantResponse {
1293
- }
1294
- interface ParticipantRejected {
1295
- /**
1296
- * Program ID which participant rejected
1297
- * @format GUID
1298
- */
1299
- programId?: string;
1300
- /**
1301
- * Member ID of participant rejected
1302
- * @format GUID
1303
- */
1304
- memberId?: string;
1305
- }
1306
- interface IssueCertificateRequest {
1307
- /**
1308
- * Participant to get certificate
1309
- * @format GUID
1310
- */
1311
- participantId: string;
1312
- }
1313
- interface IssueCertificateResponse {
1314
- /** Updated participant */
1315
- participant?: Participant;
1316
- }
1317
- interface GetCompletionStatsRequest {
1318
- /**
1319
- * program id to get stats for
1320
- * @format GUID
1321
- */
1322
- programId: string;
1323
- }
1324
- interface GetCompletionStatsResponse {
1325
- /** Number of participants that completed the program */
1326
- completedAll?: number;
1327
- /** Percentage of participants that completed the program */
1328
- completionRate?: number;
1329
- }
1330
- interface GetPremiumStatsRequest {
1331
- }
1332
- interface GetPremiumStatsResponse {
1333
- /** True if site has Online Programs premium feature */
1334
- hasPremium?: boolean;
1335
- /** Count of active participants on the site */
1336
- activeParticipantsCount?: number;
1337
- /** Limit of active participants on a site without premium */
1338
- activeParticipantsLimit?: number;
1339
- }
1340
811
  interface ExportParticipantsStatsRequest {
1341
812
  /**
1342
813
  * program id to export data from
@@ -1376,29 +847,9 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
1376
847
  __responseType: Q;
1377
848
  __originalResponseType: R;
1378
849
  };
1379
- declare function joinProgram(): __PublicMethodMetaInfo<'POST', {}, JoinProgramRequest$1, JoinProgramRequest, JoinProgramResponse$1, JoinProgramResponse>;
1380
- declare function getParticipant(): __PublicMethodMetaInfo<'GET', {
1381
- participantId: string;
1382
- }, GetParticipantRequest$1, GetParticipantRequest, GetParticipantResponse$1, GetParticipantResponse>;
1383
- declare function leaveProgram(): __PublicMethodMetaInfo<'POST', {
1384
- participantId: string;
1385
- }, LeaveProgramRequest$1, LeaveProgramRequest, LeaveProgramResponse$1, LeaveProgramResponse>;
1386
- declare function queryParticipants(): __PublicMethodMetaInfo<'POST', {}, QueryParticipantsRequest$1, QueryParticipantsRequest, QueryParticipantsResponse$1, QueryParticipantsResponse>;
1387
- declare function getAccessStatus(): __PublicMethodMetaInfo<'GET', {}, GetAccessStatusRequest$1, GetAccessStatusRequest, GetAccessStatusResponse$1, GetAccessStatusResponse>;
1388
- declare function applyCoupon(): __PublicMethodMetaInfo<'POST', {
1389
- participantId: string;
1390
- couponCode: string;
1391
- }, ApplyCouponRequest$1, ApplyCouponRequest, ApplyCouponResponse$1, ApplyCouponResponse>;
1392
- declare function revertCoupon(): __PublicMethodMetaInfo<'POST', {
1393
- participantId: string;
1394
- couponId: string;
1395
- }, RevertCouponRequest$1, RevertCouponRequest, RevertCouponResponse$1, RevertCouponResponse>;
1396
- declare function bulkInviteToProgram(): __PublicMethodMetaInfo<'POST', {}, BulkInviteToProgramRequest$1, BulkInviteToProgramRequest, BulkInviteToProgramResponse$1, BulkInviteToProgramResponse>;
1397
- declare function bulkInviteAllToProgram(): __PublicMethodMetaInfo<'POST', {}, BulkInviteAllToProgramRequest$1, BulkInviteAllToProgramRequest, BulkInviteAllToProgramResponse$1, BulkInviteAllToProgramResponse>;
1398
- declare function bulkAddToProgram(): __PublicMethodMetaInfo<'POST', {}, BulkAddToProgramRequest$1, BulkAddToProgramRequest, BulkAddToProgramResponse$1, BulkAddToProgramResponse>;
850
+ declare function createParticipant(): __PublicMethodMetaInfo<'POST', {}, CreateParticipantRequest$1, CreateParticipantRequest, CreateParticipantResponse$1, CreateParticipantResponse>;
851
+ declare function bulkCreateParticipant(): __PublicMethodMetaInfo<'POST', {}, BulkCreateParticipantRequest$1, BulkCreateParticipantRequest, BulkCreateParticipantResponse$1, BulkCreateParticipantResponse>;
1399
852
  declare function bulkAddAllToProgram(): __PublicMethodMetaInfo<'POST', {}, BulkAddAllToProgramRequest$1, BulkAddAllToProgramRequest, BulkAddAllToProgramResponse$1, BulkAddAllToProgramResponse>;
1400
- declare function bulkApproveParticipant(): __PublicMethodMetaInfo<'POST', {}, BulkApproveParticipantRequest$1, BulkApproveParticipantRequest, BulkApproveParticipantResponse$1, BulkApproveParticipantResponse>;
1401
- declare function bulkApproveAllParticipant(): __PublicMethodMetaInfo<'POST', {}, BulkApproveAllParticipantRequest$1, BulkApproveAllParticipantRequest, BulkApproveAllParticipantResponse$1, BulkApproveAllParticipantResponse>;
1402
853
  declare function deleteParticipant(): __PublicMethodMetaInfo<'DELETE', {
1403
854
  participantId: string;
1404
855
  }, DeleteParticipantRequest$1, DeleteParticipantRequest, DeleteParticipantResponse$1, DeleteParticipantResponse>;
@@ -1409,8 +860,18 @@ declare function getCompletionStats(): __PublicMethodMetaInfo<'GET', {
1409
860
  programId: string;
1410
861
  }, GetCompletionStatsRequest$1, GetCompletionStatsRequest, GetCompletionStatsResponse$1, GetCompletionStatsResponse>;
1411
862
  declare function getPremiumStats(): __PublicMethodMetaInfo<'GET', {}, GetPremiumStatsRequest$1, GetPremiumStatsRequest, GetPremiumStatsResponse$1, GetPremiumStatsResponse>;
863
+ declare function getParticipant(): __PublicMethodMetaInfo<'GET', {
864
+ participantId: string;
865
+ }, GetParticipantRequest$1, GetParticipantRequest, GetParticipantResponse$1, GetParticipantResponse>;
866
+ declare function queryParticipants(): __PublicMethodMetaInfo<'POST', {}, QueryParticipantsRequest$1, QueryParticipantsRequest, QueryParticipantsResponse$1, QueryParticipantsResponse>;
867
+ declare function getAccessStatus(): __PublicMethodMetaInfo<'GET', {}, GetAccessStatusRequest$1, GetAccessStatusRequest, GetAccessStatusResponse$1, GetAccessStatusResponse>;
868
+ declare function bulkInviteToProgram(): __PublicMethodMetaInfo<'POST', {}, BulkInviteToProgramRequest$1, BulkInviteToProgramRequest, BulkInviteToProgramResponse$1, BulkInviteToProgramResponse>;
869
+ declare function bulkInviteAllToProgram(): __PublicMethodMetaInfo<'POST', {}, BulkInviteAllToProgramRequest$1, BulkInviteAllToProgramRequest, BulkInviteAllToProgramResponse$1, BulkInviteAllToProgramResponse>;
870
+ declare function bulkAddToProgram(): __PublicMethodMetaInfo<'POST', {}, BulkAddToProgramRequest$1, BulkAddToProgramRequest, BulkAddToProgramResponse$1, BulkAddToProgramResponse>;
871
+ declare function bulkApproveParticipant(): __PublicMethodMetaInfo<'POST', {}, BulkApproveParticipantRequest$1, BulkApproveParticipantRequest, BulkApproveParticipantResponse$1, BulkApproveParticipantResponse>;
872
+ declare function bulkApproveAllParticipant(): __PublicMethodMetaInfo<'POST', {}, BulkApproveAllParticipantRequest$1, BulkApproveAllParticipantRequest, BulkApproveAllParticipantResponse$1, BulkApproveAllParticipantResponse>;
1412
873
  declare function exportParticipantsStats(): __PublicMethodMetaInfo<'GET', {
1413
874
  programId: string;
1414
875
  }, ExportParticipantsStatsRequest$1, ExportParticipantsStatsRequest, ExportParticipantsStatsResponse$1, ExportParticipantsStatsResponse>;
1415
876
 
1416
- export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AddressLocation as AddressLocationOriginal, type Address as AddressOriginal, type AddressStreetOneOf as AddressStreetOneOfOriginal, type ApplicationError as ApplicationErrorOriginal, type ApplyCouponRequest as ApplyCouponRequestOriginal, type ApplyCouponResponse as ApplyCouponResponseOriginal, type AutoRemovedOptions as AutoRemovedOptionsOriginal, type BehaviorBehaviorOneOf as BehaviorBehaviorOneOfOriginal, type Behavior as BehaviorOriginal, type BenefitNotification as BenefitNotificationOriginal, type Benefit as BenefitOriginal, BenefitType as BenefitTypeOriginal, type BenefitTypeWithLiterals as BenefitTypeWithLiteralsOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkAddAllToProgramRequest as BulkAddAllToProgramRequestOriginal, type BulkAddAllToProgramResponse as BulkAddAllToProgramResponseOriginal, type BulkAddToProgramRequest as BulkAddToProgramRequestOriginal, type BulkAddToProgramResponse as BulkAddToProgramResponseOriginal, type BulkAddToProgramResult as BulkAddToProgramResultOriginal, type BulkApproveAllParticipantRequest as BulkApproveAllParticipantRequestOriginal, type BulkApproveAllParticipantResponse as BulkApproveAllParticipantResponseOriginal, type BulkApproveParticipantRequest as BulkApproveParticipantRequestOriginal, type BulkApproveParticipantResponse as BulkApproveParticipantResponseOriginal, type BulkApproveParticipantResult as BulkApproveParticipantResultOriginal, type BulkInviteAllToProgramRequest as BulkInviteAllToProgramRequestOriginal, type BulkInviteAllToProgramResponse as BulkInviteAllToProgramResponseOriginal, type BulkInviteToProgramRequest as BulkInviteToProgramRequestOriginal, type BulkInviteToProgramResponse as BulkInviteToProgramResponseOriginal, type BulkInviteToProgramResult as BulkInviteToProgramResultOriginal, type Certificate as CertificateOriginal, type CompletedOptions as CompletedOptionsOriginal, type CreditCardPaymentMethodData as CreditCardPaymentMethodDataOriginal, type CurrencyAmount as CurrencyAmountOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type DeleteParticipantRequest as DeleteParticipantRequestOriginal, type DeleteParticipantResponse as DeleteParticipantResponseOriginal, type DiscountDiscountOneOf as DiscountDiscountOneOfOriginal, type Discount as DiscountOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type EntryPass as EntryPassOriginal, Event as EventOriginal, EventType as EventTypeOriginal, type EventTypeWithLiterals as EventTypeWithLiteralsOriginal, type EventWithLiterals as EventWithLiteralsOriginal, type ExportParticipantsStatsRequest as ExportParticipantsStatsRequestOriginal, type ExportParticipantsStatsResponse as ExportParticipantsStatsResponseOriginal, type ExtendedFields as ExtendedFieldsOriginal, type FailedOptions as FailedOptionsOriginal, type FreeCouponOptions as FreeCouponOptionsOriginal, type FullAddressContactDetails as FullAddressContactDetailsOriginal, type GetAccessStatusRequest as GetAccessStatusRequestOriginal, type GetAccessStatusResponse as GetAccessStatusResponseOriginal, type GetCompletionStatsRequest as GetCompletionStatsRequestOriginal, type GetCompletionStatsResponse as GetCompletionStatsResponseOriginal, type GetParticipantRequest as GetParticipantRequestOriginal, type GetParticipantResponse as GetParticipantResponseOriginal, type GetPremiumStatsRequest as GetPremiumStatsRequestOriginal, type GetPremiumStatsResponse as GetPremiumStatsResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, Initiator as InitiatorOriginal, type InitiatorWithLiterals as InitiatorWithLiteralsOriginal, type IssueCertificateRequest as IssueCertificateRequestOriginal, type IssueCertificateResponse as IssueCertificateResponseOriginal, type ItemMetadata as ItemMetadataOriginal, JoinPath as JoinPathOriginal, type JoinPathWithLiterals as JoinPathWithLiteralsOriginal, type JoinProgramRequest as JoinProgramRequestOriginal, type JoinProgramResponse as JoinProgramResponseOriginal, type JoinedOptionsJoinPathOptionsOneOf as JoinedOptionsJoinPathOptionsOneOfOriginal, type JoinedOptions as JoinedOptionsOriginal, type LeaveProgramRequest as LeaveProgramRequestOriginal, type LeaveProgramResponse as LeaveProgramResponseOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type OfflinePaymentSent as OfflinePaymentSentOriginal, type OrderAdditionalCharges as OrderAdditionalChargesOriginal, OrderItemCategory as OrderItemCategoryOriginal, type OrderItemCategoryWithLiterals as OrderItemCategoryWithLiteralsOriginal, type OrderItem as OrderItemOriginal, type Order as OrderOriginal, type PaidPlanOptions as PaidPlanOptionsOriginal, type ParticipantAdded as ParticipantAddedOriginal, type ParticipantApproved as ParticipantApprovedOriginal, type ParticipantExportsFinished as ParticipantExportsFinishedOriginal, type ParticipantInvited as ParticipantInvitedOriginal, type ParticipantJoined as ParticipantJoinedOriginal, type ParticipantLeft as ParticipantLeftOriginal, type Participant as ParticipantOriginal, type ParticipantRejected as ParticipantRejectedOriginal, type ParticipantStateOptionsOneOf as ParticipantStateOptionsOneOfOriginal, type PaymentEventEventOneOf as PaymentEventEventOneOfOriginal, type PaymentEvent as PaymentEventOriginal, type PaymentFailed as PaymentFailedOriginal, type PaymentPendingOptions as PaymentPendingOptionsOriginal, type Progress as ProgressOriginal, type QueryParticipantsRequest as QueryParticipantsRequestOriginal, type QueryParticipantsResponse as QueryParticipantsResponseOriginal, type RecurringPaymentCancellationDetails as RecurringPaymentCancellationDetailsOriginal, type RecurringPaymentDetails as RecurringPaymentDetailsOriginal, type RecurringPaymentStatusChangedEvent as RecurringPaymentStatusChangedEventOriginal, type Refund as RefundOriginal, type RefundStatusChangedEvent as RefundStatusChangedEventOriginal, RefundStatus as RefundStatusOriginal, type RefundStatusWithLiterals as RefundStatusWithLiteralsOriginal, RemovalReason as RemovalReasonOriginal, type RemovalReasonWithLiterals as RemovalReasonWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type RevertCouponRequest as RevertCouponRequestOriginal, type RevertCouponResponse as RevertCouponResponseOriginal, type ScheduledAction as ScheduledActionOriginal, ScheduledActionType as ScheduledActionTypeOriginal, type ScheduledActionTypeWithLiterals as ScheduledActionTypeWithLiteralsOriginal, type SinglePaymentConfirmed as SinglePaymentConfirmedOriginal, type SinglePaymentDeclined as SinglePaymentDeclinedOriginal, type SinglePaymentOptions as SinglePaymentOptionsOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type StandardDetails as StandardDetailsOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, Status as StatusOriginal, type StatusWithLiterals as StatusWithLiteralsOriginal, type StreetAddress as StreetAddressOriginal, type Subdivision as SubdivisionOriginal, SubdivisionType as SubdivisionTypeOriginal, type SubdivisionTypeWithLiterals as SubdivisionTypeWithLiteralsOriginal, type SuspendedOptions as SuspendedOptionsOriginal, type TransactionCreatedEvent as TransactionCreatedEventOriginal, type Transaction as TransactionOriginal, type TransactionPaymentMethodDataOneOf as TransactionPaymentMethodDataOneOfOriginal, type TransactionStatusChangedEvent as TransactionStatusChangedEventOriginal, TransactionStatus as TransactionStatusOriginal, type TransactionStatusWithLiterals as TransactionStatusWithLiteralsOriginal, type TransactionUpdatedEvent as TransactionUpdatedEventOriginal, type VatId as VatIdOriginal, VatType as VatTypeOriginal, type VatTypeWithLiterals as VatTypeWithLiteralsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, applyCoupon, bulkAddAllToProgram, bulkAddToProgram, bulkApproveAllParticipant, bulkApproveParticipant, bulkInviteAllToProgram, bulkInviteToProgram, deleteParticipant, exportParticipantsStats, getAccessStatus, getCompletionStats, getParticipant, getPremiumStats, issueCertificate, joinProgram, leaveProgram, queryParticipants, revertCoupon };
877
+ export { type ActionEvent as ActionEventOriginal, type ApplicationError as ApplicationErrorOriginal, type BehaviorBehaviorOneOf as BehaviorBehaviorOneOfOriginal, type Behavior as BehaviorOriginal, type BenefitNotification as BenefitNotificationOriginal, type Benefit as BenefitOriginal, BenefitType as BenefitTypeOriginal, type BenefitTypeWithLiterals as BenefitTypeWithLiteralsOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkAddAllToProgramRequest as BulkAddAllToProgramRequestOriginal, type BulkAddAllToProgramResponse as BulkAddAllToProgramResponseOriginal, type BulkAddToProgramRequest as BulkAddToProgramRequestOriginal, type BulkAddToProgramResponse as BulkAddToProgramResponseOriginal, type BulkAddToProgramResult as BulkAddToProgramResultOriginal, type BulkApproveAllParticipantRequest as BulkApproveAllParticipantRequestOriginal, type BulkApproveAllParticipantResponse as BulkApproveAllParticipantResponseOriginal, type BulkApproveParticipantRequest as BulkApproveParticipantRequestOriginal, type BulkApproveParticipantResponse as BulkApproveParticipantResponseOriginal, type BulkApproveParticipantResult as BulkApproveParticipantResultOriginal, type BulkCreateParticipantRequest as BulkCreateParticipantRequestOriginal, type BulkCreateParticipantResponse as BulkCreateParticipantResponseOriginal, type BulkInviteAllToProgramRequest as BulkInviteAllToProgramRequestOriginal, type BulkInviteAllToProgramResponse as BulkInviteAllToProgramResponseOriginal, type BulkInviteToProgramRequest as BulkInviteToProgramRequestOriginal, type BulkInviteToProgramResponse as BulkInviteToProgramResponseOriginal, type BulkInviteToProgramResult as BulkInviteToProgramResultOriginal, type BulkParticipantResult as BulkParticipantResultOriginal, type Certificate as CertificateOriginal, type CommonBulkActionMetadata as CommonBulkActionMetadataOriginal, type CommonItemMetadata as CommonItemMetadataOriginal, type CreateParticipantRequest as CreateParticipantRequestOriginal, type CreateParticipantResponse as CreateParticipantResponseOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type DeleteParticipantRequest as DeleteParticipantRequestOriginal, type DeleteParticipantResponse as DeleteParticipantResponseOriginal, type DiscountDiscountOneOf as DiscountDiscountOneOfOriginal, type Discount as DiscountOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type EntryPass as EntryPassOriginal, Event as EventOriginal, type EventWithLiterals as EventWithLiteralsOriginal, type ExportParticipantsStatsRequest as ExportParticipantsStatsRequestOriginal, type ExportParticipantsStatsResponse as ExportParticipantsStatsResponseOriginal, type ExtendedFields as ExtendedFieldsOriginal, type GetAccessStatusRequest as GetAccessStatusRequestOriginal, type GetAccessStatusResponse as GetAccessStatusResponseOriginal, type GetCompletionStatsRequest as GetCompletionStatsRequestOriginal, type GetCompletionStatsResponse as GetCompletionStatsResponseOriginal, type GetParticipantRequest as GetParticipantRequestOriginal, type GetParticipantResponse as GetParticipantResponseOriginal, type GetPremiumStatsRequest as GetPremiumStatsRequestOriginal, type GetPremiumStatsResponse as GetPremiumStatsResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type IssueCertificateRequest as IssueCertificateRequestOriginal, type IssueCertificateResponse as IssueCertificateResponseOriginal, type ItemMetadata as ItemMetadataOriginal, JoinPath as JoinPathOriginal, type JoinPathWithLiterals as JoinPathWithLiteralsOriginal, type JoinedInfo as JoinedInfoOriginal, type Member as MemberOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type ParticipantAdded as ParticipantAddedOriginal, type ParticipantApproved as ParticipantApprovedOriginal, type ParticipantExportsFinished as ParticipantExportsFinishedOriginal, type ParticipantInvited as ParticipantInvitedOriginal, type Participant as ParticipantOriginal, type PaymentInfo as PaymentInfoOriginal, type Progress as ProgressOriginal, type QueryParticipantsRequest as QueryParticipantsRequestOriginal, type QueryParticipantsResponse as QueryParticipantsResponseOriginal, type RestoreInfo as RestoreInfoOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, bulkAddAllToProgram, bulkAddToProgram, bulkApproveAllParticipant, bulkApproveParticipant, bulkCreateParticipant, bulkInviteAllToProgram, bulkInviteToProgram, createParticipant, deleteParticipant, exportParticipantsStats, getAccessStatus, getCompletionStats, getParticipant, getPremiumStats, issueCertificate, queryParticipants };