@connectedxm/admin-sdk 1.0.0

package/docs/EventsTracksApi.md

@@ -0,0 +1,662 @@
+# EventsTracksApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**addEventTrackSession**](#addeventtracksession) | **POST** /events/{eventId}/tracks/{trackId}/sessions/{sessionId} | Add Event Track Session|
+|[**addEventTrackSponsor**](#addeventtracksponsor) | **POST** /events/{eventId}/tracks/{trackId}/sponsors/{sponsorId} | Add Event Track Sponsor|
+|[**createEventTrack**](#createeventtrack) | **POST** /events/{eventId}/tracks | Create Event Track|
+|[**deleteEventTrack**](#deleteeventtrack) | **DELETE** /events/{eventId}/tracks/{trackId} | Delete Event Track|
+|[**getEventTrack**](#geteventtrack) | **GET** /events/{eventId}/tracks/{trackId} | Get Event Track|
+|[**getEventTrackSessions**](#geteventtracksessions) | **GET** /events/{eventId}/tracks/{trackId}/sessions | Get Event Track Sessions|
+|[**getEventTrackSponsors**](#geteventtracksponsors) | **GET** /events/{eventId}/tracks/{trackId}/sponsors | Get Event Track Sponsors|
+|[**getEventTracks**](#geteventtracks) | **GET** /events/{eventId}/tracks | Get Event Tracks|
+|[**removeEventTrackSession**](#removeeventtracksession) | **DELETE** /events/{eventId}/tracks/{trackId}/sessions/{sessionId} | Remove Event Track Session|
+|[**removeEventTrackSponsor**](#removeeventtracksponsor) | **DELETE** /events/{eventId}/tracks/{trackId}/sponsors/{sponsorId} | Remove Event Track Sponsor|
+|[**updateEventTrack**](#updateeventtrack) | **PUT** /events/{eventId}/tracks/{trackId} | Update Event Track|
+
+# **addEventTrackSession**
+> CreateEventTrack200Response addEventTrackSession()
+
+Add Event Track Session endpoint
+
+### Example
+
+```typescript
+import {
+    EventsTracksApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsTracksApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let trackId: string; //The track identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+
+const { status, data } = await apiInstance.addEventTrackSession(
+    eventId,
+    trackId,
+    sessionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **trackId** | [**string**] | The track identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventTrack200Response**
+
+### 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)
+
+# **addEventTrackSponsor**
+> CreateEventTrack200Response addEventTrackSponsor()
+
+Add Event Track Sponsor endpoint
+
+### Example
+
+```typescript
+import {
+    EventsTracksApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsTracksApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let trackId: string; //The track identifier (default to undefined)
+let sponsorId: string; //The sponsor identifier (default to undefined)
+
+const { status, data } = await apiInstance.addEventTrackSponsor(
+    eventId,
+    trackId,
+    sponsorId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **trackId** | [**string**] | The track identifier | defaults to undefined|
+| **sponsorId** | [**string**] | The sponsor identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventTrack200Response**
+
+### 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)
+
+# **createEventTrack**
+> CreateEventTrack200Response createEventTrack(eventTrackCreateInputs)
+
+Create Event Track endpoint
+
+### Example
+
+```typescript
+import {
+    EventsTracksApi,
+    Configuration,
+    EventTrackCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsTracksApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let eventTrackCreateInputs: EventTrackCreateInputs; //
+
+const { status, data } = await apiInstance.createEventTrack(
+    eventId,
+    eventTrackCreateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventTrackCreateInputs** | **EventTrackCreateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventTrack200Response**
+
+### 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)
+
+# **deleteEventTrack**
+> CreateAccountInvitations200Response deleteEventTrack()
+
+Delete Event Track endpoint
+
+### Example
+
+```typescript
+import {
+    EventsTracksApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsTracksApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let trackId: string; //The track identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteEventTrack(
+    eventId,
+    trackId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **trackId** | [**string**] | The track 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)
+
+# **getEventTrack**
+> CreateEventTrack200Response getEventTrack()
+
+Get Event Track endpoint
+
+### Example
+
+```typescript
+import {
+    EventsTracksApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsTracksApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let trackId: string; //The track identifier (default to undefined)
+
+const { status, data } = await apiInstance.getEventTrack(
+    eventId,
+    trackId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **trackId** | [**string**] | The track identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventTrack200Response**
+
+### 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)
+
+# **getEventTrackSessions**
+> GetAccountInvitations200Response getEventTrackSessions()
+
+Get Event Track Sessions endpoint
+
+### Example
+
+```typescript
+import {
+    EventsTracksApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsTracksApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let trackId: string; //The track 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.getEventTrackSessions(
+    eventId,
+    trackId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **trackId** | [**string**] | The track 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)
+
+# **getEventTrackSponsors**
+> GetAccounts200Response getEventTrackSponsors()
+
+Get Event Track Sponsors endpoint
+
+### Example
+
+```typescript
+import {
+    EventsTracksApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsTracksApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let trackId: string; //The track 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.getEventTrackSponsors(
+    eventId,
+    trackId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **trackId** | [**string**] | The track 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
+
+**GetAccounts200Response**
+
+### 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)
+
+# **getEventTracks**
+> GetEventSessionTracks200Response getEventTracks()
+
+Get Event Tracks endpoint
+
+### Example
+
+```typescript
+import {
+    EventsTracksApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsTracksApi(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.getEventTracks(
+    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
+
+**GetEventSessionTracks200Response**
+
+### 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)
+
+# **removeEventTrackSession**
+> CreateEventTrack200Response removeEventTrackSession()
+
+Remove Event Track Session endpoint
+
+### Example
+
+```typescript
+import {
+    EventsTracksApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsTracksApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let trackId: string; //The track identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+
+const { status, data } = await apiInstance.removeEventTrackSession(
+    eventId,
+    trackId,
+    sessionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **trackId** | [**string**] | The track identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventTrack200Response**
+
+### 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)
+
+# **removeEventTrackSponsor**
+> CreateEventTrack200Response removeEventTrackSponsor()
+
+Remove Event Track Sponsor endpoint
+
+### Example
+
+```typescript
+import {
+    EventsTracksApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsTracksApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let trackId: string; //The track identifier (default to undefined)
+let sponsorId: string; //The sponsor identifier (default to undefined)
+
+const { status, data } = await apiInstance.removeEventTrackSponsor(
+    eventId,
+    trackId,
+    sponsorId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **trackId** | [**string**] | The track identifier | defaults to undefined|
+| **sponsorId** | [**string**] | The sponsor identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventTrack200Response**
+
+### 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)
+
+# **updateEventTrack**
+> CreateEventTrack200Response updateEventTrack(eventTrackUpdateInputs)
+
+Update Event Track endpoint
+
+### Example
+
+```typescript
+import {
+    EventsTracksApi,
+    Configuration,
+    EventTrackUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsTracksApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let trackId: string; //The track identifier (default to undefined)
+let eventTrackUpdateInputs: EventTrackUpdateInputs; //
+
+const { status, data } = await apiInstance.updateEventTrack(
+    eventId,
+    trackId,
+    eventTrackUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventTrackUpdateInputs** | **EventTrackUpdateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **trackId** | [**string**] | The track identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventTrack200Response**
+
+### 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)
+

package/docs/ExportStatus.md

@@ -0,0 +1,12 @@
+# ExportStatus
+
+
+## Enum
+
+* `Pending` (value: `'pending'`)
+
+* `Resolved` (value: `'resolved'`)
+
+* `Failed` (value: `'failed'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Faq.md

@@ -0,0 +1,32 @@
+# Faq
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**priority** | **number** |  | [default to undefined]
+**organizationId** | **string** |  | [default to undefined]
+**eventId** | **string** |  | [default to undefined]
+**sectionId** | **string** |  | [default to undefined]
+**section** | [**BaseFaqSection**](BaseFaqSection.md) |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Faq } from '@connectedxm/admin-sdk';
+
+const instance: Faq = {
+    priority,
+    organizationId,
+    eventId,
+    sectionId,
+    section,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)