-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.ts
3600 lines (3365 loc) · 138 KB
/
api.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* tslint:disable */
/* eslint-disable */
/**
* ChatKitty Platform API
* Server-Side Platform API for ChatKitty. ChatKitty is the first complete chat platform; bringing together everything that\'s required to build real-time chat into Web and mobile apps. Using JavaScript or TypeScript? [Check out our server-side SDK](https://chatkitty.github.io/chatkitty-server-side-sdk-js/) for the ChatKitty Platform API.
*
* The version of the OpenAPI document: 1.5.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { Configuration } from './configuration';
import globalAxios, { AxiosPromise, AxiosInstance } from 'axios';
// Some imports not used depending on template conditions
// @ts-ignore
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
/**
* Represents this ChatKitty application and can be used to configure the application.
* @export
* @interface Application
*/
export interface Application {
/**
* 64 bit integer identifier associated with this application
* @type {number}
* @memberof Application
*/
id: number;
/**
* The name of the ChatKitty application
* @type {string}
* @memberof Application
*/
name: string;
/**
* Unique string used as an API key for this application client-side
* @type {string}
* @memberof Application
*/
key: string;
/**
* Map of arbiturary properties belonging to this application
* @type {object}
* @memberof Application
*/
properties?: object;
/**
*
* @type {ApplicationLinks}
* @memberof Application
*/
_links?: ApplicationLinks;
}
/**
*
* @export
* @interface ApplicationLinks
*/
export interface ApplicationLinks {
/**
*
* @type {Link}
* @memberof ApplicationLinks
*/
self: Link;
/**
*
* @type {Link}
* @memberof ApplicationLinks
*/
users: Link;
/**
*
* @type {Link}
* @memberof ApplicationLinks
*/
channels: Link;
/**
*
* @type {Link}
* @memberof ApplicationLinks
*/
messages: Link;
/**
*
* @type {Link}
* @memberof ApplicationLinks
*/
findusers: Link;
/**
*
* @type {Link}
* @memberof ApplicationLinks
*/
findchannels: Link;
}
/**
* A channel within this ChatKitty application
* @export
* @interface Channel
*/
export interface Channel {
/**
* 64 bit integer identifier associated with this channel
* @type {number}
* @memberof Channel
*/
id: number;
/**
* The type of this channel
* @type {string}
* @memberof Channel
*/
type: ChannelTypeEnum;
/**
* The unique name of this channel
* @type {string}
* @memberof Channel
*/
name: string;
/**
*
* @type {Message}
* @memberof Channel
*/
lastReceivedMessage?: Message;
/**
*
* @type {User}
* @memberof Channel
*/
creator?: User;
/**
* Map of arbiturary properties belonging to this channel
* @type {object}
* @memberof Channel
*/
properties?: object;
/**
* ISO 8601 instant when this channel was created
* @type {string}
* @memberof Channel
*/
createdTime: string;
/**
*
* @type {ChannelLinks}
* @memberof Channel
*/
_links?: ChannelLinks;
}
/**
* @export
* @enum {string}
*/
export enum ChannelTypeEnum {
Direct = 'DIRECT',
Public = 'PUBLIC',
Private = 'PRIVATE'
}
/**
*
* @export
* @interface ChannelLinks
*/
export interface ChannelLinks {
/**
*
* @type {Link}
* @memberof ChannelLinks
*/
self: Link;
/**
*
* @type {Link}
* @memberof ChannelLinks
*/
messages: Link;
/**
*
* @type {Link}
* @memberof ChannelLinks
*/
members?: Link;
/**
*
* @type {Link}
* @memberof ChannelLinks
*/
application: Link;
}
/**
* A page of channels
* @export
* @interface ChannelPage
*/
export interface ChannelPage {
/**
*
* @type {ChannelPageAllOfEmbedded}
* @memberof ChannelPage
*/
_embedded: ChannelPageAllOfEmbedded;
/**
*
* @type {PagePage}
* @memberof ChannelPage
*/
page: PagePage;
/**
*
* @type {PageLinks}
* @memberof ChannelPage
*/
_links: PageLinks;
}
/**
*
* @export
* @interface ChannelPageAllOf
*/
export interface ChannelPageAllOf {
/**
*
* @type {ChannelPageAllOfEmbedded}
* @memberof ChannelPageAllOf
*/
_embedded?: ChannelPageAllOfEmbedded;
}
/**
*
* @export
* @interface ChannelPageAllOfEmbedded
*/
export interface ChannelPageAllOfEmbedded {
/**
*
* @type {Array<Channel>}
* @memberof ChannelPageAllOfEmbedded
*/
channels?: Array<Channel>;
}
/**
*
* @export
* @interface CreateChannelRequest
*/
export interface CreateChannelRequest {
/**
* The type of this channel.
* @type {string}
* @memberof CreateChannelRequest
*/
type: CreateChannelRequestTypeEnum;
/**
* Map of arbiturary properties belonging to this channel
* @type {object}
* @memberof CreateChannelRequest
*/
properties?: object;
/**
*
* @type {ResourceReference}
* @memberof CreateChannelRequest
*/
creator?: ResourceReference;
}
/**
* @export
* @enum {string}
*/
export enum CreateChannelRequestTypeEnum {
Direct = 'DIRECT',
Public = 'PUBLIC',
Private = 'PRIVATE'
}
/**
*
* @export
* @interface CreateDirectChannelRequest
*/
export interface CreateDirectChannelRequest extends CreateChannelRequest {
/**
* Resource references of the members of this direct channel. The same direct channel is always returned for the same set of members.
* @type {Array<ResourceReference>}
* @memberof CreateDirectChannelRequest
*/
members: Array<ResourceReference>;
}
/**
*
* @export
* @interface CreateExternalFileRequest
*/
export interface CreateExternalFileRequest {
/**
* External URL pointing to this file\'s content
* @type {string}
* @memberof CreateExternalFileRequest
*/
url: string;
/**
* The name of this file
* @type {string}
* @memberof CreateExternalFileRequest
*/
name: string;
/**
* MIME type of this file
* @type {string}
* @memberof CreateExternalFileRequest
*/
contentType: string;
/**
*
* @type {number}
* @memberof CreateExternalFileRequest
*/
size: number;
}
/**
*
* @export
* @interface CreateExternalFileSystemMessageRequest
*/
export interface CreateExternalFileSystemMessageRequest {
/**
* The type of message. Always FILE
* @type {string}
* @memberof CreateExternalFileSystemMessageRequest
*/
type: CreateExternalFileSystemMessageRequestTypeEnum;
/**
*
* @type {CreateExternalFileRequest}
* @memberof CreateExternalFileSystemMessageRequest
*/
file: CreateExternalFileRequest;
/**
* Tag to group file messages by (like an album name).
* @type {string}
* @memberof CreateExternalFileSystemMessageRequest
*/
groupTag?: string;
}
/**
* @export
* @enum {string}
*/
export enum CreateExternalFileSystemMessageRequestTypeEnum {
File = 'FILE'
}
/**
*
* @export
* @interface CreatePrivateChannelRequest
*/
export interface CreatePrivateChannelRequest extends CreateChannelRequest {
/**
* A unique name for the channel.
* @type {string}
* @memberof CreatePrivateChannelRequest
*/
name?: string;
}
/**
*
* @export
* @interface CreatePublicChannelRequest
*/
export interface CreatePublicChannelRequest extends CreateChannelRequest {
/**
* A unique name for the channel.
* @type {string}
* @memberof CreatePublicChannelRequest
*/
name?: string;
}
/**
*
* @export
* @interface CreateTextSystemMessageRequest
*/
export interface CreateTextSystemMessageRequest {
/**
* The type of message. Always TEXT
* @type {string}
* @memberof CreateTextSystemMessageRequest
*/
type: CreateTextSystemMessageRequestTypeEnum;
/**
* The text body of the message.
* @type {string}
* @memberof CreateTextSystemMessageRequest
*/
body: string;
}
/**
* @export
* @enum {string}
*/
export enum CreateTextSystemMessageRequestTypeEnum {
Text = 'TEXT'
}
/**
*
* @export
* @interface CreateUserRequest
*/
export interface CreateUserRequest {
/**
* Username of this user
* @type {string}
* @memberof CreateUserRequest
*/
name: string;
/**
* Human readable name of this user that will be shown to other users
* @type {string}
* @memberof CreateUserRequest
*/
displayName: string;
/**
* True if this user should be created as a guest
* @type {boolean}
* @memberof CreateUserRequest
*/
isGuest?: boolean;
}
/**
* The representation of an emoji
* @export
* @interface Emoji
*/
export interface Emoji {
/**
* The unicode character of this emoji\'s represenation
* @type {string}
* @memberof Emoji
*/
character: string;
/**
* Description of this emoji
* @type {string}
* @memberof Emoji
*/
description: string;
/**
* List of possible aliases for this emoji
* @type {Array<string>}
* @memberof Emoji
*/
aliases: Array<string>;
/**
* Tags used to describe this emoji
* @type {Array<string>}
* @memberof Emoji
*/
tags: Array<string>;
}
/**
* Represents a HAL HATEOAS link to a resource
* @export
* @interface Link
*/
export interface Link {
/**
* URI pointing to a resource representation
* @type {string}
* @memberof Link
*/
href: string;
}
/**
* A message within this ChatKitty application
* @export
* @interface Message
*/
export interface Message {
/**
* 64 bit integer identifier associated with this message. Present if this message is persistent
* @type {number}
* @memberof Message
*/
id?: number;
/**
* The type of this message
* @type {string}
* @memberof Message
*/
type: MessageTypeEnum;
/**
*
* @type {User}
* @memberof Message
*/
user?: User;
/**
* Text body of this message. Present if this is a text message
* @type {string}
* @memberof Message
*/
body?: string;
/**
*
* @type {any}
* @memberof Message
*/
file?: any;
/**
* Map of arbiturary properties belonging to this message
* @type {object}
* @memberof Message
*/
properties?: object;
/**
* ISO 8601 instant when this message was created
* @type {string}
* @memberof Message
*/
createdTime: string;
/**
*
* @type {MessageLinks}
* @memberof Message
*/
_links?: MessageLinks;
}
/**
* @export
* @enum {string}
*/
export enum MessageTypeEnum {
Text = 'TEXT',
File = 'FILE',
SystemText = 'SYSTEM_TEXT',
SystemFile = 'SYSTEM_FILE'
}
/**
*
* @export
* @interface MessageLinks
*/
export interface MessageLinks {
/**
*
* @type {Link}
* @memberof MessageLinks
*/
self: Link;
/**
*
* @type {Link}
* @memberof MessageLinks
*/
channel: Link;
/**
*
* @type {Link}
* @memberof MessageLinks
*/
user?: Link;
/**
*
* @type {Link}
* @memberof MessageLinks
*/
application: Link;
}
/**
* A page of messages
* @export
* @interface MessagePage
*/
export interface MessagePage {
/**
*
* @type {MessagePageAllOfEmbedded}
* @memberof MessagePage
*/
_embedded: MessagePageAllOfEmbedded;
/**
*
* @type {PagePage}
* @memberof MessagePage
*/
page: PagePage;
/**
*
* @type {PageLinks}
* @memberof MessagePage
*/
_links: PageLinks;
}
/**
*
* @export
* @interface MessagePageAllOf
*/
export interface MessagePageAllOf {
/**
*
* @type {MessagePageAllOfEmbedded}
* @memberof MessagePageAllOf
*/
_embedded?: MessagePageAllOfEmbedded;
}
/**
*
* @export
* @interface MessagePageAllOfEmbedded
*/
export interface MessagePageAllOfEmbedded {
/**
*
* @type {Array<Message>}
* @memberof MessagePageAllOfEmbedded
*/
messages?: Array<Message>;
}
/**
* File metadata
* @export
* @interface ModelFile
*/
export interface ModelFile {
/**
* The type of this file
* @type {string}
* @memberof ModelFile
*/
type: ModelFileTypeEnum;
/**
* URI pointing to this file\'s content
* @type {string}
* @memberof ModelFile
*/
url: string;
/**
* The name of this file
* @type {string}
* @memberof ModelFile
*/
name: string;
/**
* MIME type of this file
* @type {string}
* @memberof ModelFile
*/
contentType: string;
/**
*
* @type {number}
* @memberof ModelFile
*/
size: number;
}
/**
* @export
* @enum {string}
*/
export enum ModelFileTypeEnum {
Hosted = 'HOSTED',
External = 'EXTERNAL'
}
/**
* A notification received by a ChatKitty user. The user receiving a notification is referred to as the notification recipient.
* @export
* @interface Notification
*/
export interface Notification {
/**
* 64 bit integer identifier associated with this notification
* @type {number}
* @memberof Notification
*/
id: number;
/**
* Title of this notification briefly informing the user what occurred.
* @type {string}
* @memberof Notification
*/
title: string;
/**
* Detailed message informing the user what occurred triggering this notification.
* @type {string}
* @memberof Notification
*/
body: string;
/**
*
* @type {Channel}
* @memberof Notification
*/
channel?: Channel;
/**
*
* @type {NotificationData}
* @memberof Notification
*/
data: NotificationData;
/**
* True if this notification is muted and should not actively notify the receipient user of its related event.
* @type {boolean}
* @memberof Notification
*/
muted?: boolean;
/**
* ISO 8601 instant when this notification was created
* @type {string}
* @memberof Notification
*/
createdTime: string;
/**
* ISO 8601 instant when this notification was first read.
* @type {string}
* @memberof Notification
*/
readTime?: string;
/**
*
* @type {NotificationLinks}
* @memberof Notification
*/
_links?: NotificationLinks;
}
/**
* Additional data related to a notification.
* @export
* @interface NotificationData
*/
export interface NotificationData {
/**
* The type of notification that was received. This specifies the schema of the notification data.
* @type {string}
* @memberof NotificationData
*/
type: NotificationDataTypeEnum;
/**
* 64 bit integer identifier associated with the channel this notification is related to. Present if SYSTEM:SENT:MESSAGE, or USER:SENT:MESSAGE.
* @type {number}
* @memberof NotificationData
*/
channelId?: number;
/**
* The message this notification is related to. Present if SYSTEM:SENT:MESSAGE, or USER:SENT:MESSAGE.
* @type {Message}
* @memberof NotificationData
*/
message?: Message;
}
/**
* @export
* @enum {string}
*/
export enum NotificationDataTypeEnum {
Systemsentmessage = 'SYSTEM:SENT:MESSAGE',
Usersentmessage = 'USER:SENT:MESSAGE'
}
/**
*
* @export
* @interface NotificationLinks
*/
export interface NotificationLinks {
/**
*
* @type {Link}
* @memberof NotificationLinks
*/
self: Link;
/**
*
* @type {Link}
* @memberof NotificationLinks
*/
recipient: Link;
}
/**
* A page of resources
* @export
* @interface Page
*/
export interface Page {
/**
*
* @type {PagePage}
* @memberof Page
*/
page: PagePage;
/**
*
* @type {PageLinks}
* @memberof Page
*/
_links: PageLinks;
}
/**
*
* @export
* @interface PageLinks
*/
export interface PageLinks {
/**
*
* @type {Link}
* @memberof PageLinks
*/
self: Link;
/**
*
* @type {Link}
* @memberof PageLinks
*/
first?: Link;
/**
*
* @type {Link}
* @memberof PageLinks
*/
prev?: Link;
/**
*
* @type {Link}
* @memberof PageLinks
*/
next?: Link;
/**
*
* @type {Link}
* @memberof PageLinks
*/
last?: Link;
}
/**
*
* @export
* @interface PagePage
*/
export interface PagePage {
/**
*
* @type {number}
* @memberof PagePage
*/
size: number;
/**
*
* @type {number}
* @memberof PagePage
*/
number?: number;
/**
*
* @type {number}
* @memberof PagePage
*/
totalElements?: number;
/**
*
* @type {number}
* @memberof PagePage
*/
totalPages?: number;
}
/**
* A message reaction
* @export
* @interface Reaction
*/
export interface Reaction {
/**
*
* @type {User}
* @memberof Reaction
*/
user: User;
/**
*
* @type {Emoji}
* @memberof Reaction
*/
emoji: Emoji;
/**
* ISO 8601 instant when this reaction was created
* @type {string}
* @memberof Reaction
*/
createdTime: string;
/**
*
* @type {ReactionLinks}
* @memberof Reaction
*/
_links?: ReactionLinks;
}
/**
*
* @export
* @interface ReactionLinks
*/
export interface ReactionLinks {
/**
*
* @type {Link}
* @memberof ReactionLinks
*/
self: Link;
/**
*
* @type {Link}
* @memberof ReactionLinks
*/
user: Link;
/**
*
* @type {Link}
* @memberof ReactionLinks
*/
message: Link;
/**
*
* @type {Link}
* @memberof ReactionLinks
*/
application: Link;
}
/**
* represents a message thread inside a channel
* @export
* @interface ReplyThread
*/
export interface ReplyThread {
/**
* 64 bit integer identifier associated with this reply thread
* @type {number}
* @memberof ReplyThread
*/
id: number;
/**
* The type of this thread
* @type {string}
* @memberof ReplyThread
*/
type: ReplyThreadTypeEnum;
/**
*
* @type {ReplyThreadLinks}
* @memberof ReplyThread
*/
_links?: ReplyThreadLinks;
}
/**
* @export
* @enum {string}
*/
export enum ReplyThreadTypeEnum {
Main = 'MAIN',
Child = 'CHILD'
}
/**
*
* @export
* @interface ReplyThreadLinks
*/
export interface ReplyThreadLinks {
/**
*
* @type {Link}
* @memberof ReplyThreadLinks
*/
self: Link;
/**