Files
simstudioai--sim/apps/sim/tools/mailchimp/create_merge_field.ts
T
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

102 lines
2.7 KiB
TypeScript

import type { MailchimpMergeField } from '@/tools/mailchimp/types'
import { buildMailchimpUrl, handleMailchimpError } from '@/tools/mailchimp/types'
import type { ToolConfig } from '@/tools/types'
export interface MailchimpCreateMergeFieldParams {
apiKey: string
listId: string
mergeName: string
mergeType: string
}
export interface MailchimpCreateMergeFieldResponse {
success: boolean
output: {
mergeField: MailchimpMergeField
merge_id: string
success: boolean
}
}
export const mailchimpCreateMergeFieldTool: ToolConfig<
MailchimpCreateMergeFieldParams,
MailchimpCreateMergeFieldResponse
> = {
id: 'mailchimp_create_merge_field',
name: 'Create Merge Field in Mailchimp Audience',
description: 'Create a new merge field in a Mailchimp audience',
version: '1.0.0',
params: {
apiKey: {
type: 'string',
required: true,
visibility: 'hidden',
description: 'Mailchimp API key with server prefix',
},
listId: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description: 'The unique ID for the audience/list (e.g., "abc123def4")',
},
mergeName: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description: 'The name of the merge field (e.g., "First Name")',
},
mergeType: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description:
'The type of the merge field: "text", "number", "address", "phone", "date", "url", "imageurl", "radio", "dropdown", "birthday", or "zip"',
},
},
request: {
url: (params) => buildMailchimpUrl(params.apiKey, `/lists/${params.listId}/merge-fields`),
method: 'POST',
headers: (params) => ({
Authorization: `Bearer ${params.apiKey}`,
'Content-Type': 'application/json',
}),
body: (params) => ({
name: params.mergeName,
type: params.mergeType,
}),
},
transformResponse: async (response: Response) => {
if (!response.ok) {
const data = await response.json()
handleMailchimpError(data, response.status, 'create_merge_field')
}
const data = await response.json()
return {
success: true,
output: {
mergeField: data,
merge_id: data.merge_id,
success: true,
},
}
},
outputs: {
success: { type: 'boolean', description: 'Operation success status' },
output: {
type: 'object',
description: 'Created merge field data',
properties: {
mergeField: { type: 'json', description: 'Created merge field object' },
merge_id: { type: 'string', description: 'Created merge field ID' },
success: { type: 'boolean', description: 'Operation success' },
},
},
},
}