@connectedxm/admin-sdk 6.8.6 → 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 +46 -8
- package/AdminApi.ts +24 -1
- package/README.md +79 -12
- package/api.ts +5210 -700
- package/dist/AdminApi.d.ts +10 -1
- package/dist/AdminApi.js +9 -1
- package/dist/api.d.ts +2895 -456
- package/dist/api.js +4276 -1073
- package/dist/esm/AdminApi.d.ts +10 -1
- package/dist/esm/AdminApi.js +10 -2
- package/dist/esm/api.d.ts +2895 -456
- package/dist/esm/api.js +4225 -1051
- 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/AccountCreateInputs.md +2 -0
- package/docs/AccountUpdateInputs.md +2 -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 +6 -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 +34 -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 +6 -0
- package/docs/EventBlockCreateInputs.md +6 -0
- package/docs/EventBlockUpdateInputs.md +6 -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 +14 -0
- package/docs/SeriesApi.md +64 -0
- package/docs/SeriesCreateInputs.md +16 -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 +40 -0
- package/docs/SeriesRegistrationCreateInputs.md +20 -0
- package/docs/SeriesRegistrationQuestionResponse.md +34 -0
- package/docs/SeriesRegistrationResponsesUpdateInputs.md +20 -0
- package/docs/SeriesRegistrationResponsesUpdateInputsResponsesInner.md +22 -0
- package/docs/SeriesRegistrationUpdateInputs.md +20 -0
- package/docs/SeriesRegistrationsApi.md +547 -0
- package/docs/SeriesTranslation.md +38 -0
- package/docs/SeriesTranslationUpdateInputs.md +28 -0
- package/docs/SeriesUpdateInputs.md +16 -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,191 @@
|
|
|
1
|
+
# EventsPassesAttributesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://admin-api.connected.dev*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**getEventPassAttributes**](#geteventpassattributes) | **GET** /events/{eventId}/passes/{passId}/attributes | Get Event Pass Attributes|
|
|
8
|
+
|[**removeEventPassAttribute**](#removeeventpassattribute) | **DELETE** /events/{eventId}/passes/{passId}/attributes/{attributeId} | Remove Event Pass Attribute|
|
|
9
|
+
|[**updateEventPassAttributes**](#updateeventpassattributes) | **PUT** /events/{eventId}/passes/{passId}/attributes | Update Event Pass Attributes|
|
|
10
|
+
|
|
11
|
+
# **getEventPassAttributes**
|
|
12
|
+
> GetAccountInvitations200Response getEventPassAttributes()
|
|
13
|
+
|
|
14
|
+
Get Event Pass Attributes endpoint
|
|
15
|
+
|
|
16
|
+
### Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import {
|
|
20
|
+
EventsPassesAttributesApi,
|
|
21
|
+
Configuration
|
|
22
|
+
} from '@connectedxm/admin-sdk';
|
|
23
|
+
|
|
24
|
+
const configuration = new Configuration();
|
|
25
|
+
const apiInstance = new EventsPassesAttributesApi(configuration);
|
|
26
|
+
|
|
27
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
28
|
+
let passId: string; //The pass identifier (default to undefined)
|
|
29
|
+
let page: number; //Page number (optional) (default to 1)
|
|
30
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
31
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
32
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
33
|
+
|
|
34
|
+
const { status, data } = await apiInstance.getEventPassAttributes(
|
|
35
|
+
eventId,
|
|
36
|
+
passId,
|
|
37
|
+
page,
|
|
38
|
+
pageSize,
|
|
39
|
+
orderBy,
|
|
40
|
+
search
|
|
41
|
+
);
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### Parameters
|
|
45
|
+
|
|
46
|
+
|Name | Type | Description | Notes|
|
|
47
|
+
|------------- | ------------- | ------------- | -------------|
|
|
48
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
49
|
+
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
50
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
51
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
52
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
53
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
### Return type
|
|
57
|
+
|
|
58
|
+
**GetAccountInvitations200Response**
|
|
59
|
+
|
|
60
|
+
### Authorization
|
|
61
|
+
|
|
62
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
63
|
+
|
|
64
|
+
### HTTP request headers
|
|
65
|
+
|
|
66
|
+
- **Content-Type**: Not defined
|
|
67
|
+
- **Accept**: application/json
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
### HTTP response details
|
|
71
|
+
| Status code | Description | Response headers |
|
|
72
|
+
|-------------|-------------|------------------|
|
|
73
|
+
|**200** | Successful response | - |
|
|
74
|
+
|
|
75
|
+
[[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)
|
|
76
|
+
|
|
77
|
+
# **removeEventPassAttribute**
|
|
78
|
+
> CreateAccountAddress200Response removeEventPassAttribute()
|
|
79
|
+
|
|
80
|
+
Remove Event Pass Attribute endpoint
|
|
81
|
+
|
|
82
|
+
### Example
|
|
83
|
+
|
|
84
|
+
```typescript
|
|
85
|
+
import {
|
|
86
|
+
EventsPassesAttributesApi,
|
|
87
|
+
Configuration
|
|
88
|
+
} from '@connectedxm/admin-sdk';
|
|
89
|
+
|
|
90
|
+
const configuration = new Configuration();
|
|
91
|
+
const apiInstance = new EventsPassesAttributesApi(configuration);
|
|
92
|
+
|
|
93
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
94
|
+
let passId: string; //The pass identifier (default to undefined)
|
|
95
|
+
let attributeId: string; //The attribute identifier (default to undefined)
|
|
96
|
+
|
|
97
|
+
const { status, data } = await apiInstance.removeEventPassAttribute(
|
|
98
|
+
eventId,
|
|
99
|
+
passId,
|
|
100
|
+
attributeId
|
|
101
|
+
);
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### Parameters
|
|
105
|
+
|
|
106
|
+
|Name | Type | Description | Notes|
|
|
107
|
+
|------------- | ------------- | ------------- | -------------|
|
|
108
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
109
|
+
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
110
|
+
| **attributeId** | [**string**] | The attribute identifier | defaults to undefined|
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
### Return type
|
|
114
|
+
|
|
115
|
+
**CreateAccountAddress200Response**
|
|
116
|
+
|
|
117
|
+
### Authorization
|
|
118
|
+
|
|
119
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
120
|
+
|
|
121
|
+
### HTTP request headers
|
|
122
|
+
|
|
123
|
+
- **Content-Type**: Not defined
|
|
124
|
+
- **Accept**: application/json
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
### HTTP response details
|
|
128
|
+
| Status code | Description | Response headers |
|
|
129
|
+
|-------------|-------------|------------------|
|
|
130
|
+
|**200** | Successful response | - |
|
|
131
|
+
|
|
132
|
+
[[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)
|
|
133
|
+
|
|
134
|
+
# **updateEventPassAttributes**
|
|
135
|
+
> CreateAccountAddress200Response updateEventPassAttributes(passAttributesUpdateInputs)
|
|
136
|
+
|
|
137
|
+
Update Event Pass Attributes endpoint
|
|
138
|
+
|
|
139
|
+
### Example
|
|
140
|
+
|
|
141
|
+
```typescript
|
|
142
|
+
import {
|
|
143
|
+
EventsPassesAttributesApi,
|
|
144
|
+
Configuration,
|
|
145
|
+
PassAttributesUpdateInputs
|
|
146
|
+
} from '@connectedxm/admin-sdk';
|
|
147
|
+
|
|
148
|
+
const configuration = new Configuration();
|
|
149
|
+
const apiInstance = new EventsPassesAttributesApi(configuration);
|
|
150
|
+
|
|
151
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
152
|
+
let passId: string; //The pass identifier (default to undefined)
|
|
153
|
+
let passAttributesUpdateInputs: PassAttributesUpdateInputs; //
|
|
154
|
+
|
|
155
|
+
const { status, data } = await apiInstance.updateEventPassAttributes(
|
|
156
|
+
eventId,
|
|
157
|
+
passId,
|
|
158
|
+
passAttributesUpdateInputs
|
|
159
|
+
);
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
### Parameters
|
|
163
|
+
|
|
164
|
+
|Name | Type | Description | Notes|
|
|
165
|
+
|------------- | ------------- | ------------- | -------------|
|
|
166
|
+
| **passAttributesUpdateInputs** | **PassAttributesUpdateInputs**| | |
|
|
167
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
168
|
+
| **passId** | [**string**] | The pass identifier | defaults to undefined|
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
### Return type
|
|
172
|
+
|
|
173
|
+
**CreateAccountAddress200Response**
|
|
174
|
+
|
|
175
|
+
### Authorization
|
|
176
|
+
|
|
177
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
178
|
+
|
|
179
|
+
### HTTP request headers
|
|
180
|
+
|
|
181
|
+
- **Content-Type**: application/json
|
|
182
|
+
- **Accept**: application/json
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
### HTTP response details
|
|
186
|
+
| Status code | Description | Response headers |
|
|
187
|
+
|-------------|-------------|------------------|
|
|
188
|
+
|**200** | Successful response | - |
|
|
189
|
+
|
|
190
|
+
[[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)
|
|
191
|
+
|
|
@@ -9,7 +9,9 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
9
9
|
|[**addEventSessionPassType**](#addeventsessionpasstype) | **POST** /events/{eventId}/sessions/{sessionId}/passTypes/{passTypeId} | Add Event Session Pass Type|
|
|
10
10
|
|[**addEventSessionSpeaker**](#addeventsessionspeaker) | **POST** /events/{eventId}/sessions/{sessionId}/speakers/{speakerId} | Add Event Session Speaker|
|
|
11
11
|
|[**addEventSessionSponsor**](#addeventsessionsponsor) | **POST** /events/{eventId}/sessions/{sessionId}/sponsors/{sponsorId} | Add Event Session Sponsor|
|
|
12
|
+
|[**addEventSessionTier**](#addeventsessiontier) | **POST** /events/{eventId}/sessions/{sessionId}/tiers/{tierId} | Add Event Session Tier|
|
|
12
13
|
|[**addEventSessionTrack**](#addeventsessiontrack) | **POST** /events/{eventId}/sessions/{sessionId}/tracks/{trackId} | Add Event Session Track|
|
|
14
|
+
|[**cloneEventSession**](#cloneeventsession) | **POST** /events/{eventId}/sessions/{sessionId}/clone | Clone Event Session|
|
|
13
15
|
|[**createEventSession**](#createeventsession) | **POST** /events/{eventId}/sessions | Create Event Session|
|
|
14
16
|
|[**deleteEventSession**](#deleteeventsession) | **DELETE** /events/{eventId}/sessions/{sessionId} | Delete Event Session|
|
|
15
17
|
|[**getEventSession**](#geteventsession) | **GET** /events/{eventId}/sessions/{sessionId} | Get Event Session|
|
|
@@ -20,6 +22,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
20
22
|
|[**getEventSessionPayments**](#geteventsessionpayments) | **GET** /events/{eventId}/sessions/{sessionId}/payments | Get Event Session Payments|
|
|
21
23
|
|[**getEventSessionSpeakers**](#geteventsessionspeakers) | **GET** /events/{eventId}/sessions/{sessionId}/speakers | Get Event Session Speakers|
|
|
22
24
|
|[**getEventSessionSponsors**](#geteventsessionsponsors) | **GET** /events/{eventId}/sessions/{sessionId}/sponsors | Get Event Session Sponsors|
|
|
25
|
+
|[**getEventSessionTiers**](#geteventsessiontiers) | **GET** /events/{eventId}/sessions/{sessionId}/tiers | Get Event Session Tiers|
|
|
23
26
|
|[**getEventSessionTracks**](#geteventsessiontracks) | **GET** /events/{eventId}/sessions/{sessionId}/tracks | Get Event Session Tracks|
|
|
24
27
|
|[**getEventSessions**](#geteventsessions) | **GET** /events/{eventId}/sessions | Get Event Sessions|
|
|
25
28
|
|[**removeEventSessionAccount**](#removeeventsessionaccount) | **DELETE** /events/{eventId}/sessions/{sessionId}/accounts/{accountId} | Remove Event Session Account|
|
|
@@ -27,6 +30,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
27
30
|
|[**removeEventSessionPassType**](#removeeventsessionpasstype) | **DELETE** /events/{eventId}/sessions/{sessionId}/passTypes/{passTypeId} | Remove Event Session Pass Type|
|
|
28
31
|
|[**removeEventSessionSpeaker**](#removeeventsessionspeaker) | **DELETE** /events/{eventId}/sessions/{sessionId}/speakers/{speakerId} | Remove Event Session Speaker|
|
|
29
32
|
|[**removeEventSessionSponsor**](#removeeventsessionsponsor) | **DELETE** /events/{eventId}/sessions/{sessionId}/sponsors/{sponsorId} | Remove Event Session Sponsor|
|
|
33
|
+
|[**removeEventSessionTier**](#removeeventsessiontier) | **DELETE** /events/{eventId}/sessions/{sessionId}/tiers/{tierId} | Remove Event Session Tier|
|
|
30
34
|
|[**removeEventSessionTrack**](#removeeventsessiontrack) | **DELETE** /events/{eventId}/sessions/{sessionId}/tracks/{trackId} | Remove Event Session Track|
|
|
31
35
|
|[**updateEventSession**](#updateeventsession) | **PUT** /events/{eventId}/sessions/{sessionId} | Update Event Session|
|
|
32
36
|
|
|
@@ -308,6 +312,63 @@ const { status, data } = await apiInstance.addEventSessionSponsor(
|
|
|
308
312
|
- **Accept**: application/json
|
|
309
313
|
|
|
310
314
|
|
|
315
|
+
### HTTP response details
|
|
316
|
+
| Status code | Description | Response headers |
|
|
317
|
+
|-------------|-------------|------------------|
|
|
318
|
+
|**200** | Successful response | - |
|
|
319
|
+
|
|
320
|
+
[[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)
|
|
321
|
+
|
|
322
|
+
# **addEventSessionTier**
|
|
323
|
+
> CreateEventSession200Response addEventSessionTier()
|
|
324
|
+
|
|
325
|
+
Add Event Session Tier endpoint
|
|
326
|
+
|
|
327
|
+
### Example
|
|
328
|
+
|
|
329
|
+
```typescript
|
|
330
|
+
import {
|
|
331
|
+
EventsSessionsApi,
|
|
332
|
+
Configuration
|
|
333
|
+
} from '@connectedxm/admin-sdk';
|
|
334
|
+
|
|
335
|
+
const configuration = new Configuration();
|
|
336
|
+
const apiInstance = new EventsSessionsApi(configuration);
|
|
337
|
+
|
|
338
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
339
|
+
let sessionId: string; //The session identifier (default to undefined)
|
|
340
|
+
let tierId: string; //The tier identifier (default to undefined)
|
|
341
|
+
|
|
342
|
+
const { status, data } = await apiInstance.addEventSessionTier(
|
|
343
|
+
eventId,
|
|
344
|
+
sessionId,
|
|
345
|
+
tierId
|
|
346
|
+
);
|
|
347
|
+
```
|
|
348
|
+
|
|
349
|
+
### Parameters
|
|
350
|
+
|
|
351
|
+
|Name | Type | Description | Notes|
|
|
352
|
+
|------------- | ------------- | ------------- | -------------|
|
|
353
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
354
|
+
| **sessionId** | [**string**] | The session identifier | defaults to undefined|
|
|
355
|
+
| **tierId** | [**string**] | The tier identifier | defaults to undefined|
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
### Return type
|
|
359
|
+
|
|
360
|
+
**CreateEventSession200Response**
|
|
361
|
+
|
|
362
|
+
### Authorization
|
|
363
|
+
|
|
364
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
365
|
+
|
|
366
|
+
### HTTP request headers
|
|
367
|
+
|
|
368
|
+
- **Content-Type**: Not defined
|
|
369
|
+
- **Accept**: application/json
|
|
370
|
+
|
|
371
|
+
|
|
311
372
|
### HTTP response details
|
|
312
373
|
| Status code | Description | Response headers |
|
|
313
374
|
|-------------|-------------|------------------|
|
|
@@ -365,6 +426,64 @@ const { status, data } = await apiInstance.addEventSessionTrack(
|
|
|
365
426
|
- **Accept**: application/json
|
|
366
427
|
|
|
367
428
|
|
|
429
|
+
### HTTP response details
|
|
430
|
+
| Status code | Description | Response headers |
|
|
431
|
+
|-------------|-------------|------------------|
|
|
432
|
+
|**200** | Successful response | - |
|
|
433
|
+
|
|
434
|
+
[[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)
|
|
435
|
+
|
|
436
|
+
# **cloneEventSession**
|
|
437
|
+
> CreateAccountAddress200Response cloneEventSession(eventSessionCloneOptions)
|
|
438
|
+
|
|
439
|
+
Clone Event Session endpoint
|
|
440
|
+
|
|
441
|
+
### Example
|
|
442
|
+
|
|
443
|
+
```typescript
|
|
444
|
+
import {
|
|
445
|
+
EventsSessionsApi,
|
|
446
|
+
Configuration,
|
|
447
|
+
EventSessionCloneOptions
|
|
448
|
+
} from '@connectedxm/admin-sdk';
|
|
449
|
+
|
|
450
|
+
const configuration = new Configuration();
|
|
451
|
+
const apiInstance = new EventsSessionsApi(configuration);
|
|
452
|
+
|
|
453
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
454
|
+
let sessionId: string; //The session identifier (default to undefined)
|
|
455
|
+
let eventSessionCloneOptions: EventSessionCloneOptions; //
|
|
456
|
+
|
|
457
|
+
const { status, data } = await apiInstance.cloneEventSession(
|
|
458
|
+
eventId,
|
|
459
|
+
sessionId,
|
|
460
|
+
eventSessionCloneOptions
|
|
461
|
+
);
|
|
462
|
+
```
|
|
463
|
+
|
|
464
|
+
### Parameters
|
|
465
|
+
|
|
466
|
+
|Name | Type | Description | Notes|
|
|
467
|
+
|------------- | ------------- | ------------- | -------------|
|
|
468
|
+
| **eventSessionCloneOptions** | **EventSessionCloneOptions**| | |
|
|
469
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
470
|
+
| **sessionId** | [**string**] | The session identifier | defaults to undefined|
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
### Return type
|
|
474
|
+
|
|
475
|
+
**CreateAccountAddress200Response**
|
|
476
|
+
|
|
477
|
+
### Authorization
|
|
478
|
+
|
|
479
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
480
|
+
|
|
481
|
+
### HTTP request headers
|
|
482
|
+
|
|
483
|
+
- **Content-Type**: application/json
|
|
484
|
+
- **Accept**: application/json
|
|
485
|
+
|
|
486
|
+
|
|
368
487
|
### HTTP response details
|
|
369
488
|
| Status code | Description | Response headers |
|
|
370
489
|
|-------------|-------------|------------------|
|
|
@@ -993,6 +1112,72 @@ const { status, data } = await apiInstance.getEventSessionSponsors(
|
|
|
993
1112
|
- **Accept**: application/json
|
|
994
1113
|
|
|
995
1114
|
|
|
1115
|
+
### HTTP response details
|
|
1116
|
+
| Status code | Description | Response headers |
|
|
1117
|
+
|-------------|-------------|------------------|
|
|
1118
|
+
|**200** | Successful response | - |
|
|
1119
|
+
|
|
1120
|
+
[[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)
|
|
1121
|
+
|
|
1122
|
+
# **getEventSessionTiers**
|
|
1123
|
+
> GetAccountTiers200Response getEventSessionTiers()
|
|
1124
|
+
|
|
1125
|
+
Get Event Session Tiers endpoint
|
|
1126
|
+
|
|
1127
|
+
### Example
|
|
1128
|
+
|
|
1129
|
+
```typescript
|
|
1130
|
+
import {
|
|
1131
|
+
EventsSessionsApi,
|
|
1132
|
+
Configuration
|
|
1133
|
+
} from '@connectedxm/admin-sdk';
|
|
1134
|
+
|
|
1135
|
+
const configuration = new Configuration();
|
|
1136
|
+
const apiInstance = new EventsSessionsApi(configuration);
|
|
1137
|
+
|
|
1138
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
1139
|
+
let sessionId: string; //The session identifier (default to undefined)
|
|
1140
|
+
let page: number; //Page number (optional) (default to 1)
|
|
1141
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
1142
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
1143
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
1144
|
+
|
|
1145
|
+
const { status, data } = await apiInstance.getEventSessionTiers(
|
|
1146
|
+
eventId,
|
|
1147
|
+
sessionId,
|
|
1148
|
+
page,
|
|
1149
|
+
pageSize,
|
|
1150
|
+
orderBy,
|
|
1151
|
+
search
|
|
1152
|
+
);
|
|
1153
|
+
```
|
|
1154
|
+
|
|
1155
|
+
### Parameters
|
|
1156
|
+
|
|
1157
|
+
|Name | Type | Description | Notes|
|
|
1158
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1159
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
1160
|
+
| **sessionId** | [**string**] | The session identifier | defaults to undefined|
|
|
1161
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
1162
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
1163
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
1164
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
1165
|
+
|
|
1166
|
+
|
|
1167
|
+
### Return type
|
|
1168
|
+
|
|
1169
|
+
**GetAccountTiers200Response**
|
|
1170
|
+
|
|
1171
|
+
### Authorization
|
|
1172
|
+
|
|
1173
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1174
|
+
|
|
1175
|
+
### HTTP request headers
|
|
1176
|
+
|
|
1177
|
+
- **Content-Type**: Not defined
|
|
1178
|
+
- **Accept**: application/json
|
|
1179
|
+
|
|
1180
|
+
|
|
996
1181
|
### HTTP response details
|
|
997
1182
|
| Status code | Description | Response headers |
|
|
998
1183
|
|-------------|-------------|------------------|
|
|
@@ -1393,6 +1578,63 @@ const { status, data } = await apiInstance.removeEventSessionSponsor(
|
|
|
1393
1578
|
| **sponsorId** | [**string**] | The sponsor identifier | defaults to undefined|
|
|
1394
1579
|
|
|
1395
1580
|
|
|
1581
|
+
### Return type
|
|
1582
|
+
|
|
1583
|
+
**CreateAccountAddress200Response**
|
|
1584
|
+
|
|
1585
|
+
### Authorization
|
|
1586
|
+
|
|
1587
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
1588
|
+
|
|
1589
|
+
### HTTP request headers
|
|
1590
|
+
|
|
1591
|
+
- **Content-Type**: Not defined
|
|
1592
|
+
- **Accept**: application/json
|
|
1593
|
+
|
|
1594
|
+
|
|
1595
|
+
### HTTP response details
|
|
1596
|
+
| Status code | Description | Response headers |
|
|
1597
|
+
|-------------|-------------|------------------|
|
|
1598
|
+
|**200** | Successful response | - |
|
|
1599
|
+
|
|
1600
|
+
[[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)
|
|
1601
|
+
|
|
1602
|
+
# **removeEventSessionTier**
|
|
1603
|
+
> CreateAccountAddress200Response removeEventSessionTier()
|
|
1604
|
+
|
|
1605
|
+
Remove Event Session Tier endpoint
|
|
1606
|
+
|
|
1607
|
+
### Example
|
|
1608
|
+
|
|
1609
|
+
```typescript
|
|
1610
|
+
import {
|
|
1611
|
+
EventsSessionsApi,
|
|
1612
|
+
Configuration
|
|
1613
|
+
} from '@connectedxm/admin-sdk';
|
|
1614
|
+
|
|
1615
|
+
const configuration = new Configuration();
|
|
1616
|
+
const apiInstance = new EventsSessionsApi(configuration);
|
|
1617
|
+
|
|
1618
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
1619
|
+
let sessionId: string; //The session identifier (default to undefined)
|
|
1620
|
+
let tierId: string; //The tier identifier (default to undefined)
|
|
1621
|
+
|
|
1622
|
+
const { status, data } = await apiInstance.removeEventSessionTier(
|
|
1623
|
+
eventId,
|
|
1624
|
+
sessionId,
|
|
1625
|
+
tierId
|
|
1626
|
+
);
|
|
1627
|
+
```
|
|
1628
|
+
|
|
1629
|
+
### Parameters
|
|
1630
|
+
|
|
1631
|
+
|Name | Type | Description | Notes|
|
|
1632
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1633
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
1634
|
+
| **sessionId** | [**string**] | The session identifier | defaults to undefined|
|
|
1635
|
+
| **tierId** | [**string**] | The tier identifier | defaults to undefined|
|
|
1636
|
+
|
|
1637
|
+
|
|
1396
1638
|
### Return type
|
|
1397
1639
|
|
|
1398
1640
|
**CreateAccountAddress200Response**
|
|
@@ -1,10 +1,12 @@
|
|
|
1
|
-
#
|
|
1
|
+
# OnSiteScanType
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Enum
|
|
5
5
|
|
|
6
|
-
* `
|
|
6
|
+
* `Both` (value: `'both'`)
|
|
7
7
|
|
|
8
|
-
* `
|
|
8
|
+
* `Qr` (value: `'qr'`)
|
|
9
|
+
|
|
10
|
+
* `Code128` (value: `'code128'`)
|
|
9
11
|
|
|
10
12
|
[[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,30 @@
|
|
|
1
|
+
# PassAttribute
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**attributeId** | **string** | | [default to undefined]
|
|
10
|
+
**attribute** | [**BaseEventAttribute**](BaseEventAttribute.md) | | [default to undefined]
|
|
11
|
+
**value** | **string** | | [default to undefined]
|
|
12
|
+
**createdAt** | **string** | | [default to undefined]
|
|
13
|
+
**updatedAt** | **string** | | [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { PassAttribute } from '@connectedxm/admin-sdk';
|
|
19
|
+
|
|
20
|
+
const instance: PassAttribute = {
|
|
21
|
+
id,
|
|
22
|
+
attributeId,
|
|
23
|
+
attribute,
|
|
24
|
+
value,
|
|
25
|
+
createdAt,
|
|
26
|
+
updatedAt,
|
|
27
|
+
};
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
[[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
|
+
# PassAttributesUpdateInputs
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**values** | [**Array<PassAttributesUpdateInputsValuesInner>**](PassAttributesUpdateInputsValuesInner.md) | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { PassAttributesUpdateInputs } from '@connectedxm/admin-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: PassAttributesUpdateInputs = {
|
|
16
|
+
values,
|
|
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
|
+
# PassAttributesUpdateInputsValuesInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**attributeId** | **string** | | [default to undefined]
|
|
9
|
+
**value** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { PassAttributesUpdateInputsValuesInner } from '@connectedxm/admin-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: PassAttributesUpdateInputsValuesInner = {
|
|
17
|
+
attributeId,
|
|
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)
|
|
@@ -31,6 +31,8 @@ Name | Type | Description | Notes
|
|
|
31
31
|
**taxCode** | **string** | | [optional] [default to undefined]
|
|
32
32
|
**taxIncluded** | **boolean** | | [optional] [default to undefined]
|
|
33
33
|
**taxLocation** | [**TaxLocationType**](TaxLocationType.md) | | [optional] [default to undefined]
|
|
34
|
+
**printable** | **boolean** | | [optional] [default to undefined]
|
|
35
|
+
**badgeColor** | **string** | | [optional] [default to undefined]
|
|
34
36
|
|
|
35
37
|
## Example
|
|
36
38
|
|
|
@@ -64,6 +66,8 @@ const instance: PassTypeCreateInputs = {
|
|
|
64
66
|
taxCode,
|
|
65
67
|
taxIncluded,
|
|
66
68
|
taxLocation,
|
|
69
|
+
printable,
|
|
70
|
+
badgeColor,
|
|
67
71
|
};
|
|
68
72
|
```
|
|
69
73
|
|
|
@@ -33,6 +33,8 @@ Name | Type | Description | Notes
|
|
|
33
33
|
**taxCode** | **string** | | [optional] [default to undefined]
|
|
34
34
|
**taxIncluded** | **boolean** | | [optional] [default to undefined]
|
|
35
35
|
**taxLocation** | [**TaxLocationType**](TaxLocationType.md) | | [optional] [default to undefined]
|
|
36
|
+
**printable** | **boolean** | | [optional] [default to undefined]
|
|
37
|
+
**badgeColor** | **string** | | [optional] [default to undefined]
|
|
36
38
|
|
|
37
39
|
## Example
|
|
38
40
|
|
|
@@ -68,6 +70,8 @@ const instance: PassTypeUpdateInputs = {
|
|
|
68
70
|
taxCode,
|
|
69
71
|
taxIncluded,
|
|
70
72
|
taxLocation,
|
|
73
|
+
printable,
|
|
74
|
+
badgeColor,
|
|
71
75
|
};
|
|
72
76
|
```
|
|
73
77
|
|
package/docs/Payment.md
CHANGED
|
@@ -31,6 +31,7 @@ Name | Type | Description | Notes
|
|
|
31
31
|
**membershipId** | **string** | | [default to undefined]
|
|
32
32
|
**couponId** | **string** | | [default to undefined]
|
|
33
33
|
**invoiceId** | **string** | | [default to undefined]
|
|
34
|
+
**seriesId** | **string** | | [default to undefined]
|
|
34
35
|
**lineItems** | **Array<object>** | | [default to undefined]
|
|
35
36
|
**createdAt** | **string** | | [default to undefined]
|
|
36
37
|
**locationAddress1** | **string** | | [default to undefined]
|
|
@@ -57,6 +58,7 @@ Name | Type | Description | Notes
|
|
|
57
58
|
**space** | [**BaseBookingSpace**](BaseBookingSpace.md) | | [default to undefined]
|
|
58
59
|
**coupon** | [**BaseCoupon**](BaseCoupon.md) | | [default to undefined]
|
|
59
60
|
**invoice** | [**BaseInvoice**](BaseInvoice.md) | | [default to undefined]
|
|
61
|
+
**series** | [**BaseSeries**](BaseSeries.md) | | [default to undefined]
|
|
60
62
|
**metadata** | **object** | | [optional] [default to undefined]
|
|
61
63
|
|
|
62
64
|
## Example
|
|
@@ -91,6 +93,7 @@ const instance: Payment = {
|
|
|
91
93
|
membershipId,
|
|
92
94
|
couponId,
|
|
93
95
|
invoiceId,
|
|
96
|
+
seriesId,
|
|
94
97
|
lineItems,
|
|
95
98
|
createdAt,
|
|
96
99
|
locationAddress1,
|
|
@@ -117,6 +120,7 @@ const instance: Payment = {
|
|
|
117
120
|
space,
|
|
118
121
|
coupon,
|
|
119
122
|
invoice,
|
|
123
|
+
series,
|
|
120
124
|
metadata,
|
|
121
125
|
};
|
|
122
126
|
```
|
package/docs/PaymentLineItem.md
CHANGED
|
@@ -34,6 +34,7 @@ Name | Type | Description | Notes
|
|
|
34
34
|
**access** | [**BaseEventSessionAccess**](BaseEventSessionAccess.md) | | [default to undefined]
|
|
35
35
|
**booking** | [**BaseBooking**](BaseBooking.md) | | [default to undefined]
|
|
36
36
|
**coupon** | [**BaseCoupon**](BaseCoupon.md) | | [default to undefined]
|
|
37
|
+
**seriesRegistration** | [**BaseSeriesRegistration**](BaseSeriesRegistration.md) | | [default to undefined]
|
|
37
38
|
**payment** | [**BasePayment**](BasePayment.md) | | [default to undefined]
|
|
38
39
|
|
|
39
40
|
## Example
|
|
@@ -71,6 +72,7 @@ const instance: PaymentLineItem = {
|
|
|
71
72
|
access,
|
|
72
73
|
booking,
|
|
73
74
|
coupon,
|
|
75
|
+
seriesRegistration,
|
|
74
76
|
payment,
|
|
75
77
|
};
|
|
76
78
|
```
|
|
@@ -21,6 +21,8 @@
|
|
|
21
21
|
|
|
22
22
|
* `Coupon` (value: `'coupon'`)
|
|
23
23
|
|
|
24
|
+
* `Series` (value: `'series'`)
|
|
25
|
+
|
|
24
26
|
* `Refund` (value: `'refund'`)
|
|
25
27
|
|
|
26
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)
|