# EventsPassesAccessesApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**createEventSessionAccess**](#createeventsessionaccess) | **POST** /events/{eventId}/sessions/{sessionId}/passes/{passId} | Grant a pass access to a session|
|[**deleteEventSessionAccess**](#deleteeventsessionaccess) | **DELETE** /events/{eventId}/sessions/{sessionId}/passes/{passId} | Revoke a pass\&#39;s access to a session|
|[**getEventPassAccesses**](#geteventpassaccesses) | **GET** /events/{eventId}/passes/{passId}/accesses | List a pass\&#39;s session accesses|
|[**updateEventSessionAccess**](#updateeventsessionaccess) | **PUT** /events/{eventId}/sessions/{sessionId}/passes/{passId} | Update a pass\&#39;s session access|
|[**updateEventSessionAccessResponses**](#updateeventsessionaccessresponses) | **PUT** /events/{eventId}/sessions/{sessionId}/passes/{passId}/responses | Update a pass\&#39;s session access question responses|

# **createEventSessionAccess**
> GetEventSessionAccess200Response createEventSessionAccess()

Creates a session access record linking an attendee\'s pass to an event session, failing if session registration is not enabled, and requires update permission on attendees.

### Example

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

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

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

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

### Parameters

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


### Return type

**GetEventSessionAccess200Response**

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

# **deleteEventSessionAccess**
> CreateAccountInvitations200Response deleteEventSessionAccess()

Permanently deletes the session access record linking a pass to an event session, requiring update permission on attendees.

### Example

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

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

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

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

### Parameters

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

# **getEventPassAccesses**
> GetEventPassAccesses200Response getEventPassAccesses()

Returns a paginated list of session access records granted by the specified event pass, supporting search and sorting; requires the \"read\" permission on both the \"events\" and \"attendees\" modules.

### Example

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

const configuration = new Configuration();
const apiInstance = new EventsPassesAccessesApi(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.getEventPassAccesses(
    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

**GetEventPassAccesses200Response**

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

# **updateEventSessionAccess**
> GetEventSessionAccess200Response updateEventSessionAccess(eventSessionAccessUpdateInputs)

Updates fields, such as status, on the session access record linking a pass to an event session, requiring update permission on attendees.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let sessionId: string; //The session identifier (default to undefined)
let passId: string; //The pass identifier (default to undefined)
let eventSessionAccessUpdateInputs: EventSessionAccessUpdateInputs; //

const { status, data } = await apiInstance.updateEventSessionAccess(
    eventId,
    sessionId,
    passId,
    eventSessionAccessUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventSessionAccessUpdateInputs** | **EventSessionAccessUpdateInputs**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **sessionId** | [**string**] | The session identifier | defaults to undefined|
| **passId** | [**string**] | The pass identifier | defaults to undefined|


### Return type

**GetEventSessionAccess200Response**

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

# **updateEventSessionAccessResponses**
> CreateAccountInvitations200Response updateEventSessionAccessResponses(requestBody)

Overwrites the registration question responses used to control a pass\'s access to a specific event session, requires read/update permission on attendees and read permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let sessionId: string; //The session identifier (default to undefined)
let passId: string; //The pass identifier (default to undefined)
let requestBody: Array<object>; //

const { status, data } = await apiInstance.updateEventSessionAccessResponses(
    eventId,
    sessionId,
    passId,
    requestBody
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **requestBody** | **Array<object>**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **sessionId** | [**string**] | The session identifier | defaults to undefined|
| **passId** | [**string**] | The pass identifier | defaults to undefined|


### Return type

**CreateAccountInvitations200Response**

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

