pipedrive 22.3.1-rc.2 → 22.3.1-rc.4

package/docs/MeetingsApi.md

@@ -0,0 +1,118 @@
+# Pipedrive.MeetingsApi
+
+All URIs are relative to *https://api.pipedrive.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**deleteUserProviderLink**](MeetingsApi.md#deleteUserProviderLink) | **DELETE** /meetings/userProviderLinks/{id} | Delete the link between a user and the installed video call integration
+[**saveUserProviderLink**](MeetingsApi.md#saveUserProviderLink) | **POST** /meetings/userProviderLinks | Link a user with the installed video call integration
+
+
+
+## deleteUserProviderLink
+
+> UserProviderLinkSuccessResponse deleteUserProviderLink(id)
+
+Delete the link between a user and the installed video call integration
+
+A video calling provider must call this endpoint to remove the link between a user and the installed video calling app.
+
+### 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.MeetingsApi(apiClient);
+let id = "id_example"; // String | Unique identifier linking a user to the installed integration
+apiInstance.deleteUserProviderLink(id).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Unique identifier linking a user to the installed integration | 
+
+### Return type
+
+[**UserProviderLinkSuccessResponse**](UserProviderLinkSuccessResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## saveUserProviderLink
+
+> UserProviderLinkSuccessResponse saveUserProviderLink(opts)
+
+Link a user with the installed video call integration
+
+A video calling provider must call this endpoint after a user has installed the video calling app so that the new user's information is sent.
+
+### 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.MeetingsApi(apiClient);
+let opts = Pipedrive.UserProviderLinkCreateRequest.constructFromObject({
+  // Properties that you want to update
+});
+apiInstance.saveUserProviderLink(opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **userProviderLinkCreateRequest** | [**UserProviderLinkCreateRequest**](UserProviderLinkCreateRequest.md)|  | [optional] 
+
+### Return type
+
+[**UserProviderLinkSuccessResponse**](UserProviderLinkSuccessResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

package/docs/NewDeal.md

@@ -15,6 +15,9 @@ Name | Type | Description | Notes
 **stageId** | **Number** | The ID of the stage this deal will be added to. Please note that a pipeline will be assigned automatically based on the `stage_id`. If omitted, the deal will be placed in the first stage of the default pipeline. | [optional] 
 **status** | **String** | open = Open, won = Won, lost = Lost, deleted = Deleted. If omitted, status will be set to open. | [optional] 
 **addTime** | **String** | The optional creation date & time of the deal in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] 
+**wonTime** | **String** | The optional date and time of changing the deal status as won in UTC. Format: YYYY-MM-DD HH:MM:SS. Can be set only when deal `status` is already Won. Can not be used together with `lost_time`. | [optional] 
+**lostTime** | **String** | The optional date and time of changing the deal status as lost in UTC. Format: YYYY-MM-DD HH:MM:SS. Can be set only when deal `status` is already Lost. Can not be used together with `won_time`. | [optional] 
+**closeTime** | **String** | The optional date and time of closing the deal in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] 
 **expectedCloseDate** | **Date** | The expected close date of the deal. In ISO 8601 format: YYYY-MM-DD. | [optional] 
 **probability** | **Number** | The success probability percentage of the deal. Used/shown only when `deal_probability` for the pipeline of the deal is enabled. | [optional] 
 **lostReason** | **String** | The optional message about why the deal was lost (to be used when status = lost) | [optional] 

package/docs/OrganizationsApi.md

@@ -209,6 +209,9 @@ 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
@@ -235,7 +238,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[api_key](../README.md#api_key)
+[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
 
 ### HTTP request headers
 
@@ -737,7 +740,7 @@ 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)
+  '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);
@@ -756,7 +759,7 @@ Name | Type | Description  | Notes
  **start** | **Number**| Pagination start | [optional] [default to 0]
  **limit** | **Number**| Items shown per page | [optional] 
  **allChanges** | **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] 
+ **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
 
@@ -790,6 +793,9 @@ 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
@@ -814,7 +820,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[api_key](../README.md#api_key)
+[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
 
 ### HTTP request headers
 

package/docs/ParticipantsChangelog.md

@@ -0,0 +1,11 @@
+# Pipedrive.ParticipantsChangelog
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**success** | **Boolean** | If the request was successful or not | [optional] 
+**data** | [**[ParticipantsChangelogItem]**](ParticipantsChangelogItem.md) | The array of participant changelog | [optional] 
+**additionalData** | [**AdditionalData**](AdditionalData.md) |  | [optional] 
+
+

package/docs/ParticipantsChangelogItem.md

@@ -0,0 +1,12 @@
+# Pipedrive.ParticipantsChangelogItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**actorUserId** | **Number** | The ID of the user | [optional] 
+**personId** | **Number** | The ID of the person | [optional] 
+**action** | **String** | Deal participant action type | [optional] 
+**time** | **String** | The deal participant action log time | [optional] 
+
+

package/docs/PersonsApi.md

@@ -276,6 +276,9 @@ 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.PersonsApi(apiClient);
 let id = 56; // Number | The ID of the person
@@ -302,7 +305,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[api_key](../README.md#api_key)
+[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
 
 ### HTTP request headers
 
@@ -786,6 +789,9 @@ 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.PersonsApi(apiClient);
 let id = 56; // Number | The ID of the person
@@ -816,7 +822,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[api_key](../README.md#api_key)
+[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
 
 ### HTTP request headers
 
@@ -852,7 +858,7 @@ 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 - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change)
+  'items': "items_example" // String | A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change).
 };
 apiInstance.getPersonUpdates(id, opts).then((data) => {
   console.log('API called successfully. Returned data: ' + data);
@@ -871,7 +877,7 @@ Name | Type | Description  | Notes
  **start** | **Number**| Pagination start | [optional] [default to 0]
  **limit** | **Number**| Items shown per page | [optional] 
  **allChanges** | **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 - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change) | [optional] 
+ **items** | **String**| A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change). | [optional] 
 
 ### Return type
 
@@ -905,6 +911,9 @@ 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.PersonsApi(apiClient);
 let id = 56; // Number | The ID of the person
@@ -929,7 +938,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[api_key](../README.md#api_key)
+[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
 
 ### HTTP request headers
 

package/docs/PostDealParticipants.md

@@ -6,6 +6,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **success** | **Boolean** | If the request was successful or not | [optional] 
 **data** | [**PersonItem**](PersonItem.md) | The object of participant | [optional] 
-**relatedObjects** | [**GetDealsRelatedObjects**](GetDealsRelatedObjects.md) |  | [optional] 
+**relatedObjects** | [**PostDealParticipantsRelatedObjects**](PostDealParticipantsRelatedObjects.md) |  | [optional] 
 
 

package/docs/PostDealParticipantsRelatedObjects.md

@@ -0,0 +1,10 @@
+# Pipedrive.PostDealParticipantsRelatedObjects
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user** | [**RelatedUserData**](RelatedUserData.md) |  | [optional] 
+**person** | [**RelatedPersonDataWithActiveFlag**](RelatedPersonDataWithActiveFlag.md) |  | [optional] 
+
+

package/docs/ProductsApi.md

@@ -380,7 +380,7 @@ let id = 56; // Number | The ID of the product
 let opts = {
   'start': 0, // Number | Pagination start
   'limit': 56, // Number | Items shown per page
-  'sort': "sort_example" // String | The field name and sorting mode (`field_name_1 ASC` or `field_name_1 DESC`). Supported fields: `update_time`, `id`
+  'sort': "sort_example" // String | The field name and sorting mode (`field_name_1 ASC` or `field_name_1 DESC`). Supported fields: `update_time`, `id`.
 };
 apiInstance.getProductFiles(id, opts).then((data) => {
   console.log('API called successfully. Returned data: ' + data);
@@ -398,7 +398,7 @@ Name | Type | Description  | Notes
  **id** | **Number**| The ID of the product | 
  **start** | **Number**| Pagination start | [optional] [default to 0]
  **limit** | **Number**| Items shown per page | [optional] 
- **sort** | **String**| The field name and sorting mode (`field_name_1 ASC` or `field_name_1 DESC`). Supported fields: `update_time`, `id` | [optional] 
+ **sort** | **String**| The field name and sorting mode (`field_name_1 ASC` or `field_name_1 DESC`). Supported fields: `update_time`, `id`. | [optional] 
 
 ### Return type
 

package/docs/RecentsApi.md

@@ -31,7 +31,7 @@ let oauth2 = apiClient.authentications['oauth2'];
 oauth2.accessToken = 'YOUR ACCESS TOKEN';
 
 let apiInstance = new Pipedrive.RecentsApi(apiClient);
-let sinceTimestamp = "sinceTimestamp_example"; // String | The timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS
+let sinceTimestamp = "sinceTimestamp_example"; // String | The timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS.
 let opts = {
   'items': "items_example", // String | Multiple selection of item types to include in the query (optional)
   'start': 0, // Number | Pagination start
@@ -50,7 +50,7 @@ apiInstance.getRecents(sinceTimestamp, opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **sinceTimestamp** | **String**| The timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS | 
+ **sinceTimestamp** | **String**| The timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS. | 
  **items** | **String**| Multiple selection of item types to include in the query (optional) | [optional] 
  **start** | **Number**| Pagination start | [optional] [default to 0]
  **limit** | **Number**| Items shown per page | [optional] 

package/docs/ResponseCallLogObject.md

@@ -15,7 +15,8 @@ Name | Type | Description | Notes
 **endTime** | **Date** | The date and time of the end of the call in UTC. Format: YYYY-MM-DD HH:MM:SS. | 
 **personId** | **Number** | The ID of the person this call is associated with | [optional] 
 **orgId** | **Number** | The ID of the organization this call is associated with | [optional] 
-**dealId** | **Number** | The ID of the deal this call is associated with | [optional] 
+**dealId** | **Number** | The ID of the deal this call is associated with. A call log can be associated with either a deal or a lead, but not both at once. | [optional] 
+**leadId** | **String** | The ID of the lead in the UUID format this call is associated with. A call log can be associated with either a deal or a lead, but not both at once. | [optional] 
 **note** | **String** | The note for the call log in HTML format | [optional] 
 **id** | **String** | The call log ID, generated when the call log was created | [optional] 
 **hasRecording** | **Boolean** | If the call log has an audio recording attached, the value should be true | [optional] 

package/docs/UpdateDealRequest.md

@@ -14,6 +14,9 @@ Name | Type | Description | Notes
 **pipelineId** | **Number** | The ID of the pipeline this deal will be added to. By default, the deal will be added to the first stage of the specified pipeline. Please note that `pipeline_id` and `stage_id` should not be used together as `pipeline_id` will be ignored. | [optional] 
 **stageId** | **Number** | The ID of the stage this deal will be added to. Please note that a pipeline will be assigned automatically based on the `stage_id`. | [optional] 
 **status** | **String** | open = Open, won = Won, lost = Lost, deleted = Deleted. | [optional] 
+**wonTime** | **String** | The optional date and time of changing the deal status as won in UTC. Format: YYYY-MM-DD HH:MM:SS. Can be set only when deal `status` is already Won. Can not be used together with `lost_time`. | [optional] 
+**lostTime** | **String** | The optional date and time of changing the deal status as lost in UTC. Format: YYYY-MM-DD HH:MM:SS. Can be set only when deal `status` is already Lost. Can not be used together with `won_time`. | [optional] 
+**closeTime** | **String** | The optional date and time of closing the deal in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] 
 **expectedCloseDate** | **Date** | The expected close date of the deal. In ISO 8601 format: YYYY-MM-DD. | [optional] 
 **probability** | **Number** | The success probability percentage of the deal. Used/shown only when `deal_probability` for the pipeline of the deal is enabled. | [optional] 
 **lostReason** | **String** | The optional message about why the deal was lost (to be used when status = lost) | [optional] 

package/docs/UserProviderLinkCreateRequest.md

@@ -0,0 +1,12 @@
+# Pipedrive.UserProviderLinkCreateRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**userProviderId** | **String** | Unique identifier linking a user to the installed integration. Generated by the integration. | 
+**userId** | **Number** | Pipedrive user ID | 
+**companyId** | **Number** | Pipedrive company ID | 
+**marketplaceClientId** | **String** | Pipedrive Marketplace client ID of the installed integration | 
+
+

package/docs/UserProviderLinkErrorResponse.md

@@ -0,0 +1,10 @@
+# Pipedrive.UserProviderLinkErrorResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**success** | **Boolean** | Boolean that indicates whether the request was successful or not | [optional] 
+**message** | **String** | The error message of the request | [optional] 
+
+

package/docs/UserProviderLinkSuccessResponse.md

@@ -0,0 +1,10 @@
+# Pipedrive.UserProviderLinkSuccessResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**success** | **Boolean** | Boolean that indicates whether the request was successful or not | [optional] 
+**data** | [**UserProviderLinkSuccessResponseData**](UserProviderLinkSuccessResponseData.md) |  | [optional] 
+
+

package/docs/UserProviderLinkSuccessResponseData.md

@@ -0,0 +1,9 @@
+# Pipedrive.UserProviderLinkSuccessResponseData
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** | The success message of the request | [optional] 
+
+

package/docs/UsersApi.md

@@ -97,7 +97,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN';
 let apiInstance = new Pipedrive.UsersApi(apiClient);
 let term = "term_example"; // String | The search term to look for
 let opts = {
-  'searchByEmail': new Pipedrive.NumberBooleanDefault0() // NumberBooleanDefault0 | When enabled, the term will only be matched against email addresses of users. Default: `false`
+  '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);
@@ -113,7 +113,7 @@ apiInstance.findUsersByName(term, opts).then((data) => {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **term** | **String**| The search term to look for | 
- **searchByEmail** | [**NumberBooleanDefault0**](.md)| When enabled, the term will only be matched against email addresses of users. Default: `false` | [optional] 
+ **searchByEmail** | [**NumberBooleanDefault0**](.md)| When enabled, the term will only be matched against email addresses of users. Default: `false`. | [optional] 
 
 ### Return type