Files
simstudioai--sim/apps/sim/tools/zendesk/update_organization.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

166 lines
4.4 KiB
TypeScript

import { createLogger } from '@sim/logger'
import type { ToolConfig } from '@/tools/types'
import {
buildZendeskUrl,
handleZendeskError,
ORGANIZATION_OUTPUT_PROPERTIES,
} from '@/tools/zendesk/types'
const logger = createLogger('ZendeskUpdateOrganization')
export interface ZendeskUpdateOrganizationParams {
email: string
apiToken: string
subdomain: string
organizationId: string
name?: string
domainNames?: string
details?: string
notes?: string
tags?: string
customFields?: string
}
export interface ZendeskUpdateOrganizationResponse {
success: boolean
output: {
organization: any
organization_id: number
success: boolean
}
}
export const zendeskUpdateOrganizationTool: ToolConfig<
ZendeskUpdateOrganizationParams,
ZendeskUpdateOrganizationResponse
> = {
id: 'zendesk_update_organization',
name: 'Update Organization in Zendesk',
description: 'Update an existing organization in Zendesk',
version: '1.0.0',
params: {
email: {
type: 'string',
required: true,
visibility: 'user-only',
description: 'Your Zendesk email address',
},
apiToken: {
type: 'string',
required: true,
visibility: 'hidden',
description: 'Zendesk API token',
},
subdomain: {
type: 'string',
required: true,
visibility: 'user-only',
description: 'Your Zendesk subdomain',
},
organizationId: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description: 'Organization ID to update as a numeric string (e.g., "12345")',
},
name: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'New organization name (e.g., "Acme Corporation")',
},
domainNames: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Comma-separated domain names (e.g., "acme.com, acme.org")',
},
details: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Organization details text',
},
notes: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Organization notes text',
},
tags: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Comma-separated tags (e.g., "enterprise, priority")',
},
customFields: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Custom fields as JSON object (e.g., {"field_id": "value"})',
},
},
request: {
url: (params) => buildZendeskUrl(params.subdomain, `/organizations/${params.organizationId}`),
method: 'PUT',
headers: (params) => {
const credentials = `${params.email}/token:${params.apiToken}`
const base64Credentials = Buffer.from(credentials).toString('base64')
return {
Authorization: `Basic ${base64Credentials}`,
'Content-Type': 'application/json',
}
},
body: (params) => {
const organization: any = {}
if (params.name) organization.name = params.name
if (params.domainNames)
organization.domain_names = params.domainNames.split(',').map((d) => d.trim())
if (params.details) organization.details = params.details
if (params.notes) organization.notes = params.notes
if (params.tags) organization.tags = params.tags.split(',').map((t) => t.trim())
if (params.customFields) {
try {
const customFields = JSON.parse(params.customFields)
organization.organization_fields = customFields
} catch (error) {
logger.warn('Failed to parse custom fields', { error })
}
}
return { organization }
},
},
transformResponse: async (response: Response) => {
if (!response.ok) {
const data = await response.json()
handleZendeskError(data, response.status, 'update_organization')
}
const data = await response.json()
return {
success: true,
output: {
organization: data.organization,
organization_id: data.organization?.id,
success: true,
},
}
},
outputs: {
organization: {
type: 'object',
description: 'Updated organization object',
properties: ORGANIZATION_OUTPUT_PROPERTIES,
},
organization_id: { type: 'number', description: 'The updated organization ID' },
},
}