@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
|
@@ -0,0 +1,272 @@
|
|
|
1
|
+
# EventsPassesFollowupsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://admin-api.connected.dev*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**getEventPassQuestionFollowups**](#geteventpassquestionfollowups) | **GET** /events/{eventId}/attendees/{accountId}/passes/{passId}/followups | Get Event Pass Question Followups|
|
|
8
|
+
|[**getEventPassQuestionSections**](#geteventpassquestionsections) | **GET** /events/{eventId}/attendees/{accountId}/passes/{passId}/sections | Get Event Pass Question Sections|
|
|
9
|
+
|[**updateEventPassFollowupResponses**](#updateeventpassfollowupresponses) | **PUT** /events/{eventId}/attendees/{accountId}/passes/{passId}/followups | Update Event Pass Followup Responses|
|
|
10
|
+
|[**updateEventPassSingleFollowupResponses**](#updateeventpasssinglefollowupresponses) | **PUT** /events/{eventId}/attendees/{accountId}/passes/{passId}/followups/{followupId} | Update Event Pass Single Followup Responses|
|
|
11
|
+
|
|
12
|
+
# **getEventPassQuestionFollowups**
|
|
13
|
+
> GetEventPassQuestionFollowups200Response getEventPassQuestionFollowups()
|
|
14
|
+
|
|
15
|
+
Get Event Pass Question Followups endpoint
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import {
|
|
21
|
+
EventsPassesFollowupsApi,
|
|
22
|
+
Configuration
|
|
23
|
+
} from '@connectedxm/admin-sdk';
|
|
24
|
+
|
|
25
|
+
const configuration = new Configuration();
|
|
26
|
+
const apiInstance = new EventsPassesFollowupsApi(configuration);
|
|
27
|
+
|
|
28
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
29
|
+
let accountId: string; //The account identifier (default to undefined)
|
|
30
|
+
let passId: string; //The pass identifier (default to undefined)
|
|
31
|
+
let page: number; //Page number (optional) (default to 1)
|
|
32
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
33
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
34
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
35
|
+
|
|
36
|
+
const { status, data } = await apiInstance.getEventPassQuestionFollowups(
|
|
37
|
+
eventId,
|
|
38
|
+
accountId,
|
|
39
|
+
passId,
|
|
40
|
+
page,
|
|
41
|
+
pageSize,
|
|
42
|
+
orderBy,
|
|
43
|
+
search
|
|
44
|
+
);
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### Parameters
|
|
48
|
+
|
|
49
|
+
|Name | Type | Description | Notes|
|
|
50
|
+
|------------- | ------------- | ------------- | -------------|
|
|
51
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
52
|
+
| **accountId** | [**string**] | The account identifier | defaults to undefined|
|
|
53
|
+
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
54
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
55
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
56
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
57
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
### Return type
|
|
61
|
+
|
|
62
|
+
**GetEventPassQuestionFollowups200Response**
|
|
63
|
+
|
|
64
|
+
### Authorization
|
|
65
|
+
|
|
66
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
67
|
+
|
|
68
|
+
### HTTP request headers
|
|
69
|
+
|
|
70
|
+
- **Content-Type**: Not defined
|
|
71
|
+
- **Accept**: application/json
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
### HTTP response details
|
|
75
|
+
| Status code | Description | Response headers |
|
|
76
|
+
|-------------|-------------|------------------|
|
|
77
|
+
|**200** | Successful response | - |
|
|
78
|
+
|
|
79
|
+
[[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)
|
|
80
|
+
|
|
81
|
+
# **getEventPassQuestionSections**
|
|
82
|
+
> GetEventPassQuestionSections200Response getEventPassQuestionSections()
|
|
83
|
+
|
|
84
|
+
Get Event Pass Question Sections endpoint
|
|
85
|
+
|
|
86
|
+
### Example
|
|
87
|
+
|
|
88
|
+
```typescript
|
|
89
|
+
import {
|
|
90
|
+
EventsPassesFollowupsApi,
|
|
91
|
+
Configuration
|
|
92
|
+
} from '@connectedxm/admin-sdk';
|
|
93
|
+
|
|
94
|
+
const configuration = new Configuration();
|
|
95
|
+
const apiInstance = new EventsPassesFollowupsApi(configuration);
|
|
96
|
+
|
|
97
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
98
|
+
let accountId: string; //The account identifier (default to undefined)
|
|
99
|
+
let passId: string; //The pass identifier (default to undefined)
|
|
100
|
+
let page: number; //Page number (optional) (default to 1)
|
|
101
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
102
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
103
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
104
|
+
|
|
105
|
+
const { status, data } = await apiInstance.getEventPassQuestionSections(
|
|
106
|
+
eventId,
|
|
107
|
+
accountId,
|
|
108
|
+
passId,
|
|
109
|
+
page,
|
|
110
|
+
pageSize,
|
|
111
|
+
orderBy,
|
|
112
|
+
search
|
|
113
|
+
);
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
### Parameters
|
|
117
|
+
|
|
118
|
+
|Name | Type | Description | Notes|
|
|
119
|
+
|------------- | ------------- | ------------- | -------------|
|
|
120
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
121
|
+
| **accountId** | [**string**] | The account identifier | defaults to undefined|
|
|
122
|
+
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
123
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
124
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
125
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
126
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
### Return type
|
|
130
|
+
|
|
131
|
+
**GetEventPassQuestionSections200Response**
|
|
132
|
+
|
|
133
|
+
### Authorization
|
|
134
|
+
|
|
135
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
136
|
+
|
|
137
|
+
### HTTP request headers
|
|
138
|
+
|
|
139
|
+
- **Content-Type**: Not defined
|
|
140
|
+
- **Accept**: application/json
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
### HTTP response details
|
|
144
|
+
| Status code | Description | Response headers |
|
|
145
|
+
|-------------|-------------|------------------|
|
|
146
|
+
|**200** | Successful response | - |
|
|
147
|
+
|
|
148
|
+
[[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)
|
|
149
|
+
|
|
150
|
+
# **updateEventPassFollowupResponses**
|
|
151
|
+
> CreateAccountInvitations200Response updateEventPassFollowupResponses()
|
|
152
|
+
|
|
153
|
+
Update Event Pass Followup Responses endpoint
|
|
154
|
+
|
|
155
|
+
### Example
|
|
156
|
+
|
|
157
|
+
```typescript
|
|
158
|
+
import {
|
|
159
|
+
EventsPassesFollowupsApi,
|
|
160
|
+
Configuration
|
|
161
|
+
} from '@connectedxm/admin-sdk';
|
|
162
|
+
|
|
163
|
+
const configuration = new Configuration();
|
|
164
|
+
const apiInstance = new EventsPassesFollowupsApi(configuration);
|
|
165
|
+
|
|
166
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
167
|
+
let accountId: string; //The account identifier (default to undefined)
|
|
168
|
+
let passId: string; //The pass identifier (default to undefined)
|
|
169
|
+
let questions: Array<Question>; //Filter by questions (default to undefined)
|
|
170
|
+
|
|
171
|
+
const { status, data } = await apiInstance.updateEventPassFollowupResponses(
|
|
172
|
+
eventId,
|
|
173
|
+
accountId,
|
|
174
|
+
passId,
|
|
175
|
+
questions
|
|
176
|
+
);
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
### Parameters
|
|
180
|
+
|
|
181
|
+
|Name | Type | Description | Notes|
|
|
182
|
+
|------------- | ------------- | ------------- | -------------|
|
|
183
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
184
|
+
| **accountId** | [**string**] | The account identifier | defaults to undefined|
|
|
185
|
+
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
186
|
+
| **questions** | **Array<Question>** | Filter by questions | defaults to undefined|
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
### Return type
|
|
190
|
+
|
|
191
|
+
**CreateAccountInvitations200Response**
|
|
192
|
+
|
|
193
|
+
### Authorization
|
|
194
|
+
|
|
195
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
196
|
+
|
|
197
|
+
### HTTP request headers
|
|
198
|
+
|
|
199
|
+
- **Content-Type**: Not defined
|
|
200
|
+
- **Accept**: application/json
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
### HTTP response details
|
|
204
|
+
| Status code | Description | Response headers |
|
|
205
|
+
|-------------|-------------|------------------|
|
|
206
|
+
|**200** | Successful response | - |
|
|
207
|
+
|
|
208
|
+
[[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)
|
|
209
|
+
|
|
210
|
+
# **updateEventPassSingleFollowupResponses**
|
|
211
|
+
> CreateAccountInvitations200Response updateEventPassSingleFollowupResponses()
|
|
212
|
+
|
|
213
|
+
Update Event Pass Single Followup Responses endpoint
|
|
214
|
+
|
|
215
|
+
### Example
|
|
216
|
+
|
|
217
|
+
```typescript
|
|
218
|
+
import {
|
|
219
|
+
EventsPassesFollowupsApi,
|
|
220
|
+
Configuration
|
|
221
|
+
} from '@connectedxm/admin-sdk';
|
|
222
|
+
|
|
223
|
+
const configuration = new Configuration();
|
|
224
|
+
const apiInstance = new EventsPassesFollowupsApi(configuration);
|
|
225
|
+
|
|
226
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
227
|
+
let accountId: string; //The account identifier (default to undefined)
|
|
228
|
+
let passId: string; //The pass identifier (default to undefined)
|
|
229
|
+
let followupId: string; //The followup identifier (default to undefined)
|
|
230
|
+
let questions: Array<Question>; //Filter by questions (default to undefined)
|
|
231
|
+
|
|
232
|
+
const { status, data } = await apiInstance.updateEventPassSingleFollowupResponses(
|
|
233
|
+
eventId,
|
|
234
|
+
accountId,
|
|
235
|
+
passId,
|
|
236
|
+
followupId,
|
|
237
|
+
questions
|
|
238
|
+
);
|
|
239
|
+
```
|
|
240
|
+
|
|
241
|
+
### Parameters
|
|
242
|
+
|
|
243
|
+
|Name | Type | Description | Notes|
|
|
244
|
+
|------------- | ------------- | ------------- | -------------|
|
|
245
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
246
|
+
| **accountId** | [**string**] | The account identifier | defaults to undefined|
|
|
247
|
+
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
248
|
+
| **followupId** | [**string**] | The followup identifier | defaults to undefined|
|
|
249
|
+
| **questions** | **Array<Question>** | Filter by questions | defaults to undefined|
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
### Return type
|
|
253
|
+
|
|
254
|
+
**CreateAccountInvitations200Response**
|
|
255
|
+
|
|
256
|
+
### Authorization
|
|
257
|
+
|
|
258
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
259
|
+
|
|
260
|
+
### HTTP request headers
|
|
261
|
+
|
|
262
|
+
- **Content-Type**: Not defined
|
|
263
|
+
- **Accept**: application/json
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
### HTTP response details
|
|
267
|
+
| Status code | Description | Response headers |
|
|
268
|
+
|-------------|-------------|------------------|
|
|
269
|
+
|**200** | Successful response | - |
|
|
270
|
+
|
|
271
|
+
[[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)
|
|
272
|
+
|
|
@@ -0,0 +1,326 @@
|
|
|
1
|
+
# EventsPassesResponsesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://admin-api.connected.dev*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**getEventPassResponse**](#geteventpassresponse) | **GET** /events/{eventId}/passes/{passId}/responses/{questionId} | Get Event Pass Response|
|
|
8
|
+
|[**getEventPassResponseChanges**](#geteventpassresponsechanges) | **GET** /events/{eventId}/passes/{passId}/responses/{questionId}/changes | Get Event Pass Response Changes|
|
|
9
|
+
|[**getEventPassResponses**](#geteventpassresponses) | **GET** /events/{eventId}/passes/{passId}/responses | Get Event Pass Responses|
|
|
10
|
+
|[**updateEventPassResponse**](#updateeventpassresponse) | **PUT** /events/{eventId}/passes/{passId}/responses/{questionId} | Update Event Pass Response|
|
|
11
|
+
|[**updateEventPassResponses**](#updateeventpassresponses) | **PUT** /events/{eventId}/attendees/{accountId}/passes/{passId}/responses | Update Event Pass Responses|
|
|
12
|
+
|
|
13
|
+
# **getEventPassResponse**
|
|
14
|
+
> GetEventPassResponse200Response getEventPassResponse()
|
|
15
|
+
|
|
16
|
+
Get Event Pass Response endpoint
|
|
17
|
+
|
|
18
|
+
### Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import {
|
|
22
|
+
EventsPassesResponsesApi,
|
|
23
|
+
Configuration
|
|
24
|
+
} from '@connectedxm/admin-sdk';
|
|
25
|
+
|
|
26
|
+
const configuration = new Configuration();
|
|
27
|
+
const apiInstance = new EventsPassesResponsesApi(configuration);
|
|
28
|
+
|
|
29
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
30
|
+
let passId: string; //The pass identifier (default to undefined)
|
|
31
|
+
let questionId: string; //The question identifier (default to undefined)
|
|
32
|
+
|
|
33
|
+
const { status, data } = await apiInstance.getEventPassResponse(
|
|
34
|
+
eventId,
|
|
35
|
+
passId,
|
|
36
|
+
questionId
|
|
37
|
+
);
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### Parameters
|
|
41
|
+
|
|
42
|
+
|Name | Type | Description | Notes|
|
|
43
|
+
|------------- | ------------- | ------------- | -------------|
|
|
44
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
45
|
+
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
46
|
+
| **questionId** | [**string**] | The question identifier | defaults to undefined|
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
### Return type
|
|
50
|
+
|
|
51
|
+
**GetEventPassResponse200Response**
|
|
52
|
+
|
|
53
|
+
### Authorization
|
|
54
|
+
|
|
55
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
56
|
+
|
|
57
|
+
### HTTP request headers
|
|
58
|
+
|
|
59
|
+
- **Content-Type**: Not defined
|
|
60
|
+
- **Accept**: application/json
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
### HTTP response details
|
|
64
|
+
| Status code | Description | Response headers |
|
|
65
|
+
|-------------|-------------|------------------|
|
|
66
|
+
|**200** | Successful response | - |
|
|
67
|
+
|
|
68
|
+
[[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)
|
|
69
|
+
|
|
70
|
+
# **getEventPassResponseChanges**
|
|
71
|
+
> GetEventPassResponseChanges200Response getEventPassResponseChanges()
|
|
72
|
+
|
|
73
|
+
Get Event Pass Response Changes endpoint
|
|
74
|
+
|
|
75
|
+
### Example
|
|
76
|
+
|
|
77
|
+
```typescript
|
|
78
|
+
import {
|
|
79
|
+
EventsPassesResponsesApi,
|
|
80
|
+
Configuration
|
|
81
|
+
} from '@connectedxm/admin-sdk';
|
|
82
|
+
|
|
83
|
+
const configuration = new Configuration();
|
|
84
|
+
const apiInstance = new EventsPassesResponsesApi(configuration);
|
|
85
|
+
|
|
86
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
87
|
+
let passId: string; //The pass identifier (default to undefined)
|
|
88
|
+
let questionId: string; //The question identifier (default to undefined)
|
|
89
|
+
let page: number; //Page number (optional) (default to 1)
|
|
90
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
91
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
92
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
93
|
+
|
|
94
|
+
const { status, data } = await apiInstance.getEventPassResponseChanges(
|
|
95
|
+
eventId,
|
|
96
|
+
passId,
|
|
97
|
+
questionId,
|
|
98
|
+
page,
|
|
99
|
+
pageSize,
|
|
100
|
+
orderBy,
|
|
101
|
+
search
|
|
102
|
+
);
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
### Parameters
|
|
106
|
+
|
|
107
|
+
|Name | Type | Description | Notes|
|
|
108
|
+
|------------- | ------------- | ------------- | -------------|
|
|
109
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
110
|
+
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
111
|
+
| **questionId** | [**string**] | The question identifier | defaults to undefined|
|
|
112
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
113
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
114
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
115
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
### Return type
|
|
119
|
+
|
|
120
|
+
**GetEventPassResponseChanges200Response**
|
|
121
|
+
|
|
122
|
+
### Authorization
|
|
123
|
+
|
|
124
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
125
|
+
|
|
126
|
+
### HTTP request headers
|
|
127
|
+
|
|
128
|
+
- **Content-Type**: Not defined
|
|
129
|
+
- **Accept**: application/json
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
### HTTP response details
|
|
133
|
+
| Status code | Description | Response headers |
|
|
134
|
+
|-------------|-------------|------------------|
|
|
135
|
+
|**200** | Successful response | - |
|
|
136
|
+
|
|
137
|
+
[[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)
|
|
138
|
+
|
|
139
|
+
# **getEventPassResponses**
|
|
140
|
+
> GetEventPassResponses200Response getEventPassResponses()
|
|
141
|
+
|
|
142
|
+
Get Event Pass Responses endpoint
|
|
143
|
+
|
|
144
|
+
### Example
|
|
145
|
+
|
|
146
|
+
```typescript
|
|
147
|
+
import {
|
|
148
|
+
EventsPassesResponsesApi,
|
|
149
|
+
Configuration
|
|
150
|
+
} from '@connectedxm/admin-sdk';
|
|
151
|
+
|
|
152
|
+
const configuration = new Configuration();
|
|
153
|
+
const apiInstance = new EventsPassesResponsesApi(configuration);
|
|
154
|
+
|
|
155
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
156
|
+
let passId: string; //The pass identifier (default to undefined)
|
|
157
|
+
let page: number; //Page number (optional) (default to 1)
|
|
158
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
159
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
160
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
161
|
+
|
|
162
|
+
const { status, data } = await apiInstance.getEventPassResponses(
|
|
163
|
+
eventId,
|
|
164
|
+
passId,
|
|
165
|
+
page,
|
|
166
|
+
pageSize,
|
|
167
|
+
orderBy,
|
|
168
|
+
search
|
|
169
|
+
);
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
### Parameters
|
|
173
|
+
|
|
174
|
+
|Name | Type | Description | Notes|
|
|
175
|
+
|------------- | ------------- | ------------- | -------------|
|
|
176
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
177
|
+
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
178
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
179
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
180
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
181
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
### Return type
|
|
185
|
+
|
|
186
|
+
**GetEventPassResponses200Response**
|
|
187
|
+
|
|
188
|
+
### Authorization
|
|
189
|
+
|
|
190
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
191
|
+
|
|
192
|
+
### HTTP request headers
|
|
193
|
+
|
|
194
|
+
- **Content-Type**: Not defined
|
|
195
|
+
- **Accept**: application/json
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
### HTTP response details
|
|
199
|
+
| Status code | Description | Response headers |
|
|
200
|
+
|-------------|-------------|------------------|
|
|
201
|
+
|**200** | Successful response | - |
|
|
202
|
+
|
|
203
|
+
[[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)
|
|
204
|
+
|
|
205
|
+
# **updateEventPassResponse**
|
|
206
|
+
> GetEventPassResponse200Response updateEventPassResponse(updateEventPassResponseInputs)
|
|
207
|
+
|
|
208
|
+
Update Event Pass Response endpoint
|
|
209
|
+
|
|
210
|
+
### Example
|
|
211
|
+
|
|
212
|
+
```typescript
|
|
213
|
+
import {
|
|
214
|
+
EventsPassesResponsesApi,
|
|
215
|
+
Configuration,
|
|
216
|
+
UpdateEventPassResponseInputs
|
|
217
|
+
} from '@connectedxm/admin-sdk';
|
|
218
|
+
|
|
219
|
+
const configuration = new Configuration();
|
|
220
|
+
const apiInstance = new EventsPassesResponsesApi(configuration);
|
|
221
|
+
|
|
222
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
223
|
+
let passId: string; //The pass identifier (default to undefined)
|
|
224
|
+
let questionId: string; //The question identifier (default to undefined)
|
|
225
|
+
let updateEventPassResponseInputs: UpdateEventPassResponseInputs; //
|
|
226
|
+
|
|
227
|
+
const { status, data } = await apiInstance.updateEventPassResponse(
|
|
228
|
+
eventId,
|
|
229
|
+
passId,
|
|
230
|
+
questionId,
|
|
231
|
+
updateEventPassResponseInputs
|
|
232
|
+
);
|
|
233
|
+
```
|
|
234
|
+
|
|
235
|
+
### Parameters
|
|
236
|
+
|
|
237
|
+
|Name | Type | Description | Notes|
|
|
238
|
+
|------------- | ------------- | ------------- | -------------|
|
|
239
|
+
| **updateEventPassResponseInputs** | **UpdateEventPassResponseInputs**| | |
|
|
240
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
241
|
+
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
242
|
+
| **questionId** | [**string**] | The question identifier | defaults to undefined|
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
### Return type
|
|
246
|
+
|
|
247
|
+
**GetEventPassResponse200Response**
|
|
248
|
+
|
|
249
|
+
### Authorization
|
|
250
|
+
|
|
251
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
252
|
+
|
|
253
|
+
### HTTP request headers
|
|
254
|
+
|
|
255
|
+
- **Content-Type**: application/json
|
|
256
|
+
- **Accept**: application/json
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
### HTTP response details
|
|
260
|
+
| Status code | Description | Response headers |
|
|
261
|
+
|-------------|-------------|------------------|
|
|
262
|
+
|**200** | Successful response | - |
|
|
263
|
+
|
|
264
|
+
[[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)
|
|
265
|
+
|
|
266
|
+
# **updateEventPassResponses**
|
|
267
|
+
> CreateAccountInvitations200Response updateEventPassResponses(updateEventPassResponsesInputs)
|
|
268
|
+
|
|
269
|
+
Update Event Pass Responses endpoint
|
|
270
|
+
|
|
271
|
+
### Example
|
|
272
|
+
|
|
273
|
+
```typescript
|
|
274
|
+
import {
|
|
275
|
+
EventsPassesResponsesApi,
|
|
276
|
+
Configuration,
|
|
277
|
+
UpdateEventPassResponsesInputs
|
|
278
|
+
} from '@connectedxm/admin-sdk';
|
|
279
|
+
|
|
280
|
+
const configuration = new Configuration();
|
|
281
|
+
const apiInstance = new EventsPassesResponsesApi(configuration);
|
|
282
|
+
|
|
283
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
284
|
+
let accountId: string; //The account identifier (default to undefined)
|
|
285
|
+
let passId: string; //The pass identifier (default to undefined)
|
|
286
|
+
let updateEventPassResponsesInputs: UpdateEventPassResponsesInputs; //
|
|
287
|
+
|
|
288
|
+
const { status, data } = await apiInstance.updateEventPassResponses(
|
|
289
|
+
eventId,
|
|
290
|
+
accountId,
|
|
291
|
+
passId,
|
|
292
|
+
updateEventPassResponsesInputs
|
|
293
|
+
);
|
|
294
|
+
```
|
|
295
|
+
|
|
296
|
+
### Parameters
|
|
297
|
+
|
|
298
|
+
|Name | Type | Description | Notes|
|
|
299
|
+
|------------- | ------------- | ------------- | -------------|
|
|
300
|
+
| **updateEventPassResponsesInputs** | **UpdateEventPassResponsesInputs**| | |
|
|
301
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
302
|
+
| **accountId** | [**string**] | The account identifier | defaults to undefined|
|
|
303
|
+
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
### Return type
|
|
307
|
+
|
|
308
|
+
**CreateAccountInvitations200Response**
|
|
309
|
+
|
|
310
|
+
### Authorization
|
|
311
|
+
|
|
312
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
313
|
+
|
|
314
|
+
### HTTP request headers
|
|
315
|
+
|
|
316
|
+
- **Content-Type**: application/json
|
|
317
|
+
- **Accept**: application/json
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
### HTTP response details
|
|
321
|
+
| Status code | Description | Response headers |
|
|
322
|
+
|-------------|-------------|------------------|
|
|
323
|
+
|**200** | Successful response | - |
|
|
324
|
+
|
|
325
|
+
[[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)
|
|
326
|
+
|
package/docs/SideEffect.md
CHANGED
|
@@ -10,23 +10,27 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**checkedInPassEventId** | **string** | | [default to undefined]
|
|
11
11
|
**newAccountTierId** | **string** | | [default to undefined]
|
|
12
12
|
**removedAccountTierId** | **string** | | [default to undefined]
|
|
13
|
+
**passWithQuestionChoiceId** | **string** | | [default to undefined]
|
|
13
14
|
**joinGroupId** | **string** | | [default to undefined]
|
|
14
15
|
**leaveGroupId** | **string** | | [default to undefined]
|
|
15
16
|
**addToTierId** | **string** | | [default to undefined]
|
|
16
17
|
**subscribeToChannelId** | **string** | | [default to undefined]
|
|
17
18
|
**sendWebhookId** | **string** | | [default to undefined]
|
|
18
19
|
**completeActivationId** | **string** | | [default to undefined]
|
|
20
|
+
**registerForSessionId** | **string** | | [default to undefined]
|
|
19
21
|
**organizationId** | **string** | | [default to undefined]
|
|
20
22
|
**newPassOfPassType** | [**BaseEventPassType**](BaseEventPassType.md) | | [default to undefined]
|
|
21
23
|
**checkedInPassEvent** | [**BaseEvent**](BaseEvent.md) | | [default to undefined]
|
|
22
24
|
**newAccountTier** | [**BaseTier**](BaseTier.md) | | [default to undefined]
|
|
23
25
|
**removedAccountTier** | [**BaseTier**](BaseTier.md) | | [default to undefined]
|
|
26
|
+
**passWithQuestionChoice** | [**BaseRegistrationQuestionChoice**](BaseRegistrationQuestionChoice.md) | | [default to undefined]
|
|
24
27
|
**joinGroup** | [**BaseGroup**](BaseGroup.md) | | [default to undefined]
|
|
25
28
|
**leaveGroup** | [**BaseGroup**](BaseGroup.md) | | [default to undefined]
|
|
26
29
|
**addToTier** | [**BaseTier**](BaseTier.md) | | [default to undefined]
|
|
27
30
|
**subscribeToChannel** | [**BaseChannel**](BaseChannel.md) | | [default to undefined]
|
|
28
31
|
**sendWebhook** | [**BaseWebhook**](BaseWebhook.md) | | [default to undefined]
|
|
29
32
|
**completeActivation** | [**BaseEventActivation**](BaseEventActivation.md) | | [default to undefined]
|
|
33
|
+
**registerForSession** | [**BaseEventSession**](BaseEventSession.md) | | [default to undefined]
|
|
30
34
|
**createdAt** | **string** | | [default to undefined]
|
|
31
35
|
**updatedAt** | **string** | | [default to undefined]
|
|
32
36
|
|
|
@@ -41,23 +45,27 @@ const instance: SideEffect = {
|
|
|
41
45
|
checkedInPassEventId,
|
|
42
46
|
newAccountTierId,
|
|
43
47
|
removedAccountTierId,
|
|
48
|
+
passWithQuestionChoiceId,
|
|
44
49
|
joinGroupId,
|
|
45
50
|
leaveGroupId,
|
|
46
51
|
addToTierId,
|
|
47
52
|
subscribeToChannelId,
|
|
48
53
|
sendWebhookId,
|
|
49
54
|
completeActivationId,
|
|
55
|
+
registerForSessionId,
|
|
50
56
|
organizationId,
|
|
51
57
|
newPassOfPassType,
|
|
52
58
|
checkedInPassEvent,
|
|
53
59
|
newAccountTier,
|
|
54
60
|
removedAccountTier,
|
|
61
|
+
passWithQuestionChoice,
|
|
55
62
|
joinGroup,
|
|
56
63
|
leaveGroup,
|
|
57
64
|
addToTier,
|
|
58
65
|
subscribeToChannel,
|
|
59
66
|
sendWebhook,
|
|
60
67
|
completeActivation,
|
|
68
|
+
registerForSession,
|
|
61
69
|
createdAt,
|
|
62
70
|
updatedAt,
|
|
63
71
|
};
|
|
@@ -15,4 +15,6 @@
|
|
|
15
15
|
|
|
16
16
|
* `CompleteActivation` (value: `'COMPLETE_ACTIVATION'`)
|
|
17
17
|
|
|
18
|
+
* `RegisterForSession` (value: `'REGISTER_FOR_SESSION'`)
|
|
19
|
+
|
|
18
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)
|
|
@@ -3,12 +3,14 @@
|
|
|
3
3
|
|
|
4
4
|
## Enum
|
|
5
5
|
|
|
6
|
-
* `NewPassOfPassType` (value: `'NEW_PASS_OF_PASS_TYPE'`)
|
|
7
|
-
|
|
8
6
|
* `CheckedInEventPass` (value: `'CHECKED_IN_EVENT_PASS'`)
|
|
9
7
|
|
|
10
8
|
* `NewAccountTier` (value: `'NEW_ACCOUNT_TIER'`)
|
|
11
9
|
|
|
12
10
|
* `RemovedAccountTier` (value: `'REMOVED_ACCOUNT_TIER'`)
|
|
13
11
|
|
|
12
|
+
* `NewPassOfPassType` (value: `'NEW_PASS_OF_PASS_TYPE'`)
|
|
13
|
+
|
|
14
|
+
* `PassWithQuestionChoice` (value: `'PASS_WITH_QUESTION_CHOICE'`)
|
|
15
|
+
|
|
14
16
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UpdateEventPassResponsesInputs
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**questions** | [**Array<Question>**](Question.md) | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { UpdateEventPassResponsesInputs } from '@connectedxm/admin-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: UpdateEventPassResponsesInputs = {
|
|
16
|
+
questions,
|
|
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)
|