@connectedxm/admin-sdk 1.0.0

package/docs/EventsSessionsSectionsApi.md

@@ -0,0 +1,628 @@
+# EventsSessionsSectionsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**addEventSessionSectionQuestion**](#addeventsessionsectionquestion) | **POST** /events/{eventId}/sessions/{sessionId}/sections/{sectionId}/questions/{questionId} | Add Event Session Section Question|
+|[**createEventSessionSection**](#createeventsessionsection) | **POST** /events/{eventId}/sessions/{sessionId}/sections | Create Event Session Section|
+|[**deleteEventSessionSection**](#deleteeventsessionsection) | **DELETE** /events/{eventId}/sessions/{sessionId}/sections/{sectionId} | Delete Event Session Section|
+|[**getEventSessionSection**](#geteventsessionsection) | **GET** /events/{eventId}/sessions/{sessionId}/sections/{sectionId} | Get Event Session Section|
+|[**getEventSessionSectionQuestions**](#geteventsessionsectionquestions) | **GET** /events/{eventId}/sessions/{sessionId}/sections/{sectionId}/questions | Get Event Session Section Questions|
+|[**getEventSessionSections**](#geteventsessionsections) | **GET** /events/{eventId}/sessions/{sessionId}/sections | Get Event Session Sections|
+|[**removeEventSessionSectionQuestion**](#removeeventsessionsectionquestion) | **DELETE** /events/{eventId}/sessions/{sessionId}/sections/{sectionId}/questions/{questionId} | Remove Event Session Section Question|
+|[**reorderEventSessionSectionQuestions**](#reordereventsessionsectionquestions) | **PUT** /events/{eventId}/sessions/{sessionId}/sections/{sectionId}/questions/reorder | Reorder Event Session Section Questions|
+|[**updateEventSessionSection**](#updateeventsessionsection) | **PUT** /events/{eventId}/sessions/{sessionId}/sections/{sectionId} | Update Event Session Section|
+|[**updateEventSessionSectionQuestion**](#updateeventsessionsectionquestion) | **PUT** /events/{eventId}/sessions/{sessionId}/sections/{sectionId}/questions/{questionId} | Update Event Session Section Question|
+
+# **addEventSessionSectionQuestion**
+> CreateAccountAddress200Response addEventSessionSectionQuestion()
+
+Add Event Session Section Question endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsSectionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsSectionsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session 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.addEventSessionSectionQuestion(
+    eventId,
+    sessionId,
+    sectionId,
+    questionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+| **sectionId** | [**string**] | The section identifier | defaults to undefined|
+| **questionId** | [**string**] | The question identifier | 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)
+
+# **createEventSessionSection**
+> CreateAccountAddress200Response createEventSessionSection(eventSessionSectionCreateInputs)
+
+Create Event Session Section endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsSectionsApi,
+    Configuration,
+    EventSessionSectionCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsSectionsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+let eventSessionSectionCreateInputs: EventSessionSectionCreateInputs; //
+
+const { status, data } = await apiInstance.createEventSessionSection(
+    eventId,
+    sessionId,
+    eventSessionSectionCreateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventSessionSectionCreateInputs** | **EventSessionSectionCreateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateAccountAddress200Response**
+
+### 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)
+
+# **deleteEventSessionSection**
+> CreateAccountInvitations200Response deleteEventSessionSection()
+
+Delete Event Session Section endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsSectionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsSectionsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+let sectionId: string; //The section identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteEventSessionSection(
+    eventId,
+    sessionId,
+    sectionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session 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)
+
+# **getEventSessionSection**
+> CreateAccountAddress200Response getEventSessionSection()
+
+Get Event Session Section endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsSectionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsSectionsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+let sectionId: string; //The section identifier (default to undefined)
+
+const { status, data } = await apiInstance.getEventSessionSection(
+    eventId,
+    sessionId,
+    sectionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+| **sectionId** | [**string**] | The section identifier | 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)
+
+# **getEventSessionSectionQuestions**
+> GetAccountInvitations200Response getEventSessionSectionQuestions()
+
+Get Event Session Section Questions endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsSectionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsSectionsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session 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.getEventSessionSectionQuestions(
+    eventId,
+    sessionId,
+    sectionId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session 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
+
+**GetAccountInvitations200Response**
+
+### 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)
+
+# **getEventSessionSections**
+> GetAccountInvitations200Response getEventSessionSections()
+
+Get Event Session Sections endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsSectionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsSectionsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session 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.getEventSessionSections(
+    eventId,
+    sessionId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session 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
+
+**GetAccountInvitations200Response**
+
+### 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)
+
+# **removeEventSessionSectionQuestion**
+> CreateAccountAddress200Response removeEventSessionSectionQuestion()
+
+Remove Event Session Section Question endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsSectionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsSectionsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session 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.removeEventSessionSectionQuestion(
+    eventId,
+    sessionId,
+    sectionId,
+    questionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+| **sectionId** | [**string**] | The section identifier | defaults to undefined|
+| **questionId** | [**string**] | The question identifier | 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)
+
+# **reorderEventSessionSectionQuestions**
+> CreateAccountAddress200Response reorderEventSessionSectionQuestions()
+
+Reorder Event Session Section Questions endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsSectionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsSectionsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session 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.reorderEventSessionSectionQuestions(
+    eventId,
+    sessionId,
+    sectionId,
+    questionIds
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session 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)
+
+# **updateEventSessionSection**
+> CreateAccountAddress200Response updateEventSessionSection()
+
+Update Event Session Section endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsSectionsApi,
+    Configuration,
+    EventSessionSectionUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsSectionsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+let sectionId: string; //The section identifier (default to undefined)
+let section: EventSessionSectionUpdateInputs; //Filter by section (default to undefined)
+
+const { status, data } = await apiInstance.updateEventSessionSection(
+    eventId,
+    sessionId,
+    sectionId,
+    section
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+| **sectionId** | [**string**] | The section identifier | defaults to undefined|
+| **section** | **EventSessionSectionUpdateInputs** | Filter by section | 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)
+
+# **updateEventSessionSectionQuestion**
+> CreateAccountAddress200Response updateEventSessionSectionQuestion()
+
+Update Event Session Section Question endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsSectionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsSectionsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+let sectionId: string; //The section identifier (default to undefined)
+let questionId: string; //The question identifier (default to undefined)
+let sortOrder: number; //Filter by sortOrder (default to undefined)
+
+const { status, data } = await apiInstance.updateEventSessionSectionQuestion(
+    eventId,
+    sessionId,
+    sectionId,
+    questionId,
+    sortOrder
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+| **sectionId** | [**string**] | The section identifier | defaults to undefined|
+| **questionId** | [**string**] | The question identifier | defaults to undefined|
+| **sortOrder** | [**number**] | Filter by sortOrder | 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)
+