@great-detail/support-sdk 0.4.4 → 0.4.5

package/src/Channel/ListChannels.ts

@@ -1,53 +0,0 @@
-/**
- * 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 FetchTransport from "../Transport/FetchTransport.js";
-
-export interface Options {
-  request?: RequestInit;
-}
-
-export type ListChannelsResponse = {
-  channels: ({
-    id: string;
-    name?: string;
-    channelStatus: "ActiveChannelStatus" | "PotentialChannelStatus";
-    account: string;
-    createdAt: string;
-    updatedAt?: string;
-  } & (
-    | {
-        source: "meta-whatsapp";
-        metaWhatsapp: {
-          id: string;
-          whatsappAccountID: string;
-          whatsappPhoneNumberID: string;
-          accessToken: string;
-        };
-      }
-    | {
-        source: "twilio-sendgrid";
-        twilioSendgrid: {
-          id: string;
-          apiKey: string;
-        };
-      }
-  ))[];
-};
-
-export default class ListChannels {
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ request = {} }: Options = {}) {
-    return this._transport.send<ListChannelsResponse>("v1/channels", {
-      ...request,
-      method: "GET",
-    });
-  }
-}

package/src/Channel/index.ts

@@ -1,10 +0,0 @@
-/**
- * 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
- */
-
-export { type ListChannelsResponse } from "./ListChannels.js";

package/src/Client/index.ts

