# EventsPagesApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**addEventPageImage**](#addeventpageimage) | **POST** /events/{eventId}/pages/{pageId}/images/{imageId} | Add an image to an event page|
|[**createEventPage**](#createeventpage) | **POST** /events/{eventId}/pages | Create an event page|
|[**deleteEventPage**](#deleteeventpage) | **DELETE** /events/{eventId}/pages/{pageId} | Delete an event page|
|[**getEventPage**](#geteventpage) | **GET** /events/{eventId}/pages/{pageId} | Get an event page|
|[**getEventPageImages**](#geteventpageimages) | **GET** /events/{eventId}/pages/{pageId}/images | List an event page\'s images|
|[**getEventPages**](#geteventpages) | **GET** /events/{eventId}/pages | List an event\'s pages|
|[**removeEventPageImage**](#removeeventpageimage) | **DELETE** /events/{eventId}/pages/{pageId}/images/{imageId} | Remove an image from an event page|
|[**updateEventPage**](#updateeventpage) | **PUT** /events/{eventId}/pages/{pageId} | Update an event page|

# **addEventPageImage**
> CreateEventPage200Response addEventPageImage()

Attaches an existing image to an event page\'s image gallery, requiring update permission on both events and storage.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let pageId: string; //The page identifier (default to undefined)
let imageId: string; //The image identifier (default to undefined)

const { status, data } = await apiInstance.addEventPageImage(
    eventId,
    pageId,
    imageId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **pageId** | [**string**] | The page identifier | defaults to undefined|
| **imageId** | [**string**] | The image identifier | defaults to undefined|


### Return type

**CreateEventPage200Response**

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

# **createEventPage**
> CreateEventPage200Response createEventPage(eventPageCreateInputs)

Creates a new custom content page for an event, assigning it a slug and sort order, and requires create permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let eventPageCreateInputs: EventPageCreateInputs; //

const { status, data } = await apiInstance.createEventPage(
    eventId,
    eventPageCreateInputs
);
```

### Parameters

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


### Return type

**CreateEventPage200Response**

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

# **deleteEventPage**
> CreateAccountInvitations200Response deleteEventPage()

Deletes a custom content page from an event and re-sequences the sort order of the event\'s remaining pages, requiring update permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let pageId: string; //The page identifier (default to undefined)

const { status, data } = await apiInstance.deleteEventPage(
    eventId,
    pageId
);
```

### Parameters

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

# **getEventPage**
> CreateEventPage200Response getEventPage()

Retrieves the details of a single page belonging to the specified event by its page ID; requires the \"read\" permission on the \"events\" module.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let pageId: string; //The page identifier (default to undefined)

const { status, data } = await apiInstance.getEventPage(
    eventId,
    pageId
);
```

### Parameters

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


### Return type

**CreateEventPage200Response**

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

# **getEventPageImages**
> GetEventPageImages200Response getEventPageImages()

Returns a paginated list of images attached to the specified event page, supporting search and sorting; requires the \"read\" permission on both the \"events\" and \"storage\" modules.

### Example

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

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

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

### Parameters

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

**GetEventPageImages200Response**

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

# **getEventPages**
> GetEventPages200Response getEventPages()

Returns a paginated list of custom pages belonging to the specified event, supporting search and sorting; requires the \"read\" permission on the \"events\" module.

### Example

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

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

**GetEventPages200Response**

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

# **removeEventPageImage**
> CreateEventPage200Response removeEventPageImage()

Detaches an image from an event page\'s image gallery without deleting the underlying image, requiring update permission on both events and storage.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let pageId: string; //The page identifier (default to undefined)
let imageId: string; //The image identifier (default to undefined)

const { status, data } = await apiInstance.removeEventPageImage(
    eventId,
    pageId,
    imageId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **pageId** | [**string**] | The page identifier | defaults to undefined|
| **imageId** | [**string**] | The image identifier | defaults to undefined|


### Return type

**CreateEventPage200Response**

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

# **updateEventPage**
> CreateEventPage200Response updateEventPage(eventPageUpdateInputs)

Updates the content, title, or sort order of an existing custom event page, re-sequencing other pages when the sort order changes, and requires update permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let pageId: string; //The page identifier (default to undefined)
let eventPageUpdateInputs: EventPageUpdateInputs; //

const { status, data } = await apiInstance.updateEventPage(
    eventId,
    pageId,
    eventPageUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventPageUpdateInputs** | **EventPageUpdateInputs**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **pageId** | [**string**] | The page identifier | defaults to undefined|


### Return type

**CreateEventPage200Response**

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