@oxchannels/sdk 1.0.0

package/dist/client.d.ts

@@ -0,0 +1,83 @@
+import type { ActiveApiErrorCodeV2 as ContractActiveApiErrorCodeV2, ApiErrorCategory as ContractApiErrorCategory, ApiErrorEnvelopeV2 as ContractApiErrorEnvelopeV2, ApiErrorViolation as ContractApiErrorViolation } from './generated/contracts/api-errors.js';
+import type { paths as AgentBootstrapContractV2Paths } from './generated/agent-bootstrap-contract-v2-schema.js';
+import type { paths as DashboardContractV2Paths } from './generated/dashboard-contract-v2-schema.js';
+import type { paths as PartnerContractV2Paths } from './generated/partner-contract-v2-schema.js';
+import type { paths as PublicContractV2Paths } from './generated/public-contract-v2-schema.js';
+export declare const OXCHANNELS_CONTRACT_SET_VERSION: "2.0.0";
+export type ActiveApiErrorCode = ContractActiveApiErrorCodeV2;
+export type ApiErrorCategory = ContractApiErrorCategory;
+export type ApiErrorViolation = ContractApiErrorViolation;
+export type ErrorEnvelopeV2 = ContractApiErrorEnvelopeV2;
+export declare class OxChannelsApiError<Code extends string = string> extends Error {
+    readonly status: number;
+    readonly code: Code;
+    readonly traceId?: string | undefined;
+    constructor(status: number, code: Code, traceId?: string | undefined);
+}
+export declare class OxChannelsApiErrorV2 extends OxChannelsApiError<ActiveApiErrorCode> {
+    readonly schemaVersion: "2.0.0";
+    readonly envelope: Readonly<ErrorEnvelopeV2>;
+    readonly apiMessage: string;
+    readonly correlationId: string;
+    readonly retryable: boolean;
+    readonly category: ApiErrorCategory;
+    readonly effectEvidence: 'NOT_APPLIED' | 'UNKNOWN' | null;
+    readonly retryAfterSeconds?: number;
+    readonly violations?: readonly Readonly<ApiErrorViolation>[];
+    constructor(status: number, envelope: Readonly<ErrorEnvelopeV2>);
+}
+export declare class OxChannelsApiProtocolError extends Error {
+    readonly status: number;
+    readonly code: "ERROR_ENVELOPE_INVALID";
+    constructor(status: number);
+}
+export interface ProviderBindingRotationSelection {
+    readonly workspaceId: string;
+    readonly registrationId: string;
+}
+interface ContractV2BaseOptions {
+    readonly baseUrl?: string;
+    readonly timeoutMs?: number;
+    readonly allowInsecureLoopbackForDevelopment?: boolean;
+    readonly fetch?: typeof globalThis.fetch;
+}
+export interface PublicClientOptions extends ContractV2BaseOptions {
+    readonly onUnauthorized?: () => void;
+}
+export declare function createPublicClient(options?: PublicClientOptions): import("openapi-fetch").Client<PublicContractV2Paths, `${string}/${string}`>;
+export interface DashboardV2ClientOptions {
+    readonly baseUrl?: string;
+    readonly allowInsecureLoopbackForDevelopment?: boolean;
+    readonly csrfToken: () => string | undefined;
+    readonly requestId?: () => string;
+    readonly expectedProviderBindingId?: (selection: Readonly<ProviderBindingRotationSelection>) => string | undefined;
+    readonly onUnauthorized?: () => void;
+    readonly fetch?: typeof globalThis.fetch;
+    readonly timeoutMs?: number;
+}
+export declare function createDashboardV2Client(options: DashboardV2ClientOptions): import("openapi-fetch").Client<DashboardContractV2Paths, `${string}/${string}`>;
+interface PartnerClientBaseOptions extends ContractV2BaseOptions {
+    readonly baseUrl: string;
+    readonly correlationId?: () => string | undefined;
+}
+export type PartnerClientOptions = PartnerClientBaseOptions & (Readonly<{
+    serviceKey: () => string;
+    bearer?: never;
+}> | Readonly<{
+    bearer: () => string;
+    serviceKey?: never;
+}>);
+export declare function createPartnerClient(options: PartnerClientOptions): import("openapi-fetch").Client<PartnerContractV2Paths, `${string}/${string}`>;
+export interface AgentBootstrapClientOptions extends ContractV2BaseOptions {
+    readonly baseUrl: string;
+}
+export declare function createAgentBootstrapClient(options: AgentBootstrapClientOptions): import("openapi-fetch").Client<AgentBootstrapContractV2Paths, `${string}/${string}`>;
+export declare const createDashboardContractClient: typeof createDashboardV2Client;
+export declare const createOxStudioClient: typeof createPartnerClient;
+export type PublicClient = ReturnType<typeof createPublicClient>;
+export type DashboardV2Client = ReturnType<typeof createDashboardV2Client>;
+export type DashboardContractClient = DashboardV2Client;
+export type PartnerClient = ReturnType<typeof createPartnerClient>;
+export type OxStudioClient = PartnerClient;
+export type AgentBootstrapClient = ReturnType<typeof createAgentBootstrapClient>;
+export {};