@great-detail/support-sdk 0.0.3 → 0.0.5

package/dist/index.d.ts

@@ -48,7 +48,7 @@ interface Authentication extends RequestFilterable {
  * @see       https://greatdetail.com
  */
 
-interface Options$c {
+interface Options$h {
     name?: string;
     key?: string;
 }
@@ -56,7 +56,7 @@ declare class KeyAuthentication implements Authentication {
     #private;
     static DEFAULT_NAME: string;
     name: string;
-    constructor({ name, key, }?: Options$c);
+    constructor({ name, key, }?: Options$h);
     filter(request: RequestInit): Promise<RequestInit>;
 }
 
@@ -69,12 +69,12 @@ declare class KeyAuthentication implements Authentication {
  * @see       https://greatdetail.com
  */
 
-interface Options$b {
+interface Options$g {
     token?: string;
 }
 declare class TokenAuthentication implements Authentication {
     #private;
-    constructor({ token }?: Options$b);
+    constructor({ token }?: Options$g);
     filter(request: RequestInit): Promise<RequestInit>;
 }
 
@@ -106,13 +106,13 @@ declare class PublicAuthentication implements Authentication {
  * @see       https://greatdetail.com
  */
 
-interface Options$a extends SendOptions {
+interface Options$f extends SendOptions {
     request?: RequestInit;
 }
 declare class ListActionsRequest {
     protected _client: Client;
     constructor(_client: Client);
-    send({ request, ...options }?: Options$a): Promise<ListActionsResponse>;
+    send({ request, ...options }?: Options$f): Promise<ListActionsResponse>;
 }
 type ListActionsResponsePayload = {
     actions: {
@@ -139,13 +139,13 @@ declare class ListActionsResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$9 extends SendOptions {
+interface Options$e extends SendOptions {
     request?: RequestInit;
 }
 declare class ListChannelsRequest {
     protected _client: Client;
     constructor(_client: Client);
-    send({ request, ...options }?: Options$9): Promise<ListChannelsResponse>;
+    send({ request, ...options }?: Options$e): Promise<ListChannelsResponse>;
 }
 type ListChannelsResponsePayload = {
     channels: {
@@ -172,13 +172,47 @@ declare class ListChannelsResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$8 extends SendOptions {
+interface Options$d extends SendOptions {
+    id: string;
+    request?: RequestInit;
+}
+declare class GetContactRequest {
+    protected _client: Client;
+    constructor(_client: Client);
+    send({ id, request, ...options }: Options$d): Promise<GetContactResponse>;
+}
+type GetContactResponsePayload = {
+    contact: {
+        id: string;
+        name?: string;
+        emailAddress?: string;
+        telephoneNumber?: string;
+        createdAt: string;
+        updatedAt?: string;
+    };
+};
+declare class GetContactResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<GetContactResponsePayload>;
+}
+
+/**
+ * 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$c extends SendOptions {
     request?: RequestInit;
 }
 declare class ListContactsRequest {
     protected _client: Client;
     constructor(_client: Client);
-    send({ request, ...options }?: Options$8): Promise<ListContactsResponse>;
+    send({ request, ...options }?: Options$c): Promise<ListContactsResponse>;
 }
 type ListContactsResponsePayload = {
     contacts: {
@@ -205,14 +239,14 @@ declare class ListContactsResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$7 extends SendOptions {
+interface Options$b extends SendOptions {
     id: string;
     request?: RequestInit;
 }
 declare class GetConversationRequest {
     protected _client: Client;
     constructor(_client: Client);
-    send({ id, request, ...options }: Options$7): Promise<GetConversationResponse>;
+    send({ id, request, ...options }: Options$b): Promise<GetConversationResponse>;
 }
 type GetConversationResponsePayload = {
     conversation: {
@@ -238,13 +272,13 @@ declare class GetConversationResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$6 extends SendOptions {
+interface Options$a extends SendOptions {
     request?: RequestInit;
 }
 declare class ListConversationsRequest {
     protected _client: Client;
     constructor(_client: Client);
-    send({ request, ...options }?: Options$6): Promise<ListConversationsResponse>;
+    send({ request, ...options }?: Options$a): Promise<ListConversationsResponse>;
 }
 type ListConversationsResponsePayload = {
     conversations: {
@@ -270,13 +304,92 @@ declare class ListConversationsResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$5 extends SendOptions {
+interface Options$9 extends SendOptions {
+    body: z.infer<typeof CreateLabelRequest.SCHEMA>;
+    request?: RequestInit;
+}
+declare class CreateLabelRequest {
+    protected _client: Client;
+    static SCHEMA: z.ZodObject<{
+        title: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        account: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        title: string;
+        account: string;
+        description?: string | undefined;
+    }, {
+        title: string;
+        account: string;
+        description?: string | undefined;
+    }>;
+    constructor(_client: Client);
+    send({ body, request, ...options }: Options$9): Promise<CreateLabelResponse>;
+}
+type CreateLabelResponsePayload = {
+    label: {
+        id: string;
+        title: string;
+        description?: string;
+        createdAt: string;
+        updatedAt?: string;
+    };
+};
+declare class CreateLabelResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<CreateLabelResponsePayload>;
+}
+
+/**
+ * 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$8 extends SendOptions {
+    id: string;
+    request?: RequestInit;
+}
+declare class GetLabelRequest {
+    protected _client: Client;
+    constructor(_client: Client);
+    send({ id, request, ...options }: Options$8): Promise<GetLabelResponse>;
+}
+type GetLabelResponsePayload = {
+    label: {
+        id: string;
+        title: string;
+        description?: string;
+        createdAt: string;
+        updatedAt?: string;
+    };
+};
+declare class GetLabelResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<GetLabelResponsePayload>;
+}
+
+/**
+ * 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$7 extends SendOptions {
     request?: RequestInit;
 }
 declare class ListLabelsRequest {
     protected _client: Client;
     constructor(_client: Client);
-    send({ request, ...options }?: Options$5): Promise<ListLabelsResponse>;
+    send({ request, ...options }?: Options$7): Promise<ListLabelsResponse>;
 }
 type ListLabelsResponsePayload = {
     labels: {
@@ -302,13 +415,13 @@ declare class ListLabelsResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$4 extends SendOptions {
+interface Options$6 extends SendOptions {
     request?: RequestInit;
 }
 declare class ListMessagesRequest {
     protected _client: Client;
     constructor(_client: Client);
-    send({ request, ...options }?: Options$4): Promise<ListMessagesResponse>;
+    send({ request, ...options }?: Options$6): Promise<ListMessagesResponse>;
 }
 type ListMessagesResponsePayload = {
     messages: {
@@ -337,7 +450,7 @@ declare class ListMessagesResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$3 extends SendOptions {
+interface Options$5 extends SendOptions {
     id: string;
     body: z.infer<typeof CreateCorrectionModelRequest.SCHEMA>;
     request?: RequestInit;
@@ -358,7 +471,7 @@ declare class CreateCorrectionModelRequest {
         correction: string;
     }>;
     constructor(_client: Client);
-    send({ id, body, request, ...options }: Options$3): Promise<CreateCorrectionModelResponse>;
+    send({ id, body, request, ...options }: Options$5): Promise<CreateCorrectionModelResponse>;
 }
 type CreateCorrectionResponsePayload = unknown;
 declare class CreateCorrectionModelResponse {
@@ -376,13 +489,46 @@ declare class CreateCorrectionModelResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$2 extends SendOptions {
+interface Options$4 extends SendOptions {
+    id: string;
+    request?: RequestInit;
+}
+declare class GetModelRequest {
+    protected _client: Client;
+    constructor(_client: Client);
+    send({ id, request, ...options }: Options$4): Promise<GetModelResponse>;
+}
+type GetModelResponsePayload = {
+    model: {
+        id: string;
+        name: string;
+        url: string;
+        icon: string;
+        disambiguatingDescription: string;
+    };
+};
+declare class GetModelResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<GetModelResponsePayload>;
+}
+
+/**
+ * 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$3 extends SendOptions {
     request?: RequestInit;
 }
 declare class ListModelsRequest {
     protected _client: Client;
     constructor(_client: Client);
-    send({ request, ...options }?: Options$2): Promise<ListModelsResponse>;
+    send({ request, ...options }?: Options$3): Promise<ListModelsResponse>;
 }
 type ListModelsResponsePayload = {
     models: {
@@ -408,7 +554,7 @@ declare class ListModelsResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$1 extends SendOptions {
+interface Options$2 extends SendOptions {
     id: string;
     body: z.infer<typeof CreateResponseModelRequest.SCHEMA>;
     request?: RequestInit;
@@ -426,7 +572,7 @@ declare class CreateResponseModelRequest {
         content: string | null;
     }>, "many">;
     constructor(_client: Client);
-    send({ id, body, request, ...options }: Options$1): Promise<CreateResponseModelResponse>;
+    send({ id, body, request, ...options }: Options$2): Promise<CreateResponseModelResponse>;
 }
 type CreateResponseResponsePayload = {
     message: string | null;
@@ -441,6 +587,39 @@ declare class CreateResponseModelResponse {
     result(): Promise<CreateResponseResponsePayload>;
 }
 
+/**
+ * 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$1 extends SendOptions {
+    id: string;
+    request?: RequestInit;
+}
+declare class GetSourceRequest {
+    protected _client: Client;
+    constructor(_client: Client);
+    send({ id, request, ...options }: Options$1): Promise<GetSourceResponse>;
+}
+type GetSourceResponsePayload = {
+    source: {
+        id: string;
+        name: string;
+        category: string;
+        url: string;
+        disambiguatingDescription: string;
+    };
+};
+declare class GetSourceResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<GetSourceResponsePayload>;
+}
+
 /**
  * Great Detail Support System.
  *
@@ -510,6 +689,7 @@ declare class Client {
         list: ListChannelsRequest;
     };
     contact: {
+        get: GetContactRequest;
         list: ListContactsRequest;
     };
     conversation: {
@@ -517,12 +697,15 @@ declare class Client {
         list: ListConversationsRequest;
     };
     label: {
+        create: CreateLabelRequest;
+        get: GetLabelRequest;
         list: ListLabelsRequest;
     };
     message: {
         list: ListMessagesRequest;
     };
     model: {
+        get: GetModelRequest;
         list: ListModelsRequest;
         response: {
             create: CreateResponseModelRequest;
@@ -532,10 +715,11 @@ declare class Client {
         };
     };
     source: {
+        get: GetSourceRequest;
         list: ListSourcesRequest;
     };
     protected _filterRequest(request: RequestInit): Promise<RequestInit>;
     send(url: string | URL, request: RequestInit, { fetch: fetchAlternative }?: SendOptions): Promise<Response>;
 }
 
-export { Client, type CreateCorrectionResponsePayload, type CreateResponseResponsePayload, DEFAULT_SUPPORT_BASE_URL, type GetConversationResponsePayload, KeyAuthentication, type ListActionsResponsePayload, type ListChannelsResponsePayload, type ListContactsResponsePayload, type ListConversationsResponsePayload, type ListLabelsResponsePayload, type ListMessagesResponsePayload, type ListModelsResponsePayload, type ListSourcesResponsePayload, PublicAuthentication, type RequestFilterable, TokenAuthentication, Client as default };
+export { Client, type CreateCorrectionResponsePayload, type CreateLabelResponsePayload, type CreateResponseResponsePayload, DEFAULT_SUPPORT_BASE_URL, type GetConversationResponsePayload, KeyAuthentication, type ListActionsResponsePayload, type ListChannelsResponsePayload, type ListContactsResponsePayload, type ListConversationsResponsePayload, type ListLabelsResponsePayload, type ListMessagesResponsePayload, type ListModelsResponsePayload, type ListSourcesResponsePayload, PublicAuthentication, type RequestFilterable, TokenAuthentication, Client as default };

package/dist/index.js

@@ -1 +1 @@
-import{a,b as i,c as p,d as n}from"./chunk-LS7DRWDS.js";var t=class s{static DEFAULT_NAME=i;name;#e;constructor({name:e=process.env.SUPPORT_KEY_NAME??s.DEFAULT_NAME,key:r=process.env.SUPPORT_API_KEY}={}){if(!r)throw new Error("API Key option must be specified when using Key Authentication");this.name=e,this.#e=r}async filter(e){return{...e,headers:{...e.headers,Authorization:`Basic ${btoa(this.name+":"+this.#e)}`}}}};var o=class{#e;constructor({token:e=process.env.SUPPORT_ACCESS_TOKEN}={}){if(!e)throw new Error("Access Token option must be specified when using Token Authentication");this.#e=e}async filter(e){return{...e,headers:{...e.headers,Authorization:`Bearer ${this.#e}`}}}};export{n as Client,a as DEFAULT_SUPPORT_BASE_URL,t as KeyAuthentication,p as PublicAuthentication,o as TokenAuthentication,n as default};
+import{a,b as n,c as p,d as i}from"./chunk-BFO7RVLV.js";var t=class s{static DEFAULT_NAME=n;name;#e;constructor({name:e=process.env.SUPPORT_KEY_NAME??s.DEFAULT_NAME,key:r=process.env.SUPPORT_API_KEY}={}){if(!r)throw new Error("API Key option must be specified when using Key Authentication");this.name=e,this.#e=r}async filter(e){return{...e,headers:{...e.headers,Authorization:`Basic ${btoa(this.name+":"+this.#e)}`}}}};var o=class{#e;constructor({token:e=process.env.SUPPORT_ACCESS_TOKEN}={}){if(!e)throw new Error("Access Token option must be specified when using Token Authentication");this.#e=e}async filter(e){return{...e,headers:{...e.headers,Authorization:`Bearer ${this.#e}`}}}};export{i as Client,a as DEFAULT_SUPPORT_BASE_URL,t as KeyAuthentication,p as PublicAuthentication,o as TokenAuthentication,i as default};

package/package.json

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

package/src/Client/index.ts

@@ -11,16 +11,21 @@ import ListActionsRequest from "../Action/ListActions.js";
 import Authentication from "../Authentication/index.js";
 import ListChannelsRequest from "../Channel/ListChannels.js";
 import { DEFAULT_SUPPORT_BASE_URL } from "../constants/index.js";
+import GetContactRequest from "../Contact/GetContact.js";
 import ListContactsRequest from "../Contact/ListContacts.js";
 import GetConversationRequest from "../Conversation/GetConversation.js";
 import ListConversationsRequest from "../Conversation/ListConversations.js";
+import CreateLabelRequest from "../Label/CreateLabel.js";
+import GetLabelRequest from "../Label/GetLabel.js";
 import ListLabelsRequest from "../Label/ListLabels.js";
 import ListMessagesRequest from "../Message/ListMessages.js";
 import CreateCorrectionModelRequest from "../Model/Correction/CreateCorrectionModel.js";
+import GetModelRequest from "../Model/GetModel.js";
 import ListModelsRequest from "../Model/ListModels.js";
 import CreateResponseModelRequest from "../Model/Response/CreateResponseModel.js";
 import RequestFilterable from "../Request/RequestFilterable.js";
 import RequestStandardHeaders from "../Request/RequestStandardHeaders.js";
+import GetSourceRequest from "../Source/GetSource.js";
 import ListSourcesRequest from "../Source/ListSources.js";
 
 export interface ClientOptions {
@@ -68,6 +73,7 @@ export default class Client {
   };
 
   public contact = {
+    get: new GetContactRequest(this),
     list: new ListContactsRequest(this),
   };
 
@@ -77,6 +83,8 @@ export default class Client {
   };
 
   public label = {
+    create: new CreateLabelRequest(this),
+    get: new GetLabelRequest(this),
     list: new ListLabelsRequest(this),
   };
 
@@ -85,6 +93,7 @@ export default class Client {
   };
 
   public model = {
+    get: new GetModelRequest(this),
     list: new ListModelsRequest(this),
     response: {
       create: new CreateResponseModelRequest(this),
@@ -95,6 +104,7 @@ export default class Client {
   };
 
   public source = {
+    get: new GetSourceRequest(this),
     list: new ListSourcesRequest(this),
   };
 

package/src/Contact/GetContact.ts

@@ -0,0 +1,51 @@
+/**
+ * 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 Client, { SendOptions } from "../Client/index.js";
+
+export interface Options extends SendOptions {
+  id: string;
+  request?: RequestInit;
+}
+
+export default class GetContactRequest {
+  constructor(protected _client: Client) {}
+
+  public async send({ id, request = {}, ...options }: Options) {
+    return this._client
+      .send(
+        "/v1/contacts/" + encodeURIComponent(id),
+        {
+          ...request,
+          method: "GET",
+        },
+        options,
+      )
+      .then((response) => new GetContactResponse(response));
+  }
+}
+
+export type GetContactResponsePayload = {
+  contact: {
+    id: string;
+    name?: string;
+    emailAddress?: string;
+    telephoneNumber?: string;
+    createdAt: string;
+    updatedAt?: string;
+  };
+};
+
+export class GetContactResponse {
+  constructor(public response: Response) {}
+
+  public async result(): Promise<GetContactResponsePayload> {
+    return this.response.json();
+  }
+}

package/src/Label/CreateLabel.ts

@@ -0,0 +1,62 @@
+/**
+ * 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 Client, { SendOptions } from "../Client/index.js";
+
+export interface Options extends SendOptions {
+  body: z.infer<typeof CreateLabelRequest.SCHEMA>;
+  request?: RequestInit;
+}
+
+export default class CreateLabelRequest {
+  public static SCHEMA = z.object({
+    title: z.string(),
+    description: z.optional(z.string()),
+    account: z.string(),
+  });
+
+  constructor(protected _client: Client) {}
+
+  public async send({ body, request = {}, ...options }: Options) {
+    return this._client
+      .send(
+        "/v1/labels",
+        {
+          ...request,
+          method: "POST",
+          headers: {
+            ...request.headers,
+            "Content-Type": "application/json",
+          },
+          body: JSON.stringify(CreateLabelRequest.SCHEMA.parse(body)),
+        },
+        options,
+      )
+      .then((response) => new CreateLabelResponse(response));
+  }
+}
+
+export type CreateLabelResponsePayload = {
+  label: {
+    id: string;
+    title: string;
+    description?: string;
+    createdAt: string;
+    updatedAt?: string;
+  };
+};
+
+export class CreateLabelResponse {
+  constructor(public response: Response) {}
+
+  public async result(): Promise<CreateLabelResponsePayload> {
+    return this.response.json();
+  }
+}

package/src/Label/GetLabel.ts

@@ -0,0 +1,50 @@
+/**
+ * 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 Client, { SendOptions } from "../Client/index.js";
+
+export interface Options extends SendOptions {
+  id: string;
+  request?: RequestInit;
+}
+
+export default class GetLabelRequest {
+  constructor(protected _client: Client) {}
+
+  public async send({ id, request = {}, ...options }: Options) {
+    return this._client
+      .send(
+        "/v1/labels/" + encodeURIComponent(id),
+        {
+          ...request,
+          method: "GET",
+        },
+        options,
+      )
+      .then((response) => new GetLabelResponse(response));
+  }
+}
+
+export type GetLabelResponsePayload = {
+  label: {
+    id: string;
+    title: string;
+    description?: string;
+    createdAt: string;
+    updatedAt?: string;
+  };
+};
+
+export class GetLabelResponse {
+  constructor(public response: Response) {}
+
+  public async result(): Promise<GetLabelResponsePayload> {
+    return this.response.json();
+  }
+}

package/src/Model/GetModel.ts

@@ -0,0 +1,50 @@
+/**
+ * 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 Client, { SendOptions } from "../Client/index.js";
+
+export interface Options extends SendOptions {
+  id: string;
+  request?: RequestInit;
+}
+
+export default class GetModelRequest {
+  constructor(protected _client: Client) {}
+
+  public async send({ id, request = {}, ...options }: Options) {
+    return this._client
+      .send(
+        "/v1/models/" + encodeURIComponent(id),
+        {
+          ...request,
+          method: "GET",
+        },
+        options,
+      )
+      .then((response) => new GetModelResponse(response));
+  }
+}
+
+export type GetModelResponsePayload = {
+  model: {
+    id: string;
+    name: string;
+    url: string;
+    icon: string;
+    disambiguatingDescription: string;
+  };
+};
+
+export class GetModelResponse {
+  constructor(public response: Response) {}
+
+  public async result(): Promise<GetModelResponsePayload> {
+    return this.response.json();
+  }
+}