@friggframework/api-module-pipedrive 2.1.0-next.1 → 2.1.0-next.3

package/README.md

@@ -1,6 +1,5 @@
 # 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
+Read more on the [Frigg documentation site](https://docs.friggframework.org/api-modules/list/pipedrive

package/dist/api.d.ts

@@ -1,5 +1,5 @@
 import { OAuth2Requester } from "@friggframework/core";
-import { OAuth2RequesterOptions, ActivityParams, ListActivitiesParams, ListDealsParams, ListPersonsParams, GetPersonParams, ListOrganizationsParams, GetOrganizationParams, PipedriveResponse, PipedriveUser, PipedriveTokenResponse } from "./types";
+import { OAuth2RequesterOptions, ActivityParams, ListActivitiesParams, ListDealsParams, CreateDealParams, ListPersonsParams, GetPersonParams, SearchPersonsParams, SearchParams, CreateNoteParams, ListOrganizationsParams, GetOrganizationParams, PipedriveResponse, PipedriveUser, PipedriveTokenResponse, CreateWebhookParams, CreateCallLogParams, UpdateCallLogParams, ListCallLogsParams } from "./types";
 export declare class Api extends OAuth2Requester {
     companyDomain: string | null;
     URLs: {
@@ -11,8 +11,15 @@ export declare class Api extends OAuth2Requester {
         deals: string;
         persons: string;
         personById: (personId: string | number) => string;
+        personsSearch: string;
         organizations: string;
         organizationById: (orgId: string | number) => string;
+        notes: string;
+        webhooks: string;
+        webhookById: (webhookId: string | number) => string;
+        search: string;
+        callLogs: string;
+        callLogById: (callLogId: string) => string;
     };
     constructor(params: OAuth2RequesterOptions);
     /**
@@ -33,6 +40,19 @@ export declare class Api extends OAuth2Requester {
      * @returns Response with deal data array and pagination cursor
      */
     listDeals(params?: ListDealsParams): Promise<PipedriveResponse>;
+    /**
+     * Create a new deal
+     * @param params - Deal data
+     * @param params.title - Deal title (required)
+     * @param params.value - Deal value
+     * @param params.currency - Currency code
+     * @param params.person_id - Associated person ID
+     * @param params.org_id - Associated organization ID
+     * @param params.pipeline_id - Pipeline ID
+     * @param params.stage_id - Stage ID
+     * @returns Response with created deal data
+     */
+    createDeal(params: CreateDealParams): Promise<PipedriveResponse>;
     listActivityFields(): Promise<PipedriveResponse>;
     /**
      * List activities with v2 API support
@@ -58,6 +78,45 @@ export declare class Api extends OAuth2Requester {
      * @returns Response with person data
      */
     getPerson(personId: string | number, params?: GetPersonParams): Promise<PipedriveResponse>;
+    /**
+     * Search for persons
+     * @param params - Search parameters
+     * @param params.term - The search term (minimum 2 characters, or 1 if using exact_match)
+     * @param params.fields - Comma-separated fields to search in
+     * @param params.exact_match - When enabled, only full exact matches are returned
+     * @param params.organization_id - Filter persons by organization ID
+     * @param params.include_fields - Optional fields to include (e.g., "person.picture")
+     * @param params.limit - Number of entries to return (default 100, max 500)
+     * @param params.cursor - Pagination cursor
+     * @returns Response with search results including items with result_score and person data
+     */
+    searchPersons(params: SearchPersonsParams): Promise<PipedriveResponse>;
+    /**
+     * Search across all items (persons, organizations, deals, etc.)
+     * @param params - Search parameters
+     * @param params.term - The search term (minimum 2 characters)
+     * @param params.item_types - Comma-separated item types to search (e.g., 'person,organization,deal')
+     * @param params.exact_match - When enabled, only full exact matches are returned
+     * @param params.fields - Comma-separated fields to search in
+     * @param params.limit - Number of entries to return (default 10, max 100)
+     * @param params.start - Pagination start
+     * @returns Response with search results across multiple item types
+     */
+    search(params: SearchParams): Promise<PipedriveResponse>;
+    /**
+     * Create a new note
+     * @param params - Note data
+     * @param params.content - The content of the note in HTML format (required)
+     * @param params.lead_id - The ID of the lead (UUID format)
+     * @param params.deal_id - The ID of the deal
+     * @param params.person_id - The ID of the person
+     * @param params.org_id - The ID of the organization
+     * @param params.project_id - The ID of the project
+     * @param params.user_id - The ID of the user (author)
+     * @param params.add_time - Creation date & time in UTC (Format: YYYY-MM-DD HH:MM:SS)
+     * @returns Response with created note data
+     */
+    createNote(params: CreateNoteParams): Promise<PipedriveResponse>;
     /**
      * List organizations with v2 API support
      * @param params - Query parameters for filtering and pagination
@@ -71,4 +130,76 @@ export declare class Api extends OAuth2Requester {
      * @returns Response with organization data
      */
     getOrganization(orgId: string | number, params?: GetOrganizationParams): Promise<PipedriveResponse>;
+    /**
+     * List all webhooks for the company
+     * @returns Response with array of webhook configurations
+     */
+    listWebhooks(): Promise<PipedriveResponse>;
+    /**
+     * Create a new webhook subscription
+     * @param params - Webhook configuration
+     * @param params.subscription_url - Public HTTPS URL to receive webhooks
+     * @param params.event_action - Event action: added, updated, deleted, merged, *
+     * @param params.event_object - Event object: person, organization, deal, activity, product, *
+     * @param params.name - Human-readable name for the webhook
+     * @param params.user_id - Optional: User ID to authorize webhook with
+     * @param params.http_auth_user - Optional: HTTP basic auth username
+     * @param params.http_auth_password - Optional: HTTP basic auth password
+     * @param params.version - Optional: Webhook version (1.0 or 2.0, default: 2.0)
+     * @returns Response with created webhook data
+     */
+    createWebhook(params: CreateWebhookParams): Promise<PipedriveResponse>;
+    /**
+     * Delete a webhook by ID
+     * @param webhookId - The ID of the webhook to delete
+     * @returns Response confirming deletion
+     */
+    deleteWebhook(webhookId: string | number): Promise<PipedriveResponse>;
+    /**
+     * List all call logs
+     * @param params - Pagination parameters
+     * @param params.start - Pagination start position (default: 0)
+     * @param params.limit - Max entries per page (max: 50)
+     * @returns Response with call log data array
+     */
+    listCallLogs(params?: ListCallLogsParams): Promise<PipedriveResponse>;
+    /**
+     * Get a single call log by ID
+     * @param callLogId - The ID of the call log to retrieve
+     * @returns Response with call log data
+     */
+    getCallLog(callLogId: string): Promise<PipedriveResponse>;
+    /**
+     * Create a new call log
+     * @param params - Call log data
+     * @param params.to_phone_number - The number called (required)
+     * @param params.outcome - Call result: connected, no_answer, left_message, left_voicemail, wrong_number, busy (required)
+     * @param params.start_time - Call start in UTC YYYY-MM-DD HH:MM:SS (required)
+     * @param params.end_time - Call end in UTC YYYY-MM-DD HH:MM:SS (required)
+     * @param params.person_id - Associated person ID
+     * @param params.org_id - Associated organization ID
+     * @param params.deal_id - Associated deal ID
+     * @param params.subject - Activity name/subject
+     * @param params.duration - Duration in seconds
+     * @param params.from_phone_number - Caller's number
+     * @param params.note - Notes in HTML format
+     * @returns Response with created call log data
+     */
+    createCallLog(params: CreateCallLogParams): Promise<PipedriveResponse>;
+    /**
+     * Update an existing call log
+     * @param callLogId - The ID of the call log to update
+     * @param params - Fields to update
+     * @param params.outcome - Call result
+     * @param params.subject - Activity name/subject
+     * @param params.note - Notes in HTML format
+     * @returns Response with updated call log data
+     */
+    updateCallLog(callLogId: string, params: UpdateCallLogParams): Promise<PipedriveResponse>;
+    /**
+     * Delete a call log by ID
+     * @param callLogId - The ID of the call log to delete
+     * @returns Response confirming deletion
+     */
+    deleteCallLog(callLogId: string): Promise<PipedriveResponse>;
 }

package/dist/api.js

@@ -16,8 +16,15 @@ class Api extends core_1.OAuth2Requester {
             deals: "/v2/deals",
             persons: "/v2/persons",
             personById: (personId) => `/v2/persons/${personId}`,
+            personsSearch: "/v2/persons/search",
             organizations: "/v2/organizations",
             organizationById: (orgId) => `/v2/organizations/${orgId}`,
+            notes: "/v1/notes",
+            webhooks: "/v1/webhooks",
+            webhookById: (webhookId) => `/v1/webhooks/${webhookId}`,
+            search: "/v1/search",
+            callLogs: "/v1/callLogs",
+            callLogById: (callLogId) => `/v1/callLogs/${callLogId}`,
         };
         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";
@@ -66,6 +73,28 @@ class Api extends core_1.OAuth2Requester {
         }
         return this._get(options);
     }
+    /**
+     * Create a new deal
+     * @param params - Deal data
+     * @param params.title - Deal title (required)
+     * @param params.value - Deal value
+     * @param params.currency - Currency code
+     * @param params.person_id - Associated person ID
+     * @param params.org_id - Associated organization ID
+     * @param params.pipeline_id - Pipeline ID
+     * @param params.stage_id - Stage ID
+     * @returns Response with created deal data
+     */
+    async createDeal(params) {
+        const options = {
+            url: this.baseUrl + this.URLs.deals,
+            body: params,
+            headers: {
+                "Content-Type": "application/json",
+            },
+        };
+        return this._post(options);
+    }
     // **************************   Activities   **********************************
     async listActivityFields() {
         const options = {
@@ -156,6 +185,67 @@ class Api extends core_1.OAuth2Requester {
         }
         return this._get(options);
     }
+    /**
+     * Search for persons
+     * @param params - Search parameters
+     * @param params.term - The search term (minimum 2 characters, or 1 if using exact_match)
+     * @param params.fields - Comma-separated fields to search in
+     * @param params.exact_match - When enabled, only full exact matches are returned
+     * @param params.organization_id - Filter persons by organization ID
+     * @param params.include_fields - Optional fields to include (e.g., "person.picture")
+     * @param params.limit - Number of entries to return (default 100, max 500)
+     * @param params.cursor - Pagination cursor
+     * @returns Response with search results including items with result_score and person data
+     */
+    async searchPersons(params) {
+        const options = {
+            url: this.baseUrl + this.URLs.personsSearch,
+            query: params,
+        };
+        return this._get(options);
+    }
+    /**
+     * Search across all items (persons, organizations, deals, etc.)
+     * @param params - Search parameters
+     * @param params.term - The search term (minimum 2 characters)
+     * @param params.item_types - Comma-separated item types to search (e.g., 'person,organization,deal')
+     * @param params.exact_match - When enabled, only full exact matches are returned
+     * @param params.fields - Comma-separated fields to search in
+     * @param params.limit - Number of entries to return (default 10, max 100)
+     * @param params.start - Pagination start
+     * @returns Response with search results across multiple item types
+     */
+    async search(params) {
+        const options = {
+            url: this.baseUrl + this.URLs.search,
+            query: params,
+        };
+        return this._get(options);
+    }
+    // **************************   Notes   **********************************
+    /**
+     * Create a new note
+     * @param params - Note data
+     * @param params.content - The content of the note in HTML format (required)
+     * @param params.lead_id - The ID of the lead (UUID format)
+     * @param params.deal_id - The ID of the deal
+     * @param params.person_id - The ID of the person
+     * @param params.org_id - The ID of the organization
+     * @param params.project_id - The ID of the project
+     * @param params.user_id - The ID of the user (author)
+     * @param params.add_time - Creation date & time in UTC (Format: YYYY-MM-DD HH:MM:SS)
+     * @returns Response with created note data
+     */
+    async createNote(params) {
+        const options = {
+            url: this.baseUrl + this.URLs.notes,
+            body: params,
+            headers: {
+                "Content-Type": "application/json",
+            },
+        };
+        return this._post(options);
+    }
     // **************************   Organizations   **********************************
     /**
      * List organizations with v2 API support
@@ -186,5 +276,134 @@ class Api extends core_1.OAuth2Requester {
         }
         return this._get(options);
     }
+    // **************************   Webhooks   **********************************
+    /**
+     * List all webhooks for the company
+     * @returns Response with array of webhook configurations
+     */
+    async listWebhooks() {
+        const options = {
+            url: this.baseUrl + this.URLs.webhooks,
+        };
+        return this._get(options);
+    }
+    /**
+     * Create a new webhook subscription
+     * @param params - Webhook configuration
+     * @param params.subscription_url - Public HTTPS URL to receive webhooks
+     * @param params.event_action - Event action: added, updated, deleted, merged, *
+     * @param params.event_object - Event object: person, organization, deal, activity, product, *
+     * @param params.name - Human-readable name for the webhook
+     * @param params.user_id - Optional: User ID to authorize webhook with
+     * @param params.http_auth_user - Optional: HTTP basic auth username
+     * @param params.http_auth_password - Optional: HTTP basic auth password
+     * @param params.version - Optional: Webhook version (1.0 or 2.0, default: 2.0)
+     * @returns Response with created webhook data
+     */
+    async createWebhook(params) {
+        const options = {
+            url: this.baseUrl + this.URLs.webhooks,
+            body: params,
+            headers: {
+                "Content-Type": "application/json",
+            },
+        };
+        return this._post(options);
+    }
+    /**
+     * Delete a webhook by ID
+     * @param webhookId - The ID of the webhook to delete
+     * @returns Response confirming deletion
+     */
+    async deleteWebhook(webhookId) {
+        const options = {
+            url: this.baseUrl + this.URLs.webhookById(webhookId),
+        };
+        return this._delete(options);
+    }
+    // **************************   Call Logs   **********************************
+    /**
+     * List all call logs
+     * @param params - Pagination parameters
+     * @param params.start - Pagination start position (default: 0)
+     * @param params.limit - Max entries per page (max: 50)
+     * @returns Response with call log data array
+     */
+    async listCallLogs(params) {
+        const options = {
+            url: this.baseUrl + this.URLs.callLogs,
+        };
+        if (params && Object.keys(params).length > 0) {
+            options.query = params;
+        }
+        return this._get(options);
+    }
+    /**
+     * Get a single call log by ID
+     * @param callLogId - The ID of the call log to retrieve
+     * @returns Response with call log data
+     */
+    async getCallLog(callLogId) {
+        const options = {
+            url: this.baseUrl + this.URLs.callLogById(callLogId),
+        };
+        return this._get(options);
+    }
+    /**
+     * Create a new call log
+     * @param params - Call log data
+     * @param params.to_phone_number - The number called (required)
+     * @param params.outcome - Call result: connected, no_answer, left_message, left_voicemail, wrong_number, busy (required)
+     * @param params.start_time - Call start in UTC YYYY-MM-DD HH:MM:SS (required)
+     * @param params.end_time - Call end in UTC YYYY-MM-DD HH:MM:SS (required)
+     * @param params.person_id - Associated person ID
+     * @param params.org_id - Associated organization ID
+     * @param params.deal_id - Associated deal ID
+     * @param params.subject - Activity name/subject
+     * @param params.duration - Duration in seconds
+     * @param params.from_phone_number - Caller's number
+     * @param params.note - Notes in HTML format
+     * @returns Response with created call log data
+     */
+    async createCallLog(params) {
+        const options = {
+            url: this.baseUrl + this.URLs.callLogs,
+            body: params,
+            headers: {
+                "Content-Type": "application/json",
+            },
+        };
+        return this._post(options);
+    }
+    /**
+     * Update an existing call log
+     * @param callLogId - The ID of the call log to update
+     * @param params - Fields to update
+     * @param params.outcome - Call result
+     * @param params.subject - Activity name/subject
+     * @param params.note - Notes in HTML format
+     * @returns Response with updated call log data
+     */
+    async updateCallLog(callLogId, params) {
+        const options = {
+            url: this.baseUrl + this.URLs.callLogById(callLogId),
+            body: params,
+            headers: {
+                "Content-Type": "application/json",
+            },
+        };
+        return this._patch(options);
+    }
+    /**
+     * Delete a call log by ID
+     * @param callLogId - The ID of the call log to delete
+     * @returns Response confirming deletion
+     */
+    async deleteCallLog(callLogId) {
+        const options = {
+            url: this.baseUrl + this.URLs.callLogById(callLogId),
+        };
+        return this._delete(options);
+    }
 }
 exports.Api = Api;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@friggframework/api-module-pipedrive",
-  "version": "2.1.0-next.1",
+  "version": "2.1.0-next.3",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -30,5 +30,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5b22500d5eb6b9032389753acad2279ddd70a8dd"
+  "gitHead": "fd8e7d7ad197886b7bd94a68fd26c179358f4b67"
 }