# SponsorsTranslationsApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**deleteLevelTranslation**](#deleteleveltranslation) | **DELETE** /levels/{levelId}/translations/{locale} | Delete a sponsorship level translation|
|[**getLevelTranslation**](#getleveltranslation) | **GET** /levels/{levelId}/translations/{locale} | Get a sponsorship level translation|
|[**getLevelTranslations**](#getleveltranslations) | **GET** /levels/{levelId}/translations | List a sponsorship level\'s translations|
|[**updateLevelTranslation**](#updateleveltranslation) | **PUT** /levels/{levelId}/translations/{locale} | Update a sponsorship level translation|

# **deleteLevelTranslation**
> SyncAccounts200Response deleteLevelTranslation()

Removes the translation for the given locale on the specified sponsorship level, requiring update permission on sponsors.

### Example

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

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

let levelId: string; //The level identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)

const { status, data } = await apiInstance.deleteLevelTranslation(
    levelId,
    locale
);
```

### Parameters

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

# **getLevelTranslation**
> GetLevelTranslation200Response getLevelTranslation()

Returns the translated content for a sponsorship level in the given locale, or null if no translation exists, and requires read access to sponsors.

### Example

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

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

let levelId: string; //The level identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)

const { status, data } = await apiInstance.getLevelTranslation(
    levelId,
    locale
);
```

### Parameters

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


### Return type

**GetLevelTranslation200Response**

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

# **getLevelTranslations**
> GetLevelTranslations200Response getLevelTranslations()

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

### Example

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

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

let levelId: string; //The level 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.getLevelTranslations(
    levelId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

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

**GetLevelTranslations200Response**

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

# **updateLevelTranslation**
> SyncAccounts200Response updateLevelTranslation(levelTranslationUpdateInputs)

Creates or updates the localized name and description for a sponsorship level in the given locale, requiring update permission on sponsors.

### Example

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

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

let levelId: string; //The level identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)
let levelTranslationUpdateInputs: LevelTranslationUpdateInputs; //

const { status, data } = await apiInstance.updateLevelTranslation(
    levelId,
    locale,
    levelTranslationUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **levelTranslationUpdateInputs** | **LevelTranslationUpdateInputs**|  | |
| **levelId** | [**string**] | The level 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)