@iamsamuelfraga/mcp-pipedrive 1.0.3

package/dist/tools/deals/index.d.ts

@@ -0,0 +1,1096 @@
+import type { PipedriveClient } from '../../pipedrive-client.js';
+/**
+ * Get all deal-related tools for the MCP server
+ *
+ * This function aggregates all 37 deal tools into a single object:
+ * - List operations: list, list_all_auto, list_archived
+ * - CRUD operations: create, get, update, delete, duplicate
+ * - Search operations: search
+ * - Stage operations: move_to_stage
+ * - Analytics: get_summary, get_archived_summary, get_deals_timeline, get_archived_deals_timeline
+ * - Followers: add_follower, remove_follower, list_followers
+ * - Participants: add_participant, remove_participant, list_participants
+ * - Products: add_product, update_product, remove_product, list_products
+ * - Files: attach_file, list_files
+ * - Activities: list_activities
+ * - Updates: list_field_updates, list_updates, list_participant_updates
+ * - Mail: list_mail_messages
+ * - Merge: merge
+ * - Permissions: list_permitted_users
+ * - Persons: list_persons
+ * - Status: mark_as_won, mark_as_lost
+ * - Bulk: bulk_delete
+ *
+ * @param client - The PipedriveClient instance to use for API calls
+ * @returns Object containing all deal tools with their configurations
+ */
+export declare function getDealTools(client: PipedriveClient): {
+    'deals/bulk_delete': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                ids: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                    description: string;
+                    minItems: number;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/mark_as_won': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                id: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/mark_as_lost': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                id: {
+                    type: string;
+                    description: string;
+                };
+                lost_reason: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/list_persons': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                id: {
+                    type: string;
+                    description: string;
+                };
+                start: {
+                    type: string;
+                    description: string;
+                    default: number;
+                };
+                limit: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/list_permitted_users': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                id: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/merge': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                id: {
+                    type: string;
+                    description: string;
+                };
+                merge_with_id: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/list_mail_messages': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                id: {
+                    type: string;
+                    description: string;
+                };
+                start: {
+                    type: string;
+                    description: string;
+                    default: number;
+                };
+                limit: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/list_field_updates': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                id: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/list_updates': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                id: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/list_participant_updates': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                id: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/list_activities': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                id: {
+                    type: string;
+                    description: string;
+                };
+                start: {
+                    type: string;
+                    description: string;
+                    default: number;
+                };
+                limit: {
+                    type: string;
+                    description: string;
+                };
+                done: {
+                    type: string;
+                    enum: string[];
+                    description: string;
+                };
+                exclude: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/get_deals_timeline': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                start_date: {
+                    type: string;
+                    description: string;
+                };
+                interval: {
+                    type: string;
+                    enum: string[];
+                    description: string;
+                };
+                amount: {
+                    type: string;
+                    description: string;
+                };
+                field_key: {
+                    type: string;
+                    description: string;
+                };
+                user_id: {
+                    type: string;
+                    description: string;
+                };
+                pipeline_id: {
+                    type: string;
+                    description: string;
+                };
+                filter_id: {
+                    type: string;
+                    description: string;
+                };
+                exclude_deals: {
+                    type: string;
+                    enum: number[];
+                    description: string;
+                };
+                totals_convert_currency: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/get_archived_deals_timeline': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                start_date: {
+                    type: string;
+                    description: string;
+                };
+                interval: {
+                    type: string;
+                    enum: string[];
+                    description: string;
+                };
+                amount: {
+                    type: string;
+                    description: string;
+                };
+                field_key: {
+                    type: string;
+                    description: string;
+                };
+                user_id: {
+                    type: string;
+                    description: string;
+                };
+                pipeline_id: {
+                    type: string;
+                    description: string;
+                };
+                filter_id: {
+                    type: string;
+                    description: string;
+                };
+                exclude_deals: {
+                    type: string;
+                    enum: number[];
+                    description: string;
+                };
+                totals_convert_currency: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/attach_file': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                id: {
+                    type: string;
+                    description: string;
+                };
+                file_path: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/list_files': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                id: {
+                    type: string;
+                    description: string;
+                };
+                start: {
+                    type: string;
+                    description: string;
+                    default: number;
+                };
+                limit: {
+                    type: string;
+                    description: string;
+                    default: number;
+                };
+                sort: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/add_product': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                id: {
+                    type: string;
+                    description: string;
+                };
+                product_id: {
+                    type: string;
+                    description: string;
+                };
+                item_price: {
+                    type: string;
+                    description: string;
+                };
+                quantity: {
+                    type: string;
+                    description: string;
+                };
+                discount_percentage: {
+                    type: string;
+                    description: string;
+                };
+                duration: {
+                    type: string;
+                    description: string;
+                };
+                product_variation_id: {
+                    type: string;
+                    description: string;
+                };
+                comments: {
+                    type: string;
+                    description: string;
+                };
+                enabled_flag: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/update_product': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                id: {
+                    type: string;
+                    description: string;
+                };
+                product_attachment_id: {
+                    type: string;
+                    description: string;
+                };
+                item_price: {
+                    type: string;
+                    description: string;
+                };
+                quantity: {
+                    type: string;
+                    description: string;
+                };
+                discount_percentage: {
+                    type: string;
+                    description: string;
+                };
+                duration: {
+                    type: string;
+                    description: string;
+                };
+                comments: {
+                    type: string;
+                    description: string;
+                };
+                enabled_flag: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/remove_product': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                id: {
+                    type: string;
+                    description: string;
+                };
+                product_attachment_id: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/list_products': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                id: {
+                    type: string;
+                    description: string;
+                };
+                start: {
+                    type: string;
+                    description: string;
+                    default: number;
+                };
+                limit: {
+                    type: string;
+                    description: string;
+                    default: number;
+                };
+                include_product_data: {
+                    type: string;
+                    enum: number[];
+                    description: string;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/add_participant': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                id: {
+                    type: string;
+                    description: string;
+                };
+                person_id: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/remove_participant': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                id: {
+                    type: string;
+                    description: string;
+                };
+                deal_participant_id: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/list_participants': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                id: {
+                    type: string;
+                    description: string;
+                };
+                start: {
+                    type: string;
+                    description: string;
+                    default: number;
+                };
+                limit: {
+                    type: string;
+                    description: string;
+                    default: number;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/add_follower': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                id: {
+                    type: string;
+                    description: string;
+                };
+                user_id: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/remove_follower': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                id: {
+                    type: string;
+                    description: string;
+                };
+                follower_id: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/list_followers': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                id: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/get_summary': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                status: {
+                    type: string;
+                    enum: string[];
+                    description: string;
+                };
+                filter_id: {
+                    type: string;
+                    description: string;
+                };
+                user_id: {
+                    type: string;
+                    description: string;
+                };
+                stage_id: {
+                    type: string;
+                    description: string;
+                };
+            };
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/get_archived_summary': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                status: {
+                    type: string;
+                    enum: string[];
+                    description: string;
+                };
+                filter_id: {
+                    type: string;
+                    description: string;
+                };
+                user_id: {
+                    type: string;
+                    description: string;
+                };
+                stage_id: {
+                    type: string;
+                    description: string;
+                };
+            };
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/search': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                term: {
+                    type: string;
+                    description: string;
+                };
+                fields: {
+                    type: string;
+                    enum: string[];
+                    description: string;
+                };
+                exact_match: {
+                    type: string;
+                    description: string;
+                };
+                person_id: {
+                    type: string;
+                    description: string;
+                };
+                org_id: {
+                    type: string;
+                    description: string;
+                };
+                status: {
+                    type: string;
+                    enum: string[];
+                    description: string;
+                };
+                include_fields: {
+                    type: string;
+                    description: string;
+                };
+                start: {
+                    type: string;
+                    description: string;
+                    default: number;
+                };
+                limit: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/duplicate': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                id: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/delete': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                id: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/update': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                id: {
+                    type: string;
+                    description: string;
+                };
+                title: {
+                    type: string;
+                    description: string;
+                };
+                value: {
+                    type: string;
+                    description: string;
+                };
+                currency: {
+                    type: string;
+                    description: string;
+                };
+                user_id: {
+                    type: string;
+                    description: string;
+                };
+                person_id: {
+                    type: string;
+                    description: string;
+                };
+                org_id: {
+                    type: string;
+                    description: string;
+                };
+                pipeline_id: {
+                    type: string;
+                    description: string;
+                };
+                stage_id: {
+                    type: string;
+                    description: string;
+                };
+                status: {
+                    type: string;
+                    enum: string[];
+                    description: string;
+                };
+                expected_close_date: {
+                    type: string;
+                    description: string;
+                };
+                probability: {
+                    type: string;
+                    description: string;
+                };
+                lost_reason: {
+                    type: string;
+                    description: string;
+                };
+                visible_to: {
+                    type: string;
+                    enum: string[];
+                    description: string;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/move_to_stage': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                id: {
+                    type: string;
+                    description: string;
+                };
+                stage_id: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/get': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                id: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/create': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                title: {
+                    type: string;
+                    description: string;
+                };
+                value: {
+                    type: string;
+                    description: string;
+                };
+                currency: {
+                    type: string;
+                    description: string;
+                };
+                user_id: {
+                    type: string;
+                    description: string;
+                };
+                person_id: {
+                    type: string;
+                    description: string;
+                };
+                org_id: {
+                    type: string;
+                    description: string;
+                };
+                pipeline_id: {
+                    type: string;
+                    description: string;
+                };
+                stage_id: {
+                    type: string;
+                    description: string;
+                };
+                status: {
+                    type: string;
+                    enum: string[];
+                    description: string;
+                };
+                expected_close_date: {
+                    type: string;
+                    description: string;
+                };
+                probability: {
+                    type: string;
+                    description: string;
+                };
+                lost_reason: {
+                    type: string;
+                    description: string;
+                };
+                visible_to: {
+                    type: string;
+                    enum: string[];
+                    description: string;
+                };
+                add_time: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/list': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                status: {
+                    type: string;
+                    enum: string[];
+                    description: string;
+                };
+                stage_id: {
+                    type: string;
+                    description: string;
+                };
+                user_id: {
+                    type: string;
+                    description: string;
+                };
+                person_id: {
+                    type: string;
+                    description: string;
+                };
+                org_id: {
+                    type: string;
+                    description: string;
+                };
+                pipeline_id: {
+                    type: string;
+                    description: string;
+                };
+                filter_id: {
+                    type: string;
+                    description: string;
+                };
+                sort: {
+                    type: string;
+                    description: string;
+                };
+                sort_by: {
+                    type: string;
+                    enum: string[];
+                    description: string;
+                };
+                owned_by_you: {
+                    type: string;
+                    enum: number[];
+                    description: string;
+                };
+                start: {
+                    type: string;
+                    description: string;
+                    default: number;
+                };
+                limit: {
+                    type: string;
+                    description: string;
+                    default: number;
+                };
+            };
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+    'deals/list_all_auto': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                status: {
+                    type: string;
+                    enum: string[];
+                    description: string;
+                };
+                stage_id: {
+                    type: string;
+                    description: string;
+                };
+                user_id: {
+                    type: string;
+                    description: string;
+                };
+                person_id: {
+                    type: string;
+                    description: string;
+                };
+                org_id: {
+                    type: string;
+                    description: string;
+                };
+                pipeline_id: {
+                    type: string;
+                    description: string;
+                };
+                filter_id: {
+                    type: string;
+                    description: string;
+                };
+                sort: {
+                    type: string;
+                    description: string;
+                };
+                sort_by: {
+                    type: string;
+                    enum: string[];
+                    description: string;
+                };
+                owned_by_you: {
+                    type: string;
+                    enum: number[];
+                    description: string;
+                };
+                max_items: {
+                    type: string;
+                    description: string;
+                };
+            };
+        };
+        handler: (args: unknown) => Promise<{
+            success: boolean;
+            data: unknown[];
+            additional_data: {
+                total_count: number;
+            };
+        }>;
+    };
+    'deals/list_archived': {
+        description: string;
+        inputSchema: {
+            type: "object";
+            properties: {
+                status: {
+                    type: string;
+                    enum: string[];
+                    description: string;
+                };
+                stage_id: {
+                    type: string;
+                    description: string;
+                };
+                user_id: {
+                    type: string;
+                    description: string;
+                };
+                person_id: {
+                    type: string;
+                    description: string;
+                };
+                org_id: {
+                    type: string;
+                    description: string;
+                };
+                pipeline_id: {
+                    type: string;
+                    description: string;
+                };
+                filter_id: {
+                    type: string;
+                    description: string;
+                };
+                sort: {
+                    type: string;
+                    description: string;
+                };
+                owned_by_you: {
+                    type: string;
+                    enum: number[];
+                    description: string;
+                };
+                start: {
+                    type: string;
+                    description: string;
+                    default: number;
+                };
+                limit: {
+                    type: string;
+                    description: string;
+                    default: number;
+                };
+            };
+        };
+        handler: (args: unknown) => Promise<unknown>;
+    };
+};
+//# sourceMappingURL=index.d.ts.map