@appwrite.io/console 1.2.0 → 1.2.1

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.
package/src/models.ts CHANGED
@@ -646,6 +646,14 @@ export namespace Models {
646
646
  * Is attribute an array?
647
647
  */
648
648
  array?: boolean;
649
+ /**
650
+ * Attribute creation date in ISO 8601 format.
651
+ */
652
+ $createdAt: string;
653
+ /**
654
+ * Attribute update date in ISO 8601 format.
655
+ */
656
+ $updatedAt: string;
649
657
  /**
650
658
  * Attribute size.
651
659
  */
@@ -683,6 +691,14 @@ export namespace Models {
683
691
  * Is attribute an array?
684
692
  */
685
693
  array?: boolean;
694
+ /**
695
+ * Attribute creation date in ISO 8601 format.
696
+ */
697
+ $createdAt: string;
698
+ /**
699
+ * Attribute update date in ISO 8601 format.
700
+ */
701
+ $updatedAt: string;
686
702
  /**
687
703
  * Minimum value to enforce for new documents.
688
704
  */
@@ -724,6 +740,14 @@ export namespace Models {
724
740
  * Is attribute an array?
725
741
  */
726
742
  array?: boolean;
743
+ /**
744
+ * Attribute creation date in ISO 8601 format.
745
+ */
746
+ $createdAt: string;
747
+ /**
748
+ * Attribute update date in ISO 8601 format.
749
+ */
750
+ $updatedAt: string;
727
751
  /**
728
752
  * Minimum value to enforce for new documents.
729
753
  */
@@ -765,6 +789,14 @@ export namespace Models {
765
789
  * Is attribute an array?
766
790
  */
767
791
  array?: boolean;
792
+ /**
793
+ * Attribute creation date in ISO 8601 format.
794
+ */
795
+ $createdAt: string;
796
+ /**
797
+ * Attribute update date in ISO 8601 format.
798
+ */
799
+ $updatedAt: string;
768
800
  /**
769
801
  * Default value for attribute when not provided. Cannot be set when attribute is required.
770
802
  */
@@ -798,6 +830,14 @@ export namespace Models {
798
830
  * Is attribute an array?
799
831
  */
800
832
  array?: boolean;
833
+ /**
834
+ * Attribute creation date in ISO 8601 format.
835
+ */
836
+ $createdAt: string;
837
+ /**
838
+ * Attribute update date in ISO 8601 format.
839
+ */
840
+ $updatedAt: string;
801
841
  /**
802
842
  * String format.
803
843
  */
@@ -835,6 +875,14 @@ export namespace Models {
835
875
  * Is attribute an array?
836
876
  */
837
877
  array?: boolean;
878
+ /**
879
+ * Attribute creation date in ISO 8601 format.
880
+ */
881
+ $createdAt: string;
882
+ /**
883
+ * Attribute update date in ISO 8601 format.
884
+ */
885
+ $updatedAt: string;
838
886
  /**
839
887
  * Array of elements in enumerated type.
840
888
  */
@@ -876,6 +924,14 @@ export namespace Models {
876
924
  * Is attribute an array?
877
925
  */
878
926
  array?: boolean;
927
+ /**
928
+ * Attribute creation date in ISO 8601 format.
929
+ */
930
+ $createdAt: string;
931
+ /**
932
+ * Attribute update date in ISO 8601 format.
933
+ */
934
+ $updatedAt: string;
879
935
  /**
880
936
  * String format.
881
937
  */
@@ -913,6 +969,14 @@ export namespace Models {
913
969
  * Is attribute an array?
914
970
  */
915
971
  array?: boolean;
972
+ /**
973
+ * Attribute creation date in ISO 8601 format.
974
+ */
975
+ $createdAt: string;
976
+ /**
977
+ * Attribute update date in ISO 8601 format.
978
+ */
979
+ $updatedAt: string;
916
980
  /**
917
981
  * String format.
918
982
  */
@@ -950,6 +1014,14 @@ export namespace Models {
950
1014
  * Is attribute an array?
951
1015
  */
952
1016
  array?: boolean;
1017
+ /**
1018
+ * Attribute creation date in ISO 8601 format.
1019
+ */
1020
+ $createdAt: string;
1021
+ /**
1022
+ * Attribute update date in ISO 8601 format.
1023
+ */
1024
+ $updatedAt: string;
953
1025
  /**
954
1026
  * ISO 8601 format.
955
1027
  */
@@ -987,6 +1059,14 @@ export namespace Models {
987
1059
  * Is attribute an array?
988
1060
  */
989
1061
  array?: boolean;
1062
+ /**
1063
+ * Attribute creation date in ISO 8601 format.
1064
+ */
1065
+ $createdAt: string;
1066
+ /**
1067
+ * Attribute update date in ISO 8601 format.
1068
+ */
1069
+ $updatedAt: string;
990
1070
  /**
991
1071
  * The ID of the related collection.
992
1072
  */
@@ -1040,6 +1120,14 @@ export namespace Models {
1040
1120
  * Index orders.
1041
1121
  */
1042
1122
  orders?: string[];
1123
+ /**
1124
+ * Index creation date in ISO 8601 format.
1125
+ */
1126
+ $createdAt: string;
1127
+ /**
1128
+ * Index update date in ISO 8601 format.
1129
+ */
1130
+ $updatedAt: string;
1043
1131
  }
1044
1132
  /**
1045
1133
  * Document
@@ -2685,7 +2773,7 @@ export namespace Models {
2685
2773
  */
2686
2774
  phone: string;
2687
2775
  /**
2688
- * Mock OTP for the number.
2776
+ * Mock OTP for the number.
2689
2777
  */
2690
2778
  otp: string;
2691
2779
  }
@@ -3020,6 +3108,10 @@ export namespace Models {
3020
3108
  * Total aggregated number of documents.
3021
3109
  */
3022
3110
  documentsTotal: number;
3111
+ /**
3112
+ * Total aggregated number of total databases storage in bytes.
3113
+ */
3114
+ storageTotal: number;
3023
3115
  /**
3024
3116
  * Aggregated number of databases per period.
3025
3117
  */
@@ -3032,6 +3124,10 @@ export namespace Models {
3032
3124
  * Aggregated number of documents per period.
3033
3125
  */
3034
3126
  documents: Metric[];
3127
+ /**
3128
+ * An array of the aggregated number of databases storage in bytes per period.
3129
+ */
3130
+ storage: Metric[];
3035
3131
  }
3036
3132
  /**
3037
3133
  * UsageDatabase
@@ -3049,6 +3145,10 @@ export namespace Models {
3049
3145
  * Total aggregated number of documents.
3050
3146
  */
3051
3147
  documentsTotal: number;
3148
+ /**
3149
+ * Total aggregated number of total storage used in bytes.
3150
+ */
3151
+ storageTotal: number;
3052
3152
  /**
3053
3153
  * Aggregated number of collections per period.
3054
3154
  */
@@ -3057,6 +3157,10 @@ export namespace Models {
3057
3157
  * Aggregated number of documents per period.
3058
3158
  */
3059
3159
  documents: Metric[];
3160
+ /**
3161
+ * Aggregated storage used in bytes per period.
3162
+ */
3163
+ storage: Metric[];
3060
3164
  }
3061
3165
  /**
3062
3166
  * UsageCollection
@@ -3344,6 +3448,10 @@ export namespace Models {
3344
3448
  * Total aggregated number of databases.
3345
3449
  */
3346
3450
  databasesTotal: number;
3451
+ /**
3452
+ * Total aggregated sum of databases storage size (in bytes).
3453
+ */
3454
+ databasesStorageTotal: number;
3347
3455
  /**
3348
3456
  * Total aggregated number of users.
3349
3457
  */
@@ -3356,7 +3464,13 @@ export namespace Models {
3356
3464
  * Total aggregated sum of functions storage size (in bytes).
3357
3465
  */
3358
3466
  functionsStorageTotal: number;
3467
+ /**
3468
+ * Total aggregated sum of builds storage size (in bytes).
3469
+ */
3359
3470
  buildsStorageTotal: number;
3471
+ /**
3472
+ * Total aggregated sum of deployments storage size (in bytes).
3473
+ */
3360
3474
  deploymentsStorageTotal: number;
3361
3475
  /**
3362
3476
  * Total aggregated number of buckets.
@@ -3394,6 +3508,10 @@ export namespace Models {
3394
3508
  * Aggregated breakdown in totals of usage by buckets.
3395
3509
  */
3396
3510
  bucketsBreakdown: MetricBreakdown[];
3511
+ /**
3512
+ * An array of the aggregated breakdown of storage usage by databases.
3513
+ */
3514
+ databasesStorageBreakdown: MetricBreakdown[];
3397
3515
  /**
3398
3516
  * Aggregated breakdown in totals of execution mbSeconds by functions.
3399
3517
  */
@@ -3859,7 +3977,7 @@ export namespace Models {
3859
3977
  */
3860
3978
  $updatedAt: string;
3861
3979
  /**
3862
- * Migration status ( pending, processing, failed, completed )
3980
+ * Migration status ( pending, processing, failed, completed )
3863
3981
  */
3864
3982
  status: string;
3865
3983
  /**
@@ -154,7 +154,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,
154
154
  );
155
155
  }
156
156
  /**
157
- * List Identities
157
+ * List identities
158
158
  *
159
159
  * Get the list of identities for the currently logged in user.
160
160
  *
@@ -298,7 +298,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,
298
298
  );
299
299
  }
300
300
  /**
301
- * Create Authenticator
301
+ * Create authenticator
302
302
  *
303
303
  * Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](/docs/references/cloud/client-web/account#updateMfaAuthenticator) method.
304
304
  *
@@ -327,7 +327,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,
327
327
  );
328
328
  }
329
329
  /**
330
- * Verify Authenticator
330
+ * Verify authenticator
331
331
  *
332
332
  * Verify an authenticator app after adding it using the [add authenticator](/docs/references/cloud/client-web/account#createMfaAuthenticator) method.
333
333
  *
@@ -363,7 +363,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,
363
363
  );
364
364
  }
365
365
  /**
366
- * Delete Authenticator
366
+ * Delete authenticator
367
367
  *
368
368
  * Delete an authenticator for a user by ID.
369
369
  *
@@ -392,7 +392,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,
392
392
  );
393
393
  }
394
394
  /**
395
- * Create MFA Challenge
395
+ * Create MFA challenge
396
396
  *
397
397
  * Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge) method.
398
398
  *
@@ -424,7 +424,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,
424
424
  );
425
425
  }
426
426
  /**
427
- * Create MFA Challenge (confirmation)
427
+ * Create MFA challenge (confirmation)
428
428
  *
429
429
  * Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) method.
430
430
  *
@@ -463,7 +463,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,
463
463
  );
464
464
  }
465
465
  /**
466
- * List Factors
466
+ * List factors
467
467
  *
468
468
  * List the factors available on the account to be used as a MFA challange.
469
469
  *
@@ -488,7 +488,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,
488
488
  );
489
489
  }
490
490
  /**
491
- * Get MFA Recovery Codes
491
+ * Get MFA recovery codes
492
492
  *
493
493
  * Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) method. An OTP challenge is required to read recovery codes.
494
494
  *
@@ -513,7 +513,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,
513
513
  );
514
514
  }
515
515
  /**
516
- * Create MFA Recovery Codes
516
+ * Create MFA recovery codes
517
517
  *
518
518
  * Generate recovery codes as backup for MFA flow. It's recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) method.
519
519
  *
@@ -538,7 +538,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,
538
538
  );
539
539
  }
540
540
  /**
541
- * Regenerate MFA Recovery Codes
541
+ * Regenerate MFA recovery codes
542
542
  *
543
543
  * Regenerate recovery codes that can be used as backup for MFA flow. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) method. An OTP challenge is required to regenreate recovery codes.
544
544
  *
@@ -10,7 +10,7 @@ export class Assistant {
10
10
  }
11
11
 
12
12
  /**
13
- * Ask Query
13
+ * Ask query
14
14
  *
15
15
  *
16
16
  * @param {string} prompt
@@ -37,7 +37,7 @@ export class Locale {
37
37
  );
38
38
  }
39
39
  /**
40
- * List Locale Codes
40
+ * List locale codes
41
41
  *
42
42
  * List of all locale codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).
43
43
  *
@@ -10,7 +10,7 @@ export class Migrations {
10
10
  }
11
11
 
12
12
  /**
13
- * List Migrations
13
+ * List migrations
14
14
  *
15
15
  *
16
16
  * @param {string[]} queries
@@ -42,7 +42,7 @@ export class Migrations {
42
42
  );
43
43
  }
44
44
  /**
45
- * Migrate Appwrite Data
45
+ * Migrate Appwrite data
46
46
  *
47
47
  *
48
48
  * @param {string[]} resources
@@ -94,7 +94,7 @@ export class Migrations {
94
94
  );
95
95
  }
96
96
  /**
97
- * Generate a report on Appwrite Data
97
+ * Generate a report on Appwrite data
98
98
  *
99
99
  *
100
100
  * @param {string[]} resources
@@ -146,7 +146,7 @@ export class Migrations {
146
146
  );
147
147
  }
148
148
  /**
149
- * Migrate Firebase Data (Service Account)
149
+ * Migrate Firebase data (Service Account)
150
150
  *
151
151
  *
152
152
  * @param {string[]} resources
@@ -184,7 +184,7 @@ export class Migrations {
184
184
  );
185
185
  }
186
186
  /**
187
- * Revoke Appwrite's authorization to access Firebase Projects
187
+ * Revoke Appwrite's authorization to access Firebase projects
188
188
  *
189
189
  *
190
190
  * @throws {AppwriteException}
@@ -208,7 +208,7 @@ export class Migrations {
208
208
  );
209
209
  }
210
210
  /**
211
- * Migrate Firebase Data (OAuth)
211
+ * Migrate Firebase data (OAuth)
212
212
  *
213
213
  *
214
214
  * @param {string[]} resources
@@ -246,7 +246,7 @@ export class Migrations {
246
246
  );
247
247
  }
248
248
  /**
249
- * List Firebase Projects
249
+ * List Firebase projects
250
250
  *
251
251
  *
252
252
  * @throws {AppwriteException}
@@ -270,7 +270,7 @@ export class Migrations {
270
270
  );
271
271
  }
272
272
  /**
273
- * Generate a report on Firebase Data
273
+ * Generate a report on Firebase data
274
274
  *
275
275
  *
276
276
  * @param {string[]} resources
@@ -308,7 +308,7 @@ export class Migrations {
308
308
  );
309
309
  }
310
310
  /**
311
- * Generate a report on Firebase Data using OAuth
311
+ * Generate a report on Firebase data using OAuth
312
312
  *
313
313
  *
314
314
  * @param {string[]} resources
@@ -346,7 +346,7 @@ export class Migrations {
346
346
  );
347
347
  }
348
348
  /**
349
- * Migrate NHost Data
349
+ * Migrate NHost data
350
350
  *
351
351
  *
352
352
  * @param {string[]} resources
@@ -500,7 +500,7 @@ export class Migrations {
500
500
  );
501
501
  }
502
502
  /**
503
- * Migrate Supabase Data
503
+ * Migrate Supabase data
504
504
  *
505
505
  *
506
506
  * @param {string[]} resources
@@ -640,7 +640,7 @@ export class Migrations {
640
640
  );
641
641
  }
642
642
  /**
643
- * Get Migration
643
+ * Get migration
644
644
  *
645
645
  *
646
646
  * @param {string} migrationId
@@ -668,7 +668,7 @@ export class Migrations {
668
668
  );
669
669
  }
670
670
  /**
671
- * Retry Migration
671
+ * Retry migration
672
672
  *
673
673
  *
674
674
  * @param {string} migrationId
@@ -696,7 +696,7 @@ export class Migrations {
696
696
  );
697
697
  }
698
698
  /**
699
- * Delete Migration
699
+ * Delete migration
700
700
  *
701
701
  *
702
702
  * @param {string} migrationId
@@ -53,7 +53,7 @@ export class Project {
53
53
  );
54
54
  }
55
55
  /**
56
- * List Variables
56
+ * List variables
57
57
  *
58
58
  * Get a list of all project variables. These variables will be accessible in all Appwrite Functions at runtime.
59
59
  *
@@ -78,7 +78,7 @@ export class Project {
78
78
  );
79
79
  }
80
80
  /**
81
- * Create Variable
81
+ * Create variable
82
82
  *
83
83
  * Create a new project variable. This variable will be accessible in all Appwrite Functions at runtime.
84
84
  *
@@ -117,7 +117,7 @@ export class Project {
117
117
  );
118
118
  }
119
119
  /**
120
- * Get Variable
120
+ * Get variable
121
121
  *
122
122
  * Get a project variable by its unique ID.
123
123
  *
@@ -146,7 +146,7 @@ export class Project {
146
146
  );
147
147
  }
148
148
  /**
149
- * Update Variable
149
+ * Update variable
150
150
  *
151
151
  * Update project variable by its unique ID. This variable will be accessible in all Appwrite Functions at runtime.
152
152
  *
@@ -186,7 +186,7 @@ export class Project {
186
186
  );
187
187
  }
188
188
  /**
189
- * Delete Variable
189
+ * Delete variable
190
190
  *
191
191
  * Delete a project variable by its unique ID.
192
192
  *
@@ -11,7 +11,7 @@ export class Proxy {
11
11
  }
12
12
 
13
13
  /**
14
- * List Rules
14
+ * List rules
15
15
  *
16
16
  * Get a list of all the proxy rules. You can use the query params to filter your results.
17
17
  *
@@ -44,7 +44,7 @@ export class Proxy {
44
44
  );
45
45
  }
46
46
  /**
47
- * Create Rule
47
+ * Create rule
48
48
  *
49
49
  * Create a new proxy rule.
50
50
  *
@@ -87,7 +87,7 @@ export class Proxy {
87
87
  );
88
88
  }
89
89
  /**
90
- * Get Rule
90
+ * Get rule
91
91
  *
92
92
  * Get a proxy rule by its unique ID.
93
93
  *
@@ -116,7 +116,7 @@ export class Proxy {
116
116
  );
117
117
  }
118
118
  /**
119
- * Delete Rule
119
+ * Delete rule
120
120
  *
121
121
  * Delete a proxy rule by its unique ID.
122
122
  *
@@ -145,7 +145,7 @@ export class Proxy {
145
145
  );
146
146
  }
147
147
  /**
148
- * Update Rule Verification Status
148
+ * Update rule verification status
149
149
  *
150
150
  *
151
151
  * @param {string} ruleId
@@ -410,7 +410,7 @@ If you're creating a new file using one of the Appwrite SDKs, all the chunk
410
410
  );
411
411
  }
412
412
  /**
413
- * Delete File
413
+ * Delete file
414
414
  *
415
415
  * Delete a file by its unique ID. Only users with write permissions have access to delete this resource.
416
416
  *
@@ -195,7 +195,7 @@ export class Users {
195
195
  );
196
196
  }
197
197
  /**
198
- * List Identities
198
+ * List identities
199
199
  *
200
200
  * Get identities for all users.
201
201
  *
@@ -862,7 +862,7 @@ Labels can be used to grant access to resources. While teams are a way for user&
862
862
  );
863
863
  }
864
864
  /**
865
- * Delete Authenticator
865
+ * Delete authenticator
866
866
  *
867
867
  * Delete an authenticator app.
868
868
  *
@@ -895,7 +895,7 @@ Labels can be used to grant access to resources. While teams are a way for user&
895
895
  );
896
896
  }
897
897
  /**
898
- * List Factors
898
+ * List factors
899
899
  *
900
900
  * List the factors available on the account to be used as a MFA challange.
901
901
  *
@@ -924,7 +924,7 @@ Labels can be used to grant access to resources. While teams are a way for user&
924
924
  );
925
925
  }
926
926
  /**
927
- * Get MFA Recovery Codes
927
+ * Get MFA recovery codes
928
928
  *
929
929
  * Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) method.
930
930
  *
@@ -953,7 +953,7 @@ Labels can be used to grant access to resources. While teams are a way for user&
953
953
  );
954
954
  }
955
955
  /**
956
- * Regenerate MFA Recovery Codes
956
+ * Regenerate MFA recovery codes
957
957
  *
958
958
  * Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) method.
959
959
  *
@@ -982,7 +982,7 @@ Labels can be used to grant access to resources. While teams are a way for user&
982
982
  );
983
983
  }
984
984
  /**
985
- * Create MFA Recovery Codes
985
+ * Create MFA recovery codes
986
986
  *
987
987
  * Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) method by client SDK.
988
988
  *
@@ -1342,7 +1342,7 @@ If you want to generate a token for a custom authentication flow, use the [POST
1342
1342
  );
1343
1343
  }
1344
1344
  /**
1345
- * List User Targets
1345
+ * List user targets
1346
1346
  *
1347
1347
  * List the messaging targets that are associated with a user.
1348
1348
  *
@@ -1375,7 +1375,7 @@ If you want to generate a token for a custom authentication flow, use the [POST
1375
1375
  );
1376
1376
  }
1377
1377
  /**
1378
- * Create User Target
1378
+ * Create user target
1379
1379
  *
1380
1380
  * Create a messaging target.
1381
1381
  *
@@ -1433,7 +1433,7 @@ If you want to generate a token for a custom authentication flow, use the [POST
1433
1433
  );
1434
1434
  }
1435
1435
  /**
1436
- * Get User Target
1436
+ * Get user target
1437
1437
  *
1438
1438
  * Get a user's push notification target by ID.
1439
1439
  *
@@ -1466,7 +1466,7 @@ If you want to generate a token for a custom authentication flow, use the [POST
1466
1466
  );
1467
1467
  }
1468
1468
  /**
1469
- * Update User target
1469
+ * Update user target
1470
1470
  *
1471
1471
  * Update a messaging target.
1472
1472
  *
@@ -10,7 +10,7 @@ export class Vcs {
10
10
  }
11
11
 
12
12
  /**
13
- * List Repositories
13
+ * List repositories
14
14
  *
15
15
  *
16
16
  * @param {string} installationId
@@ -116,7 +116,7 @@ export class Vcs {
116
116
  );
117
117
  }
118
118
  /**
119
- * List Repository Branches
119
+ * List repository branches
120
120
  *
121
121
  *
122
122
  * @param {string} installationId
@@ -319,7 +319,7 @@ export class Vcs {
319
319
  );
320
320
  }
321
321
  /**
322
- * Delete Installation
322
+ * Delete installation
323
323
  *
324
324
  *
325
325
  * @param {string} installationId