@great-detail/support-sdk 0.0.5 → 0.0.6

package/dist/index-zrmJVCfU.d.ts

@@ -0,0 +1,684 @@
+import { z } from 'zod';
+
+/**
+ * Great Detail Support System.
+ *
+ * @copyright 2024 Great Detail Ltd
+ * @author    Great Detail Ltd <info@greatdetail.com>
+ * @author    Dom Webber <dom.webber@greatdetail.com>
+ * @see       https://greatdetail.com
+ */
+interface RequestFilterable {
+    filter(request: RequestInit): Promise<RequestInit>;
+}
+
+/**
+ * Great Detail Support System.
+ *
+ * @copyright 2024 Great Detail Ltd
+ * @author    Great Detail Ltd <info@greatdetail.com>
+ * @author    Dom Webber <dom.webber@greatdetail.com>
+ * @see       https://greatdetail.com
+ */
+
+interface Authentication extends RequestFilterable {
+}
+
+/**
+ * Great Detail Support System.
+ *
+ * @copyright 2024 Great Detail Ltd
+ * @author    Great Detail Ltd <info@greatdetail.com>
+ * @author    Dom Webber <dom.webber@greatdetail.com>
+ * @see       https://greatdetail.com
+ */
+
+interface Options$f extends SendOptions {
+    request?: RequestInit;
+}
+declare class ListActionsRequest {
+    protected _client: Client;
+    constructor(_client: Client);
+    send({ request, ...options }?: Options$f): Promise<ListActionsResponse>;
+}
+type ListActionsResponsePayload = {
+    actions: {
+        id: string;
+        actionStatus: string;
+        message: string;
+        name: string;
+        object?: string;
+        result?: string;
+        startedAt?: string;
+        endedAt?: string;
+        createdAt: string;
+        updatedAt?: string;
+    }[];
+};
+declare class ListActionsResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<ListActionsResponsePayload>;
+}
+
+/**
+ * Great Detail Support System.
+ *
+ * @copyright 2024 Great Detail Ltd
+ * @author    Great Detail Ltd <info@greatdetail.com>
+ * @author    Dom Webber <dom.webber@greatdetail.com>
+ * @see       https://greatdetail.com
+ */
+
+interface Options$e extends SendOptions {
+    request?: RequestInit;
+}
+declare class ListChannelsRequest {
+    protected _client: Client;
+    constructor(_client: Client);
+    send({ request, ...options }?: Options$e): Promise<ListChannelsResponse>;
+}
+type ListChannelsResponsePayload = {
+    channels: ({
+        id: string;
+        name?: string;
+        channelStatus: "ActiveChannelStatus" | "PotentialChannelStatus";
+        account: string;
+        createdAt: string;
+        updatedAt?: string;
+    } & ({
+        source: "meta-whatsapp";
+        metaWhatsapp: {
+            id: string;
+            whatsappAccountID: string;
+            whatsappPhoneNumberID: string;
+            accessToken: string;
+        };
+    } | {
+        source: "twilio-sendgrid";
+        twilioSendgrid: {
+            id: string;
+            apiKey: string;
+        };
+    }))[];
+};
+declare class ListChannelsResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<ListChannelsResponsePayload>;
+}
+
+/**
+ * Great Detail Support System.
+ *
+ * @copyright 2024 Great Detail Ltd
+ * @author    Great Detail Ltd <info@greatdetail.com>
+ * @author    Dom Webber <dom.webber@greatdetail.com>
+ * @see       https://greatdetail.com
+ */
+
+interface Options$d extends SendOptions {
+    id: string;
+    request?: RequestInit;
+}
+declare class GetContactRequest {
+    protected _client: Client;
+    constructor(_client: Client);
+    send({ id, request, ...options }: Options$d): Promise<GetContactResponse>;
+}
+type GetContactResponsePayload = {
+    contact: {
+        id: string;
+        name?: string;
+        emailAddress?: string;
+        telephoneNumber?: string;
+        account: string;
+        createdAt: string;
+        updatedAt?: string;
+    };
+};
+declare class GetContactResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<GetContactResponsePayload>;
+}
+
+/**
+ * Great Detail Support System.
+ *
+ * @copyright 2024 Great Detail Ltd
+ * @author    Great Detail Ltd <info@greatdetail.com>
+ * @author    Dom Webber <dom.webber@greatdetail.com>
+ * @see       https://greatdetail.com
+ */
+
+interface Options$c extends SendOptions {
+    request?: RequestInit;
+}
+declare class ListContactsRequest {
+    protected _client: Client;
+    constructor(_client: Client);
+    send({ request, ...options }?: Options$c): Promise<ListContactsResponse>;
+}
+type ListContactsResponsePayload = {
+    contacts: {
+        id: string;
+        name?: string;
+        emailAddress?: string;
+        telephoneNumber?: string;
+        account: string;
+        createdAt: string;
+        updatedAt?: string;
+    }[];
+};
+declare class ListContactsResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<ListContactsResponsePayload>;
+}
+
+/**
+ * Great Detail Support System.
+ *
+ * @copyright 2024 Great Detail Ltd
+ * @author    Great Detail Ltd <info@greatdetail.com>
+ * @author    Dom Webber <dom.webber@greatdetail.com>
+ * @see       https://greatdetail.com
+ */
+
+interface Options$b extends SendOptions {
+    id: string;
+    request?: RequestInit;
+}
+declare class GetConversationRequest {
+    protected _client: Client;
+    constructor(_client: Client);
+    send({ id, request, ...options }: Options$b): Promise<GetConversationResponse>;
+}
+type GetConversationResponsePayload = {
+    conversation: {
+        id: string;
+        hasEnded: boolean;
+        accountChannel: string;
+        createdAt: string;
+        updatedAt: string;
+    };
+};
+declare class GetConversationResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<GetConversationResponsePayload>;
+}
+
+/**
+ * Great Detail Support System.
+ *
+ * @copyright 2024 Great Detail Ltd
+ * @author    Great Detail Ltd <info@greatdetail.com>
+ * @author    Dom Webber <dom.webber@greatdetail.com>
+ * @see       https://greatdetail.com
+ */
+
+interface Options$a extends SendOptions {
+    request?: RequestInit;
+}
+declare class ListConversationsRequest {
+    protected _client: Client;
+    constructor(_client: Client);
+    send({ request, ...options }?: Options$a): Promise<ListConversationsResponse>;
+}
+type ListConversationsResponsePayload = {
+    conversations: {
+        id: string;
+        hasEnded: boolean;
+        accountChannel: string;
+        createdAt: string;
+        updatedAt: string;
+    }[];
+};
+declare class ListConversationsResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<ListConversationsResponsePayload>;
+}
+
+/**
+ * Great Detail Support System.
+ *
+ * @copyright 2024 Great Detail Ltd
+ * @author    Great Detail Ltd <info@greatdetail.com>
+ * @author    Dom Webber <dom.webber@greatdetail.com>
+ * @see       https://greatdetail.com
+ */
+
+interface Options$9 extends SendOptions {
+    body: z.infer<typeof CreateLabelRequest.SCHEMA>;
+    request?: RequestInit;
+}
+declare class CreateLabelRequest {
+    protected _client: Client;
+    static SCHEMA: z.ZodObject<{
+        title: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        account: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        title: string;
+        account: string;
+        description?: string | undefined;
+    }, {
+        title: string;
+        account: string;
+        description?: string | undefined;
+    }>;
+    constructor(_client: Client);
+    send({ body, request, ...options }: Options$9): Promise<CreateLabelResponse>;
+}
+type CreateLabelResponsePayload = {
+    label: {
+        id: string;
+        title: string;
+        description?: string;
+        account: string;
+        createdAt: string;
+        updatedAt?: string;
+    };
+};
+declare class CreateLabelResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<CreateLabelResponsePayload>;
+}
+
+/**
+ * Great Detail Support System.
+ *
+ * @copyright 2024 Great Detail Ltd
+ * @author    Great Detail Ltd <info@greatdetail.com>
+ * @author    Dom Webber <dom.webber@greatdetail.com>
+ * @see       https://greatdetail.com
+ */
+
+interface Options$8 extends SendOptions {
+    id: string;
+    request?: RequestInit;
+}
+declare class GetLabelRequest {
+    protected _client: Client;
+    constructor(_client: Client);
+    send({ id, request, ...options }: Options$8): Promise<GetLabelResponse>;
+}
+type GetLabelResponsePayload = {
+    label: {
+        id: string;
+        title: string;
+        description?: string;
+        account: string;
+        createdAt: string;
+        updatedAt?: string;
+    };
+};
+declare class GetLabelResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<GetLabelResponsePayload>;
+}
+
+/**
+ * Great Detail Support System.
+ *
+ * @copyright 2024 Great Detail Ltd
+ * @author    Great Detail Ltd <info@greatdetail.com>
+ * @author    Dom Webber <dom.webber@greatdetail.com>
+ * @see       https://greatdetail.com
+ */
+
+interface Options$7 extends SendOptions {
+    request?: RequestInit;
+}
+declare class ListLabelsRequest {
+    protected _client: Client;
+    constructor(_client: Client);
+    send({ request, ...options }?: Options$7): Promise<ListLabelsResponse>;
+}
+type ListLabelsResponsePayload = {
+    labels: {
+        id: string;
+        title: string;
+        description?: string;
+        account: string;
+        createdAt: string;
+        updatedAt?: string;
+    }[];
+};
+declare class ListLabelsResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<ListLabelsResponsePayload>;
+}
+
+/**
+ * Great Detail Support System.
+ *
+ * @copyright 2024 Great Detail Ltd
+ * @author    Great Detail Ltd <info@greatdetail.com>
+ * @author    Dom Webber <dom.webber@greatdetail.com>
+ * @see       https://greatdetail.com
+ */
+
+interface Options$6 extends SendOptions {
+    request?: RequestInit;
+}
+declare class ListMessagesRequest {
+    protected _client: Client;
+    constructor(_client: Client);
+    send({ request, ...options }?: Options$6): Promise<ListMessagesResponse>;
+}
+type ListMessagesResponsePayload = {
+    messages: {
+        id: string;
+        role: "user" | "assistant";
+        messageStatus: string;
+        externalIdentifier?: string;
+        conversation: string;
+        contact: string;
+        messageEvents: {
+            id: string;
+            messageEventType: string;
+            triggeredAt: string;
+            createdAt: string;
+            updatedAt?: string;
+        }[];
+        createdAt: string;
+        updatedAt: string;
+    }[];
+};
+declare class ListMessagesResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<ListMessagesResponsePayload>;
+}
+
+/**
+ * Great Detail Support System.
+ *
+ * @copyright 2024 Great Detail Ltd
+ * @author    Great Detail Ltd <info@greatdetail.com>
+ * @author    Dom Webber <dom.webber@greatdetail.com>
+ * @see       https://greatdetail.com
+ */
+
+interface Options$5 extends SendOptions {
+    id: string;
+    body: z.infer<typeof CreateCorrectionModelRequest.SCHEMA>;
+    request?: RequestInit;
+}
+declare class CreateCorrectionModelRequest {
+    protected _client: Client;
+    static SCHEMA: z.ZodObject<{
+        input: z.ZodString;
+        original: z.ZodString;
+        correction: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        input: string;
+        original: string;
+        correction: string;
+    }, {
+        input: string;
+        original: string;
+        correction: string;
+    }>;
+    constructor(_client: Client);
+    send({ id, body, request, ...options }: Options$5): Promise<CreateCorrectionModelResponse>;
+}
+type CreateCorrectionResponsePayload = unknown;
+declare class CreateCorrectionModelResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<CreateCorrectionResponsePayload>;
+}
+
+/**
+ * Great Detail Support System.
+ *
+ * @copyright 2024 Great Detail Ltd
+ * @author    Great Detail Ltd <info@greatdetail.com>
+ * @author    Dom Webber <dom.webber@greatdetail.com>
+ * @see       https://greatdetail.com
+ */
+
+interface Options$4 extends SendOptions {
+    id: string;
+    request?: RequestInit;
+}
+declare class GetModelRequest {
+    protected _client: Client;
+    constructor(_client: Client);
+    send({ id, request, ...options }: Options$4): Promise<GetModelResponse>;
+}
+type GetModelResponsePayload = {
+    model: {
+        id: string;
+        name: string;
+        url?: string;
+        icon?: string;
+        disambiguatingDescription: string;
+    };
+};
+declare class GetModelResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<GetModelResponsePayload>;
+}
+
+/**
+ * Great Detail Support System.
+ *
+ * @copyright 2024 Great Detail Ltd
+ * @author    Great Detail Ltd <info@greatdetail.com>
+ * @author    Dom Webber <dom.webber@greatdetail.com>
+ * @see       https://greatdetail.com
+ */
+
+interface Options$3 extends SendOptions {
+    request?: RequestInit;
+}
+declare class ListModelsRequest {
+    protected _client: Client;
+    constructor(_client: Client);
+    send({ request, ...options }?: Options$3): Promise<ListModelsResponse>;
+}
+type ListModelsResponsePayload = {
+    models: {
+        id: string;
+        name: string;
+        url?: string;
+        icon?: string;
+        disambiguatingDescription: string;
+    }[];
+};
+declare class ListModelsResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<ListModelsResponsePayload>;
+}
+
+/**
+ * Great Detail Support System.
+ *
+ * @copyright 2024 Great Detail Ltd
+ * @author    Great Detail Ltd <info@greatdetail.com>
+ * @author    Dom Webber <dom.webber@greatdetail.com>
+ * @see       https://greatdetail.com
+ */
+
+interface Options$2 extends SendOptions {
+    id: string;
+    body: z.infer<typeof CreateResponseModelRequest.SCHEMA>;
+    request?: RequestInit;
+}
+declare class CreateResponseModelRequest {
+    protected _client: Client;
+    static SCHEMA: z.ZodArray<z.ZodObject<{
+        role: z.ZodEnum<["user", "assistant"]>;
+        content: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        role: "user" | "assistant";
+        content: string | null;
+    }, {
+        role: "user" | "assistant";
+        content: string | null;
+    }>, "many">;
+    constructor(_client: Client);
+    send({ id, body, request, ...options }: Options$2): Promise<CreateResponseModelResponse>;
+}
+type CreateResponseResponsePayload = {
+    message: string | null;
+    debug: {
+        duration: string;
+        sources: (string | undefined)[];
+    };
+};
+declare class CreateResponseModelResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<CreateResponseResponsePayload>;
+}
+
+/**
+ * Great Detail Support System.
+ *
+ * @copyright 2024 Great Detail Ltd
+ * @author    Great Detail Ltd <info@greatdetail.com>
+ * @author    Dom Webber <dom.webber@greatdetail.com>
+ * @see       https://greatdetail.com
+ */
+
+interface Options$1 extends SendOptions {
+    id: string;
+    request?: RequestInit;
+}
+declare class GetSourceRequest {
+    protected _client: Client;
+    constructor(_client: Client);
+    send({ id, request, ...options }: Options$1): Promise<GetSourceResponse>;
+}
+type GetSourceResponsePayload = {
+    source: {
+        id: string;
+        name: string;
+        category: string;
+        url?: string;
+        icon?: string;
+        disambiguatingDescription: string;
+    };
+};
+declare class GetSourceResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<GetSourceResponsePayload>;
+}
+
+/**
+ * Great Detail Support System.
+ *
+ * @copyright 2024 Great Detail Ltd
+ * @author    Great Detail Ltd <info@greatdetail.com>
+ * @author    Dom Webber <dom.webber@greatdetail.com>
+ * @see       https://greatdetail.com
+ */
+
+interface Options extends SendOptions {
+    request?: RequestInit;
+}
+declare class ListSourcesRequest {
+    protected _client: Client;
+    constructor(_client: Client);
+    send({ request, ...options }?: Options): Promise<ListSourcesResponse>;
+}
+type ListSourcesResponsePayload = {
+    sources: {
+        id: string;
+        name: string;
+        category: string;
+        url?: string;
+        icon?: string;
+        disambiguatingDescription: string;
+    }[];
+};
+declare class ListSourcesResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<ListSourcesResponsePayload>;
+}
+
+/**
+ * Great Detail Support System.
+ *
+ * @copyright 2024 Great Detail Ltd
+ * @author    Great Detail Ltd <info@greatdetail.com>
+ * @author    Dom Webber <dom.webber@greatdetail.com>
+ * @see       https://greatdetail.com
+ */
+
+interface ClientOptions {
+    requestFilterables: RequestFilterable[];
+    baseURL: string;
+}
+interface InputClientOptions {
+    baseURL?: string;
+}
+interface SendOptions {
+    /**
+     * Alternative Fetch Provider.
+     * Used to override the default fetch provider and use polyfills or other
+     * libraries.
+     *
+     * @since 1.0.0
+     */
+    fetch?: typeof fetch;
+}
+declare class Client {
+    static DEFAULT_BASE_URL: string;
+    options: ClientOptions;
+    constructor(authentication: Authentication, options?: InputClientOptions);
+    action: {
+        list: ListActionsRequest;
+    };
+    channel: {
+        list: ListChannelsRequest;
+    };
+    contact: {
+        get: GetContactRequest;
+        list: ListContactsRequest;
+    };
+    conversation: {
+        get: GetConversationRequest;
+        list: ListConversationsRequest;
+    };
+    label: {
+        create: CreateLabelRequest;
+        get: GetLabelRequest;
+        list: ListLabelsRequest;
+    };
+    message: {
+        list: ListMessagesRequest;
+    };
+    model: {
+        get: GetModelRequest;
+        list: ListModelsRequest;
+        response: {
+            create: CreateResponseModelRequest;
+        };
+        correction: {
+            create: CreateCorrectionModelRequest;
+        };
+    };
+    source: {
+        get: GetSourceRequest;
+        list: ListSourcesRequest;
+    };
+    protected _filterRequest(request: RequestInit): Promise<RequestInit>;
+    send(url: string | URL, request: RequestInit, { fetch: fetchAlternative }?: SendOptions): Promise<Response>;
+}
+
+export { type Authentication as A, Client as C, type GetConversationResponsePayload as G, type ListActionsResponsePayload as L, type RequestFilterable as R, type ListChannelsResponsePayload as a, type ListContactsResponsePayload as b, type ListConversationsResponsePayload as c, type CreateLabelResponsePayload as d, type ListLabelsResponsePayload as e, type ListMessagesResponsePayload as f, type ListModelsResponsePayload as g, type CreateCorrectionResponsePayload as h, type CreateResponseResponsePayload as i, type ListSourcesResponsePayload as j };