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

package/migration.md

@@ -0,0 +1,309 @@
+### Breaking changes
+
+- Suggested nodejs version is 18
+- Function signatures have changed from the previous version of the sdk. Now each function takes a strongly typed root object that contains all the parameters needed such as id and request payload, where in the previous version those were seperate function params
+
+
+Example functions change:
+
+- Previous version:
+
+```
+
+await dealsApi.addDeal({
+	title: 'My First Deal',
+});
+
+await dealsApi.updateDeal(1, {
+	title: 'Updated Title',
+});
+
+
+await api.getDeal(1);
+
+```
+
+- New version:
+```
+await dealsApi.addDeal({
+	AddDealRequest: {
+		title: 'My First Deal',
+	},
+});
+
+await dealsApi.updateDeal({
+	id: 1,
+	UpdateDealRequest: {
+		title: 'Updated Title',
+	},
+});
+
+await dealsApi.getDeal({
+	id : 1
+})
+
+await dealsApi.deleteDeal({
+	id : 1
+})
+
+```
+
+## Installation
+
+```
+npm i pipedrive@22.3.1-rc.3
+```
+
+## API Reference
+
+The Pipedrive RESTful API Reference can be found at https://developers.pipedrive.com/docs/api/v1.
+Pipedrive API’s core concepts for its usage can be found in our [Developer documentation](https://pipedrive.readme.io/docs/core-api-concepts-about-pipedrive-api).
+
+## How to use it?
+
+### With a pre-set API token
+
+You can retrieve the api_token from your existing Pipedrive account’s settings page. A step-by-step guide is available [here](https://pipedrive.readme.io/docs/how-to-find-the-api-token).
+
+```typescript
+import express from "express";
+import { Configuration, DealsApi } from "pipedrive";
+
+const app = express();
+
+const PORT = 3000;
+
+// Configure Client with API key authorization
+const apiConfig = new Configuration({
+  apiKey: "YOUR_API_TOKEN_HERE",
+});
+
+app.listen(PORT, () => {
+  console.log(`Listening on port ${PORT}`);
+});
+
+app.get("/", async (req, res) => {
+  const dealsApi = new DealsApi(apiConfig);
+  const response = await dealsApi.getDeals();
+  const { data: deals } = response;
+
+  res.send(deals);
+});
+```
+
+### With OAuth 2
+
+If you would like to use an OAuth access token for making API calls, then make sure the API key described in the previous section is not set or is set to an empty string. If both API token and OAuth access token are set, then the API token takes precedence.
+
+To set up authentication in the API client, you need the following information. You can receive the necessary client tokens through a Sandbox account (get it [here](https://developers.pipedrive.com/start-here)) and generate the tokens (detailed steps [here](https://pipedrive.readme.io/docs/marketplace-manager#section-how-to-get-your-client-id-and-client-secret)).
+
+| Parameter    | Description                                  |
+| ------------ | -------------------------------------------- |
+| clientId     | OAuth 2 Client ID                            |
+| clientSecret | OAuth 2 Client Secret                        |
+| redirectUri  | OAuth 2 Redirection endpoint or Callback Uri |
+
+Next, initialize the API client as follows:
+
+```typescript
+import { OAuth2Configuration, Configuration } from 'pipedrive';
+
+// Configuration parameters and credentials
+const oauth2 = new OAuth2Configuration({
+  clientId: "clientId", // OAuth 2 Client ID
+  clientSecret: "clientSecret",  // OAuth 2 Client Secret
+  redirectUri: 'redirectUri' // OAuth 2 Redirection endpoint or Callback Uri
+});
+
+const apiConfig = new Configuration({
+    accessToken: oauth2.getAccessToken,
+    basePath: oauth2.basePath,
+});
+
+```
+
+You must now authorize the client.
+
+### Authorizing your client
+
+Your application must obtain user authorization before it can execute an endpoint call. The SDK uses OAuth 2.0 authorization to obtain a user's consent to perform an API request on the user's behalf. Details about how the OAuth2.0 flow works in Pipedrive, how long tokens are valid, and more, can be found [here](https://pipedrive.readme.io/docs/marketplace-oauth-authorization).
+
+#### 1. Obtaining user consent
+
+To obtain user's consent, you must redirect the user to the authorization page. The `authorizationUrl` returns the URL to the authorization page.
+
+```typescript
+// open up the authUrl in the browser
+const authUrl = oauth2.authorizationUrl;
+```
+
+#### 2. Handle the OAuth server response
+
+Once the user responds to the consent request, the OAuth 2.0 server responds to your application's access request by using the URL specified in the request.
+
+If the user approves the request, the authorization code will be sent as the `code` query string:
+
+```
+https://example.com/oauth/callback?code=XXXXXXXXXXXXXXXXXXXXXXXXX
+```
+
+If the user does not approve the request, the response contains an `error` query string:
+
+```
+https://example.com/oauth/callback?error=access_denied
+```
+
+#### 3. Authorize the client using the code
+
+After the server receives the code, it can exchange this for an _access token_. The access token is an object containing information for authorizing the client and refreshing the token itself. In the API client all the access token fields are held separately in the `OAuth2Configuration` class. Additionally access token expiration time as an `OAuth2Configuration.expiresAt` field is calculated. It is measured in the number of milliseconds elapsed since January 1, 1970 00:00:00 UTC.
+
+```typescript
+const token = await oauth2.authorize(code);
+```
+
+The Node.js SDK supports only promises. So, the authorize call returns a promise.
+
+### Refreshing token
+
+Access tokens may expire after sometime, if it necessary you can do it manually.
+
+```typescript
+const newToken = await oauth2.tokenRefresh();
+```
+
+If the access token expires, the SDK will attempt to automatically refresh it before the next endpoint call which requires authentication.
+
+### Storing an access token for reuse
+
+It is recommended that you store the access token for reuse.
+
+This code snippet stores the access token in a session for an express application. It uses the [cookie-parser](https://www.npmjs.com/package/cookie-parser) and [cookie-session](https://www.npmjs.com/package/cookie-session) npm packages for storing the access token.
+
+```typescript
+import express from "express";
+import cookieParse from "cookie-parser";
+import cookeSession from "cookie-session";
+import { Configuration, DealsApi, OAuth2Configuration } from "pipedrive";
+
+const app = express();
+
+app.use(cookieParser());
+app.use(cookieSession({
+    name: "session",
+    keys: ["key1"]
+}));
+
+...
+
+// store access token in the session
+// note that this is only the access token field value not the whole token object
+req.session.accessToken = await oauth.getAccessToken();
+```
+
+However, since the SDK will attempt to automatically refresh the access token when it expires,
+it is recommended that you register a **token update callback** to detect any change to the access token.
+
+```typescript
+oauth2.onTokenUpdate = function (token) {
+  // getting the updated token
+  // here the token is an object, you can store the whole object or extract fields into separate values
+  req.session.token = token;
+};
+```
+
+The token update callback will be fired upon authorization as well as token refresh.
+
+### Complete example
+
+This example demonstrates an express application (which uses [cookie-parser](https://www.npmjs.com/package/cookie-parser) and [cookie-session](https://www.npmjs.com/package/cookie-session)) for handling session persistence.
+
+In this example, there are 2 endpoints. The base endpoint `'/'` first checks if the token is stored in the session.
+If it is, API endpoints can be called using the corresponding SDK controllers.
+
+However, if the token is not set in the session, then authorization URL is built and opened up.
+The response comes back at the `'/callback'` endpoint, which uses the code to authorize the client and store the token in the session.
+It then redirects back to the base endpoint for calling endpoints from the SDK.
+
+```typescript
+
+import express from "express";
+import { Configuration, DealsApi, OAuth2Configuration } from "pipedrive";
+import cookieParser from "cookie-parser";
+import cookieSession from "cookie-session";
+
+const app = express();
+
+app.use(cookieParser());
+app.use(cookieSession({
+  name: "session",
+  keys: ["key1"]
+}));
+
+const PORT = 3000;
+
+
+const oauth2 = new OAuth2Configuration({
+  clientId: "clientId", // OAuth 2 Client ID
+  clientSecret: "clientSecret",  // OAuth 2 Client Secret
+  redirectUri: 'redirectUri' // OAuth 2 Redirection endpoint or Callback Uri
+});
+
+app.listen(PORT, () => {
+  console.log(`Listening on port ${PORT}`);
+});
+
+app.get('/', async (req, res) => {
+  try {
+    // method will handle return null if token is not available in the session
+    const token = oauth2.updateToken(req.session?.accessToken);
+
+    if (!token) {
+      const authUrl = oauth2.authorizationUrl;
+      return res.redirect(authUrl);
+    }
+
+
+    const apiConfig = new Configuration({
+      accessToken: oauth2.getAccessToken,
+      basePath: oauth2.basePath,
+    });
+
+    const dealsApi = new DealsApi(apiConfig)
+
+    const response = await dealsApi.getDeals();
+    const { data: deals } = response;
+
+    return res.send(deals);
+  } catch (error){
+    console.error(error)
+    return res.status(500).send(error)
+  }
+});
+
+app.get('/callback', async (req, res) => {
+  try {
+    const authCode = req.query.code as string;
+    const newAccessToken = await oauth2.authorize(authCode);
+
+    req.session.accessToken = newAccessToken;
+    return res.redirect("/");
+  }catch (error) {
+    console.error(error)
+    return res.status(500).send(error)
+  }
+});
+
+```
+
+
+
+
+
+
+
+
+
+
+
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pipedrive",
-  "version": "22.3.1-rc.2",
+  "version": "22.3.1-rc.4",
   "description": "Pipedrive REST client for NodeJS",
   "license": "MIT",
   "homepage": "https://developers.pipedrive.com",
@@ -29,7 +29,6 @@
   },
   "dependencies": {
     "axios": "^1.3.3",
-    "eslint-plugin-jest": "^27.6.0",
     "qs": "^6.11.0"
   },
   "devDependencies": {
@@ -78,6 +77,7 @@
     "shelljs": "^0.8.4",
     "sinon": "^7.2.0",
     "ts-jest": "^29.1.1",
-    "typescript": "^4.9.5"
+    "typescript": "^4.9.5",
+    "eslint-plugin-jest": "^27.6.0"
   }
 }

package/src/api/MeetingsApi.js

@@ -0,0 +1,181 @@
+/**
+ * Pipedrive API v1
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+
+
+import ApiClient from "../ApiClient";
+import UserProviderLinkCreateRequest from '../model/UserProviderLinkCreateRequest';
+import UserProviderLinkErrorResponse from '../model/UserProviderLinkErrorResponse';
+import UserProviderLinkSuccessResponse from '../model/UserProviderLinkSuccessResponse';
+
+/**
+* Meetings service.
+* @module api/MeetingsApi
+* @version 1.0.0
+*/
+export default class MeetingsApi {
+
+    /**
+    * Constructs a new MeetingsApi. 
+    * @alias module:api/MeetingsApi
+    * @class
+    * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+    * default to {@link module:ApiClient#instance} if unspecified.
+    */
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+
+
+
+    /**
+     * 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.
+     * @param {String} id Unique identifier linking a user to the installed integration
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UserProviderLinkSuccessResponse} and HTTP response
+     */
+    deleteUserProviderLinkWithHttpInfo(id) {
+      const opts = {}
+      let postBody = null;
+
+      // verify the required parameter 'id' is set
+      if (id === undefined || id === null) {
+        throw new Error("Missing the required parameter 'id' when calling deleteUserProviderLink");
+      }
+
+      let pathParams = {
+        'id': id,
+      };
+      let queryParams = {
+      };
+      let headerParams = {
+      };
+      let formParams = {
+      };
+
+      let formParamArray = [
+      ];
+
+      let contentTypes = [];
+      const isURLEncoded = contentTypes.includes('application/x-www-form-urlencoded');
+      const isJSON = contentTypes.includes('application/json');
+
+      if (isJSON) {
+        postBody = { ...postBody, ...opts };
+      } else if (isURLEncoded) {
+        for (let key in opts) {
+          if (opts.hasOwnProperty(key) && !formParamArray.includes(key)) {
+            formParams[key] = opts[key];
+          }
+        }
+      }
+
+      let authNames = ['api_key', 'oauth2', ];
+      let accepts = ['application/json', ];
+      let returnType = UserProviderLinkSuccessResponse;
+      return this.apiClient.callApi(
+        '/meetings/userProviderLinks/{id}', 'DELETE',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, null
+      );
+    }
+
+    /**
+     * 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.
+     * @param {String} id Unique identifier linking a user to the installed integration
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UserProviderLinkSuccessResponse}
+     */
+    deleteUserProviderLink(id) {
+      return this.deleteUserProviderLinkWithHttpInfo(id)
+        .then(function(response_and_data) {
+          return response_and_data;
+        });
+    }
+
+
+    /**
+     * 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.
+     * @param {Object} opts Optional parameters
+     * @param {module:model/UserProviderLinkCreateRequest} opts.userProviderLinkCreateRequest 
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UserProviderLinkSuccessResponse} and HTTP response
+     */
+    saveUserProviderLinkWithHttpInfo(opts) {
+      opts = opts || {};
+      let postBody = opts['userProviderLinkCreateRequest'];
+
+      if (opts['user_provider_id'] === undefined || opts['user_provider_id'] === null) {
+        throw new Error("Missing the required parameter 'user_provider_id' when calling saveUserProviderLink");
+      }
+      if (opts['user_id'] === undefined || opts['user_id'] === null) {
+        throw new Error("Missing the required parameter 'user_id' when calling saveUserProviderLink");
+      }
+      if (opts['company_id'] === undefined || opts['company_id'] === null) {
+        throw new Error("Missing the required parameter 'company_id' when calling saveUserProviderLink");
+      }
+      if (opts['marketplace_client_id'] === undefined || opts['marketplace_client_id'] === null) {
+        throw new Error("Missing the required parameter 'marketplace_client_id' when calling saveUserProviderLink");
+      }
+
+      let pathParams = {
+      };
+      let queryParams = {
+      };
+      let headerParams = {
+      };
+      let formParams = {
+      };
+
+      let formParamArray = [
+      ];
+
+      let contentTypes = ['application/json', ];
+      const isURLEncoded = contentTypes.includes('application/x-www-form-urlencoded');
+      const isJSON = contentTypes.includes('application/json');
+
+      if (isJSON) {
+        postBody = { ...postBody, ...opts };
+      } else if (isURLEncoded) {
+        for (let key in opts) {
+          if (opts.hasOwnProperty(key) && !formParamArray.includes(key)) {
+            formParams[key] = opts[key];
+          }
+        }
+      }
+
+      let authNames = ['api_key', 'oauth2', ];
+      let accepts = ['application/json', ];
+      let returnType = UserProviderLinkSuccessResponse;
+      return this.apiClient.callApi(
+        '/meetings/userProviderLinks', 'POST',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, null
+      );
+    }
+
+    /**
+     * 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.
+     * @param {Object} opts Optional parameters
+     * @param {module:model/UserProviderLinkCreateRequest} opts.userProviderLinkCreateRequest 
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UserProviderLinkSuccessResponse}
+     */
+    saveUserProviderLink(opts) {
+      return this.saveUserProviderLinkWithHttpInfo(opts)
+        .then(function(response_and_data) {
+          return response_and_data;
+        });
+    }
+
+
+}

package/src/model/GetDealRelatedObjects.js

@@ -0,0 +1,101 @@
+/**
+ * Pipedrive API v1
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+
+import ApiClient from '../ApiClient';
+import RelatedOrganizationDataWithActiveFlag from './RelatedOrganizationDataWithActiveFlag';
+import RelatedPersonDataWithActiveFlag from './RelatedPersonDataWithActiveFlag';
+import RelatedUserData from './RelatedUserData';
+
+/**
+ * The GetDealRelatedObjects model module.
+ * @module model/GetDealRelatedObjects
+ * @version 1.0.0
+ */
+class GetDealRelatedObjects {
+    /**
+     * Constructs a new <code>GetDealRelatedObjects</code>.
+     * @alias module:model/GetDealRelatedObjects
+     */
+    constructor() { 
+        
+        GetDealRelatedObjects.initialize(this);
+    }
+
+    /**
+     * Initializes the fields of this object.
+     * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
+     * Only for internal use.
+     */
+    static initialize(obj) { 
+    }
+
+    /**
+     * Constructs a <code>GetDealRelatedObjects</code> from a plain JavaScript object, optionally creating a new instance.
+     * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @param {module:model/GetDealRelatedObjects} obj Optional instance to populate.
+     * @return {module:model/GetDealRelatedObjects} The populated <code>GetDealRelatedObjects</code> instance.
+     */
+    static constructFromObject(data, obj) {
+        if (data) {
+            obj = obj || new GetDealRelatedObjects();
+
+            if (data.hasOwnProperty('user')) {
+                obj['user'] = RelatedUserData.constructFromObject(data['user']);
+
+                delete data['user'];
+            }
+            if (data.hasOwnProperty('person')) {
+                obj['person'] = RelatedPersonDataWithActiveFlag.constructFromObject(data['person']);
+
+                delete data['person'];
+            }
+            if (data.hasOwnProperty('organization')) {
+                obj['organization'] = RelatedOrganizationDataWithActiveFlag.constructFromObject(data['organization']);
+
+                delete data['organization'];
+            }
+
+            if (Object.keys(data).length > 0) {
+                Object.assign(obj, data);
+            }
+
+        }
+        return obj;
+    }
+
+
+}
+
+/**
+ * @member {module:model/RelatedUserData} user
+ */
+GetDealRelatedObjects.prototype['user'] = undefined;
+
+/**
+ * @member {module:model/RelatedPersonDataWithActiveFlag} person
+ */
+GetDealRelatedObjects.prototype['person'] = undefined;
+
+/**
+ * @member {module:model/RelatedOrganizationDataWithActiveFlag} organization
+ */
+GetDealRelatedObjects.prototype['organization'] = undefined;
+
+
+
+
+
+
+export default GetDealRelatedObjects;
+

package/src/model/PostDealParticipantsRelatedObjects.js

@@ -0,0 +1,90 @@
+/**
+ * Pipedrive API v1
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+
+import ApiClient from '../ApiClient';
+import RelatedPersonDataWithActiveFlag from './RelatedPersonDataWithActiveFlag';
+import RelatedUserData from './RelatedUserData';
+
+/**
+ * The PostDealParticipantsRelatedObjects model module.
+ * @module model/PostDealParticipantsRelatedObjects
+ * @version 1.0.0
+ */
+class PostDealParticipantsRelatedObjects {
+    /**
+     * Constructs a new <code>PostDealParticipantsRelatedObjects</code>.
+     * @alias module:model/PostDealParticipantsRelatedObjects
+     */
+    constructor() { 
+        
+        PostDealParticipantsRelatedObjects.initialize(this);
+    }
+
+    /**
+     * Initializes the fields of this object.
+     * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
+     * Only for internal use.
+     */
+    static initialize(obj) { 
+    }
+
+    /**
+     * Constructs a <code>PostDealParticipantsRelatedObjects</code> from a plain JavaScript object, optionally creating a new instance.
+     * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @param {module:model/PostDealParticipantsRelatedObjects} obj Optional instance to populate.
+     * @return {module:model/PostDealParticipantsRelatedObjects} The populated <code>PostDealParticipantsRelatedObjects</code> instance.
+     */
+    static constructFromObject(data, obj) {
+        if (data) {
+            obj = obj || new PostDealParticipantsRelatedObjects();
+
+            if (data.hasOwnProperty('user')) {
+                obj['user'] = RelatedUserData.constructFromObject(data['user']);
+
+                delete data['user'];
+            }
+            if (data.hasOwnProperty('person')) {
+                obj['person'] = RelatedPersonDataWithActiveFlag.constructFromObject(data['person']);
+
+                delete data['person'];
+            }
+
+            if (Object.keys(data).length > 0) {
+                Object.assign(obj, data);
+            }
+
+        }
+        return obj;
+    }
+
+
+}
+
+/**
+ * @member {module:model/RelatedUserData} user
+ */
+PostDealParticipantsRelatedObjects.prototype['user'] = undefined;
+
+/**
+ * @member {module:model/RelatedPersonDataWithActiveFlag} person
+ */
+PostDealParticipantsRelatedObjects.prototype['person'] = undefined;
+
+
+
+
+
+
+export default PostDealParticipantsRelatedObjects;
+