@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,123 @@
|
|
|
1
|
+
# EventsActivationsSessionsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://admin-api.connected.dev*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**addEventActivationSession**](#addeventactivationsession) | **POST** /events/{eventId}/activations/{activationId}/sessions/{sessionId} | Add Event Activation Session|
|
|
8
|
+
|[**removeEventActivationSession**](#removeeventactivationsession) | **DELETE** /events/{eventId}/activations/{activationId}/sessions/{sessionId} | Remove Event Activation Session|
|
|
9
|
+
|
|
10
|
+
# **addEventActivationSession**
|
|
11
|
+
> CreateAccountAddress200Response addEventActivationSession()
|
|
12
|
+
|
|
13
|
+
Add Event Activation Session endpoint
|
|
14
|
+
|
|
15
|
+
### Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import {
|
|
19
|
+
EventsActivationsSessionsApi,
|
|
20
|
+
Configuration
|
|
21
|
+
} from '@connectedxm/admin-sdk';
|
|
22
|
+
|
|
23
|
+
const configuration = new Configuration();
|
|
24
|
+
const apiInstance = new EventsActivationsSessionsApi(configuration);
|
|
25
|
+
|
|
26
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
27
|
+
let activationId: string; //The activation identifier (default to undefined)
|
|
28
|
+
let sessionId: string; //The session identifier (default to undefined)
|
|
29
|
+
|
|
30
|
+
const { status, data } = await apiInstance.addEventActivationSession(
|
|
31
|
+
eventId,
|
|
32
|
+
activationId,
|
|
33
|
+
sessionId
|
|
34
|
+
);
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Parameters
|
|
38
|
+
|
|
39
|
+
|Name | Type | Description | Notes|
|
|
40
|
+
|------------- | ------------- | ------------- | -------------|
|
|
41
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
42
|
+
| **activationId** | [**string**] | The activation identifier | defaults to undefined|
|
|
43
|
+
| **sessionId** | [**string**] | The session identifier | defaults to undefined|
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
### Return type
|
|
47
|
+
|
|
48
|
+
**CreateAccountAddress200Response**
|
|
49
|
+
|
|
50
|
+
### Authorization
|
|
51
|
+
|
|
52
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
53
|
+
|
|
54
|
+
### HTTP request headers
|
|
55
|
+
|
|
56
|
+
- **Content-Type**: Not defined
|
|
57
|
+
- **Accept**: application/json
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
### HTTP response details
|
|
61
|
+
| Status code | Description | Response headers |
|
|
62
|
+
|-------------|-------------|------------------|
|
|
63
|
+
|**200** | Successful response | - |
|
|
64
|
+
|
|
65
|
+
[[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)
|
|
66
|
+
|
|
67
|
+
# **removeEventActivationSession**
|
|
68
|
+
> CreateAccountAddress200Response removeEventActivationSession()
|
|
69
|
+
|
|
70
|
+
Remove Event Activation Session endpoint
|
|
71
|
+
|
|
72
|
+
### Example
|
|
73
|
+
|
|
74
|
+
```typescript
|
|
75
|
+
import {
|
|
76
|
+
EventsActivationsSessionsApi,
|
|
77
|
+
Configuration
|
|
78
|
+
} from '@connectedxm/admin-sdk';
|
|
79
|
+
|
|
80
|
+
const configuration = new Configuration();
|
|
81
|
+
const apiInstance = new EventsActivationsSessionsApi(configuration);
|
|
82
|
+
|
|
83
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
84
|
+
let activationId: string; //The activation identifier (default to undefined)
|
|
85
|
+
let sessionId: string; //The session identifier (default to undefined)
|
|
86
|
+
|
|
87
|
+
const { status, data } = await apiInstance.removeEventActivationSession(
|
|
88
|
+
eventId,
|
|
89
|
+
activationId,
|
|
90
|
+
sessionId
|
|
91
|
+
);
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### Parameters
|
|
95
|
+
|
|
96
|
+
|Name | Type | Description | Notes|
|
|
97
|
+
|------------- | ------------- | ------------- | -------------|
|
|
98
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
99
|
+
| **activationId** | [**string**] | The activation identifier | defaults to undefined|
|
|
100
|
+
| **sessionId** | [**string**] | The session identifier | defaults to undefined|
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
### Return type
|
|
104
|
+
|
|
105
|
+
**CreateAccountAddress200Response**
|
|
106
|
+
|
|
107
|
+
### Authorization
|
|
108
|
+
|
|
109
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
110
|
+
|
|
111
|
+
### HTTP request headers
|
|
112
|
+
|
|
113
|
+
- **Content-Type**: Not defined
|
|
114
|
+
- **Accept**: application/json
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
### HTTP response details
|
|
118
|
+
| Status code | Description | Response headers |
|
|
119
|
+
|-------------|-------------|------------------|
|
|
120
|
+
|**200** | Successful response | - |
|
|
121
|
+
|
|
122
|
+
[[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)
|
|
123
|
+
|
|
@@ -0,0 +1,296 @@
|
|
|
1
|
+
# EventsAttributesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://admin-api.connected.dev*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**createEventAttribute**](#createeventattribute) | **POST** /events/{eventId}/attributes | Create Event Attribute|
|
|
8
|
+
|[**deleteEventAttribute**](#deleteeventattribute) | **DELETE** /events/{eventId}/attributes/{attributeId} | Delete Event Attribute|
|
|
9
|
+
|[**getEventAttribute**](#geteventattribute) | **GET** /events/{eventId}/attributes/{attributeId} | Get Event Attribute|
|
|
10
|
+
|[**getEventAttributes**](#geteventattributes) | **GET** /events/{eventId}/attributes | Get Event Attributes|
|
|
11
|
+
|[**updateEventAttribute**](#updateeventattribute) | **PUT** /events/{eventId}/attributes/{attributeId} | Update Event Attribute|
|
|
12
|
+
|
|
13
|
+
# **createEventAttribute**
|
|
14
|
+
> CreateAccountAddress200Response createEventAttribute(eventAttributeCreateInputs)
|
|
15
|
+
|
|
16
|
+
Create Event Attribute endpoint
|
|
17
|
+
|
|
18
|
+
### Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import {
|
|
22
|
+
EventsAttributesApi,
|
|
23
|
+
Configuration,
|
|
24
|
+
EventAttributeCreateInputs
|
|
25
|
+
} from '@connectedxm/admin-sdk';
|
|
26
|
+
|
|
27
|
+
const configuration = new Configuration();
|
|
28
|
+
const apiInstance = new EventsAttributesApi(configuration);
|
|
29
|
+
|
|
30
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
31
|
+
let eventAttributeCreateInputs: EventAttributeCreateInputs; //
|
|
32
|
+
|
|
33
|
+
const { status, data } = await apiInstance.createEventAttribute(
|
|
34
|
+
eventId,
|
|
35
|
+
eventAttributeCreateInputs
|
|
36
|
+
);
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### Parameters
|
|
40
|
+
|
|
41
|
+
|Name | Type | Description | Notes|
|
|
42
|
+
|------------- | ------------- | ------------- | -------------|
|
|
43
|
+
| **eventAttributeCreateInputs** | **EventAttributeCreateInputs**| | |
|
|
44
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
### Return type
|
|
48
|
+
|
|
49
|
+
**CreateAccountAddress200Response**
|
|
50
|
+
|
|
51
|
+
### Authorization
|
|
52
|
+
|
|
53
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
54
|
+
|
|
55
|
+
### HTTP request headers
|
|
56
|
+
|
|
57
|
+
- **Content-Type**: application/json
|
|
58
|
+
- **Accept**: application/json
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
### HTTP response details
|
|
62
|
+
| Status code | Description | Response headers |
|
|
63
|
+
|-------------|-------------|------------------|
|
|
64
|
+
|**200** | Successful response | - |
|
|
65
|
+
|
|
66
|
+
[[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)
|
|
67
|
+
|
|
68
|
+
# **deleteEventAttribute**
|
|
69
|
+
> CreateAccountInvitations200Response deleteEventAttribute()
|
|
70
|
+
|
|
71
|
+
Delete Event Attribute endpoint
|
|
72
|
+
|
|
73
|
+
### Example
|
|
74
|
+
|
|
75
|
+
```typescript
|
|
76
|
+
import {
|
|
77
|
+
EventsAttributesApi,
|
|
78
|
+
Configuration
|
|
79
|
+
} from '@connectedxm/admin-sdk';
|
|
80
|
+
|
|
81
|
+
const configuration = new Configuration();
|
|
82
|
+
const apiInstance = new EventsAttributesApi(configuration);
|
|
83
|
+
|
|
84
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
85
|
+
let attributeId: string; //The attribute identifier (default to undefined)
|
|
86
|
+
|
|
87
|
+
const { status, data } = await apiInstance.deleteEventAttribute(
|
|
88
|
+
eventId,
|
|
89
|
+
attributeId
|
|
90
|
+
);
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### Parameters
|
|
94
|
+
|
|
95
|
+
|Name | Type | Description | Notes|
|
|
96
|
+
|------------- | ------------- | ------------- | -------------|
|
|
97
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
98
|
+
| **attributeId** | [**string**] | The attribute identifier | defaults to undefined|
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
### Return type
|
|
102
|
+
|
|
103
|
+
**CreateAccountInvitations200Response**
|
|
104
|
+
|
|
105
|
+
### Authorization
|
|
106
|
+
|
|
107
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
108
|
+
|
|
109
|
+
### HTTP request headers
|
|
110
|
+
|
|
111
|
+
- **Content-Type**: Not defined
|
|
112
|
+
- **Accept**: application/json
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
### HTTP response details
|
|
116
|
+
| Status code | Description | Response headers |
|
|
117
|
+
|-------------|-------------|------------------|
|
|
118
|
+
|**200** | Successful response | - |
|
|
119
|
+
|
|
120
|
+
[[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)
|
|
121
|
+
|
|
122
|
+
# **getEventAttribute**
|
|
123
|
+
> CreateAccountAddress200Response getEventAttribute()
|
|
124
|
+
|
|
125
|
+
Get Event Attribute endpoint
|
|
126
|
+
|
|
127
|
+
### Example
|
|
128
|
+
|
|
129
|
+
```typescript
|
|
130
|
+
import {
|
|
131
|
+
EventsAttributesApi,
|
|
132
|
+
Configuration
|
|
133
|
+
} from '@connectedxm/admin-sdk';
|
|
134
|
+
|
|
135
|
+
const configuration = new Configuration();
|
|
136
|
+
const apiInstance = new EventsAttributesApi(configuration);
|
|
137
|
+
|
|
138
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
139
|
+
let attributeId: string; //The attribute identifier (default to undefined)
|
|
140
|
+
|
|
141
|
+
const { status, data } = await apiInstance.getEventAttribute(
|
|
142
|
+
eventId,
|
|
143
|
+
attributeId
|
|
144
|
+
);
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
### Parameters
|
|
148
|
+
|
|
149
|
+
|Name | Type | Description | Notes|
|
|
150
|
+
|------------- | ------------- | ------------- | -------------|
|
|
151
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
152
|
+
| **attributeId** | [**string**] | The attribute identifier | defaults to undefined|
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
### Return type
|
|
156
|
+
|
|
157
|
+
**CreateAccountAddress200Response**
|
|
158
|
+
|
|
159
|
+
### Authorization
|
|
160
|
+
|
|
161
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
162
|
+
|
|
163
|
+
### HTTP request headers
|
|
164
|
+
|
|
165
|
+
- **Content-Type**: Not defined
|
|
166
|
+
- **Accept**: application/json
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
### HTTP response details
|
|
170
|
+
| Status code | Description | Response headers |
|
|
171
|
+
|-------------|-------------|------------------|
|
|
172
|
+
|**200** | Successful response | - |
|
|
173
|
+
|
|
174
|
+
[[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)
|
|
175
|
+
|
|
176
|
+
# **getEventAttributes**
|
|
177
|
+
> GetAccountInvitations200Response getEventAttributes()
|
|
178
|
+
|
|
179
|
+
Get Event Attributes endpoint
|
|
180
|
+
|
|
181
|
+
### Example
|
|
182
|
+
|
|
183
|
+
```typescript
|
|
184
|
+
import {
|
|
185
|
+
EventsAttributesApi,
|
|
186
|
+
Configuration
|
|
187
|
+
} from '@connectedxm/admin-sdk';
|
|
188
|
+
|
|
189
|
+
const configuration = new Configuration();
|
|
190
|
+
const apiInstance = new EventsAttributesApi(configuration);
|
|
191
|
+
|
|
192
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
193
|
+
let page: number; //Page number (optional) (default to 1)
|
|
194
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
195
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
196
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
197
|
+
|
|
198
|
+
const { status, data } = await apiInstance.getEventAttributes(
|
|
199
|
+
eventId,
|
|
200
|
+
page,
|
|
201
|
+
pageSize,
|
|
202
|
+
orderBy,
|
|
203
|
+
search
|
|
204
|
+
);
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
### Parameters
|
|
208
|
+
|
|
209
|
+
|Name | Type | Description | Notes|
|
|
210
|
+
|------------- | ------------- | ------------- | -------------|
|
|
211
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
212
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
213
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
214
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
215
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
### Return type
|
|
219
|
+
|
|
220
|
+
**GetAccountInvitations200Response**
|
|
221
|
+
|
|
222
|
+
### Authorization
|
|
223
|
+
|
|
224
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
225
|
+
|
|
226
|
+
### HTTP request headers
|
|
227
|
+
|
|
228
|
+
- **Content-Type**: Not defined
|
|
229
|
+
- **Accept**: application/json
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
### HTTP response details
|
|
233
|
+
| Status code | Description | Response headers |
|
|
234
|
+
|-------------|-------------|------------------|
|
|
235
|
+
|**200** | Successful response | - |
|
|
236
|
+
|
|
237
|
+
[[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)
|
|
238
|
+
|
|
239
|
+
# **updateEventAttribute**
|
|
240
|
+
> CreateAccountAddress200Response updateEventAttribute(eventAttributeUpdateInputs)
|
|
241
|
+
|
|
242
|
+
Update Event Attribute endpoint
|
|
243
|
+
|
|
244
|
+
### Example
|
|
245
|
+
|
|
246
|
+
```typescript
|
|
247
|
+
import {
|
|
248
|
+
EventsAttributesApi,
|
|
249
|
+
Configuration,
|
|
250
|
+
EventAttributeUpdateInputs
|
|
251
|
+
} from '@connectedxm/admin-sdk';
|
|
252
|
+
|
|
253
|
+
const configuration = new Configuration();
|
|
254
|
+
const apiInstance = new EventsAttributesApi(configuration);
|
|
255
|
+
|
|
256
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
257
|
+
let attributeId: string; //The attribute identifier (default to undefined)
|
|
258
|
+
let eventAttributeUpdateInputs: EventAttributeUpdateInputs; //
|
|
259
|
+
|
|
260
|
+
const { status, data } = await apiInstance.updateEventAttribute(
|
|
261
|
+
eventId,
|
|
262
|
+
attributeId,
|
|
263
|
+
eventAttributeUpdateInputs
|
|
264
|
+
);
|
|
265
|
+
```
|
|
266
|
+
|
|
267
|
+
### Parameters
|
|
268
|
+
|
|
269
|
+
|Name | Type | Description | Notes|
|
|
270
|
+
|------------- | ------------- | ------------- | -------------|
|
|
271
|
+
| **eventAttributeUpdateInputs** | **EventAttributeUpdateInputs**| | |
|
|
272
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
273
|
+
| **attributeId** | [**string**] | The attribute identifier | defaults to undefined|
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
### Return type
|
|
277
|
+
|
|
278
|
+
**CreateAccountAddress200Response**
|
|
279
|
+
|
|
280
|
+
### Authorization
|
|
281
|
+
|
|
282
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
283
|
+
|
|
284
|
+
### HTTP request headers
|
|
285
|
+
|
|
286
|
+
- **Content-Type**: application/json
|
|
287
|
+
- **Accept**: application/json
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
### HTTP response details
|
|
291
|
+
| Status code | Description | Response headers |
|
|
292
|
+
|-------------|-------------|------------------|
|
|
293
|
+
|**200** | Successful response | - |
|
|
294
|
+
|
|
295
|
+
[[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)
|
|
296
|
+
|
package/docs/EventsOnSiteApi.md
CHANGED
|
@@ -5,11 +5,8 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**getEventOnSite**](#geteventonsite) | **GET** /events/{eventId}/on-site | Get Event On Site|
|
|
8
|
-
|[**
|
|
9
|
-
|[**getEventZplTemplateBadgeFields**](#geteventzpltemplatebadgefields) | **GET** /events/{eventId}/zpl-template/fields | Get Event Zpl Template Badge Fields|
|
|
8
|
+
|[**updateEventBadgeTemplate**](#updateeventbadgetemplate) | **PUT** /events/{eventId}/template | Update Event Badge Template|
|
|
10
9
|
|[**updateEventCheckinCode**](#updateeventcheckincode) | **POST** /events/{eventId}/on-site | Update Event Checkin Code|
|
|
11
|
-
|[**updateEventZplTemplate**](#updateeventzpltemplate) | **PUT** /events/{eventId}/zpl-template | Update Event Zpl Template|
|
|
12
|
-
|[**updateEventZplTemplateBadgeField**](#updateeventzpltemplatebadgefield) | **PUT** /events/{eventId}/zpl-template/fields/{fieldId} | Update Event Zpl Template Badge Field|
|
|
13
10
|
|
|
14
11
|
# **getEventOnSite**
|
|
15
12
|
> GetEventOnSite200Response getEventOnSite()
|
|
@@ -62,10 +59,10 @@ const { status, data } = await apiInstance.getEventOnSite(
|
|
|
62
59
|
|
|
63
60
|
[[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)
|
|
64
61
|
|
|
65
|
-
# **
|
|
66
|
-
> CreateAccountAddress200Response
|
|
62
|
+
# **updateEventBadgeTemplate**
|
|
63
|
+
> CreateAccountAddress200Response updateEventBadgeTemplate(body)
|
|
67
64
|
|
|
68
|
-
|
|
65
|
+
Update Event Badge Template endpoint
|
|
69
66
|
|
|
70
67
|
### Example
|
|
71
68
|
|
|
@@ -79,11 +76,11 @@ const configuration = new Configuration();
|
|
|
79
76
|
const apiInstance = new EventsOnSiteApi(configuration);
|
|
80
77
|
|
|
81
78
|
let eventId: string; //The event identifier (default to undefined)
|
|
82
|
-
let
|
|
79
|
+
let body: object; //
|
|
83
80
|
|
|
84
|
-
const { status, data } = await apiInstance.
|
|
81
|
+
const { status, data } = await apiInstance.updateEventBadgeTemplate(
|
|
85
82
|
eventId,
|
|
86
|
-
|
|
83
|
+
body
|
|
87
84
|
);
|
|
88
85
|
```
|
|
89
86
|
|
|
@@ -91,8 +88,8 @@ const { status, data } = await apiInstance.getEventZplTemplateBadgeField(
|
|
|
91
88
|
|
|
92
89
|
|Name | Type | Description | Notes|
|
|
93
90
|
|------------- | ------------- | ------------- | -------------|
|
|
91
|
+
| **body** | **object**| | |
|
|
94
92
|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
95
|
-
| **fieldId** | [**string**] | The field identifier | defaults to undefined|
|
|
96
93
|
|
|
97
94
|
|
|
98
95
|
### Return type
|
|
@@ -105,70 +102,7 @@ const { status, data } = await apiInstance.getEventZplTemplateBadgeField(
|
|
|
105
102
|
|
|
106
103
|
### HTTP request headers
|
|
107
104
|
|
|
108
|
-
- **Content-Type**:
|
|
109
|
-
- **Accept**: application/json
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
### HTTP response details
|
|
113
|
-
| Status code | Description | Response headers |
|
|
114
|
-
|-------------|-------------|------------------|
|
|
115
|
-
|**200** | Successful response | - |
|
|
116
|
-
|
|
117
|
-
[[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)
|
|
118
|
-
|
|
119
|
-
# **getEventZplTemplateBadgeFields**
|
|
120
|
-
> GetAccountInvitations200Response getEventZplTemplateBadgeFields()
|
|
121
|
-
|
|
122
|
-
Get Event Zpl Template Badge Fields endpoint
|
|
123
|
-
|
|
124
|
-
### Example
|
|
125
|
-
|
|
126
|
-
```typescript
|
|
127
|
-
import {
|
|
128
|
-
EventsOnSiteApi,
|
|
129
|
-
Configuration
|
|
130
|
-
} from '@connectedxm/admin-sdk';
|
|
131
|
-
|
|
132
|
-
const configuration = new Configuration();
|
|
133
|
-
const apiInstance = new EventsOnSiteApi(configuration);
|
|
134
|
-
|
|
135
|
-
let eventId: string; //The event identifier (default to undefined)
|
|
136
|
-
let page: number; //Page number (optional) (default to 1)
|
|
137
|
-
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
138
|
-
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
139
|
-
let search: string; //Search query (optional) (default to undefined)
|
|
140
|
-
|
|
141
|
-
const { status, data } = await apiInstance.getEventZplTemplateBadgeFields(
|
|
142
|
-
eventId,
|
|
143
|
-
page,
|
|
144
|
-
pageSize,
|
|
145
|
-
orderBy,
|
|
146
|
-
search
|
|
147
|
-
);
|
|
148
|
-
```
|
|
149
|
-
|
|
150
|
-
### Parameters
|
|
151
|
-
|
|
152
|
-
|Name | Type | Description | Notes|
|
|
153
|
-
|------------- | ------------- | ------------- | -------------|
|
|
154
|
-
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
155
|
-
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
156
|
-
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
157
|
-
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
158
|
-
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
### Return type
|
|
162
|
-
|
|
163
|
-
**GetAccountInvitations200Response**
|
|
164
|
-
|
|
165
|
-
### Authorization
|
|
166
|
-
|
|
167
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
168
|
-
|
|
169
|
-
### HTTP request headers
|
|
170
|
-
|
|
171
|
-
- **Content-Type**: Not defined
|
|
105
|
+
- **Content-Type**: application/json
|
|
172
106
|
- **Accept**: application/json
|
|
173
107
|
|
|
174
108
|
|
|
@@ -230,115 +164,3 @@ const { status, data } = await apiInstance.updateEventCheckinCode(
|
|
|
230
164
|
|
|
231
165
|
[[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)
|
|
232
166
|
|
|
233
|
-
# **updateEventZplTemplate**
|
|
234
|
-
> UpdateEventCheckinCode200Response updateEventZplTemplate()
|
|
235
|
-
|
|
236
|
-
Update Event Zpl Template endpoint
|
|
237
|
-
|
|
238
|
-
### Example
|
|
239
|
-
|
|
240
|
-
```typescript
|
|
241
|
-
import {
|
|
242
|
-
EventsOnSiteApi,
|
|
243
|
-
Configuration
|
|
244
|
-
} from '@connectedxm/admin-sdk';
|
|
245
|
-
|
|
246
|
-
const configuration = new Configuration();
|
|
247
|
-
const apiInstance = new EventsOnSiteApi(configuration);
|
|
248
|
-
|
|
249
|
-
let eventId: string; //The event identifier (default to undefined)
|
|
250
|
-
let zplTemplate: string; //Filter by zplTemplate (default to undefined)
|
|
251
|
-
|
|
252
|
-
const { status, data } = await apiInstance.updateEventZplTemplate(
|
|
253
|
-
eventId,
|
|
254
|
-
zplTemplate
|
|
255
|
-
);
|
|
256
|
-
```
|
|
257
|
-
|
|
258
|
-
### Parameters
|
|
259
|
-
|
|
260
|
-
|Name | Type | Description | Notes|
|
|
261
|
-
|------------- | ------------- | ------------- | -------------|
|
|
262
|
-
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
263
|
-
| **zplTemplate** | [**string**] | Filter by zplTemplate | defaults to undefined|
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
### Return type
|
|
267
|
-
|
|
268
|
-
**UpdateEventCheckinCode200Response**
|
|
269
|
-
|
|
270
|
-
### Authorization
|
|
271
|
-
|
|
272
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
273
|
-
|
|
274
|
-
### HTTP request headers
|
|
275
|
-
|
|
276
|
-
- **Content-Type**: Not defined
|
|
277
|
-
- **Accept**: application/json
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
### HTTP response details
|
|
281
|
-
| Status code | Description | Response headers |
|
|
282
|
-
|-------------|-------------|------------------|
|
|
283
|
-
|**200** | Successful response | - |
|
|
284
|
-
|
|
285
|
-
[[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)
|
|
286
|
-
|
|
287
|
-
# **updateEventZplTemplateBadgeField**
|
|
288
|
-
> CreateAccountAddress200Response updateEventZplTemplateBadgeField()
|
|
289
|
-
|
|
290
|
-
Update Event Zpl Template Badge Field endpoint
|
|
291
|
-
|
|
292
|
-
### Example
|
|
293
|
-
|
|
294
|
-
```typescript
|
|
295
|
-
import {
|
|
296
|
-
EventsOnSiteApi,
|
|
297
|
-
Configuration,
|
|
298
|
-
EventBadgeFieldUpdateInputs
|
|
299
|
-
} from '@connectedxm/admin-sdk';
|
|
300
|
-
|
|
301
|
-
const configuration = new Configuration();
|
|
302
|
-
const apiInstance = new EventsOnSiteApi(configuration);
|
|
303
|
-
|
|
304
|
-
let eventId: string; //The event identifier (default to undefined)
|
|
305
|
-
let fieldId: string; //The field identifier (default to undefined)
|
|
306
|
-
let field: EventBadgeFieldUpdateInputs; //Filter by field (default to undefined)
|
|
307
|
-
|
|
308
|
-
const { status, data } = await apiInstance.updateEventZplTemplateBadgeField(
|
|
309
|
-
eventId,
|
|
310
|
-
fieldId,
|
|
311
|
-
field
|
|
312
|
-
);
|
|
313
|
-
```
|
|
314
|
-
|
|
315
|
-
### Parameters
|
|
316
|
-
|
|
317
|
-
|Name | Type | Description | Notes|
|
|
318
|
-
|------------- | ------------- | ------------- | -------------|
|
|
319
|
-
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
320
|
-
| **fieldId** | [**string**] | The field identifier | defaults to undefined|
|
|
321
|
-
| **field** | **EventBadgeFieldUpdateInputs** | Filter by field | defaults to undefined|
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
### Return type
|
|
325
|
-
|
|
326
|
-
**CreateAccountAddress200Response**
|
|
327
|
-
|
|
328
|
-
### Authorization
|
|
329
|
-
|
|
330
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
331
|
-
|
|
332
|
-
### HTTP request headers
|
|
333
|
-
|
|
334
|
-
- **Content-Type**: Not defined
|
|
335
|
-
- **Accept**: application/json
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
### HTTP response details
|
|
339
|
-
| Status code | Description | Response headers |
|
|
340
|
-
|-------------|-------------|------------------|
|
|
341
|
-
|**200** | Successful response | - |
|
|
342
|
-
|
|
343
|
-
[[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)
|
|
344
|
-
|