# EventsPasstypesTranslationsApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**deleteEventPassTypeTranslation**](#deleteeventpasstypetranslation) | **DELETE** /events/{eventId}/passTypes/{passTypeId}/translations/{locale} | Delete an event pass type translation|
|[**getEventPassTypeTranslation**](#geteventpasstypetranslation) | **GET** /events/{eventId}/passTypes/{passTypeId}/translations/{locale} | Get a pass type\&#39;s translation for a locale|
|[**getEventPassTypeTranslations**](#geteventpasstypetranslations) | **GET** /events/{eventId}/passTypes/{passTypeId}/translations | List a pass type\&#39;s translations|
|[**updateEventPassTypeTranslation**](#updateeventpasstypetranslation) | **PUT** /events/{eventId}/passTypes/{passTypeId}/translations/{locale} | Update an event pass type translation|

# **deleteEventPassTypeTranslation**
> SyncAccounts200Response deleteEventPassTypeTranslation()

Deletes the localized translation for an event pass type in the given locale; requires update permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let passTypeId: string; //The passType identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)

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

### Parameters

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

# **getEventPassTypeTranslation**
> GetEventPassTypeTranslation200Response getEventPassTypeTranslation()

Retrieves the localized text (such as name and description) for an event pass type in the given locale, returning null if no translation exists for that locale; requires read access to the event.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let passTypeId: string; //The passType identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)

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

### Parameters

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


### Return type

**GetEventPassTypeTranslation200Response**

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

# **getEventPassTypeTranslations**
> GetEventPassTypeTranslations200Response getEventPassTypeTranslations()

Returns a paginated list of all locale translations that exist for an event pass type, with optional search and orderBy filters; requires read access to the event.

### Example

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

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

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

### Parameters

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

**GetEventPassTypeTranslations200Response**

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

# **updateEventPassTypeTranslation**
> SyncAccounts200Response updateEventPassTypeTranslation(eventTranslationUpdateInputs)

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

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let passTypeId: string; //The passType identifier (default to undefined)
let locale: string; //The locale identifier (default to undefined)
let eventTranslationUpdateInputs: EventTranslationUpdateInputs; //

const { status, data } = await apiInstance.updateEventPassTypeTranslation(
    eventId,
    passTypeId,
    locale,
    eventTranslationUpdateInputs
);
```

### Parameters

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

