@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
|
@@ -0,0 +1,252 @@
|
|
|
1
|
+
# SurveysSectionsTranslationsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://admin-api.connected.dev*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**deleteSurveySectionTranslation**](#deletesurveysectiontranslation) | **DELETE** /surveys/{surveyId}/sections/{sectionId}/translations/{locale} | Delete Survey Section Translation|
|
|
8
|
+
|[**getSurveySectionTranslation**](#getsurveysectiontranslation) | **GET** /surveys/{surveyId}/sections/{sectionId}/translations/{locale} | Get Survey Section Translation|
|
|
9
|
+
|[**getSurveySectionTranslations**](#getsurveysectiontranslations) | **GET** /surveys/{surveyId}/sections/{sectionId}/translations | Get Survey Section Translations|
|
|
10
|
+
|[**updateSurveySectionTranslation**](#updatesurveysectiontranslation) | **PUT** /surveys/{surveyId}/sections/{sectionId}/translations/{locale} | Update Survey Section Translation|
|
|
11
|
+
|
|
12
|
+
# **deleteSurveySectionTranslation**
|
|
13
|
+
> UpdateAnnouncementTranslation200Response deleteSurveySectionTranslation()
|
|
14
|
+
|
|
15
|
+
Delete Survey Section Translation endpoint
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import {
|
|
21
|
+
SurveysSectionsTranslationsApi,
|
|
22
|
+
Configuration
|
|
23
|
+
} from '@connectedxm/admin-sdk';
|
|
24
|
+
|
|
25
|
+
const configuration = new Configuration();
|
|
26
|
+
const apiInstance = new SurveysSectionsTranslationsApi(configuration);
|
|
27
|
+
|
|
28
|
+
let surveyId: string; //The survey identifier (default to undefined)
|
|
29
|
+
let sectionId: string; //The section identifier (default to undefined)
|
|
30
|
+
let locale: string; //The locale identifier (default to undefined)
|
|
31
|
+
|
|
32
|
+
const { status, data } = await apiInstance.deleteSurveySectionTranslation(
|
|
33
|
+
surveyId,
|
|
34
|
+
sectionId,
|
|
35
|
+
locale
|
|
36
|
+
);
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### Parameters
|
|
40
|
+
|
|
41
|
+
|Name | Type | Description | Notes|
|
|
42
|
+
|------------- | ------------- | ------------- | -------------|
|
|
43
|
+
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
|
|
44
|
+
| **sectionId** | [**string**] | The section 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
|
+
# **getSurveySectionTranslation**
|
|
70
|
+
> GetSurveySectionTranslation200Response getSurveySectionTranslation()
|
|
71
|
+
|
|
72
|
+
Get Survey Section Translation endpoint
|
|
73
|
+
|
|
74
|
+
### Example
|
|
75
|
+
|
|
76
|
+
```typescript
|
|
77
|
+
import {
|
|
78
|
+
SurveysSectionsTranslationsApi,
|
|
79
|
+
Configuration
|
|
80
|
+
} from '@connectedxm/admin-sdk';
|
|
81
|
+
|
|
82
|
+
const configuration = new Configuration();
|
|
83
|
+
const apiInstance = new SurveysSectionsTranslationsApi(configuration);
|
|
84
|
+
|
|
85
|
+
let surveyId: string; //The survey identifier (default to undefined)
|
|
86
|
+
let sectionId: string; //The section identifier (default to undefined)
|
|
87
|
+
let locale: string; //The locale identifier (default to undefined)
|
|
88
|
+
|
|
89
|
+
const { status, data } = await apiInstance.getSurveySectionTranslation(
|
|
90
|
+
surveyId,
|
|
91
|
+
sectionId,
|
|
92
|
+
locale
|
|
93
|
+
);
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Parameters
|
|
97
|
+
|
|
98
|
+
|Name | Type | Description | Notes|
|
|
99
|
+
|------------- | ------------- | ------------- | -------------|
|
|
100
|
+
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
|
|
101
|
+
| **sectionId** | [**string**] | The section identifier | defaults to undefined|
|
|
102
|
+
| **locale** | [**string**] | The locale identifier | defaults to undefined|
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
### Return type
|
|
106
|
+
|
|
107
|
+
**GetSurveySectionTranslation200Response**
|
|
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
|
+
# **getSurveySectionTranslations**
|
|
127
|
+
> GetSurveySectionTranslations200Response getSurveySectionTranslations()
|
|
128
|
+
|
|
129
|
+
Get Survey Section Translations endpoint
|
|
130
|
+
|
|
131
|
+
### Example
|
|
132
|
+
|
|
133
|
+
```typescript
|
|
134
|
+
import {
|
|
135
|
+
SurveysSectionsTranslationsApi,
|
|
136
|
+
Configuration
|
|
137
|
+
} from '@connectedxm/admin-sdk';
|
|
138
|
+
|
|
139
|
+
const configuration = new Configuration();
|
|
140
|
+
const apiInstance = new SurveysSectionsTranslationsApi(configuration);
|
|
141
|
+
|
|
142
|
+
let surveyId: string; //The survey identifier (default to undefined)
|
|
143
|
+
let sectionId: string; //The section 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.getSurveySectionTranslations(
|
|
150
|
+
surveyId,
|
|
151
|
+
sectionId,
|
|
152
|
+
page,
|
|
153
|
+
pageSize,
|
|
154
|
+
orderBy,
|
|
155
|
+
search
|
|
156
|
+
);
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
### Parameters
|
|
160
|
+
|
|
161
|
+
|Name | Type | Description | Notes|
|
|
162
|
+
|------------- | ------------- | ------------- | -------------|
|
|
163
|
+
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
|
|
164
|
+
| **sectionId** | [**string**] | The section 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
|
+
**GetSurveySectionTranslations200Response**
|
|
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
|
+
# **updateSurveySectionTranslation**
|
|
193
|
+
> UpdateAnnouncementTranslation200Response updateSurveySectionTranslation(surveySectionTranslationUpdateInputs)
|
|
194
|
+
|
|
195
|
+
Update Survey Section Translation endpoint
|
|
196
|
+
|
|
197
|
+
### Example
|
|
198
|
+
|
|
199
|
+
```typescript
|
|
200
|
+
import {
|
|
201
|
+
SurveysSectionsTranslationsApi,
|
|
202
|
+
Configuration,
|
|
203
|
+
SurveySectionTranslationUpdateInputs
|
|
204
|
+
} from '@connectedxm/admin-sdk';
|
|
205
|
+
|
|
206
|
+
const configuration = new Configuration();
|
|
207
|
+
const apiInstance = new SurveysSectionsTranslationsApi(configuration);
|
|
208
|
+
|
|
209
|
+
let surveyId: string; //The survey identifier (default to undefined)
|
|
210
|
+
let sectionId: string; //The section identifier (default to undefined)
|
|
211
|
+
let locale: string; //The locale identifier (default to undefined)
|
|
212
|
+
let surveySectionTranslationUpdateInputs: SurveySectionTranslationUpdateInputs; //
|
|
213
|
+
|
|
214
|
+
const { status, data } = await apiInstance.updateSurveySectionTranslation(
|
|
215
|
+
surveyId,
|
|
216
|
+
sectionId,
|
|
217
|
+
locale,
|
|
218
|
+
surveySectionTranslationUpdateInputs
|
|
219
|
+
);
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
### Parameters
|
|
223
|
+
|
|
224
|
+
|Name | Type | Description | Notes|
|
|
225
|
+
|------------- | ------------- | ------------- | -------------|
|
|
226
|
+
| **surveySectionTranslationUpdateInputs** | **SurveySectionTranslationUpdateInputs**| | |
|
|
227
|
+
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
|
|
228
|
+
| **sectionId** | [**string**] | The section 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
|
+
|
|
@@ -272,6 +272,7 @@ const configuration = new Configuration();
|
|
|
272
272
|
const apiInstance = new SurveysSubmissionsApi(configuration);
|
|
273
273
|
|
|
274
274
|
let surveyId: string; //The survey identifier (default to undefined)
|
|
275
|
+
let status: PurchaseStatus; //Filter by status (optional) (default to undefined)
|
|
275
276
|
let page: number; //Page number (optional) (default to 1)
|
|
276
277
|
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
277
278
|
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
@@ -279,6 +280,7 @@ let search: string; //Search query (optional) (default to undefined)
|
|
|
279
280
|
|
|
280
281
|
const { status, data } = await apiInstance.getSurveySubmissions(
|
|
281
282
|
surveyId,
|
|
283
|
+
status,
|
|
282
284
|
page,
|
|
283
285
|
pageSize,
|
|
284
286
|
orderBy,
|
|
@@ -291,6 +293,7 @@ const { status, data } = await apiInstance.getSurveySubmissions(
|
|
|
291
293
|
|Name | Type | Description | Notes|
|
|
292
294
|
|------------- | ------------- | ------------- | -------------|
|
|
293
295
|
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
|
|
296
|
+
| **status** | **PurchaseStatus** | Filter by status | (optional) defaults to undefined|
|
|
294
297
|
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
295
298
|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
296
299
|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
@@ -0,0 +1,240 @@
|
|
|
1
|
+
# SurveysTranslationsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://admin-api.connected.dev*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**deleteSurveyTranslation**](#deletesurveytranslation) | **DELETE** /surveys/{surveyId}/translations/{locale} | Delete Survey Translation|
|
|
8
|
+
|[**getSurveyTranslation**](#getsurveytranslation) | **GET** /surveys/{surveyId}/translations/{locale} | Get Survey Translation|
|
|
9
|
+
|[**getSurveyTranslations**](#getsurveytranslations) | **GET** /surveys/{surveyId}/translations | Get Survey Translations|
|
|
10
|
+
|[**updateSurveyTranslation**](#updatesurveytranslation) | **PUT** /surveys/{surveyId}/translations/{locale} | Update Survey Translation|
|
|
11
|
+
|
|
12
|
+
# **deleteSurveyTranslation**
|
|
13
|
+
> UpdateAnnouncementTranslation200Response deleteSurveyTranslation()
|
|
14
|
+
|
|
15
|
+
Delete Survey Translation endpoint
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import {
|
|
21
|
+
SurveysTranslationsApi,
|
|
22
|
+
Configuration
|
|
23
|
+
} from '@connectedxm/admin-sdk';
|
|
24
|
+
|
|
25
|
+
const configuration = new Configuration();
|
|
26
|
+
const apiInstance = new SurveysTranslationsApi(configuration);
|
|
27
|
+
|
|
28
|
+
let surveyId: string; //The survey identifier (default to undefined)
|
|
29
|
+
let locale: string; //The locale identifier (default to undefined)
|
|
30
|
+
|
|
31
|
+
const { status, data } = await apiInstance.deleteSurveyTranslation(
|
|
32
|
+
surveyId,
|
|
33
|
+
locale
|
|
34
|
+
);
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Parameters
|
|
38
|
+
|
|
39
|
+
|Name | Type | Description | Notes|
|
|
40
|
+
|------------- | ------------- | ------------- | -------------|
|
|
41
|
+
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
|
|
42
|
+
| **locale** | [**string**] | The locale identifier | defaults to undefined|
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
### Return type
|
|
46
|
+
|
|
47
|
+
**UpdateAnnouncementTranslation200Response**
|
|
48
|
+
|
|
49
|
+
### Authorization
|
|
50
|
+
|
|
51
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
52
|
+
|
|
53
|
+
### HTTP request headers
|
|
54
|
+
|
|
55
|
+
- **Content-Type**: Not defined
|
|
56
|
+
- **Accept**: application/json
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
### HTTP response details
|
|
60
|
+
| Status code | Description | Response headers |
|
|
61
|
+
|-------------|-------------|------------------|
|
|
62
|
+
|**200** | Successful response | - |
|
|
63
|
+
|
|
64
|
+
[[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)
|
|
65
|
+
|
|
66
|
+
# **getSurveyTranslation**
|
|
67
|
+
> GetSurveyTranslation200Response getSurveyTranslation()
|
|
68
|
+
|
|
69
|
+
Get Survey Translation endpoint
|
|
70
|
+
|
|
71
|
+
### Example
|
|
72
|
+
|
|
73
|
+
```typescript
|
|
74
|
+
import {
|
|
75
|
+
SurveysTranslationsApi,
|
|
76
|
+
Configuration
|
|
77
|
+
} from '@connectedxm/admin-sdk';
|
|
78
|
+
|
|
79
|
+
const configuration = new Configuration();
|
|
80
|
+
const apiInstance = new SurveysTranslationsApi(configuration);
|
|
81
|
+
|
|
82
|
+
let surveyId: string; //The survey identifier (default to undefined)
|
|
83
|
+
let locale: string; //The locale identifier (default to undefined)
|
|
84
|
+
|
|
85
|
+
const { status, data } = await apiInstance.getSurveyTranslation(
|
|
86
|
+
surveyId,
|
|
87
|
+
locale
|
|
88
|
+
);
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
### Parameters
|
|
92
|
+
|
|
93
|
+
|Name | Type | Description | Notes|
|
|
94
|
+
|------------- | ------------- | ------------- | -------------|
|
|
95
|
+
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
|
|
96
|
+
| **locale** | [**string**] | The locale identifier | defaults to undefined|
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
### Return type
|
|
100
|
+
|
|
101
|
+
**GetSurveyTranslation200Response**
|
|
102
|
+
|
|
103
|
+
### Authorization
|
|
104
|
+
|
|
105
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
106
|
+
|
|
107
|
+
### HTTP request headers
|
|
108
|
+
|
|
109
|
+
- **Content-Type**: Not defined
|
|
110
|
+
- **Accept**: application/json
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
### HTTP response details
|
|
114
|
+
| Status code | Description | Response headers |
|
|
115
|
+
|-------------|-------------|------------------|
|
|
116
|
+
|**200** | Successful response | - |
|
|
117
|
+
|
|
118
|
+
[[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)
|
|
119
|
+
|
|
120
|
+
# **getSurveyTranslations**
|
|
121
|
+
> GetSurveyTranslations200Response getSurveyTranslations()
|
|
122
|
+
|
|
123
|
+
Get Survey Translations endpoint
|
|
124
|
+
|
|
125
|
+
### Example
|
|
126
|
+
|
|
127
|
+
```typescript
|
|
128
|
+
import {
|
|
129
|
+
SurveysTranslationsApi,
|
|
130
|
+
Configuration
|
|
131
|
+
} from '@connectedxm/admin-sdk';
|
|
132
|
+
|
|
133
|
+
const configuration = new Configuration();
|
|
134
|
+
const apiInstance = new SurveysTranslationsApi(configuration);
|
|
135
|
+
|
|
136
|
+
let surveyId: string; //The survey identifier (default to undefined)
|
|
137
|
+
let page: number; //Page number (optional) (default to 1)
|
|
138
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
139
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
140
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
141
|
+
|
|
142
|
+
const { status, data } = await apiInstance.getSurveyTranslations(
|
|
143
|
+
surveyId,
|
|
144
|
+
page,
|
|
145
|
+
pageSize,
|
|
146
|
+
orderBy,
|
|
147
|
+
search
|
|
148
|
+
);
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
### Parameters
|
|
152
|
+
|
|
153
|
+
|Name | Type | Description | Notes|
|
|
154
|
+
|------------- | ------------- | ------------- | -------------|
|
|
155
|
+
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
|
|
156
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
157
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
158
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
159
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
### Return type
|
|
163
|
+
|
|
164
|
+
**GetSurveyTranslations200Response**
|
|
165
|
+
|
|
166
|
+
### Authorization
|
|
167
|
+
|
|
168
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
169
|
+
|
|
170
|
+
### HTTP request headers
|
|
171
|
+
|
|
172
|
+
- **Content-Type**: Not defined
|
|
173
|
+
- **Accept**: application/json
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
### HTTP response details
|
|
177
|
+
| Status code | Description | Response headers |
|
|
178
|
+
|-------------|-------------|------------------|
|
|
179
|
+
|**200** | Successful response | - |
|
|
180
|
+
|
|
181
|
+
[[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)
|
|
182
|
+
|
|
183
|
+
# **updateSurveyTranslation**
|
|
184
|
+
> UpdateAnnouncementTranslation200Response updateSurveyTranslation(surveyTranslationUpdateInputs)
|
|
185
|
+
|
|
186
|
+
Update Survey Translation endpoint
|
|
187
|
+
|
|
188
|
+
### Example
|
|
189
|
+
|
|
190
|
+
```typescript
|
|
191
|
+
import {
|
|
192
|
+
SurveysTranslationsApi,
|
|
193
|
+
Configuration,
|
|
194
|
+
SurveyTranslationUpdateInputs
|
|
195
|
+
} from '@connectedxm/admin-sdk';
|
|
196
|
+
|
|
197
|
+
const configuration = new Configuration();
|
|
198
|
+
const apiInstance = new SurveysTranslationsApi(configuration);
|
|
199
|
+
|
|
200
|
+
let surveyId: string; //The survey identifier (default to undefined)
|
|
201
|
+
let locale: string; //The locale identifier (default to undefined)
|
|
202
|
+
let surveyTranslationUpdateInputs: SurveyTranslationUpdateInputs; //
|
|
203
|
+
|
|
204
|
+
const { status, data } = await apiInstance.updateSurveyTranslation(
|
|
205
|
+
surveyId,
|
|
206
|
+
locale,
|
|
207
|
+
surveyTranslationUpdateInputs
|
|
208
|
+
);
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
### Parameters
|
|
212
|
+
|
|
213
|
+
|Name | Type | Description | Notes|
|
|
214
|
+
|------------- | ------------- | ------------- | -------------|
|
|
215
|
+
| **surveyTranslationUpdateInputs** | **SurveyTranslationUpdateInputs**| | |
|
|
216
|
+
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
|
|
217
|
+
| **locale** | [**string**] | The locale identifier | defaults to undefined|
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
### Return type
|
|
221
|
+
|
|
222
|
+
**UpdateAnnouncementTranslation200Response**
|
|
223
|
+
|
|
224
|
+
### Authorization
|
|
225
|
+
|
|
226
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
227
|
+
|
|
228
|
+
### HTTP request headers
|
|
229
|
+
|
|
230
|
+
- **Content-Type**: application/json
|
|
231
|
+
- **Accept**: application/json
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
### HTTP response details
|
|
235
|
+
| Status code | Description | Response headers |
|
|
236
|
+
|-------------|-------------|------------------|
|
|
237
|
+
|**200** | Successful response | - |
|
|
238
|
+
|
|
239
|
+
[[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)
|
|
240
|
+
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# UpdateAnnouncementTranslation200Response
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -12,9 +12,9 @@ Name | Type | Description | Notes
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
14
14
|
```typescript
|
|
15
|
-
import {
|
|
15
|
+
import { UpdateAnnouncementTranslation200Response } from '@connectedxm/admin-sdk';
|
|
16
16
|
|
|
17
|
-
const instance:
|
|
17
|
+
const instance: UpdateAnnouncementTranslation200Response = {
|
|
18
18
|
status,
|
|
19
19
|
message,
|
|
20
20
|
data,
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UpdateChannelContentGuestTranslation200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**ChannelContentGuestTranslation**](ChannelContentGuestTranslation.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { UpdateChannelContentGuestTranslation200Response } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: UpdateChannelContentGuestTranslation200Response = {
|
|
18
|
+
status,
|
|
19
|
+
message,
|
|
20
|
+
data,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UpdateChannelTranslation200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**ChannelTranslation**](ChannelTranslation.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { UpdateChannelTranslation200Response } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: UpdateChannelTranslation200Response = {
|
|
18
|
+
status,
|
|
19
|
+
message,
|
|
20
|
+
data,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UpdateEventActivationTranslation200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**ActivationTranslation**](ActivationTranslation.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { UpdateEventActivationTranslation200Response } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: UpdateEventActivationTranslation200Response = {
|
|
18
|
+
status,
|
|
19
|
+
message,
|
|
20
|
+
data,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UpdateEventAddOnTranslation200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**EventAddOnTranslation**](EventAddOnTranslation.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { UpdateEventAddOnTranslation200Response } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: UpdateEventAddOnTranslation200Response = {
|
|
18
|
+
status,
|
|
19
|
+
message,
|
|
20
|
+
data,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UpdateEventMediaItemTranslation200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**EventMediaItemTranslation**](EventMediaItemTranslation.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { UpdateEventMediaItemTranslation200Response } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: UpdateEventMediaItemTranslation200Response = {
|
|
18
|
+
status,
|
|
19
|
+
message,
|
|
20
|
+
data,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UpdateSeriesQuestionTranslation200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**SeriesQuestionTranslation**](SeriesQuestionTranslation.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { UpdateSeriesQuestionTranslation200Response } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: UpdateSeriesQuestionTranslation200Response = {
|
|
18
|
+
status,
|
|
19
|
+
message,
|
|
20
|
+
data,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|