# EventsFaqsApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**createEventFaqSection**](#createeventfaqsection) | **POST** /events/{eventId}/faqs | Create an event FAQ section|
|[**createEventFaqSectionQuestion**](#createeventfaqsectionquestion) | **POST** /events/{eventId}/faqs/{sectionId}/questions | Add a question to an event FAQ section|
|[**deleteEventFaqSection**](#deleteeventfaqsection) | **DELETE** /events/{eventId}/faqs/{sectionId} | Delete an event FAQ section|
|[**deleteEventFaqSectionQuestion**](#deleteeventfaqsectionquestion) | **DELETE** /events/{eventId}/faqs/{sectionId}/questions/{questionId} | Delete a question from an event FAQ section|
|[**getEventFaqSection**](#geteventfaqsection) | **GET** /events/{eventId}/faqs/{sectionId} | Get an event FAQ section|
|[**getEventFaqSectionQuestion**](#geteventfaqsectionquestion) | **GET** /events/{eventId}/faqs/{sectionId}/questions/{questionId} | Get an event FAQ question|
|[**getEventFaqSectionQuestions**](#geteventfaqsectionquestions) | **GET** /events/{eventId}/faqs/{sectionId}/questions | List an event FAQ section\'s questions|
|[**getEventFaqSections**](#geteventfaqsections) | **GET** /events/{eventId}/faqs | List an event\'s FAQ sections|
|[**reorderEventFaqSectionQuestions**](#reordereventfaqsectionquestions) | **PUT** /events/{eventId}/faqs/{sectionId}/questions/reorder | Reorder questions in an event FAQ section|
|[**updateEventFaqSection**](#updateeventfaqsection) | **PUT** /events/{eventId}/faqs/{sectionId} | Update an event FAQ section|
|[**updateEventFaqSectionQuestion**](#updateeventfaqsectionquestion) | **PUT** /events/{eventId}/faqs/{sectionId}/questions/{questionId} | Update a question in an event FAQ section|

# **createEventFaqSection**
> CreateEventFaqSection200Response createEventFaqSection(eventFaqSectionCreateInputs)

Creates a new FAQ section (a grouping of questions and answers) for the given event; requires the \"update\" permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let eventFaqSectionCreateInputs: EventFaqSectionCreateInputs; //

const { status, data } = await apiInstance.createEventFaqSection(
    eventId,
    eventFaqSectionCreateInputs
);
```

### Parameters

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


### Return type

**CreateEventFaqSection200Response**

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

# **createEventFaqSectionQuestion**
> CreateEventFaqSectionQuestion200Response createEventFaqSectionQuestion(eventFaqSectionQuestionCreateInputs)

Creates a new question-and-answer entry within the specified FAQ section of an event; requires the \"update\" permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let sectionId: string; //The section identifier (default to undefined)
let eventFaqSectionQuestionCreateInputs: EventFaqSectionQuestionCreateInputs; //

const { status, data } = await apiInstance.createEventFaqSectionQuestion(
    eventId,
    sectionId,
    eventFaqSectionQuestionCreateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventFaqSectionQuestionCreateInputs** | **EventFaqSectionQuestionCreateInputs**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **sectionId** | [**string**] | The section identifier | defaults to undefined|


### Return type

**CreateEventFaqSectionQuestion200Response**

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

# **deleteEventFaqSection**
> CreateAccountInvitations200Response deleteEventFaqSection()

Permanently deletes an FAQ section, including its questions, from the given event; requires the \"update\" permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let sectionId: string; //The section identifier (default to undefined)

const { status, data } = await apiInstance.deleteEventFaqSection(
    eventId,
    sectionId
);
```

### Parameters

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

# **deleteEventFaqSectionQuestion**
> CreateAccountInvitations200Response deleteEventFaqSectionQuestion()

Permanently deletes a single question-and-answer entry from the specified FAQ section of an event; requires the \"update\" permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let sectionId: string; //The section identifier (default to undefined)
let questionId: string; //The question identifier (default to undefined)

const { status, data } = await apiInstance.deleteEventFaqSectionQuestion(
    eventId,
    sectionId,
    questionId
);
```

### Parameters

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

# **getEventFaqSection**
> CreateEventFaqSection200Response getEventFaqSection()

Returns the details of a single FAQ section belonging to an event, identified by section ID; requires read permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let sectionId: string; //The section identifier (default to undefined)

const { status, data } = await apiInstance.getEventFaqSection(
    eventId,
    sectionId
);
```

### Parameters

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


### Return type

**CreateEventFaqSection200Response**

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

# **getEventFaqSectionQuestion**
> CreateEventFaqSectionQuestion200Response getEventFaqSectionQuestion()

Returns the details of a single question within an event FAQ section, identified by question ID; requires read permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let sectionId: string; //The section identifier (default to undefined)
let questionId: string; //The question identifier (default to undefined)

const { status, data } = await apiInstance.getEventFaqSectionQuestion(
    eventId,
    sectionId,
    questionId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **sectionId** | [**string**] | The section identifier | defaults to undefined|
| **questionId** | [**string**] | The question identifier | defaults to undefined|


### Return type

**CreateEventFaqSectionQuestion200Response**

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

# **getEventFaqSectionQuestions**
> GetEventFaqSectionQuestions200Response getEventFaqSectionQuestions()

Returns a paginated list of questions belonging to a specific FAQ section of an event, supporting page, pageSize, orderBy, and search filters; requires read permission on events.

### Example

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

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

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

### Parameters

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

**GetEventFaqSectionQuestions200Response**

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

# **getEventFaqSections**
> GetEventFaqSections200Response getEventFaqSections()

Returns a paginated list of FAQ sections for the given event, supporting search and ordering; requires read permission on events.

### Example

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

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

**GetEventFaqSections200Response**

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

# **reorderEventFaqSectionQuestions**
> ReorderEventFaqSectionQuestions200Response reorderEventFaqSectionQuestions(reorderEventFaqSectionQuestionsRequest)

Updates the display order of questions within an event FAQ section by supplying the full list of question IDs in the desired order; requires the \"update\" permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let sectionId: string; //The section identifier (default to undefined)
let reorderEventFaqSectionQuestionsRequest: ReorderEventFaqSectionQuestionsRequest; //

const { status, data } = await apiInstance.reorderEventFaqSectionQuestions(
    eventId,
    sectionId,
    reorderEventFaqSectionQuestionsRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **reorderEventFaqSectionQuestionsRequest** | **ReorderEventFaqSectionQuestionsRequest**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **sectionId** | [**string**] | The section identifier | defaults to undefined|


### Return type

**ReorderEventFaqSectionQuestions200Response**

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

# **updateEventFaqSection**
> CreateEventFaqSection200Response updateEventFaqSection(eventFaqSectionUpdateInputs)

Updates the properties (such as title) of an existing FAQ section on the given event; requires the \"update\" permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let sectionId: string; //The section identifier (default to undefined)
let eventFaqSectionUpdateInputs: EventFaqSectionUpdateInputs; //

const { status, data } = await apiInstance.updateEventFaqSection(
    eventId,
    sectionId,
    eventFaqSectionUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventFaqSectionUpdateInputs** | **EventFaqSectionUpdateInputs**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **sectionId** | [**string**] | The section identifier | defaults to undefined|


### Return type

**CreateEventFaqSection200Response**

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

# **updateEventFaqSectionQuestion**
> CreateEventFaqSectionQuestion200Response updateEventFaqSectionQuestion(eventFaqSectionQuestionUpdateInputs)

Updates the question and/or answer text of an existing entry within the specified FAQ section of an event; requires the \"update\" permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let sectionId: string; //The section identifier (default to undefined)
let questionId: string; //The question identifier (default to undefined)
let eventFaqSectionQuestionUpdateInputs: EventFaqSectionQuestionUpdateInputs; //

const { status, data } = await apiInstance.updateEventFaqSectionQuestion(
    eventId,
    sectionId,
    questionId,
    eventFaqSectionQuestionUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventFaqSectionQuestionUpdateInputs** | **EventFaqSectionQuestionUpdateInputs**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **sectionId** | [**string**] | The section identifier | defaults to undefined|
| **questionId** | [**string**] | The question identifier | defaults to undefined|


### Return type

**CreateEventFaqSectionQuestion200Response**

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