@great-detail/support-sdk 0.10.2 → 0.10.4

package/dist/{index-BziB0Sgb.d.cts → index-j66TcxXG.d.cts}

@@ -65,6 +65,23 @@ declare class FetchTransport implements Transport {
  * @author    Dom Webber <dom.webber@greatdetail.com>
  * @see       https://greatdetail.com
  */
+type CreatedAtResponseTimestamp = {
+    createdAt: string;
+};
+type UpdatedAtResponseTimestamp = {
+    updatedAt: string;
+};
+type ResponseTimestamp = CreatedAtResponseTimestamp & UpdatedAtResponseTimestamp;
+
+/**
+ * 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;
@@ -74,9 +91,7 @@ type Action = {
     result?: string;
     startedAt?: string;
     endedAt?: string;
-    createdAt: string;
-    updatedAt: string;
-};
+} & ResponseTimestamp;
 
 interface ListActionsOptions {
     request?: RequestInit;
@@ -114,15 +129,14 @@ type Authentication = RequestFilterable;
  * @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;
-};
+} & ResponseTimestamp;
 
 type CreateBoilerplatePayload = {
     title: string;
@@ -230,14 +244,13 @@ declare class UpdateBoilerplate {
  * @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;
-};
+} & ResponseTimestamp;
 
 type CreateBoilerplateCategoryPayload = {
     title: string;
@@ -279,15 +292,15 @@ declare class GetBoilerplateCategory {
     };
 }
 
-interface IncludeOptions$5 {
+interface IncludeOptions$6 {
     boilerplateCount?: boolean;
     [key: string]: boolean | undefined;
 }
-interface ListBoilerplateCategoriesOptions<C extends IncludeOptions$5> {
+interface ListBoilerplateCategoriesOptions<C extends IncludeOptions$6> {
     include?: C;
     request?: RequestInit;
 }
-type ListBoilerplateCategoriesResponse<C extends IncludeOptions$5> = {
+type ListBoilerplateCategoriesResponse<C extends IncludeOptions$6> = {
     data: {
         boilerplateCategory: BoilerplateCategory;
         boilerplateCount?: C extends {
@@ -298,7 +311,7 @@ type ListBoilerplateCategoriesResponse<C extends IncludeOptions$5> = {
 declare class ListBoilerplateCategories {
     protected _transport: FetchTransport;
     constructor(_transport: FetchTransport);
-    send<C extends IncludeOptions$5>({ include, request, }?: ListBoilerplateCategoriesOptions<C>): {
+    send<C extends IncludeOptions$6>({ include, request, }?: ListBoilerplateCategoriesOptions<C>): {
         response: () => Promise<ky.KyResponse<ListBoilerplateCategoriesResponse<C>>>;
         json: () => Promise<ListBoilerplateCategoriesResponse<C>>;
     };
@@ -334,13 +347,12 @@ declare class UpdateBoilerplateCategory {
  * @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: {
@@ -364,7 +376,7 @@ type Channel = {
             secretExcerpt: string;
         }[];
     };
-});
+}) & ResponseTimestamp;
 
 type CreateChannelPayload = {
     name?: string;
@@ -500,15 +512,14 @@ declare class UpdateChannel {
  * @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;
-};
+} & ResponseTimestamp;
 
 type CreateCompositionSectionPayload = {
     account: string;
@@ -635,15 +646,15 @@ declare class GetContactVCFURL {
  * @author    Dom Webber <dom.webber@greatdetail.com>
  * @see       https://greatdetail.com
  */
+
 type Contact = {
     id: string;
     name?: string;
     emailAddress?: string;
     telephoneNumber?: string;
+    metaWhatsappPhoneNumberID?: string;
     account: string;
-    createdAt: string;
-    updatedAt: string;
-};
+} & ResponseTimestamp;
 
 type CreateContactPayload = {
     name: string;
@@ -669,16 +680,16 @@ declare class CreateContact {
     };
 }
 
