@connectedxm/admin-sdk 6.14.5 → 6.18.1

package/docs/EventsQuestionsTranslationsApi.md

@@ -0,0 +1,509 @@
+# EventsQuestionsTranslationsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteEventQuestionChoiceTranslation**](#deleteeventquestionchoicetranslation) | **DELETE** /events/{eventId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Delete Event Question Choice Translation|
+|[**deleteEventQuestionTranslation**](#deleteeventquestiontranslation) | **DELETE** /events/{eventId}/questions/{questionId}/translations/{locale} | Delete Event Question Translation|
+|[**getEventQuestionChoiceTranslation**](#geteventquestionchoicetranslation) | **GET** /events/{eventId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Get Event Question Choice Translation|
+|[**getEventQuestionChoiceTranslations**](#geteventquestionchoicetranslations) | **GET** /events/{eventId}/questions/{questionId}/choices/{choiceId}/translations | Get Event Question Choice Translations|
+|[**getEventQuestionTranslation**](#geteventquestiontranslation) | **GET** /events/{eventId}/questions/{questionId}/translations/{locale} | Get Event Question Translation|
+|[**getEventQuestionTranslations**](#geteventquestiontranslations) | **GET** /events/{eventId}/questions/{questionId}/translations | Get Event Question Translations|
+|[**updateEventQuestionChoiceTranslation**](#updateeventquestionchoicetranslation) | **PUT** /events/{eventId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Update Event Question Choice Translation|
+|[**updateEventQuestionTranslation**](#updateeventquestiontranslation) | **PUT** /events/{eventId}/questions/{questionId}/translations/{locale} | Update Event Question Translation|
+
+# **deleteEventQuestionChoiceTranslation**
+> UpdateAnnouncementTranslation200Response deleteEventQuestionChoiceTranslation()
+
+Delete Event Question Choice Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsQuestionsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsQuestionsTranslationsApi(configuration);
+
+let eventId: string; //The event 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.deleteEventQuestionChoiceTranslation(
+    eventId,
+    questionId,
+    choiceId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event 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)
+
+# **deleteEventQuestionTranslation**
+> UpdateAnnouncementTranslation200Response deleteEventQuestionTranslation()
+
+Delete Event Question Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsQuestionsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsQuestionsTranslationsApi(configuration);
+
+let eventId: string; //The event 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.deleteEventQuestionTranslation(
+    eventId,
+    questionId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event 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)
+
+# **getEventQuestionChoiceTranslation**
+> GetEventQuestionChoiceTranslation200Response getEventQuestionChoiceTranslation()
+
+Get Event Question Choice Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsQuestionsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsQuestionsTranslationsApi(configuration);
+
+let eventId: string; //The event 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.getEventQuestionChoiceTranslation(
+    eventId,
+    questionId,
+    choiceId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event 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
+
+**GetEventQuestionChoiceTranslation200Response**
+
+### 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)
+
+# **getEventQuestionChoiceTranslations**
+> GetEventQuestionChoiceTranslations200Response getEventQuestionChoiceTranslations()
+
+Get Event Question Choice Translations endpoint
+
+### Example
+
+```typescript
+import {
+    EventsQuestionsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsQuestionsTranslationsApi(configuration);
+
+let eventId: string; //The event 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.getEventQuestionChoiceTranslations(
+    eventId,
+    questionId,
+    choiceId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event 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
+
+**GetEventQuestionChoiceTranslations200Response**
+
+### 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)
+
+# **getEventQuestionTranslation**
+> GetEventQuestionTranslation200Response getEventQuestionTranslation()
+
+Get Event Question Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsQuestionsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsQuestionsTranslationsApi(configuration);
+
+let eventId: string; //The event 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.getEventQuestionTranslation(
+    eventId,
+    questionId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **questionId** | [**string**] | The question identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**GetEventQuestionTranslation200Response**
+
+### 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)
+
+# **getEventQuestionTranslations**
+> GetEventQuestionTranslations200Response getEventQuestionTranslations()
+
+Get Event Question Translations endpoint
+
+### Example
+
+```typescript
+import {
+    EventsQuestionsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsQuestionsTranslationsApi(configuration);
+
+let eventId: string; //The event 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.getEventQuestionTranslations(
+    eventId,
+    questionId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event 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
+
+**GetEventQuestionTranslations200Response**
+
+### 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)
+
+# **updateEventQuestionChoiceTranslation**
+> UpdateAnnouncementTranslation200Response updateEventQuestionChoiceTranslation(eventQuestionChoiceTranslationUpdateInputs)
+
+Update Event Question Choice Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsQuestionsTranslationsApi,
+    Configuration,
+    EventQuestionChoiceTranslationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsQuestionsTranslationsApi(configuration);
+
+let eventId: string; //The event 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 eventQuestionChoiceTranslationUpdateInputs: EventQuestionChoiceTranslationUpdateInputs; //
+
+const { status, data } = await apiInstance.updateEventQuestionChoiceTranslation(
+    eventId,
+    questionId,
+    choiceId,
+    locale,
+    eventQuestionChoiceTranslationUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventQuestionChoiceTranslationUpdateInputs** | **EventQuestionChoiceTranslationUpdateInputs**|  | |
+| **eventId** | [**string**] | The event 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)
+
+# **updateEventQuestionTranslation**
+> UpdateAnnouncementTranslation200Response updateEventQuestionTranslation(eventQuestionTranslationUpdateInputs)
+
+Update Event Question Translation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsQuestionsTranslationsApi,
+    Configuration,
+    EventQuestionTranslationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsQuestionsTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let questionId: string; //The question identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+let eventQuestionTranslationUpdateInputs: EventQuestionTranslationUpdateInputs; //
+
+const { status, data } = await apiInstance.updateEventQuestionTranslation(
+    eventId,
+    questionId,
+    locale,
+    eventQuestionTranslationUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventQuestionTranslationUpdateInputs** | **EventQuestionTranslationUpdateInputs**|  | |
+| **eventId** | [**string**] | The event 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)
+