Files
simstudioai--sim/apps/sim/tools/square/get_invoice.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

64 lines
1.7 KiB
TypeScript

import { ErrorExtractorId } from '@/tools/error-extractors'
import type { GetInvoiceParams, InvoiceResponse } from '@/tools/square/types'
import {
INVOICE_METADATA_OUTPUT_PROPERTIES,
INVOICE_OUTPUT,
SQUARE_BASE_URL,
squareHeaders,
} from '@/tools/square/types'
import type { ToolConfig } from '@/tools/types'
export const squareGetInvoiceTool: ToolConfig<GetInvoiceParams, InvoiceResponse> = {
id: 'square_get_invoice',
name: 'Square Get Invoice',
description: 'Retrieve a single invoice by its ID',
version: '1.0.0',
errorExtractor: ErrorExtractorId.SQUARE_ERRORS,
params: {
apiKey: {
type: 'string',
required: true,
visibility: 'user-only',
description: 'Square access token (personal access token)',
},
invoiceId: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description: 'ID of the invoice to retrieve',
},
},
request: {
url: (params) => `${SQUARE_BASE_URL}/v2/invoices/${encodeURIComponent(params.invoiceId)}`,
method: 'GET',
headers: (params) => squareHeaders(params.apiKey),
},
transformResponse: async (response) => {
const data = await response.json()
const invoice = data.invoice ?? {}
return {
success: true,
output: {
invoice,
metadata: {
id: invoice.id,
status: invoice.status ?? null,
version: invoice.version ?? null,
},
},
}
},
outputs: {
invoice: { ...INVOICE_OUTPUT, description: 'The retrieved invoice object' },
metadata: {
type: 'json',
description: 'Invoice summary metadata',
properties: INVOICE_METADATA_OUTPUT_PROPERTIES,
},
},
}