# EventsBlocksApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**addEventBlockSession**](#addeventblocksession) | **POST** /events/{eventId}/blocks/{blockId}/sessions/{sessionId} | Add a session to an event block|
|[**createEventBlock**](#createeventblock) | **POST** /events/{eventId}/blocks | Create an event schedule block|
|[**deleteEventBlock**](#deleteeventblock) | **DELETE** /events/{eventId}/blocks/{blockId} | Delete an event schedule block|
|[**getEventBlock**](#geteventblock) | **GET** /events/{eventId}/blocks/{blockId} | Get an event schedule block|
|[**getEventBlockSessions**](#geteventblocksessions) | **GET** /events/{eventId}/blocks/{blockId}/sessions | List sessions in an event block|
|[**getEventBlocks**](#geteventblocks) | **GET** /events/{eventId}/blocks | List an event\'s agenda blocks|
|[**removeEventBlockSession**](#removeeventblocksession) | **DELETE** /events/{eventId}/blocks/{blockId}/sessions/{sessionId} | Remove a session from an event block|
|[**updateEventBlock**](#updateeventblock) | **PUT** /events/{eventId}/blocks/{blockId} | Update an event schedule block|

# **addEventBlockSession**
> CreateEventBlock200Response addEventBlockSession()

Adds the specified session to the given block (a schedule grouping of selectable sessions) on the given event; requires the \"update\" permission on events.

### Example

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

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

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

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

### Parameters

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


### Return type

**CreateEventBlock200Response**

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

# **createEventBlock**
> CreateEventBlock200Response createEventBlock(eventBlockCreateInputs)

Creates a new schedule block (a grouping of sessions, such as a day or track segment) for the given event and requires update permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let eventBlockCreateInputs: EventBlockCreateInputs; //

const { status, data } = await apiInstance.createEventBlock(
    eventId,
    eventBlockCreateInputs
);
```

### Parameters

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


### Return type

**CreateEventBlock200Response**

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

# **deleteEventBlock**
> CreateAccountInvitations200Response deleteEventBlock()

Permanently deletes the specified schedule block from the given event and requires update permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let blockId: string; //The block identifier (default to undefined)

const { status, data } = await apiInstance.deleteEventBlock(
    eventId,
    blockId
);
```

### Parameters

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

# **getEventBlock**
> CreateEventBlock200Response getEventBlock()

Returns a single schedule block (a grouping used to organize sessions) belonging to the given event; requires \"read\" permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let blockId: string; //The block identifier (default to undefined)

const { status, data } = await apiInstance.getEventBlock(
    eventId,
    blockId
);
```

### Parameters

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


### Return type

**CreateEventBlock200Response**

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

# **getEventBlockSessions**
> GetEventActivationSessions200Response getEventBlockSessions()

Returns a paginated list of the sessions assigned to a specific agenda block on the given event, supporting search and `orderBy` sorting; requires \"read\" permission on events.

### Example

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

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

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

### Parameters

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

**GetEventActivationSessions200Response**

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

# **getEventBlocks**
> GetEventBlocks200Response getEventBlocks()

Returns a paginated list of the blocks (agenda groupings used to organize sessions) defined for the given event, supporting search and `orderBy` sorting; requires \"read\" permission on events.

### Example

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

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

**GetEventBlocks200Response**

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

# **removeEventBlockSession**
> CreateEventBlock200Response removeEventBlockSession()

Disconnects the specified session from the given event schedule block without deleting the session itself, and requires update permission on events.

### Example

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

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

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

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

### Parameters

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


### Return type

**CreateEventBlock200Response**

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

# **updateEventBlock**
> CreateEventBlock200Response updateEventBlock(eventBlockUpdateInputs)

Updates the fields of an existing schedule block on the given event, such as its name or image, and requires update permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let blockId: string; //The block identifier (default to undefined)
let eventBlockUpdateInputs: EventBlockUpdateInputs; //

const { status, data } = await apiInstance.updateEventBlock(
    eventId,
    blockId,
    eventBlockUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventBlockUpdateInputs** | **EventBlockUpdateInputs**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **blockId** | [**string**] | The block identifier | defaults to undefined|


### Return type

**CreateEventBlock200Response**

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