@zdrops/ai-assistants-sdk 1.1.0

package/dist/index.d.ts

@@ -0,0 +1,551 @@
+interface components {
+    schemas: {
+        RegisterDto: {
+            /** @example user@example.com */
+            email: string;
+            /** @example John */
+            firstName: string;
+            /** @example Doe */
+            lastName: string;
+        };
+        MessageResponseDto: {
+            message: string;
+        };
+        LoginDto: {
+            /** @example user@example.com */
+            email: string;
+        };
+        /** @enum {string} */
+        OtpType: "registration" | "login" | "email_change";
+        VerifyOtpDto: {
+            /** @example user@example.com */
+            email: string;
+            /** @example 123456 */
+            code: string;
+            /** @example login */
+            type: components["schemas"]["OtpType"];
+        };
+        /** @enum {string} */
+        UserRole: "user" | "admin";
+        UserResponseDto: {
+            /** Format: uuid */
+            id: string;
+            /** @example user@example.com */
+            email: string;
+            /** @example John */
+            firstName: Record<string, never> | null;
+            /** @example Doe */
+            lastName: Record<string, never> | null;
+            role: components["schemas"]["UserRole"];
+            /** Format: date-time */
+            createdAt: string;
+            /** Format: date-time */
+            updatedAt: string;
+        };
+        AuthResponseDto: {
+            accessToken: string;
+            refreshToken: string;
+            user: components["schemas"]["UserResponseDto"];
+            /** @description True if the user was just created and has no profile yet */
+            isNewUser: boolean;
+        };
+        GoogleAuthDto: {
+            /** @description Google ID token from frontend Sign-In */
+            idToken: string;
+        };
+        RefreshTokenDto: {
+            refreshToken: string;
+        };
+        TokensResponseDto: {
+            accessToken: string;
+            refreshToken: string;
+        };
+        UpdateProfileDto: {
+            /** @example John */
+            firstName?: string;
+            /** @example Doe */
+            lastName?: string;
+        };
+        RequestEmailChangeDto: {
+            /** @example new@example.com */
+            newEmail: string;
+        };
+        ConfirmEmailChangeDto: {
+            /** @example 123456 */
+            code: string;
+            /** @example new@example.com */
+            newEmail: string;
+        };
+        /** @enum {string} */
+        PlanType: "one_time";
+        PlanResponseDto: {
+            /** Format: uuid */
+            id: string;
+            /** Format: date-time */
+            createdAt: string;
+            /** Format: date-time */
+            updatedAt: string;
+            /** @example Pro Plan */
+            name: string;
+            /** @example Best plan for professionals */
+            description: Record<string, never> | null;
+            type: components["schemas"]["PlanType"];
+            /** @example 100 */
+            credits: number;
+            /** @example 999 */
+            priceCents: number;
+            /** @example usd */
+            currency: string;
+            isActive: boolean;
+            /** @example 0 */
+            sortOrder: number;
+            /**
+             * @example {
+             *       "feature": "unlimited"
+             *     }
+             */
+            metadata?: Record<string, never>;
+        };
+        CreditBalanceResponseDto: {
+            /** @example 500 */
+            balance: number;
+        };
+        /** @enum {string} */
+        CreditTransactionType: "purchase" | "welcome" | "deduction" | "refund" | "adjustment";
+        CreditTransactionResponseDto: {
+            /** Format: uuid */
+            id: string;
+            /** Format: date-time */
+            createdAt: string;
+            /** Format: date-time */
+            updatedAt: string;
+            /** Format: uuid */
+            userId: string;
+            type: components["schemas"]["CreditTransactionType"];
+            /** @example 100 */
+            amount: number;
+            /** @example 600 */
+            balanceAfter: number;
+            referenceType: Record<string, never> | null;
+            /** Format: uuid */
+            referenceId: Record<string, never> | null;
+            description: Record<string, never> | null;
+        };
+        PurchaseCreditsDto: {
+            /** Format: uuid */
+            planId: string;
+        };
+        CreditBalanceEntityResponseDto: {
+            /** Format: uuid */
+            id: string;
+            /** Format: date-time */
+            createdAt: string;
+            /** Format: date-time */
+            updatedAt: string;
+            /** Format: uuid */
+            userId: string;
+            /** @example 500 */
+            balance: number;
+        };
+        PurchaseCreditsResponseDto: {
+            transaction: components["schemas"]["CreditTransactionResponseDto"];
+            balance: components["schemas"]["CreditBalanceEntityResponseDto"];
+        };
+        BillingResponseDto: {
+            /** Format: uuid */
+            id: string;
+            /** Format: date-time */
+            createdAt: string;
+            /** Format: date-time */
+            updatedAt: string;
+            /** @example John */
+            firstName: string;
+            /** @example Doe */
+            lastName: string;
+            /** @example Acme Inc. */
+            companyName?: Record<string, never> | null;
+            /** @example US123456789 */
+            taxId?: Record<string, never> | null;
+            /** @example 123 Main St */
+            street: string;
+            /** @example Suite 100 */
+            street2?: Record<string, never> | null;
+            /** @example New York */
+            city: string;
+            /** @example NY */
+            state?: Record<string, never> | null;
+            /** @example 10001 */
+            postalCode: string;
+            /**
+             * @description ISO 3166-1 alpha-2 country code
+             * @example US
+             */
+            country: string;
+            /** @example +1-555-123-4567 */
+            phone?: Record<string, never> | null;
+        };
+        UpsertBillingDto: {
+            /** @example John */
+            firstName: string;
+            /** @example Doe */
+            lastName: string;
+            /** @example Acme Inc. */
+            companyName?: string;
+            /** @example US123456789 */
+            taxId?: string;
+            /** @example 123 Main St */
+            street: string;
+            /** @example Suite 100 */
+            street2?: string;
+            /** @example New York */
+            city: string;
+            /** @example NY */
+            state?: string;
+            /** @example 10001 */
+            postalCode: string;
+            /**
+             * @description ISO 3166-1 alpha-2 country code
+             * @example US
+             */
+            country: string;
+            /** @example +1-555-123-4567 */
+            phone?: string;
+        };
+        PreferenceResponseDto: {
+            /** @example travel */
+            appKey: string;
+            /**
+             * @example {
+             *       "theme": "dark",
+             *       "language": "en"
+             *     }
+             */
+            preferences: Record<string, never>;
+            /** Format: date-time */
+            createdAt: string;
+            /** Format: date-time */
+            updatedAt: string;
+        };
+        UpdatePreferencesDto: {
+            /**
+             * @example {
+             *       "theme": "dark",
+             *       "language": "en"
+             *     }
+             */
+            preferences: Record<string, never>;
+        };
+        CreateConversationDto: {
+            title?: string;
+            /** @example travel */
+            appKey: string;
+            metadata?: Record<string, never>;
+        };
+        ConversationResponseDto: {
+            /** Format: uuid */
+            id: string;
+            /** Format: date-time */
+            createdAt: string;
+            /** Format: date-time */
+            updatedAt: string;
+            /** Format: uuid */
+            userId: string;
+            title?: Record<string, never> | null;
+            /** @example travel */
+            appKey: string;
+            /** @enum {string} */
+            status: "active" | "archived";
+            metadata: Record<string, never>;
+            lastMessageAt?: Record<string, never> | null;
+            /** @description Base64-encoded hero image data */
+            heroImageData?: Record<string, never> | null;
+            /** @description MIME type of the hero image */
+            heroMimeType?: Record<string, never> | null;
+        };
+        AddMessageDto: {
+            content: string;
+            metadata?: Record<string, never>;
+        };
+        ConversationMessageResponseDto: {
+            /** Format: uuid */
+            id: string;
+            /** Format: date-time */
+            createdAt: string;
+            /** Format: date-time */
+            updatedAt: string;
+            /** Format: uuid */
+            conversationId: string;
+            /** @enum {string} */
+            role: "user" | "assistant" | "system";
+            content: string;
+            metadata: Record<string, never>;
+            tokenCount?: Record<string, never> | null;
+        };
+        GenerateDto: {
+            content: string;
+            /** @default false */
+            isRefinement: boolean;
+            /** @example en */
+            locale?: string;
+        };
+        TriggerImageDto: {
+            /** @example hero */
+            slot: string;
+            /** @example Soft watercolour sketch of Reykjavik harbour, warm golden light */
+            prompt: string;
+        };
+        ImageStatusResponseDto: {
+            /** Format: uuid */
+            id: string;
+            /** Format: date-time */
+            createdAt: string;
+            /** Format: date-time */
+            updatedAt: string;
+            /** Format: uuid */
+            messageId: string;
+            /** @example hero */
+            slot: string;
+            /** @enum {string} */
+            status: "idle" | "generating" | "ready" | "failed";
+            prompt: string;
+            imageData?: Record<string, never> | null;
+            mimeType?: Record<string, never> | null;
+            error?: Record<string, never> | null;
+            attempts: number;
+        };
+        CreateCheckoutDto: {
+            /** Format: uuid */
+            planId: string;
+            /** @example https://app.example.com/payment/success */
+            returnUrl: string;
+            /** @example https://app.example.com/payment/cancel */
+            cancelUrl: string;
+        };
+        CheckoutResponseDto: {
+            /** Format: uuid */
+            paymentId: string;
+            /** @example https://pay.whitegallo.com/session/xyz */
+            redirectUrl: string;
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+
+type RegisterDto = components["schemas"]["RegisterDto"];
+type LoginDto = components["schemas"]["LoginDto"];
+type VerifyOtpDto = components["schemas"]["VerifyOtpDto"];
+type RefreshTokenDto = components["schemas"]["RefreshTokenDto"];
+type UpdateProfileDto = components["schemas"]["UpdateProfileDto"];
+type RequestEmailChangeDto = components["schemas"]["RequestEmailChangeDto"];
+type ConfirmEmailChangeDto = components["schemas"]["ConfirmEmailChangeDto"];
+type PurchaseCreditsDto = components["schemas"]["PurchaseCreditsDto"];
+type UpsertBillingDto = components["schemas"]["UpsertBillingDto"];
+type UpdatePreferencesDto = components["schemas"]["UpdatePreferencesDto"];
+type CreateConversationDto = components["schemas"]["CreateConversationDto"];
+type AddMessageDto = components["schemas"]["AddMessageDto"];
+type GenerateDto = components["schemas"]["GenerateDto"];
+type TriggerImageDto = components["schemas"]["TriggerImageDto"];
+type CreateCheckoutDto = components["schemas"]["CreateCheckoutDto"];
+type MessageResponseDto = components["schemas"]["MessageResponseDto"];
+type StartAuthResponseDto = MessageResponseDto & {
+    type: OtpType;
+};
+type AuthResponseDto = components["schemas"]["AuthResponseDto"];
+type TokensResponseDto = components["schemas"]["TokensResponseDto"];
+type UserResponseDto = components["schemas"]["UserResponseDto"];
+type PlanResponseDto = components["schemas"]["PlanResponseDto"];
+type CreditBalanceResponseDto = components["schemas"]["CreditBalanceResponseDto"];
+type CreditTransactionResponseDto = components["schemas"]["CreditTransactionResponseDto"];
+type PurchaseCreditsResponseDto = components["schemas"]["PurchaseCreditsResponseDto"];
+type CreditBalanceEntityResponseDto = components["schemas"]["CreditBalanceEntityResponseDto"];
+type BillingResponseDto = components["schemas"]["BillingResponseDto"];
+type PreferenceResponseDto = components["schemas"]["PreferenceResponseDto"];
+type ConversationResponseDto = components["schemas"]["ConversationResponseDto"] & {
+    heroImageData?: string | null;
+    heroMimeType?: string | null;
+};
+type ConversationMessageResponseDto = components["schemas"]["ConversationMessageResponseDto"];
+type ImageStatusResponseDto = components["schemas"]["ImageStatusResponseDto"];
+type CheckoutResponseDto = components["schemas"]["CheckoutResponseDto"];
+type OtpType = components["schemas"]["OtpType"];
+type UserRole = components["schemas"]["UserRole"];
+type PlanType = components["schemas"]["PlanType"];
+type CreditTransactionType = components["schemas"]["CreditTransactionType"];
+type ConversationStatus = ConversationResponseDto["status"];
+type MessageRole = ConversationMessageResponseDto["role"];
+type ImageGenerationStatus = ImageStatusResponseDto["status"];
+
+interface HttpClientConfig {
+    baseUrl: string;
+    tenantKey: string;
+    getAccessToken: () => string | null;
+    getRefreshToken: () => string | null;
+    onTokenRefreshed: (tokens: TokensResponseDto) => void | Promise<void>;
+    fetch?: typeof globalThis.fetch;
+}
+type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+interface RequestOptions {
+    body?: unknown;
+    query?: Record<string, string | number | boolean | undefined | null>;
+    authenticated?: boolean;
+}
+declare class HttpClient {
+    private config;
+    private refreshPromise;
+    private readonly baseUrl;
+    private readonly fetchFn;
+    constructor(config: HttpClientConfig);
+    private buildAndFetch;
+    private throwIfError;
+    private request;
+    private attemptTokenRefresh;
+    private doRefresh;
+    get<T>(path: string, options?: RequestOptions): Promise<T>;
+    post<T>(path: string, body?: unknown, options?: Omit<RequestOptions, "body">): Promise<T>;
+    patch<T>(path: string, body?: unknown, options?: Omit<RequestOptions, "body">): Promise<T>;
+    put<T>(path: string, body?: unknown, options?: Omit<RequestOptions, "body">): Promise<T>;
+    delete<T>(path: string, options?: RequestOptions): Promise<T>;
+    rawRequest(method: HttpMethod, path: string, options?: RequestOptions): Promise<Response>;
+}
+
+declare class AuthResource {
+    private http;
+    constructor(http: HttpClient);
+    register(data: RegisterDto): Promise<MessageResponseDto>;
+    login(data: LoginDto): Promise<MessageResponseDto>;
+    startAuth(data: LoginDto): Promise<StartAuthResponseDto>;
+    verifyOtp(data: VerifyOtpDto): Promise<AuthResponseDto>;
+    refresh(data: RefreshTokenDto): Promise<TokensResponseDto>;
+    logout(): Promise<void>;
+    getProfile(): Promise<UserResponseDto>;
+    updateProfile(data: UpdateProfileDto): Promise<UserResponseDto>;
+    deleteAccount(): Promise<void>;
+    requestEmailChange(data: RequestEmailChangeDto): Promise<MessageResponseDto>;
+    confirmEmailChange(data: ConfirmEmailChangeDto): Promise<MessageResponseDto>;
+}
+
+declare class PlansResource {
+    private http;
+    constructor(http: HttpClient);
+    list(query?: {
+        type?: PlanType;
+    }): Promise<PlanResponseDto[]>;
+}
+
+declare class CreditsResource {
+    private http;
+    constructor(http: HttpClient);
+    getBalance(): Promise<CreditBalanceResponseDto>;
+    getTransactions(query?: {
+        cursor?: string;
+        limit?: number;
+        type?: CreditTransactionType;
+    }): Promise<CreditTransactionResponseDto[]>;
+    purchase(data: PurchaseCreditsDto): Promise<PurchaseCreditsResponseDto>;
+}
+
+declare class BillingResource {
+    private http;
+    constructor(http: HttpClient);
+    get(): Promise<BillingResponseDto>;
+    upsert(data: UpsertBillingDto): Promise<BillingResponseDto>;
+}
+
+declare class PreferencesResource {
+    private http;
+    constructor(http: HttpClient);
+    getAll(): Promise<PreferenceResponseDto[]>;
+    getByAppKey(appKey: string): Promise<PreferenceResponseDto>;
+    upsert(appKey: string, data: UpdatePreferencesDto): Promise<PreferenceResponseDto>;
+    remove(appKey: string): Promise<void>;
+    merge(appKey: string, data: UpdatePreferencesDto): Promise<PreferenceResponseDto>;
+}
+
+declare class ConversationsResource {
+    private http;
+    constructor(http: HttpClient);
+    create(data: CreateConversationDto): Promise<ConversationResponseDto>;
+    list(query?: {
+        cursor?: string;
+        limit?: number;
+        status?: ConversationStatus;
+        appKey?: string;
+    }): Promise<ConversationResponseDto[]>;
+    get(id: string): Promise<ConversationResponseDto>;
+    archive(id: string): Promise<ConversationResponseDto>;
+    listMessages(conversationId: string, query?: {
+        cursor?: string;
+        limit?: number;
+    }): Promise<ConversationMessageResponseDto[]>;
+    addMessage(conversationId: string, data: AddMessageDto): Promise<ConversationMessageResponseDto>;
+}
+
+interface GenerationDoneData {
+    messageId: string;
+    usage?: {
+        inputTokens: number;
+        outputTokens: number;
+    };
+    structuredOutput?: Record<string, unknown>;
+}
+interface SseStreamOptions {
+    onTextDelta?: (text: string) => void;
+    onDone?: (data: GenerationDoneData) => void;
+    onError?: (error: string) => void;
+    signal?: AbortSignal;
+}
+declare class GenerationResource {
+    private http;
+    constructor(http: HttpClient);
+    generate(conversationId: string, data: GenerateDto, options?: SseStreamOptions): Promise<string>;
+}
+
+declare class ImagesResource {
+    private http;
+    constructor(http: HttpClient);
+    trigger(messageId: string, data: TriggerImageDto): Promise<ImageStatusResponseDto>;
+    getAll(messageId: string): Promise<ImageStatusResponseDto[]>;
+    getBySlot(messageId: string, slot: string): Promise<ImageStatusResponseDto>;
+}
+
+declare class PaymentsResource {
+    private http;
+    constructor(http: HttpClient);
+    checkout(data: CreateCheckoutDto): Promise<CheckoutResponseDto>;
+}
+
+interface ClientOptions {
+    baseUrl: string;
+    tenantKey: string;
+    accessToken?: string;
+    refreshToken?: string;
+    onTokenRefreshed?: (tokens: TokensResponseDto) => void | Promise<void>;
+    fetch?: typeof globalThis.fetch;
+}
+interface AiAssistantsClient {
+    auth: AuthResource;
+    plans: PlansResource;
+    credits: CreditsResource;
+    billing: BillingResource;
+    preferences: PreferencesResource;
+    conversations: ConversationsResource;
+    generation: GenerationResource;
+    images: ImagesResource;
+    payments: PaymentsResource;
+    setAccessToken(token: string): void;
+    setRefreshToken(token: string): void;
+}
+declare function createClient(options: ClientOptions): AiAssistantsClient;
+
+declare class ApiError extends Error {
+    readonly statusCode: number;
+    readonly code: string;
+    readonly requestId?: string | undefined;
+    constructor(statusCode: number, code: string, message: string | string[], requestId?: string | undefined);
+}
+
+export { type AddMessageDto, type AiAssistantsClient, ApiError, type AuthResponseDto, type BillingResponseDto, type CheckoutResponseDto, type ClientOptions, type ConfirmEmailChangeDto, type ConversationMessageResponseDto, type ConversationResponseDto, type ConversationStatus, type CreateCheckoutDto, type CreateConversationDto, type CreditBalanceEntityResponseDto, type CreditBalanceResponseDto, type CreditTransactionResponseDto, type CreditTransactionType, type GenerateDto, type GenerationDoneData, type ImageGenerationStatus, type ImageStatusResponseDto, type LoginDto, type MessageResponseDto, type MessageRole, type OtpType, type PlanResponseDto, type PlanType, type PreferenceResponseDto, type PurchaseCreditsDto, type PurchaseCreditsResponseDto, type RefreshTokenDto, type RegisterDto, type RequestEmailChangeDto, type SseStreamOptions, type StartAuthResponseDto, type TokensResponseDto, type TriggerImageDto, type UpdatePreferencesDto, type UpdateProfileDto, type UpsertBillingDto, type UserResponseDto, type UserRole, type VerifyOtpDto, createClient };