@great-detail/support-sdk 0.1.0 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -21,18 +21,7 @@ interface RequestFilterable {
21
21
  * @see https://greatdetail.com
22
22
  */
23
23
 
24
- type Authentication = RequestFilterable;
25
-
26
- /**
27
- * Great Detail Support System.
28
- *
29
- * @copyright 2024 Great Detail Ltd
30
- * @author Great Detail Ltd <info@greatdetail.com>
31
- * @author Dom Webber <dom.webber@greatdetail.com>
32
- * @see https://greatdetail.com
33
- */
34
-
35
- interface TransportOptions {
24
+ interface Options$o {
36
25
  requestFilterables: RequestFilterable[];
37
26
  baseURL: string;
38
27
  }
@@ -47,8 +36,8 @@ interface SendOptions {
47
36
  fetch?: typeof fetch;
48
37
  }
49
38
  declare class Transport {
50
- options: TransportOptions;
51
- constructor({ baseURL, ...options }: TransportOptions);
39
+ options: Options$o;
40
+ constructor({ baseURL, ...options }: Options$o);
52
41
  protected _filterRequest(request: RequestInit): Promise<RequestInit>;
53
42
  send(url: string | URL, request: RequestInit, { fetch: fetchAlternative }?: SendOptions): Promise<Response>;
54
43
  }
@@ -62,13 +51,13 @@ declare class Transport {
62
51
  * @see https://greatdetail.com
63
52
  */
64
53
 
65
- interface Options$l extends SendOptions {
54
+ interface Options$n extends SendOptions {
66
55
  request?: RequestInit;
67
56
  }
68
57
  declare class ListActionsRequest {
69
58
  protected _transport: Transport;
70
59
  constructor(_transport: Transport);
71
- send({ request, ...options }?: Options$l): Promise<ListActionsResponse>;
60
+ send({ request, ...options }?: Options$n): Promise<ListActionsResponse>;
72
61
  }
73
62
  type ListActionsResponsePayload = {
74
63
  actions: {
@@ -99,13 +88,24 @@ declare class ListActionsResponse {
99
88
  * @see https://greatdetail.com
100
89
  */
101
90
 
102
- interface Options$k extends SendOptions {
91
+ type Authentication = RequestFilterable;
92
+
93
+ /**
94
+ * Great Detail Support System.
95
+ *
96
+ * @copyright 2024 Great Detail Ltd
97
+ * @author Great Detail Ltd <info@greatdetail.com>
98
+ * @author Dom Webber <dom.webber@greatdetail.com>
99
+ * @see https://greatdetail.com
100
+ */
101
+
102
+ interface Options$m extends SendOptions {
103
103
  request?: RequestInit;
104
104
  }
105
105
  declare class ListChannelsRequest {
106
106
  protected _transport: Transport;
107
107
  constructor(_transport: Transport);
108
- send({ request, ...options }?: Options$k): Promise<ListChannelsResponse>;
108
+ send({ request, ...options }?: Options$m): Promise<ListChannelsResponse>;
109
109
  }
110
110
  type ListChannelsResponsePayload = {
111
111
  channels: ({
@@ -146,14 +146,65 @@ declare class ListChannelsResponse {
146
146
  * @see https://greatdetail.com
147
147
  */
148
148
 
149
- interface Options$j extends SendOptions {
149
+ interface Options$l extends SendOptions {
150
+ body: z.infer<typeof CreateContactRequest.SCHEMA>;
151
+ request?: RequestInit;
152
+ }
153
+ declare class CreateContactRequest {
154
+ protected _transport: Transport;
155
+ static SCHEMA: z.ZodObject<{
156
+ name: z.ZodString;
157
+ account: z.ZodString;
158
+ emailAddress: z.ZodOptional<z.ZodString>;
159
+ telephoneNumber: z.ZodOptional<z.ZodString>;
160
+ }, "strip", z.ZodTypeAny, {
161
+ name: string;
162
+ account: string;
163
+ emailAddress?: string | undefined;
164
+ telephoneNumber?: string | undefined;
165
+ }, {
166
+ name: string;
167
+ account: string;
168
+ emailAddress?: string | undefined;
169
+ telephoneNumber?: string | undefined;
170
+ }>;
171
+ constructor(_transport: Transport);
172
+ send({ body, request, ...options }: Options$l): Promise<CreateContactResponse>;
173
+ }
174
+ type CreateContactResponsePayload = {
175
+ contact: {
176
+ id: string;
177
+ name?: string;
178
+ emailAddress?: string;
179
+ telephoneNumber?: string;
180
+ account: string;
181
+ createdAt: string;
182
+ updatedAt?: string;
183
+ };
184
+ };
185
+ declare class CreateContactResponse {
186
+ response: Response;
187
+ constructor(response: Response);
188
+ result(): Promise<CreateContactResponsePayload>;
189
+ }
190
+
191
+ /**
192
+ * Great Detail Support System.
193
+ *
194
+ * @copyright 2024 Great Detail Ltd
195
+ * @author Great Detail Ltd <info@greatdetail.com>
196
+ * @author Dom Webber <dom.webber@greatdetail.com>
197
+ * @see https://greatdetail.com
198
+ */
199
+
200
+ interface Options$k extends SendOptions {
150
201
  id: string;
151
202
  request?: RequestInit;
152
203
  }
153
204
  declare class GetContactRequest {
154
205
  protected _transport: Transport;
155
206
  constructor(_transport: Transport);
156
- send({ id, request, ...options }: Options$j): Promise<GetContactResponse>;
207
+ send({ id, request, ...options }: Options$k): Promise<GetContactResponse>;
157
208
  }
158
209
  type GetContactResponsePayload = {
159
210
  contact: {
@@ -181,13 +232,13 @@ declare class GetContactResponse {
181
232
  * @see https://greatdetail.com
182
233
  */
183
234
 
184
- interface Options$i extends SendOptions {
235
+ interface Options$j extends SendOptions {
185
236
  request?: RequestInit;
186
237
  }
187
238
  declare class ListContactsRequest {
188
239
  protected _transport: Transport;
189
240
  constructor(_transport: Transport);
190
- send({ request, ...options }?: Options$i): Promise<ListContactsResponse>;
241
+ send({ request, ...options }?: Options$j): Promise<ListContactsResponse>;
191
242
  }
192
243
  type ListContactsResponsePayload = {
193
244
  contacts: {
@@ -215,7 +266,7 @@ declare class ListContactsResponse {
215
266
  * @see https://greatdetail.com
216
267
  */
217
268
 
218
- interface Options$h extends SendOptions {
269
+ interface Options$i extends SendOptions {
219
270
  id: string;
220
271
  body: z.infer<typeof UpdateContactRequest.SCHEMA>;
221
272
  request?: RequestInit;
@@ -236,7 +287,7 @@ declare class UpdateContactRequest {
236
287
  telephoneNumber?: string | undefined;
237
288
  }>;
238
289
  constructor(_transport: Transport);
239
- send({ id, body, request, ...options }: Options$h): Promise<UpdateContactResponse>;
290
+ send({ id, body, request, ...options }: Options$i): Promise<UpdateContactResponse>;
240
291
  }
241
292
  type UpdateContactResponsePayload = {
242
293
  contact: {
@@ -264,14 +315,14 @@ declare class UpdateContactResponse {
264
315
  * @see https://greatdetail.com
265
316
  */
266
317
 
267
- interface Options$g extends SendOptions {
318
+ interface Options$h extends SendOptions {
268
319
  id: string;
269
320
  request?: RequestInit;
270
321
  }
271
322
  declare class GetConversationRequest {
272
323
  protected _transport: Transport;
273
324
  constructor(_transport: Transport);
274
- send({ id, request, ...options }: Options$g): Promise<GetConversationResponse>;
325
+ send({ id, request, ...options }: Options$h): Promise<GetConversationResponse>;
275
326
  }
276
327
  type GetConversationResponsePayload = {
277
328
  conversation: {
@@ -299,13 +350,13 @@ declare class GetConversationResponse {
299
350
  * @see https://greatdetail.com
300
351
  */
301
352
 
302
- interface Options$f extends SendOptions {
353
+ interface Options$g extends SendOptions {
303
354
  request?: RequestInit;
304
355
  }
305
356
  declare class ListConversationsRequest {
306
357
  protected _transport: Transport;
307
358
  constructor(_transport: Transport);
308
- send({ request, ...options }?: Options$f): Promise<ListConversationsResponse>;
359
+ send({ request, ...options }?: Options$g): Promise<ListConversationsResponse>;
309
360
  }
310
361
  type ListConversationsResponsePayload = {
311
362
  conversations: {
@@ -333,14 +384,14 @@ declare class ListConversationsResponse {
333
384
  * @see https://greatdetail.com
334
385
  */
335
386
 
336
- interface Options$e extends SendOptions {
387
+ interface Options$f extends SendOptions {
337
388
  id: string;
338
389
  request?: RequestInit;
339
390
  }
340
391
  declare class ListLabelConversations {
341
392
  protected _transport: Transport;
342
393
  constructor(_transport: Transport);
343
- send({ id, request, ...options }: Options$e): Promise<ListLabelConversationsResponse>;
394
+ send({ id, request, ...options }: Options$f): Promise<ListLabelConversationsResponse>;
344
395
  }
345
396
  type ListLabelConversationsResponsePayload = {
346
397
  conversations: {
@@ -368,7 +419,7 @@ declare class ListLabelConversationsResponse {
368
419
  * @see https://greatdetail.com
369
420
  */
370
421
 
371
- interface Options$d extends SendOptions {
422
+ interface Options$e extends SendOptions {
372
423
  id: string;
373
424
  body: z.infer<typeof UpdateConversationRequest.SCHEMA>;
374
425
  request?: RequestInit;
@@ -383,7 +434,7 @@ declare class UpdateConversationRequest {
383
434
  hasEnded: boolean;
384
435
  }>;
385
436
  constructor(_transport: Transport);
386
- send({ id, body, request, ...options }: Options$d): Promise<UpdateConversationResponse>;
437
+ send({ id, body, request, ...options }: Options$e): Promise<UpdateConversationResponse>;
387
438
  }
388
439
  type UpdateConversationResponsePayload = {
389
440
  conversation: {
@@ -411,7 +462,7 @@ declare class UpdateConversationResponse {
411
462
  * @see https://greatdetail.com
412
463
  */
413
464
 
414
- interface Options$c extends SendOptions {
465
+ interface Options$d extends SendOptions {
415
466
  body: z.infer<typeof CreateLabelRequest.SCHEMA>;
416
467
  request?: RequestInit;
417
468
  }
@@ -422,18 +473,18 @@ declare class CreateLabelRequest {
422
473
  description: z.ZodOptional<z.ZodString>;
423
474
  account: z.ZodString;
424
475
  }, "strip", z.ZodTypeAny, {
425
- title: string;
426
476
  account: string;
477
+ title: string;
427
478
  description?: string | undefined;
428
479
  }, {
429
- title: string;
430
480
  account: string;
481
+ title: string;
431
482
  description?: string | undefined;
432
483
  }>;
433
484
  constructor(_transport: Transport);
434
- send({ body, request, ...options }: Options$c): Promise<CreateLabelResponse>;
485
+ send({ body, request, ...options }: Options$d): Promise<CreateLabelResponse>;
435
486
  }
436
- type CreateLabelResponsePayload$1 = {
487
+ type CreateLabelResponsePayload = {
437
488
  label: {
438
489
  id: string;
439
490
  title: string;
@@ -446,7 +497,7 @@ type CreateLabelResponsePayload$1 = {
446
497
  declare class CreateLabelResponse {
447
498
  response: Response;
448
499
  constructor(response: Response);
449
- result(): Promise<CreateLabelResponsePayload$1>;
500
+ result(): Promise<CreateLabelResponsePayload>;
450
501
  }
451
502
 
452
503
  /**
@@ -458,14 +509,14 @@ declare class CreateLabelResponse {
458
509
  * @see https://greatdetail.com
459
510
  */
460
511
 
461
- interface Options$b extends SendOptions {
512
+ interface Options$c extends SendOptions {
462
513
  id: string;
463
514
  request?: RequestInit;
464
515
  }
465
516
  declare class DeleteLabelRequest {
466
517
  protected _transport: Transport;
467
518
  constructor(_transport: Transport);
468
- send({ id, request, ...options }: Options$b): Promise<DeleteLabelResponse>;
519
+ send({ id, request, ...options }: Options$c): Promise<DeleteLabelResponse>;
469
520
  }
470
521
  type DeleteLabelResponsePayload = Record<string, never>;
471
522
  declare class DeleteLabelResponse {
@@ -483,14 +534,14 @@ declare class DeleteLabelResponse {
483
534
  * @see https://greatdetail.com
484
535
  */
485
536
 
486
- interface Options$a extends SendOptions {
537
+ interface Options$b extends SendOptions {
487
538
  id: string;
488
539
  request?: RequestInit;
489
540
  }
490
541
  declare class GetLabelRequest {
491
542
  protected _transport: Transport;
492
543
  constructor(_transport: Transport);
493
- send({ id, request, ...options }: Options$a): Promise<GetLabelResponse>;
544
+ send({ id, request, ...options }: Options$b): Promise<GetLabelResponse>;
494
545
  }
495
546
  type GetLabelResponsePayload = {
496
547
  label: {
@@ -517,13 +568,13 @@ declare class GetLabelResponse {
517
568
  * @see https://greatdetail.com
518
569
  */
519
570
 
520
- interface Options$9 extends SendOptions {
571
+ interface Options$a extends SendOptions {
521
572
  request?: RequestInit;
522
573
  }
523
574
  declare class ListLabelsRequest {
524
575
  protected _transport: Transport;
525
576
  constructor(_transport: Transport);
526
- send({ request, ...options }?: Options$9): Promise<ListLabelsResponse>;
577
+ send({ request, ...options }?: Options$a): Promise<ListLabelsResponse>;
527
578
  }
528
579
  type ListLabelsResponsePayload = {
529
580
  labels: {
@@ -550,7 +601,7 @@ declare class ListLabelsResponse {
550
601
  * @see https://greatdetail.com
551
602
  */
552
603
 
553
- interface Options$8 extends SendOptions {
604
+ interface Options$9 extends SendOptions {
554
605
  id: string;
555
606
  body: z.infer<typeof UpdateLabelRequest.SCHEMA>;
556
607
  request?: RequestInit;
@@ -568,9 +619,9 @@ declare class UpdateLabelRequest {
568
619
  description?: string | undefined;
569
620
  }>;
570
621
  constructor(_transport: Transport);
571
- send({ id, body, request, ...options }: Options$8): Promise<UpdateLabelResponse>;
622
+ send({ id, body, request, ...options }: Options$9): Promise<UpdateLabelResponse>;
572
623
  }
573
- type CreateLabelResponsePayload = {
624
+ type UpdateLabelResponsePayload = {
574
625
  label: {
575
626
  id: string;
576
627
  title: string;
@@ -583,7 +634,7 @@ type CreateLabelResponsePayload = {
583
634
  declare class UpdateLabelResponse {
584
635
  response: Response;
585
636
  constructor(response: Response);
586
- result(): Promise<CreateLabelResponsePayload>;
637
+ result(): Promise<UpdateLabelResponsePayload>;
587
638
  }
588
639
 
589
640
  /**
@@ -595,14 +646,14 @@ declare class UpdateLabelResponse {
595
646
  * @see https://greatdetail.com
596
647
  */
597
648
 
598
- interface Options$7 extends SendOptions {
649
+ interface Options$8 extends SendOptions {
599
650
  id: string;
600
651
  request?: RequestInit;
601
652
  }
602
653
  declare class ListConversationMessages {
603
654
  protected _transport: Transport;
604
655
  constructor(_transport: Transport);
605
- send({ id, request, ...options }: Options$7): Promise<ListConversationMessagesResponse>;
656
+ send({ id, request, ...options }: Options$8): Promise<ListConversationMessagesResponse>;
606
657
  }
607
658
  type ListConversationMessagesResponsePayload = {
608
659
  messages: {
@@ -638,13 +689,13 @@ declare class ListConversationMessagesResponse {
638
689
  * @see https://greatdetail.com
639
690
  */
640
691
 
641
- interface Options$6 extends SendOptions {
692
+ interface Options$7 extends SendOptions {
642
693
  request?: RequestInit;
643
694
  }
644
695
  declare class ListMessagesRequest {
645
696
  protected _transport: Transport;
646
697
  constructor(_transport: Transport);
647
- send({ request, ...options }?: Options$6): Promise<ListMessagesResponse>;
698
+ send({ request, ...options }?: Options$7): Promise<ListMessagesResponse>;
648
699
  }
649
700
  type ListMessagesResponsePayload = {
650
701
  messages: {
@@ -680,7 +731,7 @@ declare class ListMessagesResponse {
680
731
  * @see https://greatdetail.com
681
732
  */
682
733
 
683
- interface Options$5 extends SendOptions {
734
+ interface Options$6 extends SendOptions {
684
735
  id: string;
685
736
  body: z.infer<typeof CreateCorrectionModelRequest.SCHEMA>;
686
737
  request?: RequestInit;
@@ -701,7 +752,7 @@ declare class CreateCorrectionModelRequest {
701
752
  correction: string;
702
753
  }>;
703
754
  constructor(_transport: Transport);
704
- send({ id, body, request, ...options }: Options$5): Promise<CreateCorrectionModelResponse>;
755
+ send({ id, body, request, ...options }: Options$6): Promise<CreateCorrectionModelResponse>;
705
756
  }
706
757
  type CreateCorrectionResponsePayload = unknown;
707
758
  declare class CreateCorrectionModelResponse {
@@ -719,14 +770,14 @@ declare class CreateCorrectionModelResponse {
719
770
  * @see https://greatdetail.com
720
771
  */
721
772
 
722
- interface Options$4 extends SendOptions {
773
+ interface Options$5 extends SendOptions {
723
774
  id: string;
724
775
  request?: RequestInit;
725
776
  }
726
777
  declare class GetModelRequest {
727
778
  protected _transport: Transport;
728
779
  constructor(_transport: Transport);
729
- send({ id, request, ...options }: Options$4): Promise<GetModelResponse>;
780
+ send({ id, request, ...options }: Options$5): Promise<GetModelResponse>;
730
781
  }
731
782
  type GetModelResponsePayload = {
732
783
  model: {
@@ -752,13 +803,13 @@ declare class GetModelResponse {
752
803
  * @see https://greatdetail.com
753
804
  */
754
805
 
755
- interface Options$3 extends SendOptions {
806
+ interface Options$4 extends SendOptions {
756
807
  request?: RequestInit;
757
808
  }
758
809
  declare class ListModelsRequest {
759
810
  protected _transport: Transport;
760
811
  constructor(_transport: Transport);
761
- send({ request, ...options }?: Options$3): Promise<ListModelsResponse>;
812
+ send({ request, ...options }?: Options$4): Promise<ListModelsResponse>;
762
813
  }
763
814
  type ListModelsResponsePayload = {
764
815
  models: {
@@ -784,7 +835,7 @@ declare class ListModelsResponse {
784
835
  * @see https://greatdetail.com
785
836
  */
786
837
 
787
- interface Options$2 extends SendOptions {
838
+ interface Options$3 extends SendOptions {
788
839
  id: string;
789
840
  body: z.infer<typeof CreateResponseModelRequest.SCHEMA>;
790
841
  request?: RequestInit;
@@ -802,7 +853,7 @@ declare class CreateResponseModelRequest {
802
853
  content: string | null;
803
854
  }>, "many">;
804
855
  constructor(_transport: Transport);
805
- send({ id, body, request, ...options }: Options$2): Promise<CreateResponseModelResponse>;
856
+ send({ id, body, request, ...options }: Options$3): Promise<CreateResponseModelResponse>;
806
857
  }
807
858
  type CreateResponseResponsePayload = {
808
859
  message: string | null;
@@ -826,14 +877,14 @@ declare class CreateResponseModelResponse {
826
877
  * @see https://greatdetail.com
827
878
  */
828
879
 
829
- interface Options$1 extends SendOptions {
880
+ interface Options$2 extends SendOptions {
830
881
  id: string;
831
882
  request?: RequestInit;
832
883
  }
833
884
  declare class GetSourceRequest {
834
885
  protected _transport: Transport;
835
886
  constructor(_transport: Transport);
836
- send({ id, request, ...options }: Options$1): Promise<GetSourceResponse>;
887
+ send({ id, request, ...options }: Options$2): Promise<GetSourceResponse>;
837
888
  }
838
889
  type GetSourceResponsePayload = {
839
890
  source: {
@@ -860,13 +911,13 @@ declare class GetSourceResponse {
860
911
  * @see https://greatdetail.com
861
912
  */
862
913
 
863
- interface Options extends SendOptions {
914
+ interface Options$1 extends SendOptions {
864
915
  request?: RequestInit;
865
916
  }
866
917
  declare class ListSourcesRequest {
867
918
  protected _transport: Transport;
868
919
  constructor(_transport: Transport);
869
- send({ request, ...options }?: Options): Promise<ListSourcesResponse>;
920
+ send({ request, ...options }?: Options$1): Promise<ListSourcesResponse>;
870
921
  }
871
922
  type ListSourcesResponsePayload = {
872
923
  sources: {
@@ -893,13 +944,13 @@ declare class ListSourcesResponse {
893
944
  * @see https://greatdetail.com
894
945
  */
895
946
 
896
- interface ClientOptions {
947
+ interface Options {
897
948
  baseURL?: string | URL;
898
949
  }
899
950
  declare class Client {
900
951
  static DEFAULT_BASE_URL: string;
901
- transport: Transport;
902
- constructor(authentication: Authentication, { baseURL, ...options }?: ClientOptions);
952
+ _transport: Transport;
953
+ constructor(authentication: Authentication, { baseURL, ...options }?: Options);
903
954
  static getBaseURL(): string;
904
955
  get action(): {
905
956
  list: ListActionsRequest;
@@ -911,6 +962,7 @@ declare class Client {
911
962
  get: GetContactRequest;
912
963
  list: ListContactsRequest;
913
964
  update: UpdateContactRequest;
965
+ create: CreateContactRequest;
914
966
  };
915
967
  get conversation(): {
916
968
  get: GetConversationRequest;
@@ -949,4 +1001,4 @@ declare class Client {
949
1001
  };
950
1002
  }
951
1003
 
952
- export { type Authentication as A, Client as C, type GetConversationResponsePayload as G, type ListActionsResponsePayload as L, type RequestFilterable as R, type ListChannelsResponsePayload as a, type ListContactsResponsePayload as b, type ListConversationsResponsePayload as c, type CreateLabelResponsePayload$1 as d, type ListLabelsResponsePayload as e, type ListMessagesResponsePayload as f, type ListModelsResponsePayload as g, type CreateCorrectionResponsePayload as h, type CreateResponseResponsePayload as i, type ListSourcesResponsePayload as j };
1004
+ 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$o as a, type ListChannelsResponsePayload as b, type ListContactsResponsePayload as c, type CreateContactResponsePayload as d, type GetConversationResponsePayload as e, type ListConversationsResponsePayload as f, type ListLabelConversationsResponsePayload as g, type UpdateConversationResponsePayload as h, type CreateLabelResponsePayload as i, type GetLabelResponsePayload as j, type ListLabelsResponsePayload as k, type UpdateLabelResponsePayload as l, type ListConversationMessagesResponsePayload as m, type ListMessagesResponsePayload as n, type GetModelResponsePayload as o, type ListModelsResponsePayload as p, type CreateCorrectionResponsePayload as q, type CreateResponseResponsePayload as r, type GetSourceResponsePayload as s, type ListSourcesResponsePayload as t };