@connectedxm/admin-sdk 1.0.0

package/docs/ThreadsMessagesApi.md

@@ -0,0 +1,339 @@
+# ThreadsMessagesApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createThreadMessage**](#createthreadmessage) | **POST** /threads/{threadId}/messages | Create Thread Message|
+|[**deleteThreadMessage**](#deletethreadmessage) | **DELETE** /threads/{threadId}/messages/{messageId} | Delete Thread Message|
+|[**getThreadMessage**](#getthreadmessage) | **GET** /threads/{threadId}/messages/{messageId} | Get Thread Message|
+|[**getThreadMessages**](#getthreadmessages) | **GET** /threads/{threadId}/messages | Get Thread Messages|
+|[**getThreadMessagesPoll**](#getthreadmessagespoll) | **GET** /threads/{threadId}/messages/poll | Get Thread Messages Poll|
+|[**updateThreadMessage**](#updatethreadmessage) | **PUT** /threads/{threadId}/messages/{messageId} | Update Thread Message|
+
+# **createThreadMessage**
+> CreateThreadMessage200Response createThreadMessage(threadMessageCreateInputs)
+
+Create Thread Message endpoint
+
+### Example
+
+```typescript
+import {
+    ThreadsMessagesApi,
+    Configuration,
+    ThreadMessageCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ThreadsMessagesApi(configuration);
+
+let threadId: string; //The thread identifier (default to undefined)
+let threadMessageCreateInputs: ThreadMessageCreateInputs; //
+
+const { status, data } = await apiInstance.createThreadMessage(
+    threadId,
+    threadMessageCreateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **threadMessageCreateInputs** | **ThreadMessageCreateInputs**|  | |
+| **threadId** | [**string**] | The thread identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateThreadMessage200Response**
+
+### 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)
+
+# **deleteThreadMessage**
+> CreateThreadMessage200Response deleteThreadMessage()
+
+Delete Thread Message endpoint
+
+### Example
+
+```typescript
+import {
+    ThreadsMessagesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ThreadsMessagesApi(configuration);
+
+let threadId: string; //The thread identifier (default to undefined)
+let messageId: string; //The message identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteThreadMessage(
+    threadId,
+    messageId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **threadId** | [**string**] | The thread identifier | defaults to undefined|
+| **messageId** | [**string**] | The message identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateThreadMessage200Response**
+
+### 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)
+
+# **getThreadMessage**
+> CreateThreadMessage200Response getThreadMessage()
+
+Get Thread Message endpoint
+
+### Example
+
+```typescript
+import {
+    ThreadsMessagesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ThreadsMessagesApi(configuration);
+
+let threadId: string; //The thread identifier (default to undefined)
+let messageId: string; //The message identifier (default to undefined)
+
+const { status, data } = await apiInstance.getThreadMessage(
+    threadId,
+    messageId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **threadId** | [**string**] | The thread identifier | defaults to undefined|
+| **messageId** | [**string**] | The message identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateThreadMessage200Response**
+
+### 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)
+
+# **getThreadMessages**
+> GetThreadMessages200Response getThreadMessages()
+
+Get Thread Messages endpoint
+
+### Example
+
+```typescript
+import {
+    ThreadsMessagesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ThreadsMessagesApi(configuration);
+
+let threadId: string; //The thread identifier (default to undefined)
+
+const { status, data } = await apiInstance.getThreadMessages(
+    threadId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **threadId** | [**string**] | The thread identifier | defaults to undefined|
+
+
+### Return type
+
+**GetThreadMessages200Response**
+
+### 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)
+
+# **getThreadMessagesPoll**
+> CreateAccountAddress200Response getThreadMessagesPoll()
+
+Get Thread Messages Poll endpoint
+
+### Example
+
+```typescript
+import {
+    ThreadsMessagesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ThreadsMessagesApi(configuration);
+
+let threadId: string; //The thread identifier (default to undefined)
+let lastMessageId: string; //Filter by lastMessageId (default to undefined)
+
+const { status, data } = await apiInstance.getThreadMessagesPoll(
+    threadId,
+    lastMessageId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **threadId** | [**string**] | The thread identifier | defaults to undefined|
+| **lastMessageId** | [**string**] | Filter by lastMessageId | 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)
+
+# **updateThreadMessage**
+> CreateThreadMessage200Response updateThreadMessage(threadMessageUpdateInputs)
+
+Update Thread Message endpoint
+
+### Example
+
+```typescript
+import {
+    ThreadsMessagesApi,
+    Configuration,
+    ThreadMessageUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ThreadsMessagesApi(configuration);
+
+let threadId: string; //The thread identifier (default to undefined)
+let messageId: string; //The message identifier (default to undefined)
+let threadMessageUpdateInputs: ThreadMessageUpdateInputs; //
+
+const { status, data } = await apiInstance.updateThreadMessage(
+    threadId,
+    messageId,
+    threadMessageUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **threadMessageUpdateInputs** | **ThreadMessageUpdateInputs**|  | |
+| **threadId** | [**string**] | The thread identifier | defaults to undefined|
+| **messageId** | [**string**] | The message identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateThreadMessage200Response**
+
+### 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/ThreadsMessagesFilesApi.md

@@ -0,0 +1,178 @@
+# ThreadsMessagesFilesApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createThreadMessageFile**](#createthreadmessagefile) | **POST** /threads/{threadId}/messages/{messageId}/files/{fileId} | Create Thread Message File|
+|[**deleteThreadMessageFile**](#deletethreadmessagefile) | **DELETE** /threads/{threadId}/messages/{messageId}/files/{fileId} | Delete Thread Message File|
+|[**getThreadMessageFiles**](#getthreadmessagefiles) | **GET** /threads/{threadId}/messages/{messageId}/files | Get Thread Message Files|
+
+# **createThreadMessageFile**
+> CreateAccountAddress200Response createThreadMessageFile()
+
+Create Thread Message File endpoint
+
+### Example
+
+```typescript
+import {
+    ThreadsMessagesFilesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ThreadsMessagesFilesApi(configuration);
+
+let threadId: string; //The thread identifier (default to undefined)
+let messageId: string; //The message identifier (default to undefined)
+let fileId: string; //The file identifier (default to undefined)
+
+const { status, data } = await apiInstance.createThreadMessageFile(
+    threadId,
+    messageId,
+    fileId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **threadId** | [**string**] | The thread identifier | defaults to undefined|
+| **messageId** | [**string**] | The message identifier | defaults to undefined|
+| **fileId** | [**string**] | The file 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)
+
+# **deleteThreadMessageFile**
+> CreateAccountInvitations200Response deleteThreadMessageFile()
+
+Delete Thread Message File endpoint
+
+### Example
+
+```typescript
+import {
+    ThreadsMessagesFilesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ThreadsMessagesFilesApi(configuration);
+
+let threadId: string; //The thread identifier (default to undefined)
+let messageId: string; //The message identifier (default to undefined)
+let fileId: string; //The file identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteThreadMessageFile(
+    threadId,
+    messageId,
+    fileId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **threadId** | [**string**] | The thread identifier | defaults to undefined|
+| **messageId** | [**string**] | The message identifier | defaults to undefined|
+| **fileId** | [**string**] | The file 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)
+
+# **getThreadMessageFiles**
+> GetThreadMessageFiles200Response getThreadMessageFiles()
+
+Get Thread Message Files endpoint
+
+### Example
+
+```typescript
+import {
+    ThreadsMessagesFilesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ThreadsMessagesFilesApi(configuration);
+
+let threadId: string; //The thread identifier (default to undefined)
+let messageId: string; //The message identifier (default to undefined)
+
+const { status, data } = await apiInstance.getThreadMessageFiles(
+    threadId,
+    messageId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **threadId** | [**string**] | The thread identifier | defaults to undefined|
+| **messageId** | [**string**] | The message identifier | defaults to undefined|
+
+
+### Return type
+
+**GetThreadMessageFiles200Response**
+
+### 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/ThreadsMessagesImagesApi.md

@@ -0,0 +1,178 @@
+# ThreadsMessagesImagesApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createThreadMessageImage**](#createthreadmessageimage) | **POST** /threads/{threadId}/messages/{messageId}/images/{imageId} | Create Thread Message Image|
+|[**deleteThreadMessageImage**](#deletethreadmessageimage) | **DELETE** /threads/{threadId}/messages/{messageId}/images/{imageId} | Delete Thread Message Image|
+|[**getThreadMessageImages**](#getthreadmessageimages) | **GET** /threads/{threadId}/messages/{messageId}/images | Get Thread Message Images|
+
+# **createThreadMessageImage**
+> CreateAccountAddress200Response createThreadMessageImage()
+
+Create Thread Message Image endpoint
+
+### Example
+
+```typescript
+import {
+    ThreadsMessagesImagesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ThreadsMessagesImagesApi(configuration);
+
+let threadId: string; //The thread identifier (default to undefined)
+let messageId: string; //The message identifier (default to undefined)
+let imageId: string; //The image identifier (default to undefined)
+
+const { status, data } = await apiInstance.createThreadMessageImage(
+    threadId,
+    messageId,
+    imageId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **threadId** | [**string**] | The thread identifier | defaults to undefined|
+| **messageId** | [**string**] | The message identifier | defaults to undefined|
+| **imageId** | [**string**] | The image 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)
+
+# **deleteThreadMessageImage**
+> CreateAccountInvitations200Response deleteThreadMessageImage()
+
+Delete Thread Message Image endpoint
+
+### Example
+
+```typescript
+import {
+    ThreadsMessagesImagesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ThreadsMessagesImagesApi(configuration);
+
+let threadId: string; //The thread identifier (default to undefined)
+let messageId: string; //The message identifier (default to undefined)
+let imageId: string; //The image identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteThreadMessageImage(
+    threadId,
+    messageId,
+    imageId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **threadId** | [**string**] | The thread identifier | defaults to undefined|
+| **messageId** | [**string**] | The message identifier | defaults to undefined|
+| **imageId** | [**string**] | The image 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)
+
+# **getThreadMessageImages**
+> GetThreadMessageImages200Response getThreadMessageImages()
+
+Get Thread Message Images endpoint
+
+### Example
+
+```typescript
+import {
+    ThreadsMessagesImagesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ThreadsMessagesImagesApi(configuration);
+
+let threadId: string; //The thread identifier (default to undefined)
+let messageId: string; //The message identifier (default to undefined)
+
+const { status, data } = await apiInstance.getThreadMessageImages(
+    threadId,
+    messageId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **threadId** | [**string**] | The thread identifier | defaults to undefined|
+| **messageId** | [**string**] | The message identifier | defaults to undefined|
+
+
+### Return type
+
+**GetThreadMessageImages200Response**
+
+### 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)
+