@great-detail/support-sdk 0.5.2 → 0.5.3

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.
@@ -1,5 +1,5 @@
1
1
  import * as ky from 'ky';
2
- import { KyInstance, Options as Options$R } from 'ky';
2
+ import { KyInstance, Options as Options$W } from 'ky';
3
3
  import { z } from 'zod';
4
4
 
5
5
  /**
@@ -29,28 +29,28 @@ interface RequestFilterable {
29
29
  * @see https://greatdetail.com
30
30
  */
31
31
 
32
- interface Options$Q {
32
+ interface Options$V {
33
33
  requestFilterables: RequestFilterable[];
34
34
  }
35
35
  interface Transport {
36
36
  getURL(url: string): string;
37
37
  }
38
38
 
39
- interface InputOptions extends Options$Q {
39
+ interface InputOptions extends Options$V {
40
40
  baseURL: string;
41
41
  }
42
- interface Options$P extends Options$Q {
42
+ interface Options$U extends Options$V {
43
43
  baseURL: string;
44
44
  }
45
45
  declare class FetchTransport implements Transport {
46
46
  client: KyInstance;
47
- options: Options$P;
47
+ options: Options$U;
48
48
  constructor({ baseURL, ...options }: InputOptions);
49
49
  getURL(url: string): string;
50
- send<T = unknown>(url: string, request: Options$R): Promise<ky.KyResponse<T>>;
50
+ send<T = unknown>(url: string, request: Options$W): Promise<ky.KyResponse<T>>;
51
51
  }
52
52
 
53
- interface Options$O {
53
+ interface Options$T {
54
54
  request?: RequestInit;
55
55
  }
56
56
  type ListActionsResponse = {
@@ -70,7 +70,7 @@ type ListActionsResponse = {
70
70
  declare class ListActions {
71
71
  protected _transport: FetchTransport;
72
72
  constructor(_transport: FetchTransport);
73
- send({ request }?: Options$O): Promise<ky.KyResponse<ListActionsResponse>>;
73
+ send({ request }?: Options$T): Promise<ky.KyResponse<ListActionsResponse>>;
74
74
  }
75
75
 
76
76
  /**
@@ -84,7 +84,7 @@ declare class ListActions {
84
84
 
85
85
  type Authentication = RequestFilterable;
86
86
 
87
- interface Options$N {
87
+ interface Options$S {
88
88
  id: string;
89
89
  body: z.infer<typeof CreateBoilerplateCategoryBoilerplate.SCHEMA>;
90
90
  request?: RequestInit;
@@ -115,10 +115,10 @@ declare class CreateBoilerplateCategoryBoilerplate {
115
115
  account: string;
116
116
  }>;
117
117
  constructor(_transport: FetchTransport);
118
- send({ id, body, request }: Options$N): Promise<ky.KyResponse<CreateBoilerplateCategoryBoilerplateResponse>>;
118
+ send({ id, body, request }: Options$S): Promise<ky.KyResponse<CreateBoilerplateCategoryBoilerplateResponse>>;
119
119
  }
120
120
 
121
- interface Options$M {
121
+ interface Options$R {
122
122
  id: string;
123
123
  request?: RequestInit;
124
124
  }
@@ -136,17 +136,17 @@ type GetBoilerplateResponse = {
136
136
  declare class GetBoilerplate {
137
137
  protected _transport: FetchTransport;
138
138
  constructor(_transport: FetchTransport);
139
- send({ id, request }: Options$M): Promise<ky.KyResponse<GetBoilerplateResponse>>;
139
+ send({ id, request }: Options$R): Promise<ky.KyResponse<GetBoilerplateResponse>>;
140
140
  }
141
141
 
142
- interface Options$L {
142
+ interface Options$Q {
143
143
  id: string;
144
144
  request?: RequestInit;
145
145
  }
146
146
  declare class ListBoilerplateCategoryBoilerplates {
147
147
  protected _transport: FetchTransport;
148
148
  constructor(_transport: FetchTransport);
149
- send({ id, request }: Options$L): Promise<ky.KyResponse<ListBoilerplateCategoryBoilerplatesResponse>>;
149
+ send({ id, request }: Options$Q): Promise<ky.KyResponse<ListBoilerplateCategoryBoilerplatesResponse>>;
150
150
  }
151
151
  type ListBoilerplateCategoryBoilerplatesResponse = {
152
152
  boilerplates: {
@@ -160,7 +160,7 @@ type ListBoilerplateCategoryBoilerplatesResponse = {
160
160
  }[];
161
161
  };
162
162
 
163
- interface Options$K {
163
+ interface Options$P {
164
164
  query?: string;
165
165
  request?: RequestInit;
166
166
  }
@@ -178,10 +178,10 @@ type ListBoilerplatesResponse = {
178
178
  declare class ListBoilerplates {
179
179
  protected _transport: FetchTransport;
180
180
  constructor(_transport: FetchTransport);
181
- send({ query, request }?: Options$K): Promise<ky.KyResponse<ListBoilerplatesResponse>>;
181
+ send({ query, request }?: Options$P): Promise<ky.KyResponse<ListBoilerplatesResponse>>;
182
182
  }
183
183
 
184
- interface Options$J {
184
+ interface Options$O {
185
185
  id: string;
186
186
  body: z.infer<typeof UpdateBoilerplate.SCHEMA>;
187
187
  request?: RequestInit;
@@ -210,10 +210,10 @@ declare class UpdateBoilerplate {
210
210
  content?: string | undefined;
211
211
  }>;
212
212
  constructor(_transport: FetchTransport);
213
- send({ id, body, request }: Options$J): Promise<ky.KyResponse<UpdateBoilerplateResponse>>;
213
+ send({ id, body, request }: Options$O): Promise<ky.KyResponse<UpdateBoilerplateResponse>>;
214
214
  }
215
215
 
216
- interface Options$I {
216
+ interface Options$N {
217
217
  body: z.infer<typeof CreateBoilerplateCategory.SCHEMA>;
218
218
  request?: RequestInit;
219
219
  }
@@ -243,10 +243,10 @@ declare class CreateBoilerplateCategory {
243
243
  description?: string | undefined;
244
244
  }>;
245
245
  constructor(_transport: FetchTransport);
246
- send({ body, request }: Options$I): Promise<ky.KyResponse<CreateBoilerplateCategoryResponse>>;
246
+ send({ body, request }: Options$N): Promise<ky.KyResponse<CreateBoilerplateCategoryResponse>>;
247
247
  }
248
248
 
249
- interface Options$H {
249
+ interface Options$M {
250
250
  id: string;
251
251
  request?: RequestInit;
252
252
  }
@@ -263,10 +263,10 @@ type GetBoilerplateCategoryResponse = {
263
263
  declare class GetBoilerplateCategory {
264
264
  protected _transport: FetchTransport;
265
265
  constructor(_transport: FetchTransport);
266
- send({ id, request }: Options$H): Promise<ky.KyResponse<GetBoilerplateCategoryResponse>>;
266
+ send({ id, request }: Options$M): Promise<ky.KyResponse<GetBoilerplateCategoryResponse>>;
267
267
  }
268
268
 
269
- interface Options$G {
269
+ interface Options$L {
270
270
  request?: RequestInit;
271
271
  }
272
272
  type ListBoilerplateCategoriesResponse = {
@@ -282,10 +282,10 @@ type ListBoilerplateCategoriesResponse = {
282
282
  declare class ListBoilerplateCategories {
283
283
  protected _transport: FetchTransport;
284
284
  constructor(_transport: FetchTransport);
285
- send({ request }?: Options$G): Promise<ky.KyResponse<ListBoilerplateCategoriesResponse>>;
285
+ send({ request }?: Options$L): Promise<ky.KyResponse<ListBoilerplateCategoriesResponse>>;
286
286
  }
287
287
 
288
- interface Options$F {
288
+ interface Options$K {
289
289
  id: string;
290
290
  body: z.infer<typeof UpdateBoilerplateCategory.SCHEMA>;
291
291
  request?: RequestInit;
@@ -313,10 +313,10 @@ declare class UpdateBoilerplateCategory {
313
313
  description?: string | undefined;
314
314
  }>;
315
315
  constructor(_transport: FetchTransport);
316
- send({ id, body, request }: Options$F): Promise<ky.KyResponse<UpdateBoilerplateCategoryResponse>>;
316
+ send({ id, body, request }: Options$K): Promise<ky.KyResponse<UpdateBoilerplateCategoryResponse>>;
317
317
  }
318
318
 
319
- interface Options$E {
319
+ interface Options$J {
320
320
  body: z.infer<typeof CreateChannel.SCHEMA>;
321
321
  request?: RequestInit;
322
322
  }
@@ -411,10 +411,10 @@ declare class CreateChannel {
411
411
  };
412
412
  }>]>>;
413
413
  constructor(_transport: FetchTransport);
414
- send({ body, request }: Options$E): Promise<ky.KyResponse<CreateChannelResponse>>;
414
+ send({ body, request }: Options$J): Promise<ky.KyResponse<CreateChannelResponse>>;
415
415
  }
416
416
 
417
- interface Options$D {
417
+ interface Options$I {
418
418
  id: string;
419
419
  request?: RequestInit;
420
420
  }
@@ -454,10 +454,10 @@ type GetChannelResponse = {
454
454
  declare class GetChannel {
455
455
  protected _transport: FetchTransport;
456
456
  constructor(_transport: FetchTransport);
457
- send({ id, request }: Options$D): Promise<ky.KyResponse<GetChannelResponse>>;
457
+ send({ id, request }: Options$I): Promise<ky.KyResponse<GetChannelResponse>>;
458
458
  }
459
459
 
460
- interface Options$C {
460
+ interface Options$H {
461
461
  request?: RequestInit;
462
462
  }
463
463
  type ListChannelsResponse = {
@@ -496,10 +496,10 @@ type ListChannelsResponse = {
496
496
  declare class ListChannels {
497
497
  protected _transport: FetchTransport;
498
498
  constructor(_transport: FetchTransport);
499
- send({ request }?: Options$C): Promise<ky.KyResponse<ListChannelsResponse>>;
499
+ send({ request }?: Options$H): Promise<ky.KyResponse<ListChannelsResponse>>;
500
500
  }
501
501
 
502
- interface Options$B {
502
+ interface Options$G {
503
503
  id: string;
504
504
  body: z.infer<typeof UpdateChannel.SCHEMA>;
505
505
  request?: RequestInit;
@@ -592,7 +592,135 @@ declare class UpdateChannel {
592
592
  };
593
593
  }>]>>;
594
594
  constructor(_transport: FetchTransport);
595
- send({ id, body, request }: Options$B): Promise<ky.KyResponse<UpdateChannelResponse>>;
595
+ send({ id, body, request }: Options$G): Promise<ky.KyResponse<UpdateChannelResponse>>;
596
+ }
597
+
598
+ interface Options$F {
599
+ body: z.infer<typeof CreateCompositionSection.SCHEMA>;
600
+ request?: RequestInit;
601
+ }
602
+ type CreateCompositionSectionResponse = {
603
+ compositionSection: {
604
+ id: string;
605
+ account: string;
606
+ channel?: string;
607
+ location: "header" | "footer";
608
+ content: string;
609
+ createdAt: string;
610
+ updatedAt: string;
611
+ };
612
+ };
613
+ declare class CreateCompositionSection {
614
+ protected _transport: FetchTransport;
615
+ static SCHEMA: z.ZodObject<{
616
+ account: z.ZodString;
617
+ channel: z.ZodOptional<z.ZodString>;
618
+ location: z.ZodEnum<["header", "footer"]>;
619
+ content: z.ZodString;
620
+ }, "strip", z.ZodTypeAny, {
621
+ content: string;
622
+ account: string;
623
+ location: "header" | "footer";
624
+ channel?: string | undefined;
625
+ }, {
626
+ content: string;
627
+ account: string;
628
+ location: "header" | "footer";
629
+ channel?: string | undefined;
630
+ }>;
631
+ constructor(_transport: FetchTransport);
632
+ send({ body, request }: Options$F): Promise<ky.KyResponse<CreateCompositionSectionResponse>>;
633
+ }
634
+
635
+ interface Options$E {
636
+ id: string;
637
+ request?: RequestInit;
638
+ }
639
+ type GetCompositionSectionResponse = {
640
+ compositionSection: {
641
+ id: string;
642
+ account: string;
643
+ channel?: string;
644
+ location: "header" | "footer";
645
+ content: string;
646
+ createdAt: string;
647
+ updatedAt: string;
648
+ };
649
+ };
650
+ declare class GetCompositionSection {
651
+ protected _transport: FetchTransport;
652
+ constructor(_transport: FetchTransport);
653
+ send({ id, request }: Options$E): Promise<ky.KyResponse<GetCompositionSectionResponse>>;
654
+ }
655
+
656
+ interface Options$D {
657
+ id: string;
658
+ request?: RequestInit;
659
+ }
660
+ type ListChannelCompositionSectionsResponse = {
661
+ compositionSections: {
662
+ id: string;
663
+ account: string;
664
+ channel?: string;
665
+ location: "header" | "footer";
666
+ content: string;
667
+ createdAt: string;
668
+ updatedAt: string;
669
+ }[];
670
+ };
671
+ declare class ListChannelCompositionSections {
672
+ protected _transport: FetchTransport;
673
+ constructor(_transport: FetchTransport);
674
+ send({ id, request }: Options$D): Promise<ky.KyResponse<ListChannelCompositionSectionsResponse>>;
675
+ }
676
+
677
+ interface Options$C {
678
+ request?: RequestInit;
679
+ }
680
+ type ListCompositionSectionsResponse = {
681
+ compositionSections: {
682
+ id: string;
683
+ account: string;
684
+ channel?: string;
685
+ location: "header" | "footer";
686
+ content: string;
687
+ createdAt: string;
688
+ updatedAt: string;
689
+ }[];
690
+ };
691
+ declare class ListCompositionSections {
692
+ protected _transport: FetchTransport;
693
+ constructor(_transport: FetchTransport);
694
+ send({ request }?: Options$C): Promise<ky.KyResponse<ListCompositionSectionsResponse>>;
695
+ }
696
+
697
+ interface Options$B {
698
+ id: string;
699
+ body: z.infer<typeof UpdateCompositionSection.SCHEMA>;
700
+ request?: RequestInit;
701
+ }
702
+ type UpdateCompositionSectionResponse = {
703
+ compositionSection: {
704
+ id: string;
705
+ account: string;
706
+ channel?: string;
707
+ location: "header" | "footer";
708
+ content: string;
709
+ createdAt: string;
710
+ updatedAt: string;
711
+ };
712
+ };
713
+ declare class UpdateCompositionSection {
714
+ protected _transport: FetchTransport;
715
+ static SCHEMA: z.ZodObject<{
716
+ content: z.ZodString;
717
+ }, "strip", z.ZodTypeAny, {
718
+ content: string;
719
+ }, {
720
+ content: string;
721
+ }>;
722
+ constructor(_transport: FetchTransport);
723
+ send({ id, body, request }: Options$B): Promise<ky.KyResponse<UpdateCompositionSectionResponse>>;
596
724
  }
597
725
 
598
726
  /**
@@ -1562,10 +1690,19 @@ declare class Client {
1562
1690
  list: ListChannels;
1563
1691
  update: UpdateChannel;
1564
1692
  create: CreateChannel;
1693
+ compositionSection: {
1694
+ list: ListChannelCompositionSections;
1695
+ };
1565
1696
  message: {
1566
1697
  list: ListChannelMessages;
1567
1698
  };
1568
1699
  };
1700
+ get compositionSection(): {
1701
+ get: GetCompositionSection;
1702
+ list: ListCompositionSections;
1703
+ create: CreateCompositionSection;
1704
+ update: UpdateCompositionSection;
1705
+ };
1569
1706
  get contact(): {
1570
1707
  get: GetContact;
1571
1708
  list: ListContacts;
@@ -1640,4 +1777,4 @@ declare class Client {
1640
1777
  get webhook(): Webhook;
1641
1778
  }
1642
1779
 
1643
- export { type DeleteUploadResponse as $, type Authentication as A, type ListConversationMessagesResponse as B, Client as C, type DeleteLabelResponse as D, type ListMessagesResponse as E, type ListChannelMessagesResponse as F, type GetBoilerplateResponse as G, type GetModelResponse as H, type ListModelsResponse as I, type CreateCorrectionResponse as J, type CreateResponseResponse as K, type ListActionsResponse as L, type CreateContactNoteResponse as M, type CreateConversationNoteResponse as N, type Options as O, type GetNoteResponse as P, type ListContactNotesResponse as Q, type RequestFilterable as R, type ListConversationNotesResponse as S, type UpdateNoteResponse as T, type UpdateBoilerplateResponse as U, type GetSourceResponse as V, type WebhookResponse as W, type ListSourcesResponse as X, type CreateContactNotificationSubscriptionResponse as Y, type CreateUploadResponse as Z, type GetUploadResponse as _, type Options$Q as a, type CreateBoilerplateCategoryBoilerplateResponse as b, type ListBoilerplateCategoryBoilerplatesResponse as c, type ListBoilerplatesResponse as d, type CreateBoilerplateCategoryResponse as e, type GetBoilerplateCategoryResponse as f, type ListBoilerplateCategoriesResponse as g, type UpdateBoilerplateCategoryResponse as h, type ListChannelsResponse as i, type GetChannelResponse as j, type UpdateChannelResponse as k, type CreateChannelResponse as l, type CreateContactResponse as m, type GetContactResponse as n, type ListContactsResponse as o, type ListLabelContactsResponse as p, type UpdateContactResponse as q, type GetConversationResponse as r, type ListConversationsResponse as s, type ListLabelConversationsResponse as t, type UpdateConversationResponse as u, type ListContactConversationsResponse as v, type CreateLabelResponse as w, type GetLabelResponse as x, type ListLabelsResponse as y, type UpdateLabelResponse as z };
1780
+ export { type GetSourceResponse as $, type Authentication as A, type ListContactConversationsResponse as B, Client as C, type CreateLabelResponse as D, type DeleteLabelResponse as E, type GetLabelResponse as F, type GetBoilerplateResponse as G, type ListLabelsResponse as H, type UpdateLabelResponse as I, type ListConversationMessagesResponse as J, type ListMessagesResponse as K, type ListActionsResponse as L, type ListChannelMessagesResponse as M, type GetModelResponse as N, type Options as O, type ListModelsResponse as P, type CreateCorrectionResponse as Q, type RequestFilterable as R, type CreateResponseResponse as S, type CreateContactNoteResponse as T, type UpdateBoilerplateResponse as U, type CreateConversationNoteResponse as V, type WebhookResponse as W, type GetNoteResponse as X, type ListContactNotesResponse as Y, type ListConversationNotesResponse as Z, type UpdateNoteResponse as _, type Options$V as a, type ListSourcesResponse as a0, type CreateContactNotificationSubscriptionResponse as a1, type CreateUploadResponse as a2, type GetUploadResponse as a3, type DeleteUploadResponse as a4, type CreateBoilerplateCategoryBoilerplateResponse as b, type ListBoilerplateCategoryBoilerplatesResponse as c, type ListBoilerplatesResponse as d, type CreateBoilerplateCategoryResponse as e, type GetBoilerplateCategoryResponse as f, type ListBoilerplateCategoriesResponse as g, type UpdateBoilerplateCategoryResponse as h, type ListChannelsResponse as i, type GetChannelResponse as j, type UpdateChannelResponse as k, type CreateChannelResponse as l, type GetCompositionSectionResponse as m, type ListCompositionSectionsResponse as n, type CreateCompositionSectionResponse as o, type ListChannelCompositionSectionsResponse as p, type UpdateCompositionSectionResponse as q, type CreateContactResponse as r, type GetContactResponse as s, type ListContactsResponse as t, type ListLabelContactsResponse as u, type UpdateContactResponse as v, type GetConversationResponse as w, type ListConversationsResponse as x, type ListLabelConversationsResponse as y, type UpdateConversationResponse as z };