@great-detail/support-sdk 0.0.9 → 0.1.0

package/dist/{index-DtLhj7uf.d.cts → index-EaleABGN.d.cts}

@@ -32,13 +32,43 @@ type Authentication = RequestFilterable;
  * @see       https://greatdetail.com
  */
 
-interface Options$h extends SendOptions {
+interface TransportOptions {
+    requestFilterables: RequestFilterable[];
+    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 Transport {
+    options: TransportOptions;
+    constructor({ baseURL, ...options }: TransportOptions);
+    protected _filterRequest(request: RequestInit): Promise<RequestInit>;
+    send(url: string | URL, request: RequestInit, { fetch: fetchAlternative }?: SendOptions): Promise<Response>;
+}
+
+/**
+ * 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$l extends SendOptions {
     request?: RequestInit;
 }
 declare class ListActionsRequest {
-    protected _client: Client;
-    constructor(_client: Client);
-    send({ request, ...options }?: Options$h): Promise<ListActionsResponse>;
+    protected _transport: Transport;
+    constructor(_transport: Transport);
+    send({ request, ...options }?: Options$l): Promise<ListActionsResponse>;
 }
 type ListActionsResponsePayload = {
     actions: {
@@ -69,13 +99,13 @@ declare class ListActionsResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$g extends SendOptions {
+interface Options$k extends SendOptions {
     request?: RequestInit;
 }
 declare class ListChannelsRequest {
-    protected _client: Client;
-    constructor(_client: Client);
-    send({ request, ...options }?: Options$g): Promise<ListChannelsResponse>;
+    protected _transport: Transport;
+    constructor(_transport: Transport);
+    send({ request, ...options }?: Options$k): Promise<ListChannelsResponse>;
 }
 type ListChannelsResponsePayload = {
     channels: ({
@@ -116,14 +146,14 @@ declare class ListChannelsResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$f extends SendOptions {
+interface Options$j extends SendOptions {
     id: string;
     request?: RequestInit;
 }
 declare class GetContactRequest {
-    protected _client: Client;
-    constructor(_client: Client);
-    send({ id, request, ...options }: Options$f): Promise<GetContactResponse>;
+    protected _transport: Transport;
+    constructor(_transport: Transport);
+    send({ id, request, ...options }: Options$j): Promise<GetContactResponse>;
 }
 type GetContactResponsePayload = {
     contact: {
@@ -151,13 +181,13 @@ declare class GetContactResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$e extends SendOptions {
+interface Options$i extends SendOptions {
     request?: RequestInit;
 }
 declare class ListContactsRequest {
-    protected _client: Client;
-    constructor(_client: Client);
-    send({ request, ...options }?: Options$e): Promise<ListContactsResponse>;
+    protected _transport: Transport;
+    constructor(_transport: Transport);
+    send({ request, ...options }?: Options$i): Promise<ListContactsResponse>;
 }
 type ListContactsResponsePayload = {
     contacts: {
@@ -185,14 +215,63 @@ declare class ListContactsResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$d extends SendOptions {
+interface Options$h extends SendOptions {
+    id: string;
+    body: z.infer<typeof UpdateContactRequest.SCHEMA>;
+    request?: RequestInit;
+}
+declare class UpdateContactRequest {
+    protected _transport: Transport;
+    static SCHEMA: z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        emailAddress: z.ZodOptional<z.ZodString>;
+        telephoneNumber: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        name?: string | undefined;
+        emailAddress?: string | undefined;
+        telephoneNumber?: string | undefined;
+    }, {
+        name?: string | undefined;
+        emailAddress?: string | undefined;
+        telephoneNumber?: string | undefined;
+    }>;
+    constructor(_transport: Transport);
+    send({ id, body, request, ...options }: Options$h): Promise<UpdateContactResponse>;
+}
+type UpdateContactResponsePayload = {
+    contact: {
+        id: string;
+        name?: string;
+        emailAddress?: string;
+        telephoneNumber?: string;
+        account: string;
+        createdAt: string;
+        updatedAt?: string;
+    };
+};
+declare class UpdateContactResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<UpdateContactResponsePayload>;
+}
+
+/**
+ * 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$g extends SendOptions {
     id: string;
     request?: RequestInit;
 }
 declare class GetConversationRequest {
-    protected _client: Client;
-    constructor(_client: Client);
-    send({ id, request, ...options }: Options$d): Promise<GetConversationResponse>;
+    protected _transport: Transport;
+    constructor(_transport: Transport);
+    send({ id, request, ...options }: Options$g): Promise<GetConversationResponse>;
 }
 type GetConversationResponsePayload = {
     conversation: {
@@ -220,13 +299,13 @@ declare class GetConversationResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$c extends SendOptions {
+interface Options$f extends SendOptions {
     request?: RequestInit;
 }
 declare class ListConversationsRequest {
-    protected _client: Client;
-    constructor(_client: Client);
-    send({ request, ...options }?: Options$c): Promise<ListConversationsResponse>;
+    protected _transport: Transport;
+    constructor(_transport: Transport);
+    send({ request, ...options }?: Options$f): Promise<ListConversationsResponse>;
 }
 type ListConversationsResponsePayload = {
     conversations: {
@@ -254,13 +333,48 @@ declare class ListConversationsResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$b extends SendOptions {
+interface Options$e extends SendOptions {
+    id: string;
+    request?: RequestInit;
+}
+declare class ListLabelConversations {
+    protected _transport: Transport;
+    constructor(_transport: Transport);
+    send({ id, request, ...options }: Options$e): Promise<ListLabelConversationsResponse>;
+}
+type ListLabelConversationsResponsePayload = {
+    conversations: {
+        id: string;
+        name?: string;
+        hasEnded: boolean;
+        conversationStatus: "AwaitingContactConversationStatus" | "AwaitingAgentConversationStatus" | "ResolvedConversationStatus" | "ClosedConversationStatus";
+        accountChannel: string;
+        createdAt: string;
+        updatedAt: string;
+    }[];
+};
+declare class ListLabelConversationsResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<ListLabelConversationsResponsePayload>;
+}
+
+/**
+ * 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;
     body: z.infer<typeof UpdateConversationRequest.SCHEMA>;
     request?: RequestInit;
 }
 declare class UpdateConversationRequest {
-    protected _client: Client;
+    protected _transport: Transport;
     static SCHEMA: z.ZodObject<{
         hasEnded: z.ZodBoolean;
     }, "strip", z.ZodTypeAny, {
@@ -268,8 +382,8 @@ declare class UpdateConversationRequest {
     }, {
         hasEnded: boolean;
     }>;
-    constructor(_client: Client);
-    send({ id, body, request, ...options }: Options$b): Promise<UpdateConversationResponse>;
+    constructor(_transport: Transport);
+    send({ id, body, request, ...options }: Options$d): Promise<UpdateConversationResponse>;
 }
 type UpdateConversationResponsePayload = {
     conversation: {
@@ -297,12 +411,12 @@ declare class UpdateConversationResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$a extends SendOptions {
+interface Options$c extends SendOptions {
     body: z.infer<typeof CreateLabelRequest.SCHEMA>;
     request?: RequestInit;
 }
 declare class CreateLabelRequest {
-    protected _client: Client;
+    protected _transport: Transport;
     static SCHEMA: z.ZodObject<{
         title: z.ZodString;
         description: z.ZodOptional<z.ZodString>;
@@ -316,10 +430,10 @@ declare class CreateLabelRequest {
         account: string;
         description?: string | undefined;
     }>;
-    constructor(_client: Client);
-    send({ body, request, ...options }: Options$a): Promise<CreateLabelResponse>;
+    constructor(_transport: Transport);
+    send({ body, request, ...options }: Options$c): Promise<CreateLabelResponse>;
 }
-type CreateLabelResponsePayload = {
+type CreateLabelResponsePayload$1 = {
     label: {
         id: string;
         title: string;
@@ -332,7 +446,7 @@ type CreateLabelResponsePayload = {
 declare class CreateLabelResponse {
     response: Response;
     constructor(response: Response);
-    result(): Promise<CreateLabelResponsePayload>;
+    result(): Promise<CreateLabelResponsePayload$1>;
 }
 
 /**
@@ -344,14 +458,39 @@ declare class CreateLabelResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$9 extends SendOptions {
+interface Options$b extends SendOptions {
+    id: string;
+    request?: RequestInit;
+}
+declare class DeleteLabelRequest {
+    protected _transport: Transport;
+    constructor(_transport: Transport);
+    send({ id, request, ...options }: Options$b): Promise<DeleteLabelResponse>;
+}
+type DeleteLabelResponsePayload = Record<string, never>;
+declare class DeleteLabelResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<DeleteLabelResponsePayload>;
+}
+
+/**
+ * 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 {
     id: string;
     request?: RequestInit;
 }
 declare class GetLabelRequest {
-    protected _client: Client;
-    constructor(_client: Client);
-    send({ id, request, ...options }: Options$9): Promise<GetLabelResponse>;
+    protected _transport: Transport;
+    constructor(_transport: Transport);
+    send({ id, request, ...options }: Options$a): Promise<GetLabelResponse>;
 }
 type GetLabelResponsePayload = {
     label: {
@@ -378,13 +517,13 @@ declare class GetLabelResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$8 extends SendOptions {
+interface Options$9 extends SendOptions {
     request?: RequestInit;
 }
 declare class ListLabelsRequest {
-    protected _client: Client;
-    constructor(_client: Client);
-    send({ request, ...options }?: Options$8): Promise<ListLabelsResponse>;
+    protected _transport: Transport;
+    constructor(_transport: Transport);
+    send({ request, ...options }?: Options$9): Promise<ListLabelsResponse>;
 }
 type ListLabelsResponsePayload = {
     labels: {
@@ -402,6 +541,51 @@ declare class ListLabelsResponse {
     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$8 extends SendOptions {
+    id: string;
+    body: z.infer<typeof UpdateLabelRequest.SCHEMA>;
+    request?: RequestInit;
+}
+declare class UpdateLabelRequest {
+    protected _transport: Transport;
+    static SCHEMA: z.ZodObject<{
+        title: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        title?: string | undefined;
+        description?: string | undefined;
+    }, {
+        title?: string | undefined;
+        description?: string | undefined;
+    }>;
+    constructor(_transport: Transport);
+    send({ id, body, request, ...options }: Options$8): Promise<UpdateLabelResponse>;
+}
+type CreateLabelResponsePayload = {
+    label: {
+        id: string;
+        title: string;
+        description?: string;
+        account: string;
+        createdAt: string;
+        updatedAt?: string;
+    };
+};
+declare class UpdateLabelResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<CreateLabelResponsePayload>;
+}
+
 /**
  * Great Detail Support System.
  *
@@ -416,8 +600,8 @@ interface Options$7 extends SendOptions {
     request?: RequestInit;
 }
 declare class ListConversationMessages {
-    protected _client: Client;
-    constructor(_client: Client);
+    protected _transport: Transport;
+    constructor(_transport: Transport);
     send({ id, request, ...options }: Options$7): Promise<ListConversationMessagesResponse>;
 }
 type ListConversationMessagesResponsePayload = {
@@ -458,8 +642,8 @@ interface Options$6 extends SendOptions {
     request?: RequestInit;
 }
 declare class ListMessagesRequest {
-    protected _client: Client;
-    constructor(_client: Client);
+    protected _transport: Transport;
+    constructor(_transport: Transport);
     send({ request, ...options }?: Options$6): Promise<ListMessagesResponse>;
 }
 type ListMessagesResponsePayload = {
@@ -502,7 +686,7 @@ interface Options$5 extends SendOptions {
     request?: RequestInit;
 }
 declare class CreateCorrectionModelRequest {
-    protected _client: Client;
+    protected _transport: Transport;
     static SCHEMA: z.ZodObject<{
         input: z.ZodString;
         original: z.ZodString;
@@ -516,7 +700,7 @@ declare class CreateCorrectionModelRequest {
         original: string;
         correction: string;
     }>;
-    constructor(_client: Client);
+    constructor(_transport: Transport);
     send({ id, body, request, ...options }: Options$5): Promise<CreateCorrectionModelResponse>;
 }
 type CreateCorrectionResponsePayload = unknown;
@@ -540,8 +724,8 @@ interface Options$4 extends SendOptions {
     request?: RequestInit;
 }
 declare class GetModelRequest {
-    protected _client: Client;
-    constructor(_client: Client);
+    protected _transport: Transport;
+    constructor(_transport: Transport);
     send({ id, request, ...options }: Options$4): Promise<GetModelResponse>;
 }
 type GetModelResponsePayload = {
@@ -572,8 +756,8 @@ interface Options$3 extends SendOptions {
     request?: RequestInit;
 }
 declare class ListModelsRequest {
-    protected _client: Client;
-    constructor(_client: Client);
+    protected _transport: Transport;
+    constructor(_transport: Transport);
     send({ request, ...options }?: Options$3): Promise<ListModelsResponse>;
 }
 type ListModelsResponsePayload = {
@@ -606,7 +790,7 @@ interface Options$2 extends SendOptions {
     request?: RequestInit;
 }
 declare class CreateResponseModelRequest {
-    protected _client: Client;
+    protected _transport: Transport;
     static SCHEMA: z.ZodArray<z.ZodObject<{
         role: z.ZodEnum<["user", "assistant"]>;
         content: z.ZodNullable<z.ZodString>;
@@ -617,7 +801,7 @@ declare class CreateResponseModelRequest {
         role: "user" | "assistant";
         content: string | null;
     }>, "many">;
-    constructor(_client: Client);
+    constructor(_transport: Transport);
     send({ id, body, request, ...options }: Options$2): Promise<CreateResponseModelResponse>;
 }
 type CreateResponseResponsePayload = {
@@ -647,8 +831,8 @@ interface Options$1 extends SendOptions {
     request?: RequestInit;
 }
 declare class GetSourceRequest {
-    protected _client: Client;
-    constructor(_client: Client);
+    protected _transport: Transport;
+    constructor(_transport: Transport);
     send({ id, request, ...options }: Options$1): Promise<GetSourceResponse>;
 }
 type GetSourceResponsePayload = {
@@ -680,8 +864,8 @@ interface Options extends SendOptions {
     request?: RequestInit;
 }
 declare class ListSourcesRequest {
-    protected _client: Client;
-    constructor(_client: Client);
+    protected _transport: Transport;
+    constructor(_transport: Transport);
     send({ request, ...options }?: Options): Promise<ListSourcesResponse>;
 }
 type ListSourcesResponsePayload = {
@@ -710,37 +894,25 @@ declare class ListSourcesResponse {
  */
 
 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;
+    baseURL?: string | URL;
 }
 declare class Client {
     static DEFAULT_BASE_URL: string;
-    options: ClientOptions;
-    constructor(authentication: Authentication, options?: InputClientOptions);
-    action: {
+    transport: Transport;
+    constructor(authentication: Authentication, { baseURL, ...options }?: ClientOptions);
+    static getBaseURL(): string;
+    get action(): {
         list: ListActionsRequest;
     };
-    channel: {
+    get channel(): {
         list: ListChannelsRequest;
     };
-    contact: {
+    get contact(): {
         get: GetContactRequest;
         list: ListContactsRequest;
+        update: UpdateContactRequest;
     };
-    conversation: {
+    get conversation(): {
         get: GetConversationRequest;
         list: ListConversationsRequest;
         update: UpdateConversationRequest;
@@ -748,15 +920,20 @@ declare class Client {
             list: ListConversationMessages;
         };
     };
-    label: {
+    get label(): {
         create: CreateLabelRequest;
         get: GetLabelRequest;
         list: ListLabelsRequest;
+        update: UpdateLabelRequest;
+        delete: DeleteLabelRequest;
+        conversation: {
+            list: ListLabelConversations;
+        };
     };
-    message: {
+    get message(): {
         list: ListMessagesRequest;
     };
-    model: {
+    get model(): {
         get: GetModelRequest;
         list: ListModelsRequest;
         response: {
@@ -766,12 +943,10 @@ declare class Client {
             create: CreateCorrectionModelRequest;
         };
     };
-    source: {
+    get 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 };
+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$1 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 };