pipedrive 22.3.1-rc.3 → 22.3.1-rc.4

package/CHANGELOG.md

@@ -8,8 +8,18 @@ For public Changelog covering all changes done to Pipedrive’s API, webhooks an
 
 ## [Unreleased]
 
+## [22.3.1-rc.4] - 2024-02-12
+
 ## [22.3.1-rc.3] - 2024-01-08
-- Add `lead_id` as an acceptable body parameter for the `POST /v1/callLogs` endpoint
+- Add TypeScript Support
+
+## [22.5.0] - 2024-02-02
+### Added
+- Added documentation for new endpoint `/deals/{id}/participantsChangelog`.
+
+## [22.4.0] - 2024-01-05
+### Added
+- Added documentation for `/meetings/userProviderLinks` endpoints
 
 ## [22.3.1-rc.2] - 2023-12-22
 
@@ -595,7 +605,8 @@ structure
 * Fixed `GET /goal/:id/results` error handling in case when there are no existing stages connected to specified goal
 * Fixed typo in lead example response (`crrency` to `currency`)
 
-[Unreleased]: https://github.com/pipedrive/api-docs/compare/v22.3.1-rc.3...HEAD
+[Unreleased]: https://github.com/pipedrive/api-docs/compare/v22.3.1-rc.4...HEAD
+[22.3.1-rc.4]: https://github.com/pipedrive/api-docs/compare/v22.3.1-rc.3...v22.3.1-rc.4
 [22.3.1-rc.3]: https://github.com/pipedrive/api-docs/compare/v22.4.0...v22.3.1-rc.3
 [22.4.0]: https://github.com/pipedrive/api-docs/compare/v22.3.0...v22.4.0
 [22.3.0]: https://github.com/pipedrive/api-docs/compare/v22.2.0...v22.3.0

package/README.md

@@ -27,7 +27,7 @@ import { Configuration, DealsApi } from "pipedrive";
 
 const app = express();
 
