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

99 lines
2.7 KiB
TypeScript

import type {
ThriveListAudienceMembersParams,
ThriveListAudienceMembersResponse,
} from '@/tools/thrive/types'
import {
THRIVE_AUDIENCE_MEMBER_OUTPUT_PROPERTIES,
THRIVE_PAGINATION_OUTPUT_PROPERTIES,
} from '@/tools/thrive/types'
import {
appendThriveQuery,
getThriveBaseUrl,
getThriveHeaders,
parseThriveResponse,
} from '@/tools/thrive/utils'
import type { ToolConfig } from '@/tools/types'
export const listAudienceMembersTool: ToolConfig<
ThriveListAudienceMembersParams,
ThriveListAudienceMembersResponse
> = {
id: 'thrive_list_audience_members',
name: 'Thrive List Audience Members',
description: 'List the members of a Thrive audience with pagination.',
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',
},
page: {
type: 'number',
required: false,
visibility: 'user-or-llm',
description: 'Page number for pagination (default 1)',
},
perPage: {
type: 'number',
required: false,
visibility: 'user-or-llm',
description: 'Number of results per page (1-1000, default 100)',
},
},
request: {
url: (params) => {
const url = new URL(
`${getThriveBaseUrl(params.host, 'v1')}/audiences/${encodeURIComponent(params.audienceId)}/members`
)
appendThriveQuery(url, 'page', params.page)
appendThriveQuery(url, 'perPage', params.perPage)
return url.toString()
},
method: 'GET',
headers: (params) => getThriveHeaders(params.tenantId, params.apiKey),
},
transformResponse: async (response: Response): Promise<ThriveListAudienceMembersResponse> => {
const data = await parseThriveResponse(response, 'Failed to list audience members')
return {
success: true,
output: { results: data?.results ?? [], pagination: data?.pagination ?? null },
}
},
outputs: {
results: {
type: 'array',
description: 'The audience members',
items: { type: 'object', properties: THRIVE_AUDIENCE_MEMBER_OUTPUT_PROPERTIES },
},
pagination: {
type: 'object',
description: 'Pagination details',
properties: THRIVE_PAGINATION_OUTPUT_PROPERTIES,
},
},
}