import {z} from 'zod' export type GetApiV3TeamsTeamIdIntegrationsIntegrationIdSchemaArgs = {team_id: string, integration_id: string, maxAge?: number | undefined}; export type GetApiV3TeamsTeamIdIntegrationsIntegrationIdSchemaOptions = {baseUrl: string, fetch?: typeof fetch | undefined}; export const v1CubeMetaMeasure = z.object({name: z.string(), title: z.string().nullable().optional(), shortTitle: z.string().nullable().optional(), description: z.string().nullable().optional(), sql: z.string().nullable().optional(), type: z.enum(["string", "time", "boolean", "number", "count", "count_distinct", "count_distinct_approx", "sum", "avg", "min", "max"]), format: z.enum(["percent", "currency", "number"]).nullable().optional(), filters: z.array(z.record(z.string(), z.unknown())).nullable().optional(), drillMembers: z.array(z.string()).nullable().optional(), public: z.boolean().nullable().optional(), cumulative: z.boolean().nullable().optional(), cumulativeTotal: z.boolean().nullable().optional(), rollingWindow: z.record(z.string(), z.union([z.string(), z.number().int()])).nullable().optional(), meta: z.record(z.string(), z.unknown()).nullable().optional()}); export const v1CubeMetaDimensionLinkFormat = z.object({type: z.literal("link"), label: z.string()}); export const v1CubeMetaDimension = z.object({name: z.string(), title: z.string().nullable().optional(), shortTitle: z.string().nullable().optional(), description: z.string().nullable().optional(), sql: z.string().nullable().optional(), type: z.enum(["time", "string", "number", "boolean", "geo"]), format: z.union([z.enum(["imageUrl", "id", "link", "currency", "percent", "number"]), v1CubeMetaDimensionLinkFormat]).nullable().optional(), case: z.record(z.string(), z.unknown()).nullable().optional(), meta: z.record(z.string(), z.unknown()).nullable().optional(), primaryKey: z.boolean().nullable().optional(), propagateFiltersToSubQuery: z.boolean().nullable().optional(), public: z.boolean().nullable().optional(), subQuery: z.boolean().nullable().optional()}); export const v1CubeMetaSegment = z.object({name: z.string().optional(), title: z.string().nullable().optional(), shortTitle: z.string().nullable().optional(), description: z.string().nullable().optional(), sql: z.string().nullable().optional(), public: z.boolean().nullable().optional()}); export const v1CubeMetaJoin = z.object({name: z.string(), relationship: z.enum(["one_to_one", "one_to_many", "many_to_one", "has_one", "has_many", "belongs_to", "hasOne", "hasMany", "belongsTo"]), sql: z.string().nullable().optional()}); export const extendedCubeMeta = z.object({name: z.string(), type: z.enum(["view", "cube"]).nullable().optional(), title: z.string().nullable().optional(), description: z.string().nullable().optional(), fileName: z.string().nullable().optional(), sqlTable: z.string().nullable().optional(), sql: z.string().nullable().optional(), sqlAlias: z.string().nullable().optional(), dataSource: z.string().nullable().optional(), public: z.boolean().nullable().optional(), isVisible: z.boolean().nullable().optional(), meta: z.record(z.string(), z.unknown()).nullable().optional(), refreshKey: z.record(z.string(), z.union([z.string(), z.record(z.string(), z.string())])).nullable().optional(), extends: z.string().nullable().optional(), measures: z.array(v1CubeMetaMeasure), dimensions: z.array(v1CubeMetaDimension), segments: z.array(v1CubeMetaSegment), joins: z.array(v1CubeMetaJoin).nullable().optional(), preAggregations: z.array(z.unknown()).nullable().optional(), connectedComponent: z.number().int().nullable().optional()}); export const cubeMetadataResponse = z.object({version: z.string().optional(), type: z.literal("cubes").optional(), cubes: z.array(extendedCubeMeta)}); export const column = z.object({name: z.string(), path: z.string(), description: z.string().nullable().optional(), tags: z.array(z.string()).optional(), type: z.string()}); export const table = z.object({name: z.string(), path: z.string(), description: z.string().nullable().optional(), tags: z.array(z.string()).optional(), columns: z.array(column)}); export const databaseWithTables = z.object({name: z.string(), path: z.string(), description: z.string().nullable().optional(), tags: z.array(z.string()).optional(), childType: z.literal("tables"), tables: z.array(table)}); export const schema = z.object({name: z.string(), path: z.string(), description: z.string().nullable().optional(), tags: z.array(z.string()).optional(), tables: z.array(table)}); export const databaseWithSchemas = z.object({name: z.string(), path: z.string(), description: z.string().nullable().optional(), tags: z.array(z.string()).optional(), childType: z.literal("schemas"), schemas: z.array(schema)}); export const databaseSchemaResponse = z.object({version: z.string().optional(), type: z.literal("databases").optional(), databases: z.array(z.discriminatedUnion("childType", [databaseWithTables, databaseWithSchemas]))}); export const schemaResponse = z.object({data: z.discriminatedUnion("type", [cubeMetadataResponse, databaseSchemaResponse])}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Get integration schema * * GET /v3/teams/{team_id}/integrations/{integration_id}/schema */ export const getApiV3TeamsTeamIdIntegrationsIntegrationIdSchema = async (args: GetApiV3TeamsTeamIdIntegrationsIntegrationIdSchemaArgs, options: GetApiV3TeamsTeamIdIntegrationsIntegrationIdSchemaOptions) => { const {baseUrl, fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.maxAge != null) query.append("maxAge", String(args.maxAge)) const url = `${baseUrl.replace(/\/+$/, '')}/v3/teams/${encodeURIComponent(String(args.team_id))}/integrations/${encodeURIComponent(String(args.integration_id))}/schema${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(schemaResponse, await res.json()) };