@connectedxm/admin-sdk 6.17.4 → 6.20.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 +123 -1
- package/AdminApi.ts +105 -0
- package/README.md +251 -1
- package/api.ts +66625 -46033
- package/dist/AdminApi.d.ts +36 -1
- package/dist/AdminApi.js +35 -0
- package/dist/api.d.ts +11413 -565
- package/dist/api.js +34726 -19427
- package/dist/esm/AdminApi.d.ts +36 -1
- package/dist/esm/AdminApi.js +36 -1
- package/dist/esm/api.d.ts +11413 -565
- package/dist/esm/api.js +32952 -17798
- 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/EventsPassesApi.md +52 -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/SurveysSubmissionsApi.md +3 -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
package/docs/DashboardsApi.md
CHANGED
|
@@ -63,7 +63,7 @@ const { status, data } = await apiInstance.createDashboard(
|
|
|
63
63
|
[[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
64
|
|
|
65
65
|
# **deleteDashboard**
|
|
66
|
-
>
|
|
66
|
+
> UpdateAnnouncementTranslation200Response deleteDashboard()
|
|
67
67
|
|
|
68
68
|
Delete Dashboard endpoint
|
|
69
69
|
|
|
@@ -94,7 +94,7 @@ const { status, data } = await apiInstance.deleteDashboard(
|
|
|
94
94
|
|
|
95
95
|
### Return type
|
|
96
96
|
|
|
97
|
-
**
|
|
97
|
+
**UpdateAnnouncementTranslation200Response**
|
|
98
98
|
|
|
99
99
|
### Authorization
|
|
100
100
|
|
|
@@ -65,7 +65,7 @@ const { status, data } = await apiInstance.createDashboardWidget(
|
|
|
65
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
66
|
|
|
67
67
|
# **deleteDashboardWidget**
|
|
68
|
-
>
|
|
68
|
+
> UpdateAnnouncementTranslation200Response deleteDashboardWidget()
|
|
69
69
|
|
|
70
70
|
Delete Dashboard Widget endpoint
|
|
71
71
|
|
|
@@ -99,7 +99,7 @@ const { status, data } = await apiInstance.deleteDashboardWidget(
|
|
|
99
99
|
|
|
100
100
|
### Return type
|
|
101
101
|
|
|
102
|
-
**
|
|
102
|
+
**UpdateAnnouncementTranslation200Response**
|
|
103
103
|
|
|
104
104
|
### Authorization
|
|
105
105
|
|
package/docs/Event.md
CHANGED
|
@@ -79,6 +79,7 @@ Name | Type | Description | Notes
|
|
|
79
79
|
**continuousScanning** | **boolean** | | [default to undefined]
|
|
80
80
|
**scanType** | [**OnSiteScanType**](OnSiteScanType.md) | | [default to undefined]
|
|
81
81
|
**activationsDescription** | **string** | | [default to undefined]
|
|
82
|
+
**externalMeetingUrl** | **string** | | [default to undefined]
|
|
82
83
|
**_options** | **object** | | [default to undefined]
|
|
83
84
|
|
|
84
85
|
## Example
|
|
@@ -161,6 +162,7 @@ const instance: Event = {
|
|
|
161
162
|
continuousScanning,
|
|
162
163
|
scanType,
|
|
163
164
|
activationsDescription,
|
|
165
|
+
externalMeetingUrl,
|
|
164
166
|
_options,
|
|
165
167
|
};
|
|
166
168
|
```
|
|
@@ -18,6 +18,7 @@ Name | Type | Description | Notes
|
|
|
18
18
|
**longDescription** | **string** | | [optional] [default to undefined]
|
|
19
19
|
**reservationDescription** | **string** | | [optional] [default to undefined]
|
|
20
20
|
**externalUrl** | **string** | | [optional] [default to undefined]
|
|
21
|
+
**externalMeetingUrl** | **string** | | [optional] [default to undefined]
|
|
21
22
|
**imageId** | **string** | | [optional] [default to undefined]
|
|
22
23
|
**squareImageId** | **string** | | [optional] [default to undefined]
|
|
23
24
|
**backgroundImageId** | **string** | | [optional] [default to undefined]
|
|
@@ -84,6 +85,7 @@ const instance: EventCreateInputs = {
|
|
|
84
85
|
longDescription,
|
|
85
86
|
reservationDescription,
|
|
86
87
|
externalUrl,
|
|
88
|
+
externalMeetingUrl,
|
|
87
89
|
imageId,
|
|
88
90
|
squareImageId,
|
|
89
91
|
backgroundImageId,
|
|
@@ -18,6 +18,7 @@ Name | Type | Description | Notes
|
|
|
18
18
|
**eventStart** | **string** | | [optional] [default to undefined]
|
|
19
19
|
**eventEnd** | **string** | | [optional] [default to undefined]
|
|
20
20
|
**externalUrl** | **string** | | [optional] [default to undefined]
|
|
21
|
+
**externalMeetingUrl** | **string** | | [optional] [default to undefined]
|
|
21
22
|
**imageId** | **string** | | [optional] [default to undefined]
|
|
22
23
|
**squareImageId** | **string** | | [optional] [default to undefined]
|
|
23
24
|
**backgroundImageId** | **string** | | [optional] [default to undefined]
|
|
@@ -84,6 +85,7 @@ const instance: EventUpdateInputs = {
|
|
|
84
85
|
eventStart,
|
|
85
86
|
eventEnd,
|
|
86
87
|
externalUrl,
|
|
88
|
+
externalMeetingUrl,
|
|
87
89
|
imageId,
|
|
88
90
|
squareImageId,
|
|
89
91
|
backgroundImageId,
|
package/docs/EventsAccessApi.md
CHANGED
|
@@ -9,7 +9,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
9
9
|
|[**removeEventAccessUser**](#removeeventaccessuser) | **DELETE** /events/{eventId}/access-users/{userId} | Remove Event Access User|
|
|
10
10
|
|
|
11
11
|
# **addEventAccessUser**
|
|
12
|
-
>
|
|
12
|
+
> UpdateAnnouncementTranslation200Response addEventAccessUser()
|
|
13
13
|
|
|
14
14
|
Add Event Access User endpoint
|
|
15
15
|
|
|
@@ -43,7 +43,7 @@ const { status, data } = await apiInstance.addEventAccessUser(
|
|
|
43
43
|
|
|
44
44
|
### Return type
|
|
45
45
|
|
|
46
|
-
**
|
|
46
|
+
**UpdateAnnouncementTranslation200Response**
|
|
47
47
|
|
|
48
48
|
### Authorization
|
|
49
49
|
|
|
@@ -126,7 +126,7 @@ const { status, data } = await apiInstance.getEventAccessUsers(
|
|
|
126
126
|
[[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)
|
|
127
127
|
|
|
128
128
|
# **removeEventAccessUser**
|
|
129
|
-
>
|
|
129
|
+
> UpdateAnnouncementTranslation200Response removeEventAccessUser()
|
|
130
130
|
|
|
131
131
|
Remove Event Access User endpoint
|
|
132
132
|
|
|
@@ -160,7 +160,7 @@ const { status, data } = await apiInstance.removeEventAccessUser(
|
|
|
160
160
|
|
|
161
161
|
### Return type
|
|
162
162
|
|
|
163
|
-
**
|
|
163
|
+
**UpdateAnnouncementTranslation200Response**
|
|
164
164
|
|
|
165
165
|
### Authorization
|
|
166
166
|
|
|
@@ -0,0 +1,252 @@
|
|
|
1
|
+
# EventsActivationsTranslationsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://admin-api.connected.dev*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**deleteEventActivationTranslation**](#deleteeventactivationtranslation) | **DELETE** /events/{eventId}/activations/{activationId}/translations/{locale} | Delete Event Activation Translation|
|
|
8
|
+
|[**getEventActivationTranslation**](#geteventactivationtranslation) | **GET** /events/{eventId}/activations/{activationId}/translations/{locale} | Get Event Activation Translation|
|
|
9
|
+
|[**getEventActivationTranslations**](#geteventactivationtranslations) | **GET** /events/{eventId}/activations/{activationId}/translations | Get Event Activation Translations|
|
|
10
|
+
|[**updateEventActivationTranslation**](#updateeventactivationtranslation) | **PUT** /events/{eventId}/activations/{activationId}/translations/{locale} | Update Event Activation Translation|
|
|
11
|
+
|
|
12
|
+
# **deleteEventActivationTranslation**
|
|
13
|
+
> UpdateAnnouncementTranslation200Response deleteEventActivationTranslation()
|
|
14
|
+
|
|
15
|
+
Delete Event Activation Translation endpoint
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import {
|
|
21
|
+
EventsActivationsTranslationsApi,
|
|
22
|
+
Configuration
|
|
23
|
+
} from '@connectedxm/admin-sdk';
|
|
24
|
+
|
|
25
|
+
const configuration = new Configuration();
|
|
26
|
+
const apiInstance = new EventsActivationsTranslationsApi(configuration);
|
|
27
|
+
|
|
28
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
29
|
+
let activationId: string; //The activation identifier (default to undefined)
|
|
30
|
+
let locale: string; //The locale identifier (default to undefined)
|
|
31
|
+
|
|
32
|
+
const { status, data } = await apiInstance.deleteEventActivationTranslation(
|
|
33
|
+
eventId,
|
|
34
|
+
activationId,
|
|
35
|
+
locale
|
|
36
|
+
);
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### Parameters
|
|
40
|
+
|
|
41
|
+
|Name | Type | Description | Notes|
|
|
42
|
+
|------------- | ------------- | ------------- | -------------|
|
|
43
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
44
|
+
| **activationId** | [**string**] | The activation 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
|
+
# **getEventActivationTranslation**
|
|
70
|
+
> GetEventActivationTranslation200Response getEventActivationTranslation()
|
|
71
|
+
|
|
72
|
+
Get Event Activation Translation endpoint
|
|
73
|
+
|
|
74
|
+
### Example
|
|
75
|
+
|
|
76
|
+
```typescript
|
|
77
|
+
import {
|
|
78
|
+
EventsActivationsTranslationsApi,
|
|
79
|
+
Configuration
|
|
80
|
+
} from '@connectedxm/admin-sdk';
|
|
81
|
+
|
|
82
|
+
const configuration = new Configuration();
|
|
83
|
+
const apiInstance = new EventsActivationsTranslationsApi(configuration);
|
|
84
|
+
|
|
85
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
86
|
+
let activationId: string; //The activation identifier (default to undefined)
|
|
87
|
+
let locale: string; //The locale identifier (default to undefined)
|
|
88
|
+
|
|
89
|
+
const { status, data } = await apiInstance.getEventActivationTranslation(
|
|
90
|
+
eventId,
|
|
91
|
+
activationId,
|
|
92
|
+
locale
|
|
93
|
+
);
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Parameters
|
|
97
|
+
|
|
98
|
+
|Name | Type | Description | Notes|
|
|
99
|
+
|------------- | ------------- | ------------- | -------------|
|
|
100
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
101
|
+
| **activationId** | [**string**] | The activation identifier | defaults to undefined|
|
|
102
|
+
| **locale** | [**string**] | The locale identifier | defaults to undefined|
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
### Return type
|
|
106
|
+
|
|
107
|
+
**GetEventActivationTranslation200Response**
|
|
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
|
+
# **getEventActivationTranslations**
|
|
127
|
+
> GetEventActivationTranslations200Response getEventActivationTranslations()
|
|
128
|
+
|
|
129
|
+
Get Event Activation Translations endpoint
|
|
130
|
+
|
|
131
|
+
### Example
|
|
132
|
+
|
|
133
|
+
```typescript
|
|
134
|
+
import {
|
|
135
|
+
EventsActivationsTranslationsApi,
|
|
136
|
+
Configuration
|
|
137
|
+
} from '@connectedxm/admin-sdk';
|
|
138
|
+
|
|
139
|
+
const configuration = new Configuration();
|
|
140
|
+
const apiInstance = new EventsActivationsTranslationsApi(configuration);
|
|
141
|
+
|
|
142
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
143
|
+
let activationId: string; //The activation 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.getEventActivationTranslations(
|
|
150
|
+
eventId,
|
|
151
|
+
activationId,
|
|
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
|
+
| **activationId** | [**string**] | The activation 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
|
+
**GetEventActivationTranslations200Response**
|
|
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
|
+
# **updateEventActivationTranslation**
|
|
193
|
+
> UpdateEventActivationTranslation200Response updateEventActivationTranslation(eventActivationTranslationUpdateInputs)
|
|
194
|
+
|
|
195
|
+
Update Event Activation Translation endpoint
|
|
196
|
+
|
|
197
|
+
### Example
|
|
198
|
+
|
|
199
|
+
```typescript
|
|
200
|
+
import {
|
|
201
|
+
EventsActivationsTranslationsApi,
|
|
202
|
+
Configuration,
|
|
203
|
+
EventActivationTranslationUpdateInputs
|
|
204
|
+
} from '@connectedxm/admin-sdk';
|
|
205
|
+
|
|
206
|
+
const configuration = new Configuration();
|
|
207
|
+
const apiInstance = new EventsActivationsTranslationsApi(configuration);
|
|
208
|
+
|
|
209
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
210
|
+
let activationId: string; //The activation identifier (default to undefined)
|
|
211
|
+
let locale: string; //The locale identifier (default to undefined)
|
|
212
|
+
let eventActivationTranslationUpdateInputs: EventActivationTranslationUpdateInputs; //
|
|
213
|
+
|
|
214
|
+
const { status, data } = await apiInstance.updateEventActivationTranslation(
|
|
215
|
+
eventId,
|
|
216
|
+
activationId,
|
|
217
|
+
locale,
|
|
218
|
+
eventActivationTranslationUpdateInputs
|
|
219
|
+
);
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
### Parameters
|
|
223
|
+
|
|
224
|
+
|Name | Type | Description | Notes|
|
|
225
|
+
|------------- | ------------- | ------------- | -------------|
|
|
226
|
+
| **eventActivationTranslationUpdateInputs** | **EventActivationTranslationUpdateInputs**| | |
|
|
227
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
228
|
+
| **activationId** | [**string**] | The activation identifier | defaults to undefined|
|
|
229
|
+
| **locale** | [**string**] | The locale identifier | defaults to undefined|
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
### Return type
|
|
233
|
+
|
|
234
|
+
**UpdateEventActivationTranslation200Response**
|
|
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
|
+
# EventsAddonsTranslationsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://admin-api.connected.dev*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**deleteEventAddOnTranslation**](#deleteeventaddontranslation) | **DELETE** /events/{eventId}/addOns/{addOnId}/translations/{locale} | Delete Event Add On Translation|
|
|
8
|
+
|[**getEventAddOnTranslation**](#geteventaddontranslation) | **GET** /events/{eventId}/addOns/{addOnId}/translations/{locale} | Get Event Add On Translation|
|
|
9
|
+
|[**getEventAddOnTranslations**](#geteventaddontranslations) | **GET** /events/{eventId}/addOns/{addOnId}/translations | Get Event Add On Translations|
|
|
10
|
+
|[**updateEventAddOnTranslation**](#updateeventaddontranslation) | **PUT** /events/{eventId}/addOns/{addOnId}/translations/{locale} | Update Event Add On Translation|
|
|
11
|
+
|
|
12
|
+
# **deleteEventAddOnTranslation**
|
|
13
|
+
> UpdateAnnouncementTranslation200Response deleteEventAddOnTranslation()
|
|
14
|
+
|
|
15
|
+
Delete Event Add On Translation endpoint
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import {
|
|
21
|
+
EventsAddonsTranslationsApi,
|
|
22
|
+
Configuration
|
|
23
|
+
} from '@connectedxm/admin-sdk';
|
|
24
|
+
|
|
25
|
+
const configuration = new Configuration();
|
|
26
|
+
const apiInstance = new EventsAddonsTranslationsApi(configuration);
|
|
27
|
+
|
|
28
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
29
|
+
let addOnId: string; //The addOn identifier (default to undefined)
|
|
30
|
+
let locale: string; //The locale identifier (default to undefined)
|
|
31
|
+
|
|
32
|
+
const { status, data } = await apiInstance.deleteEventAddOnTranslation(
|
|
33
|
+
eventId,
|
|
34
|
+
addOnId,
|
|
35
|
+
locale
|
|
36
|
+
);
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### Parameters
|
|
40
|
+
|
|
41
|
+
|Name | Type | Description | Notes|
|
|
42
|
+
|------------- | ------------- | ------------- | -------------|
|
|
43
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
44
|
+
| **addOnId** | [**string**] | The addOn 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
|
+
# **getEventAddOnTranslation**
|
|
70
|
+
> GetEventAddOnTranslation200Response getEventAddOnTranslation()
|
|
71
|
+
|
|
72
|
+
Get Event Add On Translation endpoint
|
|
73
|
+
|
|
74
|
+
### Example
|
|
75
|
+
|
|
76
|
+
```typescript
|
|
77
|
+
import {
|
|
78
|
+
EventsAddonsTranslationsApi,
|
|
79
|
+
Configuration
|
|
80
|
+
} from '@connectedxm/admin-sdk';
|
|
81
|
+
|
|
82
|
+
const configuration = new Configuration();
|
|
83
|
+
const apiInstance = new EventsAddonsTranslationsApi(configuration);
|
|
84
|
+
|
|
85
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
86
|
+
let addOnId: string; //The addOn identifier (default to undefined)
|
|
87
|
+
let locale: string; //The locale identifier (default to undefined)
|
|
88
|
+
|
|
89
|
+
const { status, data } = await apiInstance.getEventAddOnTranslation(
|
|
90
|
+
eventId,
|
|
91
|
+
addOnId,
|
|
92
|
+
locale
|
|
93
|
+
);
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Parameters
|
|
97
|
+
|
|
98
|
+
|Name | Type | Description | Notes|
|
|
99
|
+
|------------- | ------------- | ------------- | -------------|
|
|
100
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
101
|
+
| **addOnId** | [**string**] | The addOn identifier | defaults to undefined|
|
|
102
|
+
| **locale** | [**string**] | The locale identifier | defaults to undefined|
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
### Return type
|
|
106
|
+
|
|
107
|
+
**GetEventAddOnTranslation200Response**
|
|
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
|
+
# **getEventAddOnTranslations**
|
|
127
|
+
> GetEventAddOnTranslations200Response getEventAddOnTranslations()
|
|
128
|
+
|
|
129
|
+
Get Event Add On Translations endpoint
|
|
130
|
+
|
|
131
|
+
### Example
|
|
132
|
+
|
|
133
|
+
```typescript
|
|
134
|
+
import {
|
|
135
|
+
EventsAddonsTranslationsApi,
|
|
136
|
+
Configuration
|
|
137
|
+
} from '@connectedxm/admin-sdk';
|
|
138
|
+
|
|
139
|
+
const configuration = new Configuration();
|
|
140
|
+
const apiInstance = new EventsAddonsTranslationsApi(configuration);
|
|
141
|
+
|
|
142
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
143
|
+
let addOnId: string; //The addOn 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.getEventAddOnTranslations(
|
|
150
|
+
eventId,
|
|
151
|
+
addOnId,
|
|
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
|
+
| **addOnId** | [**string**] | The addOn 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
|
+
**GetEventAddOnTranslations200Response**
|
|
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
|
+
# **updateEventAddOnTranslation**
|
|
193
|
+
> UpdateEventAddOnTranslation200Response updateEventAddOnTranslation(eventAddOnTranslationUpdateInputs)
|
|
194
|
+
|
|
195
|
+
Update Event Add On Translation endpoint
|
|
196
|
+
|
|
197
|
+
### Example
|
|
198
|
+
|
|
199
|
+
```typescript
|
|
200
|
+
import {
|
|
201
|
+
EventsAddonsTranslationsApi,
|
|
202
|
+
Configuration,
|
|
203
|
+
EventAddOnTranslationUpdateInputs
|
|
204
|
+
} from '@connectedxm/admin-sdk';
|
|
205
|
+
|
|
206
|
+
const configuration = new Configuration();
|
|
207
|
+
const apiInstance = new EventsAddonsTranslationsApi(configuration);
|
|
208
|
+
|
|
209
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
210
|
+
let addOnId: string; //The addOn identifier (default to undefined)
|
|
211
|
+
let locale: string; //The locale identifier (default to undefined)
|
|
212
|
+
let eventAddOnTranslationUpdateInputs: EventAddOnTranslationUpdateInputs; //
|
|
213
|
+
|
|
214
|
+
const { status, data } = await apiInstance.updateEventAddOnTranslation(
|
|
215
|
+
eventId,
|
|
216
|
+
addOnId,
|
|
217
|
+
locale,
|
|
218
|
+
eventAddOnTranslationUpdateInputs
|
|
219
|
+
);
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
### Parameters
|
|
223
|
+
|
|
224
|
+
|Name | Type | Description | Notes|
|
|
225
|
+
|------------- | ------------- | ------------- | -------------|
|
|
226
|
+
| **eventAddOnTranslationUpdateInputs** | **EventAddOnTranslationUpdateInputs**| | |
|
|
227
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
228
|
+
| **addOnId** | [**string**] | The addOn identifier | defaults to undefined|
|
|
229
|
+
| **locale** | [**string**] | The locale identifier | defaults to undefined|
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
### Return type
|
|
233
|
+
|
|
234
|
+
**UpdateEventAddOnTranslation200Response**
|
|
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
|
+
|
package/docs/EventsApi.md
CHANGED
|
@@ -16,7 +16,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
16
16
|
|[**updateEvent**](#updateevent) | **PUT** /events/{eventId} | Update Event|
|
|
17
17
|
|
|
18
18
|
# **cloneEvent**
|
|
19
|
-
>
|
|
19
|
+
> UpdateAnnouncementTranslation200Response cloneEvent(cloneOptions)
|
|
20
20
|
|
|
21
21
|
Clone Event endpoint
|
|
22
22
|
|
|
@@ -51,7 +51,7 @@ const { status, data } = await apiInstance.cloneEvent(
|
|
|
51
51
|
|
|
52
52
|
### Return type
|
|
53
53
|
|
|
54
|
-
**
|
|
54
|
+
**UpdateAnnouncementTranslation200Response**
|
|
55
55
|
|
|
56
56
|
### Authorization
|
|
57
57
|
|
|
@@ -69,7 +69,7 @@ const { status, data } = await apiInstance.createEventAttendeePackage(
|
|
|
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
|
# **deleteEventAttendeePackage**
|
|
72
|
-
>
|
|
72
|
+
> UpdateAnnouncementTranslation200Response deleteEventAttendeePackage()
|
|
73
73
|
|
|
74
74
|
Delete Event Attendee Package endpoint
|
|
75
75
|
|
|
@@ -106,7 +106,7 @@ const { status, data } = await apiInstance.deleteEventAttendeePackage(
|
|
|
106
106
|
|
|
107
107
|
### Return type
|
|
108
108
|
|
|
109
|
-
**
|
|
109
|
+
**UpdateAnnouncementTranslation200Response**
|
|
110
110
|
|
|
111
111
|
### Authorization
|
|
112
112
|
|