@@ -1,206 +0,0 @@
-/**
- * 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 ListActions from "../Action/ListActions.js";
-import Authentication from "../Authentication/index.js";
-import CreateBoilerplateCategoryBoilerplate from "../Boilerplate/CreateBoilerplateCategoryBoilerplate.js";
-import GetBoilerplate from "../Boilerplate/GetBoilerplate.js";
-import ListBoilerplateCategoryBoilerplates from "../Boilerplate/ListBoilerplateCategoryBoilerplates.js";
-import ListBoilerplates from "../Boilerplate/ListBoilerplates.js";
-import UpdateBoilerplate from "../Boilerplate/UpdateBoilerplate.js";
-import CreateBoilerplateCategory from "../BoilerplateCategory/CreateBoilerplateCategory.js";
-import GetBoilerplateCategory from "../BoilerplateCategory/GetBoilerplateCategory.js";
-import ListBoilerplateCategories from "../BoilerplateCategory/ListBoilerplateCategories.js";
-import UpdateBoilerplateCategory from "../BoilerplateCategory/UpdateBoilerplateCategory.js";
-import ListChannels from "../Channel/ListChannels.js";
-import { BASE_URL_ENV_VAR } from "../constants/environment.js";
-import { DEFAULT_SUPPORT_BASE_URL } from "../constants/index.js";
-import GetContactVCFURL from "../Contact/ContactVCF/GetContactVCF.js";
-import CreateContact from "../Contact/CreateContact.js";
-import GetContact from "../Contact/GetContact.js";
-import ListContacts from "../Contact/ListContacts.js";
-import ListLabelContacts from "../Contact/ListLabelContacts.js";
-import UpdateContact from "../Contact/UpdateContact.js";
-import GetConversation from "../Conversation/GetConversation.js";
-import ListContactConversations from "../Conversation/ListContactConversations.js";
-import ListConversations from "../Conversation/ListConversations.js";
-import ListLabelConversations from "../Conversation/ListLabelConversations.js";
-import UpdateConversation from "../Conversation/UpdateConversation.js";
-import CreateLabel from "../Label/CreateLabel.js";
-import DeleteLabel from "../Label/DeleteLabel.js";
-import GetLabel from "../Label/GetLabel.js";
-import ListLabels from "../Label/ListLabels.js";
-import UpdateLabel from "../Label/UpdateLabel.js";
-import ListConversationMessages from "../Message/ListConversationMessages.js";
-import ListMessages from "../Message/ListMessages.js";
-import CreateCorrectionModel from "../Model/Correction/CreateCorrectionModel.js";
-import GetModel from "../Model/GetModel.js";
-import ListModels from "../Model/ListModels.js";
-import CreateResponseModel from "../Model/Response/CreateResponseModel.js";
-import CreateContactNote from "../Note/CreateContactNote.js";
-import CreateConversationNote from "../Note/CreateConversationNote.js";
-import GetNote from "../Note/GetNote.js";
-import ListContactNotes from "../Note/ListContactNotes.js";
-import ListConversationNotes from "../Note/ListConversationNotes.js";
-import UpdateNote from "../Note/UpdateNote.js";
-import CreateContactNotificationSubscription from "../NotificationSubscription/CreateContactNotificationSubscription.js";
-import RequestStandardHeaders from "../Request/RequestStandardHeaders.js";
-import GetSource from "../Source/GetSource.js";
-import ListSources from "../Source/ListSources.js";
-import FetchTransport from "../Transport/FetchTransport.js";
-import Webhook from "../Webhook/index.js";
-
-export interface Options {
-  baseURL?: string | URL;
-}
-
-export default class Client {
-  public static DEFAULT_BASE_URL = DEFAULT_SUPPORT_BASE_URL;
-
-  public _transport: FetchTransport;
-
-  constructor(
-    authentication: Authentication,
-    { baseURL, ...options }: Options = {},
-  ) {
-    this._transport = new FetchTransport({
-      requestFilterables: [new RequestStandardHeaders(), authentication],
-      ...options,
-      baseURL: baseURL?.toString() ?? Client.getBaseURL(),
-    });
-  }
-
-  public static getBaseURL(): string {
-    return process.env[BASE_URL_ENV_VAR] ?? this.DEFAULT_BASE_URL;
-  }
-
-  public get action() {
-    return {
-      list: new ListActions(this._transport),
-    };
-  }
-
-  public get boilerplate() {
-    return {
-      get: new GetBoilerplate(this._transport),
-      list: new ListBoilerplates(this._transport),
-      update: new UpdateBoilerplate(this._transport),
-    };
-  }
-
-  public get boilerplateCategory() {
-    return {
-      get: new GetBoilerplateCategory(this._transport),
-      list: new ListBoilerplateCategories(this._transport),
-      create: new CreateBoilerplateCategory(this._transport),
-      update: new UpdateBoilerplateCategory(this._transport),
-      boilerplate: {
-        list: new ListBoilerplateCategoryBoilerplates(this._transport),
-        create: new CreateBoilerplateCategoryBoilerplate(this._transport),
-      },
-    };
-  }
-
-  public get channel() {
-    return {
-      list: new ListChannels(this._transport),
-    };
-  }
-
-  public get contact() {
-    return {
-      get: new GetContact(this._transport),
-      list: new ListContacts(this._transport),
-      update: new UpdateContact(this._transport),
-      create: new CreateContact(this._transport),
-      conversation: {
-        list: new ListContactConversations(this._transport),
-      },
-      note: {
-        list: new ListContactNotes(this._transport),
-        create: new CreateContactNote(this._transport),
-      },
-      notificationSubscription: {
-        create: new CreateContactNotificationSubscription(this._transport),
-      },
-      vcf: {
-        get: new GetContactVCFURL(this._transport),
-      },
-    };
-  }
-
-  public get conversation() {
-    return {
-      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),
-      },
-      note: {
-        list: new ListConversationNotes(this._transport),
-        create: new CreateConversationNote(this._transport),
-      },
-    };
-  }
-
-  public get label() {
-    return {
-      create: new CreateLabel(this._transport),
-      get: new GetLabel(this._transport),
-      list: new ListLabels(this._transport),
-      update: new UpdateLabel(this._transport),
-      delete: new DeleteLabel(this._transport),
-      contact: {
-        list: new ListLabelContacts(this._transport),
-      },
-      conversation: {
-        list: new ListLabelConversations(this._transport),
-      },
-    };
-  }
-
-  public get message() {
-    return {
-      list: new ListMessages(this._transport),
-    };
-  }
-
-  public get model() {
-    return {
-      get: new GetModel(this._transport),
-      list: new ListModels(this._transport),
-      response: {
-        create: new CreateResponseModel(this._transport),
-      },
-      correction: {
-        create: new CreateCorrectionModel(this._transport),
-      },
-    };
-  }
-
-  public get note() {
-    return {
-      get: new GetNote(this._transport),
-      update: new UpdateNote(this._transport),
-    };
-  }
-
-  public get source() {
-    return {
-      get: new GetSource(this._transport),
-      list: new ListSources(this._transport),
-    };
-  }
-
-  public get webhook() {
-    return new Webhook(this);
-  }
-}

package/src/Contact/ContactVCF/GetContactVCF.ts

@@ -1,45 +0,0 @@
-/**
- * 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 FetchTransport from "../../Transport/FetchTransport.js";
-
-export interface Options {
-  id: string;
-  vcf?:
-    | {
-        variant?: "vcard";
-        format?: "vcf" | "qr";
-      }
-    | {
-        variant: "jcard";
-        format?: "json";
-      };
-}
-
-export default class GetContactVCFURL {
-  constructor(protected _transport: FetchTransport) {}
-
-  public getRelativeURL({ id, vcf = {} }: Options) {
-    const variant = vcf.variant ?? "vcard";
-    const format = vcf.format ?? (vcf.variant === "vcard" ? "vcf" : "json");
-
-    return (
-      "v1/contacts/" +
-      encodeURIComponent(id) +
-      "/vcf?variant=" +
-      encodeURIComponent(variant) +
-      "&format=" +
-      encodeURIComponent(format)
-    );
-  }
-
-  public getURL(options: Options) {
-    return this._transport.getURL(this.getRelativeURL(options));
-  }
-}

package/src/Contact/CreateContact.ts

@@ -1,51 +0,0 @@
-/**
- * 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 CreateContact.SCHEMA>;
-  request?: RequestInit;
-}
-
-export type CreateContactResponse = {
-  contact: {
-    id: string;
-    name?: string;
-    emailAddress?: string;
-    telephoneNumber?: string;
-    account: string;
-    createdAt: string;
-    updatedAt?: string;
-  };
-};
-
-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<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

@@ -1,41 +0,0 @@
-/**
- * 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 FetchTransport from "../Transport/FetchTransport.js";
-
-export interface Options {
-  id: string;
-  request?: RequestInit;
-}
-
-export type GetContactResponse = {
-  contact: {
-    id: string;
-    name?: string;
-    emailAddress?: string;
-    telephoneNumber?: string;
-    account: string;
-    createdAt: string;
-    updatedAt?: string;
-  };
-};
-
-export default class GetContact {
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ id, request = {} }: Options) {
-    return this._transport.send<GetContactResponse>(
-      "v1/contacts/" + encodeURIComponent(id),
-      {
-        ...request,
-        method: "GET",
-      },
-    );
-  }
-}

package/src/Contact/ListContacts.ts

@@ -1,37 +0,0 @@
-/**
- * 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 FetchTransport from "../Transport/FetchTransport.js";
-
-export interface Options {
-  request?: RequestInit;
-}
-
-export type ListContactsResponse = {
-  contacts: {
-    id: string;
-    name?: string;
-    emailAddress?: string;
-    telephoneNumber?: string;
-    account: string;
-    createdAt: string;
-    updatedAt?: string;
-  }[];
-};
-
-export default class ListContacts {
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ request = {} }: Options = {}) {
-    return this._transport.send<ListContactsResponse>("v1/contacts", {
-      ...request,
-      method: "GET",
-    });
-  }
-}

package/src/Contact/ListLabelContacts.ts

@@ -1,41 +0,0 @@
-/**
- * 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 FetchTransport from "../Transport/FetchTransport.js";
-
-export interface Options {
-  id: string;
-  request?: RequestInit;
-}
-
-export type ListLabelContactsResponse = {
-  contacts: {
-    id: string;
-    name?: string;
-    emailAddress?: string;
-    telephoneNumber?: string;
-    account: string;
-    createdAt: string;
-    updatedAt?: string;
-  }[];
-};
-
-export default class ListLabelContacts {
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ id, request = {} }: Options) {
-    return this._transport.send<ListLabelContactsResponse>(
-      "v1/labels/" + encodeURIComponent(id) + "/contacts",
-      {
-        ...request,
-        method: "GET",
-      },
-    );
-  }
-}

package/src/Contact/UpdateContact.ts

@@ -1,54 +0,0 @@
-/**
- * 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 {
-  id: string;
-  body: z.infer<typeof UpdateContact.SCHEMA>;
-  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(),
-    emailAddress: z.string().email().optional(),
-    telephoneNumber: z.string().optional(),
-  });
-
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ id, body, request = {} }: Options) {
-    return this._transport.send<UpdateContactResponse>(
-      "v1/contacts/" + encodeURIComponent(id),
-      {
-        ...request,
-        method: "PATCH",
-        headers: {
-          ...request.headers,
-          "Content-Type": "application/json",
-        },
-        body: JSON.stringify(UpdateContact.SCHEMA.parse(body)),
-      },
-    );
-  }
-}

package/src/Contact/index.ts

@@ -1,14 +0,0 @@
-/**
- * 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
- */
-
-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

@@ -1,58 +0,0 @@
-/**
- * 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

@@ -1,45 +0,0 @@
-/**
- * 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 FetchTransport from "../Transport/FetchTransport.js";
-
-export interface Options {
-  id: string;
-  request?: RequestInit;
-}
-
-export type GetConversationResponse = {
-  conversation: {
-    id: string;
-    name?: string;
-    hasEnded: boolean;
-    conversationStatus:
-      | "AwaitingContactConversationStatus"
-      | "AwaitingAgentConversationStatus"
-      | "ResolvedConversationStatus"
-      | "ClosedConversationStatus";
-    accountChannel: string;
-    createdAt: string;
-    updatedAt: string;
-  };
-};
-
-export default class GetConversation {
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ id, request = {} }: Options) {
-    return this._transport.send<GetConversationResponse>(
-      "v1/conversations/" + encodeURIComponent(id),
-      {
-        ...request,
-        method: "GET",
-      },
-    );
-  }
-}