@connectedxm/admin-sdk 6.7.6 → 6.8.6
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 +8 -0
- package/AdminApi.ts +3 -0
- package/README.md +20 -0
- package/api.ts +1988 -455
- package/dist/AdminApi.d.ts +2 -1
- package/dist/AdminApi.js +1 -0
- package/dist/api.d.ts +814 -4
- package/dist/api.js +1142 -28
- package/dist/esm/AdminApi.d.ts +2 -1
- package/dist/esm/AdminApi.js +2 -1
- package/dist/esm/api.d.ts +814 -4
- package/dist/esm/api.js +1120 -10
- package/docs/BaseEventActivation.md +2 -0
- package/docs/BaseEventBlock.md +24 -0
- package/docs/BaseSurvey.md +2 -0
- package/docs/BaseSurveySubmission.md +6 -0
- package/docs/CreateEventBlock200Response.md +24 -0
- package/docs/EventActivation.md +2 -0
- package/docs/EventBlock.md +32 -0
- package/docs/EventBlockCreateInputs.md +22 -0
- package/docs/EventBlockUpdateInputs.md +22 -0
- package/docs/EventSession.md +2 -0
- package/docs/EventsBlocksApi.md +479 -0
- package/docs/EventsCouponsApi.md +3 -0
- package/docs/EventsPassesApi.md +110 -0
- package/docs/EventsSessionsApi.md +183 -0
- package/docs/GetEventBlocks200Response.md +26 -0
- package/docs/Survey.md +18 -0
- package/docs/SurveyAllOfCount.md +20 -0
- package/docs/SurveyCreateInputs.md +8 -0
- package/docs/SurveySubmission.md +6 -0
- package/docs/SurveySubmissionUpdateInputs.md +4 -0
- package/docs/SurveyUpdateInputs.md +8 -0
- package/docs/SurveysApi.md +6 -0
- package/package.json +1 -1
package/docs/EventsCouponsApi.md
CHANGED
|
@@ -507,6 +507,7 @@ const apiInstance = new EventsCouponsApi(configuration);
|
|
|
507
507
|
|
|
508
508
|
let eventId: string; //The event identifier (default to undefined)
|
|
509
509
|
let prePaid: boolean; //Filter by prePaid (optional) (default to undefined)
|
|
510
|
+
let includeVariants: object; //Filter by includeVariants (optional) (default to undefined)
|
|
510
511
|
let page: number; //Page number (optional) (default to 1)
|
|
511
512
|
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
512
513
|
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
@@ -515,6 +516,7 @@ let search: string; //Search query (optional) (default to undefined)
|
|
|
515
516
|
const { status, data } = await apiInstance.getEventCoupons(
|
|
516
517
|
eventId,
|
|
517
518
|
prePaid,
|
|
519
|
+
includeVariants,
|
|
518
520
|
page,
|
|
519
521
|
pageSize,
|
|
520
522
|
orderBy,
|
|
@@ -528,6 +530,7 @@ const { status, data } = await apiInstance.getEventCoupons(
|
|
|
528
530
|
|------------- | ------------- | ------------- | -------------|
|
|
529
531
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
530
532
|
| **prePaid** | [**boolean**] | Filter by prePaid | (optional) defaults to undefined|
|
|
533
|
+
| **includeVariants** | **object** | Filter by includeVariants | (optional) defaults to undefined|
|
|
531
534
|
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
532
535
|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
533
536
|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
package/docs/EventsPassesApi.md
CHANGED
|
@@ -6,6 +6,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**addEventPassAddOn**](#addeventpassaddon) | **POST** /events/{eventId}/passes/{passId}/addOns/{addOnId} | Add Event Pass Add On|
|
|
8
8
|
|[**cancelEventPass**](#canceleventpass) | **PUT** /events/{eventId}/passes/{passId}/cancel | Cancel Event Pass|
|
|
9
|
+
|[**checkinEventPass**](#checkineventpass) | **POST** /events/{eventId}/passes/{passId}/checkin | Checkin Event Pass|
|
|
9
10
|
|[**createEventPass**](#createeventpass) | **POST** /events/{eventId}/attendees/{accountId}/passes | Create Event Pass|
|
|
10
11
|
|[**createEventSessionAccess**](#createeventsessionaccess) | **POST** /events/{eventId}/sessions/{sessionId}/passes/{passId} | Create Event Session Access|
|
|
11
12
|
|[**deleteEventPass**](#deleteeventpass) | **DELETE** /events/{eventId}/passes/{passId} | Delete Event Pass|
|
|
@@ -25,6 +26,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
25
26
|
|[**indexEventPasses**](#indexeventpasses) | **POST** /events/{eventId}/index-passes | Index Event Passes|
|
|
26
27
|
|[**removeEventPassAddOn**](#removeeventpassaddon) | **DELETE** /events/{eventId}/passes/{passId}/addOns/{addOnId} | Remove Event Pass Add On|
|
|
27
28
|
|[**transferEventPass**](#transfereventpass) | **POST** /events/{eventId}/attendees/{accountId}/passes/{passId}/transfers | Transfer Event Pass|
|
|
29
|
+
|[**undoCheckinEventPass**](#undocheckineventpass) | **POST** /events/{eventId}/passes/{passId}/checkin/undo | Undo Checkin Event Pass|
|
|
28
30
|
|[**updateEventPass**](#updateeventpass) | **PUT** /events/{eventId}/passes/{passId} | Update Event Pass|
|
|
29
31
|
|[**updateEventPassFollowupResponses**](#updateeventpassfollowupresponses) | **PUT** /events/{eventId}/attendees/{accountId}/passes/{passId}/followups | Update Event Pass Followup Responses|
|
|
30
32
|
|[**updateEventPassResponse**](#updateeventpassresponse) | **PUT** /events/{eventId}/passes/{passId}/responses/{questionId} | Update Event Pass Response|
|
|
@@ -126,6 +128,60 @@ const { status, data } = await apiInstance.cancelEventPass(
|
|
|
126
128
|
| **sendEmail** | [**boolean**] | Filter by sendEmail | (optional) defaults to undefined|
|
|
127
129
|
|
|
128
130
|
|
|
131
|
+
### Return type
|
|
132
|
+
|
|
133
|
+
**CreateEventPass200Response**
|
|
134
|
+
|
|
135
|
+
### Authorization
|
|
136
|
+
|
|
137
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
138
|
+
|
|
139
|
+
### HTTP request headers
|
|
140
|
+
|
|
141
|
+
- **Content-Type**: Not defined
|
|
142
|
+
- **Accept**: application/json
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
### HTTP response details
|
|
146
|
+
| Status code | Description | Response headers |
|
|
147
|
+
|-------------|-------------|------------------|
|
|
148
|
+
|**200** | Successful response | - |
|
|
149
|
+
|
|
150
|
+
[[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)
|
|
151
|
+
|
|
152
|
+
# **checkinEventPass**
|
|
153
|
+
> CreateEventPass200Response checkinEventPass()
|
|
154
|
+
|
|
155
|
+
Checkin Event Pass endpoint
|
|
156
|
+
|
|
157
|
+
### Example
|
|
158
|
+
|
|
159
|
+
```typescript
|
|
160
|
+
import {
|
|
161
|
+
EventsPassesApi,
|
|
162
|
+
Configuration
|
|
163
|
+
} from '@connectedxm/admin-sdk';
|
|
164
|
+
|
|
165
|
+
const configuration = new Configuration();
|
|
166
|
+
const apiInstance = new EventsPassesApi(configuration);
|
|
167
|
+
|
|
168
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
169
|
+
let passId: string; //The pass identifier (default to undefined)
|
|
170
|
+
|
|
171
|
+
const { status, data } = await apiInstance.checkinEventPass(
|
|
172
|
+
eventId,
|
|
173
|
+
passId
|
|
174
|
+
);
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
### Parameters
|
|
178
|
+
|
|
179
|
+
|Name | Type | Description | Notes|
|
|
180
|
+
|------------- | ------------- | ------------- | -------------|
|
|
181
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
182
|
+
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
183
|
+
|
|
184
|
+
|
|
129
185
|
### Return type
|
|
130
186
|
|
|
131
187
|
**CreateEventPass200Response**
|
|
@@ -1311,6 +1367,60 @@ const { status, data } = await apiInstance.transferEventPass(
|
|
|
1311
1367
|
- **Accept**: application/json
|
|
1312
1368
|
|
|
1313
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
|
+
|
|
1314
1424
|
### HTTP response details
|
|
1315
1425
|
| Status code | Description | Response headers |
|
|
1316
1426
|
|-------------|-------------|------------------|
|
|
@@ -5,6 +5,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**addEventSessionAccount**](#addeventsessionaccount) | **POST** /events/{eventId}/sessions/{sessionId}/accounts/{accountId} | Add Event Session Account|
|
|
8
|
+
|[**addEventSessionBlock**](#addeventsessionblock) | **POST** /events/{eventId}/sessions/{sessionId}/blocks/{blockId} | Add Event Session Block|
|
|
8
9
|
|[**addEventSessionPassType**](#addeventsessionpasstype) | **POST** /events/{eventId}/sessions/{sessionId}/passTypes/{passTypeId} | Add Event Session Pass Type|
|
|
9
10
|
|[**addEventSessionSpeaker**](#addeventsessionspeaker) | **POST** /events/{eventId}/sessions/{sessionId}/speakers/{speakerId} | Add Event Session Speaker|
|
|
10
11
|
|[**addEventSessionSponsor**](#addeventsessionsponsor) | **POST** /events/{eventId}/sessions/{sessionId}/sponsors/{sponsorId} | Add Event Session Sponsor|
|
|
@@ -14,6 +15,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
14
15
|
|[**getEventSession**](#geteventsession) | **GET** /events/{eventId}/sessions/{sessionId} | Get Event Session|
|
|
15
16
|
|[**getEventSessionAccesses**](#geteventsessionaccesses) | **GET** /events/{eventId}/sessions/{sessionId}/accesses | Get Event Session Accesses|
|
|
16
17
|
|[**getEventSessionAccounts**](#geteventsessionaccounts) | **GET** /events/{eventId}/sessions/{sessionId}/accounts | Get Event Session Accounts|
|
|
18
|
+
|[**getEventSessionBlocks**](#geteventsessionblocks) | **GET** /events/{eventId}/sessions/{sessionId}/blocks | Get Event Session Blocks|
|
|
17
19
|
|[**getEventSessionPassTypes**](#geteventsessionpasstypes) | **GET** /events/{eventId}/sessions/{sessionId}/passTypes | Get Event Session Pass Types|
|
|
18
20
|
|[**getEventSessionPayments**](#geteventsessionpayments) | **GET** /events/{eventId}/sessions/{sessionId}/payments | Get Event Session Payments|
|
|
19
21
|
|[**getEventSessionSpeakers**](#geteventsessionspeakers) | **GET** /events/{eventId}/sessions/{sessionId}/speakers | Get Event Session Speakers|
|
|
@@ -21,6 +23,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
21
23
|
|[**getEventSessionTracks**](#geteventsessiontracks) | **GET** /events/{eventId}/sessions/{sessionId}/tracks | Get Event Session Tracks|
|
|
22
24
|
|[**getEventSessions**](#geteventsessions) | **GET** /events/{eventId}/sessions | Get Event Sessions|
|
|
23
25
|
|[**removeEventSessionAccount**](#removeeventsessionaccount) | **DELETE** /events/{eventId}/sessions/{sessionId}/accounts/{accountId} | Remove Event Session Account|
|
|
26
|
+
|[**removeEventSessionBlock**](#removeeventsessionblock) | **DELETE** /events/{eventId}/sessions/{sessionId}/blocks/{blockId} | Remove Event Session Block|
|
|
24
27
|
|[**removeEventSessionPassType**](#removeeventsessionpasstype) | **DELETE** /events/{eventId}/sessions/{sessionId}/passTypes/{passTypeId} | Remove Event Session Pass Type|
|
|
25
28
|
|[**removeEventSessionSpeaker**](#removeeventsessionspeaker) | **DELETE** /events/{eventId}/sessions/{sessionId}/speakers/{speakerId} | Remove Event Session Speaker|
|
|
26
29
|
|[**removeEventSessionSponsor**](#removeeventsessionsponsor) | **DELETE** /events/{eventId}/sessions/{sessionId}/sponsors/{sponsorId} | Remove Event Session Sponsor|
|
|
@@ -77,6 +80,63 @@ const { status, data } = await apiInstance.addEventSessionAccount(
|
|
|
77
80
|
- **Accept**: application/json
|
|
78
81
|
|
|
79
82
|
|
|
83
|
+
### HTTP response details
|
|
84
|
+
| Status code | Description | Response headers |
|
|
85
|
+
|-------------|-------------|------------------|
|
|
86
|
+
|**200** | Successful response | - |
|
|
87
|
+
|
|
88
|
+
[[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)
|
|
89
|
+
|
|
90
|
+
# **addEventSessionBlock**
|
|
91
|
+
> CreateEventSession200Response addEventSessionBlock()
|
|
92
|
+
|
|
93
|
+
Add Event Session Block endpoint
|
|
94
|
+
|
|
95
|
+
### Example
|
|
96
|
+
|
|
97
|
+
```typescript
|
|
98
|
+
import {
|
|
99
|
+
EventsSessionsApi,
|
|
100
|
+
Configuration
|
|
101
|
+
} from '@connectedxm/admin-sdk';
|
|
102
|
+
|
|
103
|
+
const configuration = new Configuration();
|
|
104
|
+
const apiInstance = new EventsSessionsApi(configuration);
|
|
105
|
+
|
|
106
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
107
|
+
let sessionId: string; //The session identifier (default to undefined)
|
|
108
|
+
let blockId: string; //The block identifier (default to undefined)
|
|
109
|
+
|
|
110
|
+
const { status, data } = await apiInstance.addEventSessionBlock(
|
|
111
|
+
eventId,
|
|
112
|
+
sessionId,
|
|
113
|
+
blockId
|
|
114
|
+
);
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
### Parameters
|
|
118
|
+
|
|
119
|
+
|Name | Type | Description | Notes|
|
|
120
|
+
|------------- | ------------- | ------------- | -------------|
|
|
121
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
122
|
+
| **sessionId** | [**string**] | The session identifier | defaults to undefined|
|
|
123
|
+
| **blockId** | [**string**] | The block identifier | defaults to undefined|
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
### Return type
|
|
127
|
+
|
|
128
|
+
**CreateEventSession200Response**
|
|
129
|
+
|
|
130
|
+
### Authorization
|
|
131
|
+
|
|
132
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
133
|
+
|
|
134
|
+
### HTTP request headers
|
|
135
|
+
|
|
136
|
+
- **Content-Type**: Not defined
|
|
137
|
+
- **Accept**: application/json
|
|
138
|
+
|
|
139
|
+
|
|
80
140
|
### HTTP response details
|
|
81
141
|
| Status code | Description | Response headers |
|
|
82
142
|
|-------------|-------------|------------------|
|
|
@@ -603,6 +663,72 @@ const { status, data } = await apiInstance.getEventSessionAccounts(
|
|
|
603
663
|
- **Accept**: application/json
|
|
604
664
|
|
|
605
665
|
|
|
666
|
+
### HTTP response details
|
|
667
|
+
| Status code | Description | Response headers |
|
|
668
|
+
|-------------|-------------|------------------|
|
|
669
|
+
|**200** | Successful response | - |
|
|
670
|
+
|
|
671
|
+
[[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)
|
|
672
|
+
|
|
673
|
+
# **getEventSessionBlocks**
|
|
674
|
+
> GetEventBlocks200Response getEventSessionBlocks()
|
|
675
|
+
|
|
676
|
+
Get Event Session Blocks endpoint
|
|
677
|
+
|
|
678
|
+
### Example
|
|
679
|
+
|
|
680
|
+
```typescript
|
|
681
|
+
import {
|
|
682
|
+
EventsSessionsApi,
|
|
683
|
+
Configuration
|
|
684
|
+
} from '@connectedxm/admin-sdk';
|
|
685
|
+
|
|
686
|
+
const configuration = new Configuration();
|
|
687
|
+
const apiInstance = new EventsSessionsApi(configuration);
|
|
688
|
+
|
|
689
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
690
|
+
let sessionId: string; //The session identifier (default to undefined)
|
|
691
|
+
let page: number; //Page number (optional) (default to 1)
|
|
692
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
693
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
694
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
695
|
+
|
|
696
|
+
const { status, data } = await apiInstance.getEventSessionBlocks(
|
|
697
|
+
eventId,
|
|
698
|
+
sessionId,
|
|
699
|
+
page,
|
|
700
|
+
pageSize,
|
|
701
|
+
orderBy,
|
|
702
|
+
search
|
|
703
|
+
);
|
|
704
|
+
```
|
|
705
|
+
|
|
706
|
+
### Parameters
|
|
707
|
+
|
|
708
|
+
|Name | Type | Description | Notes|
|
|
709
|
+
|------------- | ------------- | ------------- | -------------|
|
|
710
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
711
|
+
| **sessionId** | [**string**] | The session identifier | defaults to undefined|
|
|
712
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
713
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
714
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
715
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
716
|
+
|
|
717
|
+
|
|
718
|
+
### Return type
|
|
719
|
+
|
|
720
|
+
**GetEventBlocks200Response**
|
|
721
|
+
|
|
722
|
+
### Authorization
|
|
723
|
+
|
|
724
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
725
|
+
|
|
726
|
+
### HTTP request headers
|
|
727
|
+
|
|
728
|
+
- **Content-Type**: Not defined
|
|
729
|
+
- **Accept**: application/json
|
|
730
|
+
|
|
731
|
+
|
|
606
732
|
### HTTP response details
|
|
607
733
|
| Status code | Description | Response headers |
|
|
608
734
|
|-------------|-------------|------------------|
|
|
@@ -1039,6 +1165,63 @@ const { status, data } = await apiInstance.removeEventSessionAccount(
|
|
|
1039
1165
|
| **accountId** | [**string**] | The account identifier | defaults to undefined|
|
|
1040
1166
|
|
|
1041
1167
|
|
|
1168
|
+
### Return type
|
|
1169
|
+
|
|
1170
|
+
**CreateAccountAddress200Response**
|
|
1171
|
+
|
|
1172
|
+
### Authorization
|
|
1173
|
+
|
|
1174
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1175
|
+
|
|
1176
|
+
### HTTP request headers
|
|
1177
|
+
|
|
1178
|
+
- **Content-Type**: Not defined
|
|
1179
|
+
- **Accept**: application/json
|
|
1180
|
+
|
|
1181
|
+
|
|
1182
|
+
### HTTP response details
|
|
1183
|
+
| Status code | Description | Response headers |
|
|
1184
|
+
|-------------|-------------|------------------|
|
|
1185
|
+
|**200** | Successful response | - |
|
|
1186
|
+
|
|
1187
|
+
[[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)
|
|
1188
|
+
|
|
1189
|
+
# **removeEventSessionBlock**
|
|
1190
|
+
> CreateAccountAddress200Response removeEventSessionBlock()
|
|
1191
|
+
|
|
1192
|
+
Remove Event Session Block endpoint
|
|
1193
|
+
|
|
1194
|
+
### Example
|
|
1195
|
+
|
|
1196
|
+
```typescript
|
|
1197
|
+
import {
|
|
1198
|
+
EventsSessionsApi,
|
|
1199
|
+
Configuration
|
|
1200
|
+
} from '@connectedxm/admin-sdk';
|
|
1201
|
+
|
|
1202
|
+
const configuration = new Configuration();
|
|
1203
|
+
const apiInstance = new EventsSessionsApi(configuration);
|
|
1204
|
+
|
|
1205
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
1206
|
+
let sessionId: string; //The session identifier (default to undefined)
|
|
1207
|
+
let blockId: string; //The block identifier (default to undefined)
|
|
1208
|
+
|
|
1209
|
+
const { status, data } = await apiInstance.removeEventSessionBlock(
|
|
1210
|
+
eventId,
|
|
1211
|
+
sessionId,
|
|
1212
|
+
blockId
|
|
1213
|
+
);
|
|
1214
|
+
```
|
|
1215
|
+
|
|
1216
|
+
### Parameters
|
|
1217
|
+
|
|
1218
|
+
|Name | Type | Description | Notes|
|
|
1219
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1220
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
1221
|
+
| **sessionId** | [**string**] | The session identifier | defaults to undefined|
|
|
1222
|
+
| **blockId** | [**string**] | The block identifier | defaults to undefined|
|
|
1223
|
+
|
|
1224
|
+
|
|
1042
1225
|
### Return type
|
|
1043
1226
|
|
|
1044
1227
|
**CreateAccountAddress200Response**
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# GetEventBlocks200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**Array<EventBlock>**](EventBlock.md) | | [default to undefined]
|
|
11
|
+
**count** | **number** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { GetEventBlocks200Response } from '@connectedxm/admin-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: GetEventBlocks200Response = {
|
|
19
|
+
status,
|
|
20
|
+
message,
|
|
21
|
+
data,
|
|
22
|
+
count,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/Survey.md
CHANGED
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**id** | **string** | | [default to undefined]
|
|
9
9
|
**slug** | **string** | | [default to undefined]
|
|
10
10
|
**name** | **string** | | [default to undefined]
|
|
11
|
+
**active** | **boolean** | | [default to undefined]
|
|
11
12
|
**description** | **string** | | [default to undefined]
|
|
12
13
|
**image** | [**BaseImage**](BaseImage.md) | | [default to undefined]
|
|
13
14
|
**requireAuth** | **boolean** | | [default to undefined]
|
|
@@ -16,6 +17,14 @@ Name | Type | Description | Notes
|
|
|
16
17
|
**emailBody** | **string** | | [default to undefined]
|
|
17
18
|
**createdAt** | **string** | | [default to undefined]
|
|
18
19
|
**updatedAt** | **string** | | [default to undefined]
|
|
20
|
+
**eventId** | **string** | | [default to undefined]
|
|
21
|
+
**event** | [**BaseEvent**](BaseEvent.md) | | [default to undefined]
|
|
22
|
+
**sessionId** | **string** | | [default to undefined]
|
|
23
|
+
**session** | [**BaseEventSession**](BaseEventSession.md) | | [default to undefined]
|
|
24
|
+
**activationId** | **string** | | [default to undefined]
|
|
25
|
+
**activation** | [**BaseEventActivation**](BaseEventActivation.md) | | [default to undefined]
|
|
26
|
+
**passTypes** | [**Array<BaseEventPassType>**](BaseEventPassType.md) | | [default to undefined]
|
|
27
|
+
**_count** | [**SurveyAllOfCount**](SurveyAllOfCount.md) | | [default to undefined]
|
|
19
28
|
|
|
20
29
|
## Example
|
|
21
30
|
|
|
@@ -26,6 +35,7 @@ const instance: Survey = {
|
|
|
26
35
|
id,
|
|
27
36
|
slug,
|
|
28
37
|
name,
|
|
38
|
+
active,
|
|
29
39
|
description,
|
|
30
40
|
image,
|
|
31
41
|
requireAuth,
|
|
@@ -34,6 +44,14 @@ const instance: Survey = {
|
|
|
34
44
|
emailBody,
|
|
35
45
|
createdAt,
|
|
36
46
|
updatedAt,
|
|
47
|
+
eventId,
|
|
48
|
+
event,
|
|
49
|
+
sessionId,
|
|
50
|
+
session,
|
|
51
|
+
activationId,
|
|
52
|
+
activation,
|
|
53
|
+
passTypes,
|
|
54
|
+
_count,
|
|
37
55
|
};
|
|
38
56
|
```
|
|
39
57
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# SurveyAllOfCount
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**submissions** | **number** | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { SurveyAllOfCount } from '@connectedxm/admin-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: SurveyAllOfCount = {
|
|
16
|
+
submissions,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -7,12 +7,16 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**name** | **string** | | [default to undefined]
|
|
9
9
|
**slug** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**active** | **boolean** | | [optional] [default to undefined]
|
|
10
11
|
**description** | **string** | | [optional] [default to undefined]
|
|
11
12
|
**imageId** | **string** | | [optional] [default to undefined]
|
|
12
13
|
**requireAuth** | **boolean** | | [optional] [default to undefined]
|
|
13
14
|
**submissionsPerAccount** | [**InvoiceLineItemCreateInputsQuantity**](InvoiceLineItemCreateInputsQuantity.md) | | [optional] [default to undefined]
|
|
14
15
|
**replyTo** | **string** | | [optional] [default to undefined]
|
|
15
16
|
**emailBody** | **string** | | [optional] [default to undefined]
|
|
17
|
+
**eventId** | **string** | | [optional] [default to undefined]
|
|
18
|
+
**sessionId** | **string** | | [optional] [default to undefined]
|
|
19
|
+
**activationId** | **string** | | [optional] [default to undefined]
|
|
16
20
|
|
|
17
21
|
## Example
|
|
18
22
|
|
|
@@ -22,12 +26,16 @@ import { SurveyCreateInputs } from '@connectedxm/admin-sdk';
|
|
|
22
26
|
const instance: SurveyCreateInputs = {
|
|
23
27
|
name,
|
|
24
28
|
slug,
|
|
29
|
+
active,
|
|
25
30
|
description,
|
|
26
31
|
imageId,
|
|
27
32
|
requireAuth,
|
|
28
33
|
submissionsPerAccount,
|
|
29
34
|
replyTo,
|
|
30
35
|
emailBody,
|
|
36
|
+
eventId,
|
|
37
|
+
sessionId,
|
|
38
|
+
activationId,
|
|
31
39
|
};
|
|
32
40
|
```
|
|
33
41
|
|
package/docs/SurveySubmission.md
CHANGED
|
@@ -6,7 +6,10 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**id** | **string** | | [default to undefined]
|
|
9
|
+
**accountId** | **string** | | [default to undefined]
|
|
9
10
|
**account** | [**BaseAccount**](BaseAccount.md) | | [default to undefined]
|
|
11
|
+
**passId** | **string** | | [default to undefined]
|
|
12
|
+
**pass** | [**BaseEventPass**](BaseEventPass.md) | | [default to undefined]
|
|
10
13
|
**status** | [**PurchaseStatus**](PurchaseStatus.md) | | [default to undefined]
|
|
11
14
|
**responses** | [**Array<BaseSurveyQuestionResponse>**](BaseSurveyQuestionResponse.md) | | [default to undefined]
|
|
12
15
|
**createdAt** | **string** | | [default to undefined]
|
|
@@ -19,7 +22,10 @@ import { SurveySubmission } from '@connectedxm/admin-sdk';
|
|
|
19
22
|
|
|
20
23
|
const instance: SurveySubmission = {
|
|
21
24
|
id,
|
|
25
|
+
accountId,
|
|
22
26
|
account,
|
|
27
|
+
passId,
|
|
28
|
+
pass,
|
|
23
29
|
status,
|
|
24
30
|
responses,
|
|
25
31
|
createdAt,
|
|
@@ -6,6 +6,8 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**status** | [**PurchaseStatus**](PurchaseStatus.md) | | [optional] [default to undefined]
|
|
9
|
+
**accountId** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**passId** | **string** | | [optional] [default to undefined]
|
|
9
11
|
|
|
10
12
|
## Example
|
|
11
13
|
|
|
@@ -14,6 +16,8 @@ import { SurveySubmissionUpdateInputs } from '@connectedxm/admin-sdk';
|
|
|
14
16
|
|
|
15
17
|
const instance: SurveySubmissionUpdateInputs = {
|
|
16
18
|
status,
|
|
19
|
+
accountId,
|
|
20
|
+
passId,
|
|
17
21
|
};
|
|
18
22
|
```
|
|
19
23
|
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**name** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**active** | **boolean** | | [optional] [default to undefined]
|
|
9
10
|
**slug** | **string** | | [optional] [default to undefined]
|
|
10
11
|
**description** | **string** | | [optional] [default to undefined]
|
|
11
12
|
**imageId** | **string** | | [optional] [default to undefined]
|
|
@@ -13,6 +14,9 @@ Name | Type | Description | Notes
|
|
|
13
14
|
**submissionsPerAccount** | [**InvoiceLineItemCreateInputsQuantity**](InvoiceLineItemCreateInputsQuantity.md) | | [optional] [default to undefined]
|
|
14
15
|
**replyTo** | **string** | | [optional] [default to undefined]
|
|
15
16
|
**emailBody** | **string** | | [optional] [default to undefined]
|
|
17
|
+
**eventId** | **string** | | [optional] [default to undefined]
|
|
18
|
+
**sessionId** | **string** | | [optional] [default to undefined]
|
|
19
|
+
**activationId** | **string** | | [optional] [default to undefined]
|
|
16
20
|
|
|
17
21
|
## Example
|
|
18
22
|
|
|
@@ -21,6 +25,7 @@ import { SurveyUpdateInputs } from '@connectedxm/admin-sdk';
|
|
|
21
25
|
|
|
22
26
|
const instance: SurveyUpdateInputs = {
|
|
23
27
|
name,
|
|
28
|
+
active,
|
|
24
29
|
slug,
|
|
25
30
|
description,
|
|
26
31
|
imageId,
|
|
@@ -28,6 +33,9 @@ const instance: SurveyUpdateInputs = {
|
|
|
28
33
|
submissionsPerAccount,
|
|
29
34
|
replyTo,
|
|
30
35
|
emailBody,
|
|
36
|
+
eventId,
|
|
37
|
+
sessionId,
|
|
38
|
+
activationId,
|
|
31
39
|
};
|
|
32
40
|
```
|
|
33
41
|
|
package/docs/SurveysApi.md
CHANGED
|
@@ -180,12 +180,16 @@ import {
|
|
|
180
180
|
const configuration = new Configuration();
|
|
181
181
|
const apiInstance = new SurveysApi(configuration);
|
|
182
182
|
|
|
183
|
+
let eventId: string; //Filter by eventId (optional) (default to undefined)
|
|
184
|
+
let sessionId: string; //Filter by sessionId (optional) (default to undefined)
|
|
183
185
|
let page: number; //Page number (optional) (default to 1)
|
|
184
186
|
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
185
187
|
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
186
188
|
let search: string; //Search query (optional) (default to undefined)
|
|
187
189
|
|
|
188
190
|
const { status, data } = await apiInstance.getSurveys(
|
|
191
|
+
eventId,
|
|
192
|
+
sessionId,
|
|
189
193
|
page,
|
|
190
194
|
pageSize,
|
|
191
195
|
orderBy,
|
|
@@ -197,6 +201,8 @@ const { status, data } = await apiInstance.getSurveys(
|
|
|
197
201
|
|
|
198
202
|
|Name | Type | Description | Notes|
|
|
199
203
|
|------------- | ------------- | ------------- | -------------|
|
|
204
|
+
| **eventId** | [**string**] | Filter by eventId | (optional) defaults to undefined|
|
|
205
|
+
| **sessionId** | [**string**] | Filter by sessionId | (optional) defaults to undefined|
|
|
200
206
|
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
201
207
|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
202
208
|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|