# EventsPackagesTranslationsApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**deleteEventPackageTranslation**](#deleteeventpackagetranslation) | **DELETE** /events/{eventId}/packages/{packageId}/translations/{locale} | Delete an event package translation|
|[**getEventPackageTranslation**](#geteventpackagetranslation) | **GET** /events/{eventId}/packages/{packageId}/translations/{locale} | Get an event package\'s translation for a locale|
|[**getEventPackageTranslations**](#geteventpackagetranslations) | **GET** /events/{eventId}/packages/{packageId}/translations | List an event package\'s translations|
|[**updateEventPackageTranslation**](#updateeventpackagetranslation) | **PUT** /events/{eventId}/packages/{packageId}/translations/{locale} | Update an event package translation|

# **deleteEventPackageTranslation**
> CreateAccountInvitations200Response deleteEventPackageTranslation()

Removes the localized translation for the given event package in the specified locale; requires read and update permission on events.

### Example

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

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

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

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

### Parameters

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


### Return type

**CreateAccountInvitations200Response**

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

# **getEventPackageTranslation**
> GetEventPackageTranslation200Response getEventPackageTranslation()

Returns the localized text fields for the given event package in the specified locale; requires read access to events.

### Example

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

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

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

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

### Parameters

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


### Return type

**GetEventPackageTranslation200Response**

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

# **getEventPackageTranslations**
> GetEventPackageTranslations200Response getEventPackageTranslations()

Returns a paginated list of the locale translations available for the given event package, with search and ordering support; requires read access to events.

### Example

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

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

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

### Parameters

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

**GetEventPackageTranslations200Response**

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

# **updateEventPackageTranslation**
> GetEventPackageTranslation200Response updateEventPackageTranslation(eventPackageTranslationUpdateInputs)

Creates or updates the localized translation of an event package\'s content for the specified locale; requires read and update permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let packageId: string; //The package identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)
let eventPackageTranslationUpdateInputs: EventPackageTranslationUpdateInputs; //

const { status, data } = await apiInstance.updateEventPackageTranslation(
    eventId,
    packageId,
    locale,
    eventPackageTranslationUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventPackageTranslationUpdateInputs** | **EventPackageTranslationUpdateInputs**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **packageId** | [**string**] | The package identifier | defaults to undefined|
| **locale** | [**string**] | The locale identifier | defaults to undefined|


### Return type

**GetEventPackageTranslation200Response**

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