Files
simstudioai--sim/apps/sim/tools/thrive/update_assignment.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

112 lines
3.3 KiB
TypeScript

import type { ThriveAssignmentResponse, ThriveUpdateAssignmentParams } from '@/tools/thrive/types'
import { THRIVE_ASSIGNMENT_OUTPUT_PROPERTIES } from '@/tools/thrive/types'
import {
getThriveBaseUrl,
getThriveHeaders,
parseThriveArray,
parseThriveResponse,
} from '@/tools/thrive/utils'
import type { ToolConfig } from '@/tools/types'
export const updateAssignmentTool: ToolConfig<
ThriveUpdateAssignmentParams,
ThriveAssignmentResponse
> = {
id: 'thrive_update_assignment',
name: 'Thrive Update Assignment',
description: 'Update a compliance assignment in Thrive.',
version: '1.0.0',
params: {
tenantId: {
type: 'string',
required: true,
visibility: 'user-only',
description: 'Thrive Tenant ID (used as the Basic auth username)',
},
apiKey: {
type: 'string',
required: true,
visibility: 'user-only',
description: 'Thrive API key (used as the Basic auth password)',
},
host: {
type: 'string',
required: false,
visibility: 'user-only',
description: 'Region-specific API host',
},
assignmentId: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description: 'The assignment ID',
},
audienceId: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description: 'The audience ID',
},
contentId: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'The content ID for the primary content',
},
completionPeriod: {
type: 'number',
required: false,
visibility: 'user-or-llm',
description: 'The number of days required to complete the assignment',
},
recurrence: {
type: 'number',
required: false,
visibility: 'user-or-llm',
description: 'The number of days until the assignment will reoccur',
},
alternativeContentIds: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'JSON array of content IDs that can also complete the assignment',
},
},
request: {
url: (params) =>
`${getThriveBaseUrl(params.host, 'v1')}/assignments/${encodeURIComponent(params.assignmentId)}`,
method: 'PATCH',
headers: (params) => getThriveHeaders(params.tenantId, params.apiKey),
body: (params) => {
const body: Record<string, any> = {
audienceId: params.audienceId,
}
if (params.contentId) body.contentId = params.contentId
if (params.completionPeriod !== undefined) body.completionPeriod = params.completionPeriod
if (params.recurrence !== undefined) body.recurrence = params.recurrence
if (params.alternativeContentIds) {
body.alternativeContentIds = parseThriveArray<string>(
params.alternativeContentIds,
'alternativeContentIds'
)
}
return body
},
},
transformResponse: async (response: Response): Promise<ThriveAssignmentResponse> => {
const data = await parseThriveResponse(response, 'Failed to update assignment')
return { success: true, output: { assignment: data ?? null } }
},
outputs: {
assignment: {
type: 'object',
description: 'The updated assignment',
properties: THRIVE_ASSIGNMENT_OUTPUT_PROPERTIES,
},
},
}