@connectedxm/admin-sdk 6.17.4 → 6.20.0

package/docs/EventsSessionsQuestionsTranslationsApi.md

@@ -0,0 +1,533 @@
+# EventsSessionsQuestionsTranslationsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteEventSessionQuestionChoiceTranslation**](#deleteeventsessionquestionchoicetranslation) | **DELETE** /events/{eventId}/sessions/{sessionId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Delete Event Session Question Choice Translation|
+|[**deleteEventSessionQuestionTranslation**](#deleteeventsessionquestiontranslation) | **DELETE** /events/{eventId}/sessions/{sessionId}/questions/{questionId}/translations/{locale} | Delete Event Session Question Translation|
+|[**getEventSessionQuestionChoiceTranslation**](#geteventsessionquestionchoicetranslation) | **GET** /events/{eventId}/sessions/{sessionId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Get Event Session Question Choice Translation|
+|[**getEventSessionQuestionChoiceTranslations**](#geteventsessionquestionchoicetranslations) | **GET** /events/{eventId}/sessions/{sessionId}/questions/{questionId}/choices/{choiceId}/translations | Get Event Session Question Choice Translations|
+|[**getEventSessionQuestionTranslation**](#geteventsessionquestiontranslation) | **GET** /events/{eventId}/sessions/{sessionId}/questions/{questionId}/translations/{locale} | Get Event Session Question Translation|
+|[**getEventSessionQuestionTranslations**](#geteventsessionquestiontranslations) | **GET** /events/{eventId}/sessions/{sessionId}/questions/{questionId}/translations | Get Event Session Question Translations|
+|[**updateEventSessionQuestionChoiceTranslation**](#updateeventsessionquestionchoicetranslation) | **PUT** /events/{eventId}/sessions/{sessionId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Update Event Session Question Choice Translation|
+|[**updateEventSessionQuestionTranslation**](#updateeventsessionquestiontranslation) | **PUT** /events/{eventId}/sessions/{sessionId}/questions/{questionId}/translations/{locale} | Update Event Session Question Translation|
+
+# **deleteEventSessionQuestionChoiceTranslation**
+> UpdateAnnouncementTranslation200Response deleteEventSessionQuestionChoiceTranslation()
+
+Delete Event Session Question Choice Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsQuestionsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsQuestionsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+let questionId: string; //The question identifier (default to undefined)
+let choiceId: string; //The choice identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteEventSessionQuestionChoiceTranslation(
+    eventId,
+    sessionId,
+    questionId,
+    choiceId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+| **questionId** | [**string**] | The question identifier | defaults to undefined|
+| **choiceId** | [**string**] | The choice identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**UpdateAnnouncementTranslation200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[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)
+
+# **deleteEventSessionQuestionTranslation**
+> UpdateAnnouncementTranslation200Response deleteEventSessionQuestionTranslation()
+
+Delete Event Session Question Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsQuestionsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsQuestionsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+let questionId: string; //The question identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteEventSessionQuestionTranslation(
+    eventId,
+    sessionId,
+    questionId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+| **questionId** | [**string**] | The question identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**UpdateAnnouncementTranslation200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[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)
+
+# **getEventSessionQuestionChoiceTranslation**
+> GetEventSessionQuestionChoiceTranslation200Response getEventSessionQuestionChoiceTranslation()
+
+Get Event Session Question Choice Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsQuestionsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsQuestionsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+let questionId: string; //The question identifier (default to undefined)
+let choiceId: string; //The choice identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.getEventSessionQuestionChoiceTranslation(
+    eventId,
+    sessionId,
+    questionId,
+    choiceId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+| **questionId** | [**string**] | The question identifier | defaults to undefined|
+| **choiceId** | [**string**] | The choice identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**GetEventSessionQuestionChoiceTranslation200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[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)
+
+# **getEventSessionQuestionChoiceTranslations**
+> GetEventSessionQuestionChoiceTranslations200Response getEventSessionQuestionChoiceTranslations()
+
+Get Event Session Question Choice Translations endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsQuestionsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsQuestionsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+let questionId: string; //The question identifier (default to undefined)
+let choiceId: string; //The choice identifier (default to undefined)
+let page: number; //Page number (optional) (default to 1)
+let pageSize: number; //Number of items per page (optional) (default to 25)
+let orderBy: string; //Field to order by (optional) (default to undefined)
+let search: string; //Search query (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getEventSessionQuestionChoiceTranslations(
+    eventId,
+    sessionId,
+    questionId,
+    choiceId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+| **questionId** | [**string**] | The question identifier | defaults to undefined|
+| **choiceId** | [**string**] | The choice identifier | defaults to undefined|
+| **page** | [**number**] | Page number | (optional) defaults to 1|
+| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
+| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
+| **search** | [**string**] | Search query | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetEventSessionQuestionChoiceTranslations200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[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)
+
+# **getEventSessionQuestionTranslation**
+> GetEventSessionQuestionTranslation200Response getEventSessionQuestionTranslation()
+
+Get Event Session Question Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsQuestionsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsQuestionsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+let questionId: string; //The question identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.getEventSessionQuestionTranslation(
+    eventId,
+    sessionId,
+    questionId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+| **questionId** | [**string**] | The question identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**GetEventSessionQuestionTranslation200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[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)
+
+# **getEventSessionQuestionTranslations**
+> GetEventSessionQuestionTranslations200Response getEventSessionQuestionTranslations()
+
+Get Event Session Question Translations endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsQuestionsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsQuestionsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+let questionId: string; //The question identifier (default to undefined)
+let page: number; //Page number (optional) (default to 1)
+let pageSize: number; //Number of items per page (optional) (default to 25)
+let orderBy: string; //Field to order by (optional) (default to undefined)
+let search: string; //Search query (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getEventSessionQuestionTranslations(
+    eventId,
+    sessionId,
+    questionId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+| **questionId** | [**string**] | The question identifier | defaults to undefined|
+| **page** | [**number**] | Page number | (optional) defaults to 1|
+| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
+| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
+| **search** | [**string**] | Search query | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetEventSessionQuestionTranslations200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[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)
+
+# **updateEventSessionQuestionChoiceTranslation**
+> UpdateAnnouncementTranslation200Response updateEventSessionQuestionChoiceTranslation(eventSessionQuestionChoiceTranslationUpdateInputs)
+
+Update Event Session Question Choice Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsQuestionsTranslationsApi,
+    Configuration,
+    EventSessionQuestionChoiceTranslationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsQuestionsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+let questionId: string; //The question identifier (default to undefined)
+let choiceId: string; //The choice identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+let eventSessionQuestionChoiceTranslationUpdateInputs: EventSessionQuestionChoiceTranslationUpdateInputs; //
+
+const { status, data } = await apiInstance.updateEventSessionQuestionChoiceTranslation(
+    eventId,
+    sessionId,
+    questionId,
+    choiceId,
+    locale,
+    eventSessionQuestionChoiceTranslationUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventSessionQuestionChoiceTranslationUpdateInputs** | **EventSessionQuestionChoiceTranslationUpdateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+| **questionId** | [**string**] | The question identifier | defaults to undefined|
+| **choiceId** | [**string**] | The choice identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**UpdateAnnouncementTranslation200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[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)
+
+# **updateEventSessionQuestionTranslation**
+> UpdateAnnouncementTranslation200Response updateEventSessionQuestionTranslation(eventSessionQuestionTranslationUpdateInputs)
+
+Update Event Session Question Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsQuestionsTranslationsApi,
+    Configuration,
+    EventSessionQuestionTranslationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsQuestionsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+let questionId: string; //The question identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+let eventSessionQuestionTranslationUpdateInputs: EventSessionQuestionTranslationUpdateInputs; //
+
+const { status, data } = await apiInstance.updateEventSessionQuestionTranslation(
+    eventId,
+    sessionId,
+    questionId,
+    locale,
+    eventSessionQuestionTranslationUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventSessionQuestionTranslationUpdateInputs** | **EventSessionQuestionTranslationUpdateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+| **questionId** | [**string**] | The question identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**UpdateAnnouncementTranslation200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[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)
+