@connectedxm/admin-sdk 6.17.4 → 6.20.0

package/docs/SurveysQuestionsTranslationsApi.md

@@ -0,0 +1,509 @@
+# SurveysQuestionsTranslationsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteSurveyQuestionChoiceTranslation**](#deletesurveyquestionchoicetranslation) | **DELETE** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Delete Survey Question Choice Translation|
+|[**deleteSurveyQuestionTranslation**](#deletesurveyquestiontranslation) | **DELETE** /surveys/{surveyId}/questions/{questionId}/translations/{locale} | Delete Survey Question Translation|
+|[**getSurveyQuestionChoiceTranslation**](#getsurveyquestionchoicetranslation) | **GET** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Get Survey Question Choice Translation|
+|[**getSurveyQuestionChoiceTranslations**](#getsurveyquestionchoicetranslations) | **GET** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/translations | Get Survey Question Choice Translations|
+|[**getSurveyQuestionTranslation**](#getsurveyquestiontranslation) | **GET** /surveys/{surveyId}/questions/{questionId}/translations/{locale} | Get Survey Question Translation|
+|[**getSurveyQuestionTranslations**](#getsurveyquestiontranslations) | **GET** /surveys/{surveyId}/questions/{questionId}/translations | Get Survey Question Translations|
+|[**updateSurveyQuestionChoiceTranslation**](#updatesurveyquestionchoicetranslation) | **PUT** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Update Survey Question Choice Translation|
+|[**updateSurveyQuestionTranslation**](#updatesurveyquestiontranslation) | **PUT** /surveys/{surveyId}/questions/{questionId}/translations/{locale} | Update Survey Question Translation|
+
+# **deleteSurveyQuestionChoiceTranslation**
+> UpdateAnnouncementTranslation200Response deleteSurveyQuestionChoiceTranslation()
+
+Delete Survey Question Choice Translation endpoint
+
+### Example
+
+```typescript
+import {
+    SurveysQuestionsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SurveysQuestionsTranslationsApi(configuration);
+
+let surveyId: string; //The survey 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.deleteSurveyQuestionChoiceTranslation(
+    surveyId,
+    questionId,
+    choiceId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **surveyId** | [**string**] | The survey 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)
+
+# **deleteSurveyQuestionTranslation**
+> UpdateAnnouncementTranslation200Response deleteSurveyQuestionTranslation()
+
+Delete Survey Question Translation endpoint
+
+### Example
+
+```typescript
+import {
+    SurveysQuestionsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SurveysQuestionsTranslationsApi(configuration);
+
+let surveyId: string; //The survey 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.deleteSurveyQuestionTranslation(
+    surveyId,
+    questionId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **surveyId** | [**string**] | The survey 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)
+
+# **getSurveyQuestionChoiceTranslation**
+> GetSurveyQuestionChoiceTranslation200Response getSurveyQuestionChoiceTranslation()
+
+Get Survey Question Choice Translation endpoint
+
+### Example
+
+```typescript
+import {
+    SurveysQuestionsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SurveysQuestionsTranslationsApi(configuration);
+
+let surveyId: string; //The survey 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.getSurveyQuestionChoiceTranslation(
+    surveyId,
+    questionId,
+    choiceId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **surveyId** | [**string**] | The survey 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
+
+**GetSurveyQuestionChoiceTranslation200Response**
+
+### 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)
+
+# **getSurveyQuestionChoiceTranslations**
+> GetSurveyQuestionChoiceTranslations200Response getSurveyQuestionChoiceTranslations()
+
+Get Survey Question Choice Translations endpoint
+
+### Example
+
+```typescript
+import {
+    SurveysQuestionsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SurveysQuestionsTranslationsApi(configuration);
+
+let surveyId: string; //The survey 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.getSurveyQuestionChoiceTranslations(
+    surveyId,
+    questionId,
+    choiceId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **surveyId** | [**string**] | The survey 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
+
+**GetSurveyQuestionChoiceTranslations200Response**
+
+### 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)
+
+# **getSurveyQuestionTranslation**
+> GetSurveyQuestionTranslation200Response getSurveyQuestionTranslation()
+
+Get Survey Question Translation endpoint
+
+### Example
+
+```typescript
+import {
+    SurveysQuestionsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SurveysQuestionsTranslationsApi(configuration);
+
+let surveyId: string; //The survey 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.getSurveyQuestionTranslation(
+    surveyId,
+    questionId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
+| **questionId** | [**string**] | The question identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**GetSurveyQuestionTranslation200Response**
+
+### 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)
+
+# **getSurveyQuestionTranslations**
+> GetSurveyQuestionTranslations200Response getSurveyQuestionTranslations()
+
+Get Survey Question Translations endpoint
+
+### Example
+
+```typescript
+import {
+    SurveysQuestionsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SurveysQuestionsTranslationsApi(configuration);
+
+let surveyId: string; //The survey 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.getSurveyQuestionTranslations(
+    surveyId,
+    questionId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **surveyId** | [**string**] | The survey 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
+
+**GetSurveyQuestionTranslations200Response**
+
+### 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)
+
+# **updateSurveyQuestionChoiceTranslation**
+> UpdateAnnouncementTranslation200Response updateSurveyQuestionChoiceTranslation(surveyQuestionChoiceTranslationUpdateInputs)
+
+Update Survey Question Choice Translation endpoint
+
+### Example
+
+```typescript
+import {
+    SurveysQuestionsTranslationsApi,
+    Configuration,
+    SurveyQuestionChoiceTranslationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SurveysQuestionsTranslationsApi(configuration);
+
+let surveyId: string; //The survey 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 surveyQuestionChoiceTranslationUpdateInputs: SurveyQuestionChoiceTranslationUpdateInputs; //
+
+const { status, data } = await apiInstance.updateSurveyQuestionChoiceTranslation(
+    surveyId,
+    questionId,
+    choiceId,
+    locale,
+    surveyQuestionChoiceTranslationUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **surveyQuestionChoiceTranslationUpdateInputs** | **SurveyQuestionChoiceTranslationUpdateInputs**|  | |
+| **surveyId** | [**string**] | The survey 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)
+
+# **updateSurveyQuestionTranslation**
+> UpdateAnnouncementTranslation200Response updateSurveyQuestionTranslation(surveyQuestionTranslationUpdateInputs)
+
+Update Survey Question Translation endpoint
+
+### Example
+
+```typescript
+import {
+    SurveysQuestionsTranslationsApi,
+    Configuration,
+    SurveyQuestionTranslationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SurveysQuestionsTranslationsApi(configuration);
+
+let surveyId: string; //The survey identifier (default to undefined)
+let questionId: string; //The question identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+let surveyQuestionTranslationUpdateInputs: SurveyQuestionTranslationUpdateInputs; //
+
+const { status, data } = await apiInstance.updateSurveyQuestionTranslation(
+    surveyId,
+    questionId,
+    locale,
+    surveyQuestionTranslationUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **surveyQuestionTranslationUpdateInputs** | **SurveyQuestionTranslationUpdateInputs**|  | |
+| **surveyId** | [**string**] | The survey 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)
+