@teamlearners/clawops 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,549 @@
+import { z } from 'zod';
+
+interface APIClientOptions {
+    apiKey: string;
+    baseURL?: string;
+    timeout?: number;
+    maxRetries?: number;
+    fetch?: typeof globalThis.fetch;
+    defaultHeaders?: Record<string, string>;
+}
+declare class APIClient {
+    protected _apiKey: string;
+    protected _baseURL: string;
+    protected _maxRetries: number;
+    protected _timeout: number;
+    protected _fetch: typeof globalThis.fetch;
+    protected _defaultHeaders: Record<string, string>;
+    constructor(options: APIClientOptions);
+    private _buildHeaders;
+    protected _request<T>(method: string, path: string, options?: {
+        body?: Record<string, unknown> | null;
+        query?: Record<string, unknown> | null;
+        castTo?: z.ZodType<T>;
+        extraHeaders?: Record<string, string>;
+        extraQuery?: Record<string, unknown>;
+        timeout?: number;
+    }): Promise<T | null>;
+    private _shouldRetry;
+    private _retryDelay;
+    private _sleep;
+    _get<T>(path: string, options: {
+        castTo: z.ZodType<T>;
+        query?: Record<string, unknown> | null;
+        extraHeaders?: Record<string, string>;
+        extraQuery?: Record<string, unknown>;
+        timeout?: number;
+    }): Promise<T>;
+    _post<T>(path: string, options: {
+        body?: Record<string, unknown> | null;
+        castTo: z.ZodType<T>;
+        extraHeaders?: Record<string, string>;
+        extraQuery?: Record<string, unknown>;
+        timeout?: number;
+    }): Promise<T>;
+    _put<T>(path: string, options: {
+        body?: Record<string, unknown> | null;
+        castTo: z.ZodType<T>;
+        extraHeaders?: Record<string, string>;
+        extraQuery?: Record<string, unknown>;
+        timeout?: number;
+    }): Promise<T>;
+    _delete(path: string, options?: {
+        extraHeaders?: Record<string, string>;
+        timeout?: number;
+    }): Promise<void>;
+}
+
+declare class APIResource {
+    protected _client: APIClient;
+    protected _accountId: string;
+    constructor(client: APIClient, accountId: string);
+    protected get _basePath(): string;
+}
+
+declare class Page<T> {
+    data: T[];
+    meta: {
+        total: number;
+        page: number;
+        pageSize: number;
+    };
+    private _client;
+    private _path;
+    private _itemSchema;
+    private _query;
+    constructor(data: T[], meta: {
+        total: number;
+        page: number;
+        pageSize: number;
+    });
+    /** @internal */
+    _setClient(client: APIClient, path: string, itemSchema: z.ZodType<T>, query: Record<string, unknown>): void;
+    hasNextPage(): boolean;
+    nextPage(): Promise<Page<T>>;
+    [Symbol.iterator](): Iterator<T>;
+    autoPagingIter(): AsyncGenerator<T>;
+}
+
+declare const CallSchema: z.ZodObject<{
+    callId: z.ZodString;
+    status: z.ZodEnum<["queued", "ringing", "in-progress", "completed", "failed"]>;
+    to: z.ZodString;
+    from: z.ZodString;
+    direction: z.ZodEnum<["outbound", "inbound"]>;
+    duration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    accountId: z.ZodString;
+    dateCreated: z.ZodString;
+    dateUpdated: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    callId: z.ZodString;
+    status: z.ZodEnum<["queued", "ringing", "in-progress", "completed", "failed"]>;
+    to: z.ZodString;
+    from: z.ZodString;
+    direction: z.ZodEnum<["outbound", "inbound"]>;
+    duration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    accountId: z.ZodString;
+    dateCreated: z.ZodString;
+    dateUpdated: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    callId: z.ZodString;
+    status: z.ZodEnum<["queued", "ringing", "in-progress", "completed", "failed"]>;
+    to: z.ZodString;
+    from: z.ZodString;
+    direction: z.ZodEnum<["outbound", "inbound"]>;
+    duration: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    accountId: z.ZodString;
+    dateCreated: z.ZodString;
+    dateUpdated: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.ZodTypeAny, "passthrough">>;
+type Call = z.infer<typeof CallSchema>;
+declare const CallControlResponseSchema: z.ZodObject<{
+    callId: z.ZodString;
+    status: z.ZodString;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    callId: z.ZodString;
+    status: z.ZodString;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    callId: z.ZodString;
+    status: z.ZodString;
+}, z.ZodTypeAny, "passthrough">>;
+type CallControlResponse = z.infer<typeof CallControlResponseSchema>;
+
+interface CallCreateParams {
+    to: string;
+    from: string;
+    url: string;
+    statusCallback?: string;
+    statusCallbackEvent?: string;
+}
+interface CallListParams {
+    status?: 'queued' | 'ringing' | 'in-progress' | 'completed' | 'failed';
+    page?: number;
+    pageSize?: number;
+}
+interface CallUpdateParams {
+    status?: 'completed';
+}
+
+declare class Calls extends APIResource {
+    create(params: CallCreateParams, options?: {
+        extraHeaders?: Record<string, string>;
+        extraQuery?: Record<string, unknown>;
+        timeout?: number;
+    }): Promise<Call>;
+    list(params?: CallListParams, options?: {
+        extraHeaders?: Record<string, string>;
+        extraQuery?: Record<string, unknown>;
+        timeout?: number;
+    }): Promise<Page<Call>>;
+    get(callId: string, options?: {
+        extraHeaders?: Record<string, string>;
+        extraQuery?: Record<string, unknown>;
+        timeout?: number;
+    }): Promise<Call>;
+    update(callId: string, params?: {
+        status?: 'completed';
+    }, options?: {
+        extraHeaders?: Record<string, string>;
+        extraQuery?: Record<string, unknown>;
+        timeout?: number;
+    }): Promise<CallControlResponse>;
+}
+
+declare const MessageSchema: z.ZodObject<{
+    messageId: z.ZodString;
+    status: z.ZodEnum<["queued", "sending", "sent", "failed", "received"]>;
+    type: z.ZodEnum<["sms", "mms", "rcs", "kakao"]>;
+    to: z.ZodString;
+    from: z.ZodString;
+    body: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    direction: z.ZodEnum<["outbound", "inbound"]>;
+    accountId: z.ZodString;
+    dateCreated: z.ZodString;
+    dateUpdated: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    messageId: z.ZodString;
+    status: z.ZodEnum<["queued", "sending", "sent", "failed", "received"]>;
+    type: z.ZodEnum<["sms", "mms", "rcs", "kakao"]>;
+    to: z.ZodString;
+    from: z.ZodString;
+    body: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    direction: z.ZodEnum<["outbound", "inbound"]>;
+    accountId: z.ZodString;
+    dateCreated: z.ZodString;
+    dateUpdated: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    messageId: z.ZodString;
+    status: z.ZodEnum<["queued", "sending", "sent", "failed", "received"]>;
+    type: z.ZodEnum<["sms", "mms", "rcs", "kakao"]>;
+    to: z.ZodString;
+    from: z.ZodString;
+    body: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    direction: z.ZodEnum<["outbound", "inbound"]>;
+    accountId: z.ZodString;
+    dateCreated: z.ZodString;
+    dateUpdated: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.ZodTypeAny, "passthrough">>;
+type Message = z.infer<typeof MessageSchema>;
+
+interface MessageCreateParams {
+    to: string;
+    from: string;
+    body: string;
+    type?: 'sms' | 'mms' | 'rcs' | 'kakao';
+    subject?: string;
+}
+interface MessageListParams {
+    type?: 'sms' | 'mms' | 'rcs' | 'kakao';
+    status?: 'queued' | 'sending' | 'sent' | 'failed' | 'received';
+    page?: number;
+    pageSize?: number;
+}
+
+declare class Messages extends APIResource {
+    create(params: MessageCreateParams, options?: {
+        extraHeaders?: Record<string, string>;
+        extraQuery?: Record<string, unknown>;
+        timeout?: number;
+    }): Promise<Message>;
+    list(params?: MessageListParams, options?: {
+        extraHeaders?: Record<string, string>;
+        extraQuery?: Record<string, unknown>;
+        timeout?: number;
+    }): Promise<Page<Message>>;
+    get(messageId: string, options?: {
+        extraHeaders?: Record<string, string>;
+        extraQuery?: Record<string, unknown>;
+        timeout?: number;
+    }): Promise<Message>;
+}
+
+declare const PhoneNumberSchema: z.ZodObject<{
+    number: z.ZodString;
+    source: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    webhookUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    webhookMethod: z.ZodOptional<z.ZodNullable<z.ZodEnum<["POST", "GET"]>>>;
+    createdAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    number: z.ZodString;
+    source: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    webhookUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    webhookMethod: z.ZodOptional<z.ZodNullable<z.ZodEnum<["POST", "GET"]>>>;
+    createdAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    number: z.ZodString;
+    source: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    webhookUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    webhookMethod: z.ZodOptional<z.ZodNullable<z.ZodEnum<["POST", "GET"]>>>;
+    createdAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.ZodTypeAny, "passthrough">>;
+type PhoneNumber = z.infer<typeof PhoneNumberSchema>;
+type NumberListItem = PhoneNumber;
+type NumberUpdateResponse = PhoneNumber;
+
+declare class Numbers extends APIResource {
+    create(params?: {
+        webhookUrl?: string;
+    }, options?: {
+        extraHeaders?: Record<string, string>;
+        extraQuery?: Record<string, unknown>;
+        timeout?: number;
+    }): Promise<PhoneNumber>;
+    list(options?: {
+        extraHeaders?: Record<string, string>;
+        extraQuery?: Record<string, unknown>;
+        timeout?: number;
+    }): Promise<NumberListItem[]>;
+    update(number: string, params?: {
+        webhookUrl?: string;
+        webhookMethod?: 'POST' | 'GET';
+    }, options?: {
+        extraHeaders?: Record<string, string>;
+        extraQuery?: Record<string, unknown>;
+        timeout?: number;
+    }): Promise<NumberUpdateResponse>;
+    delete(number: string, options?: {
+        extraHeaders?: Record<string, string>;
+        timeout?: number;
+    }): Promise<void>;
+}
+
+declare const WebhookLogSchema: z.ZodObject<{
+    id: z.ZodString;
+    webhookId: z.ZodString;
+    event: z.ZodString;
+    requestUrl: z.ZodString;
+    requestPayload: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    responseStatus: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    responseBody: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    responseTimeMs: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    status: z.ZodEnum<["pending", "delivered", "failed"]>;
+    attempt: z.ZodNumber;
+    maxAttempts: z.ZodNumber;
+    createdAt: z.ZodString;
+    completedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    id: z.ZodString;
+    webhookId: z.ZodString;
+    event: z.ZodString;
+    requestUrl: z.ZodString;
+    requestPayload: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    responseStatus: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    responseBody: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    responseTimeMs: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    status: z.ZodEnum<["pending", "delivered", "failed"]>;
+    attempt: z.ZodNumber;
+    maxAttempts: z.ZodNumber;
+    createdAt: z.ZodString;
+    completedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    id: z.ZodString;
+    webhookId: z.ZodString;
+    event: z.ZodString;
+    requestUrl: z.ZodString;
+    requestPayload: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    responseStatus: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    responseBody: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    responseTimeMs: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    status: z.ZodEnum<["pending", "delivered", "failed"]>;
+    attempt: z.ZodNumber;
+    maxAttempts: z.ZodNumber;
+    createdAt: z.ZodString;
+    completedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.ZodTypeAny, "passthrough">>;
+type WebhookLog = z.infer<typeof WebhookLogSchema>;
+
+declare class WebhookLogs extends APIResource {
+    list(webhookId: string, params?: {
+        page?: number;
+        pageSize?: number;
+    }, options?: {
+        extraHeaders?: Record<string, string>;
+        extraQuery?: Record<string, unknown>;
+        timeout?: number;
+    }): Promise<Page<WebhookLog>>;
+}
+
+declare class AccountContext {
+    private _client;
+    private _accountId;
+    constructor(client: APIClient, accountId: string);
+    get calls(): Calls;
+    get messages(): Messages;
+    get numbers(): Numbers;
+    get webhookLogs(): WebhookLogs;
+}
+
+declare class ClawOpsError extends Error {
+    constructor(message: string);
+}
+declare class APIError extends ClawOpsError {
+    readonly request: {
+        method: string;
+        url: string;
+    };
+    constructor(message: string, request: {
+        method: string;
+        url: string;
+    });
+}
+declare class APIStatusError extends APIError {
+    readonly status: number;
+    readonly body: unknown;
+    readonly headers: Headers | undefined;
+    constructor(message: string, response: {
+        status: number;
+        headers?: Headers;
+    }, body: unknown, request: {
+        method: string;
+        url: string;
+    });
+}
+declare class BadRequestError extends APIStatusError {
+    readonly status: 400;
+    constructor(message: string, response: {
+        status: number;
+        headers?: Headers;
+    }, body: unknown, request: {
+        method: string;
+        url: string;
+    });
+}
+declare class AuthenticationError extends APIStatusError {
+    readonly status: 401;
+    constructor(message: string, response: {
+        status: number;
+        headers?: Headers;
+    }, body: unknown, request: {
+        method: string;
+        url: string;
+    });
+}
+declare class PermissionDeniedError extends APIStatusError {
+    readonly status: 403;
+    constructor(message: string, response: {
+        status: number;
+        headers?: Headers;
+    }, body: unknown, request: {
+        method: string;
+        url: string;
+    });
+}
+declare class NotFoundError extends APIStatusError {
+    readonly status: 404;
+    constructor(message: string, response: {
+        status: number;
+        headers?: Headers;
+    }, body: unknown, request: {
+        method: string;
+        url: string;
+    });
+}
+declare class ConflictError extends APIStatusError {
+    readonly status: 409;
+    constructor(message: string, response: {
+        status: number;
+        headers?: Headers;
+    }, body: unknown, request: {
+        method: string;
+        url: string;
+    });
+}
+declare class UnprocessableEntityError extends APIStatusError {
+    readonly status: 422;
+    constructor(message: string, response: {
+        status: number;
+        headers?: Headers;
+    }, body: unknown, request: {
+        method: string;
+        url: string;
+    });
+}
+declare class InternalServerError extends APIStatusError {
+    readonly status: 500;
+    constructor(message: string, response: {
+        status: number;
+        headers?: Headers;
+    }, body: unknown, request: {
+        method: string;
+        url: string;
+    });
+}
+declare class ServiceUnavailableError extends APIStatusError {
+    readonly status: 503;
+    constructor(message: string, response: {
+        status: number;
+        headers?: Headers;
+    }, body: unknown, request: {
+        method: string;
+        url: string;
+    });
+}
+declare class APIConnectionError extends APIError {
+    constructor(request: {
+        method: string;
+        url: string;
+    }, message?: string);
+}
+declare class APITimeoutError extends APIConnectionError {
+    constructor(request: {
+        method: string;
+        url: string;
+    });
+}
+declare class APIResponseValidationError extends APIError {
+    readonly status: number;
+    constructor(response: {
+        status: number;
+    }, request: {
+        method: string;
+        url: string;
+    });
+}
+declare class AgentError extends ClawOpsError {
+    constructor(message: string);
+}
+declare class AgentConnectionError extends AgentError {
+    constructor(message?: string);
+}
+
+declare class WebhookVerificationError extends ClawOpsError {
+    constructor(message?: string);
+}
+declare class Webhooks {
+    verify(options: {
+        url: string;
+        params: Record<string, string>;
+        signature: string;
+        signingKey: string;
+    }): boolean;
+    static _computeSignature(url: string, params: Record<string, string>, signingKey: string): string;
+}
+
+interface ClawOpsOptions {
+    apiKey?: string;
+    accountId?: string;
+    baseURL?: string;
+    timeout?: number;
+    maxRetries?: number;
+    fetch?: typeof globalThis.fetch;
+    defaultHeaders?: Record<string, string>;
+}
+declare class ClawOps extends APIClient {
+    private _defaultAccountId;
+    constructor(options?: ClawOpsOptions);
+    get calls(): Calls;
+    get messages(): Messages;
+    get numbers(): Numbers;
+    get webhookLogs(): WebhookLogs;
+    get webhooks(): Webhooks;
+    accounts(accountId: string): AccountContext;
+}
+
+declare const VERSION = "0.1.0";
+
+declare const PaginationMetaSchema: z.ZodObject<{
+    total: z.ZodNumber;
+    page: z.ZodNumber;
+    pageSize: z.ZodNumber;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    total: z.ZodNumber;
+    page: z.ZodNumber;
+    pageSize: z.ZodNumber;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    total: z.ZodNumber;
+    page: z.ZodNumber;
+    pageSize: z.ZodNumber;
+}, z.ZodTypeAny, "passthrough">>;
+type PaginationMeta = z.infer<typeof PaginationMetaSchema>;
+
+interface NumberCreateParams {
+    webhookUrl?: string;
+}
+interface NumberUpdateParams {
+    webhookUrl?: string;
+    webhookMethod?: 'POST' | 'GET';
+}
+
+export { APIClient, type APIClientOptions, APIConnectionError, APIError, APIResponseValidationError, APIStatusError, APITimeoutError, AccountContext, AgentConnectionError, AgentError, AuthenticationError, BadRequestError, type Call, type CallControlResponse, type CallCreateParams, type CallListParams, type CallUpdateParams, Calls, ClawOps, ClawOpsError, type ClawOpsOptions, ConflictError, InternalServerError, type Message, type MessageCreateParams, type MessageListParams, Messages, NotFoundError, type NumberCreateParams, type NumberListItem, type NumberUpdateParams, type NumberUpdateResponse, Numbers, Page, type PaginationMeta, PermissionDeniedError, type PhoneNumber, ServiceUnavailableError, UnprocessableEntityError, VERSION, type WebhookLog, WebhookLogs, WebhookVerificationError, Webhooks, ClawOps as default };