# EventsBypassApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**createEventRegistrationBypass**](#createeventregistrationbypass) | **POST** /events/{eventId}/bypass | Create an event registration bypass|
|[**deleteEventRegistrationBypass**](#deleteeventregistrationbypass) | **DELETE** /events/{eventId}/bypass/{bypassId} | Delete an event registration bypass|
|[**getEventRegistrationBypass**](#geteventregistrationbypass) | **GET** /events/{eventId}/bypass/{bypassId} | Get a single registration bypass|
|[**getEventRegistrationBypassList**](#geteventregistrationbypasslist) | **GET** /events/{eventId}/bypass | List an event\'s registration bypasses|
|[**updateEventRegistrationBypass**](#updateeventregistrationbypass) | **PUT** /events/{eventId}/bypass/{bypassId} | Update an event registration bypass|

# **createEventRegistrationBypass**
> CreateEventRegistrationBypass200Response createEventRegistrationBypass(eventRegistrationBypassCreateInputs)

Creates a registration bypass for the given event, allowing a specific account to skip normal registration requirements, and requires create permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let eventRegistrationBypassCreateInputs: EventRegistrationBypassCreateInputs; //

const { status, data } = await apiInstance.createEventRegistrationBypass(
    eventId,
    eventRegistrationBypassCreateInputs
);
```

### Parameters

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


### Return type

**CreateEventRegistrationBypass200Response**

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

# **deleteEventRegistrationBypass**
> CreateAccountInvitations200Response deleteEventRegistrationBypass()

Permanently deletes the specified registration bypass from the given event and requires delete permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let bypassId: string; //The bypass identifier (default to undefined)

const { status, data } = await apiInstance.deleteEventRegistrationBypass(
    eventId,
    bypassId
);
```

### Parameters

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

# **getEventRegistrationBypass**
> CreateEventRegistrationBypass200Response getEventRegistrationBypass()

Retrieves one registration bypass record for the given event by its ID, showing which account it grants access to and which registration restriction (closed, before start, or after end) it bypasses; requires \"read\" permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let bypassId: string; //The bypass identifier (default to undefined)

const { status, data } = await apiInstance.getEventRegistrationBypass(
    eventId,
    bypassId
);
```

### Parameters

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


### Return type

**CreateEventRegistrationBypass200Response**

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

# **getEventRegistrationBypassList**
> GetEventRegistrationBypassList200Response getEventRegistrationBypassList()

Returns a paginated list of registration bypass records for the given event, which grant specific accounts the ability to register outside normal registration windows (before opening, after closing, or while registration is disabled), supporting search by account name/email and `orderBy` sorting; requires \"read\" permission on events.

### Example

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

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

let eventId: string; //The event 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.getEventRegistrationBypassList(
    eventId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event 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

**GetEventRegistrationBypassList200Response**

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

# **updateEventRegistrationBypass**
> CreateEventRegistrationBypass200Response updateEventRegistrationBypass(eventRegistrationBypassUpdateInputs)

Updates the fields of an existing registration bypass on the given event, such as the associated account, and requires update permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let bypassId: string; //The bypass identifier (default to undefined)
let eventRegistrationBypassUpdateInputs: EventRegistrationBypassUpdateInputs; //

const { status, data } = await apiInstance.updateEventRegistrationBypass(
    eventId,
    bypassId,
    eventRegistrationBypassUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventRegistrationBypassUpdateInputs** | **EventRegistrationBypassUpdateInputs**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **bypassId** | [**string**] | The bypass identifier | defaults to undefined|


### Return type

**CreateEventRegistrationBypass200Response**

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