@great-detail/support-sdk 0.10.2 → 0.10.3

package/dist/cli/index.d.cts

@@ -1,5 +1,5 @@
 import { Command } from 'commander';
-import { C as Client } from '../index-BziB0Sgb.cjs';
+import { C as Client } from '../index-CHwV9Mrz.cjs';
 import { Options as Options$1 } from 'ora';
 import 'ky';
 import 'zod';

package/dist/cli/index.d.ts

@@ -1,5 +1,5 @@
 import { Command } from 'commander';
-import { C as Client } from '../index-BziB0Sgb.js';
+import { C as Client } from '../index-CHwV9Mrz.js';
 import { Options as Options$1 } from 'ora';
 import 'ky';
 import 'zod';

package/dist/{index-BziB0Sgb.d.cts → index-CHwV9Mrz.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;
@@ -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;
@@ -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,9 +783,7 @@ type Conversation = {
     contacts: string[];
     status: "AwaitingContactConversationStatus" | "AwaitingAgentConversationStatus" | "ResolvedConversationStatus" | "ClosedConversationStatus";
     channel: string;
-    createdAt: string;
-    updatedAt: string;
-};
+} & ResponseTimestamp;
 
 interface IncludeOptions$3 {
     channel?: boolean;
@@ -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,7 +862,7 @@ type Message = {
     };
 } | {
     type: "richtext";
-});
+}) & ResponseTimestamp;
 
 interface IncludeOptions$2 {
     latestMessage?: boolean;
@@ -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;
@@ -1220,12 +1228,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 +1356,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 +1447,7 @@ declare class ListSources {
  * @author    Dom Webber <dom.webber@greatdetail.com>
  * @see       https://greatdetail.com
  */
+
 type Upload = {
     id: string;
     name: string;
@@ -1448,7 +1455,7 @@ type Upload = {
     contentSize: number;
     encodingFormat: string;
     sha256: string;
-};
+} & ResponseTimestamp;
 
 interface CreateUploadOptions {
     account: string;

package/dist/{index-BziB0Sgb.d.ts → index-CHwV9Mrz.d.ts}

@@ -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;
@@ -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;
@@ -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,9 +783,7 @@ type Conversation = {
     contacts: string[];
     status: "AwaitingContactConversationStatus" | "AwaitingAgentConversationStatus" | "ResolvedConversationStatus" | "ClosedConversationStatus";
     channel: string;
-    createdAt: string;
-    updatedAt: string;
-};
+} & ResponseTimestamp;
 
 interface IncludeOptions$3 {
     channel?: boolean;
@@ -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,7 +862,7 @@ type Message = {
     };
 } | {
     type: "richtext";
-});
+}) & ResponseTimestamp;
 
 interface IncludeOptions$2 {
     latestMessage?: boolean;
@@ -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;
@@ -1220,12 +1228,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 +1356,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 +1447,7 @@ declare class ListSources {
  * @author    Dom Webber <dom.webber@greatdetail.com>
  * @see       https://greatdetail.com
  */
+
 type Upload = {
     id: string;
     name: string;
@@ -1448,7 +1455,7 @@ type Upload = {
     contentSize: number;
     encodingFormat: string;
     sha256: string;
-};
+} & ResponseTimestamp;
 
 interface CreateUploadOptions {
     account: string;

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { A as Authentication, a as Conversation } from './index-BziB0Sgb.cjs';
-export { c as Action, B as Boilerplate, g as BoilerplateCategory, l as Channel, C as Client, q as CompositionSection, w as Contact, h as CreateBoilerplateCategoryResponse, d as CreateBoilerplateResponse, p as CreateChannelResponse, t as CreateCompositionSectionResponse, a6 as CreateContactNoteResponse, ag as CreateContactNotificationSubscriptionResponse, x as CreateContactResponse, a7 as CreateConversationNoteResponse, a3 as CreateCorrectionResponse, N as CreateLabelResponse, a4 as CreateResponseResponse, ai as CreateUploadResponse, P as DeleteLabelResponse, ak as DeleteUploadResponse, i as GetBoilerplateCategoryResponse, G as GetBoilerplateResponse, n as GetChannelResponse, r as GetCompositionSectionResponse, y as GetContactResponse, F as GetConversationResponse, Q as GetLabelResponse, a1 as GetModelResponse, a8 as GetNoteResponse, al as GetNotificationWellKnownResponse, ad as GetSourceResponse, aj as GetUploadResponse, M as Label, L as ListActionsResponse, j as ListBoilerplateCategoriesResponse, e as ListBoilerplateCategoryBoilerplatesResponse, f as ListBoilerplatesResponse, u as ListChannelCompositionSectionsResponse, $ as ListChannelMessagesResponse, m as ListChannelsResponse, s as ListCompositionSectionsResponse, K as ListContactConversationsResponse, a9 as ListContactNotesResponse, z as ListContactsResponse, X as ListConversationLabelsResponse, Z as ListConversationMessagesResponse, aa as ListConversationNotesResponse, H as ListConversationsResponse, D as ListLabelContactsResponse, I as ListLabelConversationsResponse, S as ListLabelsResponse, _ as ListMessagesResponse, a2 as ListModelsResponse, ae as ListSourcesResponse, Y as Message, a0 as Model, a5 as Note, af as NotificationSubscription, O as Options, R as RequestFilterable, ac as Source, b as TransportOptions, T as TwilioSendgridChannelSyncResponse, k as UpdateBoilerplateCategoryResponse, U as UpdateBoilerplateResponse, o as UpdateChannelResponse, v as UpdateCompositionSectionResponse, E as UpdateContactResponse, J as UpdateConversationResponse, V as UpdateLabelResponse, ab as UpdateNoteResponse, ah as Upload, W as WebhookResponse, C as default } from './index-BziB0Sgb.cjs';
+import { A as Authentication, a as Conversation } from './index-CHwV9Mrz.cjs';
+export { c as Action, B as Boilerplate, g as BoilerplateCategory, l as Channel, C as Client, q as CompositionSection, w as Contact, h as CreateBoilerplateCategoryResponse, d as CreateBoilerplateResponse, p as CreateChannelResponse, t as CreateCompositionSectionResponse, a6 as CreateContactNoteResponse, ag as CreateContactNotificationSubscriptionResponse, x as CreateContactResponse, a7 as CreateConversationNoteResponse, a3 as CreateCorrectionResponse, N as CreateLabelResponse, a4 as CreateResponseResponse, ai as CreateUploadResponse, P as DeleteLabelResponse, ak as DeleteUploadResponse, i as GetBoilerplateCategoryResponse, G as GetBoilerplateResponse, n as GetChannelResponse, r as GetCompositionSectionResponse, y as GetContactResponse, F as GetConversationResponse, Q as GetLabelResponse, a1 as GetModelResponse, a8 as GetNoteResponse, al as GetNotificationWellKnownResponse, ad as GetSourceResponse, aj as GetUploadResponse, M as Label, L as ListActionsResponse, j as ListBoilerplateCategoriesResponse, e as ListBoilerplateCategoryBoilerplatesResponse, f as ListBoilerplatesResponse, u as ListChannelCompositionSectionsResponse, $ as ListChannelMessagesResponse, m as ListChannelsResponse, s as ListCompositionSectionsResponse, K as ListContactConversationsResponse, a9 as ListContactNotesResponse, z as ListContactsResponse, X as ListConversationLabelsResponse, Z as ListConversationMessagesResponse, aa as ListConversationNotesResponse, H as ListConversationsResponse, D as ListLabelContactsResponse, I as ListLabelConversationsResponse, S as ListLabelsResponse, _ as ListMessagesResponse, a2 as ListModelsResponse, ae as ListSourcesResponse, Y as Message, a0 as Model, a5 as Note, af as NotificationSubscription, O as Options, R as RequestFilterable, ac as Source, b as TransportOptions, T as TwilioSendgridChannelSyncResponse, k as UpdateBoilerplateCategoryResponse, U as UpdateBoilerplateResponse, o as UpdateChannelResponse, v as UpdateCompositionSectionResponse, E as UpdateContactResponse, J as UpdateConversationResponse, V as UpdateLabelResponse, ab as UpdateNoteResponse, ah as Upload, W as WebhookResponse, C as default } from './index-CHwV9Mrz.cjs';
 import 'ky';
 import 'zod';
 

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { A as Authentication, a as Conversation } from './index-BziB0Sgb.js';
-export { c as Action, B as Boilerplate, g as BoilerplateCategory, l as Channel, C as Client, q as CompositionSection, w as Contact, h as CreateBoilerplateCategoryResponse, d as CreateBoilerplateResponse, p as CreateChannelResponse, t as CreateCompositionSectionResponse, a6 as CreateContactNoteResponse, ag as CreateContactNotificationSubscriptionResponse, x as CreateContactResponse, a7 as CreateConversationNoteResponse, a3 as CreateCorrectionResponse, N as CreateLabelResponse, a4 as CreateResponseResponse, ai as CreateUploadResponse, P as DeleteLabelResponse, ak as DeleteUploadResponse, i as GetBoilerplateCategoryResponse, G as GetBoilerplateResponse, n as GetChannelResponse, r as GetCompositionSectionResponse, y as GetContactResponse, F as GetConversationResponse, Q as GetLabelResponse, a1 as GetModelResponse, a8 as GetNoteResponse, al as GetNotificationWellKnownResponse, ad as GetSourceResponse, aj as GetUploadResponse, M as Label, L as ListActionsResponse, j as ListBoilerplateCategoriesResponse, e as ListBoilerplateCategoryBoilerplatesResponse, f as ListBoilerplatesResponse, u as ListChannelCompositionSectionsResponse, $ as ListChannelMessagesResponse, m as ListChannelsResponse, s as ListCompositionSectionsResponse, K as ListContactConversationsResponse, a9 as ListContactNotesResponse, z as ListContactsResponse, X as ListConversationLabelsResponse, Z as ListConversationMessagesResponse, aa as ListConversationNotesResponse, H as ListConversationsResponse, D as ListLabelContactsResponse, I as ListLabelConversationsResponse, S as ListLabelsResponse, _ as ListMessagesResponse, a2 as ListModelsResponse, ae as ListSourcesResponse, Y as Message, a0 as Model, a5 as Note, af as NotificationSubscription, O as Options, R as RequestFilterable, ac as Source, b as TransportOptions, T as TwilioSendgridChannelSyncResponse, k as UpdateBoilerplateCategoryResponse, U as UpdateBoilerplateResponse, o as UpdateChannelResponse, v as UpdateCompositionSectionResponse, E as UpdateContactResponse, J as UpdateConversationResponse, V as UpdateLabelResponse, ab as UpdateNoteResponse, ah as Upload, W as WebhookResponse, C as default } from './index-BziB0Sgb.js';
+import { A as Authentication, a as Conversation } from './index-CHwV9Mrz.js';
+export { c as Action, B as Boilerplate, g as BoilerplateCategory, l as Channel, C as Client, q as CompositionSection, w as Contact, h as CreateBoilerplateCategoryResponse, d as CreateBoilerplateResponse, p as CreateChannelResponse, t as CreateCompositionSectionResponse, a6 as CreateContactNoteResponse, ag as CreateContactNotificationSubscriptionResponse, x as CreateContactResponse, a7 as CreateConversationNoteResponse, a3 as CreateCorrectionResponse, N as CreateLabelResponse, a4 as CreateResponseResponse, ai as CreateUploadResponse, P as DeleteLabelResponse, ak as DeleteUploadResponse, i as GetBoilerplateCategoryResponse, G as GetBoilerplateResponse, n as GetChannelResponse, r as GetCompositionSectionResponse, y as GetContactResponse, F as GetConversationResponse, Q as GetLabelResponse, a1 as GetModelResponse, a8 as GetNoteResponse, al as GetNotificationWellKnownResponse, ad as GetSourceResponse, aj as GetUploadResponse, M as Label, L as ListActionsResponse, j as ListBoilerplateCategoriesResponse, e as ListBoilerplateCategoryBoilerplatesResponse, f as ListBoilerplatesResponse, u as ListChannelCompositionSectionsResponse, $ as ListChannelMessagesResponse, m as ListChannelsResponse, s as ListCompositionSectionsResponse, K as ListContactConversationsResponse, a9 as ListContactNotesResponse, z as ListContactsResponse, X as ListConversationLabelsResponse, Z as ListConversationMessagesResponse, aa as ListConversationNotesResponse, H as ListConversationsResponse, D as ListLabelContactsResponse, I as ListLabelConversationsResponse, S as ListLabelsResponse, _ as ListMessagesResponse, a2 as ListModelsResponse, ae as ListSourcesResponse, Y as Message, a0 as Model, a5 as Note, af as NotificationSubscription, O as Options, R as RequestFilterable, ac as Source, b as TransportOptions, T as TwilioSendgridChannelSyncResponse, k as UpdateBoilerplateCategoryResponse, U as UpdateBoilerplateResponse, o as UpdateChannelResponse, v as UpdateCompositionSectionResponse, E as UpdateContactResponse, J as UpdateConversationResponse, V as UpdateLabelResponse, ab as UpdateNoteResponse, ah as Upload, W as WebhookResponse, C as default } from './index-CHwV9Mrz.js';
 import 'ky';
 import 'zod';
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@great-detail/support-sdk",
-  "version": "0.10.2",
+  "version": "0.10.3",
   "type": "module",
   "description": "JavaScript SDK for the Great Detail Support System",
   "author": "Great Detail Ltd <info@greatdetail.com>",