@great-detail/support-sdk 0.7.7 → 0.8.1

package/dist/index-DFzidwIt.d.ts

@@ -0,0 +1,1566 @@
+import * as ky from 'ky';
+import { KyInstance, Options as Options$X } from 'ky';
+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 {
+    /**
+     * @deprecated
+     */
+    filter(...options: unknown[]): Promise<{
+        headers: Record<string, string>;
+    }>;
+    getHeaders(): Record<string, string>;
+}
+
+/**
+ * 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$W {
+    requestFilterables: RequestFilterable[];
+}
+interface Transport {
+    getURL(url: string): string;
+}
+
+interface InputOptions extends Options$W {
+    baseURL: string;
+}
+interface Options$V extends Options$W {
+    baseURL: string;
+}
+declare class FetchTransport implements Transport {
+    client: KyInstance;
+    options: Options$V;
+    constructor({ baseURL, ...options }: InputOptions);
+    getURL(url: string): string;
+    includeQuery(include: {
+        [included: string]: boolean | undefined;
+    }): [string, string][];
+    send<T = unknown>(url: string, request: Options$X): Promise<ky.KyResponse<T>>;
+}
+
+/**
+ * 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
+ */
+type Action = {
+    id: string;
+    status: string;
+    message: string;
+    name: string;
+    object?: string;
+    result?: string;
+    startedAt?: string;
+    endedAt?: string;
+    createdAt: string;
+    updatedAt: string;
+};
+
+interface Options$U {
+    request?: RequestInit;
+}
+type ListActionsResponse = {
+    data: {
+        action: Action;
+    }[];
+};
+declare class ListActions {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ request }?: Options$U): Promise<ky.KyResponse<ListActionsResponse>>;
+}
+
+/**
+ * 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
+ */
+
+type Authentication = 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
+ */
+type Boilerplate = {
+    id: string;
+    title: string;
+    content: string;
+    account: string;
+    boilerplateCategory: string;
+    createdAt: string;
+    updatedAt: string;
+};
+
+type CreateBoilerplatePayload = {
+    title: string;
+    content: string;
+    account: string;
+    boilerplateCategory: string;
+};
+interface Options$T {
+    body: CreateBoilerplatePayload;
+    request?: RequestInit;
+}
+type CreateBoilerplateResponse = {
+    data: {
+        boilerplate: Boilerplate;
+    };
+};
+declare class CreateBoilerplate {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ body, request }: Options$T): Promise<ky.KyResponse<CreateBoilerplateResponse>>;
+}
+
+interface Options$S {
+    id: string;
+    request?: RequestInit;
+}
+type GetBoilerplateResponse = {
+    data: {
+        boilerplate: Boilerplate;
+    };
+};
+declare class GetBoilerplate {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, request }: Options$S): Promise<ky.KyResponse<GetBoilerplateResponse>>;
+}
+
+interface Options$R {
+    id: string;
+    request?: RequestInit;
+}
+type ListBoilerplateCategoryBoilerplatesResponse = {
+    data: {
+        boilerplate: Boilerplate;
+    }[];
+};
+declare class ListBoilerplateCategoryBoilerplates {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, request }: Options$R): Promise<ky.KyResponse<ListBoilerplateCategoryBoilerplatesResponse>>;
+}
+
+interface Options$Q {
+    query?: string;
+    request?: RequestInit;
+}
+type ListBoilerplatesResponse = {
+    data: {
+        boilerplate: Boilerplate;
+    }[];
+};
+declare class ListBoilerplates {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ query, request }?: Options$Q): Promise<ky.KyResponse<ListBoilerplatesResponse>>;
+}
+
+type UpdateBoilerplatePayload = {
+    title?: string;
+    content?: string;
+};
+interface Options$P {
+    id: string;
+    body: UpdateBoilerplatePayload;
+    request?: RequestInit;
+}
+type UpdateBoilerplateResponse = {
+    data: {
+        boilerplate: Boilerplate;
+    };
+};
+declare class UpdateBoilerplate {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, body, request }: Options$P): Promise<ky.KyResponse<UpdateBoilerplateResponse>>;
+}
+
+/**
+ * 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
+ */
+type BoilerplateCategory = {
+    id: string;
+    title: string;
+    description?: string;
+    account: string;
+    createdAt: string;
+    updatedAt: string;
+};
+
+type CreateBoilerplateCategoryPayload = {
+    title: string;
+    description?: string;
+    account: string;
+};
+interface Options$O {
+    body: CreateBoilerplateCategoryPayload;
+    request?: RequestInit;
+}
+type CreateBoilerplateCategoryResponse = {
+    data: {
+        boilerplateCategory: BoilerplateCategory;
+    };
+};
+declare class CreateBoilerplateCategory {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ body, request }: Options$O): Promise<ky.KyResponse<CreateBoilerplateCategoryResponse>>;
+}
+
+interface Options$N {
+    id: string;
+    request?: RequestInit;
+}
+type GetBoilerplateCategoryResponse = {
+    data: {
+        boilerplateCategory: BoilerplateCategory;
+    };
+};
+declare class GetBoilerplateCategory {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, request }: Options$N): Promise<ky.KyResponse<GetBoilerplateCategoryResponse>>;
+}
+
+interface IncludeOptions$5 {
+    boilerplateCount?: boolean;
+    [key: string]: boolean | undefined;
+}
+interface Options$M<C extends IncludeOptions$5> {
+    include?: C;
+    request?: RequestInit;
+}
+type ListBoilerplateCategoriesResponse<C extends IncludeOptions$5> = {
+    data: {
+        boilerplateCategory: BoilerplateCategory;
+        boilerplateCount?: C extends {
+            boilerplateCount: true;
+        } ? number : never;
+    }[];
+};
+declare class ListBoilerplateCategories {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send<C extends IncludeOptions$5>({ include, request, }?: Options$M<C>): Promise<ky.KyResponse<ListBoilerplateCategoriesResponse<C>>>;
+}
+
+type UpdateBoilerplateCategoryPayload = {
+    title?: string;
+    description?: string;
+};
+interface Options$L {
+    id: string;
+    body: UpdateBoilerplateCategoryPayload;
+    request?: RequestInit;
+}
+type UpdateBoilerplateCategoryResponse = {
+    data: {
+        boilerplateCategory: BoilerplateCategory;
+    };
+};
+declare class UpdateBoilerplateCategory {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, body, request }: Options$L): Promise<ky.KyResponse<UpdateBoilerplateCategoryResponse>>;
+}
+
+/**
+ * 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
+ */
+type Channel = {
+    id: string;
+    name?: string;
+    status: "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;
+        displayName: string;
+        outboundEmailAddress: string;
+        replyEmailAddress?: string;
+        inboundHostname: string;
+        apiKey: string;
+        secrets: {
+            id: string;
+            isActive: boolean;
+            secretExcerpt: string;
+        }[];
+    };
+});
+
+type CreateChannelPayload = {
+    name?: string;
+    account: string;
+} & ({
+    source: "meta-whatsapp";
+} | {
+    source: "twilio-sendgrid";
+    twilioSendgrid: {
+        displayName?: string;
+        outboundEmailAddress: string;
+        replyEmailAddress?: string;
+        inboundHostname: string;
+        apiKey: string;
+    };
+});
+interface Options$K {
+    body: CreateChannelPayload;
+    request?: RequestInit;
+}
+type CreateChannelResponse = {
+    data: {
+        channel: Channel;
+    };
+};
+declare class CreateChannel {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ body, request }: Options$K): Promise<ky.KyResponse<CreateChannelResponse>>;
+}
+
+interface Options$J {
+    id: string;
+    request?: RequestInit;
+}
+type GetChannelResponse = {
+    data: {
+        channel: Channel;
+    };
+};
+declare class GetChannel {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, request }: Options$J): Promise<ky.KyResponse<GetChannelResponse>>;
+}
+
+interface Options$I {
+    request?: RequestInit;
+}
+type ListChannelsResponse = {
+    data: {
+        channel: Channel;
+    }[];
+};
+declare class ListChannels {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ request }?: Options$I): Promise<ky.KyResponse<ListChannelsResponse>>;
+}
+
+interface Options$H {
+    id: string;
+    body: z.infer<typeof TwilioSendgridChannelSync.SCHEMA>;
+    request?: RequestInit;
+}
+type TwilioSendgridChannelSyncResponse = {
+    data: {
+        channel: Extract<Channel, {
+            source: "twilio-sendgrid";
+        }>;
+    };
+};
+declare class TwilioSendgridChannelSync {
+    protected _transport: FetchTransport;
+    static SCHEMA: z.ZodObject<{
+        overwrite: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        overwrite?: boolean | undefined;
+    }, {
+        overwrite?: boolean | undefined;
+    }>;
+    constructor(_transport: FetchTransport);
+    send({ id, body, request }: Options$H): Promise<ky.KyResponse<TwilioSendgridChannelSyncResponse>>;
+}
+
+type UpdateChannelPayload = {
+    name?: string;
+} & ({
+    source: "meta-whatsapp";
+} | {
+    source: "twilio-sendgrid";
+    twilioSendgrid: {
+        displayName?: string;
+        outboundEmailAddress?: string;
+        replyEmailAddress?: string;
+        inboundHostname?: string;
+        apiKey?: string;
+    };
+});
+interface Options$G {
+    id: string;
+    body: UpdateChannelPayload;
+    request?: RequestInit;
+}
+type UpdateChannelResponse = {
+    data: {
+        channel: Channel;
+    };
+};
+declare class UpdateChannel {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, body, request }: Options$G): Promise<ky.KyResponse<UpdateChannelResponse>>;
+}
+
+/**
+ * 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
+ */
+type CompositionSection = {
+    id: string;
+    account: string;
+    channel: string;
+    location: "header" | "footer";
+    content: string;
+    createdAt: string;
+    updatedAt: string;
+};
+
+type CreateCompositionSectionPayload = {
+    account: string;
+    channel?: string;
+    location: "header" | "footer";
+    content: string;
+};
+interface Options$F {
+    body: CreateCompositionSectionPayload;
+    request?: RequestInit;
+}
+type CreateCompositionSectionResponse = {
+    data: {
+        compositionSection: CompositionSection;
+    };
+};
+declare class CreateCompositionSection {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ body, request }: Options$F): Promise<ky.KyResponse<CreateCompositionSectionResponse>>;
+}
+
+interface Options$E {
+    id: string;
+    request?: RequestInit;
+}
+type GetCompositionSectionResponse = {
+    data: {
+        compositionSection: CompositionSection;
+    };
+};
+declare class GetCompositionSection {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, request }: Options$E): Promise<ky.KyResponse<GetCompositionSectionResponse>>;
+}
+
+interface Options$D {
+    id: string;
+    request?: RequestInit;
+}
+type ListChannelCompositionSectionsResponse = {
+    data: {
+        compositionSection: CompositionSection;
+    }[];
+};
+declare class ListChannelCompositionSections {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, request }: Options$D): Promise<ky.KyResponse<ListChannelCompositionSectionsResponse>>;
+}
+
+interface Options$C {
+    request?: RequestInit;
+}
+type ListCompositionSectionsResponse = {
+    data: {
+        compositionSection: CompositionSection;
+    }[];
+};
+declare class ListCompositionSections {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ request }?: Options$C): Promise<ky.KyResponse<ListCompositionSectionsResponse>>;
+}
+
+type UpdateCompositionSectionPayload = {
+    content?: string;
+};
+interface Options$B {
+    id: string;
+    body: UpdateCompositionSectionPayload;
+    request?: RequestInit;
+}
+type UpdateCompositionSectionResponse = {
+    data: {
+        compositionSection: CompositionSection;
+    };
+};
+declare class UpdateCompositionSection {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, body, request }: Options$B): Promise<ky.KyResponse<UpdateCompositionSectionResponse>>;
+}
+
+/**
+ * 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 {
+    id: string;
+    vcf?: {
+        variant?: "vcard";
+        format?: "vcf" | "qr";
+    } | {
+        variant: "jcard";
+        format?: "json";
+    };
+}
+declare class GetContactVCFURL {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    getRelativeURL({ id, vcf }: Options$A): string;
+    getURL(options: Options$A): string;
+}
+
+/**
+ * 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
+ */
+type Contact = {
+    id: string;
+    name?: string;
+    emailAddress?: string;
+    telephoneNumber?: string;
+    account: string;
+    createdAt: string;
+    updatedAt: string;
+};
+
+type CreateContactPayload = {
+    name: string;
+    account: string;
+    emailAddress?: string;
+    telephoneNumber?: string;
+};
+interface Options$z {
+    body: CreateContactPayload;
+    request?: RequestInit;
+}
+type CreateContactResponse = {
+    data: {
+        contact: Contact;
+    };
+};
+declare class CreateContact {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ body, request }: Options$z): Promise<ky.KyResponse<CreateContactResponse>>;
+}
+
+interface IncludeOptions$4 {
+    messageCount?: boolean;
+    conversationCount?: boolean;
+    [key: string]: boolean | undefined;
+}
+interface Options$y<C extends IncludeOptions$4> {
+    id: string;
+    include?: C;
+    request?: RequestInit;
+}
+type GetContactResponse<C extends IncludeOptions$4> = {
+    data: {
+        contact: Contact;
+        messageCount?: C extends {
+            messageCount: true;
+        } ? number : never;
+        conversationCount?: C extends {
+            conversationCount: true;
+        } ? number : never;
+    };
+};
+declare class GetContact {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send<C extends IncludeOptions$4>({ id, include, request, }: Options$y<C>): Promise<ky.KyResponse<GetContactResponse<C>>>;
+}
+
+interface Options$x {
+    request?: RequestInit;
+}
+type ListContactsResponse = {
+    data: {
+        contact: Contact;
+    }[];
+};
+declare class ListContacts {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ request }?: Options$x): Promise<ky.KyResponse<ListContactsResponse>>;
+}
+
+interface Options$w {
+    id: string;
+    request?: RequestInit;
+}
+type ListLabelContactsResponse = {
+    data: {
+        contact: Contact;
+    }[];
+};
+declare class ListLabelContacts {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, request }: Options$w): Promise<ky.KyResponse<ListLabelContactsResponse>>;
+}
+
+type UpdateContactPayload = {
+    name?: string;
+    emailAddress?: string;
+    telephoneNumber?: string;
+};
+interface Options$v {
+    id: string;
+    body: UpdateContactPayload;
+    request?: RequestInit;
+}
+type UpdateContactResponse = {
+    data: {
+        contact: Contact;
+    };
+};
+declare class UpdateContact {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, body, request }: Options$v): Promise<ky.KyResponse<UpdateContactResponse>>;
+}
+
+/**
+ * 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
+ */
+type Conversation = {
+    id: string;
+    name?: string;
+    hasEnded: boolean;
+    contacts: string[];
+    status: "AwaitingContactConversationStatus" | "AwaitingAgentConversationStatus" | "ResolvedConversationStatus" | "ClosedConversationStatus";
+    channel: string;
+    createdAt: string;
+    updatedAt: string;
+};
+
+interface IncludeOptions$3 {
+    channel?: boolean;
+    [key: string]: boolean | undefined;
+}
+interface Options$u<C extends IncludeOptions$3> {
+    id: string;
+    include?: C;
+    request?: RequestInit;
+}
+type GetConversationResponse<C extends IncludeOptions$3> = {
+    data: {
+        conversation: Conversation;
+        channel: C extends {
+            channel: true;
+        } ? Channel : never;
+    };
+};
+declare class GetConversation {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send<C extends IncludeOptions$3>({ id, include, request, }: Options$u<C>): Promise<ky.KyResponse<GetConversationResponse<C>>>;
+}
+
+interface Options$t {
+    id: string;
+    request?: RequestInit;
+}
+type ListContactConversationsResponse = {
+    data: {
+        conversation: Conversation;
+    }[];
+};
+declare class ListContactConversations {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, request }: Options$t): Promise<ky.KyResponse<ListContactConversationsResponse>>;
+}
+
+/**
+ * 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
+ */
+type Message = {
+    id: string;
+    role: "user" | "assistant";
+    status: string;
+    externalIdentifier?: string;
+    conversation: string;
+    contact: string;
+    messageEvents: {
+        id: string;
+        messageEventType: string;
+        triggeredAt: string;
+        createdAt: string;
+        updatedAt?: string;
+    }[];
+    createdAt: string;
+    updatedAt: string;
+};
+
+interface IncludeOptions$2 {
+    latestMessage?: boolean;
+    [key: string]: boolean | undefined;
+}
+interface Options$s<C extends IncludeOptions$2> {
+    filter?: "unresolved";
+    include?: C;
+    request?: RequestInit;
+}
+type ListConversationsResponse<C extends IncludeOptions$2> = {
+    data: {
+        conversation: Conversation;
+        latestMessage?: C extends {
+            latestMessage: true;
+        } ? Message : never;
+    }[];
+};
+declare class ListConversations {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send<C extends IncludeOptions$2>({ filter, include, request, }?: Options$s<C>): Promise<ky.KyResponse<ListConversationsResponse<C>>>;
+}
+
+interface Options$r {
+    id: string;
+    request?: RequestInit;
+}
+type ListLabelConversationsResponse = {
+    data: {
+        conversation: Conversation;
+    }[];
+};
+declare class ListLabelConversations {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, request }: Options$r): Promise<ky.KyResponse<ListLabelConversationsResponse>>;
+}
+
+type UpdateConversationPayload = {
+    status?: "AwaitingContactConversationStatus" | "AwaitingAgentConversationStatus" | "ResolvedConversationStatus" | "ClosedConversationStatus";
+    hasEnded?: boolean;
+};
+interface Options$q {
+    id: string;
+    body: UpdateConversationPayload;
+    request?: RequestInit;
+}
+type UpdateConversationResponse = {
+    data: {
+        conversation: Conversation;
+    };
+};
+declare class UpdateConversation {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, body, request }: Options$q): Promise<ky.KyResponse<UpdateConversationResponse>>;
+}
+
+/**
+ * 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
+ */
+type Label = {
+    id: string;
+    title: string;
+    description?: string;
+    account: string;
+    createdAt: string;
+    updatedAt: string;
+};
+
+type CreateLabelPayload = {
+    title: string;
+    description?: string;
+    account: string;
+};
+interface Options$p {
+    body: CreateLabelPayload;
+    request?: RequestInit;
+}
+type CreateLabelResponse = {
+    data: {
+        label: Label;
+    };
+};
+declare class CreateLabel {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ body, request }: Options$p): Promise<ky.KyResponse<CreateLabelResponse>>;
+}
+
+interface Options$o {
+    id: string;
+    request?: RequestInit;
+}
+type DeleteLabelResponse = Record<string, never>;
+declare class DeleteLabel {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, request }: Options$o): Promise<ky.KyResponse<DeleteLabelResponse>>;
+}
+
+interface Options$n {
+    id: string;
+    request?: RequestInit;
+}
+type GetLabelResponse = {
+    data: {
+        label: Label;
+    };
+};
+declare class GetLabel {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, request }: Options$n): Promise<ky.KyResponse<GetLabelResponse>>;
+}
+
+interface IncludeOptions$1 {
+    contactCount?: boolean;
+    conversationCount?: boolean;
+    [key: string]: boolean | undefined;
+}
+interface Options$m<C extends IncludeOptions$1> {
+    include?: C;
+    request?: RequestInit;
+}
+type ListLabelsResponse<C extends IncludeOptions$1> = {
+    data: {
+        label: Label;
+        contactCount?: C extends {
+            contactCount: true;
+        } ? number : never;
+        conversationCount?: C extends {
+            conversationCount: true;
+        } ? number : never;
+    }[];
+};
+declare class ListLabels {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send<C extends IncludeOptions$1>({ include, request, }?: Options$m<C>): Promise<ky.KyResponse<ListLabelsResponse<C>>>;
+}
+
+type UpdateLabelPayload = {
+    title?: string;
+    description?: string;
+};
+interface Options$l {
+    id: string;
+    body: UpdateLabelPayload;
+    request?: RequestInit;
+}
+type UpdateLabelResponse = {
+    data: {
+        label: Label;
+    };
+};
+declare class UpdateLabel {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, body, request }: Options$l): Promise<ky.KyResponse<UpdateLabelResponse>>;
+}
+
+interface Options$k {
+    id: string;
+    request?: RequestInit;
+}
+type ListChannelMessagesResponse = {
+    data: {
+        message: Message;
+    }[];
+};
+declare class ListChannelMessages {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, request }: Options$k): Promise<ky.KyResponse<ListChannelMessagesResponse>>;
+}
+
+interface IncludeOptions {
+    contact?: boolean;
+    [key: string]: boolean | undefined;
+}
+interface Options$j<C extends IncludeOptions> {
+    id: string;
+    include?: C;
+    request?: RequestInit;
+}
+type ListConversationMessagesResponse<C extends IncludeOptions> = {
+    data: {
+        message: Message;
+        contact?: C extends {
+            contact: true;
+        } ? Contact : never;
+    }[];
+};
+declare class ListConversationMessages {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send<C extends IncludeOptions>({ id, include, request, }: Options$j<C>): Promise<ky.KyResponse<ListConversationMessagesResponse<C>>>;
+}
+
+interface Options$i {
+    request?: RequestInit;
+}
+type ListMessagesResponse = {
+    data: {
+        message: Message;
+    }[];
+};
+declare class ListMessages {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ request }?: Options$i): Promise<ky.KyResponse<ListMessagesResponse>>;
+}
+
+type CreateCorrectionModelPayload = {
+    input: string;
+    original: string;
+    correction: string;
+};
+interface Options$h {
+    id: string;
+    body: CreateCorrectionModelPayload;
+    request?: RequestInit;
+}
+type CreateCorrectionResponse = unknown;
+declare class CreateCorrectionModel {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, body, request }: Options$h): Promise<ky.KyResponse<unknown>>;
+}
+
+/**
+ * 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
+ */
+type Model = {
+    id: string;
+    name: string;
+    url?: string;
+    icon?: string;
+    disambiguatingDescription: string;
+};
+
+interface Options$g {
+    id: string;
+    request?: RequestInit;
+}
+type GetModelResponse = {
+    data: {
+        model: Model;
+    };
+};
+declare class GetModel {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, request }: Options$g): Promise<ky.KyResponse<GetModelResponse>>;
+}
+
+interface Options$f {
+    request?: RequestInit;
+}
+type ListModelsResponse = {
+    data: {
+        model: Model;
+    }[];
+};
+declare class ListModels {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ request }?: Options$f): Promise<ky.KyResponse<ListModelsResponse>>;
+}
+
+type CreateResponseModelPayload = {
+    role: "user" | "assistant";
+    content: string | null;
+}[];
+interface Options$e {
+    id: string;
+    body: CreateResponseModelPayload;
+    request?: RequestInit;
+}
+type CreateResponseResponse = {
+    message: string | null;
+    debug: {
+        duration: string;
+        sources: (string | undefined)[];
+    };
+};
+declare class CreateResponseModel {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, body, request }: Options$e): Promise<ky.KyResponse<CreateResponseResponse>>;
+}
+
+/**
+ * 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
+ */
+type Note = {
+    id: string;
+    content: string;
+    createdAt: string;
+    updatedAt: string;
+};
+
+type CreateContactNotePayload = {
+    content: string;
+};
+interface Options$d {
+    id: string;
+    body: CreateContactNotePayload;
+    request?: RequestInit;
+}
+type CreateContactNoteResponse = {
+    data: {
+        note: Note;
+    };
+};
+declare class CreateContactNote {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, body, request }: Options$d): Promise<ky.KyResponse<CreateContactNoteResponse>>;
+}
+
+type CreateConversationNotePayload = {
+    content: string;
+};
+interface Options$c {
+    id: string;
+    body: CreateConversationNotePayload;
+    request?: RequestInit;
+}
+type CreateConversationNoteResponse = {
+    data: {
+        note: Note;
+    };
+};
+declare class CreateConversationNote {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, body, request }: Options$c): Promise<ky.KyResponse<CreateConversationNoteResponse>>;
+}
+
+interface Options$b {
+    id: string;
+    request?: RequestInit;
+}
+type GetNoteResponse = {
+    data: {
+        note: Note;
+    };
+};
+declare class GetNote {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, request }: Options$b): Promise<ky.KyResponse<GetNoteResponse>>;
+}
+
+interface Options$a {
+    id: string;
+    request?: RequestInit;
+}
+type ListContactNotesResponse = {
+    data: {
+        note: Note;
+    }[];
+};
+declare class ListContactNotes {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, request }: Options$a): Promise<ky.KyResponse<ListContactNotesResponse>>;
+}
+
+interface Options$9 {
+    id: string;
+    request?: RequestInit;
+}
+type ListConversationNotesResponse = {
+    data: {
+        note: Note;
+    }[];
+};
+declare class ListConversationNotes {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, request }: Options$9): Promise<ky.KyResponse<ListConversationNotesResponse>>;
+}
+
+type UpdateNotePayload = {
+    content?: string;
+};
+interface Options$8 {
+    id: string;
+    body: UpdateNotePayload;
+    request?: RequestInit;
+}
+type UpdateNoteResponse = {
+    data: {
+        note: Note;
+    };
+};
+declare class UpdateNote {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, body, request }: Options$8): Promise<ky.KyResponse<UpdateNoteResponse>>;
+}
+
+/**
+ * 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
+ */
+type NotificationSubscription = {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+};
+
+type CreateContactNotificationSubscriptionPayload = {
+    type: "vapid";
+    endpoint: string;
+    keys: {
+        p256dh: string;
+        auth: string;
+    };
+};
+interface Options$7 {
+    id: string;
+    body: CreateContactNotificationSubscriptionPayload;
+    request?: RequestInit;
+}
+type CreateContactNotificationSubscriptionResponse = {
+    data: {
+        notificationSubscription: NotificationSubscription;
+    };
+};
+declare class CreateContactNotificationSubscription {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, body, request }: Options$7): Promise<ky.KyResponse<CreateContactNotificationSubscriptionResponse>>;
+}
+
+/**
+ * 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
+ */
+type Source = {
+    id: string;
+    name: string;
+    category: string;
+    url?: string;
+    icon?: string;
+    disambiguatingDescription: string;
+};
+
+interface Options$6 {
+    id: string;
+    request?: RequestInit;
+}
+type GetSourceResponse = {
+    data: {
+        source: Source;
+    };
+};
+declare class GetSource {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, request }: Options$6): Promise<ky.KyResponse<GetSourceResponse>>;
+}
+
+interface Options$5 {
+    category?: string | string[];
+    request?: RequestInit;
+}
+type ListSourcesResponse = {
+    data: {
+        source: Source;
+    }[];
+};
+declare class ListSources {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ category, request }?: Options$5): Promise<ky.KyResponse<ListSourcesResponse>>;
+}
+
+/**
+ * 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
+ */
+type Upload = {
+    id: string;
+    name: string;
+    alternativeName?: string;
+    contentSize: number;
+    encodingFormat: string;
+    sha256: string;
+};
+
+interface Options$4 {
+    account: string;
+    files: File[];
+    request?: RequestInit;
+}
+type CreateUploadResponse = {
+    data: {
+        upload: Upload;
+    };
+};
+declare class CreateUpload {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ account, files, request }: Options$4): Promise<ky.KyResponse<CreateUploadResponse>>;
+}
+
+interface Options$3 {
+    id: string;
+    request?: RequestInit;
+}
+type DeleteUploadResponse = Record<string, never>;
+declare class DeleteUpload {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, request }: Options$3): Promise<ky.KyResponse<DeleteUploadResponse>>;
+}
+
+interface Options$2 {
+    id: string;
+    request?: RequestInit;
+}
+type GetUploadResponse = {
+    data: {
+        url: string;
+        expiresAt: string;
+        upload: Upload;
+    };
+};
+declare class GetUpload {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, request }: Options$2): Promise<ky.KyResponse<GetUploadResponse>>;
+}
+
+/**
+ * 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
+ */
+
+type Options$1 = {
+    request: {
+        body: unknown;
+        headers: Record<string, string | string[]>;
+        [key: string]: unknown | undefined;
+    };
+};
+type WebhookResponse = z.infer<typeof Webhook.SCHEMA>;
+declare class Webhook {
+    protected _client: Client;
+    static SCHEMA: z.ZodObject<{
+        event: z.ZodIntersection<z.ZodObject<{
+            id: z.ZodString;
+            createdAt: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+            createdAt: string;
+        }, {
+            id: string;
+            createdAt: string;
+        }>, z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+            type: z.ZodLiteral<"contact.created">;
+            contact: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            type: "contact.created";
+            contact: string;
+        }, {
+            type: "contact.created";
+            contact: string;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"message.created">;
+            message: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            message: string;
+            type: "message.created";
+        }, {
+            message: string;
+            type: "message.created";
+        }>]>>;
+    }, "strip", z.ZodTypeAny, {
+        event: {
+            id: string;
+            createdAt: string;
+        } & ({
+            type: "contact.created";
+            contact: string;
+        } | {
+            message: string;
+            type: "message.created";
+        });
+    }, {
+        event: {
+            id: string;
+            createdAt: string;
+        } & ({
+            type: "contact.created";
+            contact: string;
+        } | {
+            message: string;
+            type: "message.created";
+        });
+    }>;
+    constructor(_client: Client);
+    /**
+     * @deprecated Pre-release Functionality
+     */
+    event({ request }: Options$1): Promise<{
+        event: {
+            id: string;
+            createdAt: string;
+        } & ({
+            type: "contact.created";
+            contact: string;
+        } | {
+            message: string;
+            type: "message.created";
+        });
+    }>;
+}
+
+/**
+ * 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 {
+    baseURL?: string | URL;
+}
+declare class Client {
+    static DEFAULT_BASE_URL: string;
+    _transport: FetchTransport;
+    constructor(authentication: Authentication, { baseURL, ...options }?: Options);
+    static getBaseURL(): string;
+    get action(): {
+        list: ListActions;
+    };
+    get boilerplate(): {
+        get: GetBoilerplate;
+        list: ListBoilerplates;
+        update: UpdateBoilerplate;
+        create: CreateBoilerplate;
+    };
+    get boilerplateCategory(): {
+        get: GetBoilerplateCategory;
+        list: ListBoilerplateCategories;
+        create: CreateBoilerplateCategory;
+        update: UpdateBoilerplateCategory;
+        boilerplate: {
+            list: ListBoilerplateCategoryBoilerplates;
+        };
+    };
+    get channel(): {
+        get: GetChannel;
+        list: ListChannels;
+        update: UpdateChannel;
+        create: CreateChannel;
+        compositionSection: {
+            list: ListChannelCompositionSections;
+        };
+        message: {
+            list: ListChannelMessages;
+        };
+        twilioSendgrid: {
+            sync: TwilioSendgridChannelSync;
+        };
+    };
+    get compositionSection(): {
+        get: GetCompositionSection;
+        list: ListCompositionSections;
+        create: CreateCompositionSection;
+        update: UpdateCompositionSection;
+    };
+    get contact(): {
+        get: GetContact;
+        list: ListContacts;
+        update: UpdateContact;
+        create: CreateContact;
+        conversation: {
+            list: ListContactConversations;
+        };
+        note: {
+            list: ListContactNotes;
+            create: CreateContactNote;
+        };
+        notificationSubscription: {
+            create: CreateContactNotificationSubscription;
+        };
+        vcf: {
+            get: GetContactVCFURL;
+        };
+    };
+    get conversation(): {
+        get: GetConversation;
+        list: ListConversations;
+        update: UpdateConversation;
+        create: CreateConversationNote;
+        message: {
+            list: ListConversationMessages;
+        };
+        note: {
+            list: ListConversationNotes;
+            create: CreateConversationNote;
+        };
+    };
+    get label(): {
+        create: CreateLabel;
+        get: GetLabel;
+        list: ListLabels;
+        update: UpdateLabel;
+        delete: DeleteLabel;
+        contact: {
+            list: ListLabelContacts;
+        };
+        conversation: {
+            list: ListLabelConversations;
+        };
+    };
+    get message(): {
+        list: ListMessages;
+    };
+    get model(): {
+        get: GetModel;
+        list: ListModels;
+        response: {
+            create: CreateResponseModel;
+        };
+        correction: {
+            create: CreateCorrectionModel;
+        };
+    };
+    get note(): {
+        get: GetNote;
+        update: UpdateNote;
+    };
+    get source(): {
+        get: GetSource;
+        list: ListSources;
+    };
+    get upload(): {
+        get: GetUpload;
+        create: CreateUpload;
+        delete: DeleteUpload;
+    };
+    get webhook(): Webhook;
+}
+
+export { type Model as $, type Authentication as A, type Boilerplate as B, Client as C, type ListLabelContactsResponse as D, type UpdateContactResponse as E, type GetConversationResponse as F, type GetBoilerplateResponse as G, type ListConversationsResponse as H, type ListLabelConversationsResponse as I, type UpdateConversationResponse as J, type ListContactConversationsResponse as K, type ListActionsResponse as L, type Label as M, type CreateLabelResponse as N, type Options as O, type DeleteLabelResponse as P, type GetLabelResponse as Q, type RequestFilterable as R, type ListLabelsResponse as S, type TwilioSendgridChannelSyncResponse as T, type UpdateBoilerplateResponse as U, type UpdateLabelResponse as V, type WebhookResponse as W, type Message as X, type ListConversationMessagesResponse as Y, type ListMessagesResponse as Z, type ListChannelMessagesResponse as _, type Conversation as a, type GetModelResponse as a0, type ListModelsResponse as a1, type CreateCorrectionResponse as a2, type CreateResponseResponse as a3, type Note as a4, type CreateContactNoteResponse as a5, type CreateConversationNoteResponse as a6, type GetNoteResponse as a7, type ListContactNotesResponse as a8, type ListConversationNotesResponse as a9, type UpdateNoteResponse as aa, type Source as ab, type GetSourceResponse as ac, type ListSourcesResponse as ad, type NotificationSubscription as ae, type CreateContactNotificationSubscriptionResponse as af, type Upload as ag, type CreateUploadResponse as ah, type GetUploadResponse as ai, type DeleteUploadResponse as aj, type Options$W as b, type Action as c, type CreateBoilerplateResponse as d, type ListBoilerplateCategoryBoilerplatesResponse as e, type ListBoilerplatesResponse as f, type BoilerplateCategory as g, type CreateBoilerplateCategoryResponse as h, type GetBoilerplateCategoryResponse as i, type ListBoilerplateCategoriesResponse as j, type UpdateBoilerplateCategoryResponse as k, type Channel as l, type ListChannelsResponse as m, type GetChannelResponse as n, type UpdateChannelResponse as o, type CreateChannelResponse as p, type CompositionSection as q, type GetCompositionSectionResponse as r, type ListCompositionSectionsResponse as s, type CreateCompositionSectionResponse as t, type ListChannelCompositionSectionsResponse as u, type UpdateCompositionSectionResponse as v, type Contact as w, type CreateContactResponse as x, type GetContactResponse as y, type ListContactsResponse as z };