# EventsTracksTranslationsApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**deleteEventTrackTranslation**](#deleteeventtracktranslation) | **DELETE** /events/{eventId}/tracks/{trackId}/translations/{locale} | Delete an event track translation|
|[**getEventTrackTranslation**](#geteventtracktranslation) | **GET** /events/{eventId}/tracks/{trackId}/translations/{locale} | Get an event track translation|
|[**getEventTrackTranslations**](#geteventtracktranslations) | **GET** /events/{eventId}/tracks/{trackId}/translations | List an event track\'s translations|
|[**updateEventTrackTranslation**](#updateeventtracktranslation) | **PUT** /events/{eventId}/tracks/{trackId}/translations/{locale} | Update an event track translation|

# **deleteEventTrackTranslation**
> SyncAccounts200Response deleteEventTrackTranslation()

Removes the translation of an event track for the specified locale, and requires update permission on events.

### Example

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

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

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

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

### Parameters

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

# **getEventTrackTranslation**
> GetEventTrackTranslation200Response getEventTrackTranslation()

Retrieves the localized translation of an event track for the given locale, returning null if no translation exists for that locale; requires read permission on events.

### Example

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

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

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

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

### Parameters

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


### Return type

**GetEventTrackTranslation200Response**

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

# **getEventTrackTranslations**
> GetEventTrackTranslations200Response getEventTrackTranslations()

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

### Example

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

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

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

### Parameters

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

**GetEventTrackTranslations200Response**

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

# **updateEventTrackTranslation**
> SyncAccounts200Response updateEventTrackTranslation(eventTrackTranslationUpdateInputs)

Creates or updates the translated name and description of an event track for the specified locale, and requires update permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let trackId: string; //The track identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)
let eventTrackTranslationUpdateInputs: EventTrackTranslationUpdateInputs; //

const { status, data } = await apiInstance.updateEventTrackTranslation(
    eventId,
    trackId,
    locale,
    eventTrackTranslationUpdateInputs
);
```

### Parameters

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