@connectedxm/admin-sdk 1.0.0

package/docs/StreamsSessionsApi.md

@@ -0,0 +1,364 @@
+# StreamsSessionsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**closeStreamSession**](#closestreamsession) | **PUT** /streams/{streamId}/sessions/{sessionId}/close | Close Stream Session|
+|[**exportStreamSession**](#exportstreamsession) | **POST** /streams/{streamId}/sessions/{sessionId}/export | Export Stream Session|
+|[**getStreamSession**](#getstreamsession) | **GET** /streams/{streamId}/sessions/{sessionId} | Get Stream Session|
+|[**getStreamSessionChat**](#getstreamsessionchat) | **GET** /streams/{streamId}/sessions/{sessionId}/chat | Get Stream Session Chat|
+|[**getStreamSessionSubscriptions**](#getstreamsessionsubscriptions) | **GET** /streams/{streamId}/sessions/{sessionId}/subscriptions | Get Stream Session Subscriptions|
+|[**getStreamSessions**](#getstreamsessions) | **GET** /streams/{streamId}/sessions | Get Stream Sessions|
+
+# **closeStreamSession**
+> CreateAccountInvitations200Response closeStreamSession()
+
+Close Stream Session endpoint
+
+### Example
+
+```typescript
+import {
+    StreamsSessionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StreamsSessionsApi(configuration);
+
+let streamId: string; //The stream identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+
+const { status, data } = await apiInstance.closeStreamSession(
+    streamId,
+    sessionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **streamId** | [**string**] | The stream identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session 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)
+
+# **exportStreamSession**
+> CreateAccountInvitations200Response exportStreamSession()
+
+Export Stream Session endpoint
+
+### Example
+
+```typescript
+import {
+    StreamsSessionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StreamsSessionsApi(configuration);
+
+let streamId: string; //The stream identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+
+const { status, data } = await apiInstance.exportStreamSession(
+    streamId,
+    sessionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **streamId** | [**string**] | The stream identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session 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)
+
+# **getStreamSession**
+> GetStreamSession200Response getStreamSession()
+
+Get Stream Session endpoint
+
+### Example
+
+```typescript
+import {
+    StreamsSessionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StreamsSessionsApi(configuration);
+
+let streamId: string; //The stream identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+
+const { status, data } = await apiInstance.getStreamSession(
+    streamId,
+    sessionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **streamId** | [**string**] | The stream identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+
+
+### Return type
+
+**GetStreamSession200Response**
+
+### 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)
+
+# **getStreamSessionChat**
+> CreateAccountAddress200Response getStreamSessionChat()
+
+Get Stream Session Chat endpoint
+
+### Example
+
+```typescript
+import {
+    StreamsSessionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StreamsSessionsApi(configuration);
+
+let streamId: string; //The stream identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+
+const { status, data } = await apiInstance.getStreamSessionChat(
+    streamId,
+    sessionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **streamId** | [**string**] | The stream 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**: 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)
+
+# **getStreamSessionSubscriptions**
+> GetAccountInvitations200Response getStreamSessionSubscriptions()
+
+Get Stream Session Subscriptions endpoint
+
+### Example
+
+```typescript
+import {
+    StreamsSessionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StreamsSessionsApi(configuration);
+
+let streamId: string; //The stream identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+let active: boolean; //Filter by active (optional) (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.getStreamSessionSubscriptions(
+    streamId,
+    sessionId,
+    active,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **streamId** | [**string**] | The stream identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+| **active** | [**boolean**] | Filter by active | (optional) 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)
+
+# **getStreamSessions**
+> GetStreamSessions200Response getStreamSessions()
+
+Get Stream Sessions endpoint
+
+### Example
+
+```typescript
+import {
+    StreamsSessionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StreamsSessionsApi(configuration);
+
+let streamId: string; //The stream identifier (default to undefined)
+let status: string; //Filter by status (optional) (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.getStreamSessions(
+    streamId,
+    status,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **streamId** | [**string**] | The stream identifier | defaults to undefined|
+| **status** | [**string**] | Filter by status | (optional) 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
+
+**GetStreamSessions200Response**
+
+### 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)
+

package/docs/StripeActivationFormParams.md

@@ -0,0 +1,26 @@
+# StripeActivationFormParams
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**clientPublicKey** | **string** |  | [default to undefined]
+**clientSecret** | **string** |  | [default to undefined]
+**currencyCode** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { StripeActivationFormParams } from '@connectedxm/admin-sdk';
+
+const instance: StripeActivationFormParams = {
+    clientPublicKey,
+    clientSecret,
+    currencyCode,
+    name,
+};
+```
+
+[[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/SummaryData.md

@@ -0,0 +1,26 @@
+# SummaryData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** |  | [default to undefined]
+**data** | **string** |  | [default to undefined]
+**count** | **number** |  | [default to undefined]
+**question** | [**RegistrationQuestion**](RegistrationQuestion.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SummaryData } from '@connectedxm/admin-sdk';
+
+const instance: SummaryData = {
+    type,
+    data,
+    count,
+    question,
+};
+```
+
+[[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/SupportApi.md

@@ -0,0 +1,168 @@
+# SupportApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createSupportTicket**](#createsupportticket) | **POST** /supportTickets | Create Support Ticket|
+|[**deleteSupportTicket**](#deletesupportticket) | **DELETE** /supportTickets/{supportTicketId} | Delete Support Ticket|
+|[**updateSupportTicket**](#updatesupportticket) | **PUT** /supportTickets/{supportTicketId} | Update Support Ticket|
+
+# **createSupportTicket**
+> CreateSupportTicket200Response createSupportTicket(supportTicketCreateInputs)
+
+Create Support Ticket endpoint
+
+### Example
+
+```typescript
+import {
+    SupportApi,
+    Configuration,
+    SupportTicketCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SupportApi(configuration);
+
+let supportTicketCreateInputs: SupportTicketCreateInputs; //
+
+const { status, data } = await apiInstance.createSupportTicket(
+    supportTicketCreateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **supportTicketCreateInputs** | **SupportTicketCreateInputs**|  | |
+
+
+### Return type
+
+**CreateSupportTicket200Response**
+
+### 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)
+
+# **deleteSupportTicket**
+> CreateAccountInvitations200Response deleteSupportTicket()
+
+Delete Support Ticket endpoint
+
+### Example
+
+```typescript
+import {
+    SupportApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SupportApi(configuration);
+
+let supportTicketId: string; //The supportTicket identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteSupportTicket(
+    supportTicketId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **supportTicketId** | [**string**] | The supportTicket 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)
+
+# **updateSupportTicket**
+> CreateSupportTicket200Response updateSupportTicket(supportTicketUpdateInputs)
+
+Update Support Ticket endpoint
+
+### Example
+
+```typescript
+import {
+    SupportApi,
+    Configuration,
+    SupportTicketUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SupportApi(configuration);
+
+let supportTicketId: string; //The supportTicket identifier (default to undefined)
+let supportTicketUpdateInputs: SupportTicketUpdateInputs; //
+
+const { status, data } = await apiInstance.updateSupportTicket(
+    supportTicketId,
+    supportTicketUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **supportTicketUpdateInputs** | **SupportTicketUpdateInputs**|  | |
+| **supportTicketId** | [**string**] | The supportTicket identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateSupportTicket200Response**
+
+### 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/SupportMessagesApi.md

@@ -0,0 +1,63 @@
+# SupportMessagesApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createSupportTicketMessage**](#createsupportticketmessage) | **POST** /supportTickets/{supportTicketId}/messages | Create Support Ticket Message|
+
+# **createSupportTicketMessage**
+> CreateAccountAddress200Response createSupportTicketMessage(supportTicketMessageCreateInputs)
+
+Create Support Ticket Message endpoint
+
+### Example
+
+```typescript
+import {
+    SupportMessagesApi,
+    Configuration,
+    SupportTicketMessageCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SupportMessagesApi(configuration);
+
+let supportTicketId: string; //The supportTicket identifier (default to undefined)
+let supportTicketMessageCreateInputs: SupportTicketMessageCreateInputs; //
+
+const { status, data } = await apiInstance.createSupportTicketMessage(
+    supportTicketId,
+    supportTicketMessageCreateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **supportTicketMessageCreateInputs** | **SupportTicketMessageCreateInputs**|  | |
+| **supportTicketId** | [**string**] | The supportTicket 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)
+