@connectedxm/admin-sdk 6.9.0 → 6.14.0
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 +41 -8
- package/AdminApi.ts +18 -0
- package/README.md +69 -12
- package/api.ts +4508 -708
- package/dist/AdminApi.d.ts +7 -1
- package/dist/AdminApi.js +6 -0
- package/dist/api.d.ts +2356 -293
- package/dist/api.js +3612 -918
- package/dist/esm/AdminApi.d.ts +7 -1
- package/dist/esm/AdminApi.js +7 -1
- package/dist/esm/api.d.ts +2356 -293
- package/dist/esm/api.js +3569 -900
- package/docs/AccountAttribute.md +3 -1
- package/docs/AccountAttributeCreateInputs.md +7 -1
- package/docs/AccountAttributeType.md +20 -0
- package/docs/AccountAttributeUpdateInputs.md +6 -0
- package/docs/BaseAccountAttribute.md +3 -1
- package/docs/BaseEventActivation.md +2 -0
- package/docs/{EventTrackAllOfCount.md → BaseEventActivationCount.md} +3 -3
- package/docs/{BaseRegistrationQuestionChoiceQuestion.md → BaseEventAttribute.md} +3 -3
- package/docs/BaseEventBlock.md +2 -0
- package/docs/BaseEventOnSite.md +2 -2
- package/docs/BaseEventPass.md +2 -0
- package/docs/BaseEventSession.md +2 -4
- package/docs/BaseEventSessionQuestionChoice.md +1 -1
- package/docs/BasePassAttribute.md +26 -0
- package/docs/BasePassAttributeAttribute.md +22 -0
- package/docs/BasePayment.md +2 -0
- package/docs/BaseRegistrationQuestionChoice.md +1 -1
- package/docs/BaseSeriesQuestion.md +60 -0
- package/docs/BaseSeriesQuestionChoice.md +30 -0
- package/docs/BaseSeriesRegistration.md +2 -0
- package/docs/BaseSeriesRegistrationQuestionResponse.md +26 -0
- package/docs/BaseSideEffect.md +2 -0
- package/docs/BaseSurveyQuestionChoice.md +1 -1
- package/docs/CloneOptions.md +2 -0
- package/docs/Event.md +4 -0
- package/docs/EventActivation.md +6 -0
- package/docs/EventActivationCreateInputs.md +4 -0
- package/docs/EventActivationUpdateInputs.md +4 -0
- package/docs/EventAttribute.md +26 -0
- package/docs/EventAttributeCreateInputs.md +20 -0
- package/docs/EventAttributeUpdateInputs.md +20 -0
- package/docs/EventBlock.md +2 -0
- package/docs/EventBlockCreateInputs.md +2 -0
- package/docs/EventBlockUpdateInputs.md +2 -0
- package/docs/EventCreateInputs.md +4 -0
- package/docs/EventMediaItemTranslation.md +30 -0
- package/docs/EventMediaItemTranslationUpdateInputs.md +22 -0
- package/docs/EventOnSite.md +2 -4
- package/docs/EventPass.md +8 -0
- package/docs/EventPassCreateInputs.md +2 -0
- package/docs/EventPassType.md +4 -0
- package/docs/EventPassUpdateInputs.md +2 -0
- package/docs/EventRoomTypeReservationPassesInner.md +1 -1
- package/docs/EventSession.md +12 -4
- package/docs/EventSessionCloneOptions.md +22 -0
- package/docs/EventSessionCreateInputs.md +8 -4
- package/docs/EventSessionUpdateInputs.md +8 -4
- package/docs/{SessionAccess.md → EventSessionVisibility.md} +6 -2
- package/docs/EventTrack.md +1 -1
- package/docs/EventUpdateInputs.md +4 -0
- package/docs/EventsActivationsApi.md +67 -0
- package/docs/EventsActivationsSessionsApi.md +123 -0
- package/docs/EventsAttributesApi.md +296 -0
- package/docs/EventsOnSiteApi.md +9 -187
- package/docs/EventsPassesAttributesApi.md +191 -0
- package/docs/EventsSessionsApi.md +242 -0
- package/docs/{BadgeFieldTransformation.md → OnSiteScanType.md} +5 -3
- package/docs/PassAttribute.md +30 -0
- package/docs/PassAttributesUpdateInputs.md +20 -0
- package/docs/PassAttributesUpdateInputsValuesInner.md +22 -0
- package/docs/PassTypeCreateInputs.md +4 -0
- package/docs/PassTypeUpdateInputs.md +4 -0
- package/docs/Payment.md +4 -0
- package/docs/PaymentLineItem.md +2 -0
- package/docs/PaymentLineItemType.md +2 -0
- package/docs/Series.md +6 -0
- package/docs/SeriesApi.md +64 -0
- package/docs/SeriesCreateInputs.md +6 -0
- package/docs/SeriesQuestion.md +68 -0
- package/docs/SeriesQuestionChoice.md +38 -0
- package/docs/SeriesQuestionChoiceCreateInputs.md +28 -0
- package/docs/SeriesQuestionChoiceTranslation.md +32 -0
- package/docs/SeriesQuestionChoiceUpdateInputs.md +28 -0
- package/docs/SeriesQuestionCreateInputs.md +56 -0
- package/docs/SeriesQuestionTranslation.md +32 -0
- package/docs/SeriesQuestionTranslationUpdateInputs.md +24 -0
- package/docs/SeriesQuestionType.md +30 -0
- package/docs/SeriesQuestionUpdateInputs.md +56 -0
- package/docs/SeriesQuestionUpdateInputsChoices.md +18 -0
- package/docs/SeriesQuestionsApi.md +421 -0
- package/docs/SeriesQuestionsChoicesApi.md +244 -0
- package/docs/SeriesRegistration.md +4 -0
- package/docs/SeriesRegistrationQuestionResponse.md +34 -0
- package/docs/SeriesRegistrationResponsesUpdateInputs.md +20 -0
- package/docs/SeriesRegistrationResponsesUpdateInputsResponsesInner.md +22 -0
- package/docs/SeriesRegistrationsApi.md +194 -1
- package/docs/SeriesTranslation.md +38 -0
- package/docs/SeriesTranslationUpdateInputs.md +28 -0
- package/docs/SeriesUpdateInputs.md +6 -0
- package/docs/SideEffect.md +4 -0
- package/docs/SideEffectActionType.md +2 -0
- package/docs/Survey.md +0 -4
- package/docs/SurveyCreateInputs.md +0 -2
- package/docs/SurveyUpdateInputs.md +0 -2
- package/docs/SurveysApi.md +64 -0
- package/docs/SurveysSessionsApi.md +117 -0
- package/package.json +1 -1
- package/docs/BadgeFieldType.md +0 -20
- package/docs/BaseEventOnSiteBadgeField.md +0 -44
- package/docs/EventBadgeFieldUpdateInputs.md +0 -34
- package/docs/EventOnSiteBadgeField.md +0 -46
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# SeriesRegistrationQuestionResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**value** | **string** | | [default to undefined]
|
|
10
|
+
**questionId** | **string** | | [default to undefined]
|
|
11
|
+
**question** | [**BaseSeriesQuestion**](BaseSeriesQuestion.md) | | [default to undefined]
|
|
12
|
+
**fileId** | **number** | | [default to undefined]
|
|
13
|
+
**file** | [**BaseFile**](BaseFile.md) | | [default to undefined]
|
|
14
|
+
**createdAt** | **string** | | [default to undefined]
|
|
15
|
+
**updatedAt** | **string** | | [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { SeriesRegistrationQuestionResponse } from '@connectedxm/admin-sdk';
|
|
21
|
+
|
|
22
|
+
const instance: SeriesRegistrationQuestionResponse = {
|
|
23
|
+
id,
|
|
24
|
+
value,
|
|
25
|
+
questionId,
|
|
26
|
+
question,
|
|
27
|
+
fileId,
|
|
28
|
+
file,
|
|
29
|
+
createdAt,
|
|
30
|
+
updatedAt,
|
|
31
|
+
};
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[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
|
+
# SeriesRegistrationResponsesUpdateInputs
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**responses** | [**Array<SeriesRegistrationResponsesUpdateInputsResponsesInner>**](SeriesRegistrationResponsesUpdateInputsResponsesInner.md) | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { SeriesRegistrationResponsesUpdateInputs } from '@connectedxm/admin-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: SeriesRegistrationResponsesUpdateInputs = {
|
|
16
|
+
responses,
|
|
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)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# SeriesRegistrationResponsesUpdateInputsResponsesInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**questionId** | **string** | | [default to undefined]
|
|
9
|
+
**value** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { SeriesRegistrationResponsesUpdateInputsResponsesInner } from '@connectedxm/admin-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: SeriesRegistrationResponsesUpdateInputsResponsesInner = {
|
|
17
|
+
questionId,
|
|
18
|
+
value,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -8,8 +8,11 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
8
8
|
|[**deleteSeriesRegistration**](#deleteseriesregistration) | **DELETE** /series/{seriesId}/registrations/{registrationId} | Delete Series Registration|
|
|
9
9
|
|[**getSeriesRegistration**](#getseriesregistration) | **GET** /series/{seriesId}/registrations/{registrationId} | Get Series Registration|
|
|
10
10
|
|[**getSeriesRegistrationPasses**](#getseriesregistrationpasses) | **GET** /series/{seriesId}/registrations/{registrationId}/passes | Get Series Registration Passes|
|
|
11
|
+
|[**getSeriesRegistrationPayments**](#getseriesregistrationpayments) | **GET** /series/{seriesId}/registrations/{registrationId}/payments | Get Series Registration Payments|
|
|
12
|
+
|[**getSeriesRegistrationResponses**](#getseriesregistrationresponses) | **GET** /series/{seriesId}/registrations/{registrationId}/responses | Get Series Registration Responses|
|
|
11
13
|
|[**getSeriesRegistrations**](#getseriesregistrations) | **GET** /series/{seriesId}/registrations | Get Series Registrations|
|
|
12
14
|
|[**updateSeriesRegistration**](#updateseriesregistration) | **PUT** /series/{seriesId}/registrations/{registrationId} | Update Series Registration|
|
|
15
|
+
|[**updateSeriesRegistrationResponses**](#updateseriesregistrationresponses) | **PUT** /series/{seriesId}/registrations/{registrationId}/responses | Update Series Registration Responses|
|
|
13
16
|
|
|
14
17
|
# **createSeriesRegistration**
|
|
15
18
|
> CreateAccountAddress200Response createSeriesRegistration(seriesRegistrationCreateInputs)
|
|
@@ -175,7 +178,7 @@ const { status, data } = await apiInstance.getSeriesRegistration(
|
|
|
175
178
|
[[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)
|
|
176
179
|
|
|
177
180
|
# **getSeriesRegistrationPasses**
|
|
178
|
-
>
|
|
181
|
+
> GetAccountInvitations200Response getSeriesRegistrationPasses()
|
|
179
182
|
|
|
180
183
|
Get Series Registration Passes endpoint
|
|
181
184
|
|
|
@@ -192,8 +195,140 @@ const apiInstance = new SeriesRegistrationsApi(configuration);
|
|
|
192
195
|
|
|
193
196
|
let seriesId: string; //The series identifier (default to undefined)
|
|
194
197
|
let registrationId: string; //The registration identifier (default to undefined)
|
|
198
|
+
let page: number; //Page number (optional) (default to 1)
|
|
199
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
200
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
201
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
195
202
|
|
|
196
203
|
const { status, data } = await apiInstance.getSeriesRegistrationPasses(
|
|
204
|
+
seriesId,
|
|
205
|
+
registrationId,
|
|
206
|
+
page,
|
|
207
|
+
pageSize,
|
|
208
|
+
orderBy,
|
|
209
|
+
search
|
|
210
|
+
);
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
### Parameters
|
|
214
|
+
|
|
215
|
+
|Name | Type | Description | Notes|
|
|
216
|
+
|------------- | ------------- | ------------- | -------------|
|
|
217
|
+
| **seriesId** | [**string**] | The series identifier | defaults to undefined|
|
|
218
|
+
| **registrationId** | [**string**] | The registration identifier | defaults to undefined|
|
|
219
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
220
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
221
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
222
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
### Return type
|
|
226
|
+
|
|
227
|
+
**GetAccountInvitations200Response**
|
|
228
|
+
|
|
229
|
+
### Authorization
|
|
230
|
+
|
|
231
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
232
|
+
|
|
233
|
+
### HTTP request headers
|
|
234
|
+
|
|
235
|
+
- **Content-Type**: Not defined
|
|
236
|
+
- **Accept**: application/json
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
### HTTP response details
|
|
240
|
+
| Status code | Description | Response headers |
|
|
241
|
+
|-------------|-------------|------------------|
|
|
242
|
+
|**200** | Successful response | - |
|
|
243
|
+
|
|
244
|
+
[[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)
|
|
245
|
+
|
|
246
|
+
# **getSeriesRegistrationPayments**
|
|
247
|
+
> GetAccountInvitations200Response getSeriesRegistrationPayments()
|
|
248
|
+
|
|
249
|
+
Get Series Registration Payments endpoint
|
|
250
|
+
|
|
251
|
+
### Example
|
|
252
|
+
|
|
253
|
+
```typescript
|
|
254
|
+
import {
|
|
255
|
+
SeriesRegistrationsApi,
|
|
256
|
+
Configuration
|
|
257
|
+
} from '@connectedxm/admin-sdk';
|
|
258
|
+
|
|
259
|
+
const configuration = new Configuration();
|
|
260
|
+
const apiInstance = new SeriesRegistrationsApi(configuration);
|
|
261
|
+
|
|
262
|
+
let seriesId: string; //The series identifier (default to undefined)
|
|
263
|
+
let registrationId: string; //The registration identifier (default to undefined)
|
|
264
|
+
let page: number; //Page number (optional) (default to 1)
|
|
265
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
266
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
267
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
268
|
+
|
|
269
|
+
const { status, data } = await apiInstance.getSeriesRegistrationPayments(
|
|
270
|
+
seriesId,
|
|
271
|
+
registrationId,
|
|
272
|
+
page,
|
|
273
|
+
pageSize,
|
|
274
|
+
orderBy,
|
|
275
|
+
search
|
|
276
|
+
);
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
### Parameters
|
|
280
|
+
|
|
281
|
+
|Name | Type | Description | Notes|
|
|
282
|
+
|------------- | ------------- | ------------- | -------------|
|
|
283
|
+
| **seriesId** | [**string**] | The series identifier | defaults to undefined|
|
|
284
|
+
| **registrationId** | [**string**] | The registration identifier | defaults to undefined|
|
|
285
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
286
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
287
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
288
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
### Return type
|
|
292
|
+
|
|
293
|
+
**GetAccountInvitations200Response**
|
|
294
|
+
|
|
295
|
+
### Authorization
|
|
296
|
+
|
|
297
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
298
|
+
|
|
299
|
+
### HTTP request headers
|
|
300
|
+
|
|
301
|
+
- **Content-Type**: Not defined
|
|
302
|
+
- **Accept**: application/json
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
### HTTP response details
|
|
306
|
+
| Status code | Description | Response headers |
|
|
307
|
+
|-------------|-------------|------------------|
|
|
308
|
+
|**200** | Successful response | - |
|
|
309
|
+
|
|
310
|
+
[[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)
|
|
311
|
+
|
|
312
|
+
# **getSeriesRegistrationResponses**
|
|
313
|
+
> CreateAccountAddress200Response getSeriesRegistrationResponses()
|
|
314
|
+
|
|
315
|
+
Get Series Registration Responses endpoint
|
|
316
|
+
|
|
317
|
+
### Example
|
|
318
|
+
|
|
319
|
+
```typescript
|
|
320
|
+
import {
|
|
321
|
+
SeriesRegistrationsApi,
|
|
322
|
+
Configuration
|
|
323
|
+
} from '@connectedxm/admin-sdk';
|
|
324
|
+
|
|
325
|
+
const configuration = new Configuration();
|
|
326
|
+
const apiInstance = new SeriesRegistrationsApi(configuration);
|
|
327
|
+
|
|
328
|
+
let seriesId: string; //The series identifier (default to undefined)
|
|
329
|
+
let registrationId: string; //The registration identifier (default to undefined)
|
|
330
|
+
|
|
331
|
+
const { status, data } = await apiInstance.getSeriesRegistrationResponses(
|
|
197
332
|
seriesId,
|
|
198
333
|
registrationId
|
|
199
334
|
);
|
|
@@ -352,3 +487,61 @@ const { status, data } = await apiInstance.updateSeriesRegistration(
|
|
|
352
487
|
|
|
353
488
|
[[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)
|
|
354
489
|
|
|
490
|
+
# **updateSeriesRegistrationResponses**
|
|
491
|
+
> CreateAccountAddress200Response updateSeriesRegistrationResponses(seriesRegistrationResponsesUpdateInputs)
|
|
492
|
+
|
|
493
|
+
Update Series Registration Responses endpoint
|
|
494
|
+
|
|
495
|
+
### Example
|
|
496
|
+
|
|
497
|
+
```typescript
|
|
498
|
+
import {
|
|
499
|
+
SeriesRegistrationsApi,
|
|
500
|
+
Configuration,
|
|
501
|
+
SeriesRegistrationResponsesUpdateInputs
|
|
502
|
+
} from '@connectedxm/admin-sdk';
|
|
503
|
+
|
|
504
|
+
const configuration = new Configuration();
|
|
505
|
+
const apiInstance = new SeriesRegistrationsApi(configuration);
|
|
506
|
+
|
|
507
|
+
let seriesId: string; //The series identifier (default to undefined)
|
|
508
|
+
let registrationId: string; //The registration identifier (default to undefined)
|
|
509
|
+
let seriesRegistrationResponsesUpdateInputs: SeriesRegistrationResponsesUpdateInputs; //
|
|
510
|
+
|
|
511
|
+
const { status, data } = await apiInstance.updateSeriesRegistrationResponses(
|
|
512
|
+
seriesId,
|
|
513
|
+
registrationId,
|
|
514
|
+
seriesRegistrationResponsesUpdateInputs
|
|
515
|
+
);
|
|
516
|
+
```
|
|
517
|
+
|
|
518
|
+
### Parameters
|
|
519
|
+
|
|
520
|
+
|Name | Type | Description | Notes|
|
|
521
|
+
|------------- | ------------- | ------------- | -------------|
|
|
522
|
+
| **seriesRegistrationResponsesUpdateInputs** | **SeriesRegistrationResponsesUpdateInputs**| | |
|
|
523
|
+
| **seriesId** | [**string**] | The series identifier | defaults to undefined|
|
|
524
|
+
| **registrationId** | [**string**] | The registration identifier | defaults to undefined|
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
### Return type
|
|
528
|
+
|
|
529
|
+
**CreateAccountAddress200Response**
|
|
530
|
+
|
|
531
|
+
### Authorization
|
|
532
|
+
|
|
533
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
534
|
+
|
|
535
|
+
### HTTP request headers
|
|
536
|
+
|
|
537
|
+
- **Content-Type**: application/json
|
|
538
|
+
- **Accept**: application/json
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
### HTTP response details
|
|
542
|
+
| Status code | Description | Response headers |
|
|
543
|
+
|-------------|-------------|------------------|
|
|
544
|
+
|**200** | Successful response | - |
|
|
545
|
+
|
|
546
|
+
[[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)
|
|
547
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# SeriesTranslation
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **number** | | [default to undefined]
|
|
9
|
+
**locale** | **string** | | [default to undefined]
|
|
10
|
+
**name** | **string** | | [default to undefined]
|
|
11
|
+
**description** | **string** | | [default to undefined]
|
|
12
|
+
**longDescription** | **string** | | [default to undefined]
|
|
13
|
+
**subject** | **string** | | [default to undefined]
|
|
14
|
+
**replyTo** | **string** | | [default to undefined]
|
|
15
|
+
**body** | **string** | | [default to undefined]
|
|
16
|
+
**createdAt** | **string** | | [default to undefined]
|
|
17
|
+
**updatedAt** | **string** | | [default to undefined]
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { SeriesTranslation } from '@connectedxm/admin-sdk';
|
|
23
|
+
|
|
24
|
+
const instance: SeriesTranslation = {
|
|
25
|
+
id,
|
|
26
|
+
locale,
|
|
27
|
+
name,
|
|
28
|
+
description,
|
|
29
|
+
longDescription,
|
|
30
|
+
subject,
|
|
31
|
+
replyTo,
|
|
32
|
+
body,
|
|
33
|
+
createdAt,
|
|
34
|
+
updatedAt,
|
|
35
|
+
};
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
[[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,28 @@
|
|
|
1
|
+
# SeriesTranslationUpdateInputs
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**description** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**longDescription** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**subject** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**body** | **string** | | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { SeriesTranslationUpdateInputs } from '@connectedxm/admin-sdk';
|
|
18
|
+
|
|
19
|
+
const instance: SeriesTranslationUpdateInputs = {
|
|
20
|
+
name,
|
|
21
|
+
description,
|
|
22
|
+
longDescription,
|
|
23
|
+
subject,
|
|
24
|
+
body,
|
|
25
|
+
};
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -18,6 +18,9 @@ Name | Type | Description | Notes
|
|
|
18
18
|
**taxCode** | **string** | | [optional] [default to undefined]
|
|
19
19
|
**taxIncluded** | **boolean** | | [optional] [default to undefined]
|
|
20
20
|
**taxLocation** | [**TaxLocationType**](TaxLocationType.md) | | [optional] [default to undefined]
|
|
21
|
+
**subject** | **string** | | [optional] [default to undefined]
|
|
22
|
+
**replyTo** | **string** | | [optional] [default to undefined]
|
|
23
|
+
**body** | **string** | | [optional] [default to undefined]
|
|
21
24
|
|
|
22
25
|
## Example
|
|
23
26
|
|
|
@@ -38,6 +41,9 @@ const instance: SeriesUpdateInputs = {
|
|
|
38
41
|
taxCode,
|
|
39
42
|
taxIncluded,
|
|
40
43
|
taxLocation,
|
|
44
|
+
subject,
|
|
45
|
+
replyTo,
|
|
46
|
+
body,
|
|
41
47
|
};
|
|
42
48
|
```
|
|
43
49
|
|
package/docs/SideEffect.md
CHANGED
|
@@ -15,6 +15,7 @@ Name | Type | Description | Notes
|
|
|
15
15
|
**addToTierId** | **string** | | [default to undefined]
|
|
16
16
|
**subscribeToChannelId** | **string** | | [default to undefined]
|
|
17
17
|
**sendWebhookId** | **string** | | [default to undefined]
|
|
18
|
+
**completeActivationId** | **string** | | [default to undefined]
|
|
18
19
|
**organizationId** | **string** | | [default to undefined]
|
|
19
20
|
**newPassOfPassType** | [**BaseEventPassType**](BaseEventPassType.md) | | [default to undefined]
|
|
20
21
|
**checkedInPassEvent** | [**BaseEvent**](BaseEvent.md) | | [default to undefined]
|
|
@@ -25,6 +26,7 @@ Name | Type | Description | Notes
|
|
|
25
26
|
**addToTier** | [**BaseTier**](BaseTier.md) | | [default to undefined]
|
|
26
27
|
**subscribeToChannel** | [**BaseChannel**](BaseChannel.md) | | [default to undefined]
|
|
27
28
|
**sendWebhook** | [**BaseWebhook**](BaseWebhook.md) | | [default to undefined]
|
|
29
|
+
**completeActivation** | [**BaseEventActivation**](BaseEventActivation.md) | | [default to undefined]
|
|
28
30
|
**createdAt** | **string** | | [default to undefined]
|
|
29
31
|
**updatedAt** | **string** | | [default to undefined]
|
|
30
32
|
|
|
@@ -44,6 +46,7 @@ const instance: SideEffect = {
|
|
|
44
46
|
addToTierId,
|
|
45
47
|
subscribeToChannelId,
|
|
46
48
|
sendWebhookId,
|
|
49
|
+
completeActivationId,
|
|
47
50
|
organizationId,
|
|
48
51
|
newPassOfPassType,
|
|
49
52
|
checkedInPassEvent,
|
|
@@ -54,6 +57,7 @@ const instance: SideEffect = {
|
|
|
54
57
|
addToTier,
|
|
55
58
|
subscribeToChannel,
|
|
56
59
|
sendWebhook,
|
|
60
|
+
completeActivation,
|
|
57
61
|
createdAt,
|
|
58
62
|
updatedAt,
|
|
59
63
|
};
|
|
@@ -13,4 +13,6 @@
|
|
|
13
13
|
|
|
14
14
|
* `SendWebhook` (value: `'SEND_WEBHOOK'`)
|
|
15
15
|
|
|
16
|
+
* `CompleteActivation` (value: `'COMPLETE_ACTIVATION'`)
|
|
17
|
+
|
|
16
18
|
[[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
|
@@ -19,8 +19,6 @@ Name | Type | Description | Notes
|
|
|
19
19
|
**updatedAt** | **string** | | [default to undefined]
|
|
20
20
|
**eventId** | **string** | | [default to undefined]
|
|
21
21
|
**event** | [**BaseEvent**](BaseEvent.md) | | [default to undefined]
|
|
22
|
-
**sessionId** | **string** | | [default to undefined]
|
|
23
|
-
**session** | [**BaseEventSession**](BaseEventSession.md) | | [default to undefined]
|
|
24
22
|
**activationId** | **string** | | [default to undefined]
|
|
25
23
|
**activation** | [**BaseEventActivation**](BaseEventActivation.md) | | [default to undefined]
|
|
26
24
|
**passTypes** | [**Array<BaseEventPassType>**](BaseEventPassType.md) | | [default to undefined]
|
|
@@ -46,8 +44,6 @@ const instance: Survey = {
|
|
|
46
44
|
updatedAt,
|
|
47
45
|
eventId,
|
|
48
46
|
event,
|
|
49
|
-
sessionId,
|
|
50
|
-
session,
|
|
51
47
|
activationId,
|
|
52
48
|
activation,
|
|
53
49
|
passTypes,
|
|
@@ -15,7 +15,6 @@ Name | Type | Description | Notes
|
|
|
15
15
|
**replyTo** | **string** | | [optional] [default to undefined]
|
|
16
16
|
**emailBody** | **string** | | [optional] [default to undefined]
|
|
17
17
|
**eventId** | **string** | | [optional] [default to undefined]
|
|
18
|
-
**sessionId** | **string** | | [optional] [default to undefined]
|
|
19
18
|
**activationId** | **string** | | [optional] [default to undefined]
|
|
20
19
|
|
|
21
20
|
## Example
|
|
@@ -34,7 +33,6 @@ const instance: SurveyCreateInputs = {
|
|
|
34
33
|
replyTo,
|
|
35
34
|
emailBody,
|
|
36
35
|
eventId,
|
|
37
|
-
sessionId,
|
|
38
36
|
activationId,
|
|
39
37
|
};
|
|
40
38
|
```
|
|
@@ -15,7 +15,6 @@ Name | Type | Description | Notes
|
|
|
15
15
|
**replyTo** | **string** | | [optional] [default to undefined]
|
|
16
16
|
**emailBody** | **string** | | [optional] [default to undefined]
|
|
17
17
|
**eventId** | **string** | | [optional] [default to undefined]
|
|
18
|
-
**sessionId** | **string** | | [optional] [default to undefined]
|
|
19
18
|
**activationId** | **string** | | [optional] [default to undefined]
|
|
20
19
|
|
|
21
20
|
## Example
|
|
@@ -34,7 +33,6 @@ const instance: SurveyUpdateInputs = {
|
|
|
34
33
|
replyTo,
|
|
35
34
|
emailBody,
|
|
36
35
|
eventId,
|
|
37
|
-
sessionId,
|
|
38
36
|
activationId,
|
|
39
37
|
};
|
|
40
38
|
```
|
package/docs/SurveysApi.md
CHANGED
|
@@ -7,6 +7,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
7
7
|
|[**createSurvey**](#createsurvey) | **POST** /surveys | Create Survey|
|
|
8
8
|
|[**deleteSurvey**](#deletesurvey) | **DELETE** /surveys/{surveyId} | Delete Survey|
|
|
9
9
|
|[**getSurvey**](#getsurvey) | **GET** /surveys/{surveyId} | Get Survey|
|
|
10
|
+
|[**getSurveySessions**](#getsurveysessions) | **GET** /surveys/{surveyId}/sessions | Get Survey Sessions|
|
|
10
11
|
|[**getSurveys**](#getsurveys) | **GET** /surveys | Get Surveys|
|
|
11
12
|
|[**updateSurvey**](#updatesurvey) | **PUT** /surveys/{surveyId} | Update Survey|
|
|
12
13
|
|
|
@@ -157,6 +158,69 @@ const { status, data } = await apiInstance.getSurvey(
|
|
|
157
158
|
- **Accept**: application/json
|
|
158
159
|
|
|
159
160
|
|
|
161
|
+
### HTTP response details
|
|
162
|
+
| Status code | Description | Response headers |
|
|
163
|
+
|-------------|-------------|------------------|
|
|
164
|
+
|**200** | Successful response | - |
|
|
165
|
+
|
|
166
|
+
[[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)
|
|
167
|
+
|
|
168
|
+
# **getSurveySessions**
|
|
169
|
+
> GetEventSessions200Response getSurveySessions()
|
|
170
|
+
|
|
171
|
+
Get Survey Sessions endpoint
|
|
172
|
+
|
|
173
|
+
### Example
|
|
174
|
+
|
|
175
|
+
```typescript
|
|
176
|
+
import {
|
|
177
|
+
SurveysApi,
|
|
178
|
+
Configuration
|
|
179
|
+
} from '@connectedxm/admin-sdk';
|
|
180
|
+
|
|
181
|
+
const configuration = new Configuration();
|
|
182
|
+
const apiInstance = new SurveysApi(configuration);
|
|
183
|
+
|
|
184
|
+
let surveyId: string; //The survey identifier (default to undefined)
|
|
185
|
+
let page: number; //Page number (optional) (default to 1)
|
|
186
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
187
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
188
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
189
|
+
|
|
190
|
+
const { status, data } = await apiInstance.getSurveySessions(
|
|
191
|
+
surveyId,
|
|
192
|
+
page,
|
|
193
|
+
pageSize,
|
|
194
|
+
orderBy,
|
|
195
|
+
search
|
|
196
|
+
);
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
### Parameters
|
|
200
|
+
|
|
201
|
+
|Name | Type | Description | Notes|
|
|
202
|
+
|------------- | ------------- | ------------- | -------------|
|
|
203
|
+
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
|
|
204
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
205
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
206
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
207
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
### Return type
|
|
211
|
+
|
|
212
|
+
**GetEventSessions200Response**
|
|
213
|
+
|
|
214
|
+
### Authorization
|
|
215
|
+
|
|
216
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
217
|
+
|
|
218
|
+
### HTTP request headers
|
|
219
|
+
|
|
220
|
+
- **Content-Type**: Not defined
|
|
221
|
+
- **Accept**: application/json
|
|
222
|
+
|
|
223
|
+
|
|
160
224
|
### HTTP response details
|
|
161
225
|
| Status code | Description | Response headers |
|
|
162
226
|
|-------------|-------------|------------------|
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
# SurveysSessionsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://admin-api.connected.dev*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**addSurveySession**](#addsurveysession) | **POST** /surveys/{surveyId}/sessions/{sessionId} | Add Survey Session|
|
|
8
|
+
|[**removeSurveySession**](#removesurveysession) | **DELETE** /surveys/{surveyId}/sessions/{sessionId} | Remove Survey Session|
|
|
9
|
+
|
|
10
|
+
# **addSurveySession**
|
|
11
|
+
> CreateSurvey200Response addSurveySession()
|
|
12
|
+
|
|
13
|
+
Add Survey Session endpoint
|
|
14
|
+
|
|
15
|
+
### Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import {
|
|
19
|
+
SurveysSessionsApi,
|
|
20
|
+
Configuration
|
|
21
|
+
} from '@connectedxm/admin-sdk';
|
|
22
|
+
|
|
23
|
+
const configuration = new Configuration();
|
|
24
|
+
const apiInstance = new SurveysSessionsApi(configuration);
|
|
25
|
+
|
|
26
|
+
let surveyId: string; //The survey identifier (default to undefined)
|
|
27
|
+
let sessionId: string; //The session identifier (default to undefined)
|
|
28
|
+
|
|
29
|
+
const { status, data } = await apiInstance.addSurveySession(
|
|
30
|
+
surveyId,
|
|
31
|
+
sessionId
|
|
32
|
+
);
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Parameters
|
|
36
|
+
|
|
37
|
+
|Name | Type | Description | Notes|
|
|
38
|
+
|------------- | ------------- | ------------- | -------------|
|
|
39
|
+
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
|
|
40
|
+
| **sessionId** | [**string**] | The session identifier | defaults to undefined|
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
### Return type
|
|
44
|
+
|
|
45
|
+
**CreateSurvey200Response**
|
|
46
|
+
|
|
47
|
+
### Authorization
|
|
48
|
+
|
|
49
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
50
|
+
|
|
51
|
+
### HTTP request headers
|
|
52
|
+
|
|
53
|
+
- **Content-Type**: Not defined
|
|
54
|
+
- **Accept**: application/json
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
### HTTP response details
|
|
58
|
+
| Status code | Description | Response headers |
|
|
59
|
+
|-------------|-------------|------------------|
|
|
60
|
+
|**200** | Successful response | - |
|
|
61
|
+
|
|
62
|
+
[[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)
|
|
63
|
+
|
|
64
|
+
# **removeSurveySession**
|
|
65
|
+
> CreateSurvey200Response removeSurveySession()
|
|
66
|
+
|
|
67
|
+
Remove Survey Session endpoint
|
|
68
|
+
|
|
69
|
+
### Example
|
|
70
|
+
|
|
71
|
+
```typescript
|
|
72
|
+
import {
|
|
73
|
+
SurveysSessionsApi,
|
|
74
|
+
Configuration
|
|
75
|
+
} from '@connectedxm/admin-sdk';
|
|
76
|
+
|
|
77
|
+
const configuration = new Configuration();
|
|
78
|
+
const apiInstance = new SurveysSessionsApi(configuration);
|
|
79
|
+
|
|
80
|
+
let surveyId: string; //The survey identifier (default to undefined)
|
|
81
|
+
let sessionId: string; //The session identifier (default to undefined)
|
|
82
|
+
|
|
83
|
+
const { status, data } = await apiInstance.removeSurveySession(
|
|
84
|
+
surveyId,
|
|
85
|
+
sessionId
|
|
86
|
+
);
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### Parameters
|
|
90
|
+
|
|
91
|
+
|Name | Type | Description | Notes|
|
|
92
|
+
|------------- | ------------- | ------------- | -------------|
|
|
93
|
+
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
|
|
94
|
+
| **sessionId** | [**string**] | The session identifier | defaults to undefined|
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
### Return type
|
|
98
|
+
|
|
99
|
+
**CreateSurvey200Response**
|
|
100
|
+
|
|
101
|
+
### Authorization
|
|
102
|
+
|
|
103
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
104
|
+
|
|
105
|
+
### HTTP request headers
|
|
106
|
+
|
|
107
|
+
- **Content-Type**: Not defined
|
|
108
|
+
- **Accept**: application/json
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
### HTTP response details
|
|
112
|
+
| Status code | Description | Response headers |
|
|
113
|
+
|-------------|-------------|------------------|
|
|
114
|
+
|**200** | Successful response | - |
|
|
115
|
+
|
|
116
|
+
[[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)
|
|
117
|
+
|