@friggframework/api-module-pipedrive 1.0.1-v1-alpha.5 → 2.1.0-canary.56.2dc58f9.0

package/mocks/activities/updateActivity.js

@@ -1,172 +0,0 @@
-module.exports = {
-    data: {
-        type: 'task',
-        id: 31,
-        attributes: {
-            action: 'email',
-            autoskipAt: null,
-            compiledSequenceTemplateHtml: null,
-            completed: false,
-            completedAt: null,
-            createdAt: '2021-11-06T02:52:48.000Z',
-            dueAt: '2021-11-06T02:52:48.000Z',
-            note: null,
-            opportunityAssociation: null,
-            scheduledAt: null,
-            state: 'incomplete',
-            stateChangedAt: null,
-            taskType: 'manual',
-            updatedAt: '2021-11-06T03:04:55.000Z',
-        },
-        relationships: {
-            account: {
-                data: {
-                    type: 'account',
-                    id: 3,
-                },
-            },
-            call: {
-                data: null,
-            },
-            calls: {
-                links: {
-                    related:
-                        'https://api.pipedrive.io/api/v2/calls?filter%5Btask%5D%5Bid%5D=31',
-                },
-            },
-            completer: {
-                data: null,
-            },
-            creator: {
-                data: {
-                    type: 'user',
-                    id: 1,
-                },
-            },
-            defaultPluginMapping: {
-                data: null,
-            },
-            mailing: {
-                data: null,
-            },
-            mailings: {
-                links: {
-                    related:
-                        'https://api.pipedrive.io/api/v2/mailings?filter%5Btask%5D%5Bid%5D=31',
-                },
-            },
-            opportunity: {
-                data: null,
-            },
-            owner: {
-                data: {
-                    type: 'user',
-                    id: 1,
-                },
-            },
-            prospect: {
-                data: null,
-            },
-            prospectAccount: {
-                data: null,
-            },
-            prospectContacts: {
-                data: [],
-                links: {
-                    related:
-                        'https://api.pipedrive.io/api/v2/emailAddresses?filter%5Btask%5D%5Bid%5D=31',
-                },
-                meta: {
-                    count: 0,
-                },
-            },
-            prospectOwner: {
-                data: null,
-            },
-            prospectPhoneNumbers: {
-                data: [],
-                links: {
-                    related:
-                        'https://api.pipedrive.io/api/v2/phoneNumbers?filter%5Btask%5D%5Bid%5D=31',
-                },
-                meta: {
-                    count: 0,
-                },
-            },
-            prospectStage: {
-                data: null,
-            },
-            sequence: {
-                data: null,
-            },
-            sequenceSequenceSteps: {
-                data: [],
-                links: {
-                    related:
-                        'https://api.pipedrive.io/api/v2/sequenceSteps?filter%5Btask%5D%5Bid%5D=31',
-                },
-                meta: {
-                    count: 0,
-                },
-            },
-            sequenceState: {
-                data: null,
-            },
-            sequenceStateSequenceStep: {
-                data: null,
-            },
-            sequenceStateSequenceStepOverrides: {
-                data: [],
-                meta: {
-                    count: 0,
-                },
-            },
-            sequenceStateStartingTemplate: {
-                data: null,
-            },
-            sequenceStep: {
-                data: null,
-            },
-            sequenceStepOverrideTemplates: {
-                data: [],
-                links: {
-                    related:
-                        'https://api.pipedrive.io/api/v2/templates?filter%5Btask%5D%5Bid%5D=31',
-                },
-                meta: {
-                    count: 0,
-                },
-            },
-            sequenceTemplate: {
-                data: null,
-            },
-            sequenceTemplateTemplate: {
-                data: null,
-            },
-            subject: {
-                data: {
-                    type: 'account',
-                    id: 3,
-                },
-            },
-            taskPriority: {
-                data: {
-                    type: 'taskPriority',
-                    id: 3,
-                },
-            },
-            taskTheme: {
-                data: {
-                    type: 'taskTheme',
-                    id: 1,
-                },
-            },
-            template: {
-                data: null,
-            },
-        },
-        links: {
-            self: 'https://api.pipedrive.io/api/v2/tasks/31',
-        },
-    },
-};

package/mocks/apiMock.js

@@ -1,28 +0,0 @@
-class MockApi {
-    constructor() {}
-
-    /** * Deals ** */
-
-    async listDeals() {
-        return require('./deals/listDeals');
-    }
-    /** * Activities ** */
-
-    async createActivity() {
-        return require('./activities/createActivity');
-    }
-
-    async listActivities() {
-        return require('./activities/listActivities');
-    }
-
-    async deleteActivity() {
-        return require('./activities/deleteActivity');
-    }
-
-    async updateActivity() {
-        return require('./activities/updateActivity');
-    }
-}
-
-module.exports = MockApi;

