# ChannelsTranslationsApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**deleteChannelContentGuestTranslation**](#deletechannelcontentguesttranslation) | **DELETE** /channels/{channelId}/contents/{contentId}/guests/{guestId}/translations/{locale} | Delete a channel content guest translation|
|[**deleteChannelContentTranslation**](#deletechannelcontenttranslation) | **DELETE** /channels/{channelId}/contents/{contentId}/translations/{locale} | Delete a channel content translation|
|[**deleteChannelTranslation**](#deletechanneltranslation) | **DELETE** /channels/{channelId}/translations/{locale} | Delete a channel translation|
|[**getChannelContentGuestTranslation**](#getchannelcontentguesttranslation) | **GET** /channels/{channelId}/contents/{contentId}/guests/{guestId}/translations/{locale} | Get a channel content guest\'s translation for a locale|
|[**getChannelContentGuestTranslations**](#getchannelcontentguesttranslations) | **GET** /channels/{channelId}/contents/{contentId}/guests/{guestId}/translations | List a channel content guest\'s translations|
|[**getChannelContentTranslation**](#getchannelcontenttranslation) | **GET** /channels/{channelId}/contents/{contentId}/translations/{locale} | Get a channel content item\'s translation for a locale|
|[**getChannelContentTranslations**](#getchannelcontenttranslations) | **GET** /channels/{channelId}/contents/{contentId}/translations | List a channel content item\'s translations|
|[**getChannelTranslation**](#getchanneltranslation) | **GET** /channels/{channelId}/translations/{locale} | Get a channel\'s translation for a locale|
|[**getChannelTranslations**](#getchanneltranslations) | **GET** /channels/{channelId}/translations | List a channel\'s translations|
|[**updateChannelContentGuestTranslation**](#updatechannelcontentguesttranslation) | **PUT** /channels/{channelId}/contents/{contentId}/guests/{guestId}/translations/{locale} | Update a channel content guest translation|
|[**updateChannelContentTranslation**](#updatechannelcontenttranslation) | **PUT** /channels/{channelId}/contents/{contentId}/translations/{locale} | Update a channel content translation|
|[**updateChannelTranslation**](#updatechanneltranslation) | **PUT** /channels/{channelId}/translations/{locale} | Update a channel translation|

# **deleteChannelContentGuestTranslation**
> SyncAccounts200Response deleteChannelContentGuestTranslation()

Removes the translation for a specific locale on a channel content item\'s guest speaker/author, requiring update permission on contents.

### Example

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

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

let channelId: string; //The channel identifier (default to undefined)
let contentId: string; //The content identifier (default to undefined)
let guestId: string; //The guest identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)

const { status, data } = await apiInstance.deleteChannelContentGuestTranslation(
    channelId,
    contentId,
    guestId,
    locale
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
| **contentId** | [**string**] | The content identifier | defaults to undefined|
| **guestId** | [**string**] | The guest 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)

# **deleteChannelContentTranslation**
> SyncAccounts200Response deleteChannelContentTranslation()

Removes the translation for a specific locale on a piece of channel content, requiring update permission on contents.

### Example

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

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

let channelId: string; //The channel identifier (default to undefined)
let contentId: string; //The content identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)

const { status, data } = await apiInstance.deleteChannelContentTranslation(
    channelId,
    contentId,
    locale
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
| **contentId** | [**string**] | The content 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)

# **deleteChannelTranslation**
> SyncAccounts200Response deleteChannelTranslation()

Removes the translation for a specific locale on a channel\'s name/description, requiring update permission on channels.

### Example

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

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

let channelId: string; //The channel identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)

const { status, data } = await apiInstance.deleteChannelTranslation(
    channelId,
    locale
);
```

### Parameters

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

# **getChannelContentGuestTranslation**
> GetChannelContentGuestTranslation200Response getChannelContentGuestTranslation()

Returns the localized translation of a channel content guest\'s fields for the given locale, or null if no translation exists, requiring read permission on channels and contents.

### Example

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

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

let channelId: string; //The channel identifier (default to undefined)
let contentId: string; //The content identifier (default to undefined)
let guestId: string; //The guest identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)

const { status, data } = await apiInstance.getChannelContentGuestTranslation(
    channelId,
    contentId,
    guestId,
    locale
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
| **contentId** | [**string**] | The content identifier | defaults to undefined|
| **guestId** | [**string**] | The guest identifier | defaults to undefined|
| **locale** | [**string**] | The locale identifier | defaults to undefined|


### Return type

**GetChannelContentGuestTranslation200Response**

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

# **getChannelContentGuestTranslations**
> GetChannelContentGuestTranslations200Response getChannelContentGuestTranslations()

Returns a paginated, searchable list of locale translations for a guest of a piece of channel content, requiring read permission on channels and contents.

### Example

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

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

let channelId: string; //The channel identifier (default to undefined)
let contentId: string; //The content identifier (default to undefined)
let guestId: string; //The guest 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.getChannelContentGuestTranslations(
    channelId,
    contentId,
    guestId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
| **contentId** | [**string**] | The content identifier | defaults to undefined|
| **guestId** | [**string**] | The guest 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

**GetChannelContentGuestTranslations200Response**

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

# **getChannelContentTranslation**
> GetChannelContentTranslation200Response getChannelContentTranslation()

Returns the localized translation of a channel content item\'s fields for the given locale, or null if no translation exists, requiring read permission on channels and contents.

### Example

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

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

let channelId: string; //The channel identifier (default to undefined)
let contentId: string; //The content identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)

const { status, data } = await apiInstance.getChannelContentTranslation(
    channelId,
    contentId,
    locale
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
| **contentId** | [**string**] | The content identifier | defaults to undefined|
| **locale** | [**string**] | The locale identifier | defaults to undefined|


### Return type

**GetChannelContentTranslation200Response**

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

# **getChannelContentTranslations**
> GetChannelContentTranslations200Response getChannelContentTranslations()

Returns a paginated, searchable list of locale translations for a piece of channel content, requiring read permission on channels and contents.

### Example

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

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

let channelId: string; //The channel identifier (default to undefined)
let contentId: string; //The content 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.getChannelContentTranslations(
    channelId,
    contentId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
| **contentId** | [**string**] | The content 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

**GetChannelContentTranslations200Response**

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

# **getChannelTranslation**
> GetChannelTranslation200Response getChannelTranslation()

Returns the localized translation of a channel\'s fields for the given locale, or null if no translation exists, requiring read permission on channels.

### Example

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

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

let channelId: string; //The channel identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)

const { status, data } = await apiInstance.getChannelTranslation(
    channelId,
    locale
);
```

### Parameters

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


### Return type

**GetChannelTranslation200Response**

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

# **getChannelTranslations**
> GetChannelTranslations200Response getChannelTranslations()

Returns a paginated, searchable list of locale translations for a channel, requiring read permission on channels.

### Example

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

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

let channelId: string; //The channel 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.getChannelTranslations(
    channelId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

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

**GetChannelTranslations200Response**

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

# **updateChannelContentGuestTranslation**
> UpdateChannelContentGuestTranslation200Response updateChannelContentGuestTranslation(channelContentGuestTranslationUpdateInputs)

Creates or updates the translation for a specific locale on a channel content item\'s guest speaker/author, requiring update permission on contents.

### Example

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

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

let channelId: string; //The channel identifier (default to undefined)
let contentId: string; //The content identifier (default to undefined)
let guestId: string; //The guest identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)
let channelContentGuestTranslationUpdateInputs: ChannelContentGuestTranslationUpdateInputs; //

const { status, data } = await apiInstance.updateChannelContentGuestTranslation(
    channelId,
    contentId,
    guestId,
    locale,
    channelContentGuestTranslationUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelContentGuestTranslationUpdateInputs** | **ChannelContentGuestTranslationUpdateInputs**|  | |
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
| **contentId** | [**string**] | The content identifier | defaults to undefined|
| **guestId** | [**string**] | The guest identifier | defaults to undefined|
| **locale** | [**string**] | The locale identifier | defaults to undefined|


### Return type

**UpdateChannelContentGuestTranslation200Response**

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

# **updateChannelContentTranslation**
> SyncAccounts200Response updateChannelContentTranslation(channelContentTranslationUpdateInputs)

Creates or updates the translation for a specific locale on a piece of channel content, requiring update permission on contents.

### Example

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

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

let channelId: string; //The channel identifier (default to undefined)
let contentId: string; //The content identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)
let channelContentTranslationUpdateInputs: ChannelContentTranslationUpdateInputs; //

const { status, data } = await apiInstance.updateChannelContentTranslation(
    channelId,
    contentId,
    locale,
    channelContentTranslationUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelContentTranslationUpdateInputs** | **ChannelContentTranslationUpdateInputs**|  | |
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
| **contentId** | [**string**] | The content 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)

# **updateChannelTranslation**
> UpdateChannelTranslation200Response updateChannelTranslation(channelTranslationUpdateInputs)

Creates or updates the translation for a specific locale on a channel\'s name/description, requiring update permission on channels.

### Example

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

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

let channelId: string; //The channel identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)
let channelTranslationUpdateInputs: ChannelTranslationUpdateInputs; //

const { status, data } = await apiInstance.updateChannelTranslation(
    channelId,
    locale,
    channelTranslationUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelTranslationUpdateInputs** | **ChannelTranslationUpdateInputs**|  | |
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
| **locale** | [**string**] | The locale identifier | defaults to undefined|


### Return type

**UpdateChannelTranslation200Response**

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