@friggframework/api-module-pipedrive 0.11.1 → 1.0.1-canary.36.7e495fb.0

package/.eslintrc.json

@@ -1,3 +1,3 @@
 {
-    "extends": "@friggframework/eslint-config"
+  "extends": "@friggframework/eslint-config"
 }

package/CHANGELOG.md

@@ -1,17 +1,26 @@
-# v0.11.0 (Wed Mar 20 2024)
+# v0.10.0 (Wed Mar 20 2024)
 
-#### 🚀 Enhancement
+:tada: This release contains work from new contributors! :tada:
+
+Thanks for all your work!
+
+:heart: Nicolas Leal ([@nicolasmelo1](https://github.com/nicolasmelo1))
 
-- bump minor version [#279](https://github.com/friggframework/frigg/pull/279) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+:heart: nmilcoff ([@nmilcoff](https://github.com/nmilcoff))
+
+#### 🚀 Enhancement
 
 #### 🐛 Bug Fix
 
-- bump minor version ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- correct some bad automated edits, though they are not in relevant
+  files ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
 - Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
 
-#### Authors: 2
+#### Authors: 4
 
 - [@MichaelRyanWebber](https://github.com/MichaelRyanWebber)
+- Nicolas Leal ([@nicolasmelo1](https://github.com/nicolasmelo1))
+- nmilcoff ([@nmilcoff](https://github.com/nmilcoff))
 - Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
 
 ---
@@ -123,16 +132,22 @@ Thank you, Jonathan O'Donnell ([@joncodo](https://github.com/joncodo)), for all
 
 #### 🐛 Bug Fix
 
-- Merge remote-tracking branch 'origin/main' into gitbook-updates [#48](https://github.com/friggframework/frigg/pull/48) ([@seanspeaks](https://github.com/seanspeaks))
+- Merge remote-tracking branch 'origin/main' into
+  gitbook-updates [#48](https://github.com/friggframework/frigg/pull/48) ([@seanspeaks](https://github.com/seanspeaks))
 - Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
-- A lot of changes all rolled into one [#21](https://github.com/friggframework/frigg/pull/21) ([@seanspeaks](https://github.com/seanspeaks))
-- Updated API modules with support for sls offline, and made sure optional chaining with discriminators was in place ([@seanspeaks](https://github.com/seanspeaks))
+- A lot of changes all rolled into
+  one [#21](https://github.com/friggframework/frigg/pull/21) ([@seanspeaks](https://github.com/seanspeaks))
+- Updated API modules with support for sls offline, and made sure optional chaining with discriminators was in
+  place ([@seanspeaks](https://github.com/seanspeaks))
 - Fixing dependencies across all API Modules ([@seanspeaks](https://github.com/seanspeaks))
-- More import issues (Exports are named objects, imports needed to object destructure) ([@seanspeaks](https://github.com/seanspeaks))
+- More import issues (Exports are named objects, imports needed to object
+  destructure) ([@seanspeaks](https://github.com/seanspeaks))
 - Updates to API Modules for proper export/imports ([@seanspeaks](https://github.com/seanspeaks))
-- Merge remote-tracking branch 'origin/main' into simplify-mongoose-models ([@seanspeaks](https://github.com/seanspeaks))
+- Merge remote-tracking branch 'origin/main' into
+  simplify-mongoose-models ([@seanspeaks](https://github.com/seanspeaks))
 - Update all api modules to use module-plugin models ([@seanspeaks](https://github.com/seanspeaks))
-- Add READMEs for all packages and api-modules [#20](https://github.com/friggframework/frigg/pull/20) ([@seanspeaks](https://github.com/seanspeaks))
+- Add READMEs for all packages and
+  api-modules [#20](https://github.com/friggframework/frigg/pull/20) ([@seanspeaks](https://github.com/seanspeaks))
 - Add READMEs for all packages and api-modules ([@seanspeaks](https://github.com/seanspeaks))
 
 #### ⚠️ Pushed to `main`
@@ -150,7 +165,8 @@ Thank you, Jonathan O'Donnell ([@joncodo](https://github.com/joncodo)), for all
 
 #### 🐛 Bug Fix
 
-- fix modules to @friggframework [#74](https://github.com/friggframework/frigg/pull/74) ([@sheehantoufiq](https://github.com/sheehantoufiq))
+- fix modules to
+  @friggframework [#74](https://github.com/friggframework/frigg/pull/74) ([@sheehantoufiq](https://github.com/sheehantoufiq))
 - Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
 
 #### Authors: 2
@@ -164,9 +180,11 @@ Thank you, Jonathan O'Donnell ([@joncodo](https://github.com/joncodo)), for all
 
 #### 🐛 Bug Fix
 
-- Test environment setup for all modules [#49](https://github.com/friggframework/frigg/pull/49) ([@seanspeaks](https://github.com/seanspeaks))
+- Test environment setup for all
+  modules [#49](https://github.com/friggframework/frigg/pull/49) ([@seanspeaks](https://github.com/seanspeaks))
 - Test environment setup for all modules ([@seanspeaks](https://github.com/seanspeaks))
-- Merge remote-tracking branch 'origin/main' into gitbook-updates [#48](https://github.com/friggframework/frigg/pull/48) ([@seanspeaks](https://github.com/seanspeaks))
+- Merge remote-tracking branch 'origin/main' into
+  gitbook-updates [#48](https://github.com/friggframework/frigg/pull/48) ([@seanspeaks](https://github.com/seanspeaks))
 
 #### Authors: 1
 
@@ -178,10 +196,12 @@ Thank you, Jonathan O'Donnell ([@joncodo](https://github.com/joncodo)), for all
 
 #### 🐛 Bug Fix
 
-- version bumped to address tag issue [#43](https://github.com/friggframework/frigg/pull/43) ([@seanspeaks](https://github.com/seanspeaks))
+- version bumped to address tag
+  issue [#43](https://github.com/friggframework/frigg/pull/43) ([@seanspeaks](https://github.com/seanspeaks))
 - version bumped ([@seanspeaks](https://github.com/seanspeaks))
 - Publish ([@seanspeaks](https://github.com/seanspeaks))
-- Add nx and licenses [#37](https://github.com/friggframework/frigg/pull/37) ([@seanspeaks](https://github.com/seanspeaks))
+- Add nx and
+  licenses [#37](https://github.com/friggframework/frigg/pull/37) ([@seanspeaks](https://github.com/seanspeaks))
 - MIT to all packages ([@seanspeaks](https://github.com/seanspeaks))
 
 #### Authors: 1

package/LICENSE.md

@@ -2,8 +2,15 @@ MIT License
 
 Copyright (c) 2022 Left Hook Inc.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or
+substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,5 +1,6 @@
 # pipedrive
-    
-This is the API Module for pipedrive that allows the [Frigg](https://friggframework.org) code to talk to the pipedrive API.
+
+This is the API Module for pipedrive that allows the [Frigg](https://friggframework.org) code to talk to the pipedrive
+API.
 
 Read more on the [Frigg documentation site](https://docs.friggframework.org/api-modules/list/pipedrive

package/api.js

@@ -1,118 +1,453 @@
-const { OAuth2Requester } = require('@friggframework/module-plugin');
-const { get } = require('@friggframework/assertions');
+const { OAuth2Requester, get } = require('@friggframework/core');
 
 class Api extends OAuth2Requester {
     constructor(params) {
         super(params);
+        this.baseUrl = 'https://api.pipedrive.com/api/v2';
 
-        this.access_token = get(params, 'access_token', null);
-        this.refresh_token = get(params, 'refresh_token', null);
-        this.companyDomain = get(params, 'companyDomain', null);
-        this.baseURL = () => `${this.companyDomain}/api`;
-
-        this.client_id = process.env.PIPEDRIVE_CLIENT_ID;
-        this.client_secret = process.env.PIPEDRIVE_CLIENT_SECRET;
-        this.redirect_uri = `${process.env.REDIRECT_URI}/pipedrive`;
-        this.scopes = process.env.PIPEDRIVE_SCOPES;
+        // OAuth2 configuration
+        this.authorizationUri = 'https://oauth.pipedrive.com/oauth/authorize';
+        this.tokenUri = 'https://oauth.pipedrive.com/oauth/token';
+        this.client_id = get(params, 'client_id', process.env.PIPEDRIVE_CLIENT_ID);
+        this.client_secret = get(params, 'client_secret', process.env.PIPEDRIVE_CLIENT_SECRET);
+        this.redirect_uri = get(params, 'redirect_uri', process.env.PIPEDRIVE_REDIRECT_URI);
 
         this.URLs = {
-            activities: '/v1/activities',
-            activityFields: '/v1/activityFields',
-            activityById: (activityId) => `/v1/activities/${activityId}`,
-            getUser: '/v1/users/me',
-            users: '/v1/users',
-            deals: '/v1/deals',
-        };
+            // Activities endpoints
+            activities: '/activities',
+            activityById: (activityId) => `/activities/${activityId}`,
 
-        this.authorizationUri = encodeURI(
-            `https://oauth.pipedrive.com/oauth/authorize?client_id=${this.client_id}&redirect_uri=${this.redirect_uri}&response_type=code&scope=${this.scopes}`
-        );
+            // Deals endpoints
+            deals: '/deals',
+            dealById: (dealId) => `/deals/${dealId}`,
 
-        this.tokenUri = 'https://oauth.pipedrive.com/oauth/token';
+            // Products endpoints
+            products: '/products',
+            productById: (productId) => `/products/${productId}`,
+
+            // Leads endpoints
+            leads: '/leads',
+            leadById: (leadId) => `/leads/${leadId}`,
+
+            // Organizations endpoints
+            organizations: '/organizations',
+            organizationById: (orgId) => `/organizations/${orgId}`,
+
+            // Persons endpoints
+            persons: '/persons',
+            personById: (personId) => `/persons/${personId}`,
+
+            // Pipelines endpoints
+            pipelines: '/pipelines',
+            pipelineById: (pipelineId) => `/pipelines/${pipelineId}`,
+
+            // Stages endpoints
+            stages: '/stages',
+            stageById: (stageId) => `/stages/${stageId}`,
+
+            // Users endpoints
+            users: '/users',
+            userById: (userId) => `/users/${userId}`,
+
+            // Search endpoints
+            itemSearch: '/itemSearch',
+        };
     }
 
-    async setTokens(params) {
-        await this.setCompanyDomain(params.api_domain);
-        return super.setTokens(params);
+    async getAuthorizationUri() {
+        return `${this.authorizationUri}?client_id=${this.client_id}&redirect_uri=${this.redirect_uri}&response_type=code`;
     }
 
-    async setCompanyDomain(companyDomain) {
-        this.companyDomain = companyDomain;
+    // Activities API methods
+    async getActivities(options = {}) {
+        const query = this._cleanParams({
+            filter_id: options.filter_id,
+            ids: options.ids,
+            owner_id: options.owner_id,
+            deal_id: options.deal_id,
+            lead_id: options.lead_id,
+            person_id: options.person_id,
+            org_id: options.org_id,
+            done: options.done,
+            updated_since: options.updated_since,
+            updated_until: options.updated_until,
+            sort_by: options.sort_by || 'id',
+            sort_direction: options.sort_direction || 'asc',
+            include_fields: options.include_fields,
+            limit: options.limit || 100,
+            cursor: options.cursor
+        });
+
+        return this._get({
+            url: this.baseUrl + this.URLs.activities,
+            query
+        });
     }
-    // **************************   Deals   **********************************
-    async listDeals() {
-        const options = {
-            url: this.baseURL() + this.URLs.deals,
-        };
-        const res = await this._get(options);
-        return res;
+
+    async getActivityById(activityId) {
+        return this._get({
+            url: this.baseUrl + this.URLs.activityById(activityId)
+        });
     }
-    // **************************   Activities   **********************************
-    async listActivityFields() {
-        const options = {
-            url: this.baseURL() + this.URLs.activityFields,
-        };
-        const res = await this._get(options);
-        return res;
+
+    async createActivity(body) {
+        return this._post({
+            url: this.baseUrl + this.URLs.activities,
+            body,
+            headers: {
+                'Content-Type': 'application/json'
+            }
+        });
     }
 
-    async listActivities(params) {
-        const options = {
-            url: this.baseURL() + this.URLs.activities,
-        };
-        if (params.query) {
-            options.query = params.query;
-        }
-        const res = await this._get(options);
-        return res;
+    async updateActivity(activityId, body) {
+        return this._put({
+            url: this.baseUrl + this.URLs.activityById(activityId),
+            body,
+            headers: {
+                'Content-Type': 'application/json'
+            }
+        });
     }
 
     async deleteActivity(activityId) {
-        const options = {
-            url: this.baseURL() + this.URLs.activityById(activityId),
-        };
-        const res = await this._delete(options);
-        return res;
+        return this._delete({
+            url: this.baseUrl + this.URLs.activityById(activityId)
+        });
     }
 
-    async updateActivity(activityId, task) {
-        const options = {
-            url: this.baseURL() + this.URLs.activityById(activityId),
-            body: task,
-        };
-        const res = await this._patch(options);
-        return res;
+    // Deals API methods
+    async getDeals(options = {}) {
+        const query = this._cleanParams({
+            filter_id: options.filter_id,
+            ids: options.ids,
+            owner_id: options.owner_id,
+            stage_id: options.stage_id,
+            status: options.status,
+            updated_since: options.updated_since,
+            updated_until: options.updated_until,
+            sort_by: options.sort_by || 'id',
+            sort_direction: options.sort_direction || 'asc',
+            limit: options.limit || 100,
+            cursor: options.cursor
+        });
+
+        return this._get({
+            url: this.baseUrl + this.URLs.deals,
+            query
+        });
     }
 
-    async createActivity(params) {
-        const dealId = get(params, 'dealId', null);
-        const subject = get(params, 'subject');
-        const type = get(params, 'type');
-        const options = {
-            url: this.baseURL() + this.URLs.activities,
-            body: { ...params },
+    async getDealById(dealId) {
+        return this._get({
+            url: this.baseUrl + this.URLs.dealById(dealId)
+        });
+    }
+
+    async createDeal(body) {
+        return this._post({
+            url: this.baseUrl + this.URLs.deals,
+            body,
             headers: {
-                'Content-Type': 'application/json',
-            },
-        };
-        const res = await this._post(options);
-        return res;
+                'Content-Type': 'application/json'
+            }
+        });
     }
-    // **************************   Users   **********************************
-    async getUser() {
-        const options = {
-            url: this.baseURL() + this.URLs.getUser,
-        };
-        const res = await this._get(options);
-        return res;
+
+    async updateDeal(dealId, body) {
+        return this._put({
+            url: this.baseUrl + this.URLs.dealById(dealId),
+            body,
+            headers: {
+                'Content-Type': 'application/json'
+            }
+        });
     }
 
-    async listUsers() {
-        const options = {
-            url: this.baseURL() + this.URLs.users,
-        };
-        const res = await this._get(options);
-        return res;
+    async deleteDeal(dealId) {
+        return this._delete({
+            url: this.baseUrl + this.URLs.dealById(dealId)
+        });
+    }
+
+    // Products API methods
+    async getProducts(options = {}) {
+        const query = this._cleanParams({
+            filter_id: options.filter_id,
+            ids: options.ids,
+            owner_id: options.owner_id,
+            updated_since: options.updated_since,
+            updated_until: options.updated_until,
+            sort_by: options.sort_by || 'id',
+            sort_direction: options.sort_direction || 'asc',
+            limit: options.limit || 100,
+            cursor: options.cursor
+        });
+
+        return this._get({
+            url: this.baseUrl + this.URLs.products,
+            query
+        });
+    }
+
+    async getProductById(productId) {
+        return this._get({
+            url: this.baseUrl + this.URLs.productById(productId)
+        });
+    }
+
+    async createProduct(body) {
+        return this._post({
+            url: this.baseUrl + this.URLs.products,
+            body,
+            headers: {
+                'Content-Type': 'application/json'
+            }
+        });
+    }
+
+    async updateProduct(productId, body) {
+        return this._put({
+            url: this.baseUrl + this.URLs.productById(productId),
+            body,
+            headers: {
+                'Content-Type': 'application/json'
+            }
+        });
+    }
+
+    async deleteProduct(productId) {
+        return this._delete({
+            url: this.baseUrl + this.URLs.productById(productId)
+        });
+    }
+
+    // Leads API methods
+    async getLeads(options = {}) {
+        const query = this._cleanParams({
+            filter_id: options.filter_id,
+            ids: options.ids,
+            owner_id: options.owner_id,
+            updated_since: options.updated_since,
+            updated_until: options.updated_until,
+            sort_by: options.sort_by || 'id',
+            sort_direction: options.sort_direction || 'asc',
+            limit: options.limit || 100,
+            cursor: options.cursor
+        });
+
+        return this._get({
+            url: this.baseUrl + this.URLs.leads,
+            query
+        });
+    }
+
+    async getLeadById(leadId) {
+        return this._get({
+            url: this.baseUrl + this.URLs.leadById(leadId)
+        });
+    }
+
+    async createLead(body) {
+        return this._post({
+            url: this.baseUrl + this.URLs.leads,
+            body,
+            headers: {
+                'Content-Type': 'application/json'
+            }
+        });
+    }
+
+    async updateLead(leadId, body) {
+        return this._put({
+            url: this.baseUrl + this.URLs.leadById(leadId),
+            body,
+            headers: {
+                'Content-Type': 'application/json'
+            }
+        });
+    }
+
+    async deleteLead(leadId) {
+        return this._delete({
+            url: this.baseUrl + this.URLs.leadById(leadId)
+        });
+    }
+
+    // Organizations API methods
+    async getOrganizations(options = {}) {
+        const query = this._cleanParams({
+            filter_id: options.filter_id,
+            ids: options.ids,
+            owner_id: options.owner_id,
+            updated_since: options.updated_since,
+            updated_until: options.updated_until,
+            sort_by: options.sort_by || 'id',
+            sort_direction: options.sort_direction || 'asc',
+            limit: options.limit || 100,
+            cursor: options.cursor
+        });
+
+        return this._get({
+            url: this.baseUrl + this.URLs.organizations,
+            query
+        });
+    }
+
+    async getOrganizationById(orgId) {
+        return this._get({
+            url: this.baseUrl + this.URLs.organizationById(orgId)
+        });
+    }
+
+    async createOrganization(body) {
+        return this._post({
+            url: this.baseUrl + this.URLs.organizations,
+            body,
+            headers: {
+                'Content-Type': 'application/json'
+            }
+        });
+    }
+
+    async updateOrganization(orgId, body) {
+        return this._put({
+            url: this.baseUrl + this.URLs.organizationById(orgId),
+            body,
+            headers: {
+                'Content-Type': 'application/json'
+            }
+        });
+    }
+
+    async deleteOrganization(orgId) {
+        return this._delete({
+            url: this.baseUrl + this.URLs.organizationById(orgId)
+        });
+    }
+
+    // Persons API methods
+    async getPersons(options = {}) {
+        const query = this._cleanParams({
+            filter_id: options.filter_id,
+            ids: options.ids,
+            owner_id: options.owner_id,
+            org_id: options.org_id,
+            updated_since: options.updated_since,
+            updated_until: options.updated_until,
+            sort_by: options.sort_by || 'id',
+            sort_direction: options.sort_direction || 'asc',
+            limit: options.limit || 100,
+            cursor: options.cursor
+        });
+
+        return this._get({
+            url: this.baseUrl + this.URLs.persons,
+            query
+        });
+    }
+
+    async getPersonById(personId) {
+        return this._get({
+            url: this.baseUrl + this.URLs.personById(personId)
+        });
+    }
+
+    async createPerson(body) {
+        return this._post({
+            url: this.baseUrl + this.URLs.persons,
+            body,
+            headers: {
+                'Content-Type': 'application/json'
+            }
+        });
+    }
+
+    async updatePerson(personId, body) {
+        return this._put({
+            url: this.baseUrl + this.URLs.personById(personId),
+            body,
+            headers: {
+                'Content-Type': 'application/json'
+            }
+        });
+    }
+
+    async deletePerson(personId) {
+        return this._delete({
+            url: this.baseUrl + this.URLs.personById(personId)
+        });
+    }
+
+    // Pipelines API methods
+    async getPipelines(options = {}) {
+        const query = this._cleanParams(options);
+        return this._get({
+            url: this.baseUrl + this.URLs.pipelines,
+            query
+        });
+    }
+
+    async getPipelineById(pipelineId) {
+        return this._get({
+            url: this.baseUrl + this.URLs.pipelineById(pipelineId)
+        });
+    }
+
+    // Stages API methods
+    async getStages(options = {}) {
+        const query = this._cleanParams(options);
+        return this._get({
+            url: this.baseUrl + this.URLs.stages,
+            query
+        });
+    }
+
+    async getStageById(stageId) {
+        return this._get({
+            url: this.baseUrl + this.URLs.stageById(stageId)
+        });
+    }
+
+    // Users API methods
+    async getUsers(options = {}) {
+        const query = this._cleanParams(options);
+        return this._get({
+            url: this.baseUrl + this.URLs.users,
+            query
+        });
+    }
+
+    async getUserById(userId) {
+        return this._get({
+            url: this.baseUrl + this.URLs.userById(userId)
+        });
+    }
+
+    async getCurrentUser() {
+        const users = await this.getUsers();
+        return users.data && users.data.length > 0 ? users.data[0] : null;
+    }
+
+    // Search API methods
+    async search(options = {}) {
+        const query = this._cleanParams(options);
+        return this._get({
+            url: this.baseUrl + this.URLs.itemSearch,
+            query
+        });
+    }
+
+    // Helper methods
+    _cleanParams(params) {
+        const cleaned = {};
+        Object.keys(params).forEach(key => {
+            if (params[key] !== undefined && params[key] !== null) {
+                cleaned[key] = params[key];
+            }
+        });
+        return cleaned;
     }
 }
+
 module.exports = { Api };