Files
simstudioai--sim/apps/sim/tools/brex/list_users.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.2 KiB
TypeScript

import type { BrexListUsersParams, BrexListUsersResponse } from '@/tools/brex/types'
import { BREX_USER_PROPERTIES } from '@/tools/brex/types'
import {
appendBrexPagination,
BREX_API_BASE,
buildBrexHeaders,
parseBrexJson,
} from '@/tools/brex/utils'
import type { ToolConfig } from '@/tools/types'
export const brexListUsersTool: ToolConfig<BrexListUsersParams, BrexListUsersResponse> = {
id: 'brex_list_users',
name: 'Brex List Users',
description: 'List users in the Brex account, optionally filtered by email',
version: '1.0.0',
params: {
apiKey: {
type: 'string',
required: true,
visibility: 'user-only',
description: 'Brex user token (generated from Developer Settings in the Brex dashboard)',
},
email: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Filter users by exact email address',
},
cursor: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Pagination cursor from a previous response',
},
limit: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Number of users to return (default 100, max 1000)',
},
},
request: {
url: (params) => {
const query = new URLSearchParams()
if (params.email) query.append('email', params.email.trim())
appendBrexPagination(query, params)
const queryString = query.toString()
return queryString ? `${BREX_API_BASE}/v2/users?${queryString}` : `${BREX_API_BASE}/v2/users`
},
method: 'GET',
headers: (params) => buildBrexHeaders(params.apiKey),
},
transformResponse: async (response) => {
const data = await parseBrexJson(response)
return {
success: true,
output: {
items: data.items ?? [],
nextCursor: data.next_cursor ?? null,
},
}
},
outputs: {
items: {
type: 'array',
description: 'Users in the Brex account',
items: { type: 'json', properties: BREX_USER_PROPERTIES },
},
nextCursor: {
type: 'string',
description: 'Cursor for fetching the next page of results',
optional: true,
},
},
}