@great-detail/support-sdk 0.3.1 → 0.3.3

package/dist/{index-BZ58JQ7A.d.cts → index-yIZZNsRM.d.cts}

@@ -28,21 +28,21 @@ interface RequestFilterable {
  * @see       https://greatdetail.com
  */
 
-interface Options$G {
+interface Options$H {
     requestFilterables: RequestFilterable[];
 }
 interface Transport {
     getURL(url: string): string;
 }
 
-interface InputOptions extends Options$G {
+interface InputOptions extends Options$H {
     baseURL: string;
 }
-interface Options$F extends Options$G {
+interface Options$G extends Options$H {
     baseURL: string;
 }
 declare class FetchTransport implements Transport {
-    options: Options$F;
+    options: Options$G;
     constructor({ baseURL, ...options }: InputOptions);
     getURL(url: string): string;
     getRequest(url: string, request: RequestInit): Request;
@@ -58,13 +58,13 @@ declare class FetchTransport implements Transport {
  * @see       https://greatdetail.com
  */
 
-interface Options$E {
+interface Options$F {
     request?: RequestInit;
 }
 declare class ListActions {
     protected _transport: FetchTransport;
     constructor(_transport: FetchTransport);
-    send({ request }?: Options$E): Promise<ListActionsResponse>;
+    send({ request }?: Options$F): Promise<ListActionsResponse>;
 }
 type ListActionsResponsePayload = {
     actions: {
@@ -106,7 +106,7 @@ type Authentication = RequestFilterable;
  * @see       https://greatdetail.com
  */
 
-interface Options$D {
+interface Options$E {
     id: string;
     body: z.infer<typeof CreateBoilerplateCategoryBoilerplate.SCHEMA>;
     request?: RequestInit;
@@ -127,7 +127,7 @@ declare class CreateBoilerplateCategoryBoilerplate {
         account: string;
     }>;
     constructor(_transport: FetchTransport);
-    send({ id, body, request }: Options$D): Promise<CreateBoilerplateCategoryBoilerplateResponse>;
+    send({ id, body, request }: Options$E): Promise<CreateBoilerplateCategoryBoilerplateResponse>;
 }
 type CreateBoilerplateCategoryBoilerplateResponsePayload = {
     boilerplate: {
@@ -154,14 +154,14 @@ declare class CreateBoilerplateCategoryBoilerplateResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$C {
+interface Options$D {
     id: string;
     request?: RequestInit;
 }
 declare class GetBoilerplate {
     protected _transport: FetchTransport;
     constructor(_transport: FetchTransport);
-    send({ id, request }: Options$C): Promise<GetBoilerplateResponse>;
+    send({ id, request }: Options$D): Promise<GetBoilerplateResponse>;
 }
 type GetBoilerplateResponsePayload = {
     boilerplate: {
@@ -189,14 +189,14 @@ declare class GetBoilerplateResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$B {
+interface Options$C {
     id: string;
     request?: RequestInit;
 }
 declare class ListBoilerplateCategoryBoilerplates {
     protected _transport: FetchTransport;
     constructor(_transport: FetchTransport);
-    send({ id, request }: Options$B): Promise<ListBoilerplateCategoryBoilerplatesResponse>;
+    send({ id, request }: Options$C): Promise<ListBoilerplateCategoryBoilerplatesResponse>;
 }
 type ListBoilerplateCategoryBoilerplatesResponsePayload = {
     boilerplates: {
@@ -224,13 +224,13 @@ declare class ListBoilerplateCategoryBoilerplatesResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$A {
+interface Options$B {
     request?: RequestInit;
 }
 declare class ListBoilerplates {
     protected _transport: FetchTransport;
     constructor(_transport: FetchTransport);
-    send({ request }?: Options$A): Promise<ListBoilerplatesResponse>;
+    send({ request }?: Options$B): Promise<ListBoilerplatesResponse>;
 }
 type ListBoilerplatesResponsePayload = {
     boilerplates: {
@@ -258,7 +258,7 @@ declare class ListBoilerplatesResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$z {
+interface Options$A {
     id: string;
     body: z.infer<typeof UpdateBoilerplate.SCHEMA>;
     request?: RequestInit;
@@ -276,7 +276,7 @@ declare class UpdateBoilerplate {
         content?: string | undefined;
     }>;
     constructor(_transport: FetchTransport);
-    send({ id, body, request }: Options$z): Promise<UpdateBoilerplateResponse>;
+    send({ id, body, request }: Options$A): Promise<UpdateBoilerplateResponse>;
 }
 type UpdateBoilerplateResponsePayload = {
     boilerplate: {
@@ -304,7 +304,7 @@ declare class UpdateBoilerplateResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$y {
+interface Options$z {
     body: z.infer<typeof CreateBoilerplateCategory.SCHEMA>;
     request?: RequestInit;
 }
@@ -324,7 +324,7 @@ declare class CreateBoilerplateCategory {
         description?: string | undefined;
     }>;
     constructor(_transport: FetchTransport);
-    send({ body, request }: Options$y): Promise<CreateBoilerplateCategoryResponse>;
+    send({ body, request }: Options$z): Promise<CreateBoilerplateCategoryResponse>;
 }
 type CreateBoilerplateCategoryResponsePayload = {
     boilerplateCategory: {
@@ -351,14 +351,14 @@ declare class CreateBoilerplateCategoryResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$x {
+interface Options$y {
     id: string;
     request?: RequestInit;
 }
 declare class GetBoilerplateCategory {
     protected _transport: FetchTransport;
     constructor(_transport: FetchTransport);
-    send({ id, request }: Options$x): Promise<GetBoilerplateCategoryResponse>;
+    send({ id, request }: Options$y): Promise<GetBoilerplateCategoryResponse>;
 }
 type GetBoilerplateCategoryResponsePayload = {
     boilerplateCategory: {
@@ -385,13 +385,13 @@ declare class GetBoilerplateCategoryResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$w {
+interface Options$x {
     request?: RequestInit;
 }
 declare class ListBoilerplateCategories {
     protected _transport: FetchTransport;
     constructor(_transport: FetchTransport);
-    send({ request }?: Options$w): Promise<ListBoilerplateCategoriesResponse>;
+    send({ request }?: Options$x): Promise<ListBoilerplateCategoriesResponse>;
 }
 type ListBoilerplateCategoriesResponsePayload = {
     boilerplateCategories: {
@@ -418,7 +418,7 @@ declare class ListBoilerplateCategoriesResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$v {
+interface Options$w {
     id: string;
     body: z.infer<typeof UpdateBoilerplateCategory.SCHEMA>;
     request?: RequestInit;
@@ -436,7 +436,7 @@ declare class UpdateBoilerplateCategory {
         description?: string | undefined;
     }>;
     constructor(_transport: FetchTransport);
-    send({ id, body, request }: Options$v): Promise<UpdateBoilerplateCategoryResponse>;
+    send({ id, body, request }: Options$w): Promise<UpdateBoilerplateCategoryResponse>;
 }
 type UpdateBoilerplateCategoryResponsePayload = {
     boilerplateCategory: {
@@ -463,13 +463,13 @@ declare class UpdateBoilerplateCategoryResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$u {
+interface Options$v {
     request?: RequestInit;
 }
 declare class ListChannels {
     protected _transport: FetchTransport;
     constructor(_transport: FetchTransport);
-    send({ request }?: Options$u): Promise<ListChannelsResponse>;
+    send({ request }?: Options$v): Promise<ListChannelsResponse>;
 }
 type ListChannelsResponsePayload = {
     channels: ({
@@ -510,7 +510,7 @@ declare class ListChannelsResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$t {
+interface Options$u {
     id: string;
     vcf?: {
         variant?: "vcard";
@@ -523,8 +523,8 @@ interface Options$t {
 declare class GetContactVCFURL {
     protected _transport: FetchTransport;
     constructor(_transport: FetchTransport);
-    getRelativeURL({ id, vcf }: Options$t): string;
-    getURL(options: Options$t): string;
+    getRelativeURL({ id, vcf }: Options$u): string;
+    getURL(options: Options$u): string;
 }
 
 /**
@@ -536,7 +536,7 @@ declare class GetContactVCFURL {
  * @see       https://greatdetail.com
  */
 
-interface Options$s {
+interface Options$t {
     body: z.infer<typeof CreateContact.SCHEMA>;
     request?: RequestInit;
 }
@@ -559,7 +559,7 @@ declare class CreateContact {
         telephoneNumber?: string | undefined;
     }>;
     constructor(_transport: FetchTransport);
-    send({ body, request }: Options$s): Promise<CreateContactResponse>;
+    send({ body, request }: Options$t): Promise<CreateContactResponse>;
 }
 type CreateContactResponsePayload = {
     contact: {
@@ -587,14 +587,14 @@ declare class CreateContactResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$r {
+interface Options$s {
     id: string;
     request?: RequestInit;
 }
 declare class GetContact {
     protected _transport: FetchTransport;
     constructor(_transport: FetchTransport);
-    send({ id, request }: Options$r): Promise<GetContactResponse>;
+    send({ id, request }: Options$s): Promise<GetContactResponse>;
 }
 type GetContactResponsePayload = {
     contact: {
@@ -622,13 +622,13 @@ declare class GetContactResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$q {
+interface Options$r {
     request?: RequestInit;
 }
 declare class ListContacts {
     protected _transport: FetchTransport;
     constructor(_transport: FetchTransport);
-    send({ request }?: Options$q): Promise<ListContactsResponse>;
+    send({ request }?: Options$r): Promise<ListContactsResponse>;
 }
 type ListContactsResponsePayload = {
     contacts: {
@@ -656,14 +656,14 @@ declare class ListContactsResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$p {
+interface Options$q {
     id: string;
     request?: RequestInit;
 }
 declare class ListLabelContacts {
     protected _transport: FetchTransport;
     constructor(_transport: FetchTransport);
-    send({ id, request }: Options$p): Promise<ListLabelContactsResponse>;
+    send({ id, request }: Options$q): Promise<ListLabelContactsResponse>;
 }
 type ListLabelContactsResponsePayload = {
     contacts: {
@@ -691,7 +691,7 @@ declare class ListLabelContactsResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$o {
+interface Options$p {
     id: string;
     body: z.infer<typeof UpdateContact.SCHEMA>;
     request?: RequestInit;
@@ -712,7 +712,7 @@ declare class UpdateContact {
         telephoneNumber?: string | undefined;
     }>;
     constructor(_transport: FetchTransport);
-    send({ id, body, request }: Options$o): Promise<UpdateContactResponse>;
+    send({ id, body, request }: Options$p): Promise<UpdateContactResponse>;
 }
 type UpdateContactResponsePayload = {
     contact: {
@@ -740,14 +740,14 @@ declare class UpdateContactResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$n {
+interface Options$o {
     id: string;
     request?: RequestInit;
 }
 declare class GetConversation {
     protected _transport: FetchTransport;
     constructor(_transport: FetchTransport);
-    send({ id, request }: Options$n): Promise<GetConversationResponse>;
+    send({ id, request }: Options$o): Promise<GetConversationResponse>;
 }
 type GetConversationResponsePayload = {
     conversation: {
@@ -766,6 +766,41 @@ declare class GetConversationResponse {
     result(): Promise<GetConversationResponsePayload>;
 }
 
+/**
+ * Great Detail Support System.
+ *
+ * @copyright 2024 Great Detail Ltd
+ * @author    Great Detail Ltd <info@greatdetail.com>
+ * @author    Dom Webber <dom.webber@greatdetail.com>
+ * @see       https://greatdetail.com
+ */
+
+interface Options$n {
+    id: string;
+    request?: RequestInit;
+}
+declare class ListContactConversations {
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, request }: Options$n): Promise<ListContactConversationsResponse>;
+}
+type ListContactConversationsResponsePayload = {
+    conversations: {
+        id: string;
+        name?: string;
+        hasEnded: boolean;
+        conversationStatus: "AwaitingContactConversationStatus" | "AwaitingAgentConversationStatus" | "ResolvedConversationStatus" | "ClosedConversationStatus";
+        accountChannel: string;
+        createdAt: string;
+        updatedAt: string;
+    }[];
+};
+declare class ListContactConversationsResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<ListContactConversationsResponsePayload>;
+}
+
 /**
  * Great Detail Support System.
  *
@@ -852,11 +887,14 @@ interface Options$k {
 declare class UpdateConversation {
     protected _transport: FetchTransport;
     static SCHEMA: z.ZodObject<{
-        hasEnded: z.ZodBoolean;
+        conversationStatus: z.ZodOptional<z.ZodEnum<["AwaitingContactConversationStatus", "AwaitingAgentConversationStatus", "ResolvedConversationStatus", "ClosedConversationStatus"]>>;
+        hasEnded: z.ZodOptional<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
-        hasEnded: boolean;
+        conversationStatus?: "AwaitingContactConversationStatus" | "AwaitingAgentConversationStatus" | "ResolvedConversationStatus" | "ClosedConversationStatus" | undefined;
+        hasEnded?: boolean | undefined;
     }, {
-        hasEnded: boolean;
+        conversationStatus?: "AwaitingContactConversationStatus" | "AwaitingAgentConversationStatus" | "ResolvedConversationStatus" | "ClosedConversationStatus" | undefined;
+        hasEnded?: boolean | undefined;
     }>;
     constructor(_transport: FetchTransport);
     send({ id, body, request }: Options$k): Promise<UpdateConversationResponse>;
@@ -1619,8 +1657,8 @@ declare class Client {
         list: ListContacts;
         update: UpdateContact;
         create: CreateContact;
-        conversations: {
-            list: ListLabelConversations;
+        conversation: {
+            list: ListContactConversations;
         };
         note: {
             list: ListContactNotes;
@@ -1678,4 +1716,4 @@ declare class Client {
     };
 }
 
-export { type Authentication as A, type CreateCorrectionResponsePayload as B, Client as C, type DeleteLabelResponsePayload as D, type CreateResponseResponsePayload as E, type CreateContactNoteResponsePayload as F, type GetBoilerplateResponsePayload as G, type CreateConversationNoteResponsePayload as H, type GetNoteResponsePayload as I, type ListContactNotesResponsePayload as J, type ListConversationNotesResponsePayload as K, type ListActionsResponsePayload as L, type UpdateNoteResponsePayload as M, type GetSourceResponsePayload as N, type Options as O, type ListSourcesResponsePayload as P, type RequestFilterable as R, type UpdateBoilerplateResponsePayload as U, type Options$G as a, type CreateBoilerplateCategoryBoilerplateResponsePayload as b, type ListBoilerplateCategoryBoilerplatesResponsePayload as c, type ListBoilerplatesResponsePayload as d, type CreateBoilerplateCategoryResponsePayload as e, type GetBoilerplateCategoryResponsePayload as f, type ListBoilerplateCategoriesResponsePayload as g, type UpdateBoilerplateCategoryResponsePayload as h, type ListChannelsResponsePayload as i, type CreateContactResponsePayload as j, type GetContactResponsePayload as k, type ListContactsResponsePayload as l, type ListLabelContactsResponsePayload as m, type UpdateContactResponsePayload as n, type GetConversationResponsePayload as o, type ListConversationsResponsePayload as p, type ListLabelConversationsResponsePayload as q, type UpdateConversationResponsePayload as r, type CreateLabelResponsePayload as s, type GetLabelResponsePayload as t, type ListLabelsResponsePayload as u, type UpdateLabelResponsePayload as v, type ListConversationMessagesResponsePayload as w, type ListMessagesResponsePayload as x, type GetModelResponsePayload as y, type ListModelsResponsePayload as z };
+export { type Authentication as A, type ListModelsResponsePayload as B, Client as C, type DeleteLabelResponsePayload as D, type CreateCorrectionResponsePayload as E, type CreateResponseResponsePayload as F, type GetBoilerplateResponsePayload as G, type CreateContactNoteResponsePayload as H, type CreateConversationNoteResponsePayload as I, type GetNoteResponsePayload as J, type ListContactNotesResponsePayload as K, type ListActionsResponsePayload as L, type ListConversationNotesResponsePayload as M, type UpdateNoteResponsePayload as N, type Options as O, type GetSourceResponsePayload as P, type ListSourcesResponsePayload as Q, type RequestFilterable as R, type UpdateBoilerplateResponsePayload as U, type Options$H as a, type CreateBoilerplateCategoryBoilerplateResponsePayload as b, type ListBoilerplateCategoryBoilerplatesResponsePayload as c, type ListBoilerplatesResponsePayload as d, type CreateBoilerplateCategoryResponsePayload as e, type GetBoilerplateCategoryResponsePayload as f, type ListBoilerplateCategoriesResponsePayload as g, type UpdateBoilerplateCategoryResponsePayload as h, type ListChannelsResponsePayload as i, type CreateContactResponsePayload as j, type GetContactResponsePayload as k, type ListContactsResponsePayload as l, type ListLabelContactsResponsePayload as m, type UpdateContactResponsePayload as n, type GetConversationResponsePayload as o, type ListConversationsResponsePayload as p, type ListLabelConversationsResponsePayload as q, type UpdateConversationResponsePayload as r, type ListContactConversationsResponsePayload as s, type CreateLabelResponsePayload as t, type GetLabelResponsePayload as u, type ListLabelsResponsePayload as v, type UpdateLabelResponsePayload as w, type ListConversationMessagesResponsePayload as x, type ListMessagesResponsePayload as y, type GetModelResponsePayload as z };