@appwrite.io/console 0.0.1 → 0.0.2-preview-0.0

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.
@@ -0,0 +1,2548 @@
1
+ export declare namespace Models {
2
+ /**
3
+ * Documents List
4
+ */
5
+ type DocumentList<Document extends Models.Document> = {
6
+ /**
7
+ * Total number of documents documents that matched your query.
8
+ */
9
+ total: number;
10
+ /**
11
+ * List of documents.
12
+ */
13
+ documents: Document[];
14
+ };
15
+ /**
16
+ * Collections List
17
+ */
18
+ type CollectionList = {
19
+ /**
20
+ * Total number of collections documents that matched your query.
21
+ */
22
+ total: number;
23
+ /**
24
+ * List of collections.
25
+ */
26
+ collections: Collection[];
27
+ };
28
+ /**
29
+ * Databases List
30
+ */
31
+ type DatabaseList = {
32
+ /**
33
+ * Total number of databases documents that matched your query.
34
+ */
35
+ total: number;
36
+ /**
37
+ * List of databases.
38
+ */
39
+ databases: Database[];
40
+ };
41
+ /**
42
+ * Indexes List
43
+ */
44
+ type IndexList = {
45
+ /**
46
+ * Total number of indexes documents that matched your query.
47
+ */
48
+ total: number;
49
+ /**
50
+ * List of indexes.
51
+ */
52
+ indexes: Index[];
53
+ };
54
+ /**
55
+ * Users List
56
+ */
57
+ type UserList<Preferences extends Models.Preferences> = {
58
+ /**
59
+ * Total number of users documents that matched your query.
60
+ */
61
+ total: number;
62
+ /**
63
+ * List of users.
64
+ */
65
+ users: User<Preferences>[];
66
+ };
67
+ /**
68
+ * Sessions List
69
+ */
70
+ type SessionList = {
71
+ /**
72
+ * Total number of sessions documents that matched your query.
73
+ */
74
+ total: number;
75
+ /**
76
+ * List of sessions.
77
+ */
78
+ sessions: Session[];
79
+ };
80
+ /**
81
+ * Logs List
82
+ */
83
+ type LogList = {
84
+ /**
85
+ * Total number of logs documents that matched your query.
86
+ */
87
+ total: number;
88
+ /**
89
+ * List of logs.
90
+ */
91
+ logs: Log[];
92
+ };
93
+ /**
94
+ * Files List
95
+ */
96
+ type FileList = {
97
+ /**
98
+ * Total number of files documents that matched your query.
99
+ */
100
+ total: number;
101
+ /**
102
+ * List of files.
103
+ */
104
+ files: File[];
105
+ };
106
+ /**
107
+ * Buckets List
108
+ */
109
+ type BucketList = {
110
+ /**
111
+ * Total number of buckets documents that matched your query.
112
+ */
113
+ total: number;
114
+ /**
115
+ * List of buckets.
116
+ */
117
+ buckets: Bucket[];
118
+ };
119
+ /**
120
+ * Teams List
121
+ */
122
+ type TeamList = {
123
+ /**
124
+ * Total number of teams documents that matched your query.
125
+ */
126
+ total: number;
127
+ /**
128
+ * List of teams.
129
+ */
130
+ teams: Team[];
131
+ };
132
+ /**
133
+ * Memberships List
134
+ */
135
+ type MembershipList = {
136
+ /**
137
+ * Total number of memberships documents that matched your query.
138
+ */
139
+ total: number;
140
+ /**
141
+ * List of memberships.
142
+ */
143
+ memberships: Membership[];
144
+ };
145
+ /**
146
+ * Functions List
147
+ */
148
+ type FunctionList = {
149
+ /**
150
+ * Total number of functions documents that matched your query.
151
+ */
152
+ total: number;
153
+ /**
154
+ * List of functions.
155
+ */
156
+ functions: Function[];
157
+ };
158
+ /**
159
+ * Runtimes List
160
+ */
161
+ type RuntimeList = {
162
+ /**
163
+ * Total number of runtimes documents that matched your query.
164
+ */
165
+ total: number;
166
+ /**
167
+ * List of runtimes.
168
+ */
169
+ runtimes: Runtime[];
170
+ };
171
+ /**
172
+ * Deployments List
173
+ */
174
+ type DeploymentList = {
175
+ /**
176
+ * Total number of deployments documents that matched your query.
177
+ */
178
+ total: number;
179
+ /**
180
+ * List of deployments.
181
+ */
182
+ deployments: Deployment[];
183
+ };
184
+ /**
185
+ * Executions List
186
+ */
187
+ type ExecutionList = {
188
+ /**
189
+ * Total number of executions documents that matched your query.
190
+ */
191
+ total: number;
192
+ /**
193
+ * List of executions.
194
+ */
195
+ executions: Execution[];
196
+ };
197
+ /**
198
+ * Projects List
199
+ */
200
+ type ProjectList = {
201
+ /**
202
+ * Total number of projects documents that matched your query.
203
+ */
204
+ total: number;
205
+ /**
206
+ * List of projects.
207
+ */
208
+ projects: Project[];
209
+ };
210
+ /**
211
+ * Webhooks List
212
+ */
213
+ type WebhookList = {
214
+ /**
215
+ * Total number of webhooks documents that matched your query.
216
+ */
217
+ total: number;
218
+ /**
219
+ * List of webhooks.
220
+ */
221
+ webhooks: Webhook[];
222
+ };
223
+ /**
224
+ * API Keys List
225
+ */
226
+ type KeyList = {
227
+ /**
228
+ * Total number of keys documents that matched your query.
229
+ */
230
+ total: number;
231
+ /**
232
+ * List of keys.
233
+ */
234
+ keys: Key[];
235
+ };
236
+ /**
237
+ * Platforms List
238
+ */
239
+ type PlatformList = {
240
+ /**
241
+ * Total number of platforms documents that matched your query.
242
+ */
243
+ total: number;
244
+ /**
245
+ * List of platforms.
246
+ */
247
+ platforms: Platform[];
248
+ };
249
+ /**
250
+ * Domains List
251
+ */
252
+ type DomainList = {
253
+ /**
254
+ * Total number of domains documents that matched your query.
255
+ */
256
+ total: number;
257
+ /**
258
+ * List of domains.
259
+ */
260
+ domains: Domain[];
261
+ };
262
+ /**
263
+ * Countries List
264
+ */
265
+ type CountryList = {
266
+ /**
267
+ * Total number of countries documents that matched your query.
268
+ */
269
+ total: number;
270
+ /**
271
+ * List of countries.
272
+ */
273
+ countries: Country[];
274
+ };
275
+ /**
276
+ * Continents List
277
+ */
278
+ type ContinentList = {
279
+ /**
280
+ * Total number of continents documents that matched your query.
281
+ */
282
+ total: number;
283
+ /**
284
+ * List of continents.
285
+ */
286
+ continents: Continent[];
287
+ };
288
+ /**
289
+ * Languages List
290
+ */
291
+ type LanguageList = {
292
+ /**
293
+ * Total number of languages documents that matched your query.
294
+ */
295
+ total: number;
296
+ /**
297
+ * List of languages.
298
+ */
299
+ languages: Language[];
300
+ };
301
+ /**
302
+ * Currencies List
303
+ */
304
+ type CurrencyList = {
305
+ /**
306
+ * Total number of currencies documents that matched your query.
307
+ */
308
+ total: number;
309
+ /**
310
+ * List of currencies.
311
+ */
312
+ currencies: Currency[];
313
+ };
314
+ /**
315
+ * Phones List
316
+ */
317
+ type PhoneList = {
318
+ /**
319
+ * Total number of phones documents that matched your query.
320
+ */
321
+ total: number;
322
+ /**
323
+ * List of phones.
324
+ */
325
+ phones: Phone[];
326
+ };
327
+ /**
328
+ * Variables List
329
+ */
330
+ type VariableList = {
331
+ /**
332
+ * Total number of variables documents that matched your query.
333
+ */
334
+ total: number;
335
+ /**
336
+ * List of variables.
337
+ */
338
+ variables: Variable[];
339
+ };
340
+ /**
341
+ * Database
342
+ */
343
+ type Database = {
344
+ /**
345
+ * Database ID.
346
+ */
347
+ $id: string;
348
+ /**
349
+ * Database name.
350
+ */
351
+ name: string;
352
+ /**
353
+ * Database creation date in ISO 8601 format.
354
+ */
355
+ $createdAt: string;
356
+ /**
357
+ * Database update date in ISO 8601 format.
358
+ */
359
+ $updatedAt: string;
360
+ };
361
+ /**
362
+ * Collection
363
+ */
364
+ type Collection = {
365
+ /**
366
+ * Collection ID.
367
+ */
368
+ $id: string;
369
+ /**
370
+ * Collection creation date in ISO 8601 format.
371
+ */
372
+ $createdAt: string;
373
+ /**
374
+ * Collection update date in ISO 8601 format.
375
+ */
376
+ $updatedAt: string;
377
+ /**
378
+ * Collection permissions. [Learn more about permissions](/docs/permissions).
379
+ */
380
+ $permissions: string[];
381
+ /**
382
+ * Database ID.
383
+ */
384
+ databaseId: string;
385
+ /**
386
+ * Collection name.
387
+ */
388
+ name: string;
389
+ /**
390
+ * Collection enabled.
391
+ */
392
+ enabled: boolean;
393
+ /**
394
+ * Whether document-level permissions are enabled. [Learn more about permissions](/docs/permissions).
395
+ */
396
+ documentSecurity: boolean;
397
+ /**
398
+ * Collection attributes.
399
+ */
400
+ attributes: string[];
401
+ /**
402
+ * Collection indexes.
403
+ */
404
+ indexes: Index[];
405
+ };
406
+ /**
407
+ * Attributes List
408
+ */
409
+ type AttributeList = {
410
+ /**
411
+ * Total number of attributes in the given collection.
412
+ */
413
+ total: number;
414
+ /**
415
+ * List of attributes.
416
+ */
417
+ attributes: string[];
418
+ };
419
+ /**
420
+ * AttributeString
421
+ */
422
+ type AttributeString = {
423
+ /**
424
+ * Attribute Key.
425
+ */
426
+ key: string;
427
+ /**
428
+ * Attribute type.
429
+ */
430
+ type: string;
431
+ /**
432
+ * Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
433
+ */
434
+ status: string;
435
+ /**
436
+ * Is attribute required?
437
+ */
438
+ required: boolean;
439
+ /**
440
+ * Is attribute an array?
441
+ */
442
+ array?: boolean;
443
+ /**
444
+ * Attribute size.
445
+ */
446
+ size: number;
447
+ /**
448
+ * Default value for attribute when not provided. Cannot be set when attribute is required.
449
+ */
450
+ default?: string;
451
+ };
452
+ /**
453
+ * AttributeInteger
454
+ */
455
+ type AttributeInteger = {
456
+ /**
457
+ * Attribute Key.
458
+ */
459
+ key: string;
460
+ /**
461
+ * Attribute type.
462
+ */
463
+ type: string;
464
+ /**
465
+ * Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
466
+ */
467
+ status: string;
468
+ /**
469
+ * Is attribute required?
470
+ */
471
+ required: boolean;
472
+ /**
473
+ * Is attribute an array?
474
+ */
475
+ array?: boolean;
476
+ /**
477
+ * Minimum value to enforce for new documents.
478
+ */
479
+ min?: number;
480
+ /**
481
+ * Maximum value to enforce for new documents.
482
+ */
483
+ max?: number;
484
+ /**
485
+ * Default value for attribute when not provided. Cannot be set when attribute is required.
486
+ */
487
+ default?: number;
488
+ };
489
+ /**
490
+ * AttributeFloat
491
+ */
492
+ type AttributeFloat = {
493
+ /**
494
+ * Attribute Key.
495
+ */
496
+ key: string;
497
+ /**
498
+ * Attribute type.
499
+ */
500
+ type: string;
501
+ /**
502
+ * Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
503
+ */
504
+ status: string;
505
+ /**
506
+ * Is attribute required?
507
+ */
508
+ required: boolean;
509
+ /**
510
+ * Is attribute an array?
511
+ */
512
+ array?: boolean;
513
+ /**
514
+ * Minimum value to enforce for new documents.
515
+ */
516
+ min?: number;
517
+ /**
518
+ * Maximum value to enforce for new documents.
519
+ */
520
+ max?: number;
521
+ /**
522
+ * Default value for attribute when not provided. Cannot be set when attribute is required.
523
+ */
524
+ default?: number;
525
+ };
526
+ /**
527
+ * AttributeBoolean
528
+ */
529
+ type AttributeBoolean = {
530
+ /**
531
+ * Attribute Key.
532
+ */
533
+ key: string;
534
+ /**
535
+ * Attribute type.
536
+ */
537
+ type: string;
538
+ /**
539
+ * Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
540
+ */
541
+ status: string;
542
+ /**
543
+ * Is attribute required?
544
+ */
545
+ required: boolean;
546
+ /**
547
+ * Is attribute an array?
548
+ */
549
+ array?: boolean;
550
+ /**
551
+ * Default value for attribute when not provided. Cannot be set when attribute is required.
552
+ */
553
+ default?: boolean;
554
+ };
555
+ /**
556
+ * AttributeEmail
557
+ */
558
+ type AttributeEmail = {
559
+ /**
560
+ * Attribute Key.
561
+ */
562
+ key: string;
563
+ /**
564
+ * Attribute type.
565
+ */
566
+ type: string;
567
+ /**
568
+ * Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
569
+ */
570
+ status: string;
571
+ /**
572
+ * Is attribute required?
573
+ */
574
+ required: boolean;
575
+ /**
576
+ * Is attribute an array?
577
+ */
578
+ array?: boolean;
579
+ /**
580
+ * String format.
581
+ */
582
+ format: string;
583
+ /**
584
+ * Default value for attribute when not provided. Cannot be set when attribute is required.
585
+ */
586
+ default?: string;
587
+ };
588
+ /**
589
+ * AttributeEnum
590
+ */
591
+ type AttributeEnum = {
592
+ /**
593
+ * Attribute Key.
594
+ */
595
+ key: string;
596
+ /**
597
+ * Attribute type.
598
+ */
599
+ type: string;
600
+ /**
601
+ * Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
602
+ */
603
+ status: string;
604
+ /**
605
+ * Is attribute required?
606
+ */
607
+ required: boolean;
608
+ /**
609
+ * Is attribute an array?
610
+ */
611
+ array?: boolean;
612
+ /**
613
+ * Array of elements in enumerated type.
614
+ */
615
+ elements: string[];
616
+ /**
617
+ * String format.
618
+ */
619
+ format: string;
620
+ /**
621
+ * Default value for attribute when not provided. Cannot be set when attribute is required.
622
+ */
623
+ default?: string;
624
+ };
625
+ /**
626
+ * AttributeIP
627
+ */
628
+ type AttributeIp = {
629
+ /**
630
+ * Attribute Key.
631
+ */
632
+ key: string;
633
+ /**
634
+ * Attribute type.
635
+ */
636
+ type: string;
637
+ /**
638
+ * Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
639
+ */
640
+ status: string;
641
+ /**
642
+ * Is attribute required?
643
+ */
644
+ required: boolean;
645
+ /**
646
+ * Is attribute an array?
647
+ */
648
+ array?: boolean;
649
+ /**
650
+ * String format.
651
+ */
652
+ format: string;
653
+ /**
654
+ * Default value for attribute when not provided. Cannot be set when attribute is required.
655
+ */
656
+ default?: string;
657
+ };
658
+ /**
659
+ * AttributeURL
660
+ */
661
+ type AttributeUrl = {
662
+ /**
663
+ * Attribute Key.
664
+ */
665
+ key: string;
666
+ /**
667
+ * Attribute type.
668
+ */
669
+ type: string;
670
+ /**
671
+ * Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
672
+ */
673
+ status: string;
674
+ /**
675
+ * Is attribute required?
676
+ */
677
+ required: boolean;
678
+ /**
679
+ * Is attribute an array?
680
+ */
681
+ array?: boolean;
682
+ /**
683
+ * String format.
684
+ */
685
+ format: string;
686
+ /**
687
+ * Default value for attribute when not provided. Cannot be set when attribute is required.
688
+ */
689
+ default?: string;
690
+ };
691
+ /**
692
+ * AttributeDatetime
693
+ */
694
+ type AttributeDatetime = {
695
+ /**
696
+ * Attribute Key.
697
+ */
698
+ key: string;
699
+ /**
700
+ * Attribute type.
701
+ */
702
+ type: string;
703
+ /**
704
+ * Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
705
+ */
706
+ status: string;
707
+ /**
708
+ * Is attribute required?
709
+ */
710
+ required: boolean;
711
+ /**
712
+ * Is attribute an array?
713
+ */
714
+ array?: boolean;
715
+ /**
716
+ * ISO 8601 format.
717
+ */
718
+ format: string;
719
+ /**
720
+ * Default value for attribute when not provided. Only null is optional
721
+ */
722
+ default?: string;
723
+ };
724
+ /**
725
+ * Index
726
+ */
727
+ type Index = {
728
+ /**
729
+ * Index Key.
730
+ */
731
+ key: string;
732
+ /**
733
+ * Index type.
734
+ */
735
+ type: string;
736
+ /**
737
+ * Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
738
+ */
739
+ status: string;
740
+ /**
741
+ * Index attributes.
742
+ */
743
+ attributes: string[];
744
+ /**
745
+ * Index orders.
746
+ */
747
+ orders?: string[];
748
+ };
749
+ /**
750
+ * Document
751
+ */
752
+ type Document = {
753
+ /**
754
+ * Document ID.
755
+ */
756
+ $id: string;
757
+ /**
758
+ * Collection ID.
759
+ */
760
+ $collectionId: string;
761
+ /**
762
+ * Database ID.
763
+ */
764
+ $databaseId: string;
765
+ /**
766
+ * Document creation date in ISO 8601 format.
767
+ */
768
+ $createdAt: string;
769
+ /**
770
+ * Document update date in ISO 8601 format.
771
+ */
772
+ $updatedAt: string;
773
+ /**
774
+ * Document permissions. [Learn more about permissions](/docs/permissions).
775
+ */
776
+ $permissions: string[];
777
+ [key: string]: any;
778
+ };
779
+ /**
780
+ * Log
781
+ */
782
+ type Log = {
783
+ /**
784
+ * Event name.
785
+ */
786
+ event: string;
787
+ /**
788
+ * User ID.
789
+ */
790
+ userId: string;
791
+ /**
792
+ * User Email.
793
+ */
794
+ userEmail: string;
795
+ /**
796
+ * User Name.
797
+ */
798
+ userName: string;
799
+ /**
800
+ * API mode when event triggered.
801
+ */
802
+ mode: string;
803
+ /**
804
+ * IP session in use when the session was created.
805
+ */
806
+ ip: string;
807
+ /**
808
+ * Log creation date in ISO 8601 format.
809
+ */
810
+ time: string;
811
+ /**
812
+ * Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json).
813
+ */
814
+ osCode: string;
815
+ /**
816
+ * Operating system name.
817
+ */
818
+ osName: string;
819
+ /**
820
+ * Operating system version.
821
+ */
822
+ osVersion: string;
823
+ /**
824
+ * Client type.
825
+ */
826
+ clientType: string;
827
+ /**
828
+ * Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json).
829
+ */
830
+ clientCode: string;
831
+ /**
832
+ * Client name.
833
+ */
834
+ clientName: string;
835
+ /**
836
+ * Client version.
837
+ */
838
+ clientVersion: string;
839
+ /**
840
+ * Client engine name.
841
+ */
842
+ clientEngine: string;
843
+ /**
844
+ * Client engine name.
845
+ */
846
+ clientEngineVersion: string;
847
+ /**
848
+ * Device name.
849
+ */
850
+ deviceName: string;
851
+ /**
852
+ * Device brand name.
853
+ */
854
+ deviceBrand: string;
855
+ /**
856
+ * Device model name.
857
+ */
858
+ deviceModel: string;
859
+ /**
860
+ * Country two-character ISO 3166-1 alpha code.
861
+ */
862
+ countryCode: string;
863
+ /**
864
+ * Country name.
865
+ */
866
+ countryName: string;
867
+ };
868
+ /**
869
+ * User
870
+ */
871
+ type User<Preferences extends Models.Preferences> = {
872
+ /**
873
+ * User ID.
874
+ */
875
+ $id: string;
876
+ /**
877
+ * User creation date in ISO 8601 format.
878
+ */
879
+ $createdAt: string;
880
+ /**
881
+ * User update date in ISO 8601 format.
882
+ */
883
+ $updatedAt: string;
884
+ /**
885
+ * User name.
886
+ */
887
+ name: string;
888
+ /**
889
+ * Hashed user password.
890
+ */
891
+ password: string;
892
+ /**
893
+ * Password hashing algorithm.
894
+ */
895
+ hash: string;
896
+ /**
897
+ * Password hashing algorithm configuration.
898
+ */
899
+ hashOptions: object;
900
+ /**
901
+ * User registration date in ISO 8601 format.
902
+ */
903
+ registration: string;
904
+ /**
905
+ * User status. Pass `true` for enabled and `false` for disabled.
906
+ */
907
+ status: boolean;
908
+ /**
909
+ * Password update time in ISO 8601 format.
910
+ */
911
+ passwordUpdate: string;
912
+ /**
913
+ * User email address.
914
+ */
915
+ email: string;
916
+ /**
917
+ * User phone number in E.164 format.
918
+ */
919
+ phone: string;
920
+ /**
921
+ * Email verification status.
922
+ */
923
+ emailVerification: boolean;
924
+ /**
925
+ * Phone verification status.
926
+ */
927
+ phoneVerification: boolean;
928
+ /**
929
+ * User preferences as a key-value object
930
+ */
931
+ prefs: Preferences;
932
+ };
933
+ /**
934
+ * AlgoMD5
935
+ */
936
+ type AlgoMd5 = {
937
+ /**
938
+ * Algo type.
939
+ */
940
+ type: string;
941
+ };
942
+ /**
943
+ * AlgoSHA
944
+ */
945
+ type AlgoSha = {
946
+ /**
947
+ * Algo type.
948
+ */
949
+ type: string;
950
+ };
951
+ /**
952
+ * AlgoPHPass
953
+ */
954
+ type AlgoPhpass = {
955
+ /**
956
+ * Algo type.
957
+ */
958
+ type: string;
959
+ };
960
+ /**
961
+ * AlgoBcrypt
962
+ */
963
+ type AlgoBcrypt = {
964
+ /**
965
+ * Algo type.
966
+ */
967
+ type: string;
968
+ };
969
+ /**
970
+ * AlgoScrypt
971
+ */
972
+ type AlgoScrypt = {
973
+ /**
974
+ * Algo type.
975
+ */
976
+ type: string;
977
+ /**
978
+ * CPU complexity of computed hash.
979
+ */
980
+ costCpu: number;
981
+ /**
982
+ * Memory complexity of computed hash.
983
+ */
984
+ costMemory: number;
985
+ /**
986
+ * Parallelization of computed hash.
987
+ */
988
+ costParallel: number;
989
+ /**
990
+ * Length used to compute hash.
991
+ */
992
+ length: number;
993
+ };
994
+ /**
995
+ * AlgoScryptModified
996
+ */
997
+ type AlgoScryptModified = {
998
+ /**
999
+ * Algo type.
1000
+ */
1001
+ type: string;
1002
+ /**
1003
+ * Salt used to compute hash.
1004
+ */
1005
+ salt: string;
1006
+ /**
1007
+ * Separator used to compute hash.
1008
+ */
1009
+ saltSeparator: string;
1010
+ /**
1011
+ * Key used to compute hash.
1012
+ */
1013
+ signerKey: string;
1014
+ };
1015
+ /**
1016
+ * AlgoArgon2
1017
+ */
1018
+ type AlgoArgon2 = {
1019
+ /**
1020
+ * Algo type.
1021
+ */
1022
+ type: string;
1023
+ /**
1024
+ * Memory used to compute hash.
1025
+ */
1026
+ memoryCost: number;
1027
+ /**
1028
+ * Amount of time consumed to compute hash
1029
+ */
1030
+ timeCost: number;
1031
+ /**
1032
+ * Number of threads used to compute hash.
1033
+ */
1034
+ threads: number;
1035
+ };
1036
+ /**
1037
+ * Account
1038
+ */
1039
+ type Account<Preferences extends Models.Preferences> = {
1040
+ /**
1041
+ * User ID.
1042
+ */
1043
+ $id: string;
1044
+ /**
1045
+ * User creation date in ISO 8601 format.
1046
+ */
1047
+ $createdAt: string;
1048
+ /**
1049
+ * User update date in ISO 8601 format.
1050
+ */
1051
+ $updatedAt: string;
1052
+ /**
1053
+ * User name.
1054
+ */
1055
+ name: string;
1056
+ /**
1057
+ * User registration date in ISO 8601 format.
1058
+ */
1059
+ registration: string;
1060
+ /**
1061
+ * User status. Pass `true` for enabled and `false` for disabled.
1062
+ */
1063
+ status: boolean;
1064
+ /**
1065
+ * Password update time in ISO 8601 format.
1066
+ */
1067
+ passwordUpdate: string;
1068
+ /**
1069
+ * User email address.
1070
+ */
1071
+ email: string;
1072
+ /**
1073
+ * User phone number in E.164 format.
1074
+ */
1075
+ phone: string;
1076
+ /**
1077
+ * Email verification status.
1078
+ */
1079
+ emailVerification: boolean;
1080
+ /**
1081
+ * Phone verification status.
1082
+ */
1083
+ phoneVerification: boolean;
1084
+ /**
1085
+ * User preferences as a key-value object
1086
+ */
1087
+ prefs: Preferences;
1088
+ };
1089
+ /**
1090
+ * Preferences
1091
+ */
1092
+ type Preferences = {
1093
+ [key: string]: any;
1094
+ };
1095
+ /**
1096
+ * Session
1097
+ */
1098
+ type Session = {
1099
+ /**
1100
+ * Session ID.
1101
+ */
1102
+ $id: string;
1103
+ /**
1104
+ * Session creation date in ISO 8601 format.
1105
+ */
1106
+ $createdAt: string;
1107
+ /**
1108
+ * User ID.
1109
+ */
1110
+ userId: string;
1111
+ /**
1112
+ * Session expiration date in ISO 8601 format.
1113
+ */
1114
+ expire: string;
1115
+ /**
1116
+ * Session Provider.
1117
+ */
1118
+ provider: string;
1119
+ /**
1120
+ * Session Provider User ID.
1121
+ */
1122
+ providerUid: string;
1123
+ /**
1124
+ * Session Provider Access Token.
1125
+ */
1126
+ providerAccessToken: string;
1127
+ /**
1128
+ * The date of when the access token expires in ISO 8601 format.
1129
+ */
1130
+ providerAccessTokenExpiry: string;
1131
+ /**
1132
+ * Session Provider Refresh Token.
1133
+ */
1134
+ providerRefreshToken: string;
1135
+ /**
1136
+ * IP in use when the session was created.
1137
+ */
1138
+ ip: string;
1139
+ /**
1140
+ * Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json).
1141
+ */
1142
+ osCode: string;
1143
+ /**
1144
+ * Operating system name.
1145
+ */
1146
+ osName: string;
1147
+ /**
1148
+ * Operating system version.
1149
+ */
1150
+ osVersion: string;
1151
+ /**
1152
+ * Client type.
1153
+ */
1154
+ clientType: string;
1155
+ /**
1156
+ * Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json).
1157
+ */
1158
+ clientCode: string;
1159
+ /**
1160
+ * Client name.
1161
+ */
1162
+ clientName: string;
1163
+ /**
1164
+ * Client version.
1165
+ */
1166
+ clientVersion: string;
1167
+ /**
1168
+ * Client engine name.
1169
+ */
1170
+ clientEngine: string;
1171
+ /**
1172
+ * Client engine name.
1173
+ */
1174
+ clientEngineVersion: string;
1175
+ /**
1176
+ * Device name.
1177
+ */
1178
+ deviceName: string;
1179
+ /**
1180
+ * Device brand name.
1181
+ */
1182
+ deviceBrand: string;
1183
+ /**
1184
+ * Device model name.
1185
+ */
1186
+ deviceModel: string;
1187
+ /**
1188
+ * Country two-character ISO 3166-1 alpha code.
1189
+ */
1190
+ countryCode: string;
1191
+ /**
1192
+ * Country name.
1193
+ */
1194
+ countryName: string;
1195
+ /**
1196
+ * Returns true if this the current user session.
1197
+ */
1198
+ current: boolean;
1199
+ };
1200
+ /**
1201
+ * Token
1202
+ */
1203
+ type Token = {
1204
+ /**
1205
+ * Token ID.
1206
+ */
1207
+ $id: string;
1208
+ /**
1209
+ * Token creation date in ISO 8601 format.
1210
+ */
1211
+ $createdAt: string;
1212
+ /**
1213
+ * User ID.
1214
+ */
1215
+ userId: string;
1216
+ /**
1217
+ * Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.
1218
+ */
1219
+ secret: string;
1220
+ /**
1221
+ * Token expiration date in ISO 8601 format.
1222
+ */
1223
+ expire: string;
1224
+ };
1225
+ /**
1226
+ * JWT
1227
+ */
1228
+ type Jwt = {
1229
+ /**
1230
+ * JWT encoded string.
1231
+ */
1232
+ jwt: string;
1233
+ };
1234
+ /**
1235
+ * Locale
1236
+ */
1237
+ type Locale = {
1238
+ /**
1239
+ * User IP address.
1240
+ */
1241
+ ip: string;
1242
+ /**
1243
+ * Country code in [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) two-character format
1244
+ */
1245
+ countryCode: string;
1246
+ /**
1247
+ * Country name. This field support localization.
1248
+ */
1249
+ country: string;
1250
+ /**
1251
+ * Continent code. A two character continent code &quot;AF&quot; for Africa, &quot;AN&quot; for Antarctica, &quot;AS&quot; for Asia, &quot;EU&quot; for Europe, &quot;NA&quot; for North America, &quot;OC&quot; for Oceania, and &quot;SA&quot; for South America.
1252
+ */
1253
+ continentCode: string;
1254
+ /**
1255
+ * Continent name. This field support localization.
1256
+ */
1257
+ continent: string;
1258
+ /**
1259
+ * True if country is part of the European Union.
1260
+ */
1261
+ eu: boolean;
1262
+ /**
1263
+ * Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format
1264
+ */
1265
+ currency: string;
1266
+ };
1267
+ /**
1268
+ * File
1269
+ */
1270
+ type File = {
1271
+ /**
1272
+ * File ID.
1273
+ */
1274
+ $id: string;
1275
+ /**
1276
+ * Bucket ID.
1277
+ */
1278
+ bucketId: string;
1279
+ /**
1280
+ * File creation date in ISO 8601 format.
1281
+ */
1282
+ $createdAt: string;
1283
+ /**
1284
+ * File update date in ISO 8601 format.
1285
+ */
1286
+ $updatedAt: string;
1287
+ /**
1288
+ * File permissions. [Learn more about permissions](/docs/permissions).
1289
+ */
1290
+ $permissions: string[];
1291
+ /**
1292
+ * File name.
1293
+ */
1294
+ name: string;
1295
+ /**
1296
+ * File MD5 signature.
1297
+ */
1298
+ signature: string;
1299
+ /**
1300
+ * File mime type.
1301
+ */
1302
+ mimeType: string;
1303
+ /**
1304
+ * File original size in bytes.
1305
+ */
1306
+ sizeOriginal: number;
1307
+ /**
1308
+ * Total number of chunks available
1309
+ */
1310
+ chunksTotal: number;
1311
+ /**
1312
+ * Total number of chunks uploaded
1313
+ */
1314
+ chunksUploaded: number;
1315
+ };
1316
+ /**
1317
+ * Bucket
1318
+ */
1319
+ type Bucket = {
1320
+ /**
1321
+ * Bucket ID.
1322
+ */
1323
+ $id: string;
1324
+ /**
1325
+ * Bucket creation time in ISO 8601 format.
1326
+ */
1327
+ $createdAt: string;
1328
+ /**
1329
+ * Bucket update date in ISO 8601 format.
1330
+ */
1331
+ $updatedAt: string;
1332
+ /**
1333
+ * Bucket permissions. [Learn more about permissions](/docs/permissions).
1334
+ */
1335
+ $permissions: string[];
1336
+ /**
1337
+ * Whether file-level security is enabled. [Learn more about permissions](/docs/permissions).
1338
+ */
1339
+ fileSecurity: boolean;
1340
+ /**
1341
+ * Bucket name.
1342
+ */
1343
+ name: string;
1344
+ /**
1345
+ * Bucket enabled.
1346
+ */
1347
+ enabled: boolean;
1348
+ /**
1349
+ * Maximum file size supported.
1350
+ */
1351
+ maximumFileSize: number;
1352
+ /**
1353
+ * Allowed file extensions.
1354
+ */
1355
+ allowedFileExtensions: string[];
1356
+ /**
1357
+ * Compression algorithm choosen for compression. Will be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd).
1358
+ */
1359
+ compression: string;
1360
+ /**
1361
+ * Bucket is encrypted.
1362
+ */
1363
+ encryption: boolean;
1364
+ /**
1365
+ * Virus scanning is enabled.
1366
+ */
1367
+ antivirus: boolean;
1368
+ };
1369
+ /**
1370
+ * Team
1371
+ */
1372
+ type Team = {
1373
+ /**
1374
+ * Team ID.
1375
+ */
1376
+ $id: string;
1377
+ /**
1378
+ * Team creation date in ISO 8601 format.
1379
+ */
1380
+ $createdAt: string;
1381
+ /**
1382
+ * Team update date in ISO 8601 format.
1383
+ */
1384
+ $updatedAt: string;
1385
+ /**
1386
+ * Team name.
1387
+ */
1388
+ name: string;
1389
+ /**
1390
+ * Total number of team members.
1391
+ */
1392
+ total: number;
1393
+ };
1394
+ /**
1395
+ * Membership
1396
+ */
1397
+ type Membership = {
1398
+ /**
1399
+ * Membership ID.
1400
+ */
1401
+ $id: string;
1402
+ /**
1403
+ * Membership creation date in ISO 8601 format.
1404
+ */
1405
+ $createdAt: string;
1406
+ /**
1407
+ * Membership update date in ISO 8601 format.
1408
+ */
1409
+ $updatedAt: string;
1410
+ /**
1411
+ * User ID.
1412
+ */
1413
+ userId: string;
1414
+ /**
1415
+ * User name.
1416
+ */
1417
+ userName: string;
1418
+ /**
1419
+ * User email address.
1420
+ */
1421
+ userEmail: string;
1422
+ /**
1423
+ * Team ID.
1424
+ */
1425
+ teamId: string;
1426
+ /**
1427
+ * Team name.
1428
+ */
1429
+ teamName: string;
1430
+ /**
1431
+ * Date, the user has been invited to join the team in ISO 8601 format.
1432
+ */
1433
+ invited: string;
1434
+ /**
1435
+ * Date, the user has accepted the invitation to join the team in ISO 8601 format.
1436
+ */
1437
+ joined: string;
1438
+ /**
1439
+ * User confirmation status, true if the user has joined the team or false otherwise.
1440
+ */
1441
+ confirm: boolean;
1442
+ /**
1443
+ * User list of roles
1444
+ */
1445
+ roles: string[];
1446
+ };
1447
+ /**
1448
+ * Function
1449
+ */
1450
+ type Function = {
1451
+ /**
1452
+ * Function ID.
1453
+ */
1454
+ $id: string;
1455
+ /**
1456
+ * Function creation date in ISO 8601 format.
1457
+ */
1458
+ $createdAt: string;
1459
+ /**
1460
+ * Function update date in ISO 8601 format.
1461
+ */
1462
+ $updatedAt: string;
1463
+ /**
1464
+ * Execution permissions.
1465
+ */
1466
+ execute: string[];
1467
+ /**
1468
+ * Function name.
1469
+ */
1470
+ name: string;
1471
+ /**
1472
+ * Function enabled.
1473
+ */
1474
+ enabled: boolean;
1475
+ /**
1476
+ * Function execution runtime.
1477
+ */
1478
+ runtime: string;
1479
+ /**
1480
+ * Function&#039;s active deployment ID.
1481
+ */
1482
+ deployment: string;
1483
+ /**
1484
+ * Function variables.
1485
+ */
1486
+ vars: Variable[];
1487
+ /**
1488
+ * Function trigger events.
1489
+ */
1490
+ events: string[];
1491
+ /**
1492
+ * Function execution schedult in CRON format.
1493
+ */
1494
+ schedule: string;
1495
+ /**
1496
+ * Function&#039;s next scheduled execution time in ISO 8601 format.
1497
+ */
1498
+ scheduleNext: string;
1499
+ /**
1500
+ * Function&#039;s previous scheduled execution time in ISO 8601 format.
1501
+ */
1502
+ schedulePrevious: string;
1503
+ /**
1504
+ * Function execution timeout in seconds.
1505
+ */
1506
+ timeout: number;
1507
+ };
1508
+ /**
1509
+ * Runtime
1510
+ */
1511
+ type Runtime = {
1512
+ /**
1513
+ * Runtime ID.
1514
+ */
1515
+ $id: string;
1516
+ /**
1517
+ * Runtime Name.
1518
+ */
1519
+ name: string;
1520
+ /**
1521
+ * Runtime version.
1522
+ */
1523
+ version: string;
1524
+ /**
1525
+ * Base Docker image used to build the runtime.
1526
+ */
1527
+ base: string;
1528
+ /**
1529
+ * Image name of Docker Hub.
1530
+ */
1531
+ image: string;
1532
+ /**
1533
+ * Name of the logo image.
1534
+ */
1535
+ logo: string;
1536
+ /**
1537
+ * List of supported architectures.
1538
+ */
1539
+ supports: string[];
1540
+ };
1541
+ /**
1542
+ * Deployment
1543
+ */
1544
+ type Deployment = {
1545
+ /**
1546
+ * Deployment ID.
1547
+ */
1548
+ $id: string;
1549
+ /**
1550
+ * Deployment creation date in ISO 8601 format.
1551
+ */
1552
+ $createdAt: string;
1553
+ /**
1554
+ * Deployment update date in ISO 8601 format.
1555
+ */
1556
+ $updatedAt: string;
1557
+ /**
1558
+ * Resource ID.
1559
+ */
1560
+ resourceId: string;
1561
+ /**
1562
+ * Resource type.
1563
+ */
1564
+ resourceType: string;
1565
+ /**
1566
+ * The entrypoint file to use to execute the deployment code.
1567
+ */
1568
+ entrypoint: string;
1569
+ /**
1570
+ * The code size in bytes.
1571
+ */
1572
+ size: number;
1573
+ /**
1574
+ * The current build ID.
1575
+ */
1576
+ buildId: string;
1577
+ /**
1578
+ * Whether the deployment should be automatically activated.
1579
+ */
1580
+ activate: boolean;
1581
+ /**
1582
+ * The deployment status. Possible values are &quot;processing&quot;, &quot;building&quot;, &quot;pending&quot;, &quot;ready&quot;, and &quot;failed&quot;.
1583
+ */
1584
+ status: string;
1585
+ /**
1586
+ * The build stdout.
1587
+ */
1588
+ buildStdout: string;
1589
+ /**
1590
+ * The build stderr.
1591
+ */
1592
+ buildStderr: string;
1593
+ /**
1594
+ * The current build time in seconds.
1595
+ */
1596
+ buildTime: number;
1597
+ };
1598
+ /**
1599
+ * Execution
1600
+ */
1601
+ type Execution = {
1602
+ /**
1603
+ * Execution ID.
1604
+ */
1605
+ $id: string;
1606
+ /**
1607
+ * Execution creation date in ISO 8601 format.
1608
+ */
1609
+ $createdAt: string;
1610
+ /**
1611
+ * Execution upate date in ISO 8601 format.
1612
+ */
1613
+ $updatedAt: string;
1614
+ /**
1615
+ * Execution roles.
1616
+ */
1617
+ $permissions: string[];
1618
+ /**
1619
+ * Function ID.
1620
+ */
1621
+ functionId: string;
1622
+ /**
1623
+ * The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.
1624
+ */
1625
+ trigger: string;
1626
+ /**
1627
+ * The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`.
1628
+ */
1629
+ status: string;
1630
+ /**
1631
+ * The script status code.
1632
+ */
1633
+ statusCode: number;
1634
+ /**
1635
+ * The script response output string. Logs the last 4,000 characters of the execution response output.
1636
+ */
1637
+ response: string;
1638
+ /**
1639
+ * The script stdout output string. Logs the last 4,000 characters of the execution stdout output. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.
1640
+ */
1641
+ stdout: string;
1642
+ /**
1643
+ * The script stderr output string. Logs the last 4,000 characters of the execution stderr output. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.
1644
+ */
1645
+ stderr: string;
1646
+ /**
1647
+ * The script execution duration in seconds.
1648
+ */
1649
+ duration: number;
1650
+ };
1651
+ /**
1652
+ * Project
1653
+ */
1654
+ type Project = {
1655
+ /**
1656
+ * Project ID.
1657
+ */
1658
+ $id: string;
1659
+ /**
1660
+ * Project creation date in ISO 8601 format.
1661
+ */
1662
+ $createdAt: string;
1663
+ /**
1664
+ * Project update date in ISO 8601 format.
1665
+ */
1666
+ $updatedAt: string;
1667
+ /**
1668
+ * Project name.
1669
+ */
1670
+ name: string;
1671
+ /**
1672
+ * Project description.
1673
+ */
1674
+ description: string;
1675
+ /**
1676
+ * Project team ID.
1677
+ */
1678
+ teamId: string;
1679
+ /**
1680
+ * Project logo file ID.
1681
+ */
1682
+ logo: string;
1683
+ /**
1684
+ * Project website URL.
1685
+ */
1686
+ url: string;
1687
+ /**
1688
+ * Company legal name.
1689
+ */
1690
+ legalName: string;
1691
+ /**
1692
+ * Country code in [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) two-character format.
1693
+ */
1694
+ legalCountry: string;
1695
+ /**
1696
+ * State name.
1697
+ */
1698
+ legalState: string;
1699
+ /**
1700
+ * City name.
1701
+ */
1702
+ legalCity: string;
1703
+ /**
1704
+ * Company Address.
1705
+ */
1706
+ legalAddress: string;
1707
+ /**
1708
+ * Company Tax ID.
1709
+ */
1710
+ legalTaxId: string;
1711
+ /**
1712
+ * Session duration in seconds.
1713
+ */
1714
+ authDuration: number;
1715
+ /**
1716
+ * Max users allowed. 0 is unlimited.
1717
+ */
1718
+ authLimit: number;
1719
+ /**
1720
+ * Max sessions allowed per user. 100 maximum.
1721
+ */
1722
+ authSessionsLimit: number;
1723
+ /**
1724
+ * Max allowed passwords in the history list per user. Max passwords limit allowed in history is 20. Use 0 for disabling password history.
1725
+ */
1726
+ authPasswordHistory: number;
1727
+ /**
1728
+ * Whether or not to check user&#039;s password against most commonly used passwords.
1729
+ */
1730
+ authPasswordDictionary: boolean;
1731
+ /**
1732
+ * List of Providers.
1733
+ */
1734
+ providers: Provider[];
1735
+ /**
1736
+ * List of Platforms.
1737
+ */
1738
+ platforms: Platform[];
1739
+ /**
1740
+ * List of Webhooks.
1741
+ */
1742
+ webhooks: Webhook[];
1743
+ /**
1744
+ * List of API Keys.
1745
+ */
1746
+ keys: Key[];
1747
+ /**
1748
+ * List of Domains.
1749
+ */
1750
+ domains: Domain[];
1751
+ /**
1752
+ * Email/Password auth method status
1753
+ */
1754
+ authEmailPassword: boolean;
1755
+ /**
1756
+ * Magic URL auth method status
1757
+ */
1758
+ authUsersAuthMagicURL: boolean;
1759
+ /**
1760
+ * Anonymous auth method status
1761
+ */
1762
+ authAnonymous: boolean;
1763
+ /**
1764
+ * Invites auth method status
1765
+ */
1766
+ authInvites: boolean;
1767
+ /**
1768
+ * JWT auth method status
1769
+ */
1770
+ authJWT: boolean;
1771
+ /**
1772
+ * Phone auth method status
1773
+ */
1774
+ authPhone: boolean;
1775
+ /**
1776
+ * Account service status
1777
+ */
1778
+ serviceStatusForAccount: boolean;
1779
+ /**
1780
+ * Avatars service status
1781
+ */
1782
+ serviceStatusForAvatars: boolean;
1783
+ /**
1784
+ * Databases service status
1785
+ */
1786
+ serviceStatusForDatabases: boolean;
1787
+ /**
1788
+ * Locale service status
1789
+ */
1790
+ serviceStatusForLocale: boolean;
1791
+ /**
1792
+ * Health service status
1793
+ */
1794
+ serviceStatusForHealth: boolean;
1795
+ /**
1796
+ * Storage service status
1797
+ */
1798
+ serviceStatusForStorage: boolean;
1799
+ /**
1800
+ * Teams service status
1801
+ */
1802
+ serviceStatusForTeams: boolean;
1803
+ /**
1804
+ * Users service status
1805
+ */
1806
+ serviceStatusForUsers: boolean;
1807
+ /**
1808
+ * Functions service status
1809
+ */
1810
+ serviceStatusForFunctions: boolean;
1811
+ /**
1812
+ * GraphQL service status
1813
+ */
1814
+ serviceStatusForGraphql: boolean;
1815
+ };
1816
+ /**
1817
+ * Webhook
1818
+ */
1819
+ type Webhook = {
1820
+ /**
1821
+ * Webhook ID.
1822
+ */
1823
+ $id: string;
1824
+ /**
1825
+ * Webhook creation date in ISO 8601 format.
1826
+ */
1827
+ $createdAt: string;
1828
+ /**
1829
+ * Webhook update date in ISO 8601 format.
1830
+ */
1831
+ $updatedAt: string;
1832
+ /**
1833
+ * Webhook name.
1834
+ */
1835
+ name: string;
1836
+ /**
1837
+ * Webhook URL endpoint.
1838
+ */
1839
+ url: string;
1840
+ /**
1841
+ * Webhook trigger events.
1842
+ */
1843
+ events: string[];
1844
+ /**
1845
+ * Indicated if SSL / TLS Certificate verification is enabled.
1846
+ */
1847
+ security: boolean;
1848
+ /**
1849
+ * HTTP basic authentication username.
1850
+ */
1851
+ httpUser: string;
1852
+ /**
1853
+ * HTTP basic authentication password.
1854
+ */
1855
+ httpPass: string;
1856
+ /**
1857
+ * Signature key which can be used to validated incoming
1858
+ */
1859
+ signatureKey: string;
1860
+ };
1861
+ /**
1862
+ * Key
1863
+ */
1864
+ type Key = {
1865
+ /**
1866
+ * Key ID.
1867
+ */
1868
+ $id: string;
1869
+ /**
1870
+ * Key creation date in ISO 8601 format.
1871
+ */
1872
+ $createdAt: string;
1873
+ /**
1874
+ * Key update date in ISO 8601 format.
1875
+ */
1876
+ $updatedAt: string;
1877
+ /**
1878
+ * Key name.
1879
+ */
1880
+ name: string;
1881
+ /**
1882
+ * Key expiration date in ISO 8601 format.
1883
+ */
1884
+ expire: string;
1885
+ /**
1886
+ * Allowed permission scopes.
1887
+ */
1888
+ scopes: string[];
1889
+ /**
1890
+ * Secret key.
1891
+ */
1892
+ secret: string;
1893
+ /**
1894
+ * Most recent access date in ISO 8601 format.
1895
+ */
1896
+ accessedAt: string;
1897
+ /**
1898
+ * List of SDK user agents that used this key.
1899
+ */
1900
+ sdks: string[];
1901
+ };
1902
+ /**
1903
+ * Domain
1904
+ */
1905
+ type Domain = {
1906
+ /**
1907
+ * Domain ID.
1908
+ */
1909
+ $id: string;
1910
+ /**
1911
+ * Domain creation date in ISO 8601 format.
1912
+ */
1913
+ $createdAt: string;
1914
+ /**
1915
+ * Domain update date in ISO 8601 format.
1916
+ */
1917
+ $updatedAt: string;
1918
+ /**
1919
+ * Domain name.
1920
+ */
1921
+ domain: string;
1922
+ /**
1923
+ * Registerable domain name.
1924
+ */
1925
+ registerable: string;
1926
+ /**
1927
+ * TLD name.
1928
+ */
1929
+ tld: string;
1930
+ /**
1931
+ * Verification process status.
1932
+ */
1933
+ verification: boolean;
1934
+ /**
1935
+ * Certificate ID.
1936
+ */
1937
+ certificateId: string;
1938
+ };
1939
+ /**
1940
+ * Provider
1941
+ */
1942
+ type Provider = {
1943
+ /**
1944
+ * Provider name.
1945
+ */
1946
+ name: string;
1947
+ /**
1948
+ * OAuth 2.0 application ID.
1949
+ */
1950
+ appId: string;
1951
+ /**
1952
+ * OAuth 2.0 application secret. Might be JSON string if provider requires extra configuration.
1953
+ */
1954
+ secret: string;
1955
+ /**
1956
+ * Provider is active and can be used to create session.
1957
+ */
1958
+ enabled: boolean;
1959
+ };
1960
+ /**
1961
+ * Platform
1962
+ */
1963
+ type Platform = {
1964
+ /**
1965
+ * Platform ID.
1966
+ */
1967
+ $id: string;
1968
+ /**
1969
+ * Platform creation date in ISO 8601 format.
1970
+ */
1971
+ $createdAt: string;
1972
+ /**
1973
+ * Platform update date in ISO 8601 format.
1974
+ */
1975
+ $updatedAt: string;
1976
+ /**
1977
+ * Platform name.
1978
+ */
1979
+ name: string;
1980
+ /**
1981
+ * Platform type. Possible values are: web, flutter-web, flutter-ios, flutter-android, ios, android, and unity.
1982
+ */
1983
+ type: string;
1984
+ /**
1985
+ * Platform Key. iOS bundle ID or Android package name. Empty string for other platforms.
1986
+ */
1987
+ key: string;
1988
+ /**
1989
+ * App store or Google Play store ID.
1990
+ */
1991
+ store: string;
1992
+ /**
1993
+ * Web app hostname. Empty string for other platforms.
1994
+ */
1995
+ hostname: string;
1996
+ /**
1997
+ * HTTP basic authentication username.
1998
+ */
1999
+ httpUser: string;
2000
+ /**
2001
+ * HTTP basic authentication password.
2002
+ */
2003
+ httpPass: string;
2004
+ };
2005
+ /**
2006
+ * Variable
2007
+ */
2008
+ type Variable = {
2009
+ /**
2010
+ * Variable ID.
2011
+ */
2012
+ $id: string;
2013
+ /**
2014
+ * Variable creation date in ISO 8601 format.
2015
+ */
2016
+ $createdAt: string;
2017
+ /**
2018
+ * Variable creation date in ISO 8601 format.
2019
+ */
2020
+ $updatedAt: string;
2021
+ /**
2022
+ * Variable key.
2023
+ */
2024
+ key: string;
2025
+ /**
2026
+ * Variable value.
2027
+ */
2028
+ value: string;
2029
+ /**
2030
+ * Function ID.
2031
+ */
2032
+ functionId: string;
2033
+ };
2034
+ /**
2035
+ * Country
2036
+ */
2037
+ type Country = {
2038
+ /**
2039
+ * Country name.
2040
+ */
2041
+ name: string;
2042
+ /**
2043
+ * Country two-character ISO 3166-1 alpha code.
2044
+ */
2045
+ code: string;
2046
+ };
2047
+ /**
2048
+ * Continent
2049
+ */
2050
+ type Continent = {
2051
+ /**
2052
+ * Continent name.
2053
+ */
2054
+ name: string;
2055
+ /**
2056
+ * Continent two letter code.
2057
+ */
2058
+ code: string;
2059
+ };
2060
+ /**
2061
+ * Language
2062
+ */
2063
+ type Language = {
2064
+ /**
2065
+ * Language name.
2066
+ */
2067
+ name: string;
2068
+ /**
2069
+ * Language two-character ISO 639-1 codes.
2070
+ */
2071
+ code: string;
2072
+ /**
2073
+ * Language native name.
2074
+ */
2075
+ nativeName: string;
2076
+ };
2077
+ /**
2078
+ * Currency
2079
+ */
2080
+ type Currency = {
2081
+ /**
2082
+ * Currency symbol.
2083
+ */
2084
+ symbol: string;
2085
+ /**
2086
+ * Currency name.
2087
+ */
2088
+ name: string;
2089
+ /**
2090
+ * Currency native symbol.
2091
+ */
2092
+ symbolNative: string;
2093
+ /**
2094
+ * Number of decimal digits.
2095
+ */
2096
+ decimalDigits: number;
2097
+ /**
2098
+ * Currency digit rounding.
2099
+ */
2100
+ rounding: number;
2101
+ /**
2102
+ * Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format.
2103
+ */
2104
+ code: string;
2105
+ /**
2106
+ * Currency plural name
2107
+ */
2108
+ namePlural: string;
2109
+ };
2110
+ /**
2111
+ * Phone
2112
+ */
2113
+ type Phone = {
2114
+ /**
2115
+ * Phone code.
2116
+ */
2117
+ code: string;
2118
+ /**
2119
+ * Country two-character ISO 3166-1 alpha code.
2120
+ */
2121
+ countryCode: string;
2122
+ /**
2123
+ * Country name.
2124
+ */
2125
+ countryName: string;
2126
+ };
2127
+ /**
2128
+ * Health Antivirus
2129
+ */
2130
+ type HealthAntivirus = {
2131
+ /**
2132
+ * Antivirus version.
2133
+ */
2134
+ version: string;
2135
+ /**
2136
+ * Antivirus status. Possible values can are: `disabled`, `offline`, `online`
2137
+ */
2138
+ status: string;
2139
+ };
2140
+ /**
2141
+ * Health Queue
2142
+ */
2143
+ type HealthQueue = {
2144
+ /**
2145
+ * Amount of actions in the queue.
2146
+ */
2147
+ size: number;
2148
+ };
2149
+ /**
2150
+ * Health Status
2151
+ */
2152
+ type HealthStatus = {
2153
+ /**
2154
+ * Duration in milliseconds how long the health check took.
2155
+ */
2156
+ ping: number;
2157
+ /**
2158
+ * Service status. Possible values can are: `pass`, `fail`
2159
+ */
2160
+ status: string;
2161
+ };
2162
+ /**
2163
+ * Health Time
2164
+ */
2165
+ type HealthTime = {
2166
+ /**
2167
+ * Current unix timestamp on trustful remote server.
2168
+ */
2169
+ remoteTime: number;
2170
+ /**
2171
+ * Current unix timestamp of local server where Appwrite runs.
2172
+ */
2173
+ localTime: number;
2174
+ /**
2175
+ * Difference of unix remote and local timestamps in milliseconds.
2176
+ */
2177
+ diff: number;
2178
+ };
2179
+ /**
2180
+ * Metric
2181
+ */
2182
+ type Metric = {
2183
+ /**
2184
+ * The value of this metric at the timestamp.
2185
+ */
2186
+ value: number;
2187
+ /**
2188
+ * The date at which this metric was aggregated in ISO 8601 format.
2189
+ */
2190
+ date: string;
2191
+ };
2192
+ /**
2193
+ * UsageDatabases
2194
+ */
2195
+ type UsageDatabases = {
2196
+ /**
2197
+ * The time range of the usage stats.
2198
+ */
2199
+ range: string;
2200
+ /**
2201
+ * Aggregated stats for total number of documents.
2202
+ */
2203
+ databasesCount: Metric[];
2204
+ /**
2205
+ * Aggregated stats for total number of documents.
2206
+ */
2207
+ documentsCount: Metric[];
2208
+ /**
2209
+ * Aggregated stats for total number of collections.
2210
+ */
2211
+ collectionsCount: Metric[];
2212
+ /**
2213
+ * Aggregated stats for documents created.
2214
+ */
2215
+ databasesCreate: Metric[];
2216
+ /**
2217
+ * Aggregated stats for documents read.
2218
+ */
2219
+ databasesRead: Metric[];
2220
+ /**
2221
+ * Aggregated stats for documents updated.
2222
+ */
2223
+ databasesUpdate: Metric[];
2224
+ /**
2225
+ * Aggregated stats for total number of collections.
2226
+ */
2227
+ databasesDelete: Metric[];
2228
+ /**
2229
+ * Aggregated stats for documents created.
2230
+ */
2231
+ documentsCreate: Metric[];
2232
+ /**
2233
+ * Aggregated stats for documents read.
2234
+ */
2235
+ documentsRead: Metric[];
2236
+ /**
2237
+ * Aggregated stats for documents updated.
2238
+ */
2239
+ documentsUpdate: Metric[];
2240
+ /**
2241
+ * Aggregated stats for documents deleted.
2242
+ */
2243
+ documentsDelete: Metric[];
2244
+ /**
2245
+ * Aggregated stats for collections created.
2246
+ */
2247
+ collectionsCreate: Metric[];
2248
+ /**
2249
+ * Aggregated stats for collections read.
2250
+ */
2251
+ collectionsRead: Metric[];
2252
+ /**
2253
+ * Aggregated stats for collections updated.
2254
+ */
2255
+ collectionsUpdate: Metric[];
2256
+ /**
2257
+ * Aggregated stats for collections delete.
2258
+ */
2259
+ collectionsDelete: Metric[];
2260
+ };
2261
+ /**
2262
+ * UsageDatabase
2263
+ */
2264
+ type UsageDatabase = {
2265
+ /**
2266
+ * The time range of the usage stats.
2267
+ */
2268
+ range: string;
2269
+ /**
2270
+ * Aggregated stats for total number of documents.
2271
+ */
2272
+ documentsCount: Metric[];
2273
+ /**
2274
+ * Aggregated stats for total number of collections.
2275
+ */
2276
+ collectionsCount: Metric[];
2277
+ /**
2278
+ * Aggregated stats for documents created.
2279
+ */
2280
+ documentsCreate: Metric[];
2281
+ /**
2282
+ * Aggregated stats for documents read.
2283
+ */
2284
+ documentsRead: Metric[];
2285
+ /**
2286
+ * Aggregated stats for documents updated.
2287
+ */
2288
+ documentsUpdate: Metric[];
2289
+ /**
2290
+ * Aggregated stats for documents deleted.
2291
+ */
2292
+ documentsDelete: Metric[];
2293
+ /**
2294
+ * Aggregated stats for collections created.
2295
+ */
2296
+ collectionsCreate: Metric[];
2297
+ /**
2298
+ * Aggregated stats for collections read.
2299
+ */
2300
+ collectionsRead: Metric[];
2301
+ /**
2302
+ * Aggregated stats for collections updated.
2303
+ */
2304
+ collectionsUpdate: Metric[];
2305
+ /**
2306
+ * Aggregated stats for collections delete.
2307
+ */
2308
+ collectionsDelete: Metric[];
2309
+ };
2310
+ /**
2311
+ * UsageCollection
2312
+ */
2313
+ type UsageCollection = {
2314
+ /**
2315
+ * The time range of the usage stats.
2316
+ */
2317
+ range: string;
2318
+ /**
2319
+ * Aggregated stats for total number of documents.
2320
+ */
2321
+ documentsCount: Metric[];
2322
+ /**
2323
+ * Aggregated stats for documents created.
2324
+ */
2325
+ documentsCreate: Metric[];
2326
+ /**
2327
+ * Aggregated stats for documents read.
2328
+ */
2329
+ documentsRead: Metric[];
2330
+ /**
2331
+ * Aggregated stats for documents updated.
2332
+ */
2333
+ documentsUpdate: Metric[];
2334
+ /**
2335
+ * Aggregated stats for documents deleted.
2336
+ */
2337
+ documentsDelete: Metric[];
2338
+ };
2339
+ /**
2340
+ * UsageUsers
2341
+ */
2342
+ type UsageUsers = {
2343
+ /**
2344
+ * The time range of the usage stats.
2345
+ */
2346
+ range: string;
2347
+ /**
2348
+ * Aggregated stats for total number of users.
2349
+ */
2350
+ usersCount: Metric[];
2351
+ /**
2352
+ * Aggregated stats for users created.
2353
+ */
2354
+ usersCreate: Metric[];
2355
+ /**
2356
+ * Aggregated stats for users read.
2357
+ */
2358
+ usersRead: Metric[];
2359
+ /**
2360
+ * Aggregated stats for users updated.
2361
+ */
2362
+ usersUpdate: Metric[];
2363
+ /**
2364
+ * Aggregated stats for users deleted.
2365
+ */
2366
+ usersDelete: Metric[];
2367
+ /**
2368
+ * Aggregated stats for sessions created.
2369
+ */
2370
+ sessionsCreate: Metric[];
2371
+ /**
2372
+ * Aggregated stats for sessions created for a provider ( email, anonymous or oauth2 ).
2373
+ */
2374
+ sessionsProviderCreate: Metric[];
2375
+ /**
2376
+ * Aggregated stats for sessions deleted.
2377
+ */
2378
+ sessionsDelete: Metric[];
2379
+ };
2380
+ /**
2381
+ * StorageUsage
2382
+ */
2383
+ type UsageStorage = {
2384
+ /**
2385
+ * The time range of the usage stats.
2386
+ */
2387
+ range: string;
2388
+ /**
2389
+ * Aggregated stats for the occupied storage size (in bytes).
2390
+ */
2391
+ storage: Metric[];
2392
+ /**
2393
+ * Aggregated stats for total number of files.
2394
+ */
2395
+ filesCount: Metric[];
2396
+ /**
2397
+ * Aggregated stats for total number of buckets.
2398
+ */
2399
+ bucketsCount: Metric[];
2400
+ /**
2401
+ * Aggregated stats for buckets created.
2402
+ */
2403
+ bucketsCreate: Metric[];
2404
+ /**
2405
+ * Aggregated stats for buckets read.
2406
+ */
2407
+ bucketsRead: Metric[];
2408
+ /**
2409
+ * Aggregated stats for buckets updated.
2410
+ */
2411
+ bucketsUpdate: Metric[];
2412
+ /**
2413
+ * Aggregated stats for buckets deleted.
2414
+ */
2415
+ bucketsDelete: Metric[];
2416
+ /**
2417
+ * Aggregated stats for files created.
2418
+ */
2419
+ filesCreate: Metric[];
2420
+ /**
2421
+ * Aggregated stats for files read.
2422
+ */
2423
+ filesRead: Metric[];
2424
+ /**
2425
+ * Aggregated stats for files updated.
2426
+ */
2427
+ filesUpdate: Metric[];
2428
+ /**
2429
+ * Aggregated stats for files deleted.
2430
+ */
2431
+ filesDelete: Metric[];
2432
+ };
2433
+ /**
2434
+ * UsageBuckets
2435
+ */
2436
+ type UsageBuckets = {
2437
+ /**
2438
+ * The time range of the usage stats.
2439
+ */
2440
+ range: string;
2441
+ /**
2442
+ * Aggregated stats for total number of files in this bucket.
2443
+ */
2444
+ filesCount: Metric[];
2445
+ /**
2446
+ * Aggregated stats for total storage of files in this bucket.
2447
+ */
2448
+ filesStorage: Metric[];
2449
+ /**
2450
+ * Aggregated stats for files created.
2451
+ */
2452
+ filesCreate: Metric[];
2453
+ /**
2454
+ * Aggregated stats for files read.
2455
+ */
2456
+ filesRead: Metric[];
2457
+ /**
2458
+ * Aggregated stats for files updated.
2459
+ */
2460
+ filesUpdate: Metric[];
2461
+ /**
2462
+ * Aggregated stats for files deleted.
2463
+ */
2464
+ filesDelete: Metric[];
2465
+ };
2466
+ /**
2467
+ * UsageFunctions
2468
+ */
2469
+ type UsageFunctions = {
2470
+ /**
2471
+ * The time range of the usage stats.
2472
+ */
2473
+ range: string;
2474
+ /**
2475
+ * Aggregated stats for number of function executions.
2476
+ */
2477
+ executionsTotal: Metric[];
2478
+ /**
2479
+ * Aggregated stats for function execution failures.
2480
+ */
2481
+ executionsFailure: Metric[];
2482
+ /**
2483
+ * Aggregated stats for function execution successes.
2484
+ */
2485
+ executionsSuccess: Metric[];
2486
+ /**
2487
+ * Aggregated stats for function execution duration.
2488
+ */
2489
+ executionsTime: Metric[];
2490
+ /**
2491
+ * Aggregated stats for number of function builds.
2492
+ */
2493
+ buildsTotal: Metric[];
2494
+ /**
2495
+ * Aggregated stats for function build failures.
2496
+ */
2497
+ buildsFailure: Metric[];
2498
+ /**
2499
+ * Aggregated stats for function build successes.
2500
+ */
2501
+ buildsSuccess: Metric[];
2502
+ /**
2503
+ * Aggregated stats for function build duration.
2504
+ */
2505
+ buildsTime: Metric[];
2506
+ };
2507
+ /**
2508
+ * UsageProject
2509
+ */
2510
+ type UsageProject = {
2511
+ /**
2512
+ * The time range of the usage stats.
2513
+ */
2514
+ range: string;
2515
+ /**
2516
+ * Aggregated stats for number of requests.
2517
+ */
2518
+ requests: Metric[];
2519
+ /**
2520
+ * Aggregated stats for consumed bandwidth.
2521
+ */
2522
+ network: Metric[];
2523
+ /**
2524
+ * Aggregated stats for function executions.
2525
+ */
2526
+ executions: Metric[];
2527
+ /**
2528
+ * Aggregated stats for number of documents.
2529
+ */
2530
+ documents: Metric[];
2531
+ /**
2532
+ * Aggregated stats for number of databases.
2533
+ */
2534
+ databases: Metric[];
2535
+ /**
2536
+ * Aggregated stats for number of users.
2537
+ */
2538
+ users: Metric[];
2539
+ /**
2540
+ * Aggregated stats for the occupied storage size (in bytes).
2541
+ */
2542
+ storage: Metric[];
2543
+ /**
2544
+ * Aggregated stats for number of buckets.
2545
+ */
2546
+ buckets: Metric[];
2547
+ };
2548
+ }