Files
wehub-resource-sync d25d482dc2
Publish CLI Package / publish-npm (push) Waiting to run
Publish Python SDK / publish-pypi (push) Waiting to run
Publish TypeScript SDK / publish-npm (push) Waiting to run
CI / Migrate Dev DB (push) Has been skipped
CI / Detect Version (push) Has been cancelled
CI / Migrate DB (push) Has been cancelled
CI / Build Dev ECR (./docker/app.Dockerfile, ECR_APP) (push) Has been cancelled
CI / Build Dev ECR (./docker/db.Dockerfile, ECR_MIGRATIONS) (push) Has been cancelled
CI / Build Dev ECR (./docker/pii.Dockerfile, ECR_PII) (push) Has been cancelled
CI / Build Dev ECR (./docker/realtime.Dockerfile, ECR_REALTIME) (push) Has been cancelled
CI / Deploy Trigger.dev (Dev) (push) Has been cancelled
CI / Build AMD64 (./docker/app.Dockerfile, ECR_APP, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build AMD64 (./docker/db.Dockerfile, ECR_MIGRATIONS, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build AMD64 (./docker/pii.Dockerfile, ECR_PII, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build AMD64 (./docker/realtime.Dockerfile, ECR_REALTIME, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/app.Dockerfile, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/db.Dockerfile, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/pii.Dockerfile, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/realtime.Dockerfile, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Check Docs Changes (push) Has been cancelled
CI / Process Docs (push) Has been cancelled
CI / Create GitHub Release (push) Has been cancelled
CI / Test and Build (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:20:55 +08:00

181 lines
5.5 KiB
TypeScript

import { createLogger } from '@sim/logger'
import type { PipedriveGetLeadsParams, PipedriveGetLeadsResponse } from '@/tools/pipedrive/types'
import { PIPEDRIVE_LEAD_OUTPUT_PROPERTIES } from '@/tools/pipedrive/types'
import type { ToolConfig } from '@/tools/types'
const logger = createLogger('PipedriveGetLeads')
export const pipedriveGetLeadsTool: ToolConfig<PipedriveGetLeadsParams, PipedriveGetLeadsResponse> =
{
id: 'pipedrive_get_leads',
name: 'Get Leads from Pipedrive',
description: 'Retrieve all leads or a specific lead from Pipedrive',
version: '1.0.0',
oauth: {
required: true,
provider: 'pipedrive',
},
params: {
accessToken: {
type: 'string',
required: true,
visibility: 'hidden',
description: 'The access token for the Pipedrive API',
},
lead_id: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Optional: ID of a specific lead to retrieve (e.g., "abc123-def456-ghi789")',
},
archived: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Get archived leads instead of active ones (e.g., "true" or "false")',
},
owner_id: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Filter by owner user ID (e.g., "123")',
},
person_id: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Filter by person ID (e.g., "456")',
},
organization_id: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Filter by organization ID (e.g., "789")',
},
limit: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Number of results to return (e.g., "50", default: 100, max: 500)',
},
start: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Pagination start offset (0-based index of the first item to return)',
},
},
request: {
url: (params) => {
// If lead_id is provided, get specific lead
if (params.lead_id) {
return `https://api.pipedrive.com/v1/leads/${params.lead_id}`
}
// Get archived or active leads with optional filters
const baseUrl =
params.archived === 'true'
? 'https://api.pipedrive.com/v1/leads/archived'
: 'https://api.pipedrive.com/v1/leads'
const queryParams = new URLSearchParams()
if (params.owner_id) queryParams.append('owner_id', params.owner_id)
if (params.person_id) queryParams.append('person_id', params.person_id)
if (params.organization_id) queryParams.append('organization_id', params.organization_id)
if (params.limit) queryParams.append('limit', params.limit)
if (params.start) queryParams.append('start', params.start)
const queryString = queryParams.toString()
return queryString ? `${baseUrl}?${queryString}` : baseUrl
},
method: 'GET',
headers: (params) => {
if (!params.accessToken) {
throw new Error('Access token is required')
}
return {
Authorization: `Bearer ${params.accessToken}`,
Accept: 'application/json',
}
},
},
transformResponse: async (response: Response, params) => {
const data = await response.json()
if (!data.success) {
logger.error('Pipedrive API request failed', { data })
throw new Error(data.error || 'Failed to fetch lead(s) from Pipedrive')
}
// If lead_id was provided, return single lead
if (params?.lead_id) {
return {
success: true,
output: {
lead: data.data ?? null,
success: true,
},
}
}
// Otherwise, return list of leads
const leads = data.data || []
// Leads endpoint puts pagination fields directly on additional_data (no .pagination wrapper)
const hasMore = data.additional_data?.more_items_in_collection || false
const currentStart = data.additional_data?.start ?? 0
const currentLimit = data.additional_data?.limit ?? leads.length
const nextStart = hasMore ? currentStart + currentLimit : null
return {
success: true,
output: {
leads,
total_items: leads.length,
has_more: hasMore,
next_start: nextStart,
success: true,
},
}
},
outputs: {
leads: {
type: 'array',
description: 'Array of lead objects (when listing all)',
optional: true,
items: {
type: 'object',
properties: PIPEDRIVE_LEAD_OUTPUT_PROPERTIES,
},
},
lead: {
type: 'object',
description: 'Single lead object (when lead_id is provided)',
optional: true,
properties: PIPEDRIVE_LEAD_OUTPUT_PROPERTIES,
},
total_items: {
type: 'number',
description: 'Total number of leads returned',
optional: true,
},
has_more: {
type: 'boolean',
description: 'Whether more leads are available',
optional: true,
},
next_start: {
type: 'number',
description: 'Offset for fetching the next page',
optional: true,
},
success: { type: 'boolean', description: 'Operation success status' },
},
}