@connectedxm/admin-sdk 6.14.5 → 6.17.4
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/.openapi-generator/FILES +5 -0
- package/AdminApi.ts +12 -0
- package/README.md +19 -17
- package/api.ts +2642 -2390
- package/dist/AdminApi.d.ts +5 -1
- package/dist/AdminApi.js +4 -0
- package/dist/api.d.ts +1224 -1073
- package/dist/api.js +1935 -1726
- package/dist/esm/AdminApi.d.ts +5 -1
- package/dist/esm/AdminApi.js +5 -1
- package/dist/esm/api.d.ts +1224 -1073
- package/dist/esm/api.js +2018 -1825
- package/docs/BaseSideEffect.md +4 -0
- package/docs/BookingSpace.md +4 -0
- package/docs/BookingSpaceCreateInputs.md +4 -0
- package/docs/BookingSpaceTranslation.md +4 -0
- package/docs/BookingSpaceTranslationUpdateInputs.md +4 -0
- package/docs/BookingSpaceUpdateInputs.md +4 -0
- package/docs/BookingsApi.md +58 -0
- package/docs/EventsPassesAccessesApi.md +313 -0
- package/docs/EventsPassesAddonsApi.md +190 -0
- package/docs/EventsPassesApi.md +77 -1149
- package/docs/EventsPassesFollowupsApi.md +272 -0
- package/docs/EventsPassesResponsesApi.md +326 -0
- package/docs/SideEffect.md +8 -0
- package/docs/SideEffectActionType.md +2 -0
- package/docs/SideEffectTriggerType.md +4 -2
- package/docs/UpdateEventPassResponsesInputs.md +20 -0
- package/package.json +1 -1
package/docs/EventsPassesApi.md
CHANGED
|
@@ -4,93 +4,19 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**addEventPassAddOn**](#addeventpassaddon) | **POST** /events/{eventId}/passes/{passId}/addOns/{addOnId} | Add Event Pass Add On|
|
|
8
7
|
|[**cancelEventPass**](#canceleventpass) | **PUT** /events/{eventId}/passes/{passId}/cancel | Cancel Event Pass|
|
|
9
8
|
|[**checkinEventPass**](#checkineventpass) | **POST** /events/{eventId}/passes/{passId}/checkin | Checkin Event Pass|
|
|
10
9
|
|[**createEventPass**](#createeventpass) | **POST** /events/{eventId}/attendees/{accountId}/passes | Create Event Pass|
|
|
11
|
-
|[**createEventSessionAccess**](#createeventsessionaccess) | **POST** /events/{eventId}/sessions/{sessionId}/passes/{passId} | Create Event Session Access|
|
|
12
10
|
|[**deleteEventPass**](#deleteeventpass) | **DELETE** /events/{eventId}/passes/{passId} | Delete Event Pass|
|
|
13
|
-
|[**deleteEventSessionAccess**](#deleteeventsessionaccess) | **DELETE** /events/{eventId}/sessions/{sessionId}/passes/{passId} | Delete Event Session Access|
|
|
14
11
|
|[**getEventPass**](#geteventpass) | **GET** /events/{eventId}/passes/{passId} | Get Event Pass|
|
|
15
|
-
|[**getEventPassAccesses**](#geteventpassaccesses) | **GET** /events/{eventId}/passes/{passId}/accesses | Get Event Pass Accesses|
|
|
16
|
-
|[**getEventPassAddOns**](#geteventpassaddons) | **GET** /events/{eventId}/passes/{passId}/addOns | Get Event Pass Add Ons|
|
|
17
12
|
|[**getEventPassMatches**](#geteventpassmatches) | **GET** /events/{eventId}/passes/{passId}/matches | Get Event Pass Matches|
|
|
18
13
|
|[**getEventPassPayments**](#geteventpasspayments) | **GET** /events/{eventId}/passes/{passId}/payments | Get Event Pass Payments|
|
|
19
|
-
|[**getEventPassQuestionFollowups**](#geteventpassquestionfollowups) | **GET** /events/{eventId}/attendees/{accountId}/passes/{passId}/followups | Get Event Pass Question Followups|
|
|
20
|
-
|[**getEventPassQuestionSections**](#geteventpassquestionsections) | **GET** /events/{eventId}/attendees/{accountId}/passes/{passId}/sections | Get Event Pass Question Sections|
|
|
21
|
-
|[**getEventPassResponse**](#geteventpassresponse) | **GET** /events/{eventId}/passes/{passId}/responses/{questionId} | Get Event Pass Response|
|
|
22
|
-
|[**getEventPassResponseChanges**](#geteventpassresponsechanges) | **GET** /events/{eventId}/passes/{passId}/responses/{questionId}/changes | Get Event Pass Response Changes|
|
|
23
|
-
|[**getEventPassResponses**](#geteventpassresponses) | **GET** /events/{eventId}/passes/{passId}/responses | Get Event Pass Responses|
|
|
24
14
|
|[**getEventPassTransferLogs**](#geteventpasstransferlogs) | **GET** /events/{eventId}/passes/{passId}/transfers/logs | Get Event Pass Transfer Logs|
|
|
25
15
|
|[**getEventPasses**](#geteventpasses) | **GET** /events/{eventId}/passes | Get Event Passes|
|
|
26
16
|
|[**indexEventPasses**](#indexeventpasses) | **POST** /events/{eventId}/index-passes | Index Event Passes|
|
|
27
|
-
|[**removeEventPassAddOn**](#removeeventpassaddon) | **DELETE** /events/{eventId}/passes/{passId}/addOns/{addOnId} | Remove Event Pass Add On|
|
|
28
17
|
|[**transferEventPass**](#transfereventpass) | **POST** /events/{eventId}/attendees/{accountId}/passes/{passId}/transfers | Transfer Event Pass|
|
|
29
18
|
|[**undoCheckinEventPass**](#undocheckineventpass) | **POST** /events/{eventId}/passes/{passId}/checkin/undo | Undo Checkin Event Pass|
|
|
30
19
|
|[**updateEventPass**](#updateeventpass) | **PUT** /events/{eventId}/passes/{passId} | Update Event Pass|
|
|
31
|
-
|[**updateEventPassFollowupResponses**](#updateeventpassfollowupresponses) | **PUT** /events/{eventId}/attendees/{accountId}/passes/{passId}/followups | Update Event Pass Followup Responses|
|
|
32
|
-
|[**updateEventPassResponse**](#updateeventpassresponse) | **PUT** /events/{eventId}/passes/{passId}/responses/{questionId} | Update Event Pass Response|
|
|
33
|
-
|[**updateEventPassResponses**](#updateeventpassresponses) | **PUT** /events/{eventId}/attendees/{accountId}/passes/{passId}/responses | Update Event Pass Responses|
|
|
34
|
-
|[**updateEventPassSingleFollowupResponses**](#updateeventpasssinglefollowupresponses) | **PUT** /events/{eventId}/attendees/{accountId}/passes/{passId}/followups/{followupId} | Update Event Pass Single Followup Responses|
|
|
35
|
-
|[**updateEventSessionAccess**](#updateeventsessionaccess) | **PUT** /events/{eventId}/sessions/{sessionId}/passes/{passId} | Update Event Session Access|
|
|
36
|
-
|[**updateEventSessionAccessResponses**](#updateeventsessionaccessresponses) | **PUT** /events/{eventId}/sessions/{sessionId}/passes/{passId}/responses | Update Event Session Access Responses|
|
|
37
|
-
|
|
38
|
-
# **addEventPassAddOn**
|
|
39
|
-
> CreateEventPass200Response addEventPassAddOn()
|
|
40
|
-
|
|
41
|
-
Add Event Pass Add On endpoint
|
|
42
|
-
|
|
43
|
-
### Example
|
|
44
|
-
|
|
45
|
-
```typescript
|
|
46
|
-
import {
|
|
47
|
-
EventsPassesApi,
|
|
48
|
-
Configuration
|
|
49
|
-
} from '@connectedxm/admin-sdk';
|
|
50
|
-
|
|
51
|
-
const configuration = new Configuration();
|
|
52
|
-
const apiInstance = new EventsPassesApi(configuration);
|
|
53
|
-
|
|
54
|
-
let eventId: string; //The event identifier (default to undefined)
|
|
55
|
-
let passId: string; //The pass identifier (default to undefined)
|
|
56
|
-
let addOnId: string; //The addOn identifier (default to undefined)
|
|
57
|
-
|
|
58
|
-
const { status, data } = await apiInstance.addEventPassAddOn(
|
|
59
|
-
eventId,
|
|
60
|
-
passId,
|
|
61
|
-
addOnId
|
|
62
|
-
);
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
### Parameters
|
|
66
|
-
|
|
67
|
-
|Name | Type | Description | Notes|
|
|
68
|
-
|------------- | ------------- | ------------- | -------------|
|
|
69
|
-
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
70
|
-
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
71
|
-
| **addOnId** | [**string**] | The addOn identifier | defaults to undefined|
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
### Return type
|
|
75
|
-
|
|
76
|
-
**CreateEventPass200Response**
|
|
77
|
-
|
|
78
|
-
### Authorization
|
|
79
|
-
|
|
80
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
81
|
-
|
|
82
|
-
### HTTP request headers
|
|
83
|
-
|
|
84
|
-
- **Content-Type**: Not defined
|
|
85
|
-
- **Accept**: application/json
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
### HTTP response details
|
|
89
|
-
| Status code | Description | Response headers |
|
|
90
|
-
|-------------|-------------|------------------|
|
|
91
|
-
|**200** | Successful response | - |
|
|
92
|
-
|
|
93
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
94
20
|
|
|
95
21
|
# **cancelEventPass**
|
|
96
22
|
> CreateEventPass200Response cancelEventPass()
|
|
@@ -254,63 +180,6 @@ const { status, data } = await apiInstance.createEventPass(
|
|
|
254
180
|
- **Accept**: application/json
|
|
255
181
|
|
|
256
182
|
|
|
257
|
-
### HTTP response details
|
|
258
|
-
| Status code | Description | Response headers |
|
|
259
|
-
|-------------|-------------|------------------|
|
|
260
|
-
|**200** | Successful response | - |
|
|
261
|
-
|
|
262
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
263
|
-
|
|
264
|
-
# **createEventSessionAccess**
|
|
265
|
-
> GetEventSessionAccess200Response createEventSessionAccess()
|
|
266
|
-
|
|
267
|
-
Create Event Session Access endpoint
|
|
268
|
-
|
|
269
|
-
### Example
|
|
270
|
-
|
|
271
|
-
```typescript
|
|
272
|
-
import {
|
|
273
|
-
EventsPassesApi,
|
|
274
|
-
Configuration
|
|
275
|
-
} from '@connectedxm/admin-sdk';
|
|
276
|
-
|
|
277
|
-
const configuration = new Configuration();
|
|
278
|
-
const apiInstance = new EventsPassesApi(configuration);
|
|
279
|
-
|
|
280
|
-
let eventId: string; //The event identifier (default to undefined)
|
|
281
|
-
let sessionId: string; //The session identifier (default to undefined)
|
|
282
|
-
let passId: string; //The pass identifier (default to undefined)
|
|
283
|
-
|
|
284
|
-
const { status, data } = await apiInstance.createEventSessionAccess(
|
|
285
|
-
eventId,
|
|
286
|
-
sessionId,
|
|
287
|
-
passId
|
|
288
|
-
);
|
|
289
|
-
```
|
|
290
|
-
|
|
291
|
-
### Parameters
|
|
292
|
-
|
|
293
|
-
|Name | Type | Description | Notes|
|
|
294
|
-
|------------- | ------------- | ------------- | -------------|
|
|
295
|
-
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
296
|
-
| **sessionId** | [**string**] | The session identifier | defaults to undefined|
|
|
297
|
-
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
### Return type
|
|
301
|
-
|
|
302
|
-
**GetEventSessionAccess200Response**
|
|
303
|
-
|
|
304
|
-
### Authorization
|
|
305
|
-
|
|
306
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
307
|
-
|
|
308
|
-
### HTTP request headers
|
|
309
|
-
|
|
310
|
-
- **Content-Type**: Not defined
|
|
311
|
-
- **Accept**: application/json
|
|
312
|
-
|
|
313
|
-
|
|
314
183
|
### HTTP response details
|
|
315
184
|
| Status code | Description | Response headers |
|
|
316
185
|
|-------------|-------------|------------------|
|
|
@@ -375,10 +244,10 @@ const { status, data } = await apiInstance.deleteEventPass(
|
|
|
375
244
|
|
|
376
245
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
377
246
|
|
|
378
|
-
# **
|
|
379
|
-
>
|
|
247
|
+
# **getEventPass**
|
|
248
|
+
> CreateEventPass200Response getEventPass()
|
|
380
249
|
|
|
381
|
-
|
|
250
|
+
Get Event Pass endpoint
|
|
382
251
|
|
|
383
252
|
### Example
|
|
384
253
|
|
|
@@ -392,12 +261,10 @@ const configuration = new Configuration();
|
|
|
392
261
|
const apiInstance = new EventsPassesApi(configuration);
|
|
393
262
|
|
|
394
263
|
let eventId: string; //The event identifier (default to undefined)
|
|
395
|
-
let sessionId: string; //The session identifier (default to undefined)
|
|
396
264
|
let passId: string; //The pass identifier (default to undefined)
|
|
397
265
|
|
|
398
|
-
const { status, data } = await apiInstance.
|
|
266
|
+
const { status, data } = await apiInstance.getEventPass(
|
|
399
267
|
eventId,
|
|
400
|
-
sessionId,
|
|
401
268
|
passId
|
|
402
269
|
);
|
|
403
270
|
```
|
|
@@ -407,13 +274,12 @@ const { status, data } = await apiInstance.deleteEventSessionAccess(
|
|
|
407
274
|
|Name | Type | Description | Notes|
|
|
408
275
|
|------------- | ------------- | ------------- | -------------|
|
|
409
276
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
410
|
-
| **sessionId** | [**string**] | The session identifier | defaults to undefined|
|
|
411
277
|
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
412
278
|
|
|
413
279
|
|
|
414
280
|
### Return type
|
|
415
281
|
|
|
416
|
-
**
|
|
282
|
+
**CreateEventPass200Response**
|
|
417
283
|
|
|
418
284
|
### Authorization
|
|
419
285
|
|
|
@@ -432,10 +298,10 @@ const { status, data } = await apiInstance.deleteEventSessionAccess(
|
|
|
432
298
|
|
|
433
299
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
434
300
|
|
|
435
|
-
# **
|
|
436
|
-
>
|
|
301
|
+
# **getEventPassMatches**
|
|
302
|
+
> GetEventPassMatches200Response getEventPassMatches()
|
|
437
303
|
|
|
438
|
-
Get Event Pass endpoint
|
|
304
|
+
Get Event Pass Matches endpoint
|
|
439
305
|
|
|
440
306
|
### Example
|
|
441
307
|
|
|
@@ -450,10 +316,14 @@ const apiInstance = new EventsPassesApi(configuration);
|
|
|
450
316
|
|
|
451
317
|
let eventId: string; //The event identifier (default to undefined)
|
|
452
318
|
let passId: string; //The pass identifier (default to undefined)
|
|
319
|
+
let sessionId: string; //Filter by sessionId (optional) (default to undefined)
|
|
320
|
+
let roundId: string; //Filter by roundId (optional) (default to undefined)
|
|
453
321
|
|
|
454
|
-
const { status, data } = await apiInstance.
|
|
322
|
+
const { status, data } = await apiInstance.getEventPassMatches(
|
|
455
323
|
eventId,
|
|
456
|
-
passId
|
|
324
|
+
passId,
|
|
325
|
+
sessionId,
|
|
326
|
+
roundId
|
|
457
327
|
);
|
|
458
328
|
```
|
|
459
329
|
|
|
@@ -463,11 +333,13 @@ const { status, data } = await apiInstance.getEventPass(
|
|
|
463
333
|
|------------- | ------------- | ------------- | -------------|
|
|
464
334
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
465
335
|
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
336
|
+
| **sessionId** | [**string**] | Filter by sessionId | (optional) defaults to undefined|
|
|
337
|
+
| **roundId** | [**string**] | Filter by roundId | (optional) defaults to undefined|
|
|
466
338
|
|
|
467
339
|
|
|
468
340
|
### Return type
|
|
469
341
|
|
|
470
|
-
**
|
|
342
|
+
**GetEventPassMatches200Response**
|
|
471
343
|
|
|
472
344
|
### Authorization
|
|
473
345
|
|
|
@@ -486,10 +358,10 @@ const { status, data } = await apiInstance.getEventPass(
|
|
|
486
358
|
|
|
487
359
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
488
360
|
|
|
489
|
-
# **
|
|
490
|
-
>
|
|
361
|
+
# **getEventPassPayments**
|
|
362
|
+
> GetAccountPayments200Response getEventPassPayments()
|
|
491
363
|
|
|
492
|
-
Get Event Pass
|
|
364
|
+
Get Event Pass Payments endpoint
|
|
493
365
|
|
|
494
366
|
### Example
|
|
495
367
|
|
|
@@ -509,7 +381,7 @@ let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
|
509
381
|
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
510
382
|
let search: string; //Search query (optional) (default to undefined)
|
|
511
383
|
|
|
512
|
-
const { status, data } = await apiInstance.
|
|
384
|
+
const { status, data } = await apiInstance.getEventPassPayments(
|
|
513
385
|
eventId,
|
|
514
386
|
passId,
|
|
515
387
|
page,
|
|
@@ -533,7 +405,7 @@ const { status, data } = await apiInstance.getEventPassAccesses(
|
|
|
533
405
|
|
|
534
406
|
### Return type
|
|
535
407
|
|
|
536
|
-
**
|
|
408
|
+
**GetAccountPayments200Response**
|
|
537
409
|
|
|
538
410
|
### Authorization
|
|
539
411
|
|
|
@@ -552,10 +424,10 @@ const { status, data } = await apiInstance.getEventPassAccesses(
|
|
|
552
424
|
|
|
553
425
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
554
426
|
|
|
555
|
-
# **
|
|
556
|
-
>
|
|
427
|
+
# **getEventPassTransferLogs**
|
|
428
|
+
> GetEventAttendeeTransfersLogs200Response getEventPassTransferLogs()
|
|
557
429
|
|
|
558
|
-
Get Event Pass
|
|
430
|
+
Get Event Pass Transfer Logs endpoint
|
|
559
431
|
|
|
560
432
|
### Example
|
|
561
433
|
|
|
@@ -575,7 +447,7 @@ let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
|
575
447
|
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
576
448
|
let search: string; //Search query (optional) (default to undefined)
|
|
577
449
|
|
|
578
|
-
const { status, data } = await apiInstance.
|
|
450
|
+
const { status, data } = await apiInstance.getEventPassTransferLogs(
|
|
579
451
|
eventId,
|
|
580
452
|
passId,
|
|
581
453
|
page,
|
|
@@ -599,7 +471,7 @@ const { status, data } = await apiInstance.getEventPassAddOns(
|
|
|
599
471
|
|
|
600
472
|
### Return type
|
|
601
473
|
|
|
602
|
-
**
|
|
474
|
+
**GetEventAttendeeTransfersLogs200Response**
|
|
603
475
|
|
|
604
476
|
### Authorization
|
|
605
477
|
|
|
@@ -618,10 +490,10 @@ const { status, data } = await apiInstance.getEventPassAddOns(
|
|
|
618
490
|
|
|
619
491
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
620
492
|
|
|
621
|
-
# **
|
|
622
|
-
>
|
|
493
|
+
# **getEventPasses**
|
|
494
|
+
> GetEventAddOnPasses200Response getEventPasses()
|
|
623
495
|
|
|
624
|
-
Get Event
|
|
496
|
+
Get Event Passes endpoint
|
|
625
497
|
|
|
626
498
|
### Example
|
|
627
499
|
|
|
@@ -635,15 +507,19 @@ const configuration = new Configuration();
|
|
|
635
507
|
const apiInstance = new EventsPassesApi(configuration);
|
|
636
508
|
|
|
637
509
|
let eventId: string; //The event identifier (default to undefined)
|
|
638
|
-
let
|
|
639
|
-
let
|
|
640
|
-
let
|
|
510
|
+
let checkedIn: boolean; //Filter by checkedIn (optional) (default to undefined)
|
|
511
|
+
let page: number; //Page number (optional) (default to 1)
|
|
512
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
513
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
514
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
641
515
|
|
|
642
|
-
const { status, data } = await apiInstance.
|
|
516
|
+
const { status, data } = await apiInstance.getEventPasses(
|
|
643
517
|
eventId,
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
518
|
+
checkedIn,
|
|
519
|
+
page,
|
|
520
|
+
pageSize,
|
|
521
|
+
orderBy,
|
|
522
|
+
search
|
|
647
523
|
);
|
|
648
524
|
```
|
|
649
525
|
|
|
@@ -652,14 +528,16 @@ const { status, data } = await apiInstance.getEventPassMatches(
|
|
|
652
528
|
|Name | Type | Description | Notes|
|
|
653
529
|
|------------- | ------------- | ------------- | -------------|
|
|
654
530
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
655
|
-
| **
|
|
656
|
-
| **
|
|
657
|
-
| **
|
|
531
|
+
| **checkedIn** | [**boolean**] | Filter by checkedIn | (optional) defaults to undefined|
|
|
532
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
533
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
534
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
535
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
658
536
|
|
|
659
537
|
|
|
660
538
|
### Return type
|
|
661
539
|
|
|
662
|
-
**
|
|
540
|
+
**GetEventAddOnPasses200Response**
|
|
663
541
|
|
|
664
542
|
### Authorization
|
|
665
543
|
|
|
@@ -678,10 +556,10 @@ const { status, data } = await apiInstance.getEventPassMatches(
|
|
|
678
556
|
|
|
679
557
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
680
558
|
|
|
681
|
-
# **
|
|
682
|
-
>
|
|
559
|
+
# **indexEventPasses**
|
|
560
|
+
> IndexEventPasses200Response indexEventPasses()
|
|
683
561
|
|
|
684
|
-
|
|
562
|
+
Index Event Passes endpoint
|
|
685
563
|
|
|
686
564
|
### Example
|
|
687
565
|
|
|
@@ -695,19 +573,9 @@ const configuration = new Configuration();
|
|
|
695
573
|
const apiInstance = new EventsPassesApi(configuration);
|
|
696
574
|
|
|
697
575
|
let eventId: string; //The event identifier (default to undefined)
|
|
698
|
-
let passId: string; //The pass identifier (default to undefined)
|
|
699
|
-
let page: number; //Page number (optional) (default to 1)
|
|
700
|
-
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
701
|
-
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
702
|
-
let search: string; //Search query (optional) (default to undefined)
|
|
703
576
|
|
|
704
|
-
const { status, data } = await apiInstance.
|
|
705
|
-
eventId
|
|
706
|
-
passId,
|
|
707
|
-
page,
|
|
708
|
-
pageSize,
|
|
709
|
-
orderBy,
|
|
710
|
-
search
|
|
577
|
+
const { status, data } = await apiInstance.indexEventPasses(
|
|
578
|
+
eventId
|
|
711
579
|
);
|
|
712
580
|
```
|
|
713
581
|
|
|
@@ -716,16 +584,11 @@ const { status, data } = await apiInstance.getEventPassPayments(
|
|
|
716
584
|
|Name | Type | Description | Notes|
|
|
717
585
|
|------------- | ------------- | ------------- | -------------|
|
|
718
586
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
719
|
-
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
720
|
-
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
721
|
-
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
722
|
-
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
723
|
-
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
724
587
|
|
|
725
588
|
|
|
726
589
|
### Return type
|
|
727
590
|
|
|
728
|
-
**
|
|
591
|
+
**IndexEventPasses200Response**
|
|
729
592
|
|
|
730
593
|
### Authorization
|
|
731
594
|
|
|
@@ -744,10 +607,10 @@ const { status, data } = await apiInstance.getEventPassPayments(
|
|
|
744
607
|
|
|
745
608
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
746
609
|
|
|
747
|
-
# **
|
|
748
|
-
>
|
|
610
|
+
# **transferEventPass**
|
|
611
|
+
> CreateAccountInvitations200Response transferEventPass()
|
|
749
612
|
|
|
750
|
-
|
|
613
|
+
Transfer Event Pass endpoint
|
|
751
614
|
|
|
752
615
|
### Example
|
|
753
616
|
|
|
@@ -763,19 +626,13 @@ const apiInstance = new EventsPassesApi(configuration);
|
|
|
763
626
|
let eventId: string; //The event identifier (default to undefined)
|
|
764
627
|
let accountId: string; //The account identifier (default to undefined)
|
|
765
628
|
let passId: string; //The pass identifier (default to undefined)
|
|
766
|
-
let
|
|
767
|
-
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
768
|
-
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
769
|
-
let search: string; //Search query (optional) (default to undefined)
|
|
629
|
+
let receiverId: string; //Filter by receiverId (default to undefined)
|
|
770
630
|
|
|
771
|
-
const { status, data } = await apiInstance.
|
|
631
|
+
const { status, data } = await apiInstance.transferEventPass(
|
|
772
632
|
eventId,
|
|
773
633
|
accountId,
|
|
774
634
|
passId,
|
|
775
|
-
|
|
776
|
-
pageSize,
|
|
777
|
-
orderBy,
|
|
778
|
-
search
|
|
635
|
+
receiverId
|
|
779
636
|
);
|
|
780
637
|
```
|
|
781
638
|
|
|
@@ -786,15 +643,12 @@ const { status, data } = await apiInstance.getEventPassQuestionFollowups(
|
|
|
786
643
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
787
644
|
| **accountId** | [**string**] | The account identifier | defaults to undefined|
|
|
788
645
|
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
789
|
-
| **
|
|
790
|
-
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
791
|
-
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
792
|
-
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
646
|
+
| **receiverId** | [**string**] | Filter by receiverId | defaults to undefined|
|
|
793
647
|
|
|
794
648
|
|
|
795
649
|
### Return type
|
|
796
650
|
|
|
797
|
-
**
|
|
651
|
+
**CreateAccountInvitations200Response**
|
|
798
652
|
|
|
799
653
|
### Authorization
|
|
800
654
|
|
|
@@ -813,10 +667,10 @@ const { status, data } = await apiInstance.getEventPassQuestionFollowups(
|
|
|
813
667
|
|
|
814
668
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
815
669
|
|
|
816
|
-
# **
|
|
817
|
-
>
|
|
670
|
+
# **undoCheckinEventPass**
|
|
671
|
+
> CreateEventPass200Response undoCheckinEventPass()
|
|
818
672
|
|
|
819
|
-
|
|
673
|
+
Undo Checkin Event Pass endpoint
|
|
820
674
|
|
|
821
675
|
### Example
|
|
822
676
|
|
|
@@ -830,21 +684,11 @@ const configuration = new Configuration();
|
|
|
830
684
|
const apiInstance = new EventsPassesApi(configuration);
|
|
831
685
|
|
|
832
686
|
let eventId: string; //The event identifier (default to undefined)
|
|
833
|
-
let accountId: string; //The account identifier (default to undefined)
|
|
834
687
|
let passId: string; //The pass identifier (default to undefined)
|
|
835
|
-
let page: number; //Page number (optional) (default to 1)
|
|
836
|
-
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
837
|
-
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
838
|
-
let search: string; //Search query (optional) (default to undefined)
|
|
839
688
|
|
|
840
|
-
const { status, data } = await apiInstance.
|
|
689
|
+
const { status, data } = await apiInstance.undoCheckinEventPass(
|
|
841
690
|
eventId,
|
|
842
|
-
|
|
843
|
-
passId,
|
|
844
|
-
page,
|
|
845
|
-
pageSize,
|
|
846
|
-
orderBy,
|
|
847
|
-
search
|
|
691
|
+
passId
|
|
848
692
|
);
|
|
849
693
|
```
|
|
850
694
|
|
|
@@ -853,17 +697,12 @@ const { status, data } = await apiInstance.getEventPassQuestionSections(
|
|
|
853
697
|
|Name | Type | Description | Notes|
|
|
854
698
|
|------------- | ------------- | ------------- | -------------|
|
|
855
699
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
856
|
-
| **accountId** | [**string**] | The account identifier | defaults to undefined|
|
|
857
700
|
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
858
|
-
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
859
|
-
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
860
|
-
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
861
|
-
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
862
701
|
|
|
863
702
|
|
|
864
703
|
### Return type
|
|
865
704
|
|
|
866
|
-
**
|
|
705
|
+
**CreateEventPass200Response**
|
|
867
706
|
|
|
868
707
|
### Authorization
|
|
869
708
|
|
|
@@ -882,17 +721,18 @@ const { status, data } = await apiInstance.getEventPassQuestionSections(
|
|
|
882
721
|
|
|
883
722
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
884
723
|
|
|
885
|
-
# **
|
|
886
|
-
>
|
|
724
|
+
# **updateEventPass**
|
|
725
|
+
> CreateEventPass200Response updateEventPass(eventPassUpdateInputs)
|
|
887
726
|
|
|
888
|
-
|
|
727
|
+
Update Event Pass endpoint
|
|
889
728
|
|
|
890
729
|
### Example
|
|
891
730
|
|
|
892
731
|
```typescript
|
|
893
732
|
import {
|
|
894
733
|
EventsPassesApi,
|
|
895
|
-
Configuration
|
|
734
|
+
Configuration,
|
|
735
|
+
EventPassUpdateInputs
|
|
896
736
|
} from '@connectedxm/admin-sdk';
|
|
897
737
|
|
|
898
738
|
const configuration = new Configuration();
|
|
@@ -900,12 +740,12 @@ const apiInstance = new EventsPassesApi(configuration);
|
|
|
900
740
|
|
|
901
741
|
let eventId: string; //The event identifier (default to undefined)
|
|
902
742
|
let passId: string; //The pass identifier (default to undefined)
|
|
903
|
-
let
|
|
743
|
+
let eventPassUpdateInputs: EventPassUpdateInputs; //
|
|
904
744
|
|
|
905
|
-
const { status, data } = await apiInstance.
|
|
745
|
+
const { status, data } = await apiInstance.updateEventPass(
|
|
906
746
|
eventId,
|
|
907
747
|
passId,
|
|
908
|
-
|
|
748
|
+
eventPassUpdateInputs
|
|
909
749
|
);
|
|
910
750
|
```
|
|
911
751
|
|
|
@@ -913,926 +753,14 @@ const { status, data } = await apiInstance.getEventPassResponse(
|
|
|
913
753
|
|
|
914
754
|
|Name | Type | Description | Notes|
|
|
915
755
|
|------------- | ------------- | ------------- | -------------|
|
|
756
|
+
| **eventPassUpdateInputs** | **EventPassUpdateInputs**| | |
|
|
916
757
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
917
758
|
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
918
|
-
| **questionId** | [**string**] | The question identifier | defaults to undefined|
|
|
919
759
|
|
|
920
760
|
|
|
921
761
|
### Return type
|
|
922
762
|
|
|
923
|
-
**
|
|
924
|
-
|
|
925
|
-
### Authorization
|
|
926
|
-
|
|
927
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
928
|
-
|
|
929
|
-
### HTTP request headers
|
|
930
|
-
|
|
931
|
-
- **Content-Type**: Not defined
|
|
932
|
-
- **Accept**: application/json
|
|
933
|
-
|
|
934
|
-
|
|
935
|
-
### HTTP response details
|
|
936
|
-
| Status code | Description | Response headers |
|
|
937
|
-
|-------------|-------------|------------------|
|
|
938
|
-
|**200** | Successful response | - |
|
|
939
|
-
|
|
940
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
941
|
-
|
|
942
|
-
# **getEventPassResponseChanges**
|
|
943
|
-
> GetEventPassResponseChanges200Response getEventPassResponseChanges()
|
|
944
|
-
|
|
945
|
-
Get Event Pass Response Changes endpoint
|
|
946
|
-
|
|
947
|
-
### Example
|
|
948
|
-
|
|
949
|
-
```typescript
|
|
950
|
-
import {
|
|
951
|
-
EventsPassesApi,
|
|
952
|
-
Configuration
|
|
953
|
-
} from '@connectedxm/admin-sdk';
|
|
954
|
-
|
|
955
|
-
const configuration = new Configuration();
|
|
956
|
-
const apiInstance = new EventsPassesApi(configuration);
|
|
957
|
-
|
|
958
|
-
let eventId: string; //The event identifier (default to undefined)
|
|
959
|
-
let passId: string; //The pass identifier (default to undefined)
|
|
960
|
-
let questionId: string; //The question identifier (default to undefined)
|
|
961
|
-
let page: number; //Page number (optional) (default to 1)
|
|
962
|
-
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
963
|
-
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
964
|
-
let search: string; //Search query (optional) (default to undefined)
|
|
965
|
-
|
|
966
|
-
const { status, data } = await apiInstance.getEventPassResponseChanges(
|
|
967
|
-
eventId,
|
|
968
|
-
passId,
|
|
969
|
-
questionId,
|
|
970
|
-
page,
|
|
971
|
-
pageSize,
|
|
972
|
-
orderBy,
|
|
973
|
-
search
|
|
974
|
-
);
|
|
975
|
-
```
|
|
976
|
-
|
|
977
|
-
### Parameters
|
|
978
|
-
|
|
979
|
-
|Name | Type | Description | Notes|
|
|
980
|
-
|------------- | ------------- | ------------- | -------------|
|
|
981
|
-
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
982
|
-
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
983
|
-
| **questionId** | [**string**] | The question identifier | defaults to undefined|
|
|
984
|
-
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
985
|
-
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
986
|
-
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
987
|
-
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
### Return type
|
|
991
|
-
|
|
992
|
-
**GetEventPassResponseChanges200Response**
|
|
993
|
-
|
|
994
|
-
### Authorization
|
|
995
|
-
|
|
996
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
997
|
-
|
|
998
|
-
### HTTP request headers
|
|
999
|
-
|
|
1000
|
-
- **Content-Type**: Not defined
|
|
1001
|
-
- **Accept**: application/json
|
|
1002
|
-
|
|
1003
|
-
|
|
1004
|
-
### HTTP response details
|
|
1005
|
-
| Status code | Description | Response headers |
|
|
1006
|
-
|-------------|-------------|------------------|
|
|
1007
|
-
|**200** | Successful response | - |
|
|
1008
|
-
|
|
1009
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1010
|
-
|
|
1011
|
-
# **getEventPassResponses**
|
|
1012
|
-
> GetEventPassResponses200Response getEventPassResponses()
|
|
1013
|
-
|
|
1014
|
-
Get Event Pass Responses endpoint
|
|
1015
|
-
|
|
1016
|
-
### Example
|
|
1017
|
-
|
|
1018
|
-
```typescript
|
|
1019
|
-
import {
|
|
1020
|
-
EventsPassesApi,
|
|
1021
|
-
Configuration
|
|
1022
|
-
} from '@connectedxm/admin-sdk';
|
|
1023
|
-
|
|
1024
|
-
const configuration = new Configuration();
|
|
1025
|
-
const apiInstance = new EventsPassesApi(configuration);
|
|
1026
|
-
|
|
1027
|
-
let eventId: string; //The event identifier (default to undefined)
|
|
1028
|
-
let passId: string; //The pass identifier (default to undefined)
|
|
1029
|
-
let page: number; //Page number (optional) (default to 1)
|
|
1030
|
-
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
1031
|
-
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
1032
|
-
let search: string; //Search query (optional) (default to undefined)
|
|
1033
|
-
|
|
1034
|
-
const { status, data } = await apiInstance.getEventPassResponses(
|
|
1035
|
-
eventId,
|
|
1036
|
-
passId,
|
|
1037
|
-
page,
|
|
1038
|
-
pageSize,
|
|
1039
|
-
orderBy,
|
|
1040
|
-
search
|
|
1041
|
-
);
|
|
1042
|
-
```
|
|
1043
|
-
|
|
1044
|
-
### Parameters
|
|
1045
|
-
|
|
1046
|
-
|Name | Type | Description | Notes|
|
|
1047
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1048
|
-
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
1049
|
-
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
1050
|
-
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
1051
|
-
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
1052
|
-
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
1053
|
-
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
1054
|
-
|
|
1055
|
-
|
|
1056
|
-
### Return type
|
|
1057
|
-
|
|
1058
|
-
**GetEventPassResponses200Response**
|
|
1059
|
-
|
|
1060
|
-
### Authorization
|
|
1061
|
-
|
|
1062
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1063
|
-
|
|
1064
|
-
### HTTP request headers
|
|
1065
|
-
|
|
1066
|
-
- **Content-Type**: Not defined
|
|
1067
|
-
- **Accept**: application/json
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
### HTTP response details
|
|
1071
|
-
| Status code | Description | Response headers |
|
|
1072
|
-
|-------------|-------------|------------------|
|
|
1073
|
-
|**200** | Successful response | - |
|
|
1074
|
-
|
|
1075
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1076
|
-
|
|
1077
|
-
# **getEventPassTransferLogs**
|
|
1078
|
-
> GetEventAttendeeTransfersLogs200Response getEventPassTransferLogs()
|
|
1079
|
-
|
|
1080
|
-
Get Event Pass Transfer Logs endpoint
|
|
1081
|
-
|
|
1082
|
-
### Example
|
|
1083
|
-
|
|
1084
|
-
```typescript
|
|
1085
|
-
import {
|
|
1086
|
-
EventsPassesApi,
|
|
1087
|
-
Configuration
|
|
1088
|
-
} from '@connectedxm/admin-sdk';
|
|
1089
|
-
|
|
1090
|
-
const configuration = new Configuration();
|
|
1091
|
-
const apiInstance = new EventsPassesApi(configuration);
|
|
1092
|
-
|
|
1093
|
-
let eventId: string; //The event identifier (default to undefined)
|
|
1094
|
-
let passId: string; //The pass identifier (default to undefined)
|
|
1095
|
-
let page: number; //Page number (optional) (default to 1)
|
|
1096
|
-
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
1097
|
-
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
1098
|
-
let search: string; //Search query (optional) (default to undefined)
|
|
1099
|
-
|
|
1100
|
-
const { status, data } = await apiInstance.getEventPassTransferLogs(
|
|
1101
|
-
eventId,
|
|
1102
|
-
passId,
|
|
1103
|
-
page,
|
|
1104
|
-
pageSize,
|
|
1105
|
-
orderBy,
|
|
1106
|
-
search
|
|
1107
|
-
);
|
|
1108
|
-
```
|
|
1109
|
-
|
|
1110
|
-
### Parameters
|
|
1111
|
-
|
|
1112
|
-
|Name | Type | Description | Notes|
|
|
1113
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1114
|
-
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
1115
|
-
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
1116
|
-
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
1117
|
-
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
1118
|
-
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
1119
|
-
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
1120
|
-
|
|
1121
|
-
|
|
1122
|
-
### Return type
|
|
1123
|
-
|
|
1124
|
-
**GetEventAttendeeTransfersLogs200Response**
|
|
1125
|
-
|
|
1126
|
-
### Authorization
|
|
1127
|
-
|
|
1128
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1129
|
-
|
|
1130
|
-
### HTTP request headers
|
|
1131
|
-
|
|
1132
|
-
- **Content-Type**: Not defined
|
|
1133
|
-
- **Accept**: application/json
|
|
1134
|
-
|
|
1135
|
-
|
|
1136
|
-
### HTTP response details
|
|
1137
|
-
| Status code | Description | Response headers |
|
|
1138
|
-
|-------------|-------------|------------------|
|
|
1139
|
-
|**200** | Successful response | - |
|
|
1140
|
-
|
|
1141
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1142
|
-
|
|
1143
|
-
# **getEventPasses**
|
|
1144
|
-
> GetEventAddOnPasses200Response getEventPasses()
|
|
1145
|
-
|
|
1146
|
-
Get Event Passes endpoint
|
|
1147
|
-
|
|
1148
|
-
### Example
|
|
1149
|
-
|
|
1150
|
-
```typescript
|
|
1151
|
-
import {
|
|
1152
|
-
EventsPassesApi,
|
|
1153
|
-
Configuration
|
|
1154
|
-
} from '@connectedxm/admin-sdk';
|
|
1155
|
-
|
|
1156
|
-
const configuration = new Configuration();
|
|
1157
|
-
const apiInstance = new EventsPassesApi(configuration);
|
|
1158
|
-
|
|
1159
|
-
let eventId: string; //The event identifier (default to undefined)
|
|
1160
|
-
let checkedIn: boolean; //Filter by checkedIn (optional) (default to undefined)
|
|
1161
|
-
let page: number; //Page number (optional) (default to 1)
|
|
1162
|
-
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
1163
|
-
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
1164
|
-
let search: string; //Search query (optional) (default to undefined)
|
|
1165
|
-
|
|
1166
|
-
const { status, data } = await apiInstance.getEventPasses(
|
|
1167
|
-
eventId,
|
|
1168
|
-
checkedIn,
|
|
1169
|
-
page,
|
|
1170
|
-
pageSize,
|
|
1171
|
-
orderBy,
|
|
1172
|
-
search
|
|
1173
|
-
);
|
|
1174
|
-
```
|
|
1175
|
-
|
|
1176
|
-
### Parameters
|
|
1177
|
-
|
|
1178
|
-
|Name | Type | Description | Notes|
|
|
1179
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1180
|
-
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
1181
|
-
| **checkedIn** | [**boolean**] | Filter by checkedIn | (optional) defaults to undefined|
|
|
1182
|
-
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
1183
|
-
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
1184
|
-
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
1185
|
-
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
1186
|
-
|
|
1187
|
-
|
|
1188
|
-
### Return type
|
|
1189
|
-
|
|
1190
|
-
**GetEventAddOnPasses200Response**
|
|
1191
|
-
|
|
1192
|
-
### Authorization
|
|
1193
|
-
|
|
1194
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1195
|
-
|
|
1196
|
-
### HTTP request headers
|
|
1197
|
-
|
|
1198
|
-
- **Content-Type**: Not defined
|
|
1199
|
-
- **Accept**: application/json
|
|
1200
|
-
|
|
1201
|
-
|
|
1202
|
-
### HTTP response details
|
|
1203
|
-
| Status code | Description | Response headers |
|
|
1204
|
-
|-------------|-------------|------------------|
|
|
1205
|
-
|**200** | Successful response | - |
|
|
1206
|
-
|
|
1207
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1208
|
-
|
|
1209
|
-
# **indexEventPasses**
|
|
1210
|
-
> IndexEventPasses200Response indexEventPasses()
|
|
1211
|
-
|
|
1212
|
-
Index Event Passes endpoint
|
|
1213
|
-
|
|
1214
|
-
### Example
|
|
1215
|
-
|
|
1216
|
-
```typescript
|
|
1217
|
-
import {
|
|
1218
|
-
EventsPassesApi,
|
|
1219
|
-
Configuration
|
|
1220
|
-
} from '@connectedxm/admin-sdk';
|
|
1221
|
-
|
|
1222
|
-
const configuration = new Configuration();
|
|
1223
|
-
const apiInstance = new EventsPassesApi(configuration);
|
|
1224
|
-
|
|
1225
|
-
let eventId: string; //The event identifier (default to undefined)
|
|
1226
|
-
|
|
1227
|
-
const { status, data } = await apiInstance.indexEventPasses(
|
|
1228
|
-
eventId
|
|
1229
|
-
);
|
|
1230
|
-
```
|
|
1231
|
-
|
|
1232
|
-
### Parameters
|
|
1233
|
-
|
|
1234
|
-
|Name | Type | Description | Notes|
|
|
1235
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1236
|
-
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
1237
|
-
|
|
1238
|
-
|
|
1239
|
-
### Return type
|
|
1240
|
-
|
|
1241
|
-
**IndexEventPasses200Response**
|
|
1242
|
-
|
|
1243
|
-
### Authorization
|
|
1244
|
-
|
|
1245
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1246
|
-
|
|
1247
|
-
### HTTP request headers
|
|
1248
|
-
|
|
1249
|
-
- **Content-Type**: Not defined
|
|
1250
|
-
- **Accept**: application/json
|
|
1251
|
-
|
|
1252
|
-
|
|
1253
|
-
### HTTP response details
|
|
1254
|
-
| Status code | Description | Response headers |
|
|
1255
|
-
|-------------|-------------|------------------|
|
|
1256
|
-
|**200** | Successful response | - |
|
|
1257
|
-
|
|
1258
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1259
|
-
|
|
1260
|
-
# **removeEventPassAddOn**
|
|
1261
|
-
> CreateEventPass200Response removeEventPassAddOn()
|
|
1262
|
-
|
|
1263
|
-
Remove Event Pass Add On endpoint
|
|
1264
|
-
|
|
1265
|
-
### Example
|
|
1266
|
-
|
|
1267
|
-
```typescript
|
|
1268
|
-
import {
|
|
1269
|
-
EventsPassesApi,
|
|
1270
|
-
Configuration
|
|
1271
|
-
} from '@connectedxm/admin-sdk';
|
|
1272
|
-
|
|
1273
|
-
const configuration = new Configuration();
|
|
1274
|
-
const apiInstance = new EventsPassesApi(configuration);
|
|
1275
|
-
|
|
1276
|
-
let eventId: string; //The event identifier (default to undefined)
|
|
1277
|
-
let passId: string; //The pass identifier (default to undefined)
|
|
1278
|
-
let addOnId: string; //The addOn identifier (default to undefined)
|
|
1279
|
-
|
|
1280
|
-
const { status, data } = await apiInstance.removeEventPassAddOn(
|
|
1281
|
-
eventId,
|
|
1282
|
-
passId,
|
|
1283
|
-
addOnId
|
|
1284
|
-
);
|
|
1285
|
-
```
|
|
1286
|
-
|
|
1287
|
-
### Parameters
|
|
1288
|
-
|
|
1289
|
-
|Name | Type | Description | Notes|
|
|
1290
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1291
|
-
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
1292
|
-
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
1293
|
-
| **addOnId** | [**string**] | The addOn identifier | defaults to undefined|
|
|
1294
|
-
|
|
1295
|
-
|
|
1296
|
-
### Return type
|
|
1297
|
-
|
|
1298
|
-
**CreateEventPass200Response**
|
|
1299
|
-
|
|
1300
|
-
### Authorization
|
|
1301
|
-
|
|
1302
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1303
|
-
|
|
1304
|
-
### HTTP request headers
|
|
1305
|
-
|
|
1306
|
-
- **Content-Type**: Not defined
|
|
1307
|
-
- **Accept**: application/json
|
|
1308
|
-
|
|
1309
|
-
|
|
1310
|
-
### HTTP response details
|
|
1311
|
-
| Status code | Description | Response headers |
|
|
1312
|
-
|-------------|-------------|------------------|
|
|
1313
|
-
|**200** | Successful response | - |
|
|
1314
|
-
|
|
1315
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1316
|
-
|
|
1317
|
-
# **transferEventPass**
|
|
1318
|
-
> CreateAccountInvitations200Response transferEventPass()
|
|
1319
|
-
|
|
1320
|
-
Transfer Event Pass endpoint
|
|
1321
|
-
|
|
1322
|
-
### Example
|
|
1323
|
-
|
|
1324
|
-
```typescript
|
|
1325
|
-
import {
|
|
1326
|
-
EventsPassesApi,
|
|
1327
|
-
Configuration
|
|
1328
|
-
} from '@connectedxm/admin-sdk';
|
|
1329
|
-
|
|
1330
|
-
const configuration = new Configuration();
|
|
1331
|
-
const apiInstance = new EventsPassesApi(configuration);
|
|
1332
|
-
|
|
1333
|
-
let eventId: string; //The event identifier (default to undefined)
|
|
1334
|
-
let accountId: string; //The account identifier (default to undefined)
|
|
1335
|
-
let passId: string; //The pass identifier (default to undefined)
|
|
1336
|
-
let receiverId: string; //Filter by receiverId (default to undefined)
|
|
1337
|
-
|
|
1338
|
-
const { status, data } = await apiInstance.transferEventPass(
|
|
1339
|
-
eventId,
|
|
1340
|
-
accountId,
|
|
1341
|
-
passId,
|
|
1342
|
-
receiverId
|
|
1343
|
-
);
|
|
1344
|
-
```
|
|
1345
|
-
|
|
1346
|
-
### Parameters
|
|
1347
|
-
|
|
1348
|
-
|Name | Type | Description | Notes|
|
|
1349
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1350
|
-
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
1351
|
-
| **accountId** | [**string**] | The account identifier | defaults to undefined|
|
|
1352
|
-
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
1353
|
-
| **receiverId** | [**string**] | Filter by receiverId | defaults to undefined|
|
|
1354
|
-
|
|
1355
|
-
|
|
1356
|
-
### Return type
|
|
1357
|
-
|
|
1358
|
-
**CreateAccountInvitations200Response**
|
|
1359
|
-
|
|
1360
|
-
### Authorization
|
|
1361
|
-
|
|
1362
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1363
|
-
|
|
1364
|
-
### HTTP request headers
|
|
1365
|
-
|
|
1366
|
-
- **Content-Type**: Not defined
|
|
1367
|
-
- **Accept**: application/json
|
|
1368
|
-
|
|
1369
|
-
|
|
1370
|
-
### HTTP response details
|
|
1371
|
-
| Status code | Description | Response headers |
|
|
1372
|
-
|-------------|-------------|------------------|
|
|
1373
|
-
|**200** | Successful response | - |
|
|
1374
|
-
|
|
1375
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1376
|
-
|
|
1377
|
-
# **undoCheckinEventPass**
|
|
1378
|
-
> CreateEventPass200Response undoCheckinEventPass()
|
|
1379
|
-
|
|
1380
|
-
Undo Checkin Event Pass endpoint
|
|
1381
|
-
|
|
1382
|
-
### Example
|
|
1383
|
-
|
|
1384
|
-
```typescript
|
|
1385
|
-
import {
|
|
1386
|
-
EventsPassesApi,
|
|
1387
|
-
Configuration
|
|
1388
|
-
} from '@connectedxm/admin-sdk';
|
|
1389
|
-
|
|
1390
|
-
const configuration = new Configuration();
|
|
1391
|
-
const apiInstance = new EventsPassesApi(configuration);
|
|
1392
|
-
|
|
1393
|
-
let eventId: string; //The event identifier (default to undefined)
|
|
1394
|
-
let passId: string; //The pass identifier (default to undefined)
|
|
1395
|
-
|
|
1396
|
-
const { status, data } = await apiInstance.undoCheckinEventPass(
|
|
1397
|
-
eventId,
|
|
1398
|
-
passId
|
|
1399
|
-
);
|
|
1400
|
-
```
|
|
1401
|
-
|
|
1402
|
-
### Parameters
|
|
1403
|
-
|
|
1404
|
-
|Name | Type | Description | Notes|
|
|
1405
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1406
|
-
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
1407
|
-
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
1408
|
-
|
|
1409
|
-
|
|
1410
|
-
### Return type
|
|
1411
|
-
|
|
1412
|
-
**CreateEventPass200Response**
|
|
1413
|
-
|
|
1414
|
-
### Authorization
|
|
1415
|
-
|
|
1416
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1417
|
-
|
|
1418
|
-
### HTTP request headers
|
|
1419
|
-
|
|
1420
|
-
- **Content-Type**: Not defined
|
|
1421
|
-
- **Accept**: application/json
|
|
1422
|
-
|
|
1423
|
-
|
|
1424
|
-
### HTTP response details
|
|
1425
|
-
| Status code | Description | Response headers |
|
|
1426
|
-
|-------------|-------------|------------------|
|
|
1427
|
-
|**200** | Successful response | - |
|
|
1428
|
-
|
|
1429
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1430
|
-
|
|
1431
|
-
# **updateEventPass**
|
|
1432
|
-
> CreateEventPass200Response updateEventPass(eventPassUpdateInputs)
|
|
1433
|
-
|
|
1434
|
-
Update Event Pass endpoint
|
|
1435
|
-
|
|
1436
|
-
### Example
|
|
1437
|
-
|
|
1438
|
-
```typescript
|
|
1439
|
-
import {
|
|
1440
|
-
EventsPassesApi,
|
|
1441
|
-
Configuration,
|
|
1442
|
-
EventPassUpdateInputs
|
|
1443
|
-
} from '@connectedxm/admin-sdk';
|
|
1444
|
-
|
|
1445
|
-
const configuration = new Configuration();
|
|
1446
|
-
const apiInstance = new EventsPassesApi(configuration);
|
|
1447
|
-
|
|
1448
|
-
let eventId: string; //The event identifier (default to undefined)
|
|
1449
|
-
let passId: string; //The pass identifier (default to undefined)
|
|
1450
|
-
let eventPassUpdateInputs: EventPassUpdateInputs; //
|
|
1451
|
-
|
|
1452
|
-
const { status, data } = await apiInstance.updateEventPass(
|
|
1453
|
-
eventId,
|
|
1454
|
-
passId,
|
|
1455
|
-
eventPassUpdateInputs
|
|
1456
|
-
);
|
|
1457
|
-
```
|
|
1458
|
-
|
|
1459
|
-
### Parameters
|
|
1460
|
-
|
|
1461
|
-
|Name | Type | Description | Notes|
|
|
1462
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1463
|
-
| **eventPassUpdateInputs** | **EventPassUpdateInputs**| | |
|
|
1464
|
-
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
1465
|
-
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
1466
|
-
|
|
1467
|
-
|
|
1468
|
-
### Return type
|
|
1469
|
-
|
|
1470
|
-
**CreateEventPass200Response**
|
|
1471
|
-
|
|
1472
|
-
### Authorization
|
|
1473
|
-
|
|
1474
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1475
|
-
|
|
1476
|
-
### HTTP request headers
|
|
1477
|
-
|
|
1478
|
-
- **Content-Type**: application/json
|
|
1479
|
-
- **Accept**: application/json
|
|
1480
|
-
|
|
1481
|
-
|
|
1482
|
-
### HTTP response details
|
|
1483
|
-
| Status code | Description | Response headers |
|
|
1484
|
-
|-------------|-------------|------------------|
|
|
1485
|
-
|**200** | Successful response | - |
|
|
1486
|
-
|
|
1487
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1488
|
-
|
|
1489
|
-
# **updateEventPassFollowupResponses**
|
|
1490
|
-
> CreateAccountInvitations200Response updateEventPassFollowupResponses()
|
|
1491
|
-
|
|
1492
|
-
Update Event Pass Followup Responses endpoint
|
|
1493
|
-
|
|
1494
|
-
### Example
|
|
1495
|
-
|
|
1496
|
-
```typescript
|
|
1497
|
-
import {
|
|
1498
|
-
EventsPassesApi,
|
|
1499
|
-
Configuration
|
|
1500
|
-
} from '@connectedxm/admin-sdk';
|
|
1501
|
-
|
|
1502
|
-
const configuration = new Configuration();
|
|
1503
|
-
const apiInstance = new EventsPassesApi(configuration);
|
|
1504
|
-
|
|
1505
|
-
let eventId: string; //The event identifier (default to undefined)
|
|
1506
|
-
let accountId: string; //The account identifier (default to undefined)
|
|
1507
|
-
let passId: string; //The pass identifier (default to undefined)
|
|
1508
|
-
let questions: Array<Question>; //Filter by questions (default to undefined)
|
|
1509
|
-
|
|
1510
|
-
const { status, data } = await apiInstance.updateEventPassFollowupResponses(
|
|
1511
|
-
eventId,
|
|
1512
|
-
accountId,
|
|
1513
|
-
passId,
|
|
1514
|
-
questions
|
|
1515
|
-
);
|
|
1516
|
-
```
|
|
1517
|
-
|
|
1518
|
-
### Parameters
|
|
1519
|
-
|
|
1520
|
-
|Name | Type | Description | Notes|
|
|
1521
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1522
|
-
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
1523
|
-
| **accountId** | [**string**] | The account identifier | defaults to undefined|
|
|
1524
|
-
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
1525
|
-
| **questions** | **Array<Question>** | Filter by questions | defaults to undefined|
|
|
1526
|
-
|
|
1527
|
-
|
|
1528
|
-
### Return type
|
|
1529
|
-
|
|
1530
|
-
**CreateAccountInvitations200Response**
|
|
1531
|
-
|
|
1532
|
-
### Authorization
|
|
1533
|
-
|
|
1534
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1535
|
-
|
|
1536
|
-
### HTTP request headers
|
|
1537
|
-
|
|
1538
|
-
- **Content-Type**: Not defined
|
|
1539
|
-
- **Accept**: application/json
|
|
1540
|
-
|
|
1541
|
-
|
|
1542
|
-
### HTTP response details
|
|
1543
|
-
| Status code | Description | Response headers |
|
|
1544
|
-
|-------------|-------------|------------------|
|
|
1545
|
-
|**200** | Successful response | - |
|
|
1546
|
-
|
|
1547
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1548
|
-
|
|
1549
|
-
# **updateEventPassResponse**
|
|
1550
|
-
> GetEventPassResponse200Response updateEventPassResponse(updateEventPassResponseInputs)
|
|
1551
|
-
|
|
1552
|
-
Update Event Pass Response endpoint
|
|
1553
|
-
|
|
1554
|
-
### Example
|
|
1555
|
-
|
|
1556
|
-
```typescript
|
|
1557
|
-
import {
|
|
1558
|
-
EventsPassesApi,
|
|
1559
|
-
Configuration,
|
|
1560
|
-
UpdateEventPassResponseInputs
|
|
1561
|
-
} from '@connectedxm/admin-sdk';
|
|
1562
|
-
|
|
1563
|
-
const configuration = new Configuration();
|
|
1564
|
-
const apiInstance = new EventsPassesApi(configuration);
|
|
1565
|
-
|
|
1566
|
-
let eventId: string; //The event identifier (default to undefined)
|
|
1567
|
-
let passId: string; //The pass identifier (default to undefined)
|
|
1568
|
-
let questionId: string; //The question identifier (default to undefined)
|
|
1569
|
-
let updateEventPassResponseInputs: UpdateEventPassResponseInputs; //
|
|
1570
|
-
|
|
1571
|
-
const { status, data } = await apiInstance.updateEventPassResponse(
|
|
1572
|
-
eventId,
|
|
1573
|
-
passId,
|
|
1574
|
-
questionId,
|
|
1575
|
-
updateEventPassResponseInputs
|
|
1576
|
-
);
|
|
1577
|
-
```
|
|
1578
|
-
|
|
1579
|
-
### Parameters
|
|
1580
|
-
|
|
1581
|
-
|Name | Type | Description | Notes|
|
|
1582
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1583
|
-
| **updateEventPassResponseInputs** | **UpdateEventPassResponseInputs**| | |
|
|
1584
|
-
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
1585
|
-
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
1586
|
-
| **questionId** | [**string**] | The question identifier | defaults to undefined|
|
|
1587
|
-
|
|
1588
|
-
|
|
1589
|
-
### Return type
|
|
1590
|
-
|
|
1591
|
-
**GetEventPassResponse200Response**
|
|
1592
|
-
|
|
1593
|
-
### Authorization
|
|
1594
|
-
|
|
1595
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1596
|
-
|
|
1597
|
-
### HTTP request headers
|
|
1598
|
-
|
|
1599
|
-
- **Content-Type**: application/json
|
|
1600
|
-
- **Accept**: application/json
|
|
1601
|
-
|
|
1602
|
-
|
|
1603
|
-
### HTTP response details
|
|
1604
|
-
| Status code | Description | Response headers |
|
|
1605
|
-
|-------------|-------------|------------------|
|
|
1606
|
-
|**200** | Successful response | - |
|
|
1607
|
-
|
|
1608
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1609
|
-
|
|
1610
|
-
# **updateEventPassResponses**
|
|
1611
|
-
> CreateAccountInvitations200Response updateEventPassResponses()
|
|
1612
|
-
|
|
1613
|
-
Update Event Pass Responses endpoint
|
|
1614
|
-
|
|
1615
|
-
### Example
|
|
1616
|
-
|
|
1617
|
-
```typescript
|
|
1618
|
-
import {
|
|
1619
|
-
EventsPassesApi,
|
|
1620
|
-
Configuration
|
|
1621
|
-
} from '@connectedxm/admin-sdk';
|
|
1622
|
-
|
|
1623
|
-
const configuration = new Configuration();
|
|
1624
|
-
const apiInstance = new EventsPassesApi(configuration);
|
|
1625
|
-
|
|
1626
|
-
let eventId: string; //The event identifier (default to undefined)
|
|
1627
|
-
let accountId: string; //The account identifier (default to undefined)
|
|
1628
|
-
let passId: string; //The pass identifier (default to undefined)
|
|
1629
|
-
let questions: Array<Question>; //Filter by questions (default to undefined)
|
|
1630
|
-
|
|
1631
|
-
const { status, data } = await apiInstance.updateEventPassResponses(
|
|
1632
|
-
eventId,
|
|
1633
|
-
accountId,
|
|
1634
|
-
passId,
|
|
1635
|
-
questions
|
|
1636
|
-
);
|
|
1637
|
-
```
|
|
1638
|
-
|
|
1639
|
-
### Parameters
|
|
1640
|
-
|
|
1641
|
-
|Name | Type | Description | Notes|
|
|
1642
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1643
|
-
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
1644
|
-
| **accountId** | [**string**] | The account identifier | defaults to undefined|
|
|
1645
|
-
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
1646
|
-
| **questions** | **Array<Question>** | Filter by questions | defaults to undefined|
|
|
1647
|
-
|
|
1648
|
-
|
|
1649
|
-
### Return type
|
|
1650
|
-
|
|
1651
|
-
**CreateAccountInvitations200Response**
|
|
1652
|
-
|
|
1653
|
-
### Authorization
|
|
1654
|
-
|
|
1655
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1656
|
-
|
|
1657
|
-
### HTTP request headers
|
|
1658
|
-
|
|
1659
|
-
- **Content-Type**: Not defined
|
|
1660
|
-
- **Accept**: application/json
|
|
1661
|
-
|
|
1662
|
-
|
|
1663
|
-
### HTTP response details
|
|
1664
|
-
| Status code | Description | Response headers |
|
|
1665
|
-
|-------------|-------------|------------------|
|
|
1666
|
-
|**200** | Successful response | - |
|
|
1667
|
-
|
|
1668
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1669
|
-
|
|
1670
|
-
# **updateEventPassSingleFollowupResponses**
|
|
1671
|
-
> CreateAccountInvitations200Response updateEventPassSingleFollowupResponses()
|
|
1672
|
-
|
|
1673
|
-
Update Event Pass Single Followup Responses endpoint
|
|
1674
|
-
|
|
1675
|
-
### Example
|
|
1676
|
-
|
|
1677
|
-
```typescript
|
|
1678
|
-
import {
|
|
1679
|
-
EventsPassesApi,
|
|
1680
|
-
Configuration
|
|
1681
|
-
} from '@connectedxm/admin-sdk';
|
|
1682
|
-
|
|
1683
|
-
const configuration = new Configuration();
|
|
1684
|
-
const apiInstance = new EventsPassesApi(configuration);
|
|
1685
|
-
|
|
1686
|
-
let eventId: string; //The event identifier (default to undefined)
|
|
1687
|
-
let accountId: string; //The account identifier (default to undefined)
|
|
1688
|
-
let passId: string; //The pass identifier (default to undefined)
|
|
1689
|
-
let followupId: string; //The followup identifier (default to undefined)
|
|
1690
|
-
let questions: Array<Question>; //Filter by questions (default to undefined)
|
|
1691
|
-
|
|
1692
|
-
const { status, data } = await apiInstance.updateEventPassSingleFollowupResponses(
|
|
1693
|
-
eventId,
|
|
1694
|
-
accountId,
|
|
1695
|
-
passId,
|
|
1696
|
-
followupId,
|
|
1697
|
-
questions
|
|
1698
|
-
);
|
|
1699
|
-
```
|
|
1700
|
-
|
|
1701
|
-
### Parameters
|
|
1702
|
-
|
|
1703
|
-
|Name | Type | Description | Notes|
|
|
1704
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1705
|
-
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
1706
|
-
| **accountId** | [**string**] | The account identifier | defaults to undefined|
|
|
1707
|
-
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
1708
|
-
| **followupId** | [**string**] | The followup identifier | defaults to undefined|
|
|
1709
|
-
| **questions** | **Array<Question>** | Filter by questions | defaults to undefined|
|
|
1710
|
-
|
|
1711
|
-
|
|
1712
|
-
### Return type
|
|
1713
|
-
|
|
1714
|
-
**CreateAccountInvitations200Response**
|
|
1715
|
-
|
|
1716
|
-
### Authorization
|
|
1717
|
-
|
|
1718
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1719
|
-
|
|
1720
|
-
### HTTP request headers
|
|
1721
|
-
|
|
1722
|
-
- **Content-Type**: Not defined
|
|
1723
|
-
- **Accept**: application/json
|
|
1724
|
-
|
|
1725
|
-
|
|
1726
|
-
### HTTP response details
|
|
1727
|
-
| Status code | Description | Response headers |
|
|
1728
|
-
|-------------|-------------|------------------|
|
|
1729
|
-
|**200** | Successful response | - |
|
|
1730
|
-
|
|
1731
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1732
|
-
|
|
1733
|
-
# **updateEventSessionAccess**
|
|
1734
|
-
> GetEventSessionAccess200Response updateEventSessionAccess(eventSessionAccessUpdateInputs)
|
|
1735
|
-
|
|
1736
|
-
Update Event Session Access endpoint
|
|
1737
|
-
|
|
1738
|
-
### Example
|
|
1739
|
-
|
|
1740
|
-
```typescript
|
|
1741
|
-
import {
|
|
1742
|
-
EventsPassesApi,
|
|
1743
|
-
Configuration,
|
|
1744
|
-
EventSessionAccessUpdateInputs
|
|
1745
|
-
} from '@connectedxm/admin-sdk';
|
|
1746
|
-
|
|
1747
|
-
const configuration = new Configuration();
|
|
1748
|
-
const apiInstance = new EventsPassesApi(configuration);
|
|
1749
|
-
|
|
1750
|
-
let eventId: string; //The event identifier (default to undefined)
|
|
1751
|
-
let sessionId: string; //The session identifier (default to undefined)
|
|
1752
|
-
let passId: string; //The pass identifier (default to undefined)
|
|
1753
|
-
let eventSessionAccessUpdateInputs: EventSessionAccessUpdateInputs; //
|
|
1754
|
-
|
|
1755
|
-
const { status, data } = await apiInstance.updateEventSessionAccess(
|
|
1756
|
-
eventId,
|
|
1757
|
-
sessionId,
|
|
1758
|
-
passId,
|
|
1759
|
-
eventSessionAccessUpdateInputs
|
|
1760
|
-
);
|
|
1761
|
-
```
|
|
1762
|
-
|
|
1763
|
-
### Parameters
|
|
1764
|
-
|
|
1765
|
-
|Name | Type | Description | Notes|
|
|
1766
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1767
|
-
| **eventSessionAccessUpdateInputs** | **EventSessionAccessUpdateInputs**| | |
|
|
1768
|
-
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
1769
|
-
| **sessionId** | [**string**] | The session identifier | defaults to undefined|
|
|
1770
|
-
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
1771
|
-
|
|
1772
|
-
|
|
1773
|
-
### Return type
|
|
1774
|
-
|
|
1775
|
-
**GetEventSessionAccess200Response**
|
|
1776
|
-
|
|
1777
|
-
### Authorization
|
|
1778
|
-
|
|
1779
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1780
|
-
|
|
1781
|
-
### HTTP request headers
|
|
1782
|
-
|
|
1783
|
-
- **Content-Type**: application/json
|
|
1784
|
-
- **Accept**: application/json
|
|
1785
|
-
|
|
1786
|
-
|
|
1787
|
-
### HTTP response details
|
|
1788
|
-
| Status code | Description | Response headers |
|
|
1789
|
-
|-------------|-------------|------------------|
|
|
1790
|
-
|**200** | Successful response | - |
|
|
1791
|
-
|
|
1792
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1793
|
-
|
|
1794
|
-
# **updateEventSessionAccessResponses**
|
|
1795
|
-
> CreateAccountInvitations200Response updateEventSessionAccessResponses(requestBody)
|
|
1796
|
-
|
|
1797
|
-
Update Event Session Access Responses endpoint
|
|
1798
|
-
|
|
1799
|
-
### Example
|
|
1800
|
-
|
|
1801
|
-
```typescript
|
|
1802
|
-
import {
|
|
1803
|
-
EventsPassesApi,
|
|
1804
|
-
Configuration
|
|
1805
|
-
} from '@connectedxm/admin-sdk';
|
|
1806
|
-
|
|
1807
|
-
const configuration = new Configuration();
|
|
1808
|
-
const apiInstance = new EventsPassesApi(configuration);
|
|
1809
|
-
|
|
1810
|
-
let eventId: string; //The event identifier (default to undefined)
|
|
1811
|
-
let sessionId: string; //The session identifier (default to undefined)
|
|
1812
|
-
let passId: string; //The pass identifier (default to undefined)
|
|
1813
|
-
let requestBody: Array<object>; //
|
|
1814
|
-
|
|
1815
|
-
const { status, data } = await apiInstance.updateEventSessionAccessResponses(
|
|
1816
|
-
eventId,
|
|
1817
|
-
sessionId,
|
|
1818
|
-
passId,
|
|
1819
|
-
requestBody
|
|
1820
|
-
);
|
|
1821
|
-
```
|
|
1822
|
-
|
|
1823
|
-
### Parameters
|
|
1824
|
-
|
|
1825
|
-
|Name | Type | Description | Notes|
|
|
1826
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1827
|
-
| **requestBody** | **Array<object>**| | |
|
|
1828
|
-
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
1829
|
-
| **sessionId** | [**string**] | The session identifier | defaults to undefined|
|
|
1830
|
-
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
1831
|
-
|
|
1832
|
-
|
|
1833
|
-
### Return type
|
|
1834
|
-
|
|
1835
|
-
**CreateAccountInvitations200Response**
|
|
763
|
+
**CreateEventPass200Response**
|
|
1836
764
|
|
|
1837
765
|
### Authorization
|
|
1838
766
|
|