# AnnouncementsTranslationsApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**deleteAnnouncementTranslation**](#deleteannouncementtranslation) | **DELETE** /announcements/{announcementId}/translations/{locale} | Delete an announcement translation|
|[**getAnnouncementTranslation**](#getannouncementtranslation) | **GET** /announcements/{announcementId}/translations/{locale} | Get an announcement\'s translation for a locale|
|[**getAnnouncementTranslations**](#getannouncementtranslations) | **GET** /announcements/{announcementId}/translations | List an announcement\'s translations|
|[**updateAnnouncementTranslation**](#updateannouncementtranslation) | **PUT** /announcements/{announcementId}/translations/{locale} | Update an announcement translation|

# **deleteAnnouncementTranslation**
> SyncAccounts200Response deleteAnnouncementTranslation()

Removes the translation for the given announcement in the specified locale; requires update permission on announcements.

### Example

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

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

let announcementId: string; //The announcement identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)

const { status, data } = await apiInstance.deleteAnnouncementTranslation(
    announcementId,
    locale
);
```

### Parameters

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

# **getAnnouncementTranslation**
> GetAnnouncementTranslation200Response getAnnouncementTranslation()

Returns the translated content (title, message, etc.) of an announcement for the specified locale, or null if no translation exists; requires read permission on announcements.

### Example

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

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

let announcementId: string; //The announcement identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)

const { status, data } = await apiInstance.getAnnouncementTranslation(
    announcementId,
    locale
);
```

### Parameters

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


### Return type

**GetAnnouncementTranslation200Response**

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

# **getAnnouncementTranslations**
> GetAnnouncementTranslations200Response getAnnouncementTranslations()

Returns a paginated list of locale translations for the given announcement, supporting search and ordering; requires read permission on announcements.

### Example

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

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

let announcementId: string; //The announcement 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.getAnnouncementTranslations(
    announcementId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

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

**GetAnnouncementTranslations200Response**

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

# **updateAnnouncementTranslation**
> SyncAccounts200Response updateAnnouncementTranslation(announcementTranslationUpdateInputs)

Creates or updates the translated content (e.g. title, HTML body) for the given announcement in the specified locale; requires update permission on announcements.

### Example

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

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

let announcementId: string; //The announcement identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)
let announcementTranslationUpdateInputs: AnnouncementTranslationUpdateInputs; //

const { status, data } = await apiInstance.updateAnnouncementTranslation(
    announcementId,
    locale,
    announcementTranslationUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **announcementTranslationUpdateInputs** | **AnnouncementTranslationUpdateInputs**|  | |
| **announcementId** | [**string**] | The announcement 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)