-interface IncludeOptions$4 {
+interface IncludeOptions$5 {
     messageCount?: boolean;
     conversationCount?: boolean;
     [key: string]: boolean | undefined;
 }
-interface GetContactOptions<C extends IncludeOptions$4> {
+interface GetContactOptions<C extends IncludeOptions$5> {
     include?: C;
     request?: RequestInit;
 }
-type GetContactResponse<C extends IncludeOptions$4> = {
+type GetContactResponse<C extends IncludeOptions$5> = {
     data: {
         contact: Contact;
         messageCount?: C extends {
@@ -692,7 +703,7 @@ type GetContactResponse<C extends IncludeOptions$4> = {
 declare class GetContact {
     protected _transport: FetchTransport;
     constructor(_transport: FetchTransport);
-    send<C extends IncludeOptions$4>(id: string, { include, request }?: GetContactOptions<C>): {
+    send<C extends IncludeOptions$5>(id: string, { include, request }?: GetContactOptions<C>): {
         response: () => Promise<ky.KyResponse<GetContactResponse<C>>>;
         json: () => Promise<GetContactResponse<C>>;
     };
@@ -764,6 +775,7 @@ declare class UpdateContact {
  * @author    Dom Webber <dom.webber@greatdetail.com>
  * @see       https://greatdetail.com
  */
+
 type Conversation = {
     id: string;
     name?: string;
@@ -771,19 +783,17 @@ type Conversation = {
     contacts: string[];
     status: "AwaitingContactConversationStatus" | "AwaitingAgentConversationStatus" | "ResolvedConversationStatus" | "ClosedConversationStatus";
     channel: string;
-    createdAt: string;
-    updatedAt: string;
-};
+} & ResponseTimestamp;
 
-interface IncludeOptions$3 {
+interface IncludeOptions$4 {
     channel?: boolean;
     [key: string]: boolean | undefined;
 }
-interface GetConversationOptions<C extends IncludeOptions$3> {
+interface GetConversationOptions<C extends IncludeOptions$4> {
     include?: C;
     request?: RequestInit;
 }
-type GetConversationResponse<C extends IncludeOptions$3> = {
+type GetConversationResponse<C extends IncludeOptions$4> = {
     data: {
         conversation: Conversation;
         channel: C extends {
@@ -794,7 +804,7 @@ type GetConversationResponse<C extends IncludeOptions$3> = {
 declare class GetConversation {
     protected _transport: FetchTransport;
     constructor(_transport: FetchTransport);
-    send<C extends IncludeOptions$3>(id: string, { include, request }?: GetConversationOptions<C>): {
+    send<C extends IncludeOptions$4>(id: string, { include, request }?: GetConversationOptions<C>): {
         response: () => Promise<ky.KyResponse<GetConversationResponse<C>>>;
         json: () => Promise<GetConversationResponse<C>>;
     };
@@ -825,6 +835,7 @@ declare class ListContactConversations {
  * @author    Dom Webber <dom.webber@greatdetail.com>
  * @see       https://greatdetail.com
  */
+
 type Message = {
     id: string;
     role: "user" | "assistant";
@@ -839,8 +850,6 @@ type Message = {
         createdAt: string;
         updatedAt?: string;
     }[];
-    createdAt: string;
-    updatedAt: string;
 } & ({
     type: "text";
     messageText: {
@@ -853,19 +862,19 @@ type Message = {
     };
 } | {
     type: "richtext";
-});
+}) & ResponseTimestamp;
 
-interface IncludeOptions$2 {
+interface IncludeOptions$3 {
     latestMessage?: boolean;
     [key: string]: boolean | undefined;
 }
 type FilterOptions = "unresolved" | "awaitingContact" | "awaitingAgent" | (string & NonNullable<unknown>);
-interface ListConversationOptions<C extends IncludeOptions$2> {
+interface ListConversationOptions<C extends IncludeOptions$3> {
     filter?: FilterOptions;
     include?: C;
     request?: RequestInit;
 }
-type ListConversationsResponse<C extends IncludeOptions$2> = {
+type ListConversationsResponse<C extends IncludeOptions$3> = {
     data: {
         conversation: Conversation;
         latestMessage?: C extends {
@@ -876,7 +885,7 @@ type ListConversationsResponse<C extends IncludeOptions$2> = {
 declare class ListConversations {
     protected _transport: FetchTransport;
     constructor(_transport: FetchTransport);
-    send<C extends IncludeOptions$2>({ filter, include, request, }?: ListConversationOptions<C>): {
+    send<C extends IncludeOptions$3>({ filter, include, request, }?: ListConversationOptions<C>): {
         response: () => Promise<ky.KyResponse<ListConversationsResponse<C>>>;
         json: () => Promise<ListConversationsResponse<C>>;
     };
@@ -929,14 +938,13 @@ declare class UpdateConversation {
  * @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;
-};
+} & ResponseTimestamp;
 
 type CreateLabelPayload = {
     title: string;
@@ -1008,17 +1016,17 @@ declare class ListConversationLabels {
     };
 }
 
-interface IncludeOptions$1 {
+interface IncludeOptions$2 {
     contactCount?: boolean;
     conversationCount?: boolean;
     [key: string]: boolean | undefined;
 }
-interface ListLabelsOptions<C extends IncludeOptions$1> {
+interface ListLabelsOptions<C extends IncludeOptions$2> {
     query?: string;
     include?: C;
     request?: RequestInit;
 }
-type ListLabelsResponse<C extends IncludeOptions$1> = {
+type ListLabelsResponse<C extends IncludeOptions$2> = {
     data: {
         label: Label;
         contactCount?: C extends {
@@ -1032,7 +1040,7 @@ type ListLabelsResponse<C extends IncludeOptions$1> = {
 declare class ListLabels {
     protected _transport: FetchTransport;
     constructor(_transport: FetchTransport);
-    send<C extends IncludeOptions$1>({ query, include, request, }?: ListLabelsOptions<C>): {
+    send<C extends IncludeOptions$2>({ query, include, request, }?: ListLabelsOptions<C>): {
         response: () => Promise<ky.KyResponse<ListLabelsResponse<C>>>;
         json: () => Promise<ListLabelsResponse<C>>;
     };
@@ -1077,15 +1085,15 @@ declare class ListChannelMessages {
     };
 }
 
-interface IncludeOptions {
+interface IncludeOptions$1 {
     contact?: boolean;
     [key: string]: boolean | undefined;
 }
-interface ListConversationMessagesOptions<C extends IncludeOptions> {
+interface ListConversationMessagesOptions<C extends IncludeOptions$1> {
     include?: C;
     request?: RequestInit;
 }
-type ListConversationMessagesResponse<C extends IncludeOptions> = {
+type ListConversationMessagesResponse<C extends IncludeOptions$1> = {
     data: {
         message: Message;
         contact?: C extends {
@@ -1096,26 +1104,34 @@ type ListConversationMessagesResponse<C extends IncludeOptions> = {
 declare class ListConversationMessages {
     protected _transport: FetchTransport;
     constructor(_transport: FetchTransport);
-    send<C extends IncludeOptions>(id: string, { include, request }?: ListConversationMessagesOptions<C>): {
+    send<C extends IncludeOptions$1>(id: string, { include, request }?: ListConversationMessagesOptions<C>): {
         response: () => Promise<ky.KyResponse<ListConversationMessagesResponse<C>>>;
         json: () => Promise<ListConversationMessagesResponse<C>>;
     };
 }
 
-interface ListMessagesOptions {
+interface IncludeOptions {
+    contact?: boolean;
+    [key: string]: boolean | undefined;
+}
+interface ListMessagesOptions<C extends IncludeOptions> {
+    include?: C;
     request?: RequestInit;
 }
-type ListMessagesResponse = {
+type ListMessagesResponse<C extends IncludeOptions> = {
     data: {
         message: Message;
+        contact?: C extends {
+            contact: true;
+        } ? Contact : never;
     }[];
 };
 declare class ListMessages {
     protected _transport: FetchTransport;
     constructor(_transport: FetchTransport);
-    send({ request }?: ListMessagesOptions): {
-        response: () => Promise<ky.KyResponse<ListMessagesResponse>>;
-        json: () => Promise<ListMessagesResponse>;
+    send<C extends IncludeOptions>({ include, request, }?: ListMessagesOptions<C>): {
+        response: () => Promise<ky.KyResponse<ListMessagesResponse<C>>>;
+        json: () => Promise<ListMessagesResponse<C>>;
     };
 }
 
@@ -1220,12 +1236,11 @@ declare class CreateResponseModel {
  * @author    Dom Webber <dom.webber@greatdetail.com>
  * @see       https://greatdetail.com
  */
+
 type Note = {
     id: string;
     content: string;
-    createdAt: string;
-    updatedAt: string;
-};
+} & ResponseTimestamp;
 
 type CreateContactNotePayload = {
     content: string;
@@ -1349,11 +1364,10 @@ declare class UpdateNote {
  * @author    Dom Webber <dom.webber@greatdetail.com>
  * @see       https://greatdetail.com
  */
+
 type NotificationSubscription = {
     id: string;
-    createdAt: string;
-    updatedAt: string;
-};
+} & ResponseTimestamp;
 
 type CreateContactNotificationSubscriptionPayload = {
     type: "vapid";
@@ -1441,6 +1455,7 @@ declare class ListSources {
  * @author    Dom Webber <dom.webber@greatdetail.com>
  * @see       https://greatdetail.com
  */
+
 type Upload = {
     id: string;
     name: string;
@@ -1448,7 +1463,7 @@ type Upload = {
     contentSize: number;
     encodingFormat: string;
     sha256: string;
-};
+} & ResponseTimestamp;
 
 interface CreateUploadOptions {
     account: string;