@friggframework/api-module-pipedrive 2.1.0-next.0 → 2.1.0-next.2

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 { OAuth2RequesterOptions, ActivityParams, ListActivitiesParams, ListDealsParams, CreateDealParams, ListPersonsParams, GetPersonParams, SearchPersonsParams, SearchParams, CreateNoteParams, ListOrganizationsParams, GetOrganizationParams, PipedriveResponse, PipedriveUser, PipedriveTokenResponse, CreateWebhookParams } from "./types";
 export declare class Api extends OAuth2Requester {
     companyDomain: string | null;
     URLs: {
@@ -11,6 +11,13 @@ 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;
     };
     constructor(params: OAuth2RequesterOptions);
     /**
@@ -31,6 +38,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
@@ -56,4 +76,81 @@ 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
+     * @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>;
+    /**
+     * 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>;
 }

package/dist/api.js

@@ -16,6 +16,13 @@ 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",
         };
         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";
@@ -64,6 +71,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 = {
@@ -154,5 +183,141 @@ 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
+     * @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);
+    }
+    // **************************   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);
+    }
 }
 exports.Api = Api;

package/package.json

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