pipedrive 23.2.5-rc.2 → 23.3.0-rc.4

package/docs/WebhooksApi.md

@@ -1,168 +0,0 @@
-# Pipedrive.WebhooksApi
-
-All URIs are relative to *https://api.pipedrive.com/v1*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**addWebhook**](WebhooksApi.md#addWebhook) | **POST** /webhooks | Create a new Webhook
-[**deleteWebhook**](WebhooksApi.md#deleteWebhook) | **DELETE** /webhooks/{id} | Delete existing Webhook
-[**getWebhooks**](WebhooksApi.md#getWebhooks) | **GET** /webhooks | Get all Webhooks
-
-
-
-## addWebhook
-
-> Webhook addWebhook(opts)
-
-Create a new Webhook
-
-Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - `event_action` and `event_object`. E.g., use `*.*` for getting notifications about all events, `added.deal` for any newly added deals, `deleted.persons` for any deleted persons, etc. See <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks?ref=api_reference\" target=\"_blank\" rel=\"noopener noreferrer\">the guide for Webhooks</a> for more details.
-
-### 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.WebhooksApi(apiClient);
-let opts = Pipedrive.AddWebhookRequest.constructFromObject({
-  // Properties that you want to update
-});
-apiInstance.addWebhook(opts).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **AddWebhookRequest** | [**AddWebhookRequest**](AddWebhookRequest.md)|  | [optional] 
-
-### Return type
-
-[**Webhook**](Webhook.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## deleteWebhook
-
-> BaseResponseWithStatus deleteWebhook(id)
-
-Delete existing Webhook
-
-Deletes the specified Webhook.
-
-### 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.WebhooksApi(apiClient);
-let id = 56; // Number | The ID of the Webhook to delete
-apiInstance.deleteWebhook(id).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 Webhook to delete | 
-
-### Return type
-
-[**BaseResponseWithStatus**](BaseResponseWithStatus.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## getWebhooks
-
-> Webhooks getWebhooks()
-
-Get all Webhooks
-
-Returns data about all the Webhooks of a company.
-
-### 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.WebhooksApi(apiClient);
-apiInstance.getWebhooks().then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-This endpoint does not need any parameter.
-
-### Return type
-
-[**Webhooks**](Webhooks.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

package/docs/WebhooksDeleteForbiddenSchema.md

@@ -1,10 +0,0 @@
-# Pipedrive.WebhooksDeleteForbiddenSchema
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**success** | **Boolean** | If the response is successful or not | [optional] 
-**message** | **String** | The error message | [optional] 
-
-

package/docs/WebhooksDeleteForbiddenSchemaAllOf.md

@@ -1,9 +0,0 @@
-# Pipedrive.WebhooksDeleteForbiddenSchemaAllOf
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**message** | **String** | The error message | [optional] 
-
-

package/git_push.sh

@@ -1,57 +0,0 @@
-#!/bin/sh
-# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
-#
-# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
-
-git_user_id=$1
-git_repo_id=$2
-release_note=$3
-git_host=$4
-
-if [ "$git_host" = "" ]; then
-    git_host="github.com"
-    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
-fi
-
-if [ "$git_user_id" = "" ]; then
-    git_user_id="GIT_USER_ID"
-    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
-fi
-
-if [ "$git_repo_id" = "" ]; then
-    git_repo_id="GIT_REPO_ID"
-    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
-fi
-
-if [ "$release_note" = "" ]; then
-    release_note="Minor update"
-    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
-fi
-
-# Initialize the local directory as a Git repository
-git init
-
-# Adds the files in the local repository and stages them for commit.
-git add .
-
-# Commits the tracked changes and prepares them to be pushed to a remote repository.
-git commit -m "$release_note"
-
-# Sets the new remote
-git_remote=$(git remote)
-if [ "$git_remote" = "" ]; then # git remote not defined
-
-    if [ "$GIT_TOKEN" = "" ]; then
-        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
-        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
-    else
-        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
-    fi
-
-fi
-
-git pull origin master
-
-# Pushes (Forces) the changes in the local repository up to the remote repository
-echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
-git push origin master 2>&1 | grep -v 'To https'

package/migration.md

@@ -1,309 +0,0 @@
-### 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/mocha.opts

@@ -1 +0,0 @@
---timeout 10000