@friggframework/api-module-pipedrive 2.1.0-canary.56.2dc58f9.0 → 2.1.0-canary.57.58a8b12.0

package/dist/api.d.ts

@@ -1,5 +1,5 @@
-import { OAuth2Requester } from '@friggframework/core';
-import { OAuth2RequesterOptions, ActivityParams, ListActivitiesParams, ListDealsParams, ListPersonsParams, GetPersonParams, PipedriveResponse, PipedriveUser, PipedriveTokenResponse } from './types';
+import { OAuth2Requester } from "@friggframework/core";
+import { OAuth2RequesterOptions, ActivityParams, ListActivitiesParams, ListDealsParams, ListPersonsParams, GetPersonParams, ListOrganizationsParams, GetOrganizationParams, PipedriveResponse, PipedriveUser, PipedriveTokenResponse } from "./types";
 export declare class Api extends OAuth2Requester {
     companyDomain: string | null;
     URLs: {
@@ -11,6 +11,8 @@ export declare class Api extends OAuth2Requester {
         deals: string;
         persons: string;
         personById: (personId: string | number) => string;
+        organizations: string;
+        organizationById: (orgId: string | number) => string;
     };
     constructor(params: OAuth2RequesterOptions);
     /**
@@ -56,4 +58,17 @@ export declare class Api extends OAuth2Requester {
      * @returns Response with person data
      */
     getPerson(personId: string | number, params?: GetPersonParams): Promise<PipedriveResponse>;
+    /**
+     * List organizations with v2 API support
+     * @param params - Query parameters for filtering and pagination
+     * @returns Response with organization data array and pagination cursor
+     */
+    listOrganizations(params?: ListOrganizationsParams): Promise<PipedriveResponse>;
+    /**
+     * Get a single organization by ID
+     * @param orgId - The ID of the organization to retrieve
+     * @param params - Query parameters for additional fields
+     * @returns Response with organization data
+     */
+    getOrganization(orgId: string | number, params?: GetOrganizationParams): Promise<PipedriveResponse>;
 }

package/dist/api.js

@@ -5,22 +5,22 @@ const core_1 = require("@friggframework/core");
 class Api extends core_1.OAuth2Requester {
     constructor(params) {
         super(params);
-        this.companyDomain = (0, core_1.get)(params, 'companyDomain', null);
-        if (this.companyDomain) {
-            this.baseUrl = `${this.companyDomain}/api`;
-        }
+        this.companyDomain = (0, core_1.get)(params, "companyDomain", null);
+        this.baseUrl = `${this.companyDomain}/api`;
         this.URLs = {
-            activities: '/v2/activities',
-            activityFields: '/v1/activityFields',
+            activities: "/v2/activities",
+            activityFields: "/v1/activityFields",
             activityById: (activityId) => `/v2/activities/${activityId}`,
-            getUser: '/v1/users/me',
-            users: '/v1/users',
-            deals: '/v2/deals',
-            persons: '/v2/persons',
+            getUser: "/v1/users/me",
+            users: "/v1/users",
+            deals: "/v2/deals",
+            persons: "/v2/persons",
             personById: (personId) => `/v2/persons/${personId}`,
+            organizations: "/v2/organizations",
+            organizationById: (orgId) => `/v2/organizations/${orgId}`,
         };
         this.authorizationUri = encodeURI(`https://oauth.pipedrive.com/oauth/authorize?client_id=${this.client_id}&redirect_uri=${this.redirect_uri}&response_type=code&scope=${this.scope}`);
-        this.tokenUri = 'https://oauth.pipedrive.com/oauth/token';
+        this.tokenUri = "https://oauth.pipedrive.com/oauth/token";
     }
     /**
      * Sets OAuth tokens and captures the Pipedrive company domain
@@ -33,7 +33,7 @@ class Api extends core_1.OAuth2Requester {
             await this.setCompanyDomain(params.api_domain);
         }
         else if (!this.companyDomain) {
-            throw new Error('Pipedrive api_domain not provided in token response');
+            throw new Error("Pipedrive api_domain not provided in token response");
         }
         return super.setTokens(params);
     }
@@ -43,9 +43,9 @@ class Api extends core_1.OAuth2Requester {
      */
     async setCompanyDomain(companyDomain) {
         if (!companyDomain) {
-            throw new Error('Company domain is required for Pipedrive API');
+            throw new Error("Company domain is required for Pipedrive API");
         }
-        const formattedDomain = companyDomain.startsWith('http')
+        const formattedDomain = companyDomain.startsWith("http")
             ? companyDomain
             : `https://${companyDomain}`;
         this.companyDomain = formattedDomain;
@@ -101,14 +101,14 @@ class Api extends core_1.OAuth2Requester {
         return this._patch(options);
     }
     async createActivity(params) {
-        const dealId = (0, core_1.get)(params, 'dealId', null);
-        const subject = (0, core_1.get)(params, 'subject');
-        const type = (0, core_1.get)(params, 'type');
+        const dealId = (0, core_1.get)(params, "dealId", null);
+        const subject = (0, core_1.get)(params, "subject");
+        const type = (0, core_1.get)(params, "type");
         const options = {
             url: this.baseUrl + this.URLs.activities,
             body: { ...params },
             headers: {
-                'Content-Type': 'application/json',
+                "Content-Type": "application/json",
             },
         };
         return this._post(options);
@@ -156,5 +156,35 @@ class Api extends core_1.OAuth2Requester {
         }
         return this._get(options);
     }
+    // **************************   Organizations   **********************************
+    /**
+     * List organizations with v2 API support
+     * @param params - Query parameters for filtering and pagination
+     * @returns Response with organization data array and pagination cursor
+     */
+    async listOrganizations(params) {
+        const options = {
+            url: this.baseUrl + this.URLs.organizations,
+        };
+        if (params && Object.keys(params).length > 0) {
+            options.query = params;
+        }
+        return this._get(options);
+    }
+    /**
+     * Get a single organization by ID
+     * @param orgId - The ID of the organization to retrieve
+     * @param params - Query parameters for additional fields
+     * @returns Response with organization data
+     */
+    async getOrganization(orgId, params) {
+        const options = {
+            url: this.baseUrl + this.URLs.organizationById(orgId),
+        };
+        if (params && Object.keys(params).length > 0) {
+            options.query = params;
+        }
+        return this._get(options);
+    }
 }
 exports.Api = Api;

package/dist/defaultConfig.json

@@ -0,0 +1,11 @@
+{
+    "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/dist/definition.d.ts

@@ -1,4 +1,4 @@
-import 'dotenv/config';
-import { FriggModuleAuthDefinition } from '@friggframework/core';
+import "dotenv/config";
+import { FriggModuleAuthDefinition } from "@friggframework/core";
 declare const Definition: FriggModuleAuthDefinition;
 export { Definition };

package/dist/definition.js

@@ -7,17 +7,17 @@ exports.Definition = void 0;
 require("dotenv/config");
 const api_1 = require("./api");
 const core_1 = require("@friggframework/core");
-const defaultConfig_json_1 = __importDefault(require("../defaultConfig.json"));
+const defaultConfig_json_1 = __importDefault(require("./defaultConfig.json"));
 const Definition = {
     API: api_1.Api,
     getName: () => defaultConfig_json_1.default.name,
     moduleName: defaultConfig_json_1.default.name,
-    modelName: 'Pipedrive',
+    modelName: "Pipedrive",
     requiredAuthMethods: {
         getToken: async (api, params) => {
-            const code = (0, core_1.get)(params.data, 'code', '');
+            const code = (0, core_1.get)(params, "code");
             if (!code) {
-                throw new Error('Authorization code is required');
+                throw new Error("Authorization code is required");
             }
             return api.getTokenFromCode(code);
         },
@@ -30,10 +30,11 @@ const Definition = {
                 return {
                     identifiers: {
                         externalId: String(userProfile.data.company_id),
-                        user: userId
+                        user: userId,
                     },
                     details: {
-                        name: userProfile.data.company_name || 'Unknown Company'
+                        name: userProfile.data.company_name || "Unknown Company",
+                        companyDomain: userProfile.data.company_domain,
                     },
                 };
             }
@@ -42,11 +43,7 @@ const Definition = {
             }
         },
         apiPropertiesToPersist: {
-            credential: [
-                'access_token',
-                'refresh_token',
-                'companyDomain'
-            ],
+            credential: ["access_token", "refresh_token", "companyDomain"],
             entity: [],
         },
         getCredentialDetails: async (api, userId) => {
@@ -58,9 +55,9 @@ const Definition = {
                 return {
                     identifiers: {
                         externalId: String(userProfile.data.id),
-                        user: userId
+                        user: userId,
                     },
-                    details: {}
+                    details: {},
                 };
             }
             catch (error) {
@@ -74,6 +71,6 @@ const Definition = {
         client_secret: process.env.PIPEDRIVE_CLIENT_SECRET,
         scope: process.env.PIPEDRIVE_SCOPE,
         redirect_uri: `${process.env.REDIRECT_URI}/pipedrive`,
-    }
+    },
 };
 exports.Definition = Definition;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@friggframework/api-module-pipedrive",
-  "version": "2.1.0-canary.56.2dc58f9.0",
+  "version": "2.1.0-canary.57.58a8b12.0",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -18,10 +18,11 @@
     "LICENSE.md"
   ],
   "dependencies": {
-    "@friggframework/core": "^2.0.0",
+    "@friggframework/core": "^2.0.0-next.16",
     "dotenv": "^16.0.0"
   },
   "devDependencies": {
+    "@friggframework/test": "^1.1.2",
     "@types/node": "^20.8.0",
     "typescript": "^5.4.0",
     "vitest": "^1.0.0"
@@ -29,5 +30,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "2dc58f950aad42005d2a4d536615fff6420f6a1d"
+  "gitHead": "58a8b126aff08f184443b28aaa361dd62032e820"
 }

package/defaultConfig.json

@@ -1,11 +0,0 @@
-{
-  "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"
-}