# EventsAddonsTranslationsApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**deleteEventAddOnTranslation**](#deleteeventaddontranslation) | **DELETE** /events/{eventId}/addOns/{addOnId}/translations/{locale} | Delete an event add-on translation|
|[**getEventAddOnTranslation**](#geteventaddontranslation) | **GET** /events/{eventId}/addOns/{addOnId}/translations/{locale} | Get an add-on translation for a locale|
|[**getEventAddOnTranslations**](#geteventaddontranslations) | **GET** /events/{eventId}/addOns/{addOnId}/translations | List translations for an add-on|
|[**updateEventAddOnTranslation**](#updateeventaddontranslation) | **PUT** /events/{eventId}/addOns/{addOnId}/translations/{locale} | Update an event add-on translation|

# **deleteEventAddOnTranslation**
> SyncAccounts200Response deleteEventAddOnTranslation()

Removes the translation for a given locale from an event add-on, reverting that locale to the add-on\'s default content; requires the update permission on events.

### Example

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

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

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

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

### Parameters

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

# **getEventAddOnTranslation**
> GetEventAddOnTranslation200Response getEventAddOnTranslation()

Retrieves the translated text for a single event add-on in the specified locale, or null if no translation exists for that locale; requires read access to the event\'s events module.

### Example

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

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

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

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

### Parameters

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


### Return type

**GetEventAddOnTranslation200Response**

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

# **getEventAddOnTranslations**
> GetEventAddOnTranslations200Response getEventAddOnTranslations()

Returns a paginated list of locale translations for the specified event add-on, supporting search and ordering; requires read access to the event\'s events module.

### Example

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

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

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

### Parameters

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

**GetEventAddOnTranslations200Response**

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

# **updateEventAddOnTranslation**
> UpdateEventAddOnTranslation200Response updateEventAddOnTranslation(eventAddOnTranslationUpdateInputs)

Creates or updates the localized content (e.g. name, description) for an event add-on in the given locale; requires the update permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let addOnId: string; //The addOn identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)
let eventAddOnTranslationUpdateInputs: EventAddOnTranslationUpdateInputs; //

const { status, data } = await apiInstance.updateEventAddOnTranslation(
    eventId,
    addOnId,
    locale,
    eventAddOnTranslationUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventAddOnTranslationUpdateInputs** | **EventAddOnTranslationUpdateInputs**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **addOnId** | [**string**] | The addOn identifier | defaults to undefined|
| **locale** | [**string**] | The locale identifier | defaults to undefined|


### Return type

**UpdateEventAddOnTranslation200Response**

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