@great-detail/support-sdk 0.1.5 → 0.2.0

package/dist/{index-Dm8jdpkD.d.cts → index-Dj17QRj0.d.cts}

@@ -9,7 +9,13 @@ import { z } from 'zod';
  * @see       https://greatdetail.com
  */
 interface RequestFilterable {
-    filter(request: RequestInit): Promise<RequestInit>;
+    /**
+     * @deprecated
+     */
+    filter(...options: unknown[]): Promise<{
+        headers: Record<string, string>;
+    }>;
+    getHeaders(): Record<string, string>;
 }
 
 /**
@@ -21,11 +27,24 @@ interface RequestFilterable {
  * @see       https://greatdetail.com
  */
 
-interface Options$q {
+interface Options$r {
     requestFilterables: RequestFilterable[];
-    baseURL: string;
 }
-interface SendOptions {
+interface Transport {
+    getURL(url: string): string;
+}
+
+/**
+ * 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 InputOptions extends Options$r {
+    baseURL: string;
     /**
      * Alternative Fetch Provider.
      * Used to override the default fetch provider and use polyfills or other
@@ -35,12 +54,16 @@ interface SendOptions {
      */
     fetch?: typeof fetch;
 }
-declare class Transport {
+interface Options$q extends Options$r {
+    baseURL: string;
+    fetch: typeof fetch;
+}
+declare class FetchTransport implements Transport {
     options: Options$q;
-    constructor({ baseURL, ...options }: Options$q);
-    protected _filterRequest(request: RequestInit): Promise<RequestInit>;
-    getURL(url: string | URL): URL;
-    send(url: string | URL, request: RequestInit, { fetch: fetchAlternative }?: SendOptions): Promise<Response>;
+    constructor({ baseURL, fetch: fetchAlternative, ...options }: InputOptions);
+    getURL(url: string): string;
+    getRequest(url: string, request: RequestInit): Request;
+    send(url: string, request: RequestInit): Promise<Response>;
 }
 
 /**
@@ -52,13 +75,13 @@ declare class Transport {
  * @see       https://greatdetail.com
  */
 
-interface Options$p extends SendOptions {
+interface Options$p {
     request?: RequestInit;
 }
 declare class ListActions {
-    protected _transport: Transport;
-    constructor(_transport: Transport);
-    send({ request, ...options }?: Options$p): Promise<ListActionsResponse>;
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ request }?: Options$p): Promise<ListActionsResponse>;
 }
 type ListActionsResponsePayload = {
     actions: {
@@ -100,13 +123,13 @@ type Authentication = RequestFilterable;
  * @see       https://greatdetail.com
  */
 
-interface Options$o extends SendOptions {
+interface Options$o {
     request?: RequestInit;
 }
 declare class ListChannels {
-    protected _transport: Transport;
-    constructor(_transport: Transport);
-    send({ request, ...options }?: Options$o): Promise<ListChannelsResponse>;
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ request }?: Options$o): Promise<ListChannelsResponse>;
 }
 type ListChannelsResponsePayload = {
     channels: ({
@@ -149,11 +172,18 @@ declare class ListChannelsResponse {
 
 interface Options$n {
     id: string;
+    vcf?: {
+        variant?: "vcard";
+        format?: "vcf" | "qr";
+    } | {
+        variant: "jcard";
+        format?: "json";
+    };
 }
 declare class GetContactVCFURL {
-    protected _transport: Transport;
-    constructor(_transport: Transport);
-    send({ id }: Options$n): Promise<URL>;
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    getURL({ id, vcf }: Options$n): string;
 }
 
 /**
@@ -165,12 +195,12 @@ declare class GetContactVCFURL {
  * @see       https://greatdetail.com
  */
 
-interface Options$m extends SendOptions {
+interface Options$m {
     body: z.infer<typeof CreateContact.SCHEMA>;
     request?: RequestInit;
 }
 declare class CreateContact {
-    protected _transport: Transport;
+    protected _transport: FetchTransport;
     static SCHEMA: z.ZodObject<{
         name: z.ZodString;
         account: z.ZodString;
@@ -187,8 +217,8 @@ declare class CreateContact {
         emailAddress?: string | undefined;
         telephoneNumber?: string | undefined;
     }>;
-    constructor(_transport: Transport);
-    send({ body, request, ...options }: Options$m): Promise<CreateContactResponse>;
+    constructor(_transport: FetchTransport);
+    send({ body, request }: Options$m): Promise<CreateContactResponse>;
 }
 type CreateContactResponsePayload = {
     contact: {
@@ -216,14 +246,14 @@ declare class CreateContactResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$l extends SendOptions {
+interface Options$l {
     id: string;
     request?: RequestInit;
 }
 declare class GetContact {
-    protected _transport: Transport;
-    constructor(_transport: Transport);
-    send({ id, request, ...options }: Options$l): Promise<GetContactResponse>;
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, request }: Options$l): Promise<GetContactResponse>;
 }
 type GetContactResponsePayload = {
     contact: {
@@ -251,13 +281,13 @@ declare class GetContactResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$k extends SendOptions {
+interface Options$k {
     request?: RequestInit;
 }
 declare class ListContacts {
-    protected _transport: Transport;
-    constructor(_transport: Transport);
-    send({ request, ...options }?: Options$k): Promise<ListContactsResponse>;
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ request }?: Options$k): Promise<ListContactsResponse>;
 }
 type ListContactsResponsePayload = {
     contacts: {
@@ -285,14 +315,14 @@ declare class ListContactsResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$j extends SendOptions {
+interface Options$j {
     id: string;
     request?: RequestInit;
 }
 declare class ListLabelContacts {
-    protected _transport: Transport;
-    constructor(_transport: Transport);
-    send({ id, request, ...options }: Options$j): Promise<ListLabelContactsResponse>;
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, request }: Options$j): Promise<ListLabelContactsResponse>;
 }
 type ListLabelContactsResponsePayload = {
     contacts: {
@@ -320,13 +350,13 @@ declare class ListLabelContactsResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$i extends SendOptions {
+interface Options$i {
     id: string;
     body: z.infer<typeof UpdateContact.SCHEMA>;
     request?: RequestInit;
 }
 declare class UpdateContact {
-    protected _transport: Transport;
+    protected _transport: FetchTransport;
     static SCHEMA: z.ZodObject<{
         name: z.ZodOptional<z.ZodString>;
         emailAddress: z.ZodOptional<z.ZodString>;
@@ -340,8 +370,8 @@ declare class UpdateContact {
         emailAddress?: string | undefined;
         telephoneNumber?: string | undefined;
     }>;
-    constructor(_transport: Transport);
-    send({ id, body, request, ...options }: Options$i): Promise<UpdateContactResponse>;
+    constructor(_transport: FetchTransport);
+    send({ id, body, request }: Options$i): Promise<UpdateContactResponse>;
 }
 type UpdateContactResponsePayload = {
     contact: {
@@ -369,14 +399,14 @@ declare class UpdateContactResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$h extends SendOptions {
+interface Options$h {
     id: string;
     request?: RequestInit;
 }
 declare class GetConversation {
-    protected _transport: Transport;
-    constructor(_transport: Transport);
-    send({ id, request, ...options }: Options$h): Promise<GetConversationResponse>;
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, request }: Options$h): Promise<GetConversationResponse>;
 }
 type GetConversationResponsePayload = {
     conversation: {
@@ -404,13 +434,13 @@ declare class GetConversationResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$g extends SendOptions {
+interface Options$g {
     request?: RequestInit;
 }
 declare class ListConversations {
-    protected _transport: Transport;
-    constructor(_transport: Transport);
-    send({ request, ...options }?: Options$g): Promise<ListConversationsResponse>;
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ request }?: Options$g): Promise<ListConversationsResponse>;
 }
 type ListConversationsResponsePayload = {
     conversations: {
@@ -438,14 +468,14 @@ declare class ListConversationsResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$f extends SendOptions {
+interface Options$f {
     id: string;
     request?: RequestInit;
 }
 declare class ListLabelConversations {
-    protected _transport: Transport;
-    constructor(_transport: Transport);
-    send({ id, request, ...options }: Options$f): Promise<ListLabelConversationsResponse>;
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, request }: Options$f): Promise<ListLabelConversationsResponse>;
 }
 type ListLabelConversationsResponsePayload = {
     conversations: {
@@ -473,13 +503,13 @@ declare class ListLabelConversationsResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$e extends SendOptions {
+interface Options$e {
     id: string;
     body: z.infer<typeof UpdateConversation.SCHEMA>;
     request?: RequestInit;
 }
 declare class UpdateConversation {
-    protected _transport: Transport;
+    protected _transport: FetchTransport;
     static SCHEMA: z.ZodObject<{
         hasEnded: z.ZodBoolean;
     }, "strip", z.ZodTypeAny, {
@@ -487,8 +517,8 @@ declare class UpdateConversation {
     }, {
         hasEnded: boolean;
     }>;
-    constructor(_transport: Transport);
-    send({ id, body, request, ...options }: Options$e): Promise<UpdateConversationResponse>;
+    constructor(_transport: FetchTransport);
+    send({ id, body, request }: Options$e): Promise<UpdateConversationResponse>;
 }
 type UpdateConversationResponsePayload = {
     conversation: {
@@ -516,12 +546,12 @@ declare class UpdateConversationResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$d extends SendOptions {
+interface Options$d {
     body: z.infer<typeof CreateLabel.SCHEMA>;
     request?: RequestInit;
 }
 declare class CreateLabel {
-    protected _transport: Transport;
+    protected _transport: FetchTransport;
     static SCHEMA: z.ZodObject<{
         title: z.ZodString;
         description: z.ZodOptional<z.ZodString>;
@@ -535,8 +565,8 @@ declare class CreateLabel {
         title: string;
         description?: string | undefined;
     }>;
-    constructor(_transport: Transport);
-    send({ body, request, ...options }: Options$d): Promise<CreateLabelResponse>;
+    constructor(_transport: FetchTransport);
+    send({ body, request }: Options$d): Promise<CreateLabelResponse>;
 }
 type CreateLabelResponsePayload = {
     label: {
@@ -563,14 +593,14 @@ declare class CreateLabelResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$c extends SendOptions {
+interface Options$c {
     id: string;
     request?: RequestInit;
 }
 declare class DeleteLabel {
-    protected _transport: Transport;
-    constructor(_transport: Transport);
-    send({ id, request, ...options }: Options$c): Promise<DeleteLabelResponse>;
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, request }: Options$c): Promise<DeleteLabelResponse>;
 }
 type DeleteLabelResponsePayload = Record<string, never>;
 declare class DeleteLabelResponse {
@@ -588,14 +618,14 @@ declare class DeleteLabelResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$b extends SendOptions {
+interface Options$b {
     id: string;
     request?: RequestInit;
 }
 declare class GetLabel {
-    protected _transport: Transport;
-    constructor(_transport: Transport);
-    send({ id, request, ...options }: Options$b): Promise<GetLabelResponse>;
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, request }: Options$b): Promise<GetLabelResponse>;
 }
 type GetLabelResponsePayload = {
     label: {
@@ -622,13 +652,13 @@ declare class GetLabelResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$a extends SendOptions {
+interface Options$a {
     request?: RequestInit;
 }
 declare class ListLabels {
-    protected _transport: Transport;
-    constructor(_transport: Transport);
-    send({ request, ...options }?: Options$a): Promise<ListLabelsResponse>;
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ request }?: Options$a): Promise<ListLabelsResponse>;
 }
 type ListLabelsResponsePayload = {
     labels: {
@@ -655,13 +685,13 @@ declare class ListLabelsResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$9 extends SendOptions {
+interface Options$9 {
     id: string;
     body: z.infer<typeof UpdateLabel.SCHEMA>;
     request?: RequestInit;
 }
 declare class UpdateLabel {
-    protected _transport: Transport;
+    protected _transport: FetchTransport;
     static SCHEMA: z.ZodObject<{
         title: z.ZodOptional<z.ZodString>;
         description: z.ZodOptional<z.ZodString>;
@@ -672,8 +702,8 @@ declare class UpdateLabel {
         title?: string | undefined;
         description?: string | undefined;
     }>;
-    constructor(_transport: Transport);
-    send({ id, body, request, ...options }: Options$9): Promise<UpdateLabelResponse>;
+    constructor(_transport: FetchTransport);
+    send({ id, body, request }: Options$9): Promise<UpdateLabelResponse>;
 }
 type UpdateLabelResponsePayload = {
     label: {
@@ -700,14 +730,14 @@ declare class UpdateLabelResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$8 extends SendOptions {
+interface Options$8 {
     id: string;
     request?: RequestInit;
 }
 declare class ListConversationMessages {
-    protected _transport: Transport;
-    constructor(_transport: Transport);
-    send({ id, request, ...options }: Options$8): Promise<ListConversationMessagesResponse>;
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, request }: Options$8): Promise<ListConversationMessagesResponse>;
 }
 type ListConversationMessagesResponsePayload = {
     messages: {
@@ -743,13 +773,13 @@ declare class ListConversationMessagesResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$7 extends SendOptions {
+interface Options$7 {
     request?: RequestInit;
 }
 declare class ListMessages {
-    protected _transport: Transport;
-    constructor(_transport: Transport);
-    send({ request, ...options }?: Options$7): Promise<ListMessagesResponse>;
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ request }?: Options$7): Promise<ListMessagesResponse>;
 }
 type ListMessagesResponsePayload = {
     messages: {
@@ -785,13 +815,13 @@ declare class ListMessagesResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$6 extends SendOptions {
+interface Options$6 {
     id: string;
     body: z.infer<typeof CreateCorrectionModel.SCHEMA>;
     request?: RequestInit;
 }
 declare class CreateCorrectionModel {
-    protected _transport: Transport;
+    protected _transport: FetchTransport;
     static SCHEMA: z.ZodObject<{
         input: z.ZodString;
         original: z.ZodString;
@@ -805,8 +835,8 @@ declare class CreateCorrectionModel {
         original: string;
         correction: string;
     }>;
-    constructor(_transport: Transport);
-    send({ id, body, request, ...options }: Options$6): Promise<CreateCorrectionModelResponse>;
+    constructor(_transport: FetchTransport);
+    send({ id, body, request }: Options$6): Promise<CreateCorrectionModelResponse>;
 }
 type CreateCorrectionResponsePayload = unknown;
 declare class CreateCorrectionModelResponse {
@@ -824,14 +854,14 @@ declare class CreateCorrectionModelResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$5 extends SendOptions {
+interface Options$5 {
     id: string;
     request?: RequestInit;
 }
 declare class GetModel {
-    protected _transport: Transport;
-    constructor(_transport: Transport);
-    send({ id, request, ...options }: Options$5): Promise<GetModelResponse>;
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, request }: Options$5): Promise<GetModelResponse>;
 }
 type GetModelResponsePayload = {
     model: {
@@ -857,13 +887,13 @@ declare class GetModelResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$4 extends SendOptions {
+interface Options$4 {
     request?: RequestInit;
 }
 declare class ListModels {
-    protected _transport: Transport;
-    constructor(_transport: Transport);
-    send({ request, ...options }?: Options$4): Promise<ListModelsResponse>;
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ request }?: Options$4): Promise<ListModelsResponse>;
 }
 type ListModelsResponsePayload = {
     models: {
@@ -889,13 +919,13 @@ declare class ListModelsResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$3 extends SendOptions {
+interface Options$3 {
     id: string;
     body: z.infer<typeof CreateResponseModel.SCHEMA>;
     request?: RequestInit;
 }
 declare class CreateResponseModel {
-    protected _transport: Transport;
+    protected _transport: FetchTransport;
     static SCHEMA: z.ZodArray<z.ZodObject<{
         role: z.ZodEnum<["user", "assistant"]>;
         content: z.ZodNullable<z.ZodString>;
@@ -906,8 +936,8 @@ declare class CreateResponseModel {
         role: "user" | "assistant";
         content: string | null;
     }>, "many">;
-    constructor(_transport: Transport);
-    send({ id, body, request, ...options }: Options$3): Promise<CreateResponseModelResponse>;
+    constructor(_transport: FetchTransport);
+    send({ id, body, request }: Options$3): Promise<CreateResponseModelResponse>;
 }
 type CreateResponseResponsePayload = {
     message: string | null;
@@ -931,14 +961,14 @@ declare class CreateResponseModelResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$2 extends SendOptions {
+interface Options$2 {
     id: string;
     request?: RequestInit;
 }
 declare class GetSource {
-    protected _transport: Transport;
-    constructor(_transport: Transport);
-    send({ id, request, ...options }: Options$2): Promise<GetSourceResponse>;
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ id, request }: Options$2): Promise<GetSourceResponse>;
 }
 type GetSourceResponsePayload = {
     source: {
@@ -965,13 +995,13 @@ declare class GetSourceResponse {
  * @see       https://greatdetail.com
  */
 
-interface Options$1 extends SendOptions {
+interface Options$1 {
     request?: RequestInit;
 }
 declare class ListSources {
-    protected _transport: Transport;
-    constructor(_transport: Transport);
-    send({ request, ...options }?: Options$1): Promise<ListSourcesResponse>;
+    protected _transport: FetchTransport;
+    constructor(_transport: FetchTransport);
+    send({ request }?: Options$1): Promise<ListSourcesResponse>;
 }
 type ListSourcesResponsePayload = {
     sources: {
@@ -1003,7 +1033,7 @@ interface Options {
 }
 declare class Client {
     static DEFAULT_BASE_URL: string;
-    _transport: Transport;
+    _transport: FetchTransport;
     constructor(authentication: Authentication, { baseURL, ...options }?: Options);
     static getBaseURL(): string;
     get action(): {
@@ -1018,7 +1048,7 @@ declare class Client {
         update: UpdateContact;
         create: CreateContact;
         vcf: {
-            getURL: GetContactVCFURL;
+            get: GetContactVCFURL;
         };
     };
     get conversation(): {
@@ -1061,4 +1091,4 @@ declare class Client {
     };
 }
 
-export { type Authentication as A, Client as C, type DeleteLabelResponsePayload as D, type GetContactResponsePayload as G, type ListActionsResponsePayload as L, type Options as O, type RequestFilterable as R, type SendOptions as S, type UpdateContactResponsePayload as U, type Options$q as a, type ListChannelsResponsePayload as b, type ListContactsResponsePayload as c, type ListLabelContactsResponsePayload as d, type CreateContactResponsePayload as e, type GetConversationResponsePayload as f, type ListConversationsResponsePayload as g, type ListLabelConversationsResponsePayload as h, type UpdateConversationResponsePayload as i, type CreateLabelResponsePayload as j, type GetLabelResponsePayload as k, type ListLabelsResponsePayload as l, type UpdateLabelResponsePayload as m, type ListConversationMessagesResponsePayload as n, type ListMessagesResponsePayload as o, type GetModelResponsePayload as p, type ListModelsResponsePayload as q, type CreateCorrectionResponsePayload as r, type CreateResponseResponsePayload as s, type GetSourceResponsePayload as t, type ListSourcesResponsePayload as u };
+export { type Authentication as A, Client as C, type DeleteLabelResponsePayload as D, type GetContactResponsePayload as G, type ListActionsResponsePayload as L, type Options as O, type RequestFilterable as R, type UpdateContactResponsePayload as U, type Options$r as a, type ListChannelsResponsePayload as b, type ListContactsResponsePayload as c, type ListLabelContactsResponsePayload as d, type CreateContactResponsePayload as e, type GetConversationResponsePayload as f, type ListConversationsResponsePayload as g, type ListLabelConversationsResponsePayload as h, type UpdateConversationResponsePayload as i, type CreateLabelResponsePayload as j, type GetLabelResponsePayload as k, type ListLabelsResponsePayload as l, type UpdateLabelResponsePayload as m, type ListConversationMessagesResponsePayload as n, type ListMessagesResponsePayload as o, type GetModelResponsePayload as p, type ListModelsResponsePayload as q, type CreateCorrectionResponsePayload as r, type CreateResponseResponsePayload as s, type GetSourceResponsePayload as t, type ListSourcesResponsePayload as u };