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

80 lines
2.4 KiB
TypeScript

import type { ThriveAddUsersResponse, ThriveAudienceUsersParams } from '@/tools/thrive/types'
import { THRIVE_ADD_USERS_OUTPUT_PROPERTIES } from '@/tools/thrive/types'
import {
getThriveBaseUrl,
getThriveHeaders,
parseThriveArray,
parseThriveResponse,
} from '@/tools/thrive/utils'
import type { ToolConfig } from '@/tools/types'
export const replaceAudienceMembersTool: ToolConfig<
ThriveAudienceUsersParams,
ThriveAddUsersResponse
> = {
id: 'thrive_replace_audience_members',
name: 'Thrive Replace Audience Members',
description:
"Replace a Thrive audience's entire members list with the given users (does not support an empty array).",
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',
},
audienceId: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description: 'The audience id or audience reference',
},
users: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description:
'JSON array of user emails/refs/ids that replaces the whole members list (1-100, no empty array). Example: ["user@example.com"]',
},
},
request: {
url: (params) =>
`${getThriveBaseUrl(params.host, 'v1')}/audiences/${encodeURIComponent(params.audienceId)}/members`,
method: 'PATCH',
headers: (params) => getThriveHeaders(params.tenantId, params.apiKey),
body: (params) => JSON.stringify(parseThriveArray<string>(params.users, 'users')),
},
transformResponse: async (response: Response): Promise<ThriveAddUsersResponse> => {
const data = await parseThriveResponse(response, 'Failed to replace audience members')
return {
success: true,
output: { result: { success: data?.success ?? null, failure: data?.failure } },
}
},
outputs: {
result: {
type: 'object',
description:
'The add/replace result, with successfully and unsuccessfully processed entities',
properties: THRIVE_ADD_USERS_OUTPUT_PROPERTIES,
},
},
}