npm - @magnetcustomer/sdk - Versions diffs - 1.0.0 → 2.0.0 - Mend

@magnetcustomer/sdk 1.0.0 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1477) hide show

package/docs/MessagesApi.md DELETED Viewed

@@ -1,685 +0,0 @@
-# MessagesApi
-All URIs are relative to *https://magnetcustomer.net/realms/platform/protocol/openid-connect*
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**apiMeetings507f1f77bcf86cd799439110Messages507f1f77bcf86cd799439400Delete**](#apimeetings507f1f77bcf86cd799439110messages507f1f77bcf86cd799439400delete) | **DELETE** /api/meetings/507f1f77bcf86cd799439110/messages/507f1f77bcf86cd799439400 | Delete Message|
-|[**apiMeetings507f1f77bcf86cd799439110Messages507f1f77bcf86cd799439400Get**](#apimeetings507f1f77bcf86cd799439110messages507f1f77bcf86cd799439400get) | **GET** /api/meetings/507f1f77bcf86cd799439110/messages/507f1f77bcf86cd799439400 | Get Message|
-|[**apiMeetings507f1f77bcf86cd799439110MessagesGet**](#apimeetings507f1f77bcf86cd799439110messagesget) | **GET** /api/meetings/507f1f77bcf86cd799439110/messages | List Messages|
-|[**apiMeetings507f1f77bcf86cd799439110MessagesPost**](#apimeetings507f1f77bcf86cd799439110messagespost) | **POST** /api/meetings/507f1f77bcf86cd799439110/messages | Create Message|
-|[**apiTasks507f1f77bcf86cd799439100Messages507f1f77bcf86cd799439400Delete**](#apitasks507f1f77bcf86cd799439100messages507f1f77bcf86cd799439400delete) | **DELETE** /api/tasks/507f1f77bcf86cd799439100/messages/507f1f77bcf86cd799439400 | Delete Message|
-|[**apiTasks507f1f77bcf86cd799439100Messages507f1f77bcf86cd799439400Get**](#apitasks507f1f77bcf86cd799439100messages507f1f77bcf86cd799439400get) | **GET** /api/tasks/507f1f77bcf86cd799439100/messages/507f1f77bcf86cd799439400 | Get Message|
-|[**apiTasks507f1f77bcf86cd799439100MessagesGet**](#apitasks507f1f77bcf86cd799439100messagesget) | **GET** /api/tasks/507f1f77bcf86cd799439100/messages | List Messages|
-|[**apiTasks507f1f77bcf86cd799439100MessagesPost**](#apitasks507f1f77bcf86cd799439100messagespost) | **POST** /api/tasks/507f1f77bcf86cd799439100/messages | Create Message|
-|[**apiTickets507f1f77bcf86cd799439130Messages507f1f77bcf86cd799439400Delete**](#apitickets507f1f77bcf86cd799439130messages507f1f77bcf86cd799439400delete) | **DELETE** /api/tickets/507f1f77bcf86cd799439130/messages/507f1f77bcf86cd799439400 | Delete Message|
-|[**apiTickets507f1f77bcf86cd799439130Messages507f1f77bcf86cd799439400Get**](#apitickets507f1f77bcf86cd799439130messages507f1f77bcf86cd799439400get) | **GET** /api/tickets/507f1f77bcf86cd799439130/messages/507f1f77bcf86cd799439400 | Get Message|
-|[**apiTickets507f1f77bcf86cd799439130MessagesGet**](#apitickets507f1f77bcf86cd799439130messagesget) | **GET** /api/tickets/507f1f77bcf86cd799439130/messages | List Messages|
-|[**apiTickets507f1f77bcf86cd799439130MessagesPost**](#apitickets507f1f77bcf86cd799439130messagespost) | **POST** /api/tickets/507f1f77bcf86cd799439130/messages | Create Message|
-|[**apiTreatments507f1f77bcf86cd799439120Messages507f1f77bcf86cd799439400Delete**](#apitreatments507f1f77bcf86cd799439120messages507f1f77bcf86cd799439400delete) | **DELETE** /api/treatments/507f1f77bcf86cd799439120/messages/507f1f77bcf86cd799439400 | Delete Message|
-|[**apiTreatments507f1f77bcf86cd799439120Messages507f1f77bcf86cd799439400Get**](#apitreatments507f1f77bcf86cd799439120messages507f1f77bcf86cd799439400get) | **GET** /api/treatments/507f1f77bcf86cd799439120/messages/507f1f77bcf86cd799439400 | Get Message|
-|[**apiTreatments507f1f77bcf86cd799439120MessagesGet**](#apitreatments507f1f77bcf86cd799439120messagesget) | **GET** /api/treatments/507f1f77bcf86cd799439120/messages | List Messages|
-|[**apiTreatments507f1f77bcf86cd799439120MessagesPost**](#apitreatments507f1f77bcf86cd799439120messagespost) | **POST** /api/treatments/507f1f77bcf86cd799439120/messages | Create Message|
-# **apiMeetings507f1f77bcf86cd799439110Messages507f1f77bcf86cd799439400Delete**
-> apiMeetings507f1f77bcf86cd799439110Messages507f1f77bcf86cd799439400Delete()
-Remove uma mensagem.
-### Example
-```typescript
-import {
-    MessagesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new MessagesApi(configuration);
-const { status, data } = await apiInstance.apiMeetings507f1f77bcf86cd799439110Messages507f1f77bcf86cd799439400Delete();
-```
-### Parameters
-This endpoint does not have any parameters.
-### Return type
-void (empty response body)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-[[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)
-# **apiMeetings507f1f77bcf86cd799439110Messages507f1f77bcf86cd799439400Get**
-> apiMeetings507f1f77bcf86cd799439110Messages507f1f77bcf86cd799439400Get()
-Retorna uma mensagem pelo ID.
-### Example
-```typescript
-import {
-    MessagesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new MessagesApi(configuration);
-const { status, data } = await apiInstance.apiMeetings507f1f77bcf86cd799439110Messages507f1f77bcf86cd799439400Get();
-```
-### Parameters
-This endpoint does not have any parameters.
-### Return type
-void (empty response body)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-[[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)
-# **apiMeetings507f1f77bcf86cd799439110MessagesGet**
-> apiMeetings507f1f77bcf86cd799439110MessagesGet()
-Lista mensagens internas (comentarios) associadas ao registro.\\n\\nMensagens sao notas internas visiveis apenas para a equipe.
-### Example
-```typescript
-import {
-    MessagesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new MessagesApi(configuration);
-const { status, data } = await apiInstance.apiMeetings507f1f77bcf86cd799439110MessagesGet();
-```
-### Parameters
-This endpoint does not have any parameters.
-### Return type
-void (empty response body)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-[[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)
-# **apiMeetings507f1f77bcf86cd799439110MessagesPost**
-> apiMeetings507f1f77bcf86cd799439110MessagesPost()
-Adiciona uma mensagem interna ao registro.
-### Example
-```typescript
-import {
-    MessagesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new MessagesApi(configuration);
-let body: object; // (optional)
-const { status, data } = await apiInstance.apiMeetings507f1f77bcf86cd799439110MessagesPost(
-    body
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **body** | **object**|  | |
-### Return type
-void (empty response body)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: Not defined
-[[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)
-# **apiTasks507f1f77bcf86cd799439100Messages507f1f77bcf86cd799439400Delete**
-> apiTasks507f1f77bcf86cd799439100Messages507f1f77bcf86cd799439400Delete()
-Remove uma mensagem.
-### Example
-```typescript
-import {
-    MessagesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new MessagesApi(configuration);
-const { status, data } = await apiInstance.apiTasks507f1f77bcf86cd799439100Messages507f1f77bcf86cd799439400Delete();
-```
-### Parameters
-This endpoint does not have any parameters.
-### Return type
-void (empty response body)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-[[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)
-# **apiTasks507f1f77bcf86cd799439100Messages507f1f77bcf86cd799439400Get**
-> apiTasks507f1f77bcf86cd799439100Messages507f1f77bcf86cd799439400Get()
-Retorna uma mensagem pelo ID.
-### Example
-```typescript
-import {
-    MessagesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new MessagesApi(configuration);
-const { status, data } = await apiInstance.apiTasks507f1f77bcf86cd799439100Messages507f1f77bcf86cd799439400Get();
-```
-### Parameters
-This endpoint does not have any parameters.
-### Return type
-void (empty response body)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-[[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)
-# **apiTasks507f1f77bcf86cd799439100MessagesGet**
-> ApiTasks507f1f77bcf86cd799439100MessagesGet200Response apiTasks507f1f77bcf86cd799439100MessagesGet()
-Lista mensagens internas (comentarios) associadas ao registro.\\n\\nMensagens sao notas internas visiveis apenas para a equipe.
-### Example
-```typescript
-import {
-    MessagesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new MessagesApi(configuration);
-const { status, data } = await apiInstance.apiTasks507f1f77bcf86cd799439100MessagesGet();
-```
-### Parameters
-This endpoint does not have any parameters.
-### Return type
-**ApiTasks507f1f77bcf86cd799439100MessagesGet200Response**
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: application/json
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | 200 OK |  -  |
-[[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)
-# **apiTasks507f1f77bcf86cd799439100MessagesPost**
-> ApiTasks507f1f77bcf86cd799439100MessagesGet200ResponseDataInner apiTasks507f1f77bcf86cd799439100MessagesPost()
-Adiciona uma mensagem interna ao registro.
-### Example
-```typescript
-import {
-    MessagesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new MessagesApi(configuration);
-let body: object; // (optional)
-const { status, data } = await apiInstance.apiTasks507f1f77bcf86cd799439100MessagesPost(
-    body
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **body** | **object**|  | |
-### Return type
-**ApiTasks507f1f77bcf86cd799439100MessagesGet200ResponseDataInner**
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**201** | 201 Created |  -  |
-[[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)
-# **apiTickets507f1f77bcf86cd799439130Messages507f1f77bcf86cd799439400Delete**
-> apiTickets507f1f77bcf86cd799439130Messages507f1f77bcf86cd799439400Delete()
-Remove uma mensagem.
-### Example
-```typescript
-import {
-    MessagesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new MessagesApi(configuration);
-const { status, data } = await apiInstance.apiTickets507f1f77bcf86cd799439130Messages507f1f77bcf86cd799439400Delete();
-```
-### Parameters
-This endpoint does not have any parameters.
-### Return type
-void (empty response body)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-[[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)
-# **apiTickets507f1f77bcf86cd799439130Messages507f1f77bcf86cd799439400Get**
-> apiTickets507f1f77bcf86cd799439130Messages507f1f77bcf86cd799439400Get()
-Retorna uma mensagem pelo ID.
-### Example
-```typescript
-import {
-    MessagesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new MessagesApi(configuration);
-const { status, data } = await apiInstance.apiTickets507f1f77bcf86cd799439130Messages507f1f77bcf86cd799439400Get();
-```
-### Parameters
-This endpoint does not have any parameters.
-### Return type
-void (empty response body)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-[[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)
-# **apiTickets507f1f77bcf86cd799439130MessagesGet**
-> apiTickets507f1f77bcf86cd799439130MessagesGet()
-Lista mensagens internas (comentarios) associadas ao registro.\\n\\nMensagens sao notas internas visiveis apenas para a equipe.
-### Example
-```typescript
-import {
-    MessagesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new MessagesApi(configuration);
-const { status, data } = await apiInstance.apiTickets507f1f77bcf86cd799439130MessagesGet();
-```
-### Parameters
-This endpoint does not have any parameters.
-### Return type
-void (empty response body)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-[[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)
-# **apiTickets507f1f77bcf86cd799439130MessagesPost**
-> apiTickets507f1f77bcf86cd799439130MessagesPost()
-Adiciona uma mensagem interna ao registro.
-### Example
-```typescript
-import {
-    MessagesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new MessagesApi(configuration);
-let body: object; // (optional)
-const { status, data } = await apiInstance.apiTickets507f1f77bcf86cd799439130MessagesPost(
-    body
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **body** | **object**|  | |
-### Return type
-void (empty response body)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: Not defined
-[[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)
-# **apiTreatments507f1f77bcf86cd799439120Messages507f1f77bcf86cd799439400Delete**
-> apiTreatments507f1f77bcf86cd799439120Messages507f1f77bcf86cd799439400Delete()
-Remove uma mensagem.
-### Example
-```typescript
-import {
-    MessagesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new MessagesApi(configuration);
-const { status, data } = await apiInstance.apiTreatments507f1f77bcf86cd799439120Messages507f1f77bcf86cd799439400Delete();
-```
-### Parameters
-This endpoint does not have any parameters.
-### Return type
-void (empty response body)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-[[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)
-# **apiTreatments507f1f77bcf86cd799439120Messages507f1f77bcf86cd799439400Get**
-> apiTreatments507f1f77bcf86cd799439120Messages507f1f77bcf86cd799439400Get()
-Retorna uma mensagem pelo ID.
-### Example
-```typescript
-import {
-    MessagesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new MessagesApi(configuration);
-const { status, data } = await apiInstance.apiTreatments507f1f77bcf86cd799439120Messages507f1f77bcf86cd799439400Get();
-```
-### Parameters
-This endpoint does not have any parameters.
-### Return type
-void (empty response body)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-[[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)
-# **apiTreatments507f1f77bcf86cd799439120MessagesGet**
-> apiTreatments507f1f77bcf86cd799439120MessagesGet()
-Lista mensagens internas (comentarios) associadas ao registro.\\n\\nMensagens sao notas internas visiveis apenas para a equipe.
-### Example
-```typescript
-import {
-    MessagesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new MessagesApi(configuration);
-const { status, data } = await apiInstance.apiTreatments507f1f77bcf86cd799439120MessagesGet();
-```
-### Parameters
-This endpoint does not have any parameters.
-### Return type
-void (empty response body)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-[[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)
-# **apiTreatments507f1f77bcf86cd799439120MessagesPost**
-> apiTreatments507f1f77bcf86cd799439120MessagesPost()
-Adiciona uma mensagem interna ao registro.
-### Example
-```typescript
-import {
-    MessagesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new MessagesApi(configuration);
-let body: object; // (optional)
-const { status, data } = await apiInstance.apiTreatments507f1f77bcf86cd799439120MessagesPost(
-    body
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **body** | **object**|  | |
-### Return type
-void (empty response body)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: Not defined
-[[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)