/** * @generated by cli:generate:telemetry-client (openapigen) * Source: apps/cli/specs/telemetry-openapi.json * Regenerate: pnpm exec nx run cli:generate:telemetry-client * DO NOT EDIT - changes are overwritten on regeneration. */ import * as Effect from "effect/Effect"; import type { SchemaError } from "effect/Schema"; import * as Schema from "effect/Schema"; import type * as HttpClient from "effect/http/HttpClient"; import * as HttpClientError from "effect/http/HttpClientError"; import * as HttpClientRequest from "effect/http/HttpClientRequest"; import * as HttpClientResponse from "effect/http/HttpClientResponse"; export type TelemetryMetaResponse = { readonly ok: true; readonly service: "telemetry"; readonly message: string; readonly docs: string | null; readonly openapi: string | null; }; export declare const TelemetryMetaResponse: Schema.Struct<{ readonly ok: Schema.Literal; readonly service: Schema.Literal<"telemetry">; readonly message: Schema.String; readonly docs: Schema.Union; readonly openapi: Schema.Union; }>; export type DecodeErrorResponseEncoded = { readonly kind: "DecodeErrorResponse"; readonly type: string; readonly title: string; readonly status: number; readonly detail: string; readonly instance?: string; readonly code: string; }; export declare const DecodeErrorResponseEncoded: Schema.Struct<{ readonly kind: Schema.Literal<"DecodeErrorResponse">; readonly type: Schema.String; readonly title: Schema.String; readonly status: Schema.Number; readonly detail: Schema.String; readonly instance: Schema.optionalKey; readonly code: Schema.String; }>; export type IsoDateTimeString = string; export declare const IsoDateTimeString: Schema.String; export type AgentId = "adal" | "fx" | "muse-code" | "mimo-code" | "coder-agents" | "aider-desk" | "amp" | "antigravity" | "antigravity-cli" | "augment" | "claude-code" | "cline" | "codearts-agent" | "codebuddy" | "codemaker" | "codestudio" | "codex" | "command-code" | "continue" | "cortex" | "crush" | "cursor" | "deepagents" | "devin" | "dexto" | "droid" | "firebender" | "forgecode" | "gemini-cli" | "github-copilot-cli" | "goose" | "grok-cli" | "hermes" | "ibm-bob" | "iflow-cli" | "junie" | "lingma" | "kilo" | "kimi-cli" | "kiro-cli" | "kode" | "mcpjam" | "minimax-code" | "mistral-vibe" | "mux" | "neovate" | "openclaw" | "opencode" | "openhands" | "ona" | "pi" | "vscode" | "pochi" | "qoder" | "qoder-cn" | "qwen-code" | "replit" | "roo" | "rovodev" | "tabnine-cli" | "trae-cn" | "trae" | "warp" | "windsurf" | "zencoder" | "zed" | "zenflow" | "chatgpt" | "claude-ai" | "cowork" | "gemini-app"; export declare const AgentId: Schema.Literals; export type ExtensionName = string; export declare const ExtensionName: Schema.String; export type TelemetryEvent = { readonly eventId: string; readonly event: string; readonly distinctId: string; readonly timestamp: string; readonly properties?: { readonly [x: string]: string | number | boolean | null | ReadonlyArray; }; readonly userProperties?: { readonly set?: { readonly [x: string]: string | number | boolean | null | ReadonlyArray; }; readonly setOnce?: { readonly [x: string]: string | number | boolean | null | ReadonlyArray; }; }; readonly groups?: { readonly [x: string]: string; }; readonly sessionId?: string; readonly anonymous?: boolean; }; export declare const TelemetryEvent: Schema.Struct<{ readonly eventId: Schema.String; readonly event: Schema.String; readonly distinctId: Schema.String; readonly timestamp: Schema.String; readonly properties: Schema.optionalKey, Schema.$Array>]>>>; readonly userProperties: Schema.optionalKey, Schema.$Array>]>>>; readonly setOnce: Schema.optionalKey, Schema.$Array>]>>>; }>>; readonly groups: Schema.optionalKey>; readonly sessionId: Schema.optionalKey; readonly anonymous: Schema.optionalKey; }>; export type TelemetryClientContext = { readonly name: string; readonly version: string; }; export declare const TelemetryClientContext: Schema.Struct<{ readonly name: Schema.String; readonly version: Schema.String; }>; export type TelemetryEventsReceipt = { readonly receipt: "received"; readonly eventCount: number; }; export declare const TelemetryEventsReceipt: Schema.Struct<{ readonly receipt: Schema.Literal<"received">; readonly eventCount: Schema.Number; }>; export type TelemetryPayloadTooLargeErrorEncoded = { readonly kind: "TelemetryPayloadTooLargeError"; readonly type: string; readonly title: string; readonly status: number; readonly detail: string; readonly instance?: string; readonly code: string; }; export declare const TelemetryPayloadTooLargeErrorEncoded: Schema.Struct<{ readonly kind: Schema.Literal<"TelemetryPayloadTooLargeError">; readonly type: Schema.String; readonly title: Schema.String; readonly status: Schema.Number; readonly detail: Schema.String; readonly instance: Schema.optionalKey; readonly code: Schema.String; }>; export type TelemetryReportingClient = { readonly name: string; readonly version: string; readonly runtime: "bun" | "node"; readonly runtimeVersion: string; readonly platform: string; readonly architecture: string; readonly callerAgent?: "adal" | "fx" | "muse-code" | "mimo-code" | "coder-agents" | "aider-desk" | "amp" | "antigravity" | "antigravity-cli" | "augment" | "claude-code" | "cline" | "codearts-agent" | "codebuddy" | "codemaker" | "codestudio" | "codex" | "command-code" | "continue" | "cortex" | "crush" | "cursor" | "deepagents" | "devin" | "dexto" | "droid" | "firebender" | "forgecode" | "gemini-cli" | "github-copilot-cli" | "goose" | "grok-cli" | "hermes" | "ibm-bob" | "iflow-cli" | "junie" | "lingma" | "kilo" | "kimi-cli" | "kiro-cli" | "kode" | "mcpjam" | "minimax-code" | "mistral-vibe" | "mux" | "neovate" | "openclaw" | "opencode" | "openhands" | "ona" | "pi" | "vscode" | "pochi" | "qoder" | "qoder-cn" | "qwen-code" | "replit" | "roo" | "rovodev" | "tabnine-cli" | "trae-cn" | "trae" | "warp" | "windsurf" | "zencoder" | "zed" | "zenflow" | "chatgpt" | "claude-ai" | "cowork" | "gemini-app" | "unknown"; readonly ci: boolean; }; export declare const TelemetryReportingClient: Schema.Struct<{ readonly name: Schema.String; readonly version: Schema.String; readonly runtime: Schema.Literals; readonly runtimeVersion: Schema.String; readonly platform: Schema.String; readonly architecture: Schema.String; readonly callerAgent: Schema.optionalKey>; readonly ci: Schema.Boolean; }>; export type TelemetryErrorReceipt = { readonly eventId: string; readonly receipt: "received"; }; export declare const TelemetryErrorReceipt: Schema.Struct<{ readonly eventId: Schema.String; readonly receipt: Schema.Literal<"received">; }>; export type SkillInstallEvent = { readonly eventId: string; readonly event: "skill_install_completed"; readonly distinctId: string; readonly timestamp: IsoDateTimeString; readonly anonymous: true; readonly userProperties?: never; readonly groups?: never; readonly sessionId?: never; readonly properties: { readonly scope: "project" | "user"; readonly installKind: "install" | "reinstall"; readonly targetAgents: ReadonlyArray; readonly activityId?: string; readonly skill: { readonly kind: "git"; readonly repositoryUrl: string; readonly skillPath: string; }; readonly revision: { readonly kind: "git"; readonly commitSha: string; }; } | { readonly scope: "project" | "user"; readonly installKind: "install" | "reinstall"; readonly targetAgents: ReadonlyArray; readonly activityId?: string; readonly skill: { readonly kind: "registry"; readonly registryUrl: "https://registry.agentxm.ai"; readonly publisherBindingId: string; readonly extensionType: "skill"; readonly packageName: ExtensionName; }; readonly revision: { readonly kind: "registry"; readonly version: string; readonly integrity?: string; }; }; }; export declare const SkillInstallEvent: Schema.Struct<{ readonly eventId: Schema.String; readonly event: Schema.Literal<"skill_install_completed">; readonly distinctId: Schema.String; readonly timestamp: Schema.String; readonly anonymous: Schema.Literal; readonly userProperties: Schema.optionalKey; readonly groups: Schema.optionalKey; readonly sessionId: Schema.optionalKey; readonly properties: Schema.Union; readonly installKind: Schema.Literals; readonly targetAgents: Schema.$Array>; readonly activityId: Schema.optionalKey; readonly skill: Schema.Struct<{ readonly kind: Schema.Literal<"git">; readonly repositoryUrl: Schema.String; readonly skillPath: Schema.String; }>; readonly revision: Schema.Struct<{ readonly kind: Schema.Literal<"git">; readonly commitSha: Schema.String; }>; }>, Schema.Struct<{ readonly scope: Schema.Literals; readonly installKind: Schema.Literals; readonly targetAgents: Schema.$Array>; readonly activityId: Schema.optionalKey; readonly skill: Schema.Struct<{ readonly kind: Schema.Literal<"registry">; readonly registryUrl: Schema.Literal<"https://registry.agentxm.ai">; readonly publisherBindingId: Schema.String; readonly extensionType: Schema.Literal<"skill">; readonly packageName: Schema.String; }>; readonly revision: Schema.Struct<{ readonly kind: Schema.Literal<"registry">; readonly version: Schema.String; readonly integrity: Schema.optionalKey; }>; }>]>; }>; export type TelemetryContext = { readonly client: TelemetryClientContext; readonly os?: { readonly name: string; readonly version?: string; }; readonly runtime?: { readonly name: string; readonly version: string; }; readonly device?: { readonly arch: string; }; readonly ide?: { readonly name: string; readonly version: string; }; readonly environment?: string; readonly callerAgent?: "adal" | "fx" | "muse-code" | "mimo-code" | "coder-agents" | "aider-desk" | "amp" | "antigravity" | "antigravity-cli" | "augment" | "claude-code" | "cline" | "codearts-agent" | "codebuddy" | "codemaker" | "codestudio" | "codex" | "command-code" | "continue" | "cortex" | "crush" | "cursor" | "deepagents" | "devin" | "dexto" | "droid" | "firebender" | "forgecode" | "gemini-cli" | "github-copilot-cli" | "goose" | "grok-cli" | "hermes" | "ibm-bob" | "iflow-cli" | "junie" | "lingma" | "kilo" | "kimi-cli" | "kiro-cli" | "kode" | "mcpjam" | "minimax-code" | "mistral-vibe" | "mux" | "neovate" | "openclaw" | "opencode" | "openhands" | "ona" | "pi" | "vscode" | "pochi" | "qoder" | "qoder-cn" | "qwen-code" | "replit" | "roo" | "rovodev" | "tabnine-cli" | "trae-cn" | "trae" | "warp" | "windsurf" | "zencoder" | "zed" | "zenflow" | "chatgpt" | "claude-ai" | "cowork" | "gemini-app" | "unknown"; readonly ci?: boolean; readonly invocationId?: string; }; export declare const TelemetryContext: Schema.Struct<{ readonly client: Schema.Struct<{ readonly name: Schema.String; readonly version: Schema.String; }>; readonly os: Schema.optionalKey; }>>; readonly runtime: Schema.optionalKey>; readonly device: Schema.optionalKey>; readonly ide: Schema.optionalKey>; readonly environment: Schema.optionalKey; readonly callerAgent: Schema.optionalKey>; readonly ci: Schema.optionalKey; readonly invocationId: Schema.optionalKey; }>; export type TelemetryErrorReport = { readonly eventId: string; readonly invocationId: string; readonly occurredAt: IsoDateTimeString; readonly installationId?: string; readonly activityId?: string; readonly client: TelemetryReportingClient; readonly command?: string; readonly phase: "bootstrap" | "configuration" | "command" | "output"; readonly failure: { readonly kind: string; readonly category: string; readonly class: "internal" | "user" | "external"; readonly handled: boolean; }; }; export declare const TelemetryErrorReport: Schema.Struct<{ readonly eventId: Schema.String; readonly invocationId: Schema.String; readonly occurredAt: Schema.String; readonly installationId: Schema.optionalKey; readonly activityId: Schema.optionalKey; readonly client: Schema.Struct<{ readonly name: Schema.String; readonly version: Schema.String; readonly runtime: Schema.Literals; readonly runtimeVersion: Schema.String; readonly platform: Schema.String; readonly architecture: Schema.String; readonly callerAgent: Schema.optionalKey>; readonly ci: Schema.Boolean; }>; readonly command: Schema.optionalKey; readonly phase: Schema.Literals; readonly failure: Schema.Struct<{ readonly kind: Schema.String; readonly category: Schema.String; readonly class: Schema.Literals; readonly handled: Schema.Boolean; }>; }>; export type TelemetryEventsRequest = { readonly events: ReadonlyArray; readonly sentAt?: string; readonly context: TelemetryContext; }; export declare const TelemetryEventsRequest: Schema.Struct<{ readonly events: Schema.$Array; readonly distinctId: Schema.String; readonly timestamp: Schema.String; readonly anonymous: Schema.Literal; readonly userProperties: Schema.optionalKey; readonly groups: Schema.optionalKey; readonly sessionId: Schema.optionalKey; readonly properties: Schema.Union; readonly installKind: Schema.Literals; readonly targetAgents: Schema.$Array>; readonly activityId: Schema.optionalKey; readonly skill: Schema.Struct<{ readonly kind: Schema.Literal<"git">; readonly repositoryUrl: Schema.String; readonly skillPath: Schema.String; }>; readonly revision: Schema.Struct<{ readonly kind: Schema.Literal<"git">; readonly commitSha: Schema.String; }>; }>, Schema.Struct<{ readonly scope: Schema.Literals; readonly installKind: Schema.Literals; readonly targetAgents: Schema.$Array>; readonly activityId: Schema.optionalKey; readonly skill: Schema.Struct<{ readonly kind: Schema.Literal<"registry">; readonly registryUrl: Schema.Literal<"https://registry.agentxm.ai">; readonly publisherBindingId: Schema.String; readonly extensionType: Schema.Literal<"skill">; readonly packageName: Schema.String; }>; readonly revision: Schema.Struct<{ readonly kind: Schema.Literal<"registry">; readonly version: Schema.String; readonly integrity: Schema.optionalKey; }>; }>]>; }>, Schema.Struct<{ readonly eventId: Schema.String; readonly event: Schema.String; readonly distinctId: Schema.String; readonly timestamp: Schema.String; readonly properties: Schema.optionalKey, Schema.$Array>]>>>; readonly userProperties: Schema.optionalKey, Schema.$Array>]>>>; readonly setOnce: Schema.optionalKey, Schema.$Array>]>>>; }>>; readonly groups: Schema.optionalKey>; readonly sessionId: Schema.optionalKey; readonly anonymous: Schema.optionalKey; }>]>>; readonly sentAt: Schema.optionalKey; readonly context: Schema.Struct<{ readonly client: Schema.Struct<{ readonly name: Schema.String; readonly version: Schema.String; }>; readonly os: Schema.optionalKey; }>>; readonly runtime: Schema.optionalKey>; readonly device: Schema.optionalKey>; readonly ide: Schema.optionalKey>; readonly environment: Schema.optionalKey; readonly callerAgent: Schema.optionalKey>; readonly ci: Schema.optionalKey; readonly invocationId: Schema.optionalKey; }>; }>; export type MetaGet200 = TelemetryMetaResponse; export declare const MetaGet200: Schema.Struct<{ readonly ok: Schema.Literal; readonly service: Schema.Literal<"telemetry">; readonly message: Schema.String; readonly docs: Schema.Union; readonly openapi: Schema.Union; }>; export type MetaGet400 = DecodeErrorResponseEncoded; export declare const MetaGet400: Schema.Struct<{ readonly kind: Schema.Literal<"DecodeErrorResponse">; readonly type: Schema.String; readonly title: Schema.String; readonly status: Schema.Number; readonly detail: Schema.String; readonly instance: Schema.optionalKey; readonly code: Schema.String; }>; export type HealthGetShallowHealth200 = { readonly status: "pass" | "warn" | "fail"; }; export declare const HealthGetShallowHealth200: Schema.Struct<{ readonly status: Schema.Literals; }>; export type HealthGetShallowHealth400 = DecodeErrorResponseEncoded; export declare const HealthGetShallowHealth400: Schema.Struct<{ readonly kind: Schema.Literal<"DecodeErrorResponse">; readonly type: Schema.String; readonly title: Schema.String; readonly status: Schema.Number; readonly detail: Schema.String; readonly instance: Schema.optionalKey; readonly code: Schema.String; }>; export type HealthGetDeepHealthParams = { readonly "x-health-key"?: string | null; }; export declare const HealthGetDeepHealthParams: Schema.Struct<{ readonly "x-health-key": Schema.optionalKey>; }>; export type HealthGetDeepHealth200 = { readonly status: "pass" | "warn" | "fail"; readonly serviceId?: string | null; readonly version?: string | null; readonly releaseId?: string | null; readonly commit?: string | null; readonly environment?: string | null; readonly region?: string | null; readonly checks?: { readonly [x: string]: ReadonlyArray<{ readonly componentName: string; readonly componentType: "datastore" | "system" | "component"; readonly measurementName: string; readonly status: "pass" | "warn" | "fail"; readonly observedValue: number; readonly observedUnit: string; readonly time: IsoDateTimeString; readonly output?: string | null; }>; } | null; readonly output?: string | null; }; export declare const HealthGetDeepHealth200: Schema.Struct<{ readonly status: Schema.Literals; readonly serviceId: Schema.optionalKey>; readonly version: Schema.optionalKey>; readonly releaseId: Schema.optionalKey>; readonly commit: Schema.optionalKey>; readonly environment: Schema.optionalKey>; readonly region: Schema.optionalKey>; readonly checks: Schema.optionalKey; readonly measurementName: Schema.String; readonly status: Schema.Literals; readonly observedValue: Schema.Number; readonly observedUnit: Schema.String; readonly time: Schema.String; readonly output: Schema.optionalKey>; }>>>, Schema.Null]>>; readonly output: Schema.optionalKey>; }>; export type HealthGetDeepHealth400 = DecodeErrorResponseEncoded; export declare const HealthGetDeepHealth400: Schema.Struct<{ readonly kind: Schema.Literal<"DecodeErrorResponse">; readonly type: Schema.String; readonly title: Schema.String; readonly status: Schema.Number; readonly detail: Schema.String; readonly instance: Schema.optionalKey; readonly code: Schema.String; }>; export type HealthGetObservabilityVerificationParams = { readonly "x-health-key"?: string | null; readonly level?: string | null; readonly scenario?: "effect-handled-500" | "surface-unhandled-500" | null; readonly scenarioId?: string | null; }; export declare const HealthGetObservabilityVerificationParams: Schema.Struct<{ readonly "x-health-key": Schema.optionalKey>; readonly level: Schema.optionalKey>; readonly scenario: Schema.optionalKey, Schema.Null]>>; readonly scenarioId: Schema.optionalKey>; }>; export type HealthGetObservabilityVerification200 = { readonly status: "ok" | "warn" | "error"; readonly timestamp: IsoDateTimeString; readonly serviceId: string; readonly level: "basic" | "standard" | "full"; readonly checks: { readonly logging?: { readonly status: "ok" | "warn" | "error"; readonly correlationId: string; } | null; readonly tracing?: { readonly status: "ok" | "warn" | "error"; readonly traceId?: string | null; readonly message?: string | null; } | null; readonly metrics?: { readonly status: "ok" | "warn" | "error"; readonly counter: string; } | null; readonly errors?: { readonly status: "ok" | "warn" | "error"; readonly sentryEventId?: string | null; readonly reason?: "sentry-issue-reporter-disabled" | null; readonly message?: string | null; } | null; }; }; export declare const HealthGetObservabilityVerification200: Schema.Struct<{ readonly status: Schema.Literals; readonly timestamp: Schema.String; readonly serviceId: Schema.String; readonly level: Schema.Literals; readonly checks: Schema.Struct<{ readonly logging: Schema.optionalKey; readonly correlationId: Schema.String; }>, Schema.Null]>>; readonly tracing: Schema.optionalKey; readonly traceId: Schema.optionalKey>; readonly message: Schema.optionalKey>; }>, Schema.Null]>>; readonly metrics: Schema.optionalKey; readonly counter: Schema.String; }>, Schema.Null]>>; readonly errors: Schema.optionalKey; readonly sentryEventId: Schema.optionalKey>; readonly reason: Schema.optionalKey, Schema.Null]>>; readonly message: Schema.optionalKey>; }>, Schema.Null]>>; }>; }>; export type HealthGetObservabilityVerification400 = DecodeErrorResponseEncoded; export declare const HealthGetObservabilityVerification400: Schema.Struct<{ readonly kind: Schema.Literal<"DecodeErrorResponse">; readonly type: Schema.String; readonly title: Schema.String; readonly status: Schema.Number; readonly detail: Schema.String; readonly instance: Schema.optionalKey; readonly code: Schema.String; }>; export type EventsIngestRequestJson = TelemetryEventsRequest; export declare const EventsIngestRequestJson: Schema.Struct<{ readonly events: Schema.$Array; readonly distinctId: Schema.String; readonly timestamp: Schema.String; readonly anonymous: Schema.Literal; readonly userProperties: Schema.optionalKey; readonly groups: Schema.optionalKey; readonly sessionId: Schema.optionalKey; readonly properties: Schema.Union; readonly installKind: Schema.Literals; readonly targetAgents: Schema.$Array>; readonly activityId: Schema.optionalKey; readonly skill: Schema.Struct<{ readonly kind: Schema.Literal<"git">; readonly repositoryUrl: Schema.String; readonly skillPath: Schema.String; }>; readonly revision: Schema.Struct<{ readonly kind: Schema.Literal<"git">; readonly commitSha: Schema.String; }>; }>, Schema.Struct<{ readonly scope: Schema.Literals; readonly installKind: Schema.Literals; readonly targetAgents: Schema.$Array>; readonly activityId: Schema.optionalKey; readonly skill: Schema.Struct<{ readonly kind: Schema.Literal<"registry">; readonly registryUrl: Schema.Literal<"https://registry.agentxm.ai">; readonly publisherBindingId: Schema.String; readonly extensionType: Schema.Literal<"skill">; readonly packageName: Schema.String; }>; readonly revision: Schema.Struct<{ readonly kind: Schema.Literal<"registry">; readonly version: Schema.String; readonly integrity: Schema.optionalKey; }>; }>]>; }>, Schema.Struct<{ readonly eventId: Schema.String; readonly event: Schema.String; readonly distinctId: Schema.String; readonly timestamp: Schema.String; readonly properties: Schema.optionalKey, Schema.$Array>]>>>; readonly userProperties: Schema.optionalKey, Schema.$Array>]>>>; readonly setOnce: Schema.optionalKey, Schema.$Array>]>>>; }>>; readonly groups: Schema.optionalKey>; readonly sessionId: Schema.optionalKey; readonly anonymous: Schema.optionalKey; }>]>>; readonly sentAt: Schema.optionalKey; readonly context: Schema.Struct<{ readonly client: Schema.Struct<{ readonly name: Schema.String; readonly version: Schema.String; }>; readonly os: Schema.optionalKey; }>>; readonly runtime: Schema.optionalKey>; readonly device: Schema.optionalKey>; readonly ide: Schema.optionalKey>; readonly environment: Schema.optionalKey; readonly callerAgent: Schema.optionalKey>; readonly ci: Schema.optionalKey; readonly invocationId: Schema.optionalKey; }>; }>; export type EventsIngest200 = TelemetryEventsReceipt; export declare const EventsIngest200: Schema.Struct<{ readonly receipt: Schema.Literal<"received">; readonly eventCount: Schema.Number; }>; export type EventsIngest400 = DecodeErrorResponseEncoded; export declare const EventsIngest400: Schema.Struct<{ readonly kind: Schema.Literal<"DecodeErrorResponse">; readonly type: Schema.String; readonly title: Schema.String; readonly status: Schema.Number; readonly detail: Schema.String; readonly instance: Schema.optionalKey; readonly code: Schema.String; }>; export type EventsIngest413 = TelemetryPayloadTooLargeErrorEncoded; export declare const EventsIngest413: Schema.Struct<{ readonly kind: Schema.Literal<"TelemetryPayloadTooLargeError">; readonly type: Schema.String; readonly title: Schema.String; readonly status: Schema.Number; readonly detail: Schema.String; readonly instance: Schema.optionalKey; readonly code: Schema.String; }>; export type ErrorsIngestRequestJson = TelemetryErrorReport; export declare const ErrorsIngestRequestJson: Schema.Struct<{ readonly eventId: Schema.String; readonly invocationId: Schema.String; readonly occurredAt: Schema.String; readonly installationId: Schema.optionalKey; readonly activityId: Schema.optionalKey; readonly client: Schema.Struct<{ readonly name: Schema.String; readonly version: Schema.String; readonly runtime: Schema.Literals; readonly runtimeVersion: Schema.String; readonly platform: Schema.String; readonly architecture: Schema.String; readonly callerAgent: Schema.optionalKey>; readonly ci: Schema.Boolean; }>; readonly command: Schema.optionalKey; readonly phase: Schema.Literals; readonly failure: Schema.Struct<{ readonly kind: Schema.String; readonly category: Schema.String; readonly class: Schema.Literals; readonly handled: Schema.Boolean; }>; }>; export type ErrorsIngest200 = TelemetryErrorReceipt; export declare const ErrorsIngest200: Schema.Struct<{ readonly eventId: Schema.String; readonly receipt: Schema.Literal<"received">; }>; export type ErrorsIngest400 = DecodeErrorResponseEncoded; export declare const ErrorsIngest400: Schema.Struct<{ readonly kind: Schema.Literal<"DecodeErrorResponse">; readonly type: Schema.String; readonly title: Schema.String; readonly status: Schema.Number; readonly detail: Schema.String; readonly instance: Schema.optionalKey; readonly code: Schema.String; }>; export interface OperationConfig { /** * Whether or not the response should be included in the value returned from * an operation. * * If set to `true`, a tuple of `[A, HttpClientResponse]` will be returned, * where `A` is the success type of the operation. * * If set to `false`, only the success type of the operation will be returned. */ readonly includeResponse?: boolean | undefined; } /** * A utility type which optionally includes the response in the return result * of an operation based upon the value of the `includeResponse` configuration * option. */ export type WithOptionalResponse = Config extends { readonly includeResponse: true; } ? [A, HttpClientResponse.HttpClientResponse] : Config extends { readonly includeResponse?: false | undefined; } | undefined ? A : A | [A, HttpClientResponse.HttpClientResponse]; export declare const make: (httpClient: HttpClient.HttpClient, options?: { readonly transformClient?: ((client: HttpClient.HttpClient) => Effect.Effect) | undefined; }) => TelemetryClient; export interface TelemetryClient { readonly httpClient: HttpClient.HttpClient; /** * Returns service metadata and the documentation entrypoints. */ readonly MetaGet: { (options: { readonly config: Config; }): Effect.Effect, HttpClientError.HttpClientError | SchemaError | TelemetryClientError<"MetaGet400", typeof MetaGet400.Type>>; (options: { readonly config?: Config | undefined; } | undefined): Effect.Effect, HttpClientError.HttpClientError | SchemaError | TelemetryClientError<"MetaGet400", typeof MetaGet400.Type>>; }; /** * Returns pass/fail status. Public, no auth required. */ readonly HealthGetShallowHealth: { (options: { readonly config: Config; }): Effect.Effect, HttpClientError.HttpClientError | SchemaError | TelemetryClientError<"HealthGetShallowHealth400", typeof HealthGetShallowHealth400.Type>>; (options: { readonly config?: Config | undefined; } | undefined): Effect.Effect, HttpClientError.HttpClientError | SchemaError | TelemetryClientError<"HealthGetShallowHealth400", typeof HealthGetShallowHealth400.Type>>; }; /** * Returns IETF health+json response with per-dependency check results. Requires X-Health-Key header. */ readonly HealthGetDeepHealth: { (options: { readonly params?: typeof HealthGetDeepHealthParams.Encoded | undefined; readonly config: Config; }): Effect.Effect, HttpClientError.HttpClientError | SchemaError | TelemetryClientError<"HealthGetDeepHealth400", typeof HealthGetDeepHealth400.Type>>; (options: { readonly params?: typeof HealthGetDeepHealthParams.Encoded | undefined; readonly config?: Config | undefined; } | undefined): Effect.Effect, HttpClientError.HttpClientError | SchemaError | TelemetryClientError<"HealthGetDeepHealth400", typeof HealthGetDeepHealth400.Type>>; }; /** * Exercises observability pipelines and can simulate server error scenarios. Requires X-Health-Key header. */ readonly HealthGetObservabilityVerification: { (options: { readonly params?: typeof HealthGetObservabilityVerificationParams.Encoded | undefined; readonly config: Config; }): Effect.Effect, HttpClientError.HttpClientError | SchemaError | TelemetryClientError<"HealthGetObservabilityVerification400", typeof HealthGetObservabilityVerification400.Type>>; (options: { readonly params?: typeof HealthGetObservabilityVerificationParams.Encoded | undefined; readonly config?: Config | undefined; } | undefined): Effect.Effect, HttpClientError.HttpClientError | SchemaError | TelemetryClientError<"HealthGetObservabilityVerification400", typeof HealthGetObservabilityVerification400.Type>>; }; /** * Validates a JSON batch and registers bounded best-effort forwarding. The 200 receipt does not imply durable storage or provider ingestion. Content-Type must be application/json. Ingress limits are owned by the edge. */ readonly EventsIngest: { (options: { readonly payload: typeof EventsIngestRequestJson.Encoded; readonly config: Config; }): Effect.Effect, HttpClientError.HttpClientError | SchemaError | TelemetryClientError<"EventsIngest400", typeof EventsIngest400.Type> | TelemetryClientError<"EventsIngest413", typeof EventsIngest413.Type>>; (options: { readonly payload: typeof EventsIngestRequestJson.Encoded; readonly config?: Config | undefined; }): Effect.Effect, HttpClientError.HttpClientError | SchemaError | TelemetryClientError<"EventsIngest400", typeof EventsIngest400.Type> | TelemetryClientError<"EventsIngest413", typeof EventsIngest413.Type>>; }; /** * Receives one bounded, allowlisted failure report from a consent-controlled client invocation. * * **Receipt.** A `200` response is a synchronous receipt: the report passed * validation and its forwarding was registered as bounded, best-effort * background work of the receiving invocation. The receipt is not durable * acceptance, provider ingestion, or issue creation, and the service stores * nothing. Forwarding may be dropped when a provider fails or the invocation's * background deadline passes; no exactly-once delivery is promised. * * **Report identity.** Resubmitting the same report keeps its `eventId`. The * service carries that identity into the provider insert and event * identities, but provider deduplication is not an end-to-end guarantee. * * **Declared fields only.** Only the declared, bounded fields are accepted. * Undeclared fields are ignored: the platform's request decoding drops them * before the report is processed. Reports carry no messages, stack traces, * arguments, paths, or other free-form content. */ readonly ErrorsIngest: { (options: { readonly payload: typeof ErrorsIngestRequestJson.Encoded; readonly config: Config; }): Effect.Effect, HttpClientError.HttpClientError | SchemaError | TelemetryClientError<"ErrorsIngest400", typeof ErrorsIngest400.Type>>; (options: { readonly payload: typeof ErrorsIngestRequestJson.Encoded; readonly config?: Config | undefined; }): Effect.Effect, HttpClientError.HttpClientError | SchemaError | TelemetryClientError<"ErrorsIngest400", typeof ErrorsIngest400.Type>>; }; } export interface TelemetryClientError { readonly _tag: Tag; readonly request: HttpClientRequest.HttpClientRequest; readonly response: HttpClientResponse.HttpClientResponse; readonly cause: E; } export declare const TelemetryClientError: (tag: Tag, cause: E, response: HttpClientResponse.HttpClientResponse) => TelemetryClientError; //# sourceMappingURL=telemetry-client.d.ts.map