# EventsEmailsTranslationsApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**deleteEventEmailTranslation**](#deleteeventemailtranslation) | **DELETE** /events/{eventId}/emails/{type}/translations/{locale} | Delete an event email translation|
|[**getEventEmailTranslation**](#geteventemailtranslation) | **GET** /events/{eventId}/emails/{type}/translations/{locale} | Get an event email\'s translation|
|[**getEventEmailTranslations**](#geteventemailtranslations) | **GET** /events/{eventId}/emails/{type}/translations | List an event email\'s translations|
|[**updateEventEmailTranslation**](#updateeventemailtranslation) | **PUT** /events/{eventId}/emails/{type}/translations/{locale} | Update an event email translation|

# **deleteEventEmailTranslation**
> SyncAccounts200Response deleteEventEmailTranslation()

Removes the translated content for a specific event email type in a given locale, reverting that locale to the email\'s default content; requires update permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let type: string; //The type identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)

const { status, data } = await apiInstance.deleteEventEmailTranslation(
    eventId,
    type,
    locale
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **type** | [**string**] | The type 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)

# **getEventEmailTranslation**
> GetEventEmailTranslation200Response getEventEmailTranslation()

Returns the localized translation (subject/body) for a specific event email type and locale, or null if no translation exists for that locale; requires read permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let type: string; //The type identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)

const { status, data } = await apiInstance.getEventEmailTranslation(
    eventId,
    type,
    locale
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **type** | [**string**] | The type identifier | defaults to undefined|
| **locale** | [**string**] | The locale identifier | defaults to undefined|


### Return type

**GetEventEmailTranslation200Response**

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

# **getEventEmailTranslations**
> GetEventEmailTranslations200Response getEventEmailTranslations()

Returns a paginated list of locale translations for a specific event email type, supporting page, pageSize, orderBy, and search filters; requires read permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let type: string; //The type 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.getEventEmailTranslations(
    eventId,
    type,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **type** | [**string**] | The type 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

**GetEventEmailTranslations200Response**

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

# **updateEventEmailTranslation**
> SyncAccounts200Response updateEventEmailTranslation(eventEmailTranslationUpdateInputs)

Creates or updates the translated subject and body content for a specific event email type in a given locale; requires update permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let type: string; //The type identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)
let eventEmailTranslationUpdateInputs: EventEmailTranslationUpdateInputs; //

const { status, data } = await apiInstance.updateEventEmailTranslation(
    eventId,
    type,
    locale,
    eventEmailTranslationUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventEmailTranslationUpdateInputs** | **EventEmailTranslationUpdateInputs**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **type** | [**string**] | The type 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)