# EventsPassesAttributesApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**getEventPassAttributes**](#geteventpassattributes) | **GET** /events/{eventId}/passes/{passId}/attributes | List an event pass\'s attributes|
|[**importEventPassAttributes**](#importeventpassattributes) | **POST** /events/{eventId}/passes/attributes/import | Bulk set custom attribute values across many passes|
|[**removeEventPassAttribute**](#removeeventpassattribute) | **DELETE** /events/{eventId}/passes/{passId}/attributes/{attributeId} | Remove a custom attribute from a pass|
|[**updateEventPassAttributes**](#updateeventpassattributes) | **PUT** /events/{eventId}/passes/{passId}/attributes | Set custom attribute values on a pass|

# **getEventPassAttributes**
> GetEventPassAttributes200Response getEventPassAttributes()

Returns the list of custom attributes assigned to the specified event pass, supporting sorting; requires the \"read\" permission on both the \"events\" and \"attendees\" modules.

### Example

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

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

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

### Parameters

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

**GetEventPassAttributes200Response**

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

# **importEventPassAttributes**
> ImportEventPassAttributes200Response importEventPassAttributes(passAttributesImportInputs)

Creates or updates attribute values on up to 500 passes in one call, the write half of a CSV import. Each row\'s passId may be a pass id or the pass\'s alternateId, and each attributeId may be an attribute id or its name. Rows whose pass or attribute cannot be resolved are reported back as invalid and skipped rather than failing the batch. Requires read permission on events and read/update permission on attendees.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let passAttributesImportInputs: PassAttributesImportInputs; //

const { status, data } = await apiInstance.importEventPassAttributes(
    eventId,
    passAttributesImportInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **passAttributesImportInputs** | **PassAttributesImportInputs**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|


### Return type

**ImportEventPassAttributes200Response**

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

# **removeEventPassAttribute**
> RemoveEventPassAttribute200Response removeEventPassAttribute()

Deletes a single custom attribute value that had been set on the specified event pass, requires read permission on events and read/update permission on attendees.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let passId: string; //The pass identifier (default to undefined)
let attributeId: string; //The attribute identifier (default to undefined)

const { status, data } = await apiInstance.removeEventPassAttribute(
    eventId,
    passId,
    attributeId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **passId** | [**string**] | The pass identifier | defaults to undefined|
| **attributeId** | [**string**] | The attribute identifier | defaults to undefined|


### Return type

**RemoveEventPassAttribute200Response**

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

# **updateEventPassAttributes**
> UpdateEventPassAttributes200Response updateEventPassAttributes(passAttributesUpdateInputs)

Creates or updates one or more custom attribute values (attributeId/value pairs) on the specified event pass, requires read permission on events and read/update permission on attendees.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let passId: string; //The pass identifier (default to undefined)
let passAttributesUpdateInputs: PassAttributesUpdateInputs; //

const { status, data } = await apiInstance.updateEventPassAttributes(
    eventId,
    passId,
    passAttributesUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **passAttributesUpdateInputs** | **PassAttributesUpdateInputs**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **passId** | [**string**] | The pass identifier | defaults to undefined|


### Return type

**UpdateEventPassAttributes200Response**

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