Files
simstudioai--sim/apps/sim/tools/apollo/account_bulk_update.ts
T
wehub-resource-sync d25d482dc2
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
Publish CLI Package / publish-npm (push) Has been cancelled
Publish Python SDK / publish-pypi (push) Has been cancelled
Publish TypeScript SDK / publish-npm (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:20:55 +08:00

177 lines
6.2 KiB
TypeScript

import type {
ApolloAccountBulkUpdateParams,
ApolloAccountBulkUpdateResponse,
} from '@/tools/apollo/types'
import type { ToolConfig } from '@/tools/types'
export const apolloAccountBulkUpdateTool: ToolConfig<
ApolloAccountBulkUpdateParams,
ApolloAccountBulkUpdateResponse
> = {
id: 'apollo_account_bulk_update',
name: 'Apollo Bulk Update Accounts',
description:
'Update up to 1000 existing accounts at once in your Apollo database (higher limit than contacts!). Each account must include an id field. Master key required.',
version: '1.0.0',
params: {
apiKey: {
type: 'string',
required: true,
visibility: 'user-only',
description: 'Apollo API key (master key required)',
},
account_ids: {
type: 'array',
required: false,
visibility: 'user-or-llm',
description:
'Array of account IDs to update with the same values (max 1000). Use with name/owner_id for uniform updates. Use either this OR account_attributes.',
},
name: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'When using account_ids, apply this name to all accounts',
},
owner_id: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'When using account_ids, apply this owner to all accounts',
},
account_stage_id: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'When using account_ids, apply this account stage to all accounts',
},
account_attributes: {
type: 'json',
required: false,
visibility: 'user-or-llm',
description:
'Array of account objects with individual updates (each must include id). Example: [{"id": "acc1", "name": "Acme", "owner_id": "u1", "account_stage_id": "s1", "typed_custom_fields": {"field_id": "value"}}]',
},
async: {
type: 'boolean',
required: false,
visibility: 'user-only',
description:
'When true, processes the update asynchronously. Only supported when using account_ids; returns 422 if used with account_attributes.',
},
},
request: {
url: 'https://api.apollo.io/api/v1/accounts/bulk_update',
method: 'POST',
headers: (params: ApolloAccountBulkUpdateParams) => ({
'Content-Type': 'application/json',
'Cache-Control': 'no-cache',
'X-Api-Key': params.apiKey,
}),
body: (params: ApolloAccountBulkUpdateParams) => {
const body: Record<string, unknown> = {}
if (params.account_ids && params.account_ids.length > 0) {
body.account_ids = params.account_ids.slice(0, 1000)
}
if (params.name) body.name = params.name
if (params.owner_id) body.owner_id = params.owner_id
if (params.account_stage_id) body.account_stage_id = params.account_stage_id
if (params.account_attributes) {
if (Array.isArray(params.account_attributes)) {
if (params.account_attributes.length > 0) {
body.account_attributes = params.account_attributes.slice(0, 1000)
}
} else if (
typeof params.account_attributes === 'object' &&
Object.keys(params.account_attributes).length > 0
) {
body.account_attributes = params.account_attributes
}
}
const hasUpdateFields =
body.account_attributes || body.name || body.owner_id || body.account_stage_id
if (!hasUpdateFields) {
throw new Error(
'Apollo account bulk update requires update fields. Provide account_attributes (array of per-account updates with id, or single object paired with account_ids), or pair account_ids with name/owner_id to apply uniformly.'
)
}
if (!body.account_ids && !body.account_attributes) {
throw new Error(
'Apollo account bulk update requires account_ids (with name/owner_id) or account_attributes (with embedded ids).'
)
}
if (body.account_attributes && !Array.isArray(body.account_attributes) && !body.account_ids) {
throw new Error(
'Apollo account bulk update with object-form account_attributes requires account_ids to identify which accounts to update.'
)
}
if (body.account_ids && Array.isArray(body.account_attributes)) {
throw new Error(
'Apollo account bulk update cannot combine account_ids with array-form account_attributes. Use account_ids with name/owner_id (or object-form account_attributes), or use array-form account_attributes alone (each entry carries its own id).'
)
}
if (params.async !== undefined) body.async = params.async
return body
},
},
transformResponse: async (response: Response) => {
if (!response.ok) {
const errorText = await response.text()
throw new Error(`Apollo API error: ${response.status} - ${errorText}`)
}
const data = await response.json()
const accounts = Array.isArray(data?.accounts) ? data.accounts : []
const entityProgressJob = data?.entity_progress_job ?? null
const accountIds = Array.isArray(data?.account_ids)
? data.account_ids
: accounts.map((a: { id?: unknown }) => a?.id).filter((id: unknown) => typeof id === 'string')
const jobId =
typeof data?.job_id === 'string'
? data.job_id
: typeof entityProgressJob?.id === 'string'
? entityProgressJob.id
: null
return {
success: true,
output: {
accounts,
account_ids: accountIds,
entity_progress_job: entityProgressJob,
job_id: jobId,
message: data?.message ?? null,
},
}
},
outputs: {
accounts: {
type: 'json',
description: 'Updated accounts (synchronous response): [{id, account_stage_id, ...}]',
},
account_ids: {
type: 'json',
description: 'IDs of accounts that were updated',
},
entity_progress_job: {
type: 'json',
description: 'Async job descriptor (when async=true is passed with account_ids)',
optional: true,
},
job_id: {
type: 'string',
description: 'Async job ID extracted from entity_progress_job',
optional: true,
},
message: {
type: 'string',
description: 'Optional confirmation message from Apollo',
optional: true,
},
},
}