Build 1637 - version-major

CHANGELOG.md

@@ -7,6 +7,9 @@ The file format of it is based on [Keep a Changelog](http://keepachangelog.com/e
 For public Changelog covering all changes done to Pipedrive’s API, webhooks and app extensions platforms, see [public Changelog](https://pipedrive.readme.io/docs/changelog) with discussion area in [Developers Community](https://devcommunity.pipedrive.com/c/documentation/changelog/19).
 
 ## [Unreleased]
+### Security
+- Removed `.instance` static property from sdk client to prevent race conditions when using it as a singleton
+See the updated examples in the readme to get an overview of the necessary code changes.
 ## 17.5.2
 ### Changed
 - Updated endpoint descriptions to warn about permanently removing deleted entities:

README.md

@@ -19,7 +19,7 @@ Pipedrive API’s core concepts for its usage can be found in our [Developer doc
 
 > **Warning**
 >
-> The `pipedrive.ApiClient.instance` shouldn't be used as a global static instance in the **Production code**.
+> The `pipedrive.ApiClient.instance` has been deprecated.
 >
 > Please, initialise a `new pipedrive.ApiClient()` instance separately for each request instead.
 
@@ -302,7 +302,7 @@ Class | Method | HTTP request | Description
 *Pipedrive.DealsApi* | [**addDeal**](docs/DealsApi.md#addDeal) | **POST** /deals | Add a deal
 *Pipedrive.DealsApi* | [**addDealFollower**](docs/DealsApi.md#addDealFollower) | **POST** /deals/{id}/followers | Add a follower to a deal
 *Pipedrive.DealsApi* | [**addDealParticipant**](docs/DealsApi.md#addDealParticipant) | **POST** /deals/{id}/participants | Add a participant to a deal
-*Pipedrive.DealsApi* | [**addDealProduct**](docs/DealsApi.md#addDealProduct) | **POST** /deals/{id}/products | Add a product to the deal, eventually creating a new item called a deal-product
+*Pipedrive.DealsApi* | [**addDealProduct**](docs/DealsApi.md#addDealProduct) | **POST** /deals/{id}/products | Add a product to a deal
 *Pipedrive.DealsApi* | [**deleteDeal**](docs/DealsApi.md#deleteDeal) | **DELETE** /deals/{id} | Delete a deal
 *Pipedrive.DealsApi* | [**deleteDealFollower**](docs/DealsApi.md#deleteDealFollower) | **DELETE** /deals/{id}/followers/{follower_id} | Delete a follower from a deal
 *Pipedrive.DealsApi* | [**deleteDealParticipant**](docs/DealsApi.md#deleteDealParticipant) | **DELETE** /deals/{id}/participants/{deal_participant_id} | Delete a participant from a deal
@@ -325,7 +325,7 @@ Class | Method | HTTP request | Description
 *Pipedrive.DealsApi* | [**mergeDeals**](docs/DealsApi.md#mergeDeals) | **PUT** /deals/{id}/merge | Merge two deals
 *Pipedrive.DealsApi* | [**searchDeals**](docs/DealsApi.md#searchDeals) | **GET** /deals/search | Search deals
 *Pipedrive.DealsApi* | [**updateDeal**](docs/DealsApi.md#updateDeal) | **PUT** /deals/{id} | Update a deal
-*Pipedrive.DealsApi* | [**updateDealProduct**](docs/DealsApi.md#updateDealProduct) | **PUT** /deals/{id}/products/{product_attachment_id} | Update product attachment details of the deal-product (a product already attached to a deal)
+*Pipedrive.DealsApi* | [**updateDealProduct**](docs/DealsApi.md#updateDealProduct) | **PUT** /deals/{id}/products/{product_attachment_id} | Update the product attached to a deal
 *Pipedrive.FilesApi* | [**addFile**](docs/FilesApi.md#addFile) | **POST** /files | Add file
 *Pipedrive.FilesApi* | [**addFileAndLinkIt**](docs/FilesApi.md#addFileAndLinkIt) | **POST** /files/remote | Create a remote file and link it to an item
 *Pipedrive.FilesApi* | [**deleteFile**](docs/FilesApi.md#deleteFile) | **DELETE** /files/{id} | Delete a file
@@ -948,6 +948,7 @@ Class | Method | HTTP request | Description
  - [Pipedrive.MailThreadAllOf](docs/MailThreadAllOf.md)
  - [Pipedrive.MailThreadDelete](docs/MailThreadDelete.md)
  - [Pipedrive.MailThreadDeleteAllOf](docs/MailThreadDeleteAllOf.md)
+ - [Pipedrive.MailThreadDeleteAllOfData](docs/MailThreadDeleteAllOfData.md)
  - [Pipedrive.MailThreadMessages](docs/MailThreadMessages.md)
  - [Pipedrive.MailThreadMessagesAllOf](docs/MailThreadMessagesAllOf.md)
  - [Pipedrive.MailThreadOne](docs/MailThreadOne.md)
@@ -1252,7 +1253,7 @@ Class | Method | HTTP request | Description
 - **Type**: OAuth
 - **Flow**: accessCode
 - **Authorization URL**: https://oauth.pipedrive.com/oauth/authorize
-- **Scopes**:
+- **Scopes**: 
   - deals:read: Read most data about deals and related entities.
   - deals:full: Create, read, update and delete deals, its participants and followers.
   - goals:read: Read data on all goals.

docs/ActivitiesApi.md

@@ -25,17 +25,17 @@ Adds a new activity. Includes `more_activities_scheduled_in_context` p
 
 ```javascript
 import Pipedrive from 'pipedrive';
-let defaultClient = Pipedrive.ApiClient.instance;
+let apiClient = new Pipedrive.ApiClient();
 // Configure API key authorization: api_key
-let api_key = defaultClient.authentications['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 = defaultClient.authentications['oauth2'];
+let oauth2 = apiClient.authentications['oauth2'];
 oauth2.accessToken = 'YOUR ACCESS TOKEN';
 
-let apiInstance = new Pipedrive.ActivitiesApi();
+let apiInstance = new Pipedrive.ActivitiesApi(apiClient);
 let opts = Pipedrive.ActivityPostObject.constructFromObject({
   // Properties that you want to update
 });
@@ -80,17 +80,17 @@ Marks multiple activities as deleted. After 30 days, the activities will be perm
 
 ```javascript
 import Pipedrive from 'pipedrive';
-let defaultClient = Pipedrive.ApiClient.instance;
+let apiClient = new Pipedrive.ApiClient();
 // Configure API key authorization: api_key
-let api_key = defaultClient.authentications['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 = defaultClient.authentications['oauth2'];
+let oauth2 = apiClient.authentications['oauth2'];
 oauth2.accessToken = 'YOUR ACCESS TOKEN';
 
-let apiInstance = new Pipedrive.ActivitiesApi();
+let apiInstance = new Pipedrive.ActivitiesApi(apiClient);
 let ids = "ids_example"; // String | The comma-separated IDs of activities that will be deleted
 apiInstance.deleteActivities(ids).then((data) => {
   console.log('API called successfully. Returned data: ' + data);
@@ -133,17 +133,17 @@ Marks an activity as deleted. After 30 days, the activity will be permanently de
 
 ```javascript
 import Pipedrive from 'pipedrive';
-let defaultClient = Pipedrive.ApiClient.instance;
+let apiClient = new Pipedrive.ApiClient();
 // Configure API key authorization: api_key
-let api_key = defaultClient.authentications['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 = defaultClient.authentications['oauth2'];
+let oauth2 = apiClient.authentications['oauth2'];
 oauth2.accessToken = 'YOUR ACCESS TOKEN';
 
-let apiInstance = new Pipedrive.ActivitiesApi();
+let apiInstance = new Pipedrive.ActivitiesApi(apiClient);
 let id = 56; // Number | The ID of the activity
 apiInstance.deleteActivity(id).then((data) => {
   console.log('API called successfully. Returned data: ' + data);
@@ -186,17 +186,17 @@ Returns all activities assigned to a particular user.
 
 ```javascript
 import Pipedrive from 'pipedrive';
-let defaultClient = Pipedrive.ApiClient.instance;
+let apiClient = new Pipedrive.ApiClient();
 // Configure API key authorization: api_key
-let api_key = defaultClient.authentications['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 = defaultClient.authentications['oauth2'];
+let oauth2 = apiClient.authentications['oauth2'];
 oauth2.accessToken = 'YOUR ACCESS TOKEN';
 
-let apiInstance = new Pipedrive.ActivitiesApi();
+let apiInstance = new Pipedrive.ActivitiesApi(apiClient);
 let opts = {
   'userId': 56, // Number | The ID of the user whose activities will be fetched. If omitted, the user associated with the API token will be used. If 0, activities for all company users will be fetched based on the permission sets.
   'filterId': 56, // Number | The ID of the filter to use (will narrow down results if used together with `user_id` parameter)
@@ -255,17 +255,17 @@ Returns the details of a specific activity.
 
 ```javascript
 import Pipedrive from 'pipedrive';
-let defaultClient = Pipedrive.ApiClient.instance;
+let apiClient = new Pipedrive.ApiClient();
 // Configure API key authorization: api_key
-let api_key = defaultClient.authentications['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 = defaultClient.authentications['oauth2'];
+let oauth2 = apiClient.authentications['oauth2'];
 oauth2.accessToken = 'YOUR ACCESS TOKEN';
 
-let apiInstance = new Pipedrive.ActivitiesApi();
+let apiInstance = new Pipedrive.ActivitiesApi(apiClient);
 let id = 56; // Number | The ID of the activity
 apiInstance.getActivity(id).then((data) => {
   console.log('API called successfully. Returned data: ' + data);
@@ -308,17 +308,17 @@ Updates an activity. Includes `more_activities_scheduled_in_context` p
 
 ```javascript
 import Pipedrive from 'pipedrive';
-let defaultClient = Pipedrive.ApiClient.instance;
+let apiClient = new Pipedrive.ApiClient();
 // Configure API key authorization: api_key
-let api_key = defaultClient.authentications['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 = defaultClient.authentications['oauth2'];
+let oauth2 = apiClient.authentications['oauth2'];
 oauth2.accessToken = 'YOUR ACCESS TOKEN';
 
-let apiInstance = new Pipedrive.ActivitiesApi();
+let apiInstance = new Pipedrive.ActivitiesApi(apiClient);
 let id = 56; // Number | The ID of the activity
 let opts = Pipedrive.ActivityPutObject.constructFromObject({
   // Properties that you want to update

docs/ActivityFieldsApi.md

@@ -20,17 +20,17 @@ Returns all activity fields.
 
 ```javascript
 import Pipedrive from 'pipedrive';
-let defaultClient = Pipedrive.ApiClient.instance;
+let apiClient = new Pipedrive.ApiClient();
 // Configure API key authorization: api_key
-let api_key = defaultClient.authentications['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 = defaultClient.authentications['oauth2'];
+let oauth2 = apiClient.authentications['oauth2'];
 oauth2.accessToken = 'YOUR ACCESS TOKEN';
 
-let apiInstance = new Pipedrive.ActivityFieldsApi();
+let apiInstance = new Pipedrive.ActivityFieldsApi(apiClient);
 apiInstance.getActivityFields().then((data) => {
   console.log('API called successfully. Returned data: ' + data);
 }, (error) => {

docs/ActivityTypesApi.md

@@ -24,17 +24,17 @@ Adds a new activity type.
 
 ```javascript
 import Pipedrive from 'pipedrive';
-let defaultClient = Pipedrive.ApiClient.instance;
+let apiClient = new Pipedrive.ApiClient();
 // Configure API key authorization: api_key
-let api_key = defaultClient.authentications['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 = defaultClient.authentications['oauth2'];
+let oauth2 = apiClient.authentications['oauth2'];
 oauth2.accessToken = 'YOUR ACCESS TOKEN';
 
-let apiInstance = new Pipedrive.ActivityTypesApi();
+let apiInstance = new Pipedrive.ActivityTypesApi(apiClient);
 let opts = Pipedrive.ActivityTypeCreateRequest.constructFromObject({
   // Properties that you want to update
 });
@@ -79,17 +79,17 @@ Marks an activity type as deleted.
 
 ```javascript
 import Pipedrive from 'pipedrive';
-let defaultClient = Pipedrive.ApiClient.instance;
+let apiClient = new Pipedrive.ApiClient();
 // Configure API key authorization: api_key
-let api_key = defaultClient.authentications['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 = defaultClient.authentications['oauth2'];
+let oauth2 = apiClient.authentications['oauth2'];
 oauth2.accessToken = 'YOUR ACCESS TOKEN';
 
-let apiInstance = new Pipedrive.ActivityTypesApi();
+let apiInstance = new Pipedrive.ActivityTypesApi(apiClient);
 let id = 56; // Number | The ID of the activity type
 apiInstance.deleteActivityType(id).then((data) => {
   console.log('API called successfully. Returned data: ' + data);
@@ -132,17 +132,17 @@ Marks multiple activity types as deleted.
 
 ```javascript
 import Pipedrive from 'pipedrive';
-let defaultClient = Pipedrive.ApiClient.instance;
+let apiClient = new Pipedrive.ApiClient();
 // Configure API key authorization: api_key
-let api_key = defaultClient.authentications['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 = defaultClient.authentications['oauth2'];
+let oauth2 = apiClient.authentications['oauth2'];
 oauth2.accessToken = 'YOUR ACCESS TOKEN';
 
-let apiInstance = new Pipedrive.ActivityTypesApi();
+let apiInstance = new Pipedrive.ActivityTypesApi(apiClient);
 let ids = "ids_example"; // String | The comma-separated activity type IDs
 apiInstance.deleteActivityTypes(ids).then((data) => {
   console.log('API called successfully. Returned data: ' + data);
@@ -185,17 +185,17 @@ Returns all activity types.
 
 ```javascript
 import Pipedrive from 'pipedrive';
-let defaultClient = Pipedrive.ApiClient.instance;
+let apiClient = new Pipedrive.ApiClient();
 // Configure API key authorization: api_key
-let api_key = defaultClient.authentications['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 = defaultClient.authentications['oauth2'];
+let oauth2 = apiClient.authentications['oauth2'];
 oauth2.accessToken = 'YOUR ACCESS TOKEN';
 
-let apiInstance = new Pipedrive.ActivityTypesApi();
+let apiInstance = new Pipedrive.ActivityTypesApi(apiClient);
 apiInstance.getActivityTypes().then((data) => {
   console.log('API called successfully. Returned data: ' + data);
 }, (error) => {
@@ -234,17 +234,17 @@ Updates an activity type.
 
 ```javascript
 import Pipedrive from 'pipedrive';
-let defaultClient = Pipedrive.ApiClient.instance;
+let apiClient = new Pipedrive.ApiClient();
 // Configure API key authorization: api_key
-let api_key = defaultClient.authentications['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 = defaultClient.authentications['oauth2'];
+let oauth2 = apiClient.authentications['oauth2'];
 oauth2.accessToken = 'YOUR ACCESS TOKEN';
 
-let apiInstance = new Pipedrive.ActivityTypesApi();
+let apiInstance = new Pipedrive.ActivityTypesApi(apiClient);
 let id = 56; // Number | The ID of the activity type
 let opts = Pipedrive.ActivityTypeUpdateRequest.constructFromObject({
   // Properties that you want to update