@skyporch/daykeeper-react-native 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,682 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+interface paths {
+    "/v1/identity": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get widget-safe customer identity */
+        get: operations["getCustomerIdentity"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/conversations": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** List the customer's conversations */
+        get: operations["listCustomerConversations"];
+        put?: never;
+        /** Create a customer conversation */
+        post: operations["createCustomerConversation"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/unread": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get customer-side unread state
+         * @description This read does not create a contact when the customer has never used support.
+         */
+        get: operations["getCustomerUnread"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/conversations/{conversationId}/seen": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                conversationId: components["parameters"]["ConversationId"];
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Mark a customer conversation seen */
+        post: operations["markCustomerConversationSeen"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/conversations/{conversationId}/messages": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                conversationId: components["parameters"]["ConversationId"];
+            };
+            cookie?: never;
+        };
+        /**
+         * List visible messages in a customer conversation
+         * @description Private agent notes and activity records are never returned.
+         */
+        get: operations["listCustomerMessages"];
+        put?: never;
+        /** Send a customer message */
+        post: operations["sendCustomerMessage"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/anonymous-conversations/claim": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Claim a signed-out widget conversation after sign-in
+         * @description The widget token proves possession of the anonymous thread. The gateway
+         *     refuses identified, foreign-tenant, or email-mismatched contacts.
+         */
+        post: operations["claimAnonymousConversation"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/lifecycle-messages": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Deliver one idempotent lifecycle campaign message
+         * @description Requires a short-lived token with the support:lifecycle scope.
+         */
+        post: operations["deliverCustomerLifecycleMessage"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/contacts/erasure-preview": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Preview tenant-owned contacts selected for erasure
+         * @description Requires a short-lived support:erase token bound to the canonical target hash.
+         */
+        post: operations["previewCustomerErasure"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/contacts": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /**
+         * Erase tenant-owned customer contacts
+         * @description Requires a short-lived support:erase token bound to the canonical target hash.
+         */
+        delete: operations["eraseCustomers"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+interface components {
+    schemas: {
+        Conversation: {
+            id: number;
+            /** @enum {string} */
+            status: "open" | "pending" | "resolved" | "snoozed";
+            createdAt: number | string | null;
+            updatedAt: number | string | null;
+            /** @description Chatwoot agent-side unread count; do not use for a customer badge. */
+            unreadCount: number;
+            /** @description Customer-side unread count used for product badges. */
+            unreadForContact: number;
+            lastSeenAt: number | null;
+            preview: string | null;
+        };
+        Attachment: {
+            id: number;
+            fileType: string | null;
+            /** Format: uri */
+            dataUrl: string | null;
+            /** Format: uri */
+            thumbUrl: string | null;
+        };
+        Message: {
+            id: number;
+            conversationId: number;
+            content: string | null;
+            contentType: string;
+            contentAttributes: {
+                [key: string]: unknown;
+            };
+            messageType: number;
+            createdAt: number | string | null;
+            sender: components["schemas"]["MessageSender"] | null;
+            attachments: components["schemas"]["Attachment"][];
+        };
+        MessageSender: {
+            name: string | null;
+            /** Format: uri */
+            avatarUrl: string | null;
+        };
+        CustomerIdentity: {
+            /** Format: uri */
+            baseUrl: string;
+            websiteToken: string;
+            subject: string;
+            identifier: string;
+            identifierHash: string;
+            /** Format: email */
+            email: string | null;
+            name: string;
+        };
+        ConversationList: {
+            conversations: components["schemas"]["Conversation"][];
+            widgetConversationId: number | null;
+        };
+        ConversationResult: {
+            conversation: components["schemas"]["Conversation"];
+        };
+        UnreadSummary: {
+            unreadCount: number;
+            conversation: components["schemas"]["Conversation"] | null;
+            conversations: components["schemas"]["Conversation"][];
+        };
+        SeenResult: {
+            conversationId: number;
+            /** @constant */
+            seen: true;
+            seenAt: number;
+            seenMessageId?: number;
+        };
+        MessageList: {
+            messages: components["schemas"]["Message"][];
+        };
+        MessageResult: {
+            message: components["schemas"]["Message"];
+        };
+        SendMessageInput: {
+            content: string;
+        };
+        ClaimConversationInput: {
+            widgetToken: string;
+        };
+        ClaimConversationResult: {
+            /** @enum {string} */
+            status: "merged" | "already_claimed" | "already_identified" | "email_mismatch" | "foreign_contact" | "invalid_token" | "not_found";
+            conversations: number;
+        };
+        LifecycleMessageInput: {
+            /** @enum {string} */
+            campaign: "trial_day_1" | "trial_day_2" | "trial_day_6";
+        };
+        LifecycleMessageResult: {
+            /** @enum {string} */
+            campaign: "trial_day_1" | "trial_day_2" | "trial_day_6";
+            /** @enum {string} */
+            status: "delivered" | "already_delivered";
+            conversationId?: number | null;
+            /** Format: date-time */
+            deliveredAt?: string;
+            stamped?: boolean;
+        };
+        ErasureTarget: {
+            userId?: string | null;
+            /** Format: email */
+            email?: string | null;
+        } | unknown | unknown;
+        ErasureTargetsInput: {
+            targets: components["schemas"]["ErasureTarget"][];
+        };
+        ErasureSummary: {
+            attempted: number;
+            accepted: number;
+            verifiedAbsent: number;
+            failed: number;
+            dryRun?: boolean;
+            cascadeQueued?: boolean;
+            partialFailure?: boolean;
+        } & {
+            [key: string]: unknown;
+        };
+        CustomerError: {
+            error: string;
+        };
+    };
+    responses: {
+        /** @description Stable customer-safe error. Upstream provider text is never returned. */
+        Error: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["CustomerError"];
+            };
+        };
+    };
+    parameters: {
+        ConversationId: number;
+    };
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+interface operations {
+    getCustomerIdentity: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Widget-safe identity derived from the verified customer token. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CustomerIdentity"];
+                };
+            };
+            401: components["responses"]["Error"];
+            default: components["responses"]["Error"];
+        };
+    };
+    listCustomerConversations: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Customer-owned conversation summaries. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ConversationList"];
+                };
+            };
+            401: components["responses"]["Error"];
+            default: components["responses"]["Error"];
+        };
+    };
+    createCustomerConversation: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Newly created customer conversation. */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ConversationResult"];
+                };
+            };
+            401: components["responses"]["Error"];
+            default: components["responses"]["Error"];
+        };
+    };
+    getCustomerUnread: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Total unread messages and every unread thread, newest first. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["UnreadSummary"];
+                };
+            };
+            401: components["responses"]["Error"];
+            default: components["responses"]["Error"];
+        };
+    };
+    markCustomerConversationSeen: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                conversationId: components["parameters"]["ConversationId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Persisted customer-side seen marker. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SeenResult"];
+                };
+            };
+            401: components["responses"]["Error"];
+            default: components["responses"]["Error"];
+        };
+    };
+    listCustomerMessages: {
+        parameters: {
+            query?: {
+                /** @description Return messages with a larger monotonic identifier. */
+                after?: number;
+            };
+            header?: never;
+            path: {
+                conversationId: components["parameters"]["ConversationId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Visible customer conversation messages. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MessageList"];
+                };
+            };
+            401: components["responses"]["Error"];
+            default: components["responses"]["Error"];
+        };
+    };
+    sendCustomerMessage: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                conversationId: components["parameters"]["ConversationId"];
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["SendMessageInput"];
+            };
+        };
+        responses: {
+            /** @description Created customer message. */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MessageResult"];
+                };
+            };
+            401: components["responses"]["Error"];
+            default: components["responses"]["Error"];
+        };
+    };
+    claimAnonymousConversation: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["ClaimConversationInput"];
+            };
+        };
+        responses: {
+            /** @description Safe claim result; refusals are represented as explicit statuses. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ClaimConversationResult"];
+                };
+            };
+            401: components["responses"]["Error"];
+            default: components["responses"]["Error"];
+        };
+    };
+    deliverCustomerLifecycleMessage: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["LifecycleMessageInput"];
+            };
+        };
+        responses: {
+            /** @description Delivery or prior-delivery result. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LifecycleMessageResult"];
+                };
+            };
+            401: components["responses"]["Error"];
+            default: components["responses"]["Error"];
+        };
+    };
+    previewCustomerErasure: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["ErasureTargetsInput"];
+            };
+        };
+        responses: {
+            /** @description Read-only erasure preview. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErasureSummary"];
+                };
+            };
+            401: components["responses"]["Error"];
+            default: components["responses"]["Error"];
+        };
+    };
+    eraseCustomers: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["ErasureTargetsInput"];
+            };
+        };
+        responses: {
+            /** @description Verified contact absence and asynchronous cascade state. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErasureSummary"];
+                };
+            };
+            401: components["responses"]["Error"];
+            default: components["responses"]["Error"];
+        };
+    };
+}
+
+type Schemas = components["schemas"];
+type DaykeeperConversation = Schemas["Conversation"];
+type DaykeeperAttachment = Schemas["Attachment"];
+type DaykeeperMessage = Schemas["Message"];
+type DaykeeperMessageSender = Schemas["MessageSender"];
+type DaykeeperCustomerIdentity = Schemas["CustomerIdentity"];
+type DaykeeperConversationList = Schemas["ConversationList"];
+type DaykeeperConversationResult = Schemas["ConversationResult"];
+type DaykeeperUnreadSummary = Schemas["UnreadSummary"];
+type DaykeeperSeenResult = Schemas["SeenResult"];
+type DaykeeperMessageList = Schemas["MessageList"];
+type DaykeeperMessageResult = Schemas["MessageResult"];
+type DaykeeperClaimConversationResult = Schemas["ClaimConversationResult"];
+
+interface DaykeeperReactNativeTokenProviderContext {
+    /**
+     * True only after Daykeeper rejected the first token with HTTP 401. The
+     * provider should bypass any token cache and exchange the app session again.
+     */
+    forceRefresh: boolean;
+}
+type DaykeeperReactNativeTokenProvider = (context: DaykeeperReactNativeTokenProviderContext) => string | Promise<string>;
+interface DaykeeperReactNativeClientOptions {
+    baseUrl: string;
+    getAccessToken: DaykeeperReactNativeTokenProvider;
+    fetch?: typeof globalThis.fetch;
+    timeoutMs?: number;
+}
+interface DaykeeperReactNativeRequestOptions {
+    signal?: AbortSignal;
+}
+declare class DaykeeperReactNativeClient {
+    #private;
+    constructor(options: DaykeeperReactNativeClientOptions);
+    getIdentity(options?: DaykeeperReactNativeRequestOptions): Promise<DaykeeperCustomerIdentity>;
+    listConversations(options?: DaykeeperReactNativeRequestOptions): Promise<DaykeeperConversationList>;
+    createConversation(options?: DaykeeperReactNativeRequestOptions): Promise<DaykeeperConversationResult>;
+    getUnread(options?: DaykeeperReactNativeRequestOptions): Promise<DaykeeperUnreadSummary>;
+    markConversationSeen(conversationId: number, options?: DaykeeperReactNativeRequestOptions): Promise<DaykeeperSeenResult>;
+    listMessages(conversationId: number, options?: DaykeeperReactNativeRequestOptions & {
+        after?: number;
+    }): Promise<DaykeeperMessageList>;
+    sendMessage(conversationId: number, content: string, options?: DaykeeperReactNativeRequestOptions): Promise<DaykeeperMessageResult>;
+    claimAnonymousConversation(widgetToken: string, options?: DaykeeperReactNativeRequestOptions): Promise<DaykeeperClaimConversationResult>;
+}
+declare function createDaykeeperReactNativeClient(options: DaykeeperReactNativeClientOptions): DaykeeperReactNativeClient;
+
+type DaykeeperReactNativeTransportErrorCode = "INVALID_CONFIGURATION" | "NETWORK_ERROR" | "REQUEST_ABORTED" | "REQUEST_TIMEOUT" | "INVALID_RESPONSE" | "RESPONSE_TOO_LARGE";
+declare class DaykeeperReactNativeApiError extends Error {
+    readonly status: number;
+    readonly code: string;
+    readonly retryable: boolean;
+    constructor(options: {
+        status: number;
+        code: string;
+        retryable: boolean;
+    });
+    toJSON(): {
+        name: string;
+        status: number;
+        code: string;
+        retryable: boolean;
+    };
+}
+declare class DaykeeperReactNativeTransportError extends Error {
+    readonly code: DaykeeperReactNativeTransportErrorCode;
+    readonly retryable: boolean;
+    constructor(options: {
+        code: DaykeeperReactNativeTransportErrorCode;
+        message: string;
+        retryable?: boolean;
+    });
+    toJSON(): {
+        name: string;
+        code: DaykeeperReactNativeTransportErrorCode;
+        message: string;
+        retryable: boolean;
+    };
+}
+
+export { type DaykeeperAttachment, type DaykeeperClaimConversationResult, type DaykeeperConversation, type DaykeeperConversationList, type DaykeeperConversationResult, type DaykeeperCustomerIdentity, type components as DaykeeperCustomerOpenApiComponents, type operations as DaykeeperCustomerOpenApiOperations, type paths as DaykeeperCustomerOpenApiPaths, type DaykeeperMessage, type DaykeeperMessageList, type DaykeeperMessageResult, type DaykeeperMessageSender, DaykeeperReactNativeApiError, DaykeeperReactNativeClient, type DaykeeperReactNativeClientOptions, type DaykeeperReactNativeRequestOptions, type DaykeeperReactNativeTokenProvider, type DaykeeperReactNativeTokenProviderContext, DaykeeperReactNativeTransportError, type DaykeeperReactNativeTransportErrorCode, type DaykeeperSeenResult, type DaykeeperUnreadSummary, createDaykeeperReactNativeClient };