pipedrive 22.3.1-rc.2 → 22.3.1-rc.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (166) hide show
  1. package/CHANGELOG.md +6 -4
  2. package/api/activities-api.ts +1 -24
  3. package/api/activity-fields-api.ts +1 -24
  4. package/api/activity-types-api.ts +1 -21
  5. package/api/billing-api.ts +1 -24
  6. package/api/call-logs-api.ts +1 -24
  7. package/api/channels-api.ts +1 -24
  8. package/api/currencies-api.ts +1 -24
  9. package/api/deal-fields-api.ts +1 -24
  10. package/api/deals-api.ts +1 -24
  11. package/api/files-api.ts +1 -24
  12. package/api/filters-api.ts +1 -24
  13. package/api/goals-api.ts +1 -24
  14. package/api/item-search-api.ts +1 -24
  15. package/api/lead-labels-api.ts +1 -21
  16. package/api/lead-sources-api.ts +1 -24
  17. package/api/leads-api.ts +1 -24
  18. package/api/legacy-teams-api.ts +1 -24
  19. package/api/mailbox-api.ts +1 -24
  20. package/api/note-fields-api.ts +1 -24
  21. package/api/notes-api.ts +1 -21
  22. package/api/organization-fields-api.ts +1 -24
  23. package/api/organization-relationships-api.ts +1 -24
  24. package/api/organizations-api.ts +1 -24
  25. package/api/permission-sets-api.ts +1 -24
  26. package/api/person-fields-api.ts +1 -21
  27. package/api/persons-api.ts +1 -24
  28. package/api/pipelines-api.ts +1 -24
  29. package/api/product-fields-api.ts +1 -24
  30. package/api/products-api.ts +1 -24
  31. package/api/project-templates-api.ts +1 -24
  32. package/api/projects-api.ts +1 -24
  33. package/api/recents-api.ts +1 -24
  34. package/api/roles-api.ts +1 -24
  35. package/api/stages-api.ts +1 -24
  36. package/api/subscriptions-api.ts +1 -24
  37. package/api/tasks-api.ts +1 -24
  38. package/api/user-connections-api.ts +1 -24
  39. package/api/user-settings-api.ts +1 -24
  40. package/api/users-api.ts +1 -24
  41. package/api/webhooks-api.ts +1 -21
  42. package/base.ts +23 -0
  43. package/common.ts +0 -1
  44. package/configuration.ts +3 -1
  45. package/dist/api/activities-api.js +7 -30
  46. package/dist/api/activity-fields-api.js +1 -24
  47. package/dist/api/activity-types-api.js +0 -20
  48. package/dist/api/billing-api.js +1 -24
  49. package/dist/api/call-logs-api.js +5 -28
  50. package/dist/api/channels-api.js +4 -27
  51. package/dist/api/currencies-api.js +1 -24
  52. package/dist/api/deal-fields-api.js +6 -29
  53. package/dist/api/deals-api.js +28 -51
  54. package/dist/api/files-api.js +11 -34
  55. package/dist/api/filters-api.js +7 -30
  56. package/dist/api/goals-api.js +5 -28
  57. package/dist/api/item-search-api.js +2 -25
  58. package/dist/api/lead-labels-api.js +0 -20
  59. package/dist/api/lead-sources-api.js +1 -24
  60. package/dist/api/leads-api.js +7 -30
  61. package/dist/api/legacy-teams-api.js +8 -31
  62. package/dist/api/mailbox-api.js +7 -30
  63. package/dist/api/note-fields-api.js +1 -24
  64. package/dist/api/notes-api.js +0 -20
  65. package/dist/api/organization-fields-api.js +6 -29
  66. package/dist/api/organization-relationships-api.js +5 -28
  67. package/dist/api/organizations-api.js +19 -42
  68. package/dist/api/permission-sets-api.js +3 -26
  69. package/dist/api/person-fields-api.js +0 -20
  70. package/dist/api/persons-api.js +21 -44
  71. package/dist/api/pipelines-api.js +8 -31
  72. package/dist/api/product-fields-api.js +6 -29
  73. package/dist/api/products-api.js +12 -35
  74. package/dist/api/project-templates-api.js +4 -27
  75. package/dist/api/projects-api.js +14 -37
  76. package/dist/api/recents-api.js +1 -24
  77. package/dist/api/roles-api.js +12 -35
  78. package/dist/api/stages-api.js +7 -30
  79. package/dist/api/subscriptions-api.js +9 -32
  80. package/dist/api/tasks-api.js +5 -28
  81. package/dist/api/user-connections-api.js +1 -24
  82. package/dist/api/user-settings-api.js +1 -24
  83. package/dist/api/users-api.js +10 -33
  84. package/dist/api/webhooks-api.js +0 -20
  85. package/dist/base.js +20 -0
  86. package/dist/common.d.ts +0 -1
  87. package/dist/common.js +1 -2
  88. package/dist/configuration.d.ts +1 -0
  89. package/dist/configuration.js +1 -1
  90. package/dist/esm/api/activities-api.js +0 -23
  91. package/dist/esm/api/activity-fields-api.js +0 -23
  92. package/dist/esm/api/activity-types-api.js +0 -20
  93. package/dist/esm/api/billing-api.js +0 -23
  94. package/dist/esm/api/call-logs-api.js +0 -23
  95. package/dist/esm/api/channels-api.js +0 -23
  96. package/dist/esm/api/currencies-api.js +0 -23
  97. package/dist/esm/api/deal-fields-api.js +0 -23
  98. package/dist/esm/api/deals-api.js +0 -23
  99. package/dist/esm/api/files-api.js +0 -23
  100. package/dist/esm/api/filters-api.js +0 -23
  101. package/dist/esm/api/goals-api.js +0 -23
  102. package/dist/esm/api/item-search-api.js +0 -23
  103. package/dist/esm/api/lead-labels-api.js +0 -20
  104. package/dist/esm/api/lead-sources-api.js +0 -23
  105. package/dist/esm/api/leads-api.js +0 -23
  106. package/dist/esm/api/legacy-teams-api.js +0 -23
  107. package/dist/esm/api/mailbox-api.js +0 -23
  108. package/dist/esm/api/note-fields-api.js +0 -23
  109. package/dist/esm/api/notes-api.js +0 -20
  110. package/dist/esm/api/organization-fields-api.js +0 -23
  111. package/dist/esm/api/organization-relationships-api.js +0 -23
  112. package/dist/esm/api/organizations-api.js +0 -23
  113. package/dist/esm/api/permission-sets-api.js +0 -23
  114. package/dist/esm/api/person-fields-api.js +0 -20
  115. package/dist/esm/api/persons-api.js +0 -23
  116. package/dist/esm/api/pipelines-api.js +0 -23
  117. package/dist/esm/api/product-fields-api.js +0 -23
  118. package/dist/esm/api/products-api.js +0 -23
  119. package/dist/esm/api/project-templates-api.js +0 -23
  120. package/dist/esm/api/projects-api.js +0 -23
  121. package/dist/esm/api/recents-api.js +0 -23
  122. package/dist/esm/api/roles-api.js +0 -23
  123. package/dist/esm/api/stages-api.js +0 -23
  124. package/dist/esm/api/subscriptions-api.js +0 -23
  125. package/dist/esm/api/tasks-api.js +0 -23
  126. package/dist/esm/api/user-connections-api.js +0 -23
  127. package/dist/esm/api/user-settings-api.js +0 -23
  128. package/dist/esm/api/users-api.js +0 -23
  129. package/dist/esm/api/webhooks-api.js +0 -20
  130. package/dist/esm/base.js +20 -0
  131. package/dist/esm/common.d.ts +0 -1
  132. package/dist/esm/common.js +0 -1
  133. package/dist/esm/configuration.d.ts +1 -0
  134. package/dist/esm/configuration.js +1 -1
  135. package/docs/CallLogObject.md +2 -1
  136. package/docs/DealsApi.md +14 -8
  137. package/docs/FiltersApi.md +4 -1
  138. package/docs/GetDeal.md +1 -1
  139. package/docs/GetDealRelatedObjects.md +11 -0
  140. package/docs/GetDealsRelatedObjects.md +3 -3
  141. package/docs/ItemSearchApi.md +2 -2
  142. package/docs/LeadsApi.md +4 -1
  143. package/docs/MailboxApi.md +2 -2
  144. package/docs/MeetingsApi.md +118 -0
  145. package/docs/OrganizationsApi.md +10 -4
  146. package/docs/PersonsApi.md +14 -5
  147. package/docs/PostDealParticipants.md +1 -1
  148. package/docs/PostDealParticipantsRelatedObjects.md +10 -0
  149. package/docs/ProductsApi.md +2 -2
  150. package/docs/RecentsApi.md +2 -2
  151. package/docs/ResponseCallLogObject.md +2 -1
  152. package/docs/UserProviderLinkCreateRequest.md +12 -0
  153. package/docs/UserProviderLinkErrorResponse.md +10 -0
  154. package/docs/UserProviderLinkSuccessResponse.md +10 -0
  155. package/docs/UserProviderLinkSuccessResponseData.md +9 -0
  156. package/docs/UsersApi.md +2 -2
  157. package/package.json +3 -3
  158. package/src/api/MeetingsApi.js +181 -0
  159. package/src/model/GetDealRelatedObjects.js +101 -0
  160. package/src/model/PostDealParticipantsRelatedObjects.js +90 -0
  161. package/src/model/UserProviderLinkCreateRequest.js +120 -0
  162. package/src/model/UserProviderLinkErrorResponse.js +90 -0
  163. package/src/model/UserProviderLinkSuccessResponse.js +90 -0
  164. package/src/model/UserProviderLinkSuccessResponseData.js +79 -0
  165. package/test/functional/access-token.test.js +5 -5
  166. package/test/functional/authorisation.test.js +5 -8
