Files
simstudioai--sim/apps/sim/tools/emailbison/update_campaign.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

115 lines
3.0 KiB
TypeScript

import type {
EmailBisonCampaignResponse,
EmailBisonUpdateCampaignParams,
} from '@/tools/emailbison/types'
import {
campaignOutputs,
emailBisonBaseParamFields,
emailBisonHeaders,
emailBisonRecordData,
emailBisonUrl,
jsonBody,
mapCampaign,
} from '@/tools/emailbison/utils'
import type { ToolConfig } from '@/tools/types'
export const updateCampaignTool: ToolConfig<
EmailBisonUpdateCampaignParams,
EmailBisonCampaignResponse
> = {
id: 'emailbison_update_campaign',
name: 'Email Bison Update Campaign',
description: 'Updates Email Bison campaign settings.',
version: '1.0.0',
params: {
...emailBisonBaseParamFields,
campaignId: {
type: 'number',
required: true,
visibility: 'user-or-llm',
description: 'Campaign ID',
},
name: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Campaign name',
},
maxEmailsPerDay: {
type: 'number',
required: false,
visibility: 'user-or-llm',
description: 'Maximum emails per day',
},
maxNewLeadsPerDay: {
type: 'number',
required: false,
visibility: 'user-or-llm',
description: 'Maximum new leads per day',
},
plainText: {
type: 'boolean',
required: false,
visibility: 'user-or-llm',
description: 'Send plain text emails',
},
openTracking: {
type: 'boolean',
required: false,
visibility: 'user-or-llm',
description: 'Enable open tracking',
},
reputationBuilding: {
type: 'boolean',
required: false,
visibility: 'user-or-llm',
description: 'Enable reputation building',
},
canUnsubscribe: {
type: 'boolean',
required: false,
visibility: 'user-or-llm',
description: 'Enable unsubscribe link',
},
includeAutoRepliesInStats: {
type: 'boolean',
required: false,
visibility: 'user-or-llm',
description: 'Include auto replies in campaign stats',
},
sequencePrioritization: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Sequence prioritization: followups or new_leads',
},
},
request: {
url: (params) =>
emailBisonUrl(`/api/campaigns/${params.campaignId}/update`, {}, params.apiBaseUrl),
method: 'PATCH',
headers: emailBisonHeaders,
body: (params) =>
jsonBody({
name: params.name,
max_emails_per_day: params.maxEmailsPerDay,
max_new_leads_per_day: params.maxNewLeadsPerDay,
plain_text: params.plainText,
open_tracking: params.openTracking,
reputation_building: params.reputationBuilding,
can_unsubscribe: params.canUnsubscribe,
include_auto_replies_in_stats: params.includeAutoRepliesInStats,
sequence_prioritization: params.sequencePrioritization,
}),
},
transformResponse: async (response) => {
const data = await emailBisonRecordData(response, 'campaign')
return {
success: true,
output: mapCampaign(data),
}
},
outputs: campaignOutputs,
}