@wix/auto_sdk_online-programs_participants 1.0.10 → 1.0.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +3 -93
- package/build/cjs/index.js +159 -1168
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +95 -652
- package/build/cjs/index.typings.js +11 -916
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +96 -487
- package/build/cjs/meta.js +11 -790
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +3 -93
- package/build/es/index.mjs +144 -1139
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +95 -652
- package/build/es/index.typings.mjs +2 -892
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +96 -487
- package/build/es/meta.mjs +2 -767
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +3 -104
- package/build/internal/cjs/index.js +159 -1168
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +95 -662
- package/build/internal/cjs/index.typings.js +11 -916
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +96 -487
- package/build/internal/cjs/meta.js +11 -790
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +3 -104
- package/build/internal/es/index.mjs +144 -1139
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +95 -662
- package/build/internal/es/index.typings.mjs +2 -892
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +96 -487
- package/build/internal/es/meta.mjs +2 -767
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +3 -3
package/build/cjs/meta.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { 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 } from './index.typings.js';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
interface Participant {
|
|
@@ -186,41 +186,29 @@ interface ParticipantAdded {
|
|
|
186
186
|
*/
|
|
187
187
|
memberId?: string;
|
|
188
188
|
}
|
|
189
|
-
interface
|
|
190
|
-
/** Participant to create */
|
|
191
|
-
participant: Participant;
|
|
192
|
-
}
|
|
193
|
-
interface CreateParticipantResponse {
|
|
194
|
-
/** Created participant */
|
|
195
|
-
participant?: Participant;
|
|
196
|
-
}
|
|
197
|
-
interface BulkCreateParticipantRequest {
|
|
189
|
+
interface BulkInviteToProgramRequest {
|
|
198
190
|
/**
|
|
199
|
-
*
|
|
200
|
-
* @
|
|
201
|
-
* @maxSize 100
|
|
191
|
+
* Program to which bulk invite participants.
|
|
192
|
+
* @format GUID
|
|
202
193
|
*/
|
|
203
|
-
|
|
204
|
-
/** Whether to return entities in response or not. */
|
|
205
|
-
returnEntity?: boolean;
|
|
206
|
-
}
|
|
207
|
-
interface BulkCreateParticipantResponse {
|
|
194
|
+
programId: string;
|
|
208
195
|
/**
|
|
209
|
-
*
|
|
196
|
+
* Return added participants in the response or not.
|
|
197
|
+
* @format GUID
|
|
210
198
|
* @minSize 1
|
|
211
199
|
* @maxSize 100
|
|
212
200
|
*/
|
|
213
|
-
|
|
214
|
-
/**
|
|
215
|
-
|
|
201
|
+
memberIds?: string[];
|
|
202
|
+
/** Return invited participants in the response or not. */
|
|
203
|
+
returnEntity?: boolean;
|
|
216
204
|
}
|
|
217
|
-
interface
|
|
218
|
-
/**
|
|
219
|
-
|
|
220
|
-
/**
|
|
221
|
-
|
|
205
|
+
interface BulkInviteToProgramResponse {
|
|
206
|
+
/** Participants created by bulk action */
|
|
207
|
+
results?: BulkInviteToProgramResult[];
|
|
208
|
+
/** Bulk action metadata. */
|
|
209
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
222
210
|
}
|
|
223
|
-
interface
|
|
211
|
+
interface ItemMetadata {
|
|
224
212
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
225
213
|
id?: string | null;
|
|
226
214
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
@@ -238,7 +226,13 @@ interface ApplicationError {
|
|
|
238
226
|
/** Data related to the error. */
|
|
239
227
|
data?: Record<string, any> | null;
|
|
240
228
|
}
|
|
241
|
-
interface
|
|
229
|
+
interface BulkInviteToProgramResult {
|
|
230
|
+
/** Invited participant metadata. */
|
|
231
|
+
itemMetadata?: ItemMetadata;
|
|
232
|
+
/** Invited participant */
|
|
233
|
+
item?: Participant;
|
|
234
|
+
}
|
|
235
|
+
interface BulkActionMetadata {
|
|
242
236
|
/** Number of items that were successfully processed. */
|
|
243
237
|
totalSuccesses?: number;
|
|
244
238
|
/** Number of items that couldn't be processed. */
|
|
@@ -246,180 +240,121 @@ interface CommonBulkActionMetadata {
|
|
|
246
240
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
247
241
|
undetailedFailures?: number;
|
|
248
242
|
}
|
|
249
|
-
interface
|
|
250
|
-
/**
|
|
251
|
-
* Program to which bulk add participants.
|
|
252
|
-
* @format GUID
|
|
253
|
-
*/
|
|
254
|
-
programId: string;
|
|
243
|
+
interface ParticipantInvited {
|
|
255
244
|
/**
|
|
256
|
-
*
|
|
245
|
+
* Program to which bulk invite participants.
|
|
257
246
|
* @format GUID
|
|
258
|
-
* @maxSize 100
|
|
259
247
|
*/
|
|
260
|
-
|
|
261
|
-
}
|
|
262
|
-
interface BulkAddAllToProgramResponse {
|
|
248
|
+
programId?: string;
|
|
263
249
|
/**
|
|
264
|
-
*
|
|
250
|
+
* Invited member to program
|
|
265
251
|
* @format GUID
|
|
266
252
|
*/
|
|
267
|
-
|
|
253
|
+
memberId?: string;
|
|
268
254
|
}
|
|
269
|
-
interface
|
|
255
|
+
interface BulkInviteAllToProgramRequest {
|
|
270
256
|
/**
|
|
271
|
-
*
|
|
257
|
+
* Program to which bulk add participants.
|
|
272
258
|
* @format GUID
|
|
273
259
|
*/
|
|
274
|
-
|
|
275
|
-
}
|
|
276
|
-
interface DeleteParticipantResponse {
|
|
277
|
-
}
|
|
278
|
-
interface IssueCertificateRequest {
|
|
260
|
+
programId: string;
|
|
279
261
|
/**
|
|
280
|
-
*
|
|
262
|
+
* Exclude site members.
|
|
281
263
|
* @format GUID
|
|
264
|
+
* @maxSize 100
|
|
282
265
|
*/
|
|
283
|
-
|
|
266
|
+
excludeMemberIds?: string[];
|
|
284
267
|
}
|
|
285
|
-
interface
|
|
286
|
-
/**
|
|
287
|
-
|
|
268
|
+
interface BulkInviteAllToProgramResponse {
|
|
269
|
+
/** Bulk action metadata. */
|
|
270
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
288
271
|
}
|
|
289
|
-
interface
|
|
272
|
+
interface BulkAddToProgramRequest {
|
|
290
273
|
/**
|
|
291
|
-
*
|
|
274
|
+
* Program to which bulk add participants.
|
|
292
275
|
* @format GUID
|
|
293
276
|
*/
|
|
294
277
|
programId: string;
|
|
295
|
-
}
|
|
296
|
-
interface GetCompletionStatsResponse {
|
|
297
|
-
/** Number of participants that completed the program */
|
|
298
|
-
completedAll?: number;
|
|
299
|
-
/** Percentage of participants that completed the program */
|
|
300
|
-
completionRate?: number;
|
|
301
|
-
}
|
|
302
|
-
interface GetPremiumStatsRequest {
|
|
303
|
-
}
|
|
304
|
-
interface GetPremiumStatsResponse {
|
|
305
|
-
/** True if site has Online Programs premium feature */
|
|
306
|
-
hasPremium?: boolean;
|
|
307
|
-
/** Count of active participants on the site */
|
|
308
|
-
activeParticipantsCount?: number;
|
|
309
|
-
/** Limit of active participants on a site without premium */
|
|
310
|
-
activeParticipantsLimit?: number;
|
|
311
|
-
}
|
|
312
|
-
interface GetParticipantRequest {
|
|
313
278
|
/**
|
|
314
|
-
*
|
|
279
|
+
* Site members.
|
|
315
280
|
* @format GUID
|
|
281
|
+
* @minSize 1
|
|
282
|
+
* @maxSize 1000
|
|
316
283
|
*/
|
|
317
|
-
|
|
284
|
+
memberIds?: string[];
|
|
285
|
+
/** Return added participants in the response or not. */
|
|
286
|
+
returnEntity?: boolean;
|
|
318
287
|
}
|
|
319
|
-
interface
|
|
320
|
-
/**
|
|
321
|
-
|
|
288
|
+
interface BulkAddToProgramResponse {
|
|
289
|
+
/** Participants created by bulk action */
|
|
290
|
+
results?: BulkAddToProgramResult[];
|
|
291
|
+
/** Bulk action metadata. */
|
|
292
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
322
293
|
}
|
|
323
|
-
interface
|
|
324
|
-
/**
|
|
325
|
-
|
|
294
|
+
interface BulkAddToProgramResult {
|
|
295
|
+
/** Added participant metadata. */
|
|
296
|
+
itemMetadata?: ItemMetadata;
|
|
297
|
+
/** Added participant */
|
|
298
|
+
item?: Participant;
|
|
326
299
|
}
|
|
327
|
-
interface
|
|
328
|
-
/**
|
|
329
|
-
* Cursor paging options.
|
|
330
|
-
*
|
|
331
|
-
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
332
|
-
*/
|
|
333
|
-
cursorPaging?: CursorPaging;
|
|
334
|
-
/**
|
|
335
|
-
* Filter object.
|
|
336
|
-
*
|
|
337
|
-
* Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
|
|
338
|
-
*/
|
|
339
|
-
filter?: Record<string, any> | null;
|
|
300
|
+
interface BulkApproveParticipantRequest {
|
|
340
301
|
/**
|
|
341
|
-
*
|
|
342
|
-
*
|
|
343
|
-
*
|
|
344
|
-
* @maxSize 5
|
|
302
|
+
* Participants to add
|
|
303
|
+
* @format GUID
|
|
304
|
+
* @maxSize 100
|
|
345
305
|
*/
|
|
346
|
-
|
|
347
|
-
}
|
|
348
|
-
/** @oneof */
|
|
349
|
-
interface CursorQueryPagingMethodOneOf {
|
|
306
|
+
participantIds: string[];
|
|
350
307
|
/**
|
|
351
|
-
*
|
|
352
|
-
*
|
|
353
|
-
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
308
|
+
* program to approve participant
|
|
309
|
+
* @format GUID
|
|
354
310
|
*/
|
|
355
|
-
|
|
311
|
+
programId?: string;
|
|
312
|
+
/** Return approved participants in the response or not */
|
|
313
|
+
returnEntity?: boolean;
|
|
356
314
|
}
|
|
357
|
-
interface
|
|
358
|
-
/**
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
fieldName?: string;
|
|
363
|
-
/** Sort order. */
|
|
364
|
-
order?: SortOrderWithLiterals;
|
|
315
|
+
interface BulkApproveParticipantResponse {
|
|
316
|
+
/** Participants approved by bulk action */
|
|
317
|
+
results?: BulkApproveParticipantResult[];
|
|
318
|
+
/** Bulk action metadata */
|
|
319
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
365
320
|
}
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
321
|
+
interface BulkApproveParticipantResult {
|
|
322
|
+
/** Approved participant metadata */
|
|
323
|
+
itemMetadata?: ItemMetadata;
|
|
324
|
+
/** Approved or existing participant */
|
|
325
|
+
item?: Participant;
|
|
369
326
|
}
|
|
370
|
-
|
|
371
|
-
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
372
|
-
interface CursorPaging {
|
|
327
|
+
interface ParticipantApproved {
|
|
373
328
|
/**
|
|
374
|
-
*
|
|
375
|
-
* @
|
|
329
|
+
* Program ID which participant approved
|
|
330
|
+
* @format GUID
|
|
376
331
|
*/
|
|
377
|
-
|
|
332
|
+
programId?: string;
|
|
378
333
|
/**
|
|
379
|
-
*
|
|
380
|
-
*
|
|
381
|
-
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
382
|
-
* Not relevant for the first request.
|
|
383
|
-
* @maxLength 16000
|
|
334
|
+
* Member ID of participant approved
|
|
335
|
+
* @format GUID
|
|
384
336
|
*/
|
|
385
|
-
|
|
386
|
-
}
|
|
387
|
-
interface QueryParticipantsResponse {
|
|
388
|
-
/** found participants */
|
|
389
|
-
participants?: Participant[];
|
|
390
|
-
/** paging metadata */
|
|
391
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
337
|
+
memberId?: string;
|
|
392
338
|
}
|
|
393
|
-
interface
|
|
394
|
-
/** Number of items returned in current page. */
|
|
395
|
-
count?: number | null;
|
|
396
|
-
/** Cursor strings that point to the next page, previous page, or both. */
|
|
397
|
-
cursors?: Cursors;
|
|
339
|
+
interface BulkApproveAllParticipantRequest {
|
|
398
340
|
/**
|
|
399
|
-
*
|
|
400
|
-
*
|
|
401
|
-
* + `true`: Another page of results can be retrieved.
|
|
402
|
-
* + `false`: This is the last page.
|
|
341
|
+
* Program to approve all participants.
|
|
342
|
+
* @format GUID
|
|
403
343
|
*/
|
|
404
|
-
|
|
405
|
-
}
|
|
406
|
-
interface Cursors {
|
|
344
|
+
programId?: string;
|
|
407
345
|
/**
|
|
408
|
-
*
|
|
409
|
-
* @
|
|
346
|
+
* Exclude site members.
|
|
347
|
+
* @format GUID
|
|
348
|
+
* @maxSize 100
|
|
410
349
|
*/
|
|
411
|
-
|
|
350
|
+
excludeParticipantIds?: string[];
|
|
351
|
+
}
|
|
352
|
+
interface BulkApproveAllParticipantResponse {
|
|
412
353
|
/**
|
|
413
|
-
*
|
|
414
|
-
* @
|
|
354
|
+
* Job id with async process
|
|
355
|
+
* @format GUID
|
|
415
356
|
*/
|
|
416
|
-
|
|
417
|
-
}
|
|
418
|
-
interface GetAccessStatusRequest {
|
|
419
|
-
}
|
|
420
|
-
interface GetAccessStatusResponse {
|
|
421
|
-
/** True if participants cannot access online programs due to some limitations */
|
|
422
|
-
isBlocked?: boolean;
|
|
357
|
+
jobId?: string;
|
|
423
358
|
}
|
|
424
359
|
interface DomainEvent extends DomainEventBodyOneOf {
|
|
425
360
|
createdEvent?: EntityCreatedEvent;
|
|
@@ -485,115 +420,6 @@ interface EntityDeletedEvent {
|
|
|
485
420
|
interface ActionEvent {
|
|
486
421
|
bodyAsJson?: string;
|
|
487
422
|
}
|
|
488
|
-
interface Empty {
|
|
489
|
-
}
|
|
490
|
-
interface BenefitNotification {
|
|
491
|
-
/**
|
|
492
|
-
* Plan unique ID
|
|
493
|
-
* @format GUID
|
|
494
|
-
*/
|
|
495
|
-
planId?: string;
|
|
496
|
-
/**
|
|
497
|
-
* App def ID
|
|
498
|
-
* @format GUID
|
|
499
|
-
*/
|
|
500
|
-
appDefId?: string;
|
|
501
|
-
/** Current benefit details */
|
|
502
|
-
benefit?: Benefit;
|
|
503
|
-
/** Previous benefit */
|
|
504
|
-
prevBenefit?: Benefit;
|
|
505
|
-
/** Notification event */
|
|
506
|
-
event?: EventWithLiterals;
|
|
507
|
-
}
|
|
508
|
-
interface Benefit {
|
|
509
|
-
/**
|
|
510
|
-
* Benefit unique ID
|
|
511
|
-
* @format GUID
|
|
512
|
-
* @readonly
|
|
513
|
-
*/
|
|
514
|
-
id?: string | null;
|
|
515
|
-
/** Benefit Type */
|
|
516
|
-
benefitType?: BenefitTypeWithLiterals;
|
|
517
|
-
/**
|
|
518
|
-
* Resource IDs that serves by this benefit
|
|
519
|
-
* @format GUID
|
|
520
|
-
*/
|
|
521
|
-
resourceIds?: string[];
|
|
522
|
-
/** Amount of credits that provided by this benefit */
|
|
523
|
-
creditAmount?: number | null;
|
|
524
|
-
/**
|
|
525
|
-
* additional details related to benefit; limited to 20 entries, 20 symbols for key and 20 symbols for value
|
|
526
|
-
* @maxSize 20
|
|
527
|
-
*/
|
|
528
|
-
customFields?: Record<string, string>;
|
|
529
|
-
/** return value only in case it required in the ListRequest, true means that benefit's type could be updated */
|
|
530
|
-
editable?: boolean | null;
|
|
531
|
-
/** Benefit behavior */
|
|
532
|
-
behavior?: Behavior;
|
|
533
|
-
/**
|
|
534
|
-
* Id of the app associated with this benefit
|
|
535
|
-
* @format GUID
|
|
536
|
-
* @readonly
|
|
537
|
-
*/
|
|
538
|
-
appDefId?: string | null;
|
|
539
|
-
}
|
|
540
|
-
interface EntryPass {
|
|
541
|
-
}
|
|
542
|
-
interface Discount extends DiscountDiscountOneOf {
|
|
543
|
-
/**
|
|
544
|
-
* Fixed-rate percent off discount
|
|
545
|
-
* @decimalValue options { gt:0, lte:100, maxScale:2 }
|
|
546
|
-
*/
|
|
547
|
-
percentOffRate?: string;
|
|
548
|
-
/**
|
|
549
|
-
* Absolute amount discount
|
|
550
|
-
* @decimalValue options { gt:0, maxScale:2 }
|
|
551
|
-
*/
|
|
552
|
-
moneyOffAmount?: string;
|
|
553
|
-
}
|
|
554
|
-
/** @oneof */
|
|
555
|
-
interface DiscountDiscountOneOf {
|
|
556
|
-
/**
|
|
557
|
-
* Fixed-rate percent off discount
|
|
558
|
-
* @decimalValue options { gt:0, lte:100, maxScale:2 }
|
|
559
|
-
*/
|
|
560
|
-
percentOffRate?: string;
|
|
561
|
-
/**
|
|
562
|
-
* Absolute amount discount
|
|
563
|
-
* @decimalValue options { gt:0, maxScale:2 }
|
|
564
|
-
*/
|
|
565
|
-
moneyOffAmount?: string;
|
|
566
|
-
}
|
|
567
|
-
declare enum BenefitType {
|
|
568
|
-
/** Should never be used */
|
|
569
|
-
UNDEFINED = "UNDEFINED",
|
|
570
|
-
/** Limited benefit type */
|
|
571
|
-
LIMITED = "LIMITED",
|
|
572
|
-
/** Unlimited benefit type */
|
|
573
|
-
UNLIMITED = "UNLIMITED"
|
|
574
|
-
}
|
|
575
|
-
/** @enumType */
|
|
576
|
-
type BenefitTypeWithLiterals = BenefitType | 'UNDEFINED' | 'LIMITED' | 'UNLIMITED';
|
|
577
|
-
interface Behavior extends BehaviorBehaviorOneOf {
|
|
578
|
-
/** Entry pass for resources, e.g. a ticket for Bookings service or a ticket for Events. */
|
|
579
|
-
defaultBehavior?: EntryPass;
|
|
580
|
-
/** Discount applied to paid resources */
|
|
581
|
-
discount?: Discount;
|
|
582
|
-
}
|
|
583
|
-
/** @oneof */
|
|
584
|
-
interface BehaviorBehaviorOneOf {
|
|
585
|
-
/** Entry pass for resources, e.g. a ticket for Bookings service or a ticket for Events. */
|
|
586
|
-
defaultBehavior?: EntryPass;
|
|
587
|
-
/** Discount applied to paid resources */
|
|
588
|
-
discount?: Discount;
|
|
589
|
-
}
|
|
590
|
-
declare enum Event {
|
|
591
|
-
Updated = "Updated",
|
|
592
|
-
Deleted = "Deleted",
|
|
593
|
-
Created = "Created"
|
|
594
|
-
}
|
|
595
|
-
/** @enumType */
|
|
596
|
-
type EventWithLiterals = Event | 'Updated' | 'Deleted' | 'Created';
|
|
597
423
|
interface MessageEnvelope {
|
|
598
424
|
/**
|
|
599
425
|
* App instance ID.
|
|
@@ -666,202 +492,6 @@ declare enum WebhookIdentityType {
|
|
|
666
492
|
}
|
|
667
493
|
/** @enumType */
|
|
668
494
|
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
669
|
-
interface BulkInviteToProgramRequest {
|
|
670
|
-
/**
|
|
671
|
-
* Program to which bulk invite participants.
|
|
672
|
-
* @format GUID
|
|
673
|
-
*/
|
|
674
|
-
programId: string;
|
|
675
|
-
/**
|
|
676
|
-
* Return added participants in the response or not.
|
|
677
|
-
* @format GUID
|
|
678
|
-
* @minSize 1
|
|
679
|
-
* @maxSize 100
|
|
680
|
-
*/
|
|
681
|
-
memberIds?: string[];
|
|
682
|
-
/** Return invited participants in the response or not. */
|
|
683
|
-
returnEntity?: boolean;
|
|
684
|
-
}
|
|
685
|
-
interface BulkInviteToProgramResponse {
|
|
686
|
-
/** Participants created by bulk action */
|
|
687
|
-
results?: BulkInviteToProgramResult[];
|
|
688
|
-
/** Bulk action metadata. */
|
|
689
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
690
|
-
}
|
|
691
|
-
interface ItemMetadata {
|
|
692
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
693
|
-
id?: string | null;
|
|
694
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
695
|
-
originalIndex?: number;
|
|
696
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
697
|
-
success?: boolean;
|
|
698
|
-
/** Details about the error in case of failure. */
|
|
699
|
-
error?: ApplicationError;
|
|
700
|
-
}
|
|
701
|
-
interface BulkInviteToProgramResult {
|
|
702
|
-
/** Invited participant metadata. */
|
|
703
|
-
itemMetadata?: ItemMetadata;
|
|
704
|
-
/** Invited participant */
|
|
705
|
-
item?: Participant;
|
|
706
|
-
}
|
|
707
|
-
interface BulkActionMetadata {
|
|
708
|
-
/** Number of items that were successfully processed. */
|
|
709
|
-
totalSuccesses?: number;
|
|
710
|
-
/** Number of items that couldn't be processed. */
|
|
711
|
-
totalFailures?: number;
|
|
712
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
713
|
-
undetailedFailures?: number;
|
|
714
|
-
}
|
|
715
|
-
interface ParticipantInvited {
|
|
716
|
-
/**
|
|
717
|
-
* Program to which bulk invite participants.
|
|
718
|
-
* @format GUID
|
|
719
|
-
*/
|
|
720
|
-
programId?: string;
|
|
721
|
-
/**
|
|
722
|
-
* Invited member to program
|
|
723
|
-
* @format GUID
|
|
724
|
-
*/
|
|
725
|
-
memberId?: string;
|
|
726
|
-
}
|
|
727
|
-
interface BulkInviteAllToProgramRequest {
|
|
728
|
-
/**
|
|
729
|
-
* Program to which bulk add participants.
|
|
730
|
-
* @format GUID
|
|
731
|
-
*/
|
|
732
|
-
programId: string;
|
|
733
|
-
/**
|
|
734
|
-
* Exclude site members.
|
|
735
|
-
* @format GUID
|
|
736
|
-
* @maxSize 100
|
|
737
|
-
*/
|
|
738
|
-
excludeMemberIds?: string[];
|
|
739
|
-
}
|
|
740
|
-
interface BulkInviteAllToProgramResponse {
|
|
741
|
-
/** Bulk action metadata. */
|
|
742
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
743
|
-
}
|
|
744
|
-
interface BulkAddToProgramRequest {
|
|
745
|
-
/**
|
|
746
|
-
* Program to which bulk add participants.
|
|
747
|
-
* @format GUID
|
|
748
|
-
*/
|
|
749
|
-
programId: string;
|
|
750
|
-
/**
|
|
751
|
-
* Site members.
|
|
752
|
-
* @format GUID
|
|
753
|
-
* @minSize 1
|
|
754
|
-
* @maxSize 1000
|
|
755
|
-
*/
|
|
756
|
-
memberIds?: string[];
|
|
757
|
-
/** Return added participants in the response or not. */
|
|
758
|
-
returnEntity?: boolean;
|
|
759
|
-
}
|
|
760
|
-
interface BulkAddToProgramResponse {
|
|
761
|
-
/** Participants created by bulk action */
|
|
762
|
-
results?: BulkAddToProgramResult[];
|
|
763
|
-
/** Bulk action metadata. */
|
|
764
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
765
|
-
}
|
|
766
|
-
interface BulkAddToProgramResult {
|
|
767
|
-
/** Added participant metadata. */
|
|
768
|
-
itemMetadata?: ItemMetadata;
|
|
769
|
-
/** Added participant */
|
|
770
|
-
item?: Participant;
|
|
771
|
-
}
|
|
772
|
-
interface BulkApproveParticipantRequest {
|
|
773
|
-
/**
|
|
774
|
-
* Participants to add
|
|
775
|
-
* @format GUID
|
|
776
|
-
* @maxSize 100
|
|
777
|
-
*/
|
|
778
|
-
participantIds: string[];
|
|
779
|
-
/**
|
|
780
|
-
* program to approve participant
|
|
781
|
-
* @format GUID
|
|
782
|
-
*/
|
|
783
|
-
programId?: string;
|
|
784
|
-
/** Return approved participants in the response or not */
|
|
785
|
-
returnEntity?: boolean;
|
|
786
|
-
}
|
|
787
|
-
interface BulkApproveParticipantResponse {
|
|
788
|
-
/** Participants approved by bulk action */
|
|
789
|
-
results?: BulkApproveParticipantResult[];
|
|
790
|
-
/** Bulk action metadata */
|
|
791
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
792
|
-
}
|
|
793
|
-
interface BulkApproveParticipantResult {
|
|
794
|
-
/** Approved participant metadata */
|
|
795
|
-
itemMetadata?: ItemMetadata;
|
|
796
|
-
/** Approved or existing participant */
|
|
797
|
-
item?: Participant;
|
|
798
|
-
}
|
|
799
|
-
interface ParticipantApproved {
|
|
800
|
-
/**
|
|
801
|
-
* Program ID which participant approved
|
|
802
|
-
* @format GUID
|
|
803
|
-
*/
|
|
804
|
-
programId?: string;
|
|
805
|
-
/**
|
|
806
|
-
* Member ID of participant approved
|
|
807
|
-
* @format GUID
|
|
808
|
-
*/
|
|
809
|
-
memberId?: string;
|
|
810
|
-
}
|
|
811
|
-
interface BulkApproveAllParticipantRequest {
|
|
812
|
-
/**
|
|
813
|
-
* Program to approve all participants.
|
|
814
|
-
* @format GUID
|
|
815
|
-
*/
|
|
816
|
-
programId?: string;
|
|
817
|
-
/**
|
|
818
|
-
* Exclude site members.
|
|
819
|
-
* @format GUID
|
|
820
|
-
* @maxSize 100
|
|
821
|
-
*/
|
|
822
|
-
excludeParticipantIds?: string[];
|
|
823
|
-
}
|
|
824
|
-
interface BulkApproveAllParticipantResponse {
|
|
825
|
-
/**
|
|
826
|
-
* Job id with async process
|
|
827
|
-
* @format GUID
|
|
828
|
-
*/
|
|
829
|
-
jobId?: string;
|
|
830
|
-
}
|
|
831
|
-
interface ExportParticipantsStatsRequest {
|
|
832
|
-
/**
|
|
833
|
-
* program id to export data from
|
|
834
|
-
* @format GUID
|
|
835
|
-
*/
|
|
836
|
-
programId: string;
|
|
837
|
-
}
|
|
838
|
-
interface ExportParticipantsStatsResponse {
|
|
839
|
-
}
|
|
840
|
-
interface ParticipantExportsFinished {
|
|
841
|
-
/**
|
|
842
|
-
* program id from which stats were exported
|
|
843
|
-
* @format GUID
|
|
844
|
-
*/
|
|
845
|
-
programId?: string;
|
|
846
|
-
/**
|
|
847
|
-
* user id of program owner
|
|
848
|
-
* @format GUID
|
|
849
|
-
*/
|
|
850
|
-
userId?: string;
|
|
851
|
-
/**
|
|
852
|
-
* url to download report
|
|
853
|
-
* @format WEB_URL
|
|
854
|
-
*/
|
|
855
|
-
downloadUrl?: string;
|
|
856
|
-
/** days url will be downloadable */
|
|
857
|
-
downloadUrlTtlDays?: number;
|
|
858
|
-
}
|
|
859
|
-
/** @docsIgnore */
|
|
860
|
-
type CreateParticipantApplicationErrors = {
|
|
861
|
-
code?: 'INVALID_PAYMENT_INFO';
|
|
862
|
-
description?: string;
|
|
863
|
-
data?: Record<string, any>;
|
|
864
|
-
};
|
|
865
495
|
|
|
866
496
|
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
867
497
|
getUrl: (context: any) => string;
|
|
@@ -873,31 +503,10 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
|
|
|
873
503
|
__responseType: Q;
|
|
874
504
|
__originalResponseType: R;
|
|
875
505
|
};
|
|
876
|
-
declare function createParticipant(): __PublicMethodMetaInfo<'POST', {}, CreateParticipantRequest$1, CreateParticipantRequest, CreateParticipantResponse$1, CreateParticipantResponse>;
|
|
877
|
-
declare function bulkCreateParticipant(): __PublicMethodMetaInfo<'POST', {}, BulkCreateParticipantRequest$1, BulkCreateParticipantRequest, BulkCreateParticipantResponse$1, BulkCreateParticipantResponse>;
|
|
878
|
-
declare function bulkAddAllToProgram(): __PublicMethodMetaInfo<'POST', {}, BulkAddAllToProgramRequest$1, BulkAddAllToProgramRequest, BulkAddAllToProgramResponse$1, BulkAddAllToProgramResponse>;
|
|
879
|
-
declare function deleteParticipant(): __PublicMethodMetaInfo<'DELETE', {
|
|
880
|
-
participantId: string;
|
|
881
|
-
}, DeleteParticipantRequest$1, DeleteParticipantRequest, DeleteParticipantResponse$1, DeleteParticipantResponse>;
|
|
882
|
-
declare function issueCertificate(): __PublicMethodMetaInfo<'POST', {
|
|
883
|
-
participantId: string;
|
|
884
|
-
}, IssueCertificateRequest$1, IssueCertificateRequest, IssueCertificateResponse$1, IssueCertificateResponse>;
|
|
885
|
-
declare function getCompletionStats(): __PublicMethodMetaInfo<'GET', {
|
|
886
|
-
programId: string;
|
|
887
|
-
}, GetCompletionStatsRequest$1, GetCompletionStatsRequest, GetCompletionStatsResponse$1, GetCompletionStatsResponse>;
|
|
888
|
-
declare function getPremiumStats(): __PublicMethodMetaInfo<'GET', {}, GetPremiumStatsRequest$1, GetPremiumStatsRequest, GetPremiumStatsResponse$1, GetPremiumStatsResponse>;
|
|
889
|
-
declare function getParticipant(): __PublicMethodMetaInfo<'GET', {
|
|
890
|
-
participantId: string;
|
|
891
|
-
}, GetParticipantRequest$1, GetParticipantRequest, GetParticipantResponse$1, GetParticipantResponse>;
|
|
892
|
-
declare function queryParticipants(): __PublicMethodMetaInfo<'POST', {}, QueryParticipantsRequest$1, QueryParticipantsRequest, QueryParticipantsResponse$1, QueryParticipantsResponse>;
|
|
893
|
-
declare function getAccessStatus(): __PublicMethodMetaInfo<'GET', {}, GetAccessStatusRequest$1, GetAccessStatusRequest, GetAccessStatusResponse$1, GetAccessStatusResponse>;
|
|
894
506
|
declare function bulkInviteToProgram(): __PublicMethodMetaInfo<'POST', {}, BulkInviteToProgramRequest$1, BulkInviteToProgramRequest, BulkInviteToProgramResponse$1, BulkInviteToProgramResponse>;
|
|
895
507
|
declare function bulkInviteAllToProgram(): __PublicMethodMetaInfo<'POST', {}, BulkInviteAllToProgramRequest$1, BulkInviteAllToProgramRequest, BulkInviteAllToProgramResponse$1, BulkInviteAllToProgramResponse>;
|
|
896
508
|
declare function bulkAddToProgram(): __PublicMethodMetaInfo<'POST', {}, BulkAddToProgramRequest$1, BulkAddToProgramRequest, BulkAddToProgramResponse$1, BulkAddToProgramResponse>;
|
|
897
509
|
declare function bulkApproveParticipant(): __PublicMethodMetaInfo<'POST', {}, BulkApproveParticipantRequest$1, BulkApproveParticipantRequest, BulkApproveParticipantResponse$1, BulkApproveParticipantResponse>;
|
|
898
510
|
declare function bulkApproveAllParticipant(): __PublicMethodMetaInfo<'POST', {}, BulkApproveAllParticipantRequest$1, BulkApproveAllParticipantRequest, BulkApproveAllParticipantResponse$1, BulkApproveAllParticipantResponse>;
|
|
899
|
-
declare function exportParticipantsStats(): __PublicMethodMetaInfo<'GET', {
|
|
900
|
-
programId: string;
|
|
901
|
-
}, ExportParticipantsStatsRequest$1, ExportParticipantsStatsRequest, ExportParticipantsStatsResponse$1, ExportParticipantsStatsResponse>;
|
|
902
511
|
|
|
903
|
-
export { type ActionEvent as ActionEventOriginal, type ApplicationError as ApplicationErrorOriginal, type
|
|
512
|
+
export { type ActionEvent as ActionEventOriginal, type ApplicationError as ApplicationErrorOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, 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 DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type FreeCouponDetails as FreeCouponDetailsOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ItemMetadata as ItemMetadataOriginal, JoinPath as JoinPathOriginal, type JoinPathWithLiterals as JoinPathWithLiteralsOriginal, type JoinedInfoJoinPathDetailsOneOf as JoinedInfoJoinPathDetailsOneOfOriginal, type JoinedInfo as JoinedInfoOriginal, type Member as MemberOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type PaidPlanDetails as PaidPlanDetailsOriginal, type ParticipantAdded as ParticipantAddedOriginal, type ParticipantApproved as ParticipantApprovedOriginal, type ParticipantInvited as ParticipantInvitedOriginal, type Participant as ParticipantOriginal, type Progress as ProgressOriginal, type RestoreInfo as RestoreInfoOriginal, type SinglePaymentDetails as SinglePaymentDetailsOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, bulkAddToProgram, bulkApproveAllParticipant, bulkApproveParticipant, bulkInviteAllToProgram, bulkInviteToProgram };
|