@connectedxm/admin-sdk 6.20.0 → 6.24.2

package/docs/EventsSessionsTimesApi.md

@@ -0,0 +1,503 @@
+# EventsSessionsTimesApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**addEventSessionTimeSpeaker**](#addeventsessiontimespeaker) | **POST** /events/{eventId}/sessions/{sessionId}/times/{timeId}/speakers/{speakerId} | Add Event Session Time Speaker|
+|[**createEventSessionTime**](#createeventsessiontime) | **POST** /events/{eventId}/sessions/{sessionId}/times | Create Event Session Time|
+|[**deleteEventSessionTime**](#deleteeventsessiontime) | **DELETE** /events/{eventId}/sessions/{sessionId}/times/{timeId} | Delete Event Session Time|
+|[**getEventSessionTime**](#geteventsessiontime) | **GET** /events/{eventId}/sessions/{sessionId}/times/{timeId} | Get Event Session Time|
+|[**getEventSessionTimeSpeakers**](#geteventsessiontimespeakers) | **GET** /events/{eventId}/sessions/{sessionId}/times/{timeId}/speakers | Get Event Session Time Speakers|
+|[**getEventSessionTimes**](#geteventsessiontimes) | **GET** /events/{eventId}/sessions/{sessionId}/times | Get Event Session Times|
+|[**removeEventSessionTimeSpeaker**](#removeeventsessiontimespeaker) | **DELETE** /events/{eventId}/sessions/{sessionId}/times/{timeId}/speakers/{speakerId} | Remove Event Session Time Speaker|
+|[**updateEventSessionTime**](#updateeventsessiontime) | **PUT** /events/{eventId}/sessions/{sessionId}/times/{timeId} | Update Event Session Time|
+
+# **addEventSessionTimeSpeaker**
+> CreateEventSessionTime200Response addEventSessionTimeSpeaker()
+
+Add Event Session Time Speaker endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsTimesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsTimesApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+let timeId: string; //The time identifier (default to undefined)
+let speakerId: string; //The speaker identifier (default to undefined)
+
+const { status, data } = await apiInstance.addEventSessionTimeSpeaker(
+    eventId,
+    sessionId,
+    timeId,
+    speakerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+| **timeId** | [**string**] | The time identifier | defaults to undefined|
+| **speakerId** | [**string**] | The speaker identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventSessionTime200Response**
+
+### 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)
+
+# **createEventSessionTime**
+> CreateEventSessionTime200Response createEventSessionTime(eventSessionTimeCreateInputs)
+
+Create Event Session Time endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsTimesApi,
+    Configuration,
+    EventSessionTimeCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsTimesApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+let eventSessionTimeCreateInputs: EventSessionTimeCreateInputs; //
+
+const { status, data } = await apiInstance.createEventSessionTime(
+    eventId,
+    sessionId,
+    eventSessionTimeCreateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventSessionTimeCreateInputs** | **EventSessionTimeCreateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventSessionTime200Response**
+
+### 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)
+
+# **deleteEventSessionTime**
+> UpdateAnnouncementTranslation200Response deleteEventSessionTime()
+
+Delete Event Session Time endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsTimesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsTimesApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+let timeId: string; //The time identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteEventSessionTime(
+    eventId,
+    sessionId,
+    timeId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+| **timeId** | [**string**] | The time identifier | defaults to undefined|
+
+
+### Return type
+
+**UpdateAnnouncementTranslation200Response**
+
+### 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)
+
+# **getEventSessionTime**
+> CreateEventSessionTime200Response getEventSessionTime()
+
+Get Event Session Time endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsTimesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsTimesApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+let timeId: string; //The time identifier (default to undefined)
+
+const { status, data } = await apiInstance.getEventSessionTime(
+    eventId,
+    sessionId,
+    timeId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+| **timeId** | [**string**] | The time identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventSessionTime200Response**
+
+### 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)
+
+# **getEventSessionTimeSpeakers**
+> GetEventSessionSpeakers200Response getEventSessionTimeSpeakers()
+
+Get Event Session Time Speakers endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsTimesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsTimesApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+let timeId: string; //The time 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.getEventSessionTimeSpeakers(
+    eventId,
+    sessionId,
+    timeId,
+    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|
+| **timeId** | [**string**] | The time 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
+
+**GetEventSessionSpeakers200Response**
+
+### 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)
+
+# **getEventSessionTimes**
+> GetEventSessionTimes200Response getEventSessionTimes()
+
+Get Event Session Times endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsTimesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsTimesApi(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.getEventSessionTimes(
+    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
+
+**GetEventSessionTimes200Response**
+
+### 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)
+
+# **removeEventSessionTimeSpeaker**
+> CreateEventSessionTime200Response removeEventSessionTimeSpeaker()
+
+Remove Event Session Time Speaker endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsTimesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsTimesApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+let timeId: string; //The time identifier (default to undefined)
+let speakerId: string; //The speaker identifier (default to undefined)
+
+const { status, data } = await apiInstance.removeEventSessionTimeSpeaker(
+    eventId,
+    sessionId,
+    timeId,
+    speakerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+| **timeId** | [**string**] | The time identifier | defaults to undefined|
+| **speakerId** | [**string**] | The speaker identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventSessionTime200Response**
+
+### 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)
+
+# **updateEventSessionTime**
+> CreateEventSessionTime200Response updateEventSessionTime(eventSessionTimeUpdateInputs)
+
+Update Event Session Time endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSessionsTimesApi,
+    Configuration,
+    EventSessionTimeUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSessionsTimesApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+let timeId: string; //The time identifier (default to undefined)
+let eventSessionTimeUpdateInputs: EventSessionTimeUpdateInputs; //
+
+const { status, data } = await apiInstance.updateEventSessionTime(
+    eventId,
+    sessionId,
+    timeId,
+    eventSessionTimeUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventSessionTimeUpdateInputs** | **EventSessionTimeUpdateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+| **timeId** | [**string**] | The time identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventSessionTime200Response**
+
+### 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)
+