patchwork-os 0.2.0-beta.1 → 0.2.0-beta.10.canary.100

package/dist/connectors/pipedrive.d.ts

@@ -0,0 +1,189 @@
+/**
+ * Pipedrive connector — read/write Pipedrive CRM via the Pipedrive REST API v1.
+ *
+ * Auth: API token (query param `api_token`).
+ *   - Env var: PIPEDRIVE_API_TOKEN
+ *   - Stored: getSecretJsonSync("pipedrive") → PipedriveTokens
+ *
+ * Base URL: https://{companyDomain}.pipedrive.com/api/v1
+ *
+ * Tools: getDeals, getDeal, createDeal, updateDeal, deleteDeal,
+ *        getPersons, getPerson, createPerson,
+ *        getOrganizations, createActivity,
+ *        getPipelines, getStages
+ *
+ * Extends BaseConnector for unified auth, retry, rate-limit, error handling.
+ */
+import { type AuthContext, BaseConnector, type ConnectorError, type ConnectorStatus } from "./baseConnector.js";
+export interface PipedriveTokens {
+    apiToken: string;
+    companyDomain: string;
+    connected_at: string;
+}
+export interface PipedriveDeal {
+    id: number;
+    title: string;
+    value: number | null;
+    currency: string;
+    status: "open" | "won" | "lost" | "deleted";
+    stage_id: number | null;
+    person_id: {
+        value: number;
+        name: string;
+    } | null;
+    org_id: {
+        value: number;
+        name: string;
+    } | null;
+    expected_close_date: string | null;
+    add_time: string;
+    update_time: string;
+}
+export interface PipedrivePerson {
+    id: number;
+    name: string;
+    email: {
+        value: string;
+        primary: boolean;
+    }[];
+    phone: {
+        value: string;
+        primary: boolean;
+    }[];
+    org_id: {
+        value: number;
+        name: string;
+    } | null;
+    add_time: string;
+}
+export interface PipedriveOrganization {
+    id: number;
+    name: string;
+    address: string | null;
+    people_count: number;
+    add_time: string;
+}
+export interface PipedriveActivity {
+    id: number;
+    subject: string;
+    type: string;
+    due_date: string | null;
+    due_time: string | null;
+    deal_id: number | null;
+    person_id: number | null;
+    note: string | null;
+    done: boolean;
+    add_time: string;
+}
+export interface PipedrivePipeline {
+    id: number;
+    name: string;
+    order_nr: number;
+    active: boolean;
+    add_time: string;
+    update_time: string;
+}
+export interface PipedriveStage {
+    id: number;
+    name: string;
+    pipeline_id: number;
+    order_nr: number;
+    active_flag: boolean;
+    add_time: string;
+    update_time: string;
+}
+export declare class PipedriveConnector extends BaseConnector {
+    readonly providerName = "pipedrive";
+    protected getOAuthConfig(): null;
+    private baseUrl;
+    authenticate(): Promise<AuthContext>;
+    healthCheck(): Promise<{
+        ok: boolean;
+        error?: ConnectorError;
+    }>;
+    normalizeError(error: unknown): ConnectorError;
+    getStatus(): ConnectorStatus;
+    getDeals(params?: {
+        status?: "open" | "won" | "lost" | "deleted" | "all_not_deleted";
+        start?: number;
+        limit?: number;
+    }): Promise<PipedriveDeal[]>;
+    getDeal(id: number): Promise<PipedriveDeal | null>;
+    createDeal(params: {
+        title: string;
+        value?: number;
+        currency?: string;
+        stageId?: number;
+        personId?: number;
+        orgId?: number;
+        status?: "open" | "won" | "lost";
+        expectedCloseDate?: string;
+    }): Promise<PipedriveDeal>;
+    updateDeal(id: number, fields: Partial<{
+        title: string;
+        value: number;
+        currency: string;
+        stage_id: number;
+        person_id: number;
+        org_id: number;
+        status: "open" | "won" | "lost";
+        expected_close_date: string;
+    }>): Promise<PipedriveDeal>;
+    deleteDeal(id: number): Promise<void>;
+    getPersons(params?: {
+        start?: number;
+        limit?: number;
+    }): Promise<PipedrivePerson[]>;
+    getPerson(id: number): Promise<PipedrivePerson | null>;
+    createPerson(params: {
+        name: string;
+        email?: string;
+        phone?: string;
+        orgId?: number;
+    }): Promise<PipedrivePerson>;
+    getOrganizations(params?: {
+        start?: number;
+        limit?: number;
+    }): Promise<PipedriveOrganization[]>;
+    createActivity(params: {
+        subject: string;
+        type: string;
+        dueDate?: string;
+        dueTime?: string;
+        dealId?: number;
+        personId?: number;
+        note?: string;
+    }): Promise<PipedriveActivity>;
+    getPipelines(): Promise<PipedrivePipeline[]>;
+    getStages(pipelineId?: number): Promise<PipedriveStage[]>;
+    private buildUrl;
+    private buildHeaders;
+}
+/**
+ * Verify a Pipedrive v2 webhook signature.
+ * Pipedrive sends HMAC-SHA256 of the raw body signed with your client secret,
+ * delivered in the `x-pipedrive-signature` header.
+ */
+export declare function verifyPipedriveWebhook(rawBody: string | Buffer, signatureHeader: string, clientSecret: string): boolean;
+export declare function loadTokens(): PipedriveTokens | null;
+export declare function saveTokens(tokens: PipedriveTokens): void;
+export declare function clearTokens(): void;
+export declare function getPipedriveConnector(): PipedriveConnector;
+export { getPipedriveConnector as pipedrive };
+export interface ConnectorHandlerResult {
+    status: number;
+    body: string;
+    contentType?: string;
+}
+/**
+ * POST /connections/pipedrive/connect  { apiToken, companyDomain }
+ */
+export declare function handlePipedriveConnect(body: string): Promise<ConnectorHandlerResult>;
+/**
+ * POST /connections/pipedrive/test
+ */
+export declare function handlePipedriveTest(): Promise<ConnectorHandlerResult>;
+/**
+ * DELETE /connections/pipedrive
+ */
+export declare function handlePipedriveDisconnect(): ConnectorHandlerResult;