# SeriesTranslationsApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**deleteSeriesTranslation**](#deleteseriestranslation) | **DELETE** /series/{seriesId}/translations/{locale} | Delete a series translation|
|[**getSeriesTranslation**](#getseriestranslation) | **GET** /series/{seriesId}/translations/{locale} | Get a series translation|
|[**getSeriesTranslations**](#getseriestranslations) | **GET** /series/{seriesId}/translations | List a series\' translations|
|[**updateSeriesTranslation**](#updateseriestranslation) | **PUT** /series/{seriesId}/translations/{locale} | Create or update a series translation|

# **deleteSeriesTranslation**
> SyncAccounts200Response deleteSeriesTranslation()

Deletes the translated content for an event series in the given locale, requiring \"read\" and \"del\" permission on events.

### Example

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

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

let seriesId: string; //The series identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)

const { status, data } = await apiInstance.deleteSeriesTranslation(
    seriesId,
    locale
);
```

### Parameters

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

# **getSeriesTranslation**
> GetSeriesTranslation200Response getSeriesTranslation()

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

### Example

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

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

let seriesId: string; //The series identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)

const { status, data } = await apiInstance.getSeriesTranslation(
    seriesId,
    locale
);
```

### Parameters

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


### Return type

**GetSeriesTranslation200Response**

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

# **getSeriesTranslations**
> GetSeriesTranslations200Response getSeriesTranslations()

Returns a paginated list of locale translations available for a series, supporting search and ordering, and requires read access to events.

### Example

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

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

let seriesId: string; //The series 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.getSeriesTranslations(
    seriesId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

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

**GetSeriesTranslations200Response**

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

# **updateSeriesTranslation**
> SyncAccounts200Response updateSeriesTranslation(seriesTranslationUpdateInputs)

Creates or updates the translated content for an event series in the given locale, requiring \"read\" and \"update\" permission on events.

### Example

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

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

let seriesId: string; //The series identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)
let seriesTranslationUpdateInputs: SeriesTranslationUpdateInputs; //

const { status, data } = await apiInstance.updateSeriesTranslation(
    seriesId,
    locale,
    seriesTranslationUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **seriesTranslationUpdateInputs** | **SeriesTranslationUpdateInputs**|  | |
| **seriesId** | [**string**] | The series 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)