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

package/docs/UsersApi.md

@@ -1,558 +0,0 @@
-# Pipedrive.UsersApi
-
-All URIs are relative to *https://api.pipedrive.com/v1*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**addUser**](UsersApi.md#addUser) | **POST** /users | Add a new user
-[**findUsersByName**](UsersApi.md#findUsersByName) | **GET** /users/find | Find users by name
-[**getCurrentUser**](UsersApi.md#getCurrentUser) | **GET** /users/me | Get current user data
-[**getUser**](UsersApi.md#getUser) | **GET** /users/{id} | Get one user
-[**getUserFollowers**](UsersApi.md#getUserFollowers) | **GET** /users/{id}/followers | List followers of a user
-[**getUserPermissions**](UsersApi.md#getUserPermissions) | **GET** /users/{id}/permissions | List user permissions
-[**getUserRoleAssignments**](UsersApi.md#getUserRoleAssignments) | **GET** /users/{id}/roleAssignments | List role assignments
-[**getUserRoleSettings**](UsersApi.md#getUserRoleSettings) | **GET** /users/{id}/roleSettings | List user role settings
-[**getUsers**](UsersApi.md#getUsers) | **GET** /users | Get all users
-[**updateUser**](UsersApi.md#updateUser) | **PUT** /users/{id} | Update user details
-
-
-
-## addUser
-
-> User addUser(opts)
-
-Add a new user
-
-Adds a new user to the company, returns the ID upon success.
-
-### 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.UsersApi(apiClient);
-let opts = Pipedrive.AddUserRequest.constructFromObject({
-  // Properties that you want to update
-});
-apiInstance.addUser(opts).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **AddUserRequest** | [**AddUserRequest**](AddUserRequest.md)|  | [optional] 
-
-### Return type
-
-[**User**](User.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## findUsersByName
-
-> Users findUsersByName(term, opts)
-
-Find users by name
-
-Finds users by their name.
-
-### 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.UsersApi(apiClient);
-let term = "term_example"; // String | The search term to look for
-// snake_case as well as camelCase is supported for naming opts properties
-let opts = {
-  'searchByEmail': new Pipedrive.NumberBooleanDefault0() // NumberBooleanDefault0 | When enabled, the term will only be matched against email addresses of users. Default: `false`.
-};
-apiInstance.findUsersByName(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 | 
- **search_by_email** | [**NumberBooleanDefault0**](.md)| When enabled, the term will only be matched against email addresses of users. Default: `false`. | [optional] 
-
-### Return type
-
-[**Users**](Users.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## getCurrentUser
-
-> UserMe getCurrentUser()
-
-Get current user data
-
-Returns data about an authorized user within the company with bound company data: company ID, company name, and domain. Note that the `locale` property means 'Date/number format' in the Pipedrive account settings, not the chosen language.
-
-### 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.UsersApi(apiClient);
-apiInstance.getCurrentUser().then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-This endpoint does not need any parameter.
-
-### Return type
-
-[**UserMe**](UserMe.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## getUser
-
-> User getUser(id)
-
-Get one user
-
-Returns data about a specific user within the company.
-
-### 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.UsersApi(apiClient);
-let id = 56; // Number | The ID of the user
-apiInstance.getUser(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 user | 
-
-### Return type
-
-[**User**](User.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## getUserFollowers
-
-> UserIDs getUserFollowers(id)
-
-List followers of a user
-
-Lists the followers of a specific user.
-
-### 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.UsersApi(apiClient);
-let id = 56; // Number | The ID of the user
-apiInstance.getUserFollowers(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 user | 
-
-### Return type
-
-[**UserIDs**](UserIDs.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## getUserPermissions
-
-> UserPermissions getUserPermissions(id)
-
-List user permissions
-
-Lists aggregated permissions over all assigned permission sets for a user.
-
-### 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.UsersApi(apiClient);
-let id = 56; // Number | The ID of the user
-apiInstance.getUserPermissions(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 user | 
-
-### Return type
-
-[**UserPermissions**](UserPermissions.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## getUserRoleAssignments
-
-> GetRoleAssignments getUserRoleAssignments(id, opts)
-
-List role assignments
-
-Lists role assignments for a user.
-
-### 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.UsersApi(apiClient);
-let id = 56; // Number | The ID of the user
-// 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.getUserRoleAssignments(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 user | 
- **start** | **Number**| Pagination start | [optional] [default to 0]
- **limit** | **Number**| Items shown per page | [optional] 
-
-### Return type
-
-[**GetRoleAssignments**](GetRoleAssignments.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## getUserRoleSettings
-
-> GetRoleSettings getUserRoleSettings(id)
-
-List user role settings
-
-Lists the settings of user's assigned role.
-
-### 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.UsersApi(apiClient);
-let id = 56; // Number | The ID of the user
-apiInstance.getUserRoleSettings(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 user | 
-
-### Return type
-
-[**GetRoleSettings**](GetRoleSettings.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## getUsers
-
-> Users getUsers()
-
-Get all users
-
-Returns data about all users within the company.
-
-### 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.UsersApi(apiClient);
-apiInstance.getUsers().then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-This endpoint does not need any parameter.
-
-### Return type
-
-[**Users**](Users.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## updateUser
-
-> User updateUser(id, opts)
-
-Update user details
-
-Updates the properties of a user. Currently, only `active_flag` can be updated.
-
-### 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.UsersApi(apiClient);
-let id = 56; // Number | The ID of the user
-let opts = Pipedrive.UpdateUserRequest.constructFromObject({
-  // Properties that you want to update
-});
-apiInstance.updateUser(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 user | 
- **UpdateUserRequest** | [**UpdateUserRequest**](UpdateUserRequest.md)|  | [optional] 
-
-### Return type
-
-[**User**](User.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-

package/docs/VisibleTo.md

@@ -1,14 +0,0 @@
-# Pipedrive.VisibleTo
-
-## Enum
-
-
-* `1` (value: `"1"`)
-
-* `3` (value: `"3"`)
-
-* `5` (value: `"5"`)
-
-* `7` (value: `"7"`)
-
-

package/docs/Webhook.md

@@ -1,11 +0,0 @@
-# Pipedrive.Webhook
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**success** | **Boolean** | If the response is successful or not | [optional] 
-**status** | **String** | The status of the response | [optional] 
-**data** | [**BaseWebhook**](BaseWebhook.md) |  | [optional] 
-
-

package/docs/WebhookAllOf.md

@@ -1,9 +0,0 @@
-# Pipedrive.WebhookAllOf
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**BaseWebhook**](BaseWebhook.md) |  | [optional] 
-
-

package/docs/WebhookBadRequest.md

@@ -1,11 +0,0 @@
-# Pipedrive.WebhookBadRequest
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**success** | **Boolean** | If the response is successful or not | [optional] 
-**status** | **String** | The status of the response | [optional] 
-**errors** | **Object** | List of errors | [optional] 
-
-

package/docs/WebhookBadRequestAllOf.md

@@ -1,9 +0,0 @@
-# Pipedrive.WebhookBadRequestAllOf
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**errors** | **Object** | List of errors | [optional] 
-
-

package/docs/Webhooks.md

@@ -1,11 +0,0 @@
-# Pipedrive.Webhooks
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**success** | **Boolean** | If the response is successful or not | [optional] 
-**status** | **String** | The status of the response | [optional] 
-**data** | [**[BaseWebhook]**](BaseWebhook.md) | The array of Webhooks | [optional] 
-
-

package/docs/WebhooksAllOf.md

@@ -1,9 +0,0 @@
-# Pipedrive.WebhooksAllOf
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**[BaseWebhook]**](BaseWebhook.md) | The array of Webhooks | [optional] 
-
-