package/mocks/deals/listDeals.js

@@ -1,236 +0,0 @@
-module.exports = {
-    success: true,
-    data: [
-        {
-            id: 1,
-            creator_user_id: {
-                id: 1811658,
-                name: 'Tom Elliott',
-                email: 'projectteam@lefthook.co',
-                has_pic: 1,
-                pic_hash: 'de38c66276cb325d7c0e84d4fae1f0ce',
-                active_flag: true,
-                value: 1811658,
-            },
-            user_id: {
-                id: 1811658,
-                name: 'Tom Elliott',
-                email: 'projectteam@lefthook.co',
-                has_pic: 1,
-                pic_hash: 'de38c66276cb325d7c0e84d4fae1f0ce',
-                active_flag: true,
-                value: 1811658,
-            },
-            person_id: {
-                active_flag: true,
-                name: 'Example Person',
-                email: [
-                    {
-                        value: '',
-                        primary: true,
-                    },
-                ],
-                phone: [
-                    {
-                        value: '',
-                        primary: true,
-                    },
-                ],
-                owner_id: 1811658,
-                value: 1,
-            },
-            org_id: null,
-            stage_id: 1,
-            title: 'Example Person deal',
-            value: 0,
-            currency: 'USD',
-            add_time: '2020-07-06 19:08:03',
-            update_time: '2020-07-06 19:08:03',
-            stage_change_time: null,
-            active: true,
-            deleted: false,
-            status: 'open',
-            probability: null,
-            next_activity_date: null,
-            next_activity_time: null,
-            next_activity_id: null,
-            last_activity_id: null,
-            last_activity_date: null,
-            lost_reason: null,
-            visible_to: '3',
-            close_time: null,
-            pipeline_id: 1,
-            won_time: null,
-            first_won_time: null,
-            lost_time: null,
-            products_count: 0,
-            files_count: 0,
-            notes_count: 0,
-            followers_count: 1,
-            email_messages_count: 0,
-            activities_count: 0,
-            done_activities_count: 0,
-            undone_activities_count: 0,
-            participants_count: 1,
-            expected_close_date: null,
-            last_incoming_mail_time: null,
-            last_outgoing_mail_time: null,
-            label: null,
-            renewal_type: 'one_time',
-            stage_order_nr: 1,
-            person_name: 'Example Person',
-            org_name: null,
-            next_activity_subject: null,
-            next_activity_type: null,
-            next_activity_duration: null,
-            next_activity_note: null,
-            group_id: null,
-            group_name: null,
-            formatted_value: '$0',
-            weighted_value: 0,
-            formatted_weighted_value: '$0',
-            weighted_value_currency: 'USD',
-            rotten_time: null,
-            owner_name: 'Tom Elliott',
-            cc_email: 'lefthook-sandbox-41e8b7+deal1@pipedrivemail.com',
-            org_hidden: false,
-            person_hidden: false,
-        },
-        {
-            id: 2,
-            creator_user_id: {
-                id: 1811658,
-                name: 'Tom Elliott',
-                email: 'projectteam@lefthook.co',
-                has_pic: 1,
-                pic_hash: 'de38c66276cb325d7c0e84d4fae1f0ce',
-                active_flag: true,
-                value: 1811658,
-            },
-            user_id: {
-                id: 1811658,
-                name: 'Tom Elliott',
-                email: 'projectteam@lefthook.co',
-                has_pic: 1,
-                pic_hash: 'de38c66276cb325d7c0e84d4fae1f0ce',
-                active_flag: true,
-                value: 1811658,
-            },
-            person_id: null,
-            org_id: {
-                name: 'Left Hook',
-                people_count: 0,
-                owner_id: 1811658,
-                address: null,
-                active_flag: true,
-                cc_email: 'lefthook-sandbox-41e8b7@pipedrivemail.com',
-                value: 1,
-            },
-            stage_id: 1,
-            title: 'New Deal gotta find person',
-            value: 0,
-            currency: 'USD',
-            add_time: '2021-11-19 19:14:43',
-            update_time: '2021-11-19 19:14:43',
-            stage_change_time: null,
-            active: true,
-            deleted: false,
-            status: 'open',
-            probability: null,
-            next_activity_date: null,
-            next_activity_time: null,
-            next_activity_id: null,
-            last_activity_id: null,
-            last_activity_date: null,
-            lost_reason: null,
-            visible_to: '3',
-            close_time: null,
-            pipeline_id: 1,
-            won_time: null,
-            first_won_time: null,
-            lost_time: null,
-            products_count: 0,
-            files_count: 0,
-            notes_count: 0,
-            followers_count: 1,
-            email_messages_count: 0,
-            activities_count: 0,
-            done_activities_count: 0,
-            undone_activities_count: 0,
-            participants_count: 0,
-            expected_close_date: null,
-            last_incoming_mail_time: null,
-            last_outgoing_mail_time: null,
-            label: null,
-            renewal_type: 'one_time',
-            stage_order_nr: 1,
-            person_name: null,
-            org_name: 'Left Hook',
-            next_activity_subject: null,
-            next_activity_type: null,
-            next_activity_duration: null,
-            next_activity_note: null,
-            group_id: null,
-            group_name: null,
-            formatted_value: '$0',
-            weighted_value: 0,
-            formatted_weighted_value: '$0',
-            weighted_value_currency: 'USD',
-            rotten_time: null,
-            owner_name: 'Tom Elliott',
-            cc_email: 'lefthook-sandbox-41e8b7+deal2@pipedrivemail.com',
-            org_hidden: false,
-            person_hidden: false,
-        },
-    ],
-    additional_data: {
-        pagination: {
-            start: 0,
-            limit: 100,
-            more_items_in_collection: false,
-        },
-    },
-    related_objects: {
-        user: {
-            1811658: {
-                id: 1811658,
-                name: 'Tom Elliott',
-                email: 'projectteam@lefthook.co',
-                has_pic: 1,
-                pic_hash: 'de38c66276cb325d7c0e84d4fae1f0ce',
-                active_flag: true,
-            },
-        },
-        person: {
-            1: {
-                active_flag: true,
-                id: 1,
-                name: 'Example Person',
-                email: [
-                    {
-                        value: '',
-                        primary: true,
-                    },
-                ],
-                phone: [
-                    {
-                        value: '',
-                        primary: true,
-                    },
-                ],
-                owner_id: 1811658,
-            },
-        },
-        organization: {
-            1: {
-                id: 1,
-                name: 'Left Hook',
-                people_count: 0,
-                owner_id: 1811658,
-                address: null,
-                active_flag: true,
-                cc_email: 'lefthook-sandbox-41e8b7@pipedrivemail.com',
-            },
-        },
-    },
-};

