@connectedxm/admin-sdk 1.0.0

package/docs/EventsFaqsApi.md

@@ -0,0 +1,658 @@
+# EventsFaqsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createEventFaqSection**](#createeventfaqsection) | **POST** /events/{eventId}/faqs | Create Event Faq Section|
+|[**createEventFaqSectionQuestion**](#createeventfaqsectionquestion) | **POST** /events/{eventId}/faqs/{sectionId}/questions | Create Event Faq Section Question|
+|[**deleteEventFaqSection**](#deleteeventfaqsection) | **DELETE** /events/{eventId}/faqs/{sectionId} | Delete Event Faq Section|
+|[**deleteEventFaqSectionQuestion**](#deleteeventfaqsectionquestion) | **DELETE** /events/{eventId}/faqs/{sectionId}/questions/{questionId} | Delete Event Faq Section Question|
+|[**getEventFaqSection**](#geteventfaqsection) | **GET** /events/{eventId}/faqs/{sectionId} | Get Event Faq Section|
+|[**getEventFaqSectionQuestion**](#geteventfaqsectionquestion) | **GET** /events/{eventId}/faqs/{sectionId}/questions/{questionId} | Get Event Faq Section Question|
+|[**getEventFaqSectionQuestions**](#geteventfaqsectionquestions) | **GET** /events/{eventId}/faqs/{sectionId}/questions | Get Event Faq Section Questions|
+|[**getEventFaqSections**](#geteventfaqsections) | **GET** /events/{eventId}/faqs | Get Event Faq Sections|
+|[**reorderEventFaqSectionQuestions**](#reordereventfaqsectionquestions) | **PUT** /events/{eventId}/faqs/{sectionId}/questions/reorder | Reorder Event Faq Section Questions|
+|[**updateEventFaqSection**](#updateeventfaqsection) | **PUT** /events/{eventId}/faqs/{sectionId} | Update Event Faq Section|
+|[**updateEventFaqSectionQuestion**](#updateeventfaqsectionquestion) | **PUT** /events/{eventId}/faqs/{sectionId}/questions/{questionId} | Update Event Faq Section Question|
+
+# **createEventFaqSection**
+> CreateEventFaqSection200Response createEventFaqSection(eventFaqSectionCreateInputs)
+
+Create Event Faq Section endpoint
+
+### 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)
+
+Create Event Faq Section Question endpoint
+
+### 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()
+
+Delete Event Faq Section endpoint
+
+### 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()
+
+Delete Event Faq Section Question endpoint
+
+### 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()
+
+Get Event Faq Section endpoint
+
+### 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()
+
+Get Event Faq Section Question endpoint
+
+### 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()
+
+Get Event Faq Section Questions endpoint
+
+### 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()
+
+Get Event Faq Sections endpoint
+
+### 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**
+> CreateAccountAddress200Response reorderEventFaqSectionQuestions()
+
+Reorder Event Faq Section Questions endpoint
+
+### 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 questionIds: Array<string>; //Filter by questionIds (default to undefined)
+
+const { status, data } = await apiInstance.reorderEventFaqSectionQuestions(
+    eventId,
+    sectionId,
+    questionIds
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sectionId** | [**string**] | The section identifier | defaults to undefined|
+| **questionIds** | **Array&lt;string&gt;** | Filter by questionIds | defaults to undefined|
+
+
+### Return type
+
+**CreateAccountAddress200Response**
+
+### 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)
+
+# **updateEventFaqSection**
+> CreateEventFaqSection200Response updateEventFaqSection()
+
+Update Event Faq Section endpoint
+
+### 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 section: EventFaqSectionUpdateInputs; //Filter by section (default to undefined)
+
+const { status, data } = await apiInstance.updateEventFaqSection(
+    eventId,
+    sectionId,
+    section
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sectionId** | [**string**] | The section identifier | defaults to undefined|
+| **section** | **EventFaqSectionUpdateInputs** | Filter by section | 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)
+
+# **updateEventFaqSectionQuestion**
+> CreateEventFaqSectionQuestion200Response updateEventFaqSectionQuestion()
+
+Update Event Faq Section Question endpoint
+
+### 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 faq: EventFaqSectionQuestionUpdateInputs; //Filter by faq (default to undefined)
+
+const { status, data } = await apiInstance.updateEventFaqSectionQuestion(
+    eventId,
+    sectionId,
+    questionId,
+    faq
+);
+```
+
+### 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|
+| **faq** | **EventFaqSectionQuestionUpdateInputs** | Filter by faq | 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)
+