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

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 };

package/defaultConfig.json

@@ -1,9 +1,11 @@
 {
-    "name": "pipedrive",
-    "label": "PipeDrive CRM",
-    "productUrl": "https://pipedrive.com",
-    "apiDocs": "https://developer.pipedrive.com",
-    "logoUrl": "https://friggframework.org/assets/img/pipedrive.jpeg",
-    "categories": ["Sales"],
-    "description": "Pipedrive"
+  "name": "pipedrive",
+  "label": "PipeDrive CRM",
+  "productUrl": "https://pipedrive.com",
+  "apiDocs": "https://developer.pipedrive.com",
+  "logoUrl": "https://friggframework.org/assets/img/pipedrive-icon.png",
+  "categories": [
+    "Sales"
+  ],
+  "description": "Pipedrive"
 }

package/definition.js

@@ -0,0 +1,54 @@
+require('dotenv').config();
+const { Api } = require('./api');
+const { get } = require('@friggframework/core');
+const config = require('./defaultConfig.json');
+
+const Definition = {
+    API: Api,
+    getName: function () {
+        return config.name;
+    },
+    moduleName: config.name,
+    modelName: 'Pipedrive',
+    requiredAuthMethods: {
+        getAuthorizationRequirements: async function (params) {
+            return {
+                url: await this.api.getAuthUri(),
+                type: 'oauth2',
+            };
+        },
+        getToken: async function (api, params) {
+            const code = get(params.data, 'code');
+            return api.getTokenFromCode(code);
+        },
+        getEntityDetails: async function (api, callbackParams, tokenResponse, userId) {
+            const userDetails = await api.getUser();
+            return {
+                identifiers: { externalId: userDetails.data.id, user: userId },
+                details: { name: userDetails.data.name || userDetails.data.email }
+            };
+        },
+        apiPropertiesToPersist: {
+            credential: ['access_token', 'refresh_token', 'companyDomain'],
+            entity: []
+        },
+        getCredentialDetails: async function (api, userId) {
+            const userDetails = await api.getUser();
+            return {
+                identifiers: { externalId: userDetails.data.id, user: userId },
+                details: {}
+            };
+        },
+        testAuthRequest: async function (api) {
+            return api.getUser();
+        }
+    },
+    env: {
+        client_id: process.env.PIPEDRIVE_CLIENT_ID,
+        client_secret: process.env.PIPEDRIVE_CLIENT_SECRET,
+        scope: process.env.PIPEDRIVE_SCOPE,
+        redirect_uri: `${process.env.REDIRECT_URI}/pipedrive`
+    }
+};
+
+module.exports = { Definition }; 

package/index.js

@@ -1,6 +1,6 @@
-const { Api } = require('./api');
-const { Credential } = require('./models/credential');
-const { Entity } = require('./models/entity');
+const {Api} = require('./api');
+const {Credential} = require('./models/credential');
+const {Entity} = require('./models/entity');
 const ModuleManager = require('./manager');
 const Config = require('./defaultConfig');
 

package/jest-setup.js

@@ -1,2 +1,2 @@
-const { globalSetup } = require('@friggframework/test-environment');
+const {globalSetup} = require('@friggframework/test');
 module.exports = globalSetup;

package/jest-teardown.js

@@ -1,2 +1,2 @@
-const { globalTeardown } = require('@friggframework/test-environment');
+const {globalTeardown} = require('@friggframework/test');
 module.exports = globalTeardown;

package/manager.js

@@ -1,18 +1,20 @@
-const _ = require('lodash');
-const { Api } = require('./api.js');
-const { Entity } = require('./models/entity');
-const { Credential } = require('./models/credential');
 const {
     ModuleManager,
     ModuleConstants,
-} = require('@friggframework/module-plugin');
-const { flushDebugLog, debug } = require('@friggframework/logs');
+    flushDebugLog,
+    debug
+} = require('@friggframework/core');
+const {Api} = require('./api.js');
+const {Entity} = require('./models/entity');
+const {Credential} = require('./models/credential');
 const Config = require('./defaultConfig.json');
 
 class Manager extends ModuleManager {
-    static Entity = Entity;
+    static
+    Entity = Entity;
 
-    static Credential = Credential;
+    static
+    Credential = Credential;
 
     constructor(params) {
         super(params);
@@ -22,10 +24,11 @@ class Manager extends ModuleManager {
         return Config.name;
     }
 
-    static async getInstance(params) {
+    static
+    async getInstance(params) {
         const instance = new this(params);
 
-        const apiParams = { delegate: instance };
+        const apiParams = {delegate: instance};
         if (params.entityId) {
             instance.entity = await instance.entityMO.get(params.entityId);
             instance.credential = await instance.credentialMO.get(