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/TodosApi.md DELETED Viewed

@@ -1,659 +0,0 @@
-# TodosApi
-All URIs are relative to *https://magnetcustomer.net/realms/platform/protocol/openid-connect*
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**apiMeetings507f1f77bcf86cd799439110Todos507f1f77bcf86cd799439500Put**](#apimeetings507f1f77bcf86cd799439110todos507f1f77bcf86cd799439500put) | **PUT** /api/meetings/507f1f77bcf86cd799439110/todos/507f1f77bcf86cd799439500 | Update Todo|
-|[**apiMeetings507f1f77bcf86cd799439110Todos507f1f77bcf86cd799439500TogglePut**](#apimeetings507f1f77bcf86cd799439110todos507f1f77bcf86cd799439500toggleput) | **PUT** /api/meetings/507f1f77bcf86cd799439110/todos/507f1f77bcf86cd799439500/toggle | Toggle Todo|
-|[**apiMeetings507f1f77bcf86cd799439110TodosGet**](#apimeetings507f1f77bcf86cd799439110todosget) | **GET** /api/meetings/507f1f77bcf86cd799439110/todos | List Todos|
-|[**apiMeetings507f1f77bcf86cd799439110TodosPost**](#apimeetings507f1f77bcf86cd799439110todospost) | **POST** /api/meetings/507f1f77bcf86cd799439110/todos | Create Todo|
-|[**apiMeetings507f1f77bcf86cd799439110TodosStatsGet**](#apimeetings507f1f77bcf86cd799439110todosstatsget) | **GET** /api/meetings/507f1f77bcf86cd799439110/todos/stats | Get Todo Stats|
-|[**apiTasks507f1f77bcf86cd799439100Todos507f1f77bcf86cd799439500Put**](#apitasks507f1f77bcf86cd799439100todos507f1f77bcf86cd799439500put) | **PUT** /api/tasks/507f1f77bcf86cd799439100/todos/507f1f77bcf86cd799439500 | Update Todo|
-|[**apiTasks507f1f77bcf86cd799439100Todos507f1f77bcf86cd799439500TogglePut**](#apitasks507f1f77bcf86cd799439100todos507f1f77bcf86cd799439500toggleput) | **PUT** /api/tasks/507f1f77bcf86cd799439100/todos/507f1f77bcf86cd799439500/toggle | Toggle Todo|
-|[**apiTasks507f1f77bcf86cd799439100TodosGet**](#apitasks507f1f77bcf86cd799439100todosget) | **GET** /api/tasks/507f1f77bcf86cd799439100/todos | List Todos|
-|[**apiTasks507f1f77bcf86cd799439100TodosPost**](#apitasks507f1f77bcf86cd799439100todospost) | **POST** /api/tasks/507f1f77bcf86cd799439100/todos | Create Todo|
-|[**apiTasks507f1f77bcf86cd799439100TodosStatsGet**](#apitasks507f1f77bcf86cd799439100todosstatsget) | **GET** /api/tasks/507f1f77bcf86cd799439100/todos/stats | Get Todo Stats|
-|[**apiTickets507f1f77bcf86cd799439130Todos507f1f77bcf86cd799439500Put**](#apitickets507f1f77bcf86cd799439130todos507f1f77bcf86cd799439500put) | **PUT** /api/tickets/507f1f77bcf86cd799439130/todos/507f1f77bcf86cd799439500 | Update Todo|
-|[**apiTickets507f1f77bcf86cd799439130Todos507f1f77bcf86cd799439500TogglePut**](#apitickets507f1f77bcf86cd799439130todos507f1f77bcf86cd799439500toggleput) | **PUT** /api/tickets/507f1f77bcf86cd799439130/todos/507f1f77bcf86cd799439500/toggle | Toggle Todo|
-|[**apiTickets507f1f77bcf86cd799439130TodosGet**](#apitickets507f1f77bcf86cd799439130todosget) | **GET** /api/tickets/507f1f77bcf86cd799439130/todos | List Todos|
-|[**apiTickets507f1f77bcf86cd799439130TodosPost**](#apitickets507f1f77bcf86cd799439130todospost) | **POST** /api/tickets/507f1f77bcf86cd799439130/todos | Create Todo|
-|[**apiTickets507f1f77bcf86cd799439130TodosStatsGet**](#apitickets507f1f77bcf86cd799439130todosstatsget) | **GET** /api/tickets/507f1f77bcf86cd799439130/todos/stats | Get Todo Stats|
-# **apiMeetings507f1f77bcf86cd799439110Todos507f1f77bcf86cd799439500Put**
-> apiMeetings507f1f77bcf86cd799439110Todos507f1f77bcf86cd799439500Put()
-Atualiza um item do checklist.
-### Example
-```typescript
-import {
-    TodosApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new TodosApi(configuration);
-let body: object; // (optional)
-const { status, data } = await apiInstance.apiMeetings507f1f77bcf86cd799439110Todos507f1f77bcf86cd799439500Put(
-    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)
-# **apiMeetings507f1f77bcf86cd799439110Todos507f1f77bcf86cd799439500TogglePut**
-> apiMeetings507f1f77bcf86cd799439110Todos507f1f77bcf86cd799439500TogglePut()
-Marca/desmarca um item do checklist como concluido.
-### Example
-```typescript
-import {
-    TodosApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new TodosApi(configuration);
-const { status, data } = await apiInstance.apiMeetings507f1f77bcf86cd799439110Todos507f1f77bcf86cd799439500TogglePut();
-```
-### 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)
-# **apiMeetings507f1f77bcf86cd799439110TodosGet**
-> apiMeetings507f1f77bcf86cd799439110TodosGet()
-Lista itens do checklist associados ao registro.\\n\\nTodos sao organizados por posicao e podem ser marcados como concluidos.
-### Example
-```typescript
-import {
-    TodosApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new TodosApi(configuration);
-const { status, data } = await apiInstance.apiMeetings507f1f77bcf86cd799439110TodosGet();
-```
-### 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)
-# **apiMeetings507f1f77bcf86cd799439110TodosPost**
-> apiMeetings507f1f77bcf86cd799439110TodosPost()
-Adiciona um item ao checklist.
-### Example
-```typescript
-import {
-    TodosApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new TodosApi(configuration);
-let body: object; // (optional)
-const { status, data } = await apiInstance.apiMeetings507f1f77bcf86cd799439110TodosPost(
-    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)
-# **apiMeetings507f1f77bcf86cd799439110TodosStatsGet**
-> apiMeetings507f1f77bcf86cd799439110TodosStatsGet()
-Retorna estatisticas do checklist (total, concluidos, pendentes).
-### Example
-```typescript
-import {
-    TodosApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new TodosApi(configuration);
-const { status, data } = await apiInstance.apiMeetings507f1f77bcf86cd799439110TodosStatsGet();
-```
-### 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)
-# **apiTasks507f1f77bcf86cd799439100Todos507f1f77bcf86cd799439500Put**
-> apiTasks507f1f77bcf86cd799439100Todos507f1f77bcf86cd799439500Put()
-Atualiza um item do checklist.
-### Example
-```typescript
-import {
-    TodosApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new TodosApi(configuration);
-let body: object; // (optional)
-const { status, data } = await apiInstance.apiTasks507f1f77bcf86cd799439100Todos507f1f77bcf86cd799439500Put(
-    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)
-# **apiTasks507f1f77bcf86cd799439100Todos507f1f77bcf86cd799439500TogglePut**
-> apiTasks507f1f77bcf86cd799439100Todos507f1f77bcf86cd799439500TogglePut()
-Marca/desmarca um item do checklist como concluido.
-### Example
-```typescript
-import {
-    TodosApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new TodosApi(configuration);
-const { status, data } = await apiInstance.apiTasks507f1f77bcf86cd799439100Todos507f1f77bcf86cd799439500TogglePut();
-```
-### 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)
-# **apiTasks507f1f77bcf86cd799439100TodosGet**
-> ApiTasks507f1f77bcf86cd799439100TodosGet200Response apiTasks507f1f77bcf86cd799439100TodosGet()
-Lista itens do checklist associados ao registro.\\n\\nTodos sao organizados por posicao e podem ser marcados como concluidos.
-### Example
-```typescript
-import {
-    TodosApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new TodosApi(configuration);
-const { status, data } = await apiInstance.apiTasks507f1f77bcf86cd799439100TodosGet();
-```
-### Parameters
-This endpoint does not have any parameters.
-### Return type
-**ApiTasks507f1f77bcf86cd799439100TodosGet200Response**
-### 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)
-# **apiTasks507f1f77bcf86cd799439100TodosPost**
-> ApiTasks507f1f77bcf86cd799439100TodosGet200ResponseDataInner apiTasks507f1f77bcf86cd799439100TodosPost()
-Adiciona um item ao checklist.
-### Example
-```typescript
-import {
-    TodosApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new TodosApi(configuration);
-let body: object; // (optional)
-const { status, data } = await apiInstance.apiTasks507f1f77bcf86cd799439100TodosPost(
-    body
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **body** | **object**|  | |
-### Return type
-**ApiTasks507f1f77bcf86cd799439100TodosGet200ResponseDataInner**
-### 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)
-# **apiTasks507f1f77bcf86cd799439100TodosStatsGet**
-> apiTasks507f1f77bcf86cd799439100TodosStatsGet()
-Retorna estatisticas do checklist (total, concluidos, pendentes).
-### Example
-```typescript
-import {
-    TodosApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new TodosApi(configuration);
-const { status, data } = await apiInstance.apiTasks507f1f77bcf86cd799439100TodosStatsGet();
-```
-### 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)
-# **apiTickets507f1f77bcf86cd799439130Todos507f1f77bcf86cd799439500Put**
-> apiTickets507f1f77bcf86cd799439130Todos507f1f77bcf86cd799439500Put()
-Atualiza um item do checklist.
-### Example
-```typescript
-import {
-    TodosApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new TodosApi(configuration);
-let body: object; // (optional)
-const { status, data } = await apiInstance.apiTickets507f1f77bcf86cd799439130Todos507f1f77bcf86cd799439500Put(
-    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)
-# **apiTickets507f1f77bcf86cd799439130Todos507f1f77bcf86cd799439500TogglePut**
-> apiTickets507f1f77bcf86cd799439130Todos507f1f77bcf86cd799439500TogglePut()
-Marca/desmarca um item do checklist como concluido.
-### Example
-```typescript
-import {
-    TodosApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new TodosApi(configuration);
-const { status, data } = await apiInstance.apiTickets507f1f77bcf86cd799439130Todos507f1f77bcf86cd799439500TogglePut();
-```
-### 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)
-# **apiTickets507f1f77bcf86cd799439130TodosGet**
-> apiTickets507f1f77bcf86cd799439130TodosGet()
-Lista itens do checklist associados ao registro.\\n\\nTodos sao organizados por posicao e podem ser marcados como concluidos.
-### Example
-```typescript
-import {
-    TodosApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new TodosApi(configuration);
-const { status, data } = await apiInstance.apiTickets507f1f77bcf86cd799439130TodosGet();
-```
-### 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)
-# **apiTickets507f1f77bcf86cd799439130TodosPost**
-> apiTickets507f1f77bcf86cd799439130TodosPost()
-Adiciona um item ao checklist.
-### Example
-```typescript
-import {
-    TodosApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new TodosApi(configuration);
-let body: object; // (optional)
-const { status, data } = await apiInstance.apiTickets507f1f77bcf86cd799439130TodosPost(
-    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)
-# **apiTickets507f1f77bcf86cd799439130TodosStatsGet**
-> apiTickets507f1f77bcf86cd799439130TodosStatsGet()
-Retorna estatisticas do checklist (total, concluidos, pendentes).
-### Example
-```typescript
-import {
-    TodosApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new TodosApi(configuration);
-const { status, data } = await apiInstance.apiTickets507f1f77bcf86cd799439130TodosStatsGet();
-```
-### 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)

package/docs/TokenPost200Response.md DELETED Viewed

@@ -1,30 +0,0 @@
-# TokenPost200Response
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**access_token** | **string** |  | [optional] [default to undefined]
-**expires_in** | **number** |  | [optional] [default to undefined]
-**refresh_expires_in** | **number** |  | [optional] [default to undefined]
-**token_type** | **string** |  | [optional] [default to undefined]
-**not_before_policy** | **number** |  | [optional] [default to undefined]
-**scope** | **string** |  | [optional] [default to undefined]
-## Example
-```typescript
-import { TokenPost200Response } from '@magnetcustomer/sdk';
-const instance: TokenPost200Response = {
-    access_token,
-    expires_in,
-    refresh_expires_in,
-    token_type,
-    not_before_policy,
-    scope,
-};
-```
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)