# BenefitsTranslationsApi

All URIs are relative to *https://admin-api.connected.dev*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**deleteBenefitTranslation**](#deletebenefittranslation) | **DELETE** /benefits/{benefitId}/translations/{locale} | Delete a benefit translation|
|[**getBenefitTranslation**](#getbenefittranslation) | **GET** /benefits/{benefitId}/translations/{locale} | Get a benefit\'s translation|
|[**getBenefitTranslations**](#getbenefittranslations) | **GET** /benefits/{benefitId}/translations | List a benefit\'s translations|
|[**updateBenefitTranslation**](#updatebenefittranslation) | **PUT** /benefits/{benefitId}/translations/{locale} | Update a benefit translation|

# **deleteBenefitTranslation**
> SyncAccounts200Response deleteBenefitTranslation()

Removes the translation for the given benefit in the specified locale; requires update permission on benefits.

### Example

```typescript
import {
    BenefitsTranslationsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BenefitsTranslationsApi(configuration);

let benefitId: string; //The benefit identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)

const { status, data } = await apiInstance.deleteBenefitTranslation(
    benefitId,
    locale
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **benefitId** | [**string**] | The benefit 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)

# **getBenefitTranslation**
> GetBenefitTranslation200Response getBenefitTranslation()

Returns the translated text for a benefit in the given locale, or null if no translation exists for that locale; requires \"read\" permission on \"benefits\".

### Example

```typescript
import {
    BenefitsTranslationsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BenefitsTranslationsApi(configuration);

let benefitId: string; //The benefit identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)

const { status, data } = await apiInstance.getBenefitTranslation(
    benefitId,
    locale
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **benefitId** | [**string**] | The benefit identifier | defaults to undefined|
| **locale** | [**string**] | The locale identifier | defaults to undefined|


### Return type

**GetBenefitTranslation200Response**

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

# **getBenefitTranslations**
> GetBenefitTranslations200Response getBenefitTranslations()

Returns a paginated list of locale translations for the given benefit, supporting search and ordering; requires \"read\" permission on \"benefits\".

### Example

```typescript
import {
    BenefitsTranslationsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BenefitsTranslationsApi(configuration);

let benefitId: string; //The benefit 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.getBenefitTranslations(
    benefitId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **benefitId** | [**string**] | The benefit 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

**GetBenefitTranslations200Response**

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

# **updateBenefitTranslation**
> SyncAccounts200Response updateBenefitTranslation(benefitTranslationUpdateInputs)

Creates or updates the translated content (e.g. title, description) for the given benefit in the specified locale; requires update permission on benefits.

### Example

```typescript
import {
    BenefitsTranslationsApi,
    Configuration,
    BenefitTranslationUpdateInputs
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new BenefitsTranslationsApi(configuration);

let benefitId: string; //The benefit identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)
let benefitTranslationUpdateInputs: BenefitTranslationUpdateInputs; //

const { status, data } = await apiInstance.updateBenefitTranslation(
    benefitId,
    locale,
    benefitTranslationUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **benefitTranslationUpdateInputs** | **BenefitTranslationUpdateInputs**|  | |
| **benefitId** | [**string**] | The benefit 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)