# EventsPagesTranslationsApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**deleteEventPageTranslation**](#deleteeventpagetranslation) | **DELETE** /events/{eventId}/pages/{pageId}/translations/{locale} | Delete an event page translation|
|[**getEventPageTranslation**](#geteventpagetranslation) | **GET** /events/{eventId}/pages/{pageId}/translations/{locale} | Get an event page\&#39;s translation for a locale|
|[**getEventPageTranslations**](#geteventpagetranslations) | **GET** /events/{eventId}/pages/{pageId}/translations | List an event page\&#39;s translations|
|[**updateEventPageTranslation**](#updateeventpagetranslation) | **PUT** /events/{eventId}/pages/{pageId}/translations/{locale} | Create or update an event page translation|

# **deleteEventPageTranslation**
> SyncAccounts200Response deleteEventPageTranslation()

Deletes the translation for the given locale on an event page, requiring update permission on events; subsequent reads for that locale will fall back to the page\'s default content.

### Example

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

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

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

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

### Parameters

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

# **getEventPageTranslation**
> GetEventPageTranslation200Response getEventPageTranslation()

Returns the localized content for the given event page in the specified locale, or null if no translation exists; requires read access to events.

### Example

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

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

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

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

### Parameters

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


### Return type

**GetEventPageTranslation200Response**

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

# **getEventPageTranslations**
> GetEventPageTranslations200Response getEventPageTranslations()

Returns a paginated list of translations for the specified event page, supporting search and sorting; requires the \"read\" permission on the \"events\" module.

### Example

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

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

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

### Parameters

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

**GetEventPageTranslations200Response**

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

# **updateEventPageTranslation**
> SyncAccounts200Response updateEventPageTranslation(eventPageTranslationUpdateInputs)

Upserts the localized content (e.g. title, subtitle, body) for an event page in the given locale, requiring update permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let pageId: string; //The page identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)
let eventPageTranslationUpdateInputs: EventPageTranslationUpdateInputs; //

const { status, data } = await apiInstance.updateEventPageTranslation(
    eventId,
    pageId,
    locale,
    eventPageTranslationUpdateInputs
);
```

### Parameters

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