-const PORT = 1800;
+const PORT = 3000;
 
 // Configure Client with API key authorization
 const apiConfig = new Configuration({
@@ -41,7 +41,7 @@ app.listen(PORT, () => {
 app.get("/", async (req, res) => {
   const dealsApi = new DealsApi(apiConfig);
   const response = await dealsApi.getDeals();
-  const { data: deals } = response.data;
+  const { data: deals } = response;
 
   res.send(deals);
 });
@@ -68,7 +68,7 @@ import { OAuth2Configuration, Configuration } from 'pipedrive';
 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
+  redirectUri: 'redirectUri' // OAuth 2 Redirection endpoint or Callback Uri
 });
 
 const apiConfig = new Configuration({
@@ -183,9 +183,9 @@ It then redirects back to the base endpoint for calling endpoints from the SDK.
 ```typescript
 
 import express from "express";
-import cookieParse from "cookie-parser";
-import cookeSession from "cookie-session";
 import { Configuration, DealsApi, OAuth2Configuration } from "pipedrive";
+import cookieParser from "cookie-parser";
+import cookieSession from "cookie-session";
 
 const app = express();
 
@@ -195,26 +195,21 @@ app.use(cookieSession({
     keys: ["key1"]
 }));
 
-const PORT = 1800;
+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
-});
-
-const apiConfig = new Configuration({
-    accessToken: oauth2.getAccessToken,
-    basePath: oauth2.basePath,
+    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}`);
+  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);
 
@@ -232,19 +227,29 @@ app.get('/', async (req, res) => {
     // token is already set in the session
     // now make API calls as required
     // client will automatically refresh the token when it expires and call the token update callback
-    const api = new DealsApi(apiClient);
+    const dealsApi = new DealsApi(apiConfig)
+
     const response = await dealsApi.getDeals();
-    const { data: deals } = response.data;
+    const { data: deals } = response;
 
-    res.send(deals);
+    return res.send(deals);
+} catch (error){
+    console.error(error)
+    return res.status(500).send(error)
+}
 });
 
 app.get('/callback', async (req, res) => {
-    const authCode = req.query.code;
-    const newAccessToken = await oauth2.authorize(authCode);
-
-    req.session.accessToken = newAccessToken;
-    res.redirect("/");
+    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/base.ts

@@ -45,8 +45,16 @@ export interface RequestArgs {
 * Axios interceptor to add the SDK version as a User-Agent header
 * */
 globalAxios.interceptors.request.use(function (config) {
-    const version = require("../package.json").version;
+    let version;
+
+    try {
+        version = require('../package.json').version;
+    } catch (error) {
+        version = '22.x';
+    }
+
     config.headers['User-Agent'] = `Pipedrive-SDK-Javascript-${version}`;
+
     return config;
 });
 

package/configuration.ts

@@ -206,7 +206,14 @@ export class OAuth2Configuration {
   }
 
   private getUserAgent = () => {
-    const version = require("../package.json").version;
+    let version;
+
+    try {
+        version = require('../package.json').version;
+    } catch (error) {
+        version = '22.x';
+    }
+
     return `Pipedrive-SDK-Javascript-${version}`;
   };
 

package/dist/base.js

@@ -30,7 +30,13 @@ exports.COLLECTION_FORMATS = {
 * Axios interceptor to add the SDK version as a User-Agent header
 * */
 axios_1.default.interceptors.request.use(function (config) {
-    const version = require("../package.json").version;
+    let version;
+    try {
+        version = require('../package.json').version;
+    }
+    catch (error) {
+        version = '22.x';
+    }
     config.headers['User-Agent'] = `Pipedrive-SDK-Javascript-${version}`;
     return config;
 });

package/dist/configuration.js

@@ -114,7 +114,13 @@ class OAuth2Configuration {
             return token;
         };
         this.getUserAgent = () => {
-            const version = require("../package.json").version;
+            let version;
+            try {
+                version = require('../package.json').version;
+            }
+            catch (error) {
+                version = '22.x';
+            }
             return `Pipedrive-SDK-Javascript-${version}`;
         };
         this.validateParam = (params, key) => {

package/dist/esm/base.js

@@ -27,7 +27,13 @@ export const COLLECTION_FORMATS = {
 * Axios interceptor to add the SDK version as a User-Agent header
 * */
 globalAxios.interceptors.request.use(function (config) {
-    const version = require("../package.json").version;
+    let version;
+    try {
+        version = require('../package.json').version;
+    }
+    catch (error) {
+        version = '22.x';
+    }
     config.headers['User-Agent'] = `Pipedrive-SDK-Javascript-${version}`;
     return config;
 });

package/dist/esm/configuration.js

@@ -111,7 +111,13 @@ export class OAuth2Configuration {
             return token;
         };
         this.getUserAgent = () => {
-            const version = require("../package.json").version;
+            let version;
+            try {
+                version = require('../package.json').version;
+            }
+            catch (error) {
+                version = '22.x';
+            }
             return `Pipedrive-SDK-Javascript-${version}`;
         };
         this.validateParam = (params, key) => {

package/docs/AddWebhookRequest.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **subscriptionUrl** | **String** | A full, valid, publicly accessible URL which determines where to send the notifications. Please note that you cannot use Pipedrive API endpoints as the `subscription_url` and the chosen URL must not redirect to another link. | 
 **eventAction** | **String** | The type of action to receive notifications about. Wildcard will match all supported actions. | 
 **eventObject** | **String** | The type of object to receive notifications about. Wildcard will match all supported objects. | 
-**userId** | **Number** | The ID of the user that this webhook will be authorized with. You have the option to use a different user's `user_id`. If it is not set, the current user's `user_id` will be used. As each webhook event is checked against a user’s permissions, the webhook will only be sent if the user has access to the specified object(s). If you want to receive notifications for all events, please use a top-level admin user’s `user_id`. | [optional] 
+**userId** | **Number** | The ID of the user that this webhook will be authorized with. You have the option to use a different user's `user_id`. If it is not set, the current user's `user_id` will be used. As each webhook event is checked against a user's permissions, the webhook will only be sent if the user has access to the specified object(s). If you want to receive notifications for all events, please use a top-level admin user’s `user_id`. | [optional] 
 **httpAuthUser** | **String** | The HTTP basic auth username of the subscription URL endpoint (if required) | [optional] 
 **httpAuthPassword** | **String** | The HTTP basic auth password of the subscription URL endpoint (if required) | [optional] 
 **version** | **String** | The webhook's version | [optional] [default to '1.0']

package/docs/BasicDeal.md

@@ -4,6 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**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/DealParticipantsChangelog.md

@@ -0,0 +1,12 @@
+# Pipedrive.DealParticipantsChangelog
+
+## 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/DealsApi.md

@@ -20,6 +20,7 @@ Method | HTTP request | Description
 [**getDealFollowers**](DealsApi.md#getDealFollowers) | **GET** /deals/{id}/followers | List followers of a deal
 [**getDealMailMessages**](DealsApi.md#getDealMailMessages) | **GET** /deals/{id}/mailMessages | List mail messages associated with a deal
 [**getDealParticipants**](DealsApi.md#getDealParticipants) | **GET** /deals/{id}/participants | List participants of a deal
+[**getDealParticipantsChangelog**](DealsApi.md#getDealParticipantsChangelog) | **GET** /deals/{id}/participantsChangelog | List updates about participants of a deal
 [**getDealPersons**](DealsApi.md#getDealPersons) | **GET** /deals/{id}/persons | List all persons associated with a deal
 [**getDealProducts**](DealsApi.md#getDealProducts) | **GET** /deals/{id}/products | List products attached to a deal
 [**getDealUpdates**](DealsApi.md#getDealUpdates) | **GET** /deals/{id}/flow | List updates about a deal
@@ -933,6 +934,65 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## getDealParticipantsChangelog
+
+> ParticipantsChangelog getDealParticipantsChangelog(id, opts)
+
+List updates about participants of a deal
+
+List updates about participants of a deal. This is a cursor-paginated endpoint. For more information, please refer to our documentation on <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-pagination\" target=\"_blank\" rel=\"noopener noreferrer\">pagination</a>.
+
+### 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.DealsApi(apiClient);
+let id = 56; // Number | The ID of the deal
+let opts = {
+  'limit': 56, // Number | Items shown per page
+  'cursor': "cursor_example" // String | For pagination, the marker (an opaque string value) representing the first item on the next page
+};
+apiInstance.getDealParticipantsChangelog(id, opts).then((data) => {
+  console.log('API called successfully. Returned data: ' + data);
+}, (error) => {
+  console.error(error);
+});
+
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Number**| The ID of the deal | 
+ **limit** | **Number**| Items shown per page | [optional] 
+ **cursor** | **String**| For pagination, the marker (an opaque string value) representing the first item on the next page | [optional] 
+
+### Return type
+
+[**ParticipantsChangelog**](ParticipantsChangelog.md)
+
+### Authorization
+
+[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## getDealPersons
 
 > ListPersonsResponse getDealPersons(id, opts)

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/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/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/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.3",
+  "version": "22.3.1-rc.4",
   "description": "Pipedrive REST client for NodeJS",
   "license": "MIT",
   "homepage": "https://developers.pipedrive.com",