Files
sim/apps/sim/tools/mailchimp/create_batch_operation.ts
Waleed 6cb3977dd9 fix(visibility): updated visibility for non-sensitive tool params from user only to user or llm (#3095)
* fix(visibility): updated visibility for non-sensitive tool params from user only to user or llm

* update docs

* updated docs script
2026-01-31 11:31:08 -08:00

97 lines
2.5 KiB
TypeScript

import { createLogger } from '@sim/logger'
import type { MailchimpBatchOperation } from '@/tools/mailchimp/types'
import { buildMailchimpUrl, handleMailchimpError } from '@/tools/mailchimp/types'
import type { ToolConfig } from '@/tools/types'
const logger = createLogger('MailchimpCreateBatchOperation')
export interface MailchimpCreateBatchOperationParams {
apiKey: string
operations: string
}
export interface MailchimpCreateBatchOperationResponse {
success: boolean
output: {
batch: MailchimpBatchOperation
batch_id: string
success: boolean
}
}
export const mailchimpCreateBatchOperationTool: ToolConfig<
MailchimpCreateBatchOperationParams,
MailchimpCreateBatchOperationResponse
> = {
id: 'mailchimp_create_batch_operation',
name: 'Create Batch Operation in Mailchimp',
description: 'Create a new batch operation in Mailchimp',
version: '1.0.0',
params: {
apiKey: {
type: 'string',
required: true,
visibility: 'hidden',
description: 'Mailchimp API key with server prefix',
},
operations: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description:
'JSON array of batch operations (e.g., [{"method": "POST", "path": "/lists/{list_id}/members", "body": "..."}])',
},
},
request: {
url: (params) => buildMailchimpUrl(params.apiKey, '/batches'),
method: 'POST',
headers: (params) => ({
Authorization: `Bearer ${params.apiKey}`,
'Content-Type': 'application/json',
}),
body: (params) => {
let operations = []
try {
operations = JSON.parse(params.operations)
} catch (error) {
logger.warn('Failed to parse operations', { error })
}
return { operations }
},
},
transformResponse: async (response: Response) => {
if (!response.ok) {
const data = await response.json()
handleMailchimpError(data, response.status, 'create_batch_operation')
}
const data = await response.json()
return {
success: true,
output: {
batch: data,
batch_id: data.id,
success: true,
},
}
},
outputs: {
success: { type: 'boolean', description: 'Operation success status' },
output: {
type: 'object',
description: 'Created batch operation data',
properties: {
batch: { type: 'json', description: 'Created batch operation object' },
batch_id: { type: 'string', description: 'Created batch operation ID' },
success: { type: 'boolean', description: 'Operation success' },
},
},
},
}