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

@@ -1,2482 +0,0 @@
-# ResourcesApi
-All URIs are relative to *https://magnetcustomer.net/realms/platform/protocol/openid-connect*
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**apiContactsIdGet**](#apicontactsidget) | **GET** /api/contacts/{id} | Get One Contact|
-|[**apiCustomfieldblocksIdGet**](#apicustomfieldblocksidget) | **GET** /api/customfieldblocks/{id} | Get One Block|
-|[**apiCustomfieldblocksIdPut**](#apicustomfieldblocksidput) | **PUT** /api/customfieldblocks/{id} | Update One Block|
-|[**apiCustomfieldblocksPost**](#apicustomfieldblockspost) | **POST** /api/customfieldblocks | Create One Block|
-|[**apiCustomfieldsIdGet**](#apicustomfieldsidget) | **GET** /api/customfields/{id} | Get One Custom Field|
-|[**apiCustomfieldsIdPut**](#apicustomfieldsidput) | **PUT** /api/customfields/{id} | Update One Custom Field|
-|[**apiDashboardsDashboardIdWidgetsGet**](#apidashboardsdashboardidwidgetsget) | **GET** /api/dashboards/{dashboard_id}/widgets | List Widgets|
-|[**apiDealsIdGet**](#apidealsidget) | **GET** /api/deals/{id} | Get One Deal|
-|[**apiLeadsCONTACTIDMeetingsGet**](#apileadscontactidmeetingsget) | **GET** /api/leads/{CONTACT_ID}/meetings | List Meetings by Lead|
-|[**apiLeadsCONTACTIDObservationsGet**](#apileadscontactidobservationsget) | **GET** /api/leads/{CONTACT_ID}/observations | List Observations by Lead|
-|[**apiLeadsCONTACTIDTasksGet**](#apileadscontactidtasksget) | **GET** /api/leads/{CONTACT_ID}/tasks | List Tasks by Lead|
-|[**apiLeadsCONTACTIDTicketsGet**](#apileadscontactidticketsget) | **GET** /api/leads/{CONTACT_ID}/tickets | List Tickets by Lead|
-|[**apiLeadsCONTACTIDTreatmentsGet**](#apileadscontactidtreatmentsget) | **GET** /api/leads/{CONTACT_ID}/treatments | List Treatments by Lead|
-|[**apiLeadsIdGet**](#apileadsidget) | **GET** /api/leads/{id} | Get One Lead|
-|[**apiLeadsIdPut**](#apileadsidput) | **PUT** /api/leads/{id} | Update One Lead|
-|[**apiMeetingsIdGet**](#apimeetingsidget) | **GET** /api/meetings/{id} | Get One Meeting|
-|[**apiMeetingsIdPut**](#apimeetingsidput) | **PUT** /api/meetings/{id} | Update One Meeting|
-|[**apiMeetingsRoomsGet**](#apimeetingsroomsget) | **GET** /api/meetings/rooms | List Meeting Rooms|
-|[**apiMeetingsRoomsIdGet**](#apimeetingsroomsidget) | **GET** /api/meetings/rooms/{id} | Get One Meeting Room|
-|[**apiMeetingsRoomsIdPut**](#apimeetingsroomsidput) | **PUT** /api/meetings/rooms/{id} | Update One Meeting Room|
-|[**apiMeetingsRoomsPost**](#apimeetingsroomspost) | **POST** /api/meetings/rooms | Create One Meeting Room|
-|[**apiMeetingsTypesGet**](#apimeetingstypesget) | **GET** /api/meetings/types | List Meeting Types|
-|[**apiMeetingsTypesIdGet**](#apimeetingstypesidget) | **GET** /api/meetings/types/{id} | Get One Meeting Type|
-|[**apiMeetingsTypesIdPut**](#apimeetingstypesidput) | **PUT** /api/meetings/types/{id} | Update One Meeting Type|
-|[**apiMeetingsTypesPost**](#apimeetingstypespost) | **POST** /api/meetings/types | Create One Meeting Type|
-|[**apiOrganizationsIdGet**](#apiorganizationsidget) | **GET** /api/organizations/{id} | Get One Organization|
-|[**apiOrganizationsIdPut**](#apiorganizationsidput) | **PUT** /api/organizations/{id} | Update One Organization|
-|[**apiPipelinesIdGet**](#apipipelinesidget) | **GET** /api/pipelines/{id} | Get One Pipeline|
-|[**apiPipelinesIdPut**](#apipipelinesidput) | **PUT** /api/pipelines/{id} | Update One Pipeline|
-|[**apiProspectsCONTACTIDMeetingsGet**](#apiprospectscontactidmeetingsget) | **GET** /api/prospects/{CONTACT_ID}/meetings | List Meetings by Prospect|
-|[**apiProspectsCONTACTIDObservationsGet**](#apiprospectscontactidobservationsget) | **GET** /api/prospects/{CONTACT_ID}/observations | List Observations by Prospect|
-|[**apiProspectsCONTACTIDTasksGet**](#apiprospectscontactidtasksget) | **GET** /api/prospects/{CONTACT_ID}/tasks | List Tasks by Prospect|
-|[**apiProspectsCONTACTIDTicketsGet**](#apiprospectscontactidticketsget) | **GET** /api/prospects/{CONTACT_ID}/tickets | List Tickets by Prospect|
-|[**apiProspectsCONTACTIDTreatmentsGet**](#apiprospectscontactidtreatmentsget) | **GET** /api/prospects/{CONTACT_ID}/treatments | List Treatments by Prospect|
-|[**apiProspectsIdGet**](#apiprospectsidget) | **GET** /api/prospects/{id} | Get One Prospect|
-|[**apiProspectsIdPut**](#apiprospectsidput) | **PUT** /api/prospects/{id} | Update One Prospect|
-|[**apiStaffsIdGet**](#apistaffsidget) | **GET** /api/staffs/{id} | Get One Staff|
-|[**apiStaffsIdPut**](#apistaffsidput) | **PUT** /api/staffs/{id} | Update One Staff|
-|[**apiStaffsPost**](#apistaffspost) | **POST** /api/staffs | Create One Staff|
-|[**apiTasksIdGet**](#apitasksidget) | **GET** /api/tasks/{id} | Get One Task|
-|[**apiTasksIdPut**](#apitasksidput) | **PUT** /api/tasks/{id} | Update One Task|
-|[**apiTicketsIdGet**](#apiticketsidget) | **GET** /api/tickets/{id} | Get One Ticket|
-|[**apiTicketsIdPut**](#apiticketsidput) | **PUT** /api/tickets/{id} | Update One Ticket|
-|[**apiTreatmentsIdGet**](#apitreatmentsidget) | **GET** /api/treatments/{id} | Get One Treatment|
-|[**apiTreatmentsIdPut**](#apitreatmentsidput) | **PUT** /api/treatments/{id} | Update One Treatment|
-|[**apiTreatmentsTypesIdGet**](#apitreatmentstypesidget) | **GET** /api/treatments/types/{id} | Get One Treatment Type|
-|[**apiTreatmentsTypesIdPut**](#apitreatmentstypesidput) | **PUT** /api/treatments/types/{id} | Update One Treatment Type|
-|[**apiTreatmentsTypesPost**](#apitreatmentstypespost) | **POST** /api/treatments/types | Create One Treatment Type|
-|[**apiTreatmentsWorkspacesGet**](#apitreatmentsworkspacesget) | **GET** /api/treatments/workspaces | List Workspaces|
-|[**apiTreatmentsWorkspacesIdGet**](#apitreatmentsworkspacesidget) | **GET** /api/treatments/workspaces/{id} | Get One Workspace|
-|[**apiTreatmentsWorkspacesIdPut**](#apitreatmentsworkspacesidput) | **PUT** /api/treatments/workspaces/{id} | Update One Workspace|
-|[**apiTreatmentsWorkspacesPost**](#apitreatmentsworkspacespost) | **POST** /api/treatments/workspaces | Create One Workspace|
-# **apiContactsIdGet**
-> apiContactsIdGet()
-### Get Contacts  This endpoint makes an HTTP GET request to retrieve a list of contacts with optional pagination and filtering parameters.  #### Request  - Method: GET      - URL: `{{platform_url}}/contacts`      - Query Parameters:          - page (number, optional): The page number for pagination.              - search (string, optional): Search query for filtering contacts.              - limit (number, optional): The maximum number of contacts to retrieve per page.              - emailsEmpty (boolean, optional): Indicates whether to include contacts with empty email addresses.              - phonesEmpty (boolean, optional): Indicates whether to include contacts with empty phone numbers.              - interactionsEmpty (boolean, optional): Indicates whether to include contacts with empty interaction records.              - sortBy (string, optional): The field to sort the contacts by.              - sortType (string, optional): The type of sorting (e.g., asc for ascending, desc for descending).           #### Response  The response for this request is a JSON object representing the list of contacts, following the specified pagination and filtering criteria.  For the response schema, please refer to the JSON schema provided separately.
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-const { status, data } = await apiInstance.apiContactsIdGet(
-    id
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiCustomfieldblocksIdGet**
-> apiCustomfieldblocksIdGet()
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-const { status, data } = await apiInstance.apiCustomfieldblocksIdGet(
-    id
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiCustomfieldblocksIdPut**
-> apiCustomfieldblocksIdPut()
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-const { status, data } = await apiInstance.apiCustomfieldblocksIdPut(
-    id
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiCustomfieldblocksPost**
-> apiCustomfieldblocksPost()
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-const { status, data } = await apiInstance.apiCustomfieldblocksPost();
-```
-### 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)
-# **apiCustomfieldsIdGet**
-> apiCustomfieldsIdGet()
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-const { status, data } = await apiInstance.apiCustomfieldsIdGet(
-    id
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiCustomfieldsIdPut**
-> apiCustomfieldsIdPut()
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-const { status, data } = await apiInstance.apiCustomfieldsIdPut(
-    id
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiDashboardsDashboardIdWidgetsGet**
-> apiDashboardsDashboardIdWidgetsGet()
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let dashboardId: string; // (default to undefined)
-const { status, data } = await apiInstance.apiDashboardsDashboardIdWidgetsGet(
-    dashboardId
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **dashboardId** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiDealsIdGet**
-> apiDealsIdGet()
-### Get Contacts  This endpoint makes an HTTP GET request to retrieve a list of contacts with optional pagination and filtering parameters.  #### Request  - Method: GET      - URL: `{{platform_url}}/contacts`      - Query Parameters:          - page (number, optional): The page number for pagination.              - search (string, optional): Search query for filtering contacts.              - limit (number, optional): The maximum number of contacts to retrieve per page.              - emailsEmpty (boolean, optional): Indicates whether to include contacts with empty email addresses.              - phonesEmpty (boolean, optional): Indicates whether to include contacts with empty phone numbers.              - interactionsEmpty (boolean, optional): Indicates whether to include contacts with empty interaction records.              - sortBy (string, optional): The field to sort the contacts by.              - sortType (string, optional): The type of sorting (e.g., asc for ascending, desc for descending).           #### Response  The response for this request is a JSON object representing the list of contacts, following the specified pagination and filtering criteria.  For the response schema, please refer to the JSON schema provided separately.
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-const { status, data } = await apiInstance.apiDealsIdGet(
-    id
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiLeadsCONTACTIDMeetingsGet**
-> apiLeadsCONTACTIDMeetingsGet()
-List meetings for a specific lead (by contact).
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let cONTACTID: string; // (default to undefined)
-let page: number; // (optional) (default to undefined)
-let limit: number; // (optional) (default to undefined)
-const { status, data } = await apiInstance.apiLeadsCONTACTIDMeetingsGet(
-    cONTACTID,
-    page,
-    limit
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **cONTACTID** | [**string**] |  | defaults to undefined|
-| **page** | [**number**] |  | (optional) defaults to undefined|
-| **limit** | [**number**] |  | (optional) defaults to undefined|
-### 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)
-# **apiLeadsCONTACTIDObservationsGet**
-> apiLeadsCONTACTIDObservationsGet()
-List observations for a specific lead (by contact).
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let cONTACTID: string; // (default to undefined)
-let page: number; // (optional) (default to undefined)
-let limit: number; // (optional) (default to undefined)
-const { status, data } = await apiInstance.apiLeadsCONTACTIDObservationsGet(
-    cONTACTID,
-    page,
-    limit
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **cONTACTID** | [**string**] |  | defaults to undefined|
-| **page** | [**number**] |  | (optional) defaults to undefined|
-| **limit** | [**number**] |  | (optional) defaults to undefined|
-### 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)
-# **apiLeadsCONTACTIDTasksGet**
-> apiLeadsCONTACTIDTasksGet()
-List tasks for a specific lead (by contact).
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let cONTACTID: string; // (default to undefined)
-let page: number; // (optional) (default to undefined)
-let limit: number; // (optional) (default to undefined)
-const { status, data } = await apiInstance.apiLeadsCONTACTIDTasksGet(
-    cONTACTID,
-    page,
-    limit
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **cONTACTID** | [**string**] |  | defaults to undefined|
-| **page** | [**number**] |  | (optional) defaults to undefined|
-| **limit** | [**number**] |  | (optional) defaults to undefined|
-### 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)
-# **apiLeadsCONTACTIDTicketsGet**
-> apiLeadsCONTACTIDTicketsGet()
-List tickets for a specific lead (by contact).
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let cONTACTID: string; // (default to undefined)
-let page: number; // (optional) (default to undefined)
-let limit: number; // (optional) (default to undefined)
-const { status, data } = await apiInstance.apiLeadsCONTACTIDTicketsGet(
-    cONTACTID,
-    page,
-    limit
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **cONTACTID** | [**string**] |  | defaults to undefined|
-| **page** | [**number**] |  | (optional) defaults to undefined|
-| **limit** | [**number**] |  | (optional) defaults to undefined|
-### 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)
-# **apiLeadsCONTACTIDTreatmentsGet**
-> apiLeadsCONTACTIDTreatmentsGet()
-List treatments for a specific lead (by contact).
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let cONTACTID: string; // (default to undefined)
-let page: number; // (optional) (default to undefined)
-let limit: number; // (optional) (default to undefined)
-const { status, data } = await apiInstance.apiLeadsCONTACTIDTreatmentsGet(
-    cONTACTID,
-    page,
-    limit
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **cONTACTID** | [**string**] |  | defaults to undefined|
-| **page** | [**number**] |  | (optional) defaults to undefined|
-| **limit** | [**number**] |  | (optional) defaults to undefined|
-### 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)
-# **apiLeadsIdGet**
-> apiLeadsIdGet()
-Retrieves a specific lead by ID.
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-const { status, data } = await apiInstance.apiLeadsIdGet(
-    id
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiLeadsIdPut**
-> apiLeadsIdPut()
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-const { status, data } = await apiInstance.apiLeadsIdPut(
-    id
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiMeetingsIdGet**
-> apiMeetingsIdGet()
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-const { status, data } = await apiInstance.apiMeetingsIdGet(
-    id
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiMeetingsIdPut**
-> apiMeetingsIdPut()
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-const { status, data } = await apiInstance.apiMeetingsIdPut(
-    id
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiMeetingsRoomsGet**
-> apiMeetingsRoomsGet()
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let page: number; // (optional) (default to undefined)
-let limit: number; // (optional) (default to undefined)
-let search: string; // (optional) (default to undefined)
-const { status, data } = await apiInstance.apiMeetingsRoomsGet(
-    page,
-    limit,
-    search
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **page** | [**number**] |  | (optional) defaults to undefined|
-| **limit** | [**number**] |  | (optional) defaults to undefined|
-| **search** | [**string**] |  | (optional) defaults to undefined|
-### 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)
-# **apiMeetingsRoomsIdGet**
-> apiMeetingsRoomsIdGet()
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-const { status, data } = await apiInstance.apiMeetingsRoomsIdGet(
-    id
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiMeetingsRoomsIdPut**
-> apiMeetingsRoomsIdPut()
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-const { status, data } = await apiInstance.apiMeetingsRoomsIdPut(
-    id
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiMeetingsRoomsPost**
-> apiMeetingsRoomsPost()
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-const { status, data } = await apiInstance.apiMeetingsRoomsPost();
-```
-### 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)
-# **apiMeetingsTypesGet**
-> apiMeetingsTypesGet()
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let page: number; // (optional) (default to undefined)
-let limit: number; // (optional) (default to undefined)
-let search: string; // (optional) (default to undefined)
-const { status, data } = await apiInstance.apiMeetingsTypesGet(
-    page,
-    limit,
-    search
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **page** | [**number**] |  | (optional) defaults to undefined|
-| **limit** | [**number**] |  | (optional) defaults to undefined|
-| **search** | [**string**] |  | (optional) defaults to undefined|
-### 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)
-# **apiMeetingsTypesIdGet**
-> apiMeetingsTypesIdGet()
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-const { status, data } = await apiInstance.apiMeetingsTypesIdGet(
-    id
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiMeetingsTypesIdPut**
-> apiMeetingsTypesIdPut()
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-const { status, data } = await apiInstance.apiMeetingsTypesIdPut(
-    id
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiMeetingsTypesPost**
-> apiMeetingsTypesPost()
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-const { status, data } = await apiInstance.apiMeetingsTypesPost();
-```
-### 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)
-# **apiOrganizationsIdGet**
-> apiOrganizationsIdGet()
-This endpoint makes an HTTP GET request to retrieve a specific organization by ID. The response is a JSON object with the organization details including `_id`, `customFields`, `labels`, `fullname`, `doc`, `phones`, `owners`, `interactions`, `createdAt`, `updatedAt`.
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-const { status, data } = await apiInstance.apiOrganizationsIdGet(
-    id
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiOrganizationsIdPut**
-> apiOrganizationsIdPut()
-Atualiza os dados de uma organização existente.
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-let body: object; // (optional)
-const { status, data } = await apiInstance.apiOrganizationsIdPut(
-    id,
-    body
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **body** | **object**|  | |
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiPipelinesIdGet**
-> apiPipelinesIdGet()
-Retrieves a specific pipeline by ID. Response is a JSON object with pipeline details including `_id`, `title`, `stages` (array with stage names, positions, probabilities), `staffs`, `roles`, `defaultView`, `active`, `createdAt`, `updatedAt`.
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-const { status, data } = await apiInstance.apiPipelinesIdGet(
-    id
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiPipelinesIdPut**
-> apiPipelinesIdPut()
-Atualiza os dados de um pipeline existente, incluindo stages, roles e staffs associados.
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-let body: object; // (optional)
-const { status, data } = await apiInstance.apiPipelinesIdPut(
-    id,
-    body
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **body** | **object**|  | |
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiProspectsCONTACTIDMeetingsGet**
-> apiProspectsCONTACTIDMeetingsGet()
-List meetings for a specific prospect (by contact).
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let cONTACTID: string; // (default to undefined)
-let page: number; // (optional) (default to undefined)
-let limit: number; // (optional) (default to undefined)
-const { status, data } = await apiInstance.apiProspectsCONTACTIDMeetingsGet(
-    cONTACTID,
-    page,
-    limit
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **cONTACTID** | [**string**] |  | defaults to undefined|
-| **page** | [**number**] |  | (optional) defaults to undefined|
-| **limit** | [**number**] |  | (optional) defaults to undefined|
-### 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)
-# **apiProspectsCONTACTIDObservationsGet**
-> apiProspectsCONTACTIDObservationsGet()
-List observations for a specific prospect (by contact).
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let cONTACTID: string; // (default to undefined)
-let page: number; // (optional) (default to undefined)
-let limit: number; // (optional) (default to undefined)
-const { status, data } = await apiInstance.apiProspectsCONTACTIDObservationsGet(
-    cONTACTID,
-    page,
-    limit
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **cONTACTID** | [**string**] |  | defaults to undefined|
-| **page** | [**number**] |  | (optional) defaults to undefined|
-| **limit** | [**number**] |  | (optional) defaults to undefined|
-### 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)
-# **apiProspectsCONTACTIDTasksGet**
-> apiProspectsCONTACTIDTasksGet()
-List tasks for a specific prospect (by contact).
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let cONTACTID: string; // (default to undefined)
-let page: number; // (optional) (default to undefined)
-let limit: number; // (optional) (default to undefined)
-const { status, data } = await apiInstance.apiProspectsCONTACTIDTasksGet(
-    cONTACTID,
-    page,
-    limit
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **cONTACTID** | [**string**] |  | defaults to undefined|
-| **page** | [**number**] |  | (optional) defaults to undefined|
-| **limit** | [**number**] |  | (optional) defaults to undefined|
-### 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)
-# **apiProspectsCONTACTIDTicketsGet**
-> apiProspectsCONTACTIDTicketsGet()
-List tickets for a specific prospect (by contact).
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let cONTACTID: string; // (default to undefined)
-let page: number; // (optional) (default to undefined)
-let limit: number; // (optional) (default to undefined)
-const { status, data } = await apiInstance.apiProspectsCONTACTIDTicketsGet(
-    cONTACTID,
-    page,
-    limit
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **cONTACTID** | [**string**] |  | defaults to undefined|
-| **page** | [**number**] |  | (optional) defaults to undefined|
-| **limit** | [**number**] |  | (optional) defaults to undefined|
-### 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)
-# **apiProspectsCONTACTIDTreatmentsGet**
-> apiProspectsCONTACTIDTreatmentsGet()
-List treatments for a specific prospect (by contact).
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let cONTACTID: string; // (default to undefined)
-let page: number; // (optional) (default to undefined)
-let limit: number; // (optional) (default to undefined)
-const { status, data } = await apiInstance.apiProspectsCONTACTIDTreatmentsGet(
-    cONTACTID,
-    page,
-    limit
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **cONTACTID** | [**string**] |  | defaults to undefined|
-| **page** | [**number**] |  | (optional) defaults to undefined|
-| **limit** | [**number**] |  | (optional) defaults to undefined|
-### 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)
-# **apiProspectsIdGet**
-> apiProspectsIdGet()
-Retrieves a specific prospect by ID.
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-const { status, data } = await apiInstance.apiProspectsIdGet(
-    id
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiProspectsIdPut**
-> apiProspectsIdPut()
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-const { status, data } = await apiInstance.apiProspectsIdPut(
-    id
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiStaffsIdGet**
-> apiStaffsIdGet()
-### Get Staff Details  This endpoint makes an HTTP GET request to retrieve the details of a specific staff member.  #### Request  - Method: GET - URL: `{{base_url}}/api/staffs/:id`  #### Response  The response includes the staff member details: `_id`, `email`, `active`, `admin`, `customFields`, `fullname`, `image`, `role`, `settings`, `status`, `type`, `lastLogin`, `createdAt`, `updatedAt`.
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-const { status, data } = await apiInstance.apiStaffsIdGet(
-    id
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiStaffsIdPut**
-> apiStaffsIdPut()
-Updates staff information. The request body should include: `fullname` (string), `phone` (string), `role` (string - role ID), `workspaces` (array), `customFields` (array of objects).
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-let body: object; // (optional)
-const { status, data } = await apiInstance.apiStaffsIdPut(
-    id,
-    body
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **body** | **object**|  | |
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiStaffsPost**
-> apiStaffsPost()
-### Create a New Staff Member  This endpoint allows the creation of a new staff member.  #### Request Body  - `customFields` (array of objects) - Custom fields for the staff member. - `fullname` (string) - The full name of the staff member. - `email` (string) - The email address of the staff member. - `phone` (string) - The phone number of the staff member. - `role` (string) - The role ID assigned to the staff member. - `workspaces` (array) - The workspaces the staff member belongs to.  The staff member will receive an invitation email to set their password.
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let body: object; // (optional)
-const { status, data } = await apiInstance.apiStaffsPost(
-    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)
-# **apiTasksIdGet**
-> apiTasksIdGet()
-This endpoint retrieves a specific task by ID. Response is a JSON object with task details including `_id`, `code`, `owner`, `title`, `dateOfExpires`, `type`, `status`, `observation`, `contact`, `deal`, `createdAt`, `updatedAt`.
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-const { status, data } = await apiInstance.apiTasksIdGet(
-    id
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiTasksIdPut**
-> apiTasksIdPut()
-Atualiza os dados de uma tarefa existente.
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-let body: object; // (optional)
-const { status, data } = await apiInstance.apiTasksIdPut(
-    id,
-    body
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **body** | **object**|  | |
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiTicketsIdGet**
-> apiTicketsIdGet()
-Retrieves a specific ticket by ID. Response is a JSON object with ticket details including `_id`, `code`, `subject`, `description`, `status`, `priority`, `labels`, `contact`, `owner`, `participants`, `observers`, `createdAt`, `updatedAt`.
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-const { status, data } = await apiInstance.apiTicketsIdGet(
-    id
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiTicketsIdPut**
-> apiTicketsIdPut()
-Atualiza os dados de um ticket existente.
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-let body: object; // (optional)
-const { status, data } = await apiInstance.apiTicketsIdPut(
-    id,
-    body
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **body** | **object**|  | |
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiTreatmentsIdGet**
-> apiTreatmentsIdGet()
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-const { status, data } = await apiInstance.apiTreatmentsIdGet(
-    id
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiTreatmentsIdPut**
-> apiTreatmentsIdPut()
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-const { status, data } = await apiInstance.apiTreatmentsIdPut(
-    id
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiTreatmentsTypesIdGet**
-> apiTreatmentsTypesIdGet()
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-const { status, data } = await apiInstance.apiTreatmentsTypesIdGet(
-    id
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiTreatmentsTypesIdPut**
-> apiTreatmentsTypesIdPut()
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-const { status, data } = await apiInstance.apiTreatmentsTypesIdPut(
-    id
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiTreatmentsTypesPost**
-> apiTreatmentsTypesPost()
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-const { status, data } = await apiInstance.apiTreatmentsTypesPost();
-```
-### 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)
-# **apiTreatmentsWorkspacesGet**
-> apiTreatmentsWorkspacesGet()
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let page: number; // (optional) (default to undefined)
-let limit: number; // (optional) (default to undefined)
-let search: string; // (optional) (default to undefined)
-const { status, data } = await apiInstance.apiTreatmentsWorkspacesGet(
-    page,
-    limit,
-    search
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **page** | [**number**] |  | (optional) defaults to undefined|
-| **limit** | [**number**] |  | (optional) defaults to undefined|
-| **search** | [**string**] |  | (optional) defaults to undefined|
-### 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)
-# **apiTreatmentsWorkspacesIdGet**
-> apiTreatmentsWorkspacesIdGet()
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-const { status, data } = await apiInstance.apiTreatmentsWorkspacesIdGet(
-    id
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiTreatmentsWorkspacesIdPut**
-> apiTreatmentsWorkspacesIdPut()
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-let id: string; // (default to undefined)
-const { status, data } = await apiInstance.apiTreatmentsWorkspacesIdPut(
-    id
-);
-```
-### Parameters
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
-### 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)
-# **apiTreatmentsWorkspacesPost**
-> apiTreatmentsWorkspacesPost()
-### Example
-```typescript
-import {
-    ResourcesApi,
-    Configuration
-} from '@magnetcustomer/sdk';
-const configuration = new Configuration();
-const apiInstance = new ResourcesApi(configuration);
-const { status, data } = await apiInstance.apiTreatmentsWorkspacesPost();
-```
-### 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)