pipedrive 23.2.5-rc.2 → 23.3.0-rc.4

package/docs/OrganizationsApi.md

@@ -1,1206 +0,0 @@
-# Pipedrive.OrganizationsApi
-
-All URIs are relative to *https://api.pipedrive.com/v1*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**addOrganization**](OrganizationsApi.md#addOrganization) | **POST** /organizations | Add an organization
-[**addOrganizationFollower**](OrganizationsApi.md#addOrganizationFollower) | **POST** /organizations/{id}/followers | Add a follower to an organization
-[**deleteOrganization**](OrganizationsApi.md#deleteOrganization) | **DELETE** /organizations/{id} | Delete an organization
-[**deleteOrganizationFollower**](OrganizationsApi.md#deleteOrganizationFollower) | **DELETE** /organizations/{id}/followers/{follower_id} | Delete a follower from an organization
-[**deleteOrganizations**](OrganizationsApi.md#deleteOrganizations) | **DELETE** /organizations | Delete multiple organizations in bulk
-[**getOrganization**](OrganizationsApi.md#getOrganization) | **GET** /organizations/{id} | Get details of an organization
-[**getOrganizationActivities**](OrganizationsApi.md#getOrganizationActivities) | **GET** /organizations/{id}/activities | List activities associated with an organization
-[**getOrganizationChangelog**](OrganizationsApi.md#getOrganizationChangelog) | **GET** /organizations/{id}/changelog | List updates about organization field values
-[**getOrganizationDeals**](OrganizationsApi.md#getOrganizationDeals) | **GET** /organizations/{id}/deals | List deals associated with an organization
-[**getOrganizationFiles**](OrganizationsApi.md#getOrganizationFiles) | **GET** /organizations/{id}/files | List files attached to an organization
-[**getOrganizationFollowers**](OrganizationsApi.md#getOrganizationFollowers) | **GET** /organizations/{id}/followers | List followers of an organization
-[**getOrganizationMailMessages**](OrganizationsApi.md#getOrganizationMailMessages) | **GET** /organizations/{id}/mailMessages | List mail messages associated with an organization
-[**getOrganizationPersons**](OrganizationsApi.md#getOrganizationPersons) | **GET** /organizations/{id}/persons | List persons of an organization
-[**getOrganizationUpdates**](OrganizationsApi.md#getOrganizationUpdates) | **GET** /organizations/{id}/flow | List updates about an organization
-[**getOrganizationUsers**](OrganizationsApi.md#getOrganizationUsers) | **GET** /organizations/{id}/permittedUsers | List permitted users
-[**getOrganizations**](OrganizationsApi.md#getOrganizations) | **GET** /organizations | Get all organizations
-[**getOrganizationsCollection**](OrganizationsApi.md#getOrganizationsCollection) | **GET** /organizations/collection | Get all organizations (BETA)
-[**mergeOrganizations**](OrganizationsApi.md#mergeOrganizations) | **PUT** /organizations/{id}/merge | Merge two organizations
-[**searchOrganization**](OrganizationsApi.md#searchOrganization) | **GET** /organizations/search | Search organizations
-[**updateOrganization**](OrganizationsApi.md#updateOrganization) | **PUT** /organizations/{id} | Update an organization
-
-
-
-## addOrganization
-
-> OrganizationPostResponse addOrganization(opts)
-
-Add an organization
-
-Adds a new organization. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the organizationFields and look for `key` values. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-an-organization\" target=\"_blank\" rel=\"noopener noreferrer\">adding an organization</a>.
-
-### Example
-
-```javascript
-import Pipedrive from 'pipedrive';
-let apiClient = new Pipedrive.ApiClient();
-// Configure API key authorization: api_key
-let api_key = apiClient.authentications['api_key'];
-api_key.apiKey = 'YOUR API KEY';
-// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
-//api_key.apiKeyPrefix = 'Token';
-// Configure OAuth2 access token for authorization: oauth2
-let oauth2 = apiClient.authentications['oauth2'];
-oauth2.accessToken = 'YOUR ACCESS TOKEN';
-
-let apiInstance = new Pipedrive.OrganizationsApi(apiClient);
-let opts = Pipedrive.NewOrganization.constructFromObject({
-  // Properties that you want to update
-});
-apiInstance.addOrganization(opts).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **NewOrganization** | [**NewOrganization**](NewOrganization.md)|  | [optional] 
-
-### Return type
-
-[**OrganizationPostResponse**](OrganizationPostResponse.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## addOrganizationFollower
-
-> OrganizationFollowerPostResponse addOrganizationFollower(id, opts)
-
-Add a follower to an organization
-
-Adds a follower to an organization.
-
-### Example
-
-```javascript
-import Pipedrive from 'pipedrive';
-let apiClient = new Pipedrive.ApiClient();
-// Configure API key authorization: api_key
-let api_key = apiClient.authentications['api_key'];
-api_key.apiKey = 'YOUR API KEY';
-// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
-//api_key.apiKeyPrefix = 'Token';
-// Configure OAuth2 access token for authorization: oauth2
-let oauth2 = apiClient.authentications['oauth2'];
-oauth2.accessToken = 'YOUR ACCESS TOKEN';
-
-let apiInstance = new Pipedrive.OrganizationsApi(apiClient);
-let id = 56; // Number | The ID of the organization
-let opts = Pipedrive.AddOrganizationFollowerRequest.constructFromObject({
-  // Properties that you want to update
-});
-apiInstance.addOrganizationFollower(id, opts).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **Number**| The ID of the organization | 
- **AddOrganizationFollowerRequest** | [**AddOrganizationFollowerRequest**](AddOrganizationFollowerRequest.md)|  | [optional] 
-
-### Return type
-
-[**OrganizationFollowerPostResponse**](OrganizationFollowerPostResponse.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## deleteOrganization
-
-> OrganizationDeleteResponse deleteOrganization(id)
-
-Delete an organization
-
-Marks an organization as deleted. After 30 days, the organization will be permanently deleted.
-
-### Example
-
-```javascript
-import Pipedrive from 'pipedrive';
-let apiClient = new Pipedrive.ApiClient();
-// Configure API key authorization: api_key
-let api_key = apiClient.authentications['api_key'];
-api_key.apiKey = 'YOUR API KEY';
-// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
-//api_key.apiKeyPrefix = 'Token';
-// Configure OAuth2 access token for authorization: oauth2
-let oauth2 = apiClient.authentications['oauth2'];
-oauth2.accessToken = 'YOUR ACCESS TOKEN';
-
-let apiInstance = new Pipedrive.OrganizationsApi(apiClient);
-let id = 56; // Number | The ID of the organization
-apiInstance.deleteOrganization(id).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **Number**| The ID of the organization | 
-
-### Return type
-
-[**OrganizationDeleteResponse**](OrganizationDeleteResponse.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## deleteOrganizationFollower
-
-> OrganizationFollowerDeleteResponse deleteOrganizationFollower(id, followerId)
-
-Delete a follower from an organization
-
-Deletes a follower from an organization. You can retrieve the `follower_id` from the <a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#getOrganizationFollowers\">List followers of an organization</a> endpoint.
-
-### Example
-
-```javascript
-import Pipedrive from 'pipedrive';
-let apiClient = new Pipedrive.ApiClient();
-// Configure API key authorization: api_key
-let api_key = apiClient.authentications['api_key'];
-api_key.apiKey = 'YOUR API KEY';
-// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
-//api_key.apiKeyPrefix = 'Token';
-// Configure OAuth2 access token for authorization: oauth2
-let oauth2 = apiClient.authentications['oauth2'];
-oauth2.accessToken = 'YOUR ACCESS TOKEN';
-
-let apiInstance = new Pipedrive.OrganizationsApi(apiClient);
-let id = 56; // Number | The ID of the organization
-let followerId = 56; // Number | The ID of the follower
-apiInstance.deleteOrganizationFollower(id, followerId).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **Number**| The ID of the organization | 
- **follower_id** | **Number**| The ID of the follower | 
-
-### Return type
-
-[**OrganizationFollowerDeleteResponse**](OrganizationFollowerDeleteResponse.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## deleteOrganizations
-
-> OrganizationsDeleteResponse deleteOrganizations(ids)
-
-Delete multiple organizations in bulk
-
-Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted.
-
-### Example
-
-```javascript
-import Pipedrive from 'pipedrive';
-let apiClient = new Pipedrive.ApiClient();
-// Configure API key authorization: api_key
-let api_key = apiClient.authentications['api_key'];
-api_key.apiKey = 'YOUR API KEY';
-// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
-//api_key.apiKeyPrefix = 'Token';
-// Configure OAuth2 access token for authorization: oauth2
-let oauth2 = apiClient.authentications['oauth2'];
-oauth2.accessToken = 'YOUR ACCESS TOKEN';
-
-let apiInstance = new Pipedrive.OrganizationsApi(apiClient);
-let ids = "ids_example"; // String | The comma-separated IDs that will be deleted
-apiInstance.deleteOrganizations(ids).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **ids** | **String**| The comma-separated IDs that will be deleted | 
-
-### Return type
-
-[**OrganizationsDeleteResponse**](OrganizationsDeleteResponse.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## getOrganization
-
-> OrganizationDetailsGetResponse getOrganization(id)
-
-Get details of an organization
-
-Returns the details of an organization. Note that this also returns some additional fields which are not present when asking for all organizations. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of organizationFields.
-
-### Example
-
-```javascript
-import Pipedrive from 'pipedrive';
-let apiClient = new Pipedrive.ApiClient();
-// Configure API key authorization: api_key
-let api_key = apiClient.authentications['api_key'];
-api_key.apiKey = 'YOUR API KEY';
-// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
-//api_key.apiKeyPrefix = 'Token';
-// Configure OAuth2 access token for authorization: oauth2
-let oauth2 = apiClient.authentications['oauth2'];
-oauth2.accessToken = 'YOUR ACCESS TOKEN';
-
-let apiInstance = new Pipedrive.OrganizationsApi(apiClient);
-let id = 56; // Number | The ID of the organization
-apiInstance.getOrganization(id).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **Number**| The ID of the organization | 
-
-### Return type
-
-[**OrganizationDetailsGetResponse**](OrganizationDetailsGetResponse.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## getOrganizationActivities
-
-> ListActivitiesResponse getOrganizationActivities(id, opts)
-
-List activities associated with an organization
-
-Lists activities associated with an organization.
-
-### Example
-
-```javascript
-import Pipedrive from 'pipedrive';
-let apiClient = new Pipedrive.ApiClient();
-// Configure API key authorization: api_key
-let api_key = apiClient.authentications['api_key'];
-api_key.apiKey = 'YOUR API KEY';
-// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
-//api_key.apiKeyPrefix = 'Token';
-// Configure OAuth2 access token for authorization: oauth2
-let oauth2 = apiClient.authentications['oauth2'];
-oauth2.accessToken = 'YOUR ACCESS TOKEN';
-
-let apiInstance = new Pipedrive.OrganizationsApi(apiClient);
-let id = 56; // Number | The ID of the organization
-// snake_case as well as camelCase is supported for naming opts properties
-let opts = {
-  'start': 0, // Number | Pagination start
-  'limit': 56, // Number | Items shown per page
-  'done': new Pipedrive.NumberBoolean(), // NumberBoolean | Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted returns both Done and Not done activities.
-  'exclude': "exclude_example" // String | A comma-separated string of activity IDs to exclude from result
-};
-apiInstance.getOrganizationActivities(id, opts).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **Number**| The ID of the organization | 
- **start** | **Number**| Pagination start | [optional] [default to 0]
- **limit** | **Number**| Items shown per page | [optional] 
- **done** | [**NumberBoolean**](.md)| Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted returns both Done and Not done activities. | [optional] 
- **exclude** | **String**| A comma-separated string of activity IDs to exclude from result | [optional] 
-
-### Return type
-
-[**ListActivitiesResponse**](ListActivitiesResponse.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## getOrganizationChangelog
-
-> ChangelogResponse getOrganizationChangelog(id, opts)
-
-List updates about organization field values
-
-Lists updates about field values of an organization.
-
-### Example
-
-```javascript
-import Pipedrive from 'pipedrive';
-let apiClient = new Pipedrive.ApiClient();
-// Configure API key authorization: api_key
-let api_key = apiClient.authentications['api_key'];
-api_key.apiKey = 'YOUR API KEY';
-// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
-//api_key.apiKeyPrefix = 'Token';
-// Configure OAuth2 access token for authorization: oauth2
-let oauth2 = apiClient.authentications['oauth2'];
-oauth2.accessToken = 'YOUR ACCESS TOKEN';
-
-let apiInstance = new Pipedrive.OrganizationsApi(apiClient);
-let id = 56; // Number | The ID of the organization
-// snake_case as well as camelCase is supported for naming opts properties
-let opts = {
-  'cursor': "cursor_example", // String | For pagination, the marker (an opaque string value) representing the first item on the next page
-  'limit': 56 // Number | Items shown per page
-};
-apiInstance.getOrganizationChangelog(id, opts).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **Number**| The ID of the organization | 
- **cursor** | **String**| For pagination, the marker (an opaque string value) representing the first item on the next page | [optional] 
- **limit** | **Number**| Items shown per page | [optional] 
-
-### Return type
-
-[**ChangelogResponse**](ChangelogResponse.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## getOrganizationDeals
-
-> ListDealsResponse getOrganizationDeals(id, opts)
-
-List deals associated with an organization
-
-Lists deals associated with an organization.
-
-### Example
-
-```javascript
-import Pipedrive from 'pipedrive';
-let apiClient = new Pipedrive.ApiClient();
-// Configure API key authorization: api_key
-let api_key = apiClient.authentications['api_key'];
-api_key.apiKey = 'YOUR API KEY';
-// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
-//api_key.apiKeyPrefix = 'Token';
-// Configure OAuth2 access token for authorization: oauth2
-let oauth2 = apiClient.authentications['oauth2'];
-oauth2.accessToken = 'YOUR ACCESS TOKEN';
-
-let apiInstance = new Pipedrive.OrganizationsApi(apiClient);
-let id = 56; // Number | The ID of the organization
-// snake_case as well as camelCase is supported for naming opts properties
-let opts = {
-  'start': 0, // Number | Pagination start
-  'limit': 56, // Number | Items shown per page
-  'status': "'all_not_deleted'", // String | Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included.
-  'sort': "sort_example", // String | The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
-  'onlyPrimaryAssociation': new Pipedrive.NumberBoolean() // NumberBoolean | If set, only deals that are directly associated to the organization are fetched. If not set (default), all deals are fetched that are either directly or indirectly related to the organization. Indirect relations include relations through custom, organization-type fields and through persons of the given organization.
-};
-apiInstance.getOrganizationDeals(id, opts).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **Number**| The ID of the organization | 
- **start** | **Number**| Pagination start | [optional] [default to 0]
- **limit** | **Number**| Items shown per page | [optional] 
- **status** | **String**| Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. | [optional] [default to 'all_not_deleted']
- **sort** | **String**| The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). | [optional] 
- **only_primary_association** | [**NumberBoolean**](.md)| If set, only deals that are directly associated to the organization are fetched. If not set (default), all deals are fetched that are either directly or indirectly related to the organization. Indirect relations include relations through custom, organization-type fields and through persons of the given organization. | [optional] 
-
-### Return type
-
-[**ListDealsResponse**](ListDealsResponse.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## getOrganizationFiles
-
-> ListFilesResponse getOrganizationFiles(id, opts)
-
-List files attached to an organization
-
-Lists files associated with an organization.
-
-### Example
-
-```javascript
-import Pipedrive from 'pipedrive';
-let apiClient = new Pipedrive.ApiClient();
-// Configure API key authorization: api_key
-let api_key = apiClient.authentications['api_key'];
-api_key.apiKey = 'YOUR API KEY';
-// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
-//api_key.apiKeyPrefix = 'Token';
-// Configure OAuth2 access token for authorization: oauth2
-let oauth2 = apiClient.authentications['oauth2'];
-oauth2.accessToken = 'YOUR ACCESS TOKEN';
-
-let apiInstance = new Pipedrive.OrganizationsApi(apiClient);
-let id = 56; // Number | The ID of the organization
-// snake_case as well as camelCase is supported for naming opts properties
-let opts = {
-  'start': 0, // Number | Pagination start
-  'limit': 56, // Number | Items shown per page
-  'sort': "sort_example" // String | The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `product_id`, `add_time`, `update_time`, `file_name`, `file_type`, `file_size`, `comment`.
-};
-apiInstance.getOrganizationFiles(id, opts).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **Number**| The ID of the organization | 
- **start** | **Number**| Pagination start | [optional] [default to 0]
- **limit** | **Number**| Items shown per page | [optional] 
- **sort** | **String**| The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `product_id`, `add_time`, `update_time`, `file_name`, `file_type`, `file_size`, `comment`. | [optional] 
-
-### Return type
-
-[**ListFilesResponse**](ListFilesResponse.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## getOrganizationFollowers
-
-> OrganizationFollowersListResponse getOrganizationFollowers(id)
-
-List followers of an organization
-
-Lists the followers of an organization.
-
-### Example
-
-```javascript
-import Pipedrive from 'pipedrive';
-let apiClient = new Pipedrive.ApiClient();
-// Configure API key authorization: api_key
-let api_key = apiClient.authentications['api_key'];
-api_key.apiKey = 'YOUR API KEY';
-// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
-//api_key.apiKeyPrefix = 'Token';
-// Configure OAuth2 access token for authorization: oauth2
-let oauth2 = apiClient.authentications['oauth2'];
-oauth2.accessToken = 'YOUR ACCESS TOKEN';
-
-let apiInstance = new Pipedrive.OrganizationsApi(apiClient);
-let id = 56; // Number | The ID of the organization
-apiInstance.getOrganizationFollowers(id).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **Number**| The ID of the organization | 
-
-### Return type
-
-[**OrganizationFollowersListResponse**](OrganizationFollowersListResponse.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## getOrganizationMailMessages
-
-> ListMailMessagesResponse getOrganizationMailMessages(id, opts)
-
-List mail messages associated with an organization
-
-Lists mail messages associated with an organization.
-
-### Example
-
-```javascript
-import Pipedrive from 'pipedrive';
-let apiClient = new Pipedrive.ApiClient();
-// Configure API key authorization: api_key
-let api_key = apiClient.authentications['api_key'];
-api_key.apiKey = 'YOUR API KEY';
-// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
-//api_key.apiKeyPrefix = 'Token';
-// Configure OAuth2 access token for authorization: oauth2
-let oauth2 = apiClient.authentications['oauth2'];
-oauth2.accessToken = 'YOUR ACCESS TOKEN';
-
-let apiInstance = new Pipedrive.OrganizationsApi(apiClient);
-let id = 56; // Number | The ID of the organization
-// snake_case as well as camelCase is supported for naming opts properties
-let opts = {
-  'start': 0, // Number | Pagination start
-  'limit': 56 // Number | Items shown per page
-};
-apiInstance.getOrganizationMailMessages(id, opts).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **Number**| The ID of the organization | 
- **start** | **Number**| Pagination start | [optional] [default to 0]
- **limit** | **Number**| Items shown per page | [optional] 
-
-### Return type
-
-[**ListMailMessagesResponse**](ListMailMessagesResponse.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## getOrganizationPersons
-
-> ListPersonsResponse getOrganizationPersons(id, opts)
-
-List persons of an organization
-
-Lists persons associated with an organization.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
-
-### Example
-
-```javascript
-import Pipedrive from 'pipedrive';
-let apiClient = new Pipedrive.ApiClient();
-// Configure API key authorization: api_key
-let api_key = apiClient.authentications['api_key'];
-api_key.apiKey = 'YOUR API KEY';
-// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
-//api_key.apiKeyPrefix = 'Token';
-// Configure OAuth2 access token for authorization: oauth2
-let oauth2 = apiClient.authentications['oauth2'];
-oauth2.accessToken = 'YOUR ACCESS TOKEN';
-
-let apiInstance = new Pipedrive.OrganizationsApi(apiClient);
-let id = 56; // Number | The ID of the organization
-// snake_case as well as camelCase is supported for naming opts properties
-let opts = {
-  'start': 0, // Number | Pagination start
-  'limit': 56 // Number | Items shown per page
-};
-apiInstance.getOrganizationPersons(id, opts).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **Number**| The ID of the organization | 
- **start** | **Number**| Pagination start | [optional] [default to 0]
- **limit** | **Number**| Items shown per page | [optional] 
-
-### Return type
-
-[**ListPersonsResponse**](ListPersonsResponse.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## getOrganizationUpdates
-
-> OrganizationFlowResponse getOrganizationUpdates(id, opts)
-
-List updates about an organization
-
-Lists updates about an organization.
-
-### Example
-
-```javascript
-import Pipedrive from 'pipedrive';
-let apiClient = new Pipedrive.ApiClient();
-// Configure API key authorization: api_key
-let api_key = apiClient.authentications['api_key'];
-api_key.apiKey = 'YOUR API KEY';
-// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
-//api_key.apiKeyPrefix = 'Token';
-// Configure OAuth2 access token for authorization: oauth2
-let oauth2 = apiClient.authentications['oauth2'];
-oauth2.accessToken = 'YOUR ACCESS TOKEN';
-
-let apiInstance = new Pipedrive.OrganizationsApi(apiClient);
-let id = 56; // Number | The ID of the organization
-// snake_case as well as camelCase is supported for naming opts properties
-let opts = {
-  'start': 0, // Number | Pagination start
-  'limit': 56, // Number | Items shown per page
-  'allChanges': "allChanges_example", // String | Whether to show custom field updates or not. 1 = Include custom field changes. If omitted, returns changes without custom field updates.
-  'items': "items_example" // String | A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document).
-};
-apiInstance.getOrganizationUpdates(id, opts).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **Number**| The ID of the organization | 
- **start** | **Number**| Pagination start | [optional] [default to 0]
- **limit** | **Number**| Items shown per page | [optional] 
- **all_changes** | **String**| Whether to show custom field updates or not. 1 = Include custom field changes. If omitted, returns changes without custom field updates. | [optional] 
- **items** | **String**| A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document). | [optional] 
-
-### Return type
-
-[**OrganizationFlowResponse**](OrganizationFlowResponse.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## getOrganizationUsers
-
-> ListPermittedUsersResponse1 getOrganizationUsers(id)
-
-List permitted users
-
-List users permitted to access an organization.
-
-### Example
-
-```javascript
-import Pipedrive from 'pipedrive';
-let apiClient = new Pipedrive.ApiClient();
-// Configure API key authorization: api_key
-let api_key = apiClient.authentications['api_key'];
-api_key.apiKey = 'YOUR API KEY';
-// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
-//api_key.apiKeyPrefix = 'Token';
-// Configure OAuth2 access token for authorization: oauth2
-let oauth2 = apiClient.authentications['oauth2'];
-oauth2.accessToken = 'YOUR ACCESS TOKEN';
-
-let apiInstance = new Pipedrive.OrganizationsApi(apiClient);
-let id = 56; // Number | The ID of the organization
-apiInstance.getOrganizationUsers(id).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **Number**| The ID of the organization | 
-
-### Return type
-
-[**ListPermittedUsersResponse1**](ListPermittedUsersResponse1.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## getOrganizations
-
-> AllOrganizationsGetResponse getOrganizations(opts)
-
-Get all organizations
-
-Returns all organizations.
-
-### Example
-
-```javascript
-import Pipedrive from 'pipedrive';
-let apiClient = new Pipedrive.ApiClient();
-// Configure API key authorization: api_key
-let api_key = apiClient.authentications['api_key'];
-api_key.apiKey = 'YOUR API KEY';
-// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
-//api_key.apiKeyPrefix = 'Token';
-// Configure OAuth2 access token for authorization: oauth2
-let oauth2 = apiClient.authentications['oauth2'];
-oauth2.accessToken = 'YOUR ACCESS TOKEN';
-
-let apiInstance = new Pipedrive.OrganizationsApi(apiClient);
-// snake_case as well as camelCase is supported for naming opts properties
-let opts = {
-  'userId': 56, // Number | If supplied, only organizations owned by the given user will be returned. However, `filter_id` takes precedence over `user_id` when both are supplied.
-  'filterId': 56, // Number | The ID of the filter to use
-  'firstChar': "firstChar_example", // String | If supplied, only organizations whose name starts with the specified letter will be returned (case-insensitive)
-  'start': 0, // Number | Pagination start
-  'limit': 56, // Number | Items shown per page
-  'sort': "sort_example" // String | The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
-};
-apiInstance.getOrganizations(opts).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **user_id** | **Number**| If supplied, only organizations owned by the given user will be returned. However, `filter_id` takes precedence over `user_id` when both are supplied. | [optional] 
- **filter_id** | **Number**| The ID of the filter to use | [optional] 
- **first_char** | **String**| If supplied, only organizations whose name starts with the specified letter will be returned (case-insensitive) | [optional] 
- **start** | **Number**| Pagination start | [optional] [default to 0]
- **limit** | **Number**| Items shown per page | [optional] 
- **sort** | **String**| The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). | [optional] 
-
-### Return type
-
-[**AllOrganizationsGetResponse**](AllOrganizationsGetResponse.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## getOrganizationsCollection
-
-> InlineResponse2001 getOrganizationsCollection(opts)
-
-Get all organizations (BETA)
-
-Returns all organizations. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-pagination\" target=\"_blank\" rel=\"noopener noreferrer\">pagination</a>. Please note that only global admins (those with global permissions) can access these endpoints. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
-
-### Example
-
-```javascript
-import Pipedrive from 'pipedrive';
-let apiClient = new Pipedrive.ApiClient();
-// Configure API key authorization: api_key
-let api_key = apiClient.authentications['api_key'];
-api_key.apiKey = 'YOUR API KEY';
-// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
-//api_key.apiKeyPrefix = 'Token';
-// Configure OAuth2 access token for authorization: oauth2
-let oauth2 = apiClient.authentications['oauth2'];
-oauth2.accessToken = 'YOUR ACCESS TOKEN';
-
-let apiInstance = new Pipedrive.OrganizationsApi(apiClient);
-// snake_case as well as camelCase is supported for naming opts properties
-let opts = {
-  'cursor': "cursor_example", // String | For pagination, the marker (an opaque string value) representing the first item on the next page
-  'limit': 100, // Number | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
-  'since': "since_example", // String | The time boundary that points to the start of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
-  'until': "until_example", // String | The time boundary that points to the end of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
-  'ownerId': 56, // Number | If supplied, only organizations owned by the given user will be returned
-  'firstChar': "firstChar_example" // String | If supplied, only organizations whose name starts with the specified letter will be returned (case-insensitive)
-};
-apiInstance.getOrganizationsCollection(opts).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **cursor** | **String**| For pagination, the marker (an opaque string value) representing the first item on the next page | [optional] 
- **limit** | **Number**| For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. | [optional] 
- **since** | **String**| The time boundary that points to the start of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field. | [optional] 
- **until** | **String**| The time boundary that points to the end of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field. | [optional] 
- **owner_id** | **Number**| If supplied, only organizations owned by the given user will be returned | [optional] 
- **first_char** | **String**| If supplied, only organizations whose name starts with the specified letter will be returned (case-insensitive) | [optional] 
-
-### Return type
-
-[**InlineResponse2001**](InlineResponse2001.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## mergeOrganizations
-
-> OrganizationsMergeResponse mergeOrganizations(id, opts)
-
-Merge two organizations
-
-Merges an organization with another organization. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/merging-two-organizations\" target=\"_blank\" rel=\"noopener noreferrer\">merging two organizations</a>.
-
-### Example
-
-```javascript
-import Pipedrive from 'pipedrive';
-let apiClient = new Pipedrive.ApiClient();
-// Configure API key authorization: api_key
-let api_key = apiClient.authentications['api_key'];
-api_key.apiKey = 'YOUR API KEY';
-// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
-//api_key.apiKeyPrefix = 'Token';
-// Configure OAuth2 access token for authorization: oauth2
-let oauth2 = apiClient.authentications['oauth2'];
-oauth2.accessToken = 'YOUR ACCESS TOKEN';
-
-let apiInstance = new Pipedrive.OrganizationsApi(apiClient);
-let id = 56; // Number | The ID of the organization
-let opts = Pipedrive.MergeOrganizationsRequest.constructFromObject({
-  // Properties that you want to update
-});
-apiInstance.mergeOrganizations(id, opts).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **Number**| The ID of the organization | 
- **MergeOrganizationsRequest** | [**MergeOrganizationsRequest**](MergeOrganizationsRequest.md)|  | [optional] 
-
-### Return type
-
-[**OrganizationsMergeResponse**](OrganizationsMergeResponse.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## searchOrganization
-
-> OrganizationSearchResponse searchOrganization(term, opts)
-
-Search organizations
-
-Searches all organizations by name, address, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope.
-
-### Example
-
-```javascript
-import Pipedrive from 'pipedrive';
-let apiClient = new Pipedrive.ApiClient();
-// Configure API key authorization: api_key
-let api_key = apiClient.authentications['api_key'];
-api_key.apiKey = 'YOUR API KEY';
-// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
-//api_key.apiKeyPrefix = 'Token';
-// Configure OAuth2 access token for authorization: oauth2
-let oauth2 = apiClient.authentications['oauth2'];
-oauth2.accessToken = 'YOUR ACCESS TOKEN';
-
-let apiInstance = new Pipedrive.OrganizationsApi(apiClient);
-let term = "term_example"; // String | The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
-// snake_case as well as camelCase is supported for naming opts properties
-let opts = {
-  'fields': "fields_example", // String | A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
-  'exactMatch': true, // Boolean | When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
-  'start': 0, // Number | Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.
-  'limit': 56 // Number | Items shown per page
-};
-apiInstance.searchOrganization(term, opts).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **term** | **String**| The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded. | 
- **fields** | **String**| A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: &#x60;address&#x60;, &#x60;varchar&#x60;, &#x60;text&#x60;, &#x60;varchar_auto&#x60;, &#x60;double&#x60;, &#x60;monetary&#x60; and &#x60;phone&#x60;. Read more about searching by custom fields &lt;a href&#x3D;\&quot;https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener noreferrer\&quot;&gt;here&lt;/a&gt;. | [optional] 
- **exact_match** | **Boolean**| When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive. | [optional] 
- **start** | **Number**| Pagination start. Note that the pagination is based on main results and does not include related items when using &#x60;search_for_related_items&#x60; parameter. | [optional] [default to 0]
- **limit** | **Number**| Items shown per page | [optional] 
-
-### Return type
-
-[**OrganizationSearchResponse**](OrganizationSearchResponse.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## updateOrganization
-
-> OrganizationUpdateResponse updateOrganization(id, opts)
-
-Update an organization
-
-Updates the properties of an organization.
-
-### Example
-
-```javascript
-import Pipedrive from 'pipedrive';
-let apiClient = new Pipedrive.ApiClient();
-// Configure API key authorization: api_key
-let api_key = apiClient.authentications['api_key'];
-api_key.apiKey = 'YOUR API KEY';
-// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
-//api_key.apiKeyPrefix = 'Token';
-// Configure OAuth2 access token for authorization: oauth2
-let oauth2 = apiClient.authentications['oauth2'];
-oauth2.accessToken = 'YOUR ACCESS TOKEN';
-
-let apiInstance = new Pipedrive.OrganizationsApi(apiClient);
-let id = 56; // Number | The ID of the organization
-let opts = Pipedrive.UpdateOrganization.constructFromObject({
-  // Properties that you want to update
-});
-apiInstance.updateOrganization(id, opts).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **Number**| The ID of the organization | 
- **UpdateOrganization** | [**UpdateOrganization**](UpdateOrganization.md)|  | [optional] 
-
-### Return type
-
-[**OrganizationUpdateResponse**](OrganizationUpdateResponse.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-