@great-detail/support-sdk 0.3.3 → 0.4.0

package/src/BoilerplateCategory/ListBoilerplateCategories.ts

@@ -13,20 +13,7 @@ export interface Options {
   request?: RequestInit;
 }
 
-export default class ListBoilerplateCategories {
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ request = {} }: Options = {}) {
-    return this._transport
-      .send("v1/boilerplate-categories", {
-        ...request,
-        method: "GET",
-      })
-      .then((response) => new ListBoilerplateCategoriesResponse(response));
-  }
-}
-
-export type ListBoilerplateCategoriesResponsePayload = {
+export type ListBoilerplateCategoriesResponse = {
   boilerplateCategories: {
     id: string;
     title: string;
@@ -37,10 +24,16 @@ export type ListBoilerplateCategoriesResponsePayload = {
   }[];
 };
 
-export class ListBoilerplateCategoriesResponse {
-  constructor(public response: Response) {}
+export default class ListBoilerplateCategories {
+  constructor(protected _transport: FetchTransport) {}
 
-  public async result(): Promise<ListBoilerplateCategoriesResponsePayload> {
-    return this.response.json();
+  public async send({ request = {} }: Options = {}) {
+    return this._transport.send<ListBoilerplateCategoriesResponse>(
+      "v1/boilerplate-categories",
+      {
+        ...request,
+        method: "GET",
+      },
+    );
   }
 }

package/src/BoilerplateCategory/UpdateBoilerplateCategory.ts

@@ -16,6 +16,17 @@ export interface Options {
   request?: RequestInit;
 }
 
+export type UpdateBoilerplateCategoryResponse = {
+  boilerplateCategory: {
+    id: string;
+    title: string;
+    description?: string;
+    account: string;
+    createdAt: string;
+    updatedAt: string;
+  };
+};
+
 export default class UpdateBoilerplateCategory {
   public static SCHEMA = z.object({
     title: z.string().optional(),
@@ -25,8 +36,9 @@ export default class UpdateBoilerplateCategory {
   constructor(protected _transport: FetchTransport) {}
 
   public async send({ id, body, request = {} }: Options) {
-    return this._transport
-      .send("v1/boilerplate-categories/" + encodeURIComponent(id), {
+    return this._transport.send<UpdateBoilerplateCategoryResponse>(
+      "v1/boilerplate-categories/" + encodeURIComponent(id),
+      {
         ...request,
         method: "PATCH",
         headers: {
@@ -34,26 +46,7 @@ export default class UpdateBoilerplateCategory {
           "Content-Type": "application/json",
         },
         body: JSON.stringify(UpdateBoilerplateCategory.SCHEMA.parse(body)),
-      })
-      .then((response) => new UpdateBoilerplateCategoryResponse(response));
-  }
-}
-
-export type UpdateBoilerplateCategoryResponsePayload = {
-  boilerplateCategory: {
-    id: string;
-    title: string;
-    description?: string;
-    account: string;
-    createdAt: string;
-    updatedAt: string;
-  };
-};
-
-export class UpdateBoilerplateCategoryResponse {
-  constructor(public response: Response) {}
-
-  public async result(): Promise<UpdateBoilerplateCategoryResponsePayload> {
-    return this.response.json();
+      },
+    );
   }
 }

package/src/BoilerplateCategory/index.ts

@@ -7,7 +7,7 @@
  * @see       https://greatdetail.com
  */
 
-export { type CreateBoilerplateCategoryResponsePayload } from "./CreateBoilerplateCategory.js";
-export { type GetBoilerplateCategoryResponsePayload } from "./GetBoilerplateCategory.js";
-export { type ListBoilerplateCategoriesResponsePayload } from "./ListBoilerplateCategories.js";
-export { type UpdateBoilerplateCategoryResponsePayload } from "./UpdateBoilerplateCategory.js";
+export { type CreateBoilerplateCategoryResponse } from "./CreateBoilerplateCategory.js";
+export { type GetBoilerplateCategoryResponse } from "./GetBoilerplateCategory.js";
+export { type ListBoilerplateCategoriesResponse } from "./ListBoilerplateCategories.js";
+export { type UpdateBoilerplateCategoryResponse } from "./UpdateBoilerplateCategory.js";

package/src/Channel/ListChannels.ts

@@ -13,20 +13,7 @@ export interface Options {
   request?: RequestInit;
 }
 
-export default class ListChannels {
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ request = {} }: Options = {}) {
-    return this._transport
-      .send("v1/channels", {
-        ...request,
-        method: "GET",
-      })
-      .then((response) => new ListChannelsResponse(response));
-  }
-}
-
-export type ListChannelsResponsePayload = {
+export type ListChannelsResponse = {
   channels: ({
     id: string;
     name?: string;
@@ -54,10 +41,13 @@ export type ListChannelsResponsePayload = {
   ))[];
 };
 
-export class ListChannelsResponse {
-  constructor(public response: Response) {}
+export default class ListChannels {
+  constructor(protected _transport: FetchTransport) {}
 
-  public async result(): Promise<ListChannelsResponsePayload> {
-    return this.response.json();
+  public async send({ request = {} }: Options = {}) {
+    return this._transport.send<ListChannelsResponse>("v1/channels", {
+      ...request,
+      method: "GET",
+    });
   }
 }

package/src/Channel/index.ts

@@ -7,4 +7,4 @@
  * @see       https://greatdetail.com
  */
 
-export { type ListChannelsResponsePayload } from "./ListChannels.js";
+export { type ListChannelsResponse } from "./ListChannels.js";

package/src/Client/index.ts

@@ -135,6 +135,7 @@ export default class Client {
       get: new GetConversation(this._transport),
       list: new ListConversations(this._transport),
       update: new UpdateConversation(this._transport),
+      create: new CreateConversationNote(this._transport),
       message: {
         list: new ListConversationMessages(this._transport),
       },

package/src/Contact/CreateContact.ts

@@ -15,32 +15,7 @@ export interface Options {
   request?: RequestInit;
 }
 
-export default class CreateContact {
-  public static SCHEMA = z.object({
-    name: z.string(),
-    account: z.string(),
-    emailAddress: z.string().email().optional(),
-    telephoneNumber: z.string().optional(),
-  });
-
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ body, request = {} }: Options) {
-    return this._transport
-      .send("v1/contacts", {
-        ...request,
-        method: "POST",
-        headers: {
-          ...request.headers,
-          "Content-Type": "application/json",
-        },
-        body: JSON.stringify(CreateContact.SCHEMA.parse(body)),
-      })
-      .then((response) => new CreateContactResponse(response));
-  }
-}
-
-export type CreateContactResponsePayload = {
+export type CreateContactResponse = {
   contact: {
     id: string;
     name?: string;
@@ -52,10 +27,25 @@ export type CreateContactResponsePayload = {
   };
 };
 
-export class CreateContactResponse {
-  constructor(public response: Response) {}
+export default class CreateContact {
+  public static SCHEMA = z.object({
+    name: z.string(),
+    account: z.string(),
+    emailAddress: z.string().email().optional(),
+    telephoneNumber: z.string().optional(),
+  });
+
+  constructor(protected _transport: FetchTransport) {}
 
-  public async result(): Promise<CreateContactResponsePayload> {
-    return this.response.json();
+  public async send({ body, request = {} }: Options) {
+    return this._transport.send<CreateContactResponse>("v1/contacts", {
+      ...request,
+      method: "POST",
+      headers: {
+        ...request.headers,
+        "Content-Type": "application/json",
+      },
+      body: JSON.stringify(CreateContact.SCHEMA.parse(body)),
+    });
   }
 }

package/src/Contact/GetContact.ts

@@ -14,20 +14,7 @@ export interface Options {
   request?: RequestInit;
 }
 
-export default class GetContact {
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ id, request = {} }: Options) {
-    return this._transport
-      .send("v1/contacts/" + encodeURIComponent(id), {
-        ...request,
-        method: "GET",
-      })
-      .then((response) => new GetContactResponse(response));
-  }
-}
-
-export type GetContactResponsePayload = {
+export type GetContactResponse = {
   contact: {
     id: string;
     name?: string;
@@ -39,10 +26,16 @@ export type GetContactResponsePayload = {
   };
 };
 
-export class GetContactResponse {
-  constructor(public response: Response) {}
+export default class GetContact {
+  constructor(protected _transport: FetchTransport) {}
 
-  public async result(): Promise<GetContactResponsePayload> {
-    return this.response.json();
+  public async send({ id, request = {} }: Options) {
+    return this._transport.send<GetContactResponse>(
+      "v1/contacts/" + encodeURIComponent(id),
+      {
+        ...request,
+        method: "GET",
+      },
+    );
   }
 }

package/src/Contact/ListContacts.ts

@@ -13,20 +13,7 @@ export interface Options {
   request?: RequestInit;
 }
 
-export default class ListContacts {
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ request = {} }: Options = {}) {
-    return this._transport
-      .send("v1/contacts", {
-        ...request,
-        method: "GET",
-      })
-      .then((response) => new ListContactsResponse(response));
-  }
-}
-
-export type ListContactsResponsePayload = {
+export type ListContactsResponse = {
   contacts: {
     id: string;
     name?: string;
@@ -38,10 +25,13 @@ export type ListContactsResponsePayload = {
   }[];
 };
 
-export class ListContactsResponse {
-  constructor(public response: Response) {}
+export default class ListContacts {
+  constructor(protected _transport: FetchTransport) {}
 
-  public async result(): Promise<ListContactsResponsePayload> {
-    return this.response.json();
+  public async send({ request = {} }: Options = {}) {
+    return this._transport.send<ListContactsResponse>("v1/contacts", {
+      ...request,
+      method: "GET",
+    });
   }
 }

package/src/Contact/ListLabelContacts.ts

@@ -14,20 +14,7 @@ export interface Options {
   request?: RequestInit;
 }
 
-export default class ListLabelContacts {
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ id, request = {} }: Options) {
-    return this._transport
-      .send("v1/labels/" + encodeURIComponent(id) + "/contacts", {
-        ...request,
-        method: "GET",
-      })
-      .then((response) => new ListLabelContactsResponse(response));
-  }
-}
-
-export type ListLabelContactsResponsePayload = {
+export type ListLabelContactsResponse = {
   contacts: {
     id: string;
     name?: string;
@@ -39,10 +26,16 @@ export type ListLabelContactsResponsePayload = {
   }[];
 };
 
-export class ListLabelContactsResponse {
-  constructor(public response: Response) {}
+export default class ListLabelContacts {
+  constructor(protected _transport: FetchTransport) {}
 
-  public async result(): Promise<ListLabelContactsResponsePayload> {
-    return this.response.json();
+  public async send({ id, request = {} }: Options) {
+    return this._transport.send<ListLabelContactsResponse>(
+      "v1/labels/" + encodeURIComponent(id) + "/contacts",
+      {
+        ...request,
+        method: "GET",
+      },
+    );
   }
 }

package/src/Contact/UpdateContact.ts

@@ -16,6 +16,18 @@ export interface Options {
   request?: RequestInit;
 }
 
+export type UpdateContactResponse = {
+  contact: {
+    id: string;
+    name?: string;
+    emailAddress?: string;
+    telephoneNumber?: string;
+    account: string;
+    createdAt: string;
+    updatedAt?: string;
+  };
+};
+
 export default class UpdateContact {
   public static SCHEMA = z.object({
     name: z.string().optional(),
@@ -26,8 +38,9 @@ export default class UpdateContact {
   constructor(protected _transport: FetchTransport) {}
 
   public async send({ id, body, request = {} }: Options) {
-    return this._transport
-      .send("v1/contacts/" + encodeURIComponent(id), {
+    return this._transport.send<UpdateContactResponse>(
+      "v1/contacts/" + encodeURIComponent(id),
+      {
         ...request,
         method: "PATCH",
         headers: {
@@ -35,27 +48,7 @@ export default class UpdateContact {
           "Content-Type": "application/json",
         },
         body: JSON.stringify(UpdateContact.SCHEMA.parse(body)),
-      })
-      .then((response) => new UpdateContactResponse(response));
-  }
-}
-
-export type UpdateContactResponsePayload = {
-  contact: {
-    id: string;
-    name?: string;
-    emailAddress?: string;
-    telephoneNumber?: string;
-    account: string;
-    createdAt: string;
-    updatedAt?: string;
-  };
-};
-
-export class UpdateContactResponse {
-  constructor(public response: Response) {}
-
-  public async result(): Promise<UpdateContactResponsePayload> {
-    return this.response.json();
+      },
+    );
   }
 }

package/src/Contact/index.ts

@@ -7,8 +7,8 @@
  * @see       https://greatdetail.com
  */
 
-export { type CreateContactResponsePayload } from "./CreateContact.js";
-export { type GetContactResponsePayload } from "./GetContact.js";
-export { type ListContactsResponsePayload } from "./ListContacts.js";
-export { type ListLabelContactsResponsePayload } from "./ListLabelContacts.js";
-export { type UpdateContactResponsePayload } from "./UpdateContact.js";
+export { type CreateContactResponse } from "./CreateContact.js";
+export { type GetContactResponse } from "./GetContact.js";
+export { type ListContactsResponse } from "./ListContacts.js";
+export { type ListLabelContactsResponse } from "./ListLabelContacts.js";
+export { type UpdateContactResponse } from "./UpdateContact.js";

package/src/Conversation/CreateConversation.ts

@@ -0,0 +1,58 @@
+/**
+ * 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
+ */
+
+import { z } from "zod";
+import FetchTransport from "../Transport/FetchTransport.js";
+
+export interface Options {
+  body: z.infer<typeof CreateConversation.SCHEMA>;
+  request?: RequestInit;
+}
+
+export type CreateConversationResponse = {
+  conversation: {
+    id: string;
+    name?: string;
+    hasEnded: boolean;
+    conversationStatus:
+      | "AwaitingContactConversationStatus"
+      | "AwaitingAgentConversationStatus"
+      | "ResolvedConversationStatus"
+      | "ClosedConversationStatus";
+    accountChannel: string;
+    createdAt: string;
+    updatedAt: string;
+  };
+};
+
+export default class CreateConversation {
+  public static SCHEMA = z.object({
+    name: z.string().optional(),
+  });
+
+  constructor(protected _transport: FetchTransport) {}
+
+  /**
+   * @deprecated Not Yet Implemented
+   */
+  public async send({ body, request = {} }: Options) {
+    return this._transport.send<CreateConversationResponse>(
+      "v1/conversations",
+      {
+        ...request,
+        method: "POST",
+        headers: {
+          ...request.headers,
+          "Content-Type": "application/json",
+        },
+        body: JSON.stringify(CreateConversation.SCHEMA.parse(body)),
+      },
+    );
+  }
+}

package/src/Conversation/GetConversation.ts

@@ -14,20 +14,7 @@ export interface Options {
   request?: RequestInit;
 }
 
-export default class GetConversation {
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ id, request = {} }: Options) {
-    return this._transport
-      .send("v1/conversations/" + encodeURIComponent(id), {
-        ...request,
-        method: "GET",
-      })
-      .then((response) => new GetConversationResponse(response));
-  }
-}
-
-export type GetConversationResponsePayload = {
+export type GetConversationResponse = {
   conversation: {
     id: string;
     name?: string;
@@ -43,10 +30,16 @@ export type GetConversationResponsePayload = {
   };
 };
 
-export class GetConversationResponse {
-  constructor(public response: Response) {}
+export default class GetConversation {
+  constructor(protected _transport: FetchTransport) {}
 
-  public async result(): Promise<GetConversationResponsePayload> {
-    return this.response.json();
+  public async send({ id, request = {} }: Options) {
+    return this._transport.send<GetConversationResponse>(
+      "v1/conversations/" + encodeURIComponent(id),
+      {
+        ...request,
+        method: "GET",
+      },
+    );
   }
 }

package/src/Conversation/ListContactConversations.ts

@@ -14,20 +14,7 @@ export interface Options {
   request?: RequestInit;
 }
 
-export default class ListContactConversations {
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ id, request = {} }: Options) {
-    return this._transport
-      .send("v1/contacts/" + encodeURIComponent(id) + "/conversations", {
-        ...request,
-        method: "GET",
-      })
-      .then((response) => new ListContactConversationsResponse(response));
-  }
-}
-
-export type ListContactConversationsResponsePayload = {
+export type ListContactConversationsResponse = {
   conversations: {
     id: string;
     name?: string;
@@ -43,10 +30,16 @@ export type ListContactConversationsResponsePayload = {
   }[];
 };
 
-export class ListContactConversationsResponse {
-  constructor(public response: Response) {}
+export default class ListContactConversations {
+  constructor(protected _transport: FetchTransport) {}
 
-  public async result(): Promise<ListContactConversationsResponsePayload> {
-    return this.response.json();
+  public async send({ id, request = {} }: Options) {
+    return this._transport.send<ListContactConversationsResponse>(
+      "v1/contacts/" + encodeURIComponent(id) + "/conversations",
+      {
+        ...request,
+        method: "GET",
+      },
+    );
   }
 }

package/src/Conversation/ListConversations.ts

@@ -13,20 +13,7 @@ export interface Options {
   request?: RequestInit;
 }
 
-export default class ListConversations {
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ request = {} }: Options = {}) {
-    return this._transport
-      .send("v1/conversations", {
-        ...request,
-        method: "GET",
-      })
-      .then((response) => new ListConversationsResponse(response));
-  }
-}
-
-export type ListConversationsResponsePayload = {
+export type ListConversationsResponse = {
   conversations: {
     id: string;
     name?: string;
@@ -42,10 +29,13 @@ export type ListConversationsResponsePayload = {
   }[];
 };
 
-export class ListConversationsResponse {
-  constructor(public response: Response) {}
+export default class ListConversations {
+  constructor(protected _transport: FetchTransport) {}
 
-  public async result(): Promise<ListConversationsResponsePayload> {
-    return this.response.json();
+  public async send({ request = {} }: Options = {}) {
+    return this._transport.send<ListConversationsResponse>("v1/conversations", {
+      ...request,
+      method: "GET",
+    });
   }
 }

package/src/Conversation/ListLabelConversations.ts

@@ -14,20 +14,7 @@ export interface Options {
   request?: RequestInit;
 }
 
-export default class ListLabelConversations {
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ id, request = {} }: Options) {
-    return this._transport
-      .send("v1/labels/" + encodeURIComponent(id) + "/conversations", {
-        ...request,
-        method: "GET",
-      })
-      .then((response) => new ListLabelConversationsResponse(response));
-  }
-}
-
-export type ListLabelConversationsResponsePayload = {
+export type ListLabelConversationsResponse = {
   conversations: {
     id: string;
     name?: string;
@@ -43,10 +30,16 @@ export type ListLabelConversationsResponsePayload = {
   }[];
 };
 
-export class ListLabelConversationsResponse {
-  constructor(public response: Response) {}
+export default class ListLabelConversations {
+  constructor(protected _transport: FetchTransport) {}
 
-  public async result(): Promise<ListLabelConversationsResponsePayload> {
-    return this.response.json();
+  public async send({ id, request = {} }: Options) {
+    return this._transport.send<ListLabelConversationsResponse>(
+      "v1/labels/" + encodeURIComponent(id) + "/conversations",
+      {
+        ...request,
+        method: "GET",
+      },
+    );
   }
 }