@connectedxm/admin-sdk 6.17.4 → 6.18.1
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 +123 -1
- package/AdminApi.ts +105 -0
- package/README.md +250 -1
- package/api.ts +66555 -46058
- package/dist/AdminApi.d.ts +36 -1
- package/dist/AdminApi.js +35 -0
- package/dist/api.d.ts +11267 -466
- package/dist/api.js +34671 -19447
- package/dist/esm/AdminApi.d.ts +36 -1
- package/dist/esm/AdminApi.js +36 -1
- package/dist/esm/api.d.ts +11267 -466
- package/dist/esm/api.js +32890 -17811
- package/docs/AnnouncementsTranslationsApi.md +240 -0
- package/docs/BenefitsTranslationsApi.md +240 -0
- package/docs/BookingsApi.md +244 -0
- package/docs/BookingsPlacesTranslationsApi.md +121 -0
- package/docs/BookingsSpacesTranslationsApi.md +127 -0
- package/docs/ChannelsTranslationsApi.md +742 -0
- package/docs/DashboardsApi.md +2 -2
- package/docs/DashboardsWidgetsApi.md +2 -2
- package/docs/Event.md +2 -0
- package/docs/EventCreateInputs.md +2 -0
- package/docs/EventUpdateInputs.md +2 -0
- package/docs/EventsAccessApi.md +4 -4
- package/docs/EventsActivationsTranslationsApi.md +252 -0
- package/docs/EventsAddonsTranslationsApi.md +252 -0
- package/docs/EventsApi.md +2 -2
- package/docs/EventsAttendeesPackagesApi.md +2 -2
- package/docs/EventsEmailsTranslationsApi.md +252 -0
- package/docs/EventsFaqsTranslationsApi.md +509 -0
- package/docs/EventsFollowupsTranslationsApi.md +252 -0
- package/docs/EventsMediaTranslationsApi.md +252 -0
- package/docs/EventsPackagesTranslationsApi.md +252 -0
- package/docs/EventsPagesTranslationsApi.md +252 -0
- package/docs/EventsPasstypesPriceschedulesApi.md +4 -4
- package/docs/EventsPasstypesRefundschedulesApi.md +4 -4
- package/docs/EventsPasstypesTranslationsApi.md +252 -0
- package/docs/EventsQuestionsApi.md +2 -2
- package/docs/EventsQuestionsTranslationsApi.md +509 -0
- package/docs/EventsRoomtypesTranslationsApi.md +252 -0
- package/docs/EventsSectionsTranslationsApi.md +252 -0
- package/docs/EventsSessionsApi.md +2 -2
- package/docs/EventsSessionsLocationsTranslationsApi.md +252 -0
- package/docs/EventsSessionsQuestionsApi.md +2 -2
- package/docs/EventsSessionsQuestionsTranslationsApi.md +533 -0
- package/docs/EventsSessionsSectionsTranslationsApi.md +264 -0
- package/docs/EventsSessionsTranslationsApi.md +252 -0
- package/docs/EventsSpeakersTranslationsApi.md +252 -0
- package/docs/EventsSponsorshiplevelsTranslationsApi.md +252 -0
- package/docs/EventsSponsorshipsTranslationsApi.md +264 -0
- package/docs/EventsTracksTranslationsApi.md +252 -0
- package/docs/EventsTranslationsApi.md +240 -0
- package/docs/GetAnnouncementTranslation200Response.md +24 -0
- package/docs/GetAnnouncementTranslations200Response.md +26 -0
- package/docs/GetBenefitTranslation200Response.md +24 -0
- package/docs/GetBenefitTranslations200Response.md +26 -0
- package/docs/GetBookingPlaceTranslation200Response.md +24 -0
- package/docs/GetBookingPlaceTranslations200Response.md +26 -0
- package/docs/GetBookingSpaceTranslation200Response.md +24 -0
- package/docs/GetBookingSpaceTranslations200Response.md +26 -0
- package/docs/GetChannelContentGuestTranslation200Response.md +24 -0
- package/docs/GetChannelContentGuestTranslations200Response.md +26 -0
- package/docs/GetChannelContentTranslation200Response.md +24 -0
- package/docs/GetChannelContentTranslations200Response.md +26 -0
- package/docs/GetChannelTranslation200Response.md +24 -0
- package/docs/GetChannelTranslations200Response.md +26 -0
- package/docs/GetCustomModuleTranslation200Response.md +24 -0
- package/docs/GetCustomModuleTranslations200Response.md +26 -0
- package/docs/GetEventActivationTranslation200Response.md +24 -0
- package/docs/GetEventActivationTranslations200Response.md +26 -0
- package/docs/GetEventAddOnTranslation200Response.md +24 -0
- package/docs/GetEventAddOnTranslations200Response.md +26 -0
- package/docs/GetEventEmailTranslation200Response.md +24 -0
- package/docs/GetEventEmailTranslations200Response.md +26 -0
- package/docs/GetEventFaqSectionQuestionTranslation200Response.md +24 -0
- package/docs/GetEventFaqSectionQuestionTranslations200Response.md +26 -0
- package/docs/GetEventFaqSectionTranslation200Response.md +24 -0
- package/docs/GetEventFaqSectionTranslations200Response.md +26 -0
- package/docs/GetEventFollowupTranslation200Response.md +24 -0
- package/docs/GetEventFollowupTranslations200Response.md +26 -0
- package/docs/GetEventMediaItemTranslation200Response.md +24 -0
- package/docs/GetEventMediaItemTranslations200Response.md +26 -0
- package/docs/GetEventPackageTranslation200Response.md +24 -0
- package/docs/GetEventPackageTranslations200Response.md +26 -0
- package/docs/GetEventPageTranslation200Response.md +24 -0
- package/docs/GetEventPageTranslations200Response.md +26 -0
- package/docs/GetEventPassTypeTranslation200Response.md +24 -0
- package/docs/GetEventPassTypeTranslations200Response.md +26 -0
- package/docs/GetEventQuestionChoiceTranslation200Response.md +24 -0
- package/docs/GetEventQuestionChoiceTranslations200Response.md +26 -0
- package/docs/GetEventQuestionTranslation200Response.md +24 -0
- package/docs/GetEventQuestionTranslations200Response.md +26 -0
- package/docs/GetEventRoomTypeTranslation200Response.md +24 -0
- package/docs/GetEventRoomTypeTranslations200Response.md +26 -0
- package/docs/GetEventSectionTranslation200Response.md +24 -0
- package/docs/GetEventSectionTranslations200Response.md +26 -0
- package/docs/GetEventSessionLocationTranslation200Response.md +24 -0
- package/docs/GetEventSessionLocationTranslations200Response.md +26 -0
- package/docs/GetEventSessionQuestionChoiceTranslation200Response.md +24 -0
- package/docs/GetEventSessionQuestionChoiceTranslations200Response.md +26 -0
- package/docs/GetEventSessionQuestionTranslation200Response.md +24 -0
- package/docs/GetEventSessionQuestionTranslations200Response.md +26 -0
- package/docs/GetEventSessionSectionTranslation200Response.md +24 -0
- package/docs/GetEventSessionSectionTranslations200Response.md +26 -0
- package/docs/GetEventSessionTranslation200Response.md +24 -0
- package/docs/GetEventSessionTranslations200Response.md +26 -0
- package/docs/GetEventSpeakerTranslation200Response.md +24 -0
- package/docs/GetEventSpeakerTranslations200Response.md +26 -0
- package/docs/GetEventSponsorshipLevelTranslation200Response.md +24 -0
- package/docs/GetEventSponsorshipLevelTranslations200Response.md +26 -0
- package/docs/GetEventSponsorshipTranslation200Response.md +24 -0
- package/docs/GetEventSponsorshipTranslations200Response.md +26 -0
- package/docs/GetEventTrackTranslation200Response.md +24 -0
- package/docs/GetEventTrackTranslations200Response.md +26 -0
- package/docs/GetEventTranslation200Response.md +24 -0
- package/docs/GetEventTranslations200Response.md +26 -0
- package/docs/GetGroupTranslation200Response.md +24 -0
- package/docs/GetGroupTranslations200Response.md +26 -0
- package/docs/GetLevelTranslation200Response.md +24 -0
- package/docs/GetLevelTranslations200Response.md +26 -0
- package/docs/GetOrganizationModuleSettingsTranslation200Response.md +24 -0
- package/docs/GetOrganizationModuleSettingsTranslations200Response.md +26 -0
- package/docs/GetSeriesQuestionTranslation200Response.md +24 -0
- package/docs/GetSeriesTranslation200Response.md +24 -0
- package/docs/GetSeriesTranslations200Response.md +26 -0
- package/docs/GetSurveyQuestionChoiceTranslation200Response.md +24 -0
- package/docs/GetSurveyQuestionChoiceTranslations200Response.md +26 -0
- package/docs/GetSurveyQuestionTranslation200Response.md +24 -0
- package/docs/GetSurveyQuestionTranslations200Response.md +26 -0
- package/docs/GetSurveySectionTranslation200Response.md +24 -0
- package/docs/GetSurveySectionTranslations200Response.md +26 -0
- package/docs/GetSurveyTranslation200Response.md +24 -0
- package/docs/GetSurveyTranslations200Response.md +26 -0
- package/docs/GroupsTranslationsApi.md +240 -0
- package/docs/MeetingsParticipantsApi.md +4 -4
- package/docs/MeetingsSessionsApi.md +2 -2
- package/docs/NotificationsApi.md +4 -4
- package/docs/OrganizationModulesCustomTranslationsApi.md +240 -0
- package/docs/OrganizationModulesSettingsTranslationsApi.md +228 -0
- package/docs/OrganizationPaymentsApi.md +2 -2
- package/docs/OrganizationTeammembersApi.md +2 -2
- package/docs/SeriesQuestionsTranslationsApi.md +127 -0
- package/docs/SeriesTranslationsApi.md +240 -0
- package/docs/SponsorsTranslationsApi.md +240 -0
- package/docs/StorageVideosApi.md +4 -4
- package/docs/StorageVideosCaptionsApi.md +2 -2
- package/docs/SupportedLocale.md +0 -2
- package/docs/SurveysQuestionsApi.md +2 -2
- package/docs/SurveysQuestionsTranslationsApi.md +509 -0
- package/docs/SurveysSectionsTranslationsApi.md +252 -0
- package/docs/SurveysTranslationsApi.md +240 -0
- package/docs/{DeleteDashboard200Response.md → UpdateAnnouncementTranslation200Response.md} +3 -3
- package/docs/UpdateChannelContentGuestTranslation200Response.md +24 -0
- package/docs/UpdateChannelTranslation200Response.md +24 -0
- package/docs/UpdateEventActivationTranslation200Response.md +24 -0
- package/docs/UpdateEventAddOnTranslation200Response.md +24 -0
- package/docs/UpdateEventMediaItemTranslation200Response.md +24 -0
- package/docs/UpdateSeriesQuestionTranslation200Response.md +24 -0
- package/package.json +1 -1
|
@@ -0,0 +1,252 @@
|
|
|
1
|
+
# EventsPackagesTranslationsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://admin-api.connected.dev*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**deleteEventPackageTranslation**](#deleteeventpackagetranslation) | **DELETE** /events/{eventId}/packages/{packageId}/translations/{locale} | Delete Event Package Translation|
|
|
8
|
+
|[**getEventPackageTranslation**](#geteventpackagetranslation) | **GET** /events/{eventId}/packages/{packageId}/translations/{locale} | Get Event Package Translation|
|
|
9
|
+
|[**getEventPackageTranslations**](#geteventpackagetranslations) | **GET** /events/{eventId}/packages/{packageId}/translations | Get Event Package Translations|
|
|
10
|
+
|[**updateEventPackageTranslation**](#updateeventpackagetranslation) | **PUT** /events/{eventId}/packages/{packageId}/translations/{locale} | Update Event Package Translation|
|
|
11
|
+
|
|
12
|
+
# **deleteEventPackageTranslation**
|
|
13
|
+
> CreateAccountInvitations200Response deleteEventPackageTranslation()
|
|
14
|
+
|
|
15
|
+
Delete Event Package Translation endpoint
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import {
|
|
21
|
+
EventsPackagesTranslationsApi,
|
|
22
|
+
Configuration
|
|
23
|
+
} from '@connectedxm/admin-sdk';
|
|
24
|
+
|
|
25
|
+
const configuration = new Configuration();
|
|
26
|
+
const apiInstance = new EventsPackagesTranslationsApi(configuration);
|
|
27
|
+
|
|
28
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
29
|
+
let packageId: string; //The package identifier (default to undefined)
|
|
30
|
+
let locale: string; //The locale identifier (default to undefined)
|
|
31
|
+
|
|
32
|
+
const { status, data } = await apiInstance.deleteEventPackageTranslation(
|
|
33
|
+
eventId,
|
|
34
|
+
packageId,
|
|
35
|
+
locale
|
|
36
|
+
);
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### Parameters
|
|
40
|
+
|
|
41
|
+
|Name | Type | Description | Notes|
|
|
42
|
+
|------------- | ------------- | ------------- | -------------|
|
|
43
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
44
|
+
| **packageId** | [**string**] | The package identifier | defaults to undefined|
|
|
45
|
+
| **locale** | [**string**] | The locale identifier | defaults to undefined|
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
### Return type
|
|
49
|
+
|
|
50
|
+
**CreateAccountInvitations200Response**
|
|
51
|
+
|
|
52
|
+
### Authorization
|
|
53
|
+
|
|
54
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
55
|
+
|
|
56
|
+
### HTTP request headers
|
|
57
|
+
|
|
58
|
+
- **Content-Type**: Not defined
|
|
59
|
+
- **Accept**: application/json
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
### HTTP response details
|
|
63
|
+
| Status code | Description | Response headers |
|
|
64
|
+
|-------------|-------------|------------------|
|
|
65
|
+
|**200** | Successful response | - |
|
|
66
|
+
|
|
67
|
+
[[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)
|
|
68
|
+
|
|
69
|
+
# **getEventPackageTranslation**
|
|
70
|
+
> GetEventPackageTranslation200Response getEventPackageTranslation()
|
|
71
|
+
|
|
72
|
+
Get Event Package Translation endpoint
|
|
73
|
+
|
|
74
|
+
### Example
|
|
75
|
+
|
|
76
|
+
```typescript
|
|
77
|
+
import {
|
|
78
|
+
EventsPackagesTranslationsApi,
|
|
79
|
+
Configuration
|
|
80
|
+
} from '@connectedxm/admin-sdk';
|
|
81
|
+
|
|
82
|
+
const configuration = new Configuration();
|
|
83
|
+
const apiInstance = new EventsPackagesTranslationsApi(configuration);
|
|
84
|
+
|
|
85
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
86
|
+
let packageId: string; //The package identifier (default to undefined)
|
|
87
|
+
let locale: string; //The locale identifier (default to undefined)
|
|
88
|
+
|
|
89
|
+
const { status, data } = await apiInstance.getEventPackageTranslation(
|
|
90
|
+
eventId,
|
|
91
|
+
packageId,
|
|
92
|
+
locale
|
|
93
|
+
);
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Parameters
|
|
97
|
+
|
|
98
|
+
|Name | Type | Description | Notes|
|
|
99
|
+
|------------- | ------------- | ------------- | -------------|
|
|
100
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
101
|
+
| **packageId** | [**string**] | The package identifier | defaults to undefined|
|
|
102
|
+
| **locale** | [**string**] | The locale identifier | defaults to undefined|
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
### Return type
|
|
106
|
+
|
|
107
|
+
**GetEventPackageTranslation200Response**
|
|
108
|
+
|
|
109
|
+
### Authorization
|
|
110
|
+
|
|
111
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
112
|
+
|
|
113
|
+
### HTTP request headers
|
|
114
|
+
|
|
115
|
+
- **Content-Type**: Not defined
|
|
116
|
+
- **Accept**: application/json
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
### HTTP response details
|
|
120
|
+
| Status code | Description | Response headers |
|
|
121
|
+
|-------------|-------------|------------------|
|
|
122
|
+
|**200** | Successful response | - |
|
|
123
|
+
|
|
124
|
+
[[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)
|
|
125
|
+
|
|
126
|
+
# **getEventPackageTranslations**
|
|
127
|
+
> GetEventPackageTranslations200Response getEventPackageTranslations()
|
|
128
|
+
|
|
129
|
+
Get Event Package Translations endpoint
|
|
130
|
+
|
|
131
|
+
### Example
|
|
132
|
+
|
|
133
|
+
```typescript
|
|
134
|
+
import {
|
|
135
|
+
EventsPackagesTranslationsApi,
|
|
136
|
+
Configuration
|
|
137
|
+
} from '@connectedxm/admin-sdk';
|
|
138
|
+
|
|
139
|
+
const configuration = new Configuration();
|
|
140
|
+
const apiInstance = new EventsPackagesTranslationsApi(configuration);
|
|
141
|
+
|
|
142
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
143
|
+
let packageId: string; //The package identifier (default to undefined)
|
|
144
|
+
let page: number; //Page number (optional) (default to 1)
|
|
145
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
146
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
147
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
148
|
+
|
|
149
|
+
const { status, data } = await apiInstance.getEventPackageTranslations(
|
|
150
|
+
eventId,
|
|
151
|
+
packageId,
|
|
152
|
+
page,
|
|
153
|
+
pageSize,
|
|
154
|
+
orderBy,
|
|
155
|
+
search
|
|
156
|
+
);
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
### Parameters
|
|
160
|
+
|
|
161
|
+
|Name | Type | Description | Notes|
|
|
162
|
+
|------------- | ------------- | ------------- | -------------|
|
|
163
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
164
|
+
| **packageId** | [**string**] | The package identifier | defaults to undefined|
|
|
165
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
166
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
167
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
168
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
### Return type
|
|
172
|
+
|
|
173
|
+
**GetEventPackageTranslations200Response**
|
|
174
|
+
|
|
175
|
+
### Authorization
|
|
176
|
+
|
|
177
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
178
|
+
|
|
179
|
+
### HTTP request headers
|
|
180
|
+
|
|
181
|
+
- **Content-Type**: Not defined
|
|
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
|
+
|
|
192
|
+
# **updateEventPackageTranslation**
|
|
193
|
+
> GetEventPackageTranslation200Response updateEventPackageTranslation(eventPackageTranslationUpdateInputs)
|
|
194
|
+
|
|
195
|
+
Update Event Package Translation endpoint
|
|
196
|
+
|
|
197
|
+
### Example
|
|
198
|
+
|
|
199
|
+
```typescript
|
|
200
|
+
import {
|
|
201
|
+
EventsPackagesTranslationsApi,
|
|
202
|
+
Configuration,
|
|
203
|
+
EventPackageTranslationUpdateInputs
|
|
204
|
+
} from '@connectedxm/admin-sdk';
|
|
205
|
+
|
|
206
|
+
const configuration = new Configuration();
|
|
207
|
+
const apiInstance = new EventsPackagesTranslationsApi(configuration);
|
|
208
|
+
|
|
209
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
210
|
+
let packageId: string; //The package identifier (default to undefined)
|
|
211
|
+
let locale: string; //The locale identifier (default to undefined)
|
|
212
|
+
let eventPackageTranslationUpdateInputs: EventPackageTranslationUpdateInputs; //
|
|
213
|
+
|
|
214
|
+
const { status, data } = await apiInstance.updateEventPackageTranslation(
|
|
215
|
+
eventId,
|
|
216
|
+
packageId,
|
|
217
|
+
locale,
|
|
218
|
+
eventPackageTranslationUpdateInputs
|
|
219
|
+
);
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
### Parameters
|
|
223
|
+
|
|
224
|
+
|Name | Type | Description | Notes|
|
|
225
|
+
|------------- | ------------- | ------------- | -------------|
|
|
226
|
+
| **eventPackageTranslationUpdateInputs** | **EventPackageTranslationUpdateInputs**| | |
|
|
227
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
228
|
+
| **packageId** | [**string**] | The package identifier | defaults to undefined|
|
|
229
|
+
| **locale** | [**string**] | The locale identifier | defaults to undefined|
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
### Return type
|
|
233
|
+
|
|
234
|
+
**GetEventPackageTranslation200Response**
|
|
235
|
+
|
|
236
|
+
### Authorization
|
|
237
|
+
|
|
238
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
239
|
+
|
|
240
|
+
### HTTP request headers
|
|
241
|
+
|
|
242
|
+
- **Content-Type**: application/json
|
|
243
|
+
- **Accept**: application/json
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
### HTTP response details
|
|
247
|
+
| Status code | Description | Response headers |
|
|
248
|
+
|-------------|-------------|------------------|
|
|
249
|
+
|**200** | Successful response | - |
|
|
250
|
+
|
|
251
|
+
[[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)
|
|
252
|
+
|
|
@@ -0,0 +1,252 @@
|
|
|
1
|
+
# EventsPagesTranslationsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://admin-api.connected.dev*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**deleteEventPageTranslation**](#deleteeventpagetranslation) | **DELETE** /events/{eventId}/pages/{pageId}/translations/{locale} | Delete Event Page Translation|
|
|
8
|
+
|[**getEventPageTranslation**](#geteventpagetranslation) | **GET** /events/{eventId}/pages/{pageId}/translations/{locale} | Get Event Page Translation|
|
|
9
|
+
|[**getEventPageTranslations**](#geteventpagetranslations) | **GET** /events/{eventId}/pages/{pageId}/translations | Get Event Page Translations|
|
|
10
|
+
|[**updateEventPageTranslation**](#updateeventpagetranslation) | **PUT** /events/{eventId}/pages/{pageId}/translations/{locale} | Update Event Page Translation|
|
|
11
|
+
|
|
12
|
+
# **deleteEventPageTranslation**
|
|
13
|
+
> UpdateAnnouncementTranslation200Response deleteEventPageTranslation()
|
|
14
|
+
|
|
15
|
+
Delete Event Page Translation endpoint
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import {
|
|
21
|
+
EventsPagesTranslationsApi,
|
|
22
|
+
Configuration
|
|
23
|
+
} from '@connectedxm/admin-sdk';
|
|
24
|
+
|
|
25
|
+
const configuration = new Configuration();
|
|
26
|
+
const apiInstance = new EventsPagesTranslationsApi(configuration);
|
|
27
|
+
|
|
28
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
29
|
+
let pageId: string; //The page identifier (default to undefined)
|
|
30
|
+
let locale: string; //The locale identifier (default to undefined)
|
|
31
|
+
|
|
32
|
+
const { status, data } = await apiInstance.deleteEventPageTranslation(
|
|
33
|
+
eventId,
|
|
34
|
+
pageId,
|
|
35
|
+
locale
|
|
36
|
+
);
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### Parameters
|
|
40
|
+
|
|
41
|
+
|Name | Type | Description | Notes|
|
|
42
|
+
|------------- | ------------- | ------------- | -------------|
|
|
43
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
44
|
+
| **pageId** | [**string**] | The page identifier | defaults to undefined|
|
|
45
|
+
| **locale** | [**string**] | The locale identifier | defaults to undefined|
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
### Return type
|
|
49
|
+
|
|
50
|
+
**UpdateAnnouncementTranslation200Response**
|
|
51
|
+
|
|
52
|
+
### Authorization
|
|
53
|
+
|
|
54
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
55
|
+
|
|
56
|
+
### HTTP request headers
|
|
57
|
+
|
|
58
|
+
- **Content-Type**: Not defined
|
|
59
|
+
- **Accept**: application/json
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
### HTTP response details
|
|
63
|
+
| Status code | Description | Response headers |
|
|
64
|
+
|-------------|-------------|------------------|
|
|
65
|
+
|**200** | Successful response | - |
|
|
66
|
+
|
|
67
|
+
[[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)
|
|
68
|
+
|
|
69
|
+
# **getEventPageTranslation**
|
|
70
|
+
> GetEventPageTranslation200Response getEventPageTranslation()
|
|
71
|
+
|
|
72
|
+
Get Event Page Translation endpoint
|
|
73
|
+
|
|
74
|
+
### Example
|
|
75
|
+
|
|
76
|
+
```typescript
|
|
77
|
+
import {
|
|
78
|
+
EventsPagesTranslationsApi,
|
|
79
|
+
Configuration
|
|
80
|
+
} from '@connectedxm/admin-sdk';
|
|
81
|
+
|
|
82
|
+
const configuration = new Configuration();
|
|
83
|
+
const apiInstance = new EventsPagesTranslationsApi(configuration);
|
|
84
|
+
|
|
85
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
86
|
+
let pageId: string; //The page identifier (default to undefined)
|
|
87
|
+
let locale: string; //The locale identifier (default to undefined)
|
|
88
|
+
|
|
89
|
+
const { status, data } = await apiInstance.getEventPageTranslation(
|
|
90
|
+
eventId,
|
|
91
|
+
pageId,
|
|
92
|
+
locale
|
|
93
|
+
);
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Parameters
|
|
97
|
+
|
|
98
|
+
|Name | Type | Description | Notes|
|
|
99
|
+
|------------- | ------------- | ------------- | -------------|
|
|
100
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
101
|
+
| **pageId** | [**string**] | The page identifier | defaults to undefined|
|
|
102
|
+
| **locale** | [**string**] | The locale identifier | defaults to undefined|
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
### Return type
|
|
106
|
+
|
|
107
|
+
**GetEventPageTranslation200Response**
|
|
108
|
+
|
|
109
|
+
### Authorization
|
|
110
|
+
|
|
111
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
112
|
+
|
|
113
|
+
### HTTP request headers
|
|
114
|
+
|
|
115
|
+
- **Content-Type**: Not defined
|
|
116
|
+
- **Accept**: application/json
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
### HTTP response details
|
|
120
|
+
| Status code | Description | Response headers |
|
|
121
|
+
|-------------|-------------|------------------|
|
|
122
|
+
|**200** | Successful response | - |
|
|
123
|
+
|
|
124
|
+
[[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)
|
|
125
|
+
|
|
126
|
+
# **getEventPageTranslations**
|
|
127
|
+
> GetEventPageTranslations200Response getEventPageTranslations()
|
|
128
|
+
|
|
129
|
+
Get Event Page Translations endpoint
|
|
130
|
+
|
|
131
|
+
### Example
|
|
132
|
+
|
|
133
|
+
```typescript
|
|
134
|
+
import {
|
|
135
|
+
EventsPagesTranslationsApi,
|
|
136
|
+
Configuration
|
|
137
|
+
} from '@connectedxm/admin-sdk';
|
|
138
|
+
|
|
139
|
+
const configuration = new Configuration();
|
|
140
|
+
const apiInstance = new EventsPagesTranslationsApi(configuration);
|
|
141
|
+
|
|
142
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
143
|
+
let pageId: string; //The page identifier (default to undefined)
|
|
144
|
+
let page: number; //Page number (optional) (default to 1)
|
|
145
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
146
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
147
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
148
|
+
|
|
149
|
+
const { status, data } = await apiInstance.getEventPageTranslations(
|
|
150
|
+
eventId,
|
|
151
|
+
pageId,
|
|
152
|
+
page,
|
|
153
|
+
pageSize,
|
|
154
|
+
orderBy,
|
|
155
|
+
search
|
|
156
|
+
);
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
### Parameters
|
|
160
|
+
|
|
161
|
+
|Name | Type | Description | Notes|
|
|
162
|
+
|------------- | ------------- | ------------- | -------------|
|
|
163
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
164
|
+
| **pageId** | [**string**] | The page identifier | defaults to undefined|
|
|
165
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
166
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
167
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
168
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
### Return type
|
|
172
|
+
|
|
173
|
+
**GetEventPageTranslations200Response**
|
|
174
|
+
|
|
175
|
+
### Authorization
|
|
176
|
+
|
|
177
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
178
|
+
|
|
179
|
+
### HTTP request headers
|
|
180
|
+
|
|
181
|
+
- **Content-Type**: Not defined
|
|
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
|
+
|
|
192
|
+
# **updateEventPageTranslation**
|
|
193
|
+
> UpdateAnnouncementTranslation200Response updateEventPageTranslation(eventPageTranslationUpdateInputs)
|
|
194
|
+
|
|
195
|
+
Update Event Page Translation endpoint
|
|
196
|
+
|
|
197
|
+
### Example
|
|
198
|
+
|
|
199
|
+
```typescript
|
|
200
|
+
import {
|
|
201
|
+
EventsPagesTranslationsApi,
|
|
202
|
+
Configuration,
|
|
203
|
+
EventPageTranslationUpdateInputs
|
|
204
|
+
} from '@connectedxm/admin-sdk';
|
|
205
|
+
|
|
206
|
+
const configuration = new Configuration();
|
|
207
|
+
const apiInstance = new EventsPagesTranslationsApi(configuration);
|
|
208
|
+
|
|
209
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
210
|
+
let pageId: string; //The page identifier (default to undefined)
|
|
211
|
+
let locale: string; //The locale identifier (default to undefined)
|
|
212
|
+
let eventPageTranslationUpdateInputs: EventPageTranslationUpdateInputs; //
|
|
213
|
+
|
|
214
|
+
const { status, data } = await apiInstance.updateEventPageTranslation(
|
|
215
|
+
eventId,
|
|
216
|
+
pageId,
|
|
217
|
+
locale,
|
|
218
|
+
eventPageTranslationUpdateInputs
|
|
219
|
+
);
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
### Parameters
|
|
223
|
+
|
|
224
|
+
|Name | Type | Description | Notes|
|
|
225
|
+
|------------- | ------------- | ------------- | -------------|
|
|
226
|
+
| **eventPageTranslationUpdateInputs** | **EventPageTranslationUpdateInputs**| | |
|
|
227
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
228
|
+
| **pageId** | [**string**] | The page identifier | defaults to undefined|
|
|
229
|
+
| **locale** | [**string**] | The locale identifier | defaults to undefined|
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
### Return type
|
|
233
|
+
|
|
234
|
+
**UpdateAnnouncementTranslation200Response**
|
|
235
|
+
|
|
236
|
+
### Authorization
|
|
237
|
+
|
|
238
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
239
|
+
|
|
240
|
+
### HTTP request headers
|
|
241
|
+
|
|
242
|
+
- **Content-Type**: application/json
|
|
243
|
+
- **Accept**: application/json
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
### HTTP response details
|
|
247
|
+
| Status code | Description | Response headers |
|
|
248
|
+
|-------------|-------------|------------------|
|
|
249
|
+
|**200** | Successful response | - |
|
|
250
|
+
|
|
251
|
+
[[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)
|
|
252
|
+
|
|
@@ -69,7 +69,7 @@ const { status, data } = await apiInstance.createEventPassTypePriceSchedule(
|
|
|
69
69
|
[[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)
|
|
70
70
|
|
|
71
71
|
# **deleteEventPassTypePriceSchedule**
|
|
72
|
-
>
|
|
72
|
+
> UpdateAnnouncementTranslation200Response deleteEventPassTypePriceSchedule()
|
|
73
73
|
|
|
74
74
|
Delete Event Pass Type Price Schedule endpoint
|
|
75
75
|
|
|
@@ -106,7 +106,7 @@ const { status, data } = await apiInstance.deleteEventPassTypePriceSchedule(
|
|
|
106
106
|
|
|
107
107
|
### Return type
|
|
108
108
|
|
|
109
|
-
**
|
|
109
|
+
**UpdateAnnouncementTranslation200Response**
|
|
110
110
|
|
|
111
111
|
### Authorization
|
|
112
112
|
|
|
@@ -249,7 +249,7 @@ const { status, data } = await apiInstance.getEventPassTypePriceSchedules(
|
|
|
249
249
|
[[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)
|
|
250
250
|
|
|
251
251
|
# **updateEventPassTypePriceSchedule**
|
|
252
|
-
>
|
|
252
|
+
> UpdateAnnouncementTranslation200Response updateEventPassTypePriceSchedule(passTypePriceScheduleUpdateInputs)
|
|
253
253
|
|
|
254
254
|
Update Event Pass Type Price Schedule endpoint
|
|
255
255
|
|
|
@@ -290,7 +290,7 @@ const { status, data } = await apiInstance.updateEventPassTypePriceSchedule(
|
|
|
290
290
|
|
|
291
291
|
### Return type
|
|
292
292
|
|
|
293
|
-
**
|
|
293
|
+
**UpdateAnnouncementTranslation200Response**
|
|
294
294
|
|
|
295
295
|
### Authorization
|
|
296
296
|
|
|
@@ -69,7 +69,7 @@ const { status, data } = await apiInstance.createEventPassTypeRefundSchedule(
|
|
|
69
69
|
[[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)
|
|
70
70
|
|
|
71
71
|
# **deleteEventPassTypeRefundSchedule**
|
|
72
|
-
>
|
|
72
|
+
> UpdateAnnouncementTranslation200Response deleteEventPassTypeRefundSchedule()
|
|
73
73
|
|
|
74
74
|
Delete Event Pass Type Refund Schedule endpoint
|
|
75
75
|
|
|
@@ -106,7 +106,7 @@ const { status, data } = await apiInstance.deleteEventPassTypeRefundSchedule(
|
|
|
106
106
|
|
|
107
107
|
### Return type
|
|
108
108
|
|
|
109
|
-
**
|
|
109
|
+
**UpdateAnnouncementTranslation200Response**
|
|
110
110
|
|
|
111
111
|
### Authorization
|
|
112
112
|
|
|
@@ -249,7 +249,7 @@ const { status, data } = await apiInstance.getEventPassTypeRefundSchedules(
|
|
|
249
249
|
[[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)
|
|
250
250
|
|
|
251
251
|
# **updateEventPassTypeRefundSchedule**
|
|
252
|
-
>
|
|
252
|
+
> UpdateAnnouncementTranslation200Response updateEventPassTypeRefundSchedule(passTypeRefundScheduleUpdateInputs)
|
|
253
253
|
|
|
254
254
|
Update Event Pass Type Refund Schedule endpoint
|
|
255
255
|
|
|
@@ -290,7 +290,7 @@ const { status, data } = await apiInstance.updateEventPassTypeRefundSchedule(
|
|
|
290
290
|
|
|
291
291
|
### Return type
|
|
292
292
|
|
|
293
|
-
**
|
|
293
|
+
**UpdateAnnouncementTranslation200Response**
|
|
294
294
|
|
|
295
295
|
### Authorization
|
|
296
296
|
|