@@ -246,6 +246,9 @@ let api_key = apiClient.authentications['api_key'];
246
246
  api_key.apiKey = 'YOUR API KEY';
247
247
  // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
248
248
  //api_key.apiKeyPrefix = 'Token';
249
+ // Configure OAuth2 access token for authorization: oauth2
250
+ let oauth2 = apiClient.authentications['oauth2'];
251
+ oauth2.accessToken = 'YOUR ACCESS TOKEN';
249
252
 
250
253
  let apiInstance = new Pipedrive.FiltersApi(apiClient);
251
254
  apiInstance.getFilterHelpers().then((data) => {
@@ -266,7 +269,7 @@ This endpoint does not need any parameter.
266
269
 
267
270
  ### Authorization
268
271
 
269
- [api_key](../README.md#api_key)
272
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
270
273
 
271
274
  ### HTTP request headers
272
275
 
package/docs/GetDeal.md CHANGED
@@ -7,6 +7,6 @@ Name | Type | Description | Notes
7
7
  **success** | **Boolean** | If the response is successful or not | [optional]
8
8
  **data** | [**DealNonStrictWithDetails**](DealNonStrictWithDetails.md) | | [optional]
9
9
  **additionalData** | [**GetDealAdditionalData**](GetDealAdditionalData.md) | | [optional]
10
- **relatedObjects** | [**GetDealsRelatedObjects**](GetDealsRelatedObjects.md) | | [optional]
10
+ **relatedObjects** | [**GetDealRelatedObjects**](GetDealRelatedObjects.md) | | [optional]
11
11
 
12
12
 
@@ -0,0 +1,11 @@
1
+ # Pipedrive.GetDealRelatedObjects
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **user** | [**RelatedUserData**](RelatedUserData.md) | | [optional]
8
+ **person** | [**RelatedPersonDataWithActiveFlag**](RelatedPersonDataWithActiveFlag.md) | | [optional]
9
+ **organization** | [**RelatedOrganizationDataWithActiveFlag**](RelatedOrganizationDataWithActiveFlag.md) | | [optional]
10
+
11
+
@@ -4,8 +4,8 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **user** | [**DealUserData**](DealUserData.md) | | [optional]
8
- **organization** | [**DealOrganizationData**](DealOrganizationData.md) | | [optional]
9
- **person** | [**DealPersonData**](DealPersonData.md) | | [optional]
7
+ **user** | [**RelatedUserData**](RelatedUserData.md) | | [optional]
8
+ **organization** | [**RelatedOrganizationDataWithActiveFlag**](RelatedOrganizationDataWithActiveFlag.md) | | [optional]
9
+ **person** | [**RelatedPersonDataWithActiveFlag**](RelatedPersonDataWithActiveFlag.md) | | [optional]
10
10
 
11
11
 
@@ -36,7 +36,7 @@ let term = "term_example"; // String | The search term to look for. Minimum 2 ch
36
36
  let opts = {
37
37
  'itemTypes': "itemTypes_example", // String | A comma-separated string array. The type of items to perform the search from. Defaults to all.
38
38
  'fields': "fields_example", // String | A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`custom_fields`, `notes`, `email`, `organization_name`, `person_name`, `phone`, `title`</td></tr> <tr><td>File</td><td>`name`</td></tr> <tr><td>Mail attachment</td><td>`name`</td></tr> <tr><td>Project</td><td> `custom_fields`, `notes`, `title`, `description` </td></tr> </table> <br> 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>.<br/> When searching for leads, the email, organization_name, person_name, and phone fields will return results only for leads not linked to contacts. For searching leads by person or organization values, please use `search_for_related_items`.
39
- 'searchForRelatedItems': true, // Boolean | When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization.
39
+ 'searchForRelatedItems': true, // Boolean | When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization
40
40
  'exactMatch': true, // Boolean | When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
41
41
  'includeFields': "includeFields_example", // String | A comma-separated string array. Supports including optional fields in the results which are not provided by default.
42
42
  '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.
@@ -58,7 +58,7 @@ Name | Type | Description | Notes
58
58
  **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. |
59
59
  **itemTypes** | **String**| A comma-separated string array. The type of items to perform the search from. Defaults to all. | [optional]
60
60
  **fields** | **String**| A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:&lt;br&gt; &lt;table&gt; &lt;tr&gt;&lt;th&gt;&lt;b&gt;Item type&lt;/b&gt;&lt;/th&gt;&lt;th&gt;&lt;b&gt;Field&lt;/b&gt;&lt;/th&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Deal&lt;/td&gt;&lt;td&gt;&#x60;custom_fields&#x60;, &#x60;notes&#x60;, &#x60;title&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Person&lt;/td&gt;&lt;td&gt;&#x60;custom_fields&#x60;, &#x60;email&#x60;, &#x60;name&#x60;, &#x60;notes&#x60;, &#x60;phone&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Organization&lt;/td&gt;&lt;td&gt;&#x60;address&#x60;, &#x60;custom_fields&#x60;, &#x60;name&#x60;, &#x60;notes&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Product&lt;/td&gt;&lt;td&gt;&#x60;code&#x60;, &#x60;custom_fields&#x60;, &#x60;name&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Lead&lt;/td&gt;&lt;td&gt;&#x60;custom_fields&#x60;, &#x60;notes&#x60;, &#x60;email&#x60;, &#x60;organization_name&#x60;, &#x60;person_name&#x60;, &#x60;phone&#x60;, &#x60;title&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;File&lt;/td&gt;&lt;td&gt;&#x60;name&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Mail attachment&lt;/td&gt;&lt;td&gt;&#x60;name&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Project&lt;/td&gt;&lt;td&gt; &#x60;custom_fields&#x60;, &#x60;notes&#x60;, &#x60;title&#x60;, &#x60;description&#x60; &lt;/td&gt;&lt;/tr&gt; &lt;/table&gt; &lt;br&gt; 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;.&lt;br/&gt; When searching for leads, the email, organization_name, person_name, and phone fields will return results only for leads not linked to contacts. For searching leads by person or organization values, please use &#x60;search_for_related_items&#x60;. | [optional]
61
- **searchForRelatedItems** | **Boolean**| When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization. | [optional]
61
+ **searchForRelatedItems** | **Boolean**| When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization | [optional]
62
62
  **exactMatch** | **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]
63
63
  **includeFields** | **String**| A comma-separated string array. Supports including optional fields in the results which are not provided by default. | [optional]
64
64
  **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]
package/docs/LeadsApi.md CHANGED
@@ -193,6 +193,9 @@ let api_key = apiClient.authentications['api_key'];
193
193
  api_key.apiKey = 'YOUR API KEY';
194
194
  // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
195
195
  //api_key.apiKeyPrefix = 'Token';
196
+ // Configure OAuth2 access token for authorization: oauth2
197
+ let oauth2 = apiClient.authentications['oauth2'];
198
+ oauth2.accessToken = 'YOUR ACCESS TOKEN';
196
199
 
197
200
  let apiInstance = new Pipedrive.LeadsApi(apiClient);
198
201
  let id = "id_example"; // String | The ID of the lead
@@ -217,7 +220,7 @@ Name | Type | Description | Notes
217
220
 
218
221
  ### Authorization
219
222
 
220
- [api_key](../README.md#api_key)
223
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
221
224
 
222
225
  ### HTTP request headers
223
226
 
@@ -91,7 +91,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN';
91
91
  let apiInstance = new Pipedrive.MailboxApi(apiClient);
92
92
  let id = 56; // Number | The ID of the mail message to fetch
93
93
  let opts = {
94
- 'includeBody': new Pipedrive.NumberBooleanDefault0() // NumberBooleanDefault0 | Whether to include the full message body or not. `0` = Don't include, `1` = Include
94
+ 'includeBody': new Pipedrive.NumberBooleanDefault0() // NumberBooleanDefault0 | Whether to include the full message body or not. `0` = Don't include, `1` = Include.
95
95
  };
96
96
  apiInstance.getMailMessage(id, opts).then((data) => {
97
97
  console.log('API called successfully. Returned data: ' + data);
@@ -107,7 +107,7 @@ apiInstance.getMailMessage(id, opts).then((data) => {
107
107
  Name | Type | Description | Notes
108
108
  ------------- | ------------- | ------------- | -------------
109
109
  **id** | **Number**| The ID of the mail message to fetch |
110
- **includeBody** | [**NumberBooleanDefault0**](.md)| Whether to include the full message body or not. &#x60;0&#x60; &#x3D; Don&#39;t include, &#x60;1&#x60; &#x3D; Include | [optional]
110
+ **includeBody** | [**NumberBooleanDefault0**](.md)| Whether to include the full message body or not. &#x60;0&#x60; &#x3D; Don&#39;t include, &#x60;1&#x60; &#x3D; Include. | [optional]
111
111
 
112
112
  ### Return type
113
113
 
@@ -0,0 +1,118 @@
1
+ # Pipedrive.MeetingsApi
2
+
3
+ All URIs are relative to *https://api.pipedrive.com/v1*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**deleteUserProviderLink**](MeetingsApi.md#deleteUserProviderLink) | **DELETE** /meetings/userProviderLinks/{id} | Delete the link between a user and the installed video call integration
8
+ [**saveUserProviderLink**](MeetingsApi.md#saveUserProviderLink) | **POST** /meetings/userProviderLinks | Link a user with the installed video call integration
9
+
10
+
11
+
12
+ ## deleteUserProviderLink
13
+
14
+ > UserProviderLinkSuccessResponse deleteUserProviderLink(id)
15
+
16
+ Delete the link between a user and the installed video call integration
17
+
18
+ A video calling provider must call this endpoint to remove the link between a user and the installed video calling app.
19
+
20
+ ### Example
21
+
22
+ ```javascript
23
+ import Pipedrive from 'pipedrive';
24
+ let apiClient = new Pipedrive.ApiClient();
25
+ // Configure API key authorization: api_key
26
+ let api_key = apiClient.authentications['api_key'];
27
+ api_key.apiKey = 'YOUR API KEY';
28
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
29
+ //api_key.apiKeyPrefix = 'Token';
30
+ // Configure OAuth2 access token for authorization: oauth2
31
+ let oauth2 = apiClient.authentications['oauth2'];
32
+ oauth2.accessToken = 'YOUR ACCESS TOKEN';
33
+
34
+ let apiInstance = new Pipedrive.MeetingsApi(apiClient);
35
+ let id = "id_example"; // String | Unique identifier linking a user to the installed integration
36
+ apiInstance.deleteUserProviderLink(id).then((data) => {
37
+ console.log('API called successfully. Returned data: ' + data);
38
+ }, (error) => {
39
+ console.error(error);
40
+ });
41
+
42
+ ```
43
+
44
+ ### Parameters
45
+
46
+
47
+ Name | Type | Description | Notes
48
+ ------------- | ------------- | ------------- | -------------
49
+ **id** | **String**| Unique identifier linking a user to the installed integration |
50
+
51
+ ### Return type
52
+
53
+ [**UserProviderLinkSuccessResponse**](UserProviderLinkSuccessResponse.md)
54
+
55
+ ### Authorization
56
+
57
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
58
+
59
+ ### HTTP request headers
60
+
61
+ - **Content-Type**: Not defined
62
+ - **Accept**: application/json
63
+
64
+
65
+ ## saveUserProviderLink
66
+
67
+ > UserProviderLinkSuccessResponse saveUserProviderLink(opts)
68
+
69
+ Link a user with the installed video call integration
70
+
71
+ A video calling provider must call this endpoint after a user has installed the video calling app so that the new user&#39;s information is sent.
72
+
73
+ ### Example
74
+
75
+ ```javascript
76
+ import Pipedrive from 'pipedrive';
77
+ let apiClient = new Pipedrive.ApiClient();
78
+ // Configure API key authorization: api_key
79
+ let api_key = apiClient.authentications['api_key'];
80
+ api_key.apiKey = 'YOUR API KEY';
81
+ // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
82
+ //api_key.apiKeyPrefix = 'Token';
83
+ // Configure OAuth2 access token for authorization: oauth2
84
+ let oauth2 = apiClient.authentications['oauth2'];
85
+ oauth2.accessToken = 'YOUR ACCESS TOKEN';
86
+
87
+ let apiInstance = new Pipedrive.MeetingsApi(apiClient);
88
+ let opts = Pipedrive.UserProviderLinkCreateRequest.constructFromObject({
89
+ // Properties that you want to update
90
+ });
91
+ apiInstance.saveUserProviderLink(opts).then((data) => {
92
+ console.log('API called successfully. Returned data: ' + data);
93
+ }, (error) => {
94
+ console.error(error);
95
+ });
96
+
97
+ ```
98
+
99
+ ### Parameters
100
+
101
+
102
+ Name | Type | Description | Notes
103
+ ------------- | ------------- | ------------- | -------------
104
+ **userProviderLinkCreateRequest** | [**UserProviderLinkCreateRequest**](UserProviderLinkCreateRequest.md)| | [optional]
105
+
106
+ ### Return type
107
+
108
+ [**UserProviderLinkSuccessResponse**](UserProviderLinkSuccessResponse.md)
109
+
110
+ ### Authorization
111
+
112
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
113
+
114
+ ### HTTP request headers
115
+
116
+ - **Content-Type**: application/json
117
+ - **Accept**: application/json
118
+
@@ -209,6 +209,9 @@ let api_key = apiClient.authentications['api_key'];
209
209
  api_key.apiKey = 'YOUR API KEY';
210
210
  // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
211
211
  //api_key.apiKeyPrefix = 'Token';
212
+ // Configure OAuth2 access token for authorization: oauth2
213
+ let oauth2 = apiClient.authentications['oauth2'];
214
+ oauth2.accessToken = 'YOUR ACCESS TOKEN';
212
215
 
213
216
  let apiInstance = new Pipedrive.OrganizationsApi(apiClient);
214
217
  let id = 56; // Number | The ID of the organization
@@ -235,7 +238,7 @@ Name | Type | Description | Notes
235
238
 
236
239
  ### Authorization
237
240
 
238
- [api_key](../README.md#api_key)
241
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
239
242
 
240
243
  ### HTTP request headers
241
244
 
@@ -737,7 +740,7 @@ let opts = {
737
740
  'start': 0, // Number | Pagination start
738
741
  'limit': 56, // Number | Items shown per page
739
742
  '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.
740
- '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)
743
+ '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).
741
744
  };
742
745
  apiInstance.getOrganizationUpdates(id, opts).then((data) => {
743
746
  console.log('API called successfully. Returned data: ' + data);
@@ -756,7 +759,7 @@ Name | Type | Description | Notes
756
759
  **start** | **Number**| Pagination start | [optional] [default to 0]
757
760
  **limit** | **Number**| Items shown per page | [optional]
758
761
  **allChanges** | **String**| Whether to show custom field updates or not. 1 &#x3D; Include custom field changes. If omitted, returns changes without custom field updates. | [optional]
759
- **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]
762
+ **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]
760
763
 
761
764
  ### Return type
762
765
 
@@ -790,6 +793,9 @@ let api_key = apiClient.authentications['api_key'];
790
793
  api_key.apiKey = 'YOUR API KEY';
791
794
  // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
792
795
  //api_key.apiKeyPrefix = 'Token';
796
+ // Configure OAuth2 access token for authorization: oauth2
797
+ let oauth2 = apiClient.authentications['oauth2'];
798
+ oauth2.accessToken = 'YOUR ACCESS TOKEN';
793
799
 
794
800
  let apiInstance = new Pipedrive.OrganizationsApi(apiClient);
795
801
  let id = 56; // Number | The ID of the organization
@@ -814,7 +820,7 @@ Name | Type | Description | Notes
814
820
 
815
821
  ### Authorization
816
822
 
817
- [api_key](../README.md#api_key)
823
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
818
824
 
819
825
  ### HTTP request headers
820
826
 
@@ -276,6 +276,9 @@ let api_key = apiClient.authentications['api_key'];
276
276
  api_key.apiKey = 'YOUR API KEY';
277
277
  // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
278
278
  //api_key.apiKeyPrefix = 'Token';
279
+ // Configure OAuth2 access token for authorization: oauth2
280
+ let oauth2 = apiClient.authentications['oauth2'];
281
+ oauth2.accessToken = 'YOUR ACCESS TOKEN';
279
282
 
280
283
  let apiInstance = new Pipedrive.PersonsApi(apiClient);
281
284
  let id = 56; // Number | The ID of the person
@@ -302,7 +305,7 @@ Name | Type | Description | Notes
302
305
 
303
306
  ### Authorization
304
307
 
305
- [api_key](../README.md#api_key)
308
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
306
309
 
307
310
  ### HTTP request headers
308
311
 
@@ -786,6 +789,9 @@ let api_key = apiClient.authentications['api_key'];
786
789
  api_key.apiKey = 'YOUR API KEY';
787
790
  // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
788
791
  //api_key.apiKeyPrefix = 'Token';
792
+ // Configure OAuth2 access token for authorization: oauth2
793
+ let oauth2 = apiClient.authentications['oauth2'];
794
+ oauth2.accessToken = 'YOUR ACCESS TOKEN';
789
795
 
790
796
  let apiInstance = new Pipedrive.PersonsApi(apiClient);
791
797
  let id = 56; // Number | The ID of the person
@@ -816,7 +822,7 @@ Name | Type | Description | Notes
816
822
 
817
823
  ### Authorization
818
824
 
819
- [api_key](../README.md#api_key)
825
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
820
826
 
821
827
  ### HTTP request headers
822
828
 
@@ -852,7 +858,7 @@ let opts = {
852
858
  'start': 0, // Number | Pagination start
853
859
  'limit': 56, // Number | Items shown per page
854
860
  '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.
855
- '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)
861
+ '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).
856
862
  };
857
863
  apiInstance.getPersonUpdates(id, opts).then((data) => {
858
864
  console.log('API called successfully. Returned data: ' + data);
@@ -871,7 +877,7 @@ Name | Type | Description | Notes
871
877
  **start** | **Number**| Pagination start | [optional] [default to 0]
872
878
  **limit** | **Number**| Items shown per page | [optional]
873
879
  **allChanges** | **String**| Whether to show custom field updates or not. 1 &#x3D; Include custom field changes. If omitted returns changes without custom field updates. | [optional]
874
- **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]
880
+ **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]
875
881
 
876
882
  ### Return type
877
883
 
@@ -905,6 +911,9 @@ let api_key = apiClient.authentications['api_key'];
905
911
  api_key.apiKey = 'YOUR API KEY';
906
912
  // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
907
913
  //api_key.apiKeyPrefix = 'Token';
914
+ // Configure OAuth2 access token for authorization: oauth2
915
+ let oauth2 = apiClient.authentications['oauth2'];
916
+ oauth2.accessToken = 'YOUR ACCESS TOKEN';
908
917
 
909
918
  let apiInstance = new Pipedrive.PersonsApi(apiClient);
910
919
  let id = 56; // Number | The ID of the person
@@ -929,7 +938,7 @@ Name | Type | Description | Notes
929
938
 
930
939
  ### Authorization
931
940
 
932
- [api_key](../README.md#api_key)
941
+ [api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
933
942
 
934
943
  ### HTTP request headers
935
944
 
@@ -6,6 +6,6 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **success** | **Boolean** | If the request was successful or not | [optional]
8
8
  **data** | [**PersonItem**](PersonItem.md) | The object of participant | [optional]
9
- **relatedObjects** | [**GetDealsRelatedObjects**](GetDealsRelatedObjects.md) | | [optional]
9
+ **relatedObjects** | [**PostDealParticipantsRelatedObjects**](PostDealParticipantsRelatedObjects.md) | | [optional]
10
10
 
11
11
 
@@ -0,0 +1,10 @@
1
+ # Pipedrive.PostDealParticipantsRelatedObjects
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **user** | [**RelatedUserData**](RelatedUserData.md) | | [optional]
8
+ **person** | [**RelatedPersonDataWithActiveFlag**](RelatedPersonDataWithActiveFlag.md) | | [optional]
9
+
10
+
@@ -380,7 +380,7 @@ let id = 56; // Number | The ID of the product
380
380
  let opts = {
381
381
  'start': 0, // Number | Pagination start
382
382
  'limit': 56, // Number | Items shown per page
383
- 'sort': "sort_example" // String | The field name and sorting mode (`field_name_1 ASC` or `field_name_1 DESC`). Supported fields: `update_time`, `id`
383
+ 'sort': "sort_example" // String | The field name and sorting mode (`field_name_1 ASC` or `field_name_1 DESC`). Supported fields: `update_time`, `id`.
384
384
  };
385
385
  apiInstance.getProductFiles(id, opts).then((data) => {
386
386
  console.log('API called successfully. Returned data: ' + data);
@@ -398,7 +398,7 @@ Name | Type | Description | Notes
398
398
  **id** | **Number**| The ID of the product |
399
399
  **start** | **Number**| Pagination start | [optional] [default to 0]
400
400
  **limit** | **Number**| Items shown per page | [optional]
401
- **sort** | **String**| The field name and sorting mode (&#x60;field_name_1 ASC&#x60; or &#x60;field_name_1 DESC&#x60;). Supported fields: &#x60;update_time&#x60;, &#x60;id&#x60; | [optional]
401
+ **sort** | **String**| The field name and sorting mode (&#x60;field_name_1 ASC&#x60; or &#x60;field_name_1 DESC&#x60;). Supported fields: &#x60;update_time&#x60;, &#x60;id&#x60;. | [optional]
402
402
 
403
403
  ### Return type
404
404
 
@@ -31,7 +31,7 @@ let oauth2 = apiClient.authentications['oauth2'];
31
31
  oauth2.accessToken = 'YOUR ACCESS TOKEN';
32
32
 
33
33
  let apiInstance = new Pipedrive.RecentsApi(apiClient);
34
- let sinceTimestamp = "sinceTimestamp_example"; // String | The timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS
34
+ let sinceTimestamp = "sinceTimestamp_example"; // String | The timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS.
35
35
  let opts = {
36
36
  'items': "items_example", // String | Multiple selection of item types to include in the query (optional)
37
37
  'start': 0, // Number | Pagination start
@@ -50,7 +50,7 @@ apiInstance.getRecents(sinceTimestamp, opts).then((data) => {
50
50
 
51
51
  Name | Type | Description | Notes
52
52
  ------------- | ------------- | ------------- | -------------
53
- **sinceTimestamp** | **String**| The timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS |
53
+ **sinceTimestamp** | **String**| The timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS. |
54
54
  **items** | **String**| Multiple selection of item types to include in the query (optional) | [optional]
55
55
  **start** | **Number**| Pagination start | [optional] [default to 0]
56
56
  **limit** | **Number**| Items shown per page | [optional]
@@ -15,7 +15,8 @@ Name | Type | Description | Notes
15
15
  **endTime** | **Date** | The date and time of the end of the call in UTC. Format: YYYY-MM-DD HH:MM:SS. |
16
16
  **personId** | **Number** | The ID of the person this call is associated with | [optional]
17
17
  **orgId** | **Number** | The ID of the organization this call is associated with | [optional]
18
- **dealId** | **Number** | The ID of the deal this call is associated with | [optional]
18
+ **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]
19
+ **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]
19
20
  **note** | **String** | The note for the call log in HTML format | [optional]
20
21
  **id** | **String** | The call log ID, generated when the call log was created | [optional]
21
22
  **hasRecording** | **Boolean** | If the call log has an audio recording attached, the value should be true | [optional]
@@ -0,0 +1,12 @@
1
+ # Pipedrive.UserProviderLinkCreateRequest
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **userProviderId** | **String** | Unique identifier linking a user to the installed integration. Generated by the integration. |
8
+ **userId** | **Number** | Pipedrive user ID |
9
+ **companyId** | **Number** | Pipedrive company ID |
10
+ **marketplaceClientId** | **String** | Pipedrive Marketplace client ID of the installed integration |
11
+
12
+
@@ -0,0 +1,10 @@
1
+ # Pipedrive.UserProviderLinkErrorResponse
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **success** | **Boolean** | Boolean that indicates whether the request was successful or not | [optional]
8
+ **message** | **String** | The error message of the request | [optional]
9
+
10
+
@@ -0,0 +1,10 @@
1
+ # Pipedrive.UserProviderLinkSuccessResponse
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **success** | **Boolean** | Boolean that indicates whether the request was successful or not | [optional]
8
+ **data** | [**UserProviderLinkSuccessResponseData**](UserProviderLinkSuccessResponseData.md) | | [optional]
9
+
10
+
@@ -0,0 +1,9 @@
1
+ # Pipedrive.UserProviderLinkSuccessResponseData
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **message** | **String** | The success message of the request | [optional]
8
+
9
+
package/docs/UsersApi.md CHANGED
@@ -97,7 +97,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN';
97
97
  let apiInstance = new Pipedrive.UsersApi(apiClient);
98
98
  let term = "term_example"; // String | The search term to look for
99
99
  let opts = {
100
- 'searchByEmail': new Pipedrive.NumberBooleanDefault0() // NumberBooleanDefault0 | When enabled, the term will only be matched against email addresses of users. Default: `false`
100
+ 'searchByEmail': new Pipedrive.NumberBooleanDefault0() // NumberBooleanDefault0 | When enabled, the term will only be matched against email addresses of users. Default: `false`.
101
101
  };
102
102
  apiInstance.findUsersByName(term, opts).then((data) => {
103
103
  console.log('API called successfully. Returned data: ' + data);
@@ -113,7 +113,7 @@ apiInstance.findUsersByName(term, opts).then((data) => {
113
113
  Name | Type | Description | Notes
114
114
  ------------- | ------------- | ------------- | -------------
115
115
  **term** | **String**| The search term to look for |
116
- **searchByEmail** | [**NumberBooleanDefault0**](.md)| When enabled, the term will only be matched against email addresses of users. Default: &#x60;false&#x60; | [optional]
116
+ **searchByEmail** | [**NumberBooleanDefault0**](.md)| When enabled, the term will only be matched against email addresses of users. Default: &#x60;false&#x60;. | [optional]
117
117
 
118
118
  ### Return type
119
119
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pipedrive",
3
- "version": "22.3.1-rc.2",
3
+ "version": "22.3.1-rc.3",
4
4
  "description": "Pipedrive REST client for NodeJS",
5
5
  "license": "MIT",
6
6
  "homepage": "https://developers.pipedrive.com",
@@ -29,7 +29,6 @@
29
29
  },
30
30
  "dependencies": {
31
31
  "axios": "^1.3.3",
32
- "eslint-plugin-jest": "^27.6.0",
33
32
  "qs": "^6.11.0"
34
33
  },
35
34
  "devDependencies": {
@@ -78,6 +77,7 @@
78
77
  "shelljs": "^0.8.4",
79
78
  "sinon": "^7.2.0",
80
79
  "ts-jest": "^29.1.1",
81
- "typescript": "^4.9.5"
80
+ "typescript": "^4.9.5",
81
+ "eslint-plugin-jest": "^27.6.0"
82
82
  }
83
83
  }