package/models/credential.js

@@ -1,21 +0,0 @@
-const { Credential: Parent } = require('@friggframework/core');
-const mongoose = require('mongoose');
-
-const schema = new mongoose.Schema({
-    accessToken: {
-        type: String,
-        trim: true,
-        lhEncrypt: true,
-    },
-    refreshToken: {
-        type: String,
-        trim: true,
-        lhEncrypt: true,
-    },
-    companyDomain: { type: String },
-});
-
-const name = 'PipedriveCredential';
-const Credential =
-    Parent.discriminators?.[name] || Parent.discriminator(name, schema);
-module.exports = { Credential };

package/models/entity.js

@@ -1,9 +0,0 @@
-const { Entity: Parent } = require('@friggframework/core');
-'use strict';
-const mongoose = require('mongoose');
-
-const schema = new mongoose.Schema({});
-const name = 'PipedriveEntity';
-const Entity =
-    Parent.discriminators?.[name] || Parent.discriminator(name, schema);
-module.exports = { Entity };

package/test/Api.test.js

@@ -1,157 +0,0 @@
-const chai = require('chai');
-const { expect } = chai;
-const should = chai.should();
-const { Api } = require('../api');
-const { mockApi } = require('../../../../test/utils/mockApi');
-
-const MockedApi = mockApi(Api, {
-    authenticationMode: 'browser',
-    filteringScope: (url) => {
-        return /^https:[/][/].+[.]pipedrive[.]com/.test(url);
-    },
-});
-
-describe('Pipedrive API class', async () => {
-    let api;
-    before(async function () {
-        await MockedApi.initialize({ test: this.test });
-        api = await MockedApi.mock();
-    });
-
-    after(async function () {
-        await MockedApi.clean({ test: this.test });
-    });
-
-    describe('User', async () => {
-        it('should list user profile', async () => {
-            const response = await api.getUser();
-            chai.assert.hasAllKeys(response.data, [
-                'id',
-                'name',
-                'company_country',
-                'company_domain',
-                'company_id',
-                'company_name',
-                'default_currency',
-                'locale',
-                'lang',
-                'last_login',
-                'language',
-                'email',
-                'phone',
-                'created',
-                'modified',
-                'signup_flow_variation',
-                'has_created_company',
-                'is_admin',
-                'active_flag',
-                'timezone_name',
-                'timezone_offset',
-                'role_id',
-                'icon_url',
-                'is_you',
-            ]);
-        });
-    });
-
-    describe('Deals', async () => {
-        it('should list deals', async () => {
-            const response = await api.listDeals();
-            response.data.length.should.above(0);
-            response.data[0].should.have.property('id');
-            return response;
-        });
-    });
-
-    describe('Activities', async () => {
-        const mockActivity = {};
-        it('should list all Activity Fields', async () => {
-            const response = await api.listActivityFields();
-            const isRequired = response.data.filter(
-                (field) => field.mandatory_flag
-            );
-
-            for (const field of isRequired) {
-                mockActivity[field.key] = 'blah';
-            }
-        });
-        it('should create an email activity', async () => {
-            const activity = {
-                subject: 'Example Activtiy from the local grave',
-                type: 'email',
-                due_date: new Date('2021-12-03T15:06:38.700Z'),
-                user_id: '1811658',
-            };
-            const response = await api.createActivity(activity);
-            response.success.should.equal(true);
-        });
-        it('should get activities', async () => {
-            const response = await api.listActivities({
-                query: {
-                    user_id: 0, // Gets activities for all users, instead of just the auth'ed user
-                },
-            });
-            response.data[0].should.have.property('id');
-            response.data.length.should.above(0);
-            return response;
-        });
-    });
-
-    describe('Users', async () => {
-        it('should get users', async () => {
-            const response = await api.listUsers();
-            response.data.should.be.an('array').of.length.greaterThan(0);
-            response.data[0].should.have.keys(
-                'active_flag',
-                'created',
-                'default_currency',
-                'email',
-                'has_created_company',
-                'icon_url',
-                'id',
-                'is_admin',
-                'is_you',
-                'lang',
-                'last_login',
-                'locale',
-                'modified',
-                'name',
-                'phone',
-                'role_id',
-                'signup_flow_variation',
-                'timezone_name',
-                'timezone_offset'
-            );
-            return response;
-        });
-    });
-
-    describe('Bad Auth', async () => {
-        it('should refresh bad auth token', async () => {
-            // Needed to paste a valid JWT, otherwise it's testing the wrong error.
-            // TODO expand on other error types.
-            const badAccessToken =
-                'eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJzZWFuLm1hdHRoZXdzQGxlZnRob29rLmNvbSIsImlhdCI6MTYzNTUzMDk3OCwiZXhwIjoxNjM1NTM4MTc4LCJiZW50byI6ImFwcDFlIiwiYWN0Ijp7InN1YiI6IlZob0NzMFNRZ25Fa2RDanRkaFZLemV5bXBjNW9valZoRXB2am03Rjh1UVEiLCJuYW1lIjoiTGVmdCBIb29rIiwiaXNzIjoiZmxhZ3NoaXAiLCJ0eXBlIjoiYXBwIn0sIm9yZ191c2VyX2lkIjoxLCJhdWQiOiJMZWZ0IEhvb2siLCJzY29wZXMiOiJBSkFBOEFIUUFCQUJRQT09Iiwib3JnX2d1aWQiOiJmNzY3MDEzZC1mNTBiLTRlY2QtYjM1My0zNWU0MWQ5Y2RjNGIiLCJvcmdfc2hvcnRuYW1lIjoibGVmdGhvb2tzYW5kYm94In0.XFmIai0GpAePsYeA4MjRntZS3iW6effmKmIhT7SBzTQ';
-            api.access_token = badAccessToken;
-
-            await api.listDeals();
-            api.access_token.should.not.equal(badAccessToken);
-        });
-
-        it('should throw error with invalid refresh token', async () => {
-            try {
-                api.access_token =
-                    'eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJzZWFuLm1hdHRoZXdzQGxlZnRob29rLmNvbSIsImlhdCI6MTYzNTUzMDk3OCwiZXhwIjoxNjM1NTM4MTc4LCJiZW50byI6ImFwcDFlIiwiYWN0Ijp7InN1YiI6IlZob0NzMFNRZ25Fa2RDanRkaFZLemV5bXBjNW9valZoRXB2am03Rjh1UVEiLCJuYW1lIjoiTGVmdCBIb29rIiwiaXNzIjoiZmxhZ3NoaXAiLCJ0eXBlIjoiYXBwIn0sIm9yZ191c2VyX2lkIjoxLCJhdWQiOiJMZWZ0IEhvb2siLCJzY29wZXMiOiJBSkFBOEFIUUFCQUJRQT09Iiwib3JnX2d1aWQiOiJmNzY3MDEzZC1mNTBiLTRlY2QtYjM1My0zNWU0MWQ5Y2RjNGIiLCJvcmdfc2hvcnRuYW1lIjoibGVmdGhvb2tzYW5kYm94In0.XFmIai0GpAePsYeA4MjRntZS3iW6effmKmIhT7SBzTQ';
-                api.refresh_token = 'nolongervalid';
-                await api.listDeals();
-                throw new Error('Expected error not thrown');
-            } catch (e) {
-                e.message.should.contain(
-                    '-----------------------------------------------------\n' +
-                        'An error ocurred while fetching an external resource.\n' +
-                        '-----------------------------------------------------'
-                );
-            }
-        });
-    });
-});