# 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 a survey question choice\'s translation|
|[**deleteSurveyQuestionTranslation**](#deletesurveyquestiontranslation) | **DELETE** /surveys/{surveyId}/questions/{questionId}/translations/{locale} | Delete a survey question\'s translation|
|[**getSurveyQuestionChoiceTranslation**](#getsurveyquestionchoicetranslation) | **GET** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Get a survey question choice\'s translation|
|[**getSurveyQuestionChoiceTranslations**](#getsurveyquestionchoicetranslations) | **GET** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/translations | List a survey question choice\'s translations|
|[**getSurveyQuestionTranslation**](#getsurveyquestiontranslation) | **GET** /surveys/{surveyId}/questions/{questionId}/translations/{locale} | Get a survey question\'s translation|
|[**getSurveyQuestionTranslations**](#getsurveyquestiontranslations) | **GET** /surveys/{surveyId}/questions/{questionId}/translations | List a survey question\'s translations|
|[**updateSurveyQuestionChoiceTranslation**](#updatesurveyquestionchoicetranslation) | **PUT** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/translations/{locale} | Update a survey question choice\'s translation|
|[**updateSurveyQuestionTranslation**](#updatesurveyquestiontranslation) | **PUT** /surveys/{surveyId}/questions/{questionId}/translations/{locale} | Update a survey question\'s translation|

# **deleteSurveyQuestionChoiceTranslation**
> SyncAccounts200Response deleteSurveyQuestionChoiceTranslation()

Removes the translated text for a specific locale on a survey question\'s answer choice; requires \"update\" permission on surveys.

### 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

**SyncAccounts200Response**

### 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**
> SyncAccounts200Response deleteSurveyQuestionTranslation()

Removes the translated text for a specific locale on a survey question; requires \"update\" permission on surveys.

### 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

**SyncAccounts200Response**

### 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()

Returns the translated text for a single survey question choice in the given locale, or null if no translation exists for that locale, requiring \"read\" permission on surveys.

### 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()

Returns a paginated list of locale translations for the given survey question choice, with optional search and ordering, requiring \"read\" permission on surveys.

### 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()

Returns the translated text for a single survey question in the given locale, or null if no translation exists for that locale, requiring \"read\" permission on surveys.

### 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()

Returns a paginated list of locale translations for a survey question, supporting search and ordering; requires read access to the surveys module.

### 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**
> SyncAccounts200Response updateSurveyQuestionChoiceTranslation(surveyQuestionChoiceTranslationUpdateInputs)

Creates or updates the translated text for a specific locale on a survey question\'s answer choice; requires \"update\" permission on surveys.

### 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

**SyncAccounts200Response**

### 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**
> SyncAccounts200Response updateSurveyQuestionTranslation(surveyQuestionTranslationUpdateInputs)

Creates or updates the translated text for a specific locale on a survey question; requires \"update\" permission on surveys.

### 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

**SyncAccounts200Response**

### 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)