@appwrite.io/console 0.5.0 → 0.6.0-rc.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/README.md +1 -1
- package/dist/cjs/sdk.js +2100 -112
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +2100 -113
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +2100 -112
- package/docs/examples/account/add-authenticator.md +18 -0
- package/docs/examples/account/create-challenge.md +18 -0
- package/docs/examples/account/{delete.md → list-providers.md} +1 -1
- package/docs/examples/account/update-challenge.md +18 -0
- package/docs/examples/account/update-m-f-a.md +18 -0
- package/docs/examples/account/update-recovery.md +1 -1
- package/docs/examples/account/verify-authenticator.md +18 -0
- package/docs/examples/messaging/create-apns-provider.md +18 -0
- package/docs/examples/messaging/create-email-message.md +18 -0
- package/docs/examples/messaging/create-fcm-provider.md +18 -0
- package/docs/examples/messaging/create-mailgun-provider.md +18 -0
- package/docs/examples/messaging/create-msg91provider.md +18 -0
- package/docs/examples/messaging/create-push-message.md +18 -0
- package/docs/examples/messaging/create-s-m-s-message.md +18 -0
- package/docs/examples/messaging/create-sendgrid-provider.md +18 -0
- package/docs/examples/messaging/create-subscriber.md +18 -0
- package/docs/examples/messaging/create-telesign-provider.md +18 -0
- package/docs/examples/messaging/create-textmagic-provider.md +18 -0
- package/docs/examples/messaging/create-topic.md +18 -0
- package/docs/examples/messaging/create-twilio-provider.md +18 -0
- package/docs/examples/messaging/create-vonage-provider.md +18 -0
- package/docs/examples/messaging/delete-provider.md +18 -0
- package/docs/examples/messaging/delete-subscriber.md +18 -0
- package/docs/examples/messaging/delete-topic.md +18 -0
- package/docs/examples/messaging/get-message.md +18 -0
- package/docs/examples/messaging/get-provider.md +18 -0
- package/docs/examples/messaging/get-subscriber.md +18 -0
- package/docs/examples/messaging/get-topic.md +18 -0
- package/docs/examples/messaging/list-message-logs.md +18 -0
- package/docs/examples/messaging/list-messages.md +18 -0
- package/docs/examples/messaging/list-provider-logs.md +18 -0
- package/docs/examples/messaging/list-providers.md +18 -0
- package/docs/examples/messaging/list-subscriber-logs.md +18 -0
- package/docs/examples/messaging/list-subscribers.md +18 -0
- package/docs/examples/messaging/list-topic-logs.md +18 -0
- package/docs/examples/messaging/list-topics.md +18 -0
- package/docs/examples/messaging/update-apns-provider.md +18 -0
- package/docs/examples/messaging/update-email.md +18 -0
- package/docs/examples/messaging/update-fcm-provider.md +18 -0
- package/docs/examples/messaging/update-mailgun-provider.md +18 -0
- package/docs/examples/messaging/update-msg91provider.md +18 -0
- package/docs/examples/messaging/update-push-notification.md +18 -0
- package/docs/examples/messaging/update-s-m-s.md +18 -0
- package/docs/examples/messaging/update-sendgrid-provider.md +18 -0
- package/docs/examples/messaging/update-telesign-provider.md +18 -0
- package/docs/examples/messaging/update-textmagic-provider.md +18 -0
- package/docs/examples/messaging/update-topic.md +18 -0
- package/docs/examples/messaging/update-twilio-provider.md +18 -0
- package/docs/examples/messaging/update-vonage-provider.md +18 -0
- package/docs/examples/project/get-usage.md +1 -1
- package/docs/examples/projects/get-usage.md +18 -0
- package/docs/examples/projects/update-auth-mfa-factors.md +18 -0
- package/docs/examples/users/create-target.md +18 -0
- package/docs/examples/users/delete-target.md +18 -0
- package/docs/examples/users/get-target.md +18 -0
- package/docs/examples/users/list-targets.md +18 -0
- package/docs/examples/users/update-target.md +18 -0
- package/package.json +1 -1
- package/src/client.ts +1 -1
- package/src/index.ts +1 -0
- package/src/models.ts +530 -199
- package/src/services/account.ts +158 -18
- package/src/services/functions.ts +1 -1
- package/src/services/messaging.ts +1901 -0
- package/src/services/project.ts +4 -22
- package/src/services/projects.ts +58 -0
- package/src/services/storage.ts +1 -1
- package/src/services/users.ts +188 -1
- package/types/index.d.ts +1 -0
- package/types/models.d.ts +530 -199
- package/types/services/account.d.ts +56 -9
- package/types/services/functions.d.ts +1 -1
- package/types/services/messaging.d.ts +553 -0
- package/types/services/project.d.ts +2 -4
- package/types/services/projects.d.ts +20 -0
- package/types/services/storage.d.ts +1 -1
- package/types/services/users.d.ts +59 -1
package/src/models.ts
CHANGED
|
@@ -402,6 +402,71 @@ export namespace Models {
|
|
|
402
402
|
*/
|
|
403
403
|
localeCodes: LocaleCode[];
|
|
404
404
|
}
|
|
405
|
+
/**
|
|
406
|
+
* Provider list
|
|
407
|
+
*/
|
|
408
|
+
export type ProviderList = {
|
|
409
|
+
/**
|
|
410
|
+
* Total number of providers documents that matched your query.
|
|
411
|
+
*/
|
|
412
|
+
total: number;
|
|
413
|
+
/**
|
|
414
|
+
* List of providers.
|
|
415
|
+
*/
|
|
416
|
+
providers: Provider[];
|
|
417
|
+
}
|
|
418
|
+
/**
|
|
419
|
+
* Message list
|
|
420
|
+
*/
|
|
421
|
+
export type MessageList = {
|
|
422
|
+
/**
|
|
423
|
+
* Total number of messages documents that matched your query.
|
|
424
|
+
*/
|
|
425
|
+
total: number;
|
|
426
|
+
/**
|
|
427
|
+
* List of messages.
|
|
428
|
+
*/
|
|
429
|
+
messages: Message[];
|
|
430
|
+
}
|
|
431
|
+
/**
|
|
432
|
+
* Topic list
|
|
433
|
+
*/
|
|
434
|
+
export type TopicList = {
|
|
435
|
+
/**
|
|
436
|
+
* Total number of topics documents that matched your query.
|
|
437
|
+
*/
|
|
438
|
+
total: number;
|
|
439
|
+
/**
|
|
440
|
+
* List of topics.
|
|
441
|
+
*/
|
|
442
|
+
topics: Topic[];
|
|
443
|
+
}
|
|
444
|
+
/**
|
|
445
|
+
* Subscriber list
|
|
446
|
+
*/
|
|
447
|
+
export type SubscriberList = {
|
|
448
|
+
/**
|
|
449
|
+
* Total number of subscribers documents that matched your query.
|
|
450
|
+
*/
|
|
451
|
+
total: number;
|
|
452
|
+
/**
|
|
453
|
+
* List of subscribers.
|
|
454
|
+
*/
|
|
455
|
+
subscribers: Subscriber[];
|
|
456
|
+
}
|
|
457
|
+
/**
|
|
458
|
+
* Target list
|
|
459
|
+
*/
|
|
460
|
+
export type TargetList = {
|
|
461
|
+
/**
|
|
462
|
+
* Total number of targets documents that matched your query.
|
|
463
|
+
*/
|
|
464
|
+
total: number;
|
|
465
|
+
/**
|
|
466
|
+
* List of targets.
|
|
467
|
+
*/
|
|
468
|
+
targets: Target[];
|
|
469
|
+
}
|
|
405
470
|
/**
|
|
406
471
|
* Migrations List
|
|
407
472
|
*/
|
|
@@ -1121,6 +1186,10 @@ export namespace Models {
|
|
|
1121
1186
|
* User preferences as a key-value object
|
|
1122
1187
|
*/
|
|
1123
1188
|
prefs: Preferences;
|
|
1189
|
+
/**
|
|
1190
|
+
* A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.
|
|
1191
|
+
*/
|
|
1192
|
+
targets: Target[];
|
|
1124
1193
|
/**
|
|
1125
1194
|
* Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.
|
|
1126
1195
|
*/
|
|
@@ -1339,6 +1408,10 @@ export namespace Models {
|
|
|
1339
1408
|
* Returns true if this the current user session.
|
|
1340
1409
|
*/
|
|
1341
1410
|
current: boolean;
|
|
1411
|
+
/**
|
|
1412
|
+
* Returns true if this the current user session.
|
|
1413
|
+
*/
|
|
1414
|
+
factors: number;
|
|
1342
1415
|
}
|
|
1343
1416
|
/**
|
|
1344
1417
|
* Identity
|
|
@@ -2106,9 +2179,9 @@ export namespace Models {
|
|
|
2106
2179
|
*/
|
|
2107
2180
|
authPersonalDataCheck: boolean;
|
|
2108
2181
|
/**
|
|
2109
|
-
* List of Providers.
|
|
2182
|
+
* List of Auth Providers.
|
|
2110
2183
|
*/
|
|
2111
|
-
|
|
2184
|
+
oAuthProviders: AuthProvider[];
|
|
2112
2185
|
/**
|
|
2113
2186
|
* List of Platforms.
|
|
2114
2187
|
*/
|
|
@@ -2221,6 +2294,10 @@ export namespace Models {
|
|
|
2221
2294
|
* GraphQL service status
|
|
2222
2295
|
*/
|
|
2223
2296
|
serviceStatusForGraphql: boolean;
|
|
2297
|
+
/**
|
|
2298
|
+
* Messaging service status
|
|
2299
|
+
*/
|
|
2300
|
+
serviceStatusForMessaging: boolean;
|
|
2224
2301
|
}
|
|
2225
2302
|
/**
|
|
2226
2303
|
* Webhook
|
|
@@ -2309,15 +2386,15 @@ export namespace Models {
|
|
|
2309
2386
|
sdks: string[];
|
|
2310
2387
|
}
|
|
2311
2388
|
/**
|
|
2312
|
-
*
|
|
2389
|
+
* AuthProvider
|
|
2313
2390
|
*/
|
|
2314
|
-
export type
|
|
2391
|
+
export type AuthProvider = {
|
|
2315
2392
|
/**
|
|
2316
|
-
* Provider.
|
|
2393
|
+
* Auth Provider.
|
|
2317
2394
|
*/
|
|
2318
2395
|
key: string;
|
|
2319
2396
|
/**
|
|
2320
|
-
* Provider name.
|
|
2397
|
+
* Auth Provider name.
|
|
2321
2398
|
*/
|
|
2322
2399
|
name: string;
|
|
2323
2400
|
/**
|
|
@@ -2329,7 +2406,7 @@ export namespace Models {
|
|
|
2329
2406
|
*/
|
|
2330
2407
|
secret: string;
|
|
2331
2408
|
/**
|
|
2332
|
-
* Provider is active and can be used to create session.
|
|
2409
|
+
* Auth Provider is active and can be used to create session.
|
|
2333
2410
|
*/
|
|
2334
2411
|
enabled: boolean;
|
|
2335
2412
|
}
|
|
@@ -2574,370 +2651,360 @@ export namespace Models {
|
|
|
2574
2651
|
date: string;
|
|
2575
2652
|
}
|
|
2576
2653
|
/**
|
|
2577
|
-
*
|
|
2654
|
+
* UsageDatabases
|
|
2578
2655
|
*/
|
|
2579
|
-
export type
|
|
2656
|
+
export type UsageDatabases = {
|
|
2580
2657
|
/**
|
|
2581
|
-
*
|
|
2658
|
+
* The time range of the usage stats.
|
|
2582
2659
|
*/
|
|
2583
|
-
|
|
2660
|
+
range: string;
|
|
2584
2661
|
/**
|
|
2585
|
-
*
|
|
2662
|
+
* Aggregated stats for total number of documents.
|
|
2586
2663
|
*/
|
|
2587
|
-
|
|
2664
|
+
databasesCount: Metric[];
|
|
2588
2665
|
/**
|
|
2589
|
-
*
|
|
2666
|
+
* Aggregated stats for total number of documents.
|
|
2590
2667
|
*/
|
|
2591
|
-
|
|
2592
|
-
}
|
|
2593
|
-
/**
|
|
2594
|
-
* UsageDatabases
|
|
2595
|
-
*/
|
|
2596
|
-
export type UsageDatabases = {
|
|
2668
|
+
documentsCount: Metric[];
|
|
2597
2669
|
/**
|
|
2598
|
-
*
|
|
2670
|
+
* Aggregated stats for total number of collections.
|
|
2599
2671
|
*/
|
|
2600
|
-
|
|
2672
|
+
collectionsCount: Metric[];
|
|
2601
2673
|
/**
|
|
2602
|
-
*
|
|
2674
|
+
* Aggregated stats for documents created.
|
|
2603
2675
|
*/
|
|
2604
|
-
|
|
2676
|
+
databasesCreate: Metric[];
|
|
2605
2677
|
/**
|
|
2606
|
-
*
|
|
2678
|
+
* Aggregated stats for documents read.
|
|
2607
2679
|
*/
|
|
2608
|
-
|
|
2680
|
+
databasesRead: Metric[];
|
|
2609
2681
|
/**
|
|
2610
|
-
*
|
|
2682
|
+
* Aggregated stats for documents updated.
|
|
2611
2683
|
*/
|
|
2612
|
-
|
|
2684
|
+
databasesUpdate: Metric[];
|
|
2613
2685
|
/**
|
|
2614
|
-
* Aggregated number of
|
|
2686
|
+
* Aggregated stats for total number of collections.
|
|
2615
2687
|
*/
|
|
2616
|
-
|
|
2688
|
+
databasesDelete: Metric[];
|
|
2617
2689
|
/**
|
|
2618
|
-
* Aggregated
|
|
2690
|
+
* Aggregated stats for documents created.
|
|
2619
2691
|
*/
|
|
2620
|
-
|
|
2692
|
+
documentsCreate: Metric[];
|
|
2621
2693
|
/**
|
|
2622
|
-
* Aggregated
|
|
2694
|
+
* Aggregated stats for documents read.
|
|
2623
2695
|
*/
|
|
2624
|
-
|
|
2625
|
-
}
|
|
2626
|
-
/**
|
|
2627
|
-
* UsageDatabase
|
|
2628
|
-
*/
|
|
2629
|
-
export type UsageDatabase = {
|
|
2696
|
+
documentsRead: Metric[];
|
|
2630
2697
|
/**
|
|
2631
|
-
*
|
|
2698
|
+
* Aggregated stats for documents updated.
|
|
2632
2699
|
*/
|
|
2633
|
-
|
|
2700
|
+
documentsUpdate: Metric[];
|
|
2634
2701
|
/**
|
|
2635
|
-
*
|
|
2702
|
+
* Aggregated stats for documents deleted.
|
|
2636
2703
|
*/
|
|
2637
|
-
|
|
2704
|
+
documentsDelete: Metric[];
|
|
2638
2705
|
/**
|
|
2639
|
-
*
|
|
2706
|
+
* Aggregated stats for collections created.
|
|
2640
2707
|
*/
|
|
2641
|
-
|
|
2708
|
+
collectionsCreate: Metric[];
|
|
2642
2709
|
/**
|
|
2643
|
-
* Aggregated
|
|
2710
|
+
* Aggregated stats for collections read.
|
|
2644
2711
|
*/
|
|
2645
|
-
|
|
2712
|
+
collectionsRead: Metric[];
|
|
2646
2713
|
/**
|
|
2647
|
-
* Aggregated
|
|
2714
|
+
* Aggregated stats for collections updated.
|
|
2648
2715
|
*/
|
|
2649
|
-
|
|
2716
|
+
collectionsUpdate: Metric[];
|
|
2717
|
+
/**
|
|
2718
|
+
* Aggregated stats for collections delete.
|
|
2719
|
+
*/
|
|
2720
|
+
collectionsDelete: Metric[];
|
|
2650
2721
|
}
|
|
2651
2722
|
/**
|
|
2652
|
-
*
|
|
2723
|
+
* UsageDatabase
|
|
2653
2724
|
*/
|
|
2654
|
-
export type
|
|
2725
|
+
export type UsageDatabase = {
|
|
2655
2726
|
/**
|
|
2656
|
-
*
|
|
2727
|
+
* The time range of the usage stats.
|
|
2657
2728
|
*/
|
|
2658
2729
|
range: string;
|
|
2659
2730
|
/**
|
|
2660
|
-
*
|
|
2731
|
+
* Aggregated stats for total number of documents.
|
|
2661
2732
|
*/
|
|
2662
|
-
|
|
2733
|
+
documentsCount: Metric[];
|
|
2663
2734
|
/**
|
|
2664
|
-
* Aggregated
|
|
2735
|
+
* Aggregated stats for total number of collections.
|
|
2665
2736
|
*/
|
|
2666
|
-
|
|
2667
|
-
}
|
|
2668
|
-
/**
|
|
2669
|
-
* UsageUsers
|
|
2670
|
-
*/
|
|
2671
|
-
export type UsageUsers = {
|
|
2737
|
+
collectionsCount: Metric[];
|
|
2672
2738
|
/**
|
|
2673
|
-
*
|
|
2739
|
+
* Aggregated stats for documents created.
|
|
2674
2740
|
*/
|
|
2675
|
-
|
|
2741
|
+
documentsCreate: Metric[];
|
|
2676
2742
|
/**
|
|
2677
|
-
*
|
|
2743
|
+
* Aggregated stats for documents read.
|
|
2678
2744
|
*/
|
|
2679
|
-
|
|
2745
|
+
documentsRead: Metric[];
|
|
2680
2746
|
/**
|
|
2681
|
-
*
|
|
2747
|
+
* Aggregated stats for documents updated.
|
|
2682
2748
|
*/
|
|
2683
|
-
|
|
2749
|
+
documentsUpdate: Metric[];
|
|
2684
2750
|
/**
|
|
2685
|
-
* Aggregated
|
|
2751
|
+
* Aggregated stats for documents deleted.
|
|
2686
2752
|
*/
|
|
2687
|
-
|
|
2753
|
+
documentsDelete: Metric[];
|
|
2754
|
+
/**
|
|
2755
|
+
* Aggregated stats for collections created.
|
|
2756
|
+
*/
|
|
2757
|
+
collectionsCreate: Metric[];
|
|
2758
|
+
/**
|
|
2759
|
+
* Aggregated stats for collections read.
|
|
2760
|
+
*/
|
|
2761
|
+
collectionsRead: Metric[];
|
|
2762
|
+
/**
|
|
2763
|
+
* Aggregated stats for collections updated.
|
|
2764
|
+
*/
|
|
2765
|
+
collectionsUpdate: Metric[];
|
|
2688
2766
|
/**
|
|
2689
|
-
* Aggregated
|
|
2767
|
+
* Aggregated stats for collections delete.
|
|
2690
2768
|
*/
|
|
2691
|
-
|
|
2769
|
+
collectionsDelete: Metric[];
|
|
2692
2770
|
}
|
|
2693
2771
|
/**
|
|
2694
|
-
*
|
|
2772
|
+
* UsageCollection
|
|
2695
2773
|
*/
|
|
2696
|
-
export type
|
|
2774
|
+
export type UsageCollection = {
|
|
2697
2775
|
/**
|
|
2698
|
-
*
|
|
2776
|
+
* The time range of the usage stats.
|
|
2699
2777
|
*/
|
|
2700
2778
|
range: string;
|
|
2701
2779
|
/**
|
|
2702
|
-
*
|
|
2780
|
+
* Aggregated stats for total number of documents.
|
|
2703
2781
|
*/
|
|
2704
|
-
|
|
2782
|
+
documentsCount: Metric[];
|
|
2705
2783
|
/**
|
|
2706
|
-
*
|
|
2784
|
+
* Aggregated stats for documents created.
|
|
2707
2785
|
*/
|
|
2708
|
-
|
|
2786
|
+
documentsCreate: Metric[];
|
|
2709
2787
|
/**
|
|
2710
|
-
*
|
|
2788
|
+
* Aggregated stats for documents read.
|
|
2711
2789
|
*/
|
|
2712
|
-
|
|
2790
|
+
documentsRead: Metric[];
|
|
2713
2791
|
/**
|
|
2714
|
-
* Aggregated
|
|
2792
|
+
* Aggregated stats for documents updated.
|
|
2715
2793
|
*/
|
|
2716
|
-
|
|
2794
|
+
documentsUpdate: Metric[];
|
|
2717
2795
|
/**
|
|
2718
|
-
* Aggregated
|
|
2796
|
+
* Aggregated stats for documents deleted.
|
|
2719
2797
|
*/
|
|
2720
|
-
|
|
2721
|
-
/**
|
|
2722
|
-
* Aggregated number of files storage (in bytes) per period .
|
|
2723
|
-
*/
|
|
2724
|
-
storage: Metric[];
|
|
2798
|
+
documentsDelete: Metric[];
|
|
2725
2799
|
}
|
|
2726
2800
|
/**
|
|
2727
|
-
*
|
|
2801
|
+
* UsageUsers
|
|
2728
2802
|
*/
|
|
2729
|
-
export type
|
|
2803
|
+
export type UsageUsers = {
|
|
2730
2804
|
/**
|
|
2731
|
-
*
|
|
2805
|
+
* The time range of the usage stats.
|
|
2732
2806
|
*/
|
|
2733
2807
|
range: string;
|
|
2734
2808
|
/**
|
|
2735
|
-
*
|
|
2809
|
+
* Aggregated stats for total number of users.
|
|
2736
2810
|
*/
|
|
2737
|
-
|
|
2811
|
+
usersCount: Metric[];
|
|
2738
2812
|
/**
|
|
2739
|
-
*
|
|
2813
|
+
* Aggregated stats for users created.
|
|
2740
2814
|
*/
|
|
2741
|
-
|
|
2815
|
+
usersCreate: Metric[];
|
|
2742
2816
|
/**
|
|
2743
|
-
* Aggregated
|
|
2817
|
+
* Aggregated stats for users read.
|
|
2744
2818
|
*/
|
|
2745
|
-
|
|
2819
|
+
usersRead: Metric[];
|
|
2746
2820
|
/**
|
|
2747
|
-
* Aggregated
|
|
2821
|
+
* Aggregated stats for users updated.
|
|
2748
2822
|
*/
|
|
2749
|
-
|
|
2750
|
-
}
|
|
2751
|
-
/**
|
|
2752
|
-
* UsageFunctions
|
|
2753
|
-
*/
|
|
2754
|
-
export type UsageFunctions = {
|
|
2823
|
+
usersUpdate: Metric[];
|
|
2755
2824
|
/**
|
|
2756
|
-
*
|
|
2825
|
+
* Aggregated stats for users deleted.
|
|
2757
2826
|
*/
|
|
2758
|
-
|
|
2827
|
+
usersDelete: Metric[];
|
|
2759
2828
|
/**
|
|
2760
|
-
*
|
|
2829
|
+
* Aggregated stats for sessions created.
|
|
2761
2830
|
*/
|
|
2762
|
-
|
|
2831
|
+
sessionsCreate: Metric[];
|
|
2763
2832
|
/**
|
|
2764
|
-
*
|
|
2833
|
+
* Aggregated stats for sessions created for a provider ( email, anonymous or oauth2 ).
|
|
2765
2834
|
*/
|
|
2766
|
-
|
|
2835
|
+
sessionsProviderCreate: Metric[];
|
|
2767
2836
|
/**
|
|
2768
|
-
*
|
|
2837
|
+
* Aggregated stats for sessions deleted.
|
|
2769
2838
|
*/
|
|
2770
|
-
|
|
2839
|
+
sessionsDelete: Metric[];
|
|
2840
|
+
}
|
|
2841
|
+
/**
|
|
2842
|
+
* StorageUsage
|
|
2843
|
+
*/
|
|
2844
|
+
export type UsageStorage = {
|
|
2771
2845
|
/**
|
|
2772
|
-
*
|
|
2846
|
+
* The time range of the usage stats.
|
|
2773
2847
|
*/
|
|
2774
|
-
|
|
2848
|
+
range: string;
|
|
2775
2849
|
/**
|
|
2776
|
-
*
|
|
2850
|
+
* Aggregated stats for the occupied storage size (in bytes).
|
|
2777
2851
|
*/
|
|
2778
|
-
|
|
2852
|
+
storage: Metric[];
|
|
2779
2853
|
/**
|
|
2780
|
-
*
|
|
2854
|
+
* Aggregated stats for total number of files.
|
|
2781
2855
|
*/
|
|
2782
|
-
|
|
2856
|
+
filesCount: Metric[];
|
|
2783
2857
|
/**
|
|
2784
|
-
*
|
|
2858
|
+
* Aggregated stats for total number of buckets.
|
|
2785
2859
|
*/
|
|
2786
|
-
|
|
2860
|
+
bucketsCount: Metric[];
|
|
2787
2861
|
/**
|
|
2788
|
-
*
|
|
2862
|
+
* Aggregated stats for buckets created.
|
|
2789
2863
|
*/
|
|
2790
|
-
|
|
2864
|
+
bucketsCreate: Metric[];
|
|
2791
2865
|
/**
|
|
2792
|
-
* Aggregated
|
|
2866
|
+
* Aggregated stats for buckets read.
|
|
2793
2867
|
*/
|
|
2794
|
-
|
|
2868
|
+
bucketsRead: Metric[];
|
|
2795
2869
|
/**
|
|
2796
|
-
* Aggregated
|
|
2870
|
+
* Aggregated stats for buckets updated.
|
|
2797
2871
|
*/
|
|
2798
|
-
|
|
2872
|
+
bucketsUpdate: Metric[];
|
|
2799
2873
|
/**
|
|
2800
|
-
* Aggregated
|
|
2874
|
+
* Aggregated stats for buckets deleted.
|
|
2801
2875
|
*/
|
|
2802
|
-
|
|
2876
|
+
bucketsDelete: Metric[];
|
|
2803
2877
|
/**
|
|
2804
|
-
* Aggregated
|
|
2878
|
+
* Aggregated stats for files created.
|
|
2805
2879
|
*/
|
|
2806
|
-
|
|
2880
|
+
filesCreate: Metric[];
|
|
2807
2881
|
/**
|
|
2808
|
-
* Aggregated
|
|
2882
|
+
* Aggregated stats for files read.
|
|
2809
2883
|
*/
|
|
2810
|
-
|
|
2884
|
+
filesRead: Metric[];
|
|
2811
2885
|
/**
|
|
2812
|
-
* Aggregated
|
|
2886
|
+
* Aggregated stats for files updated.
|
|
2813
2887
|
*/
|
|
2814
|
-
|
|
2888
|
+
filesUpdate: Metric[];
|
|
2815
2889
|
/**
|
|
2816
|
-
* Aggregated
|
|
2890
|
+
* Aggregated stats for files deleted.
|
|
2817
2891
|
*/
|
|
2818
|
-
|
|
2819
|
-
/**
|
|
2820
|
-
* Aggregated number of functions execution compute time per period.
|
|
2821
|
-
*/
|
|
2822
|
-
executionsTime: Metric[];
|
|
2892
|
+
filesDelete: Metric[];
|
|
2823
2893
|
}
|
|
2824
2894
|
/**
|
|
2825
|
-
*
|
|
2895
|
+
* UsageBuckets
|
|
2826
2896
|
*/
|
|
2827
|
-
export type
|
|
2897
|
+
export type UsageBuckets = {
|
|
2828
2898
|
/**
|
|
2829
2899
|
* The time range of the usage stats.
|
|
2830
2900
|
*/
|
|
2831
2901
|
range: string;
|
|
2832
2902
|
/**
|
|
2833
|
-
*
|
|
2903
|
+
* Aggregated stats for total number of files in this bucket.
|
|
2834
2904
|
*/
|
|
2835
|
-
|
|
2905
|
+
filesCount: Metric[];
|
|
2836
2906
|
/**
|
|
2837
|
-
*
|
|
2907
|
+
* Aggregated stats for total storage of files in this bucket.
|
|
2838
2908
|
*/
|
|
2839
|
-
|
|
2909
|
+
filesStorage: Metric[];
|
|
2840
2910
|
/**
|
|
2841
|
-
*
|
|
2911
|
+
* Aggregated stats for files created.
|
|
2842
2912
|
*/
|
|
2843
|
-
|
|
2913
|
+
filesCreate: Metric[];
|
|
2844
2914
|
/**
|
|
2845
|
-
*
|
|
2915
|
+
* Aggregated stats for files read.
|
|
2846
2916
|
*/
|
|
2847
|
-
|
|
2917
|
+
filesRead: Metric[];
|
|
2848
2918
|
/**
|
|
2849
|
-
*
|
|
2919
|
+
* Aggregated stats for files updated.
|
|
2850
2920
|
*/
|
|
2851
|
-
|
|
2921
|
+
filesUpdate: Metric[];
|
|
2852
2922
|
/**
|
|
2853
|
-
*
|
|
2923
|
+
* Aggregated stats for files deleted.
|
|
2854
2924
|
*/
|
|
2855
|
-
|
|
2925
|
+
filesDelete: Metric[];
|
|
2926
|
+
}
|
|
2927
|
+
/**
|
|
2928
|
+
* UsageFunctions
|
|
2929
|
+
*/
|
|
2930
|
+
export type UsageFunctions = {
|
|
2856
2931
|
/**
|
|
2857
|
-
*
|
|
2932
|
+
* The time range of the usage stats.
|
|
2858
2933
|
*/
|
|
2859
|
-
|
|
2934
|
+
range: string;
|
|
2860
2935
|
/**
|
|
2861
|
-
* Aggregated number of function
|
|
2936
|
+
* Aggregated stats for number of function executions.
|
|
2862
2937
|
*/
|
|
2863
|
-
|
|
2938
|
+
executionsTotal: Metric[];
|
|
2864
2939
|
/**
|
|
2865
|
-
* Aggregated
|
|
2940
|
+
* Aggregated stats for function execution failures.
|
|
2866
2941
|
*/
|
|
2867
|
-
|
|
2942
|
+
executionsFailure: Metric[];
|
|
2868
2943
|
/**
|
|
2869
|
-
* Aggregated
|
|
2944
|
+
* Aggregated stats for function execution successes.
|
|
2870
2945
|
*/
|
|
2871
|
-
|
|
2946
|
+
executionsSuccess: Metric[];
|
|
2872
2947
|
/**
|
|
2873
|
-
* Aggregated
|
|
2948
|
+
* Aggregated stats for function execution duration.
|
|
2874
2949
|
*/
|
|
2875
|
-
|
|
2950
|
+
executionsTime: Metric[];
|
|
2876
2951
|
/**
|
|
2877
|
-
* Aggregated
|
|
2952
|
+
* Aggregated stats for number of function builds.
|
|
2878
2953
|
*/
|
|
2879
|
-
|
|
2954
|
+
buildsTotal: Metric[];
|
|
2880
2955
|
/**
|
|
2881
|
-
* Aggregated
|
|
2956
|
+
* Aggregated stats for function build failures.
|
|
2882
2957
|
*/
|
|
2883
|
-
|
|
2958
|
+
buildsFailure: Metric[];
|
|
2884
2959
|
/**
|
|
2885
|
-
* Aggregated
|
|
2960
|
+
* Aggregated stats for function build successes.
|
|
2886
2961
|
*/
|
|
2887
|
-
|
|
2962
|
+
buildsSuccess: Metric[];
|
|
2963
|
+
/**
|
|
2964
|
+
* Aggregated stats for function build duration.
|
|
2965
|
+
*/
|
|
2966
|
+
buildsTime: Metric[];
|
|
2888
2967
|
}
|
|
2889
2968
|
/**
|
|
2890
2969
|
* UsageProject
|
|
2891
2970
|
*/
|
|
2892
2971
|
export type UsageProject = {
|
|
2893
2972
|
/**
|
|
2894
|
-
*
|
|
2895
|
-
*/
|
|
2896
|
-
executionsTotal: number;
|
|
2897
|
-
/**
|
|
2898
|
-
* Total aggregated number of documents.
|
|
2899
|
-
*/
|
|
2900
|
-
documentsTotal: number;
|
|
2901
|
-
/**
|
|
2902
|
-
* Total aggregated number of databases.
|
|
2973
|
+
* The time range of the usage stats.
|
|
2903
2974
|
*/
|
|
2904
|
-
|
|
2975
|
+
range: string;
|
|
2905
2976
|
/**
|
|
2906
|
-
*
|
|
2977
|
+
* Aggregated stats for number of requests.
|
|
2907
2978
|
*/
|
|
2908
|
-
|
|
2979
|
+
requests: Metric[];
|
|
2909
2980
|
/**
|
|
2910
|
-
*
|
|
2981
|
+
* Aggregated stats for consumed bandwidth.
|
|
2911
2982
|
*/
|
|
2912
|
-
|
|
2983
|
+
network: Metric[];
|
|
2913
2984
|
/**
|
|
2914
|
-
*
|
|
2985
|
+
* Aggregated stats for function executions.
|
|
2915
2986
|
*/
|
|
2916
|
-
|
|
2987
|
+
executions: Metric[];
|
|
2917
2988
|
/**
|
|
2918
|
-
* Aggregated
|
|
2989
|
+
* Aggregated stats for number of documents.
|
|
2919
2990
|
*/
|
|
2920
|
-
|
|
2991
|
+
documents: Metric[];
|
|
2921
2992
|
/**
|
|
2922
|
-
* Aggregated number of
|
|
2993
|
+
* Aggregated stats for number of databases.
|
|
2923
2994
|
*/
|
|
2924
|
-
|
|
2995
|
+
databases: Metric[];
|
|
2925
2996
|
/**
|
|
2926
|
-
* Aggregated number of users
|
|
2997
|
+
* Aggregated stats for number of users.
|
|
2927
2998
|
*/
|
|
2928
2999
|
users: Metric[];
|
|
2929
3000
|
/**
|
|
2930
|
-
* Aggregated
|
|
3001
|
+
* Aggregated stats for the occupied storage size (in bytes).
|
|
2931
3002
|
*/
|
|
2932
|
-
|
|
2933
|
-
/**
|
|
2934
|
-
* Aggregated breakdown in totals of executions by functions.
|
|
2935
|
-
*/
|
|
2936
|
-
executionsBreakdown: MetricBreakdown[];
|
|
3003
|
+
storage: Metric[];
|
|
2937
3004
|
/**
|
|
2938
|
-
* Aggregated
|
|
3005
|
+
* Aggregated stats for number of buckets.
|
|
2939
3006
|
*/
|
|
2940
|
-
|
|
3007
|
+
buckets: Metric[];
|
|
2941
3008
|
}
|
|
2942
3009
|
/**
|
|
2943
3010
|
* Headers
|
|
@@ -3076,6 +3143,270 @@ export namespace Models {
|
|
|
3076
3143
|
*/
|
|
3077
3144
|
_APP_ASSISTANT_ENABLED: boolean;
|
|
3078
3145
|
}
|
|
3146
|
+
/**
|
|
3147
|
+
* MFA Challenge
|
|
3148
|
+
*/
|
|
3149
|
+
export type MfaChallenge = {
|
|
3150
|
+
/**
|
|
3151
|
+
* Token ID.
|
|
3152
|
+
*/
|
|
3153
|
+
$id: string;
|
|
3154
|
+
/**
|
|
3155
|
+
* Token creation date in ISO 8601 format.
|
|
3156
|
+
*/
|
|
3157
|
+
$createdAt: string;
|
|
3158
|
+
/**
|
|
3159
|
+
* User ID.
|
|
3160
|
+
*/
|
|
3161
|
+
userId: string;
|
|
3162
|
+
/**
|
|
3163
|
+
* Token expiration date in ISO 8601 format.
|
|
3164
|
+
*/
|
|
3165
|
+
expire: string;
|
|
3166
|
+
}
|
|
3167
|
+
/**
|
|
3168
|
+
* MFAProvider
|
|
3169
|
+
*/
|
|
3170
|
+
export type MfaProvider = {
|
|
3171
|
+
/**
|
|
3172
|
+
* backup codes
|
|
3173
|
+
*/
|
|
3174
|
+
backups: string[];
|
|
3175
|
+
/**
|
|
3176
|
+
* secret used for top auth
|
|
3177
|
+
*/
|
|
3178
|
+
secret: string;
|
|
3179
|
+
/**
|
|
3180
|
+
* uri for otp app
|
|
3181
|
+
*/
|
|
3182
|
+
uri: string;
|
|
3183
|
+
}
|
|
3184
|
+
/**
|
|
3185
|
+
* MFAProviders
|
|
3186
|
+
*/
|
|
3187
|
+
export type MfaProviders = {
|
|
3188
|
+
/**
|
|
3189
|
+
* TOTP
|
|
3190
|
+
*/
|
|
3191
|
+
totp: boolean;
|
|
3192
|
+
/**
|
|
3193
|
+
* Phone
|
|
3194
|
+
*/
|
|
3195
|
+
phone: boolean;
|
|
3196
|
+
/**
|
|
3197
|
+
* Email
|
|
3198
|
+
*/
|
|
3199
|
+
email: boolean;
|
|
3200
|
+
}
|
|
3201
|
+
/**
|
|
3202
|
+
* Provider
|
|
3203
|
+
*/
|
|
3204
|
+
export type Provider = {
|
|
3205
|
+
/**
|
|
3206
|
+
* Provider ID.
|
|
3207
|
+
*/
|
|
3208
|
+
$id: string;
|
|
3209
|
+
/**
|
|
3210
|
+
* Provider creation time in ISO 8601 format.
|
|
3211
|
+
*/
|
|
3212
|
+
$createdAt: string;
|
|
3213
|
+
/**
|
|
3214
|
+
* Provider update date in ISO 8601 format.
|
|
3215
|
+
*/
|
|
3216
|
+
$updatedAt: string;
|
|
3217
|
+
/**
|
|
3218
|
+
* The name for the provider instance.
|
|
3219
|
+
*/
|
|
3220
|
+
name: string;
|
|
3221
|
+
/**
|
|
3222
|
+
* The name of the provider service.
|
|
3223
|
+
*/
|
|
3224
|
+
provider: string;
|
|
3225
|
+
/**
|
|
3226
|
+
* Is provider enabled?
|
|
3227
|
+
*/
|
|
3228
|
+
enabled: boolean;
|
|
3229
|
+
/**
|
|
3230
|
+
* Type of provider.
|
|
3231
|
+
*/
|
|
3232
|
+
type: string;
|
|
3233
|
+
/**
|
|
3234
|
+
* Provider credentials.
|
|
3235
|
+
*/
|
|
3236
|
+
credentials: object;
|
|
3237
|
+
/**
|
|
3238
|
+
* Provider options.
|
|
3239
|
+
*/
|
|
3240
|
+
options?: object;
|
|
3241
|
+
}
|
|
3242
|
+
/**
|
|
3243
|
+
* Message
|
|
3244
|
+
*/
|
|
3245
|
+
export type Message = {
|
|
3246
|
+
/**
|
|
3247
|
+
* Message ID.
|
|
3248
|
+
*/
|
|
3249
|
+
$id: string;
|
|
3250
|
+
/**
|
|
3251
|
+
* Message creation time in ISO 8601 format.
|
|
3252
|
+
*/
|
|
3253
|
+
$createdAt: string;
|
|
3254
|
+
/**
|
|
3255
|
+
* Message update date in ISO 8601 format.
|
|
3256
|
+
*/
|
|
3257
|
+
$updatedAt: string;
|
|
3258
|
+
/**
|
|
3259
|
+
* Message provider type.
|
|
3260
|
+
*/
|
|
3261
|
+
providerType: string;
|
|
3262
|
+
/**
|
|
3263
|
+
* Topic IDs set as recipients.
|
|
3264
|
+
*/
|
|
3265
|
+
topics: string[];
|
|
3266
|
+
/**
|
|
3267
|
+
* User IDs set as recipients.
|
|
3268
|
+
*/
|
|
3269
|
+
users: string[];
|
|
3270
|
+
/**
|
|
3271
|
+
* Target IDs set as recipients.
|
|
3272
|
+
*/
|
|
3273
|
+
targets: string[];
|
|
3274
|
+
/**
|
|
3275
|
+
* The scheduled time for message.
|
|
3276
|
+
*/
|
|
3277
|
+
scheduledAt?: string;
|
|
3278
|
+
/**
|
|
3279
|
+
* The time when the message was delivered.
|
|
3280
|
+
*/
|
|
3281
|
+
deliveredAt?: string;
|
|
3282
|
+
/**
|
|
3283
|
+
* Delivery errors if any.
|
|
3284
|
+
*/
|
|
3285
|
+
deliveryErrors?: string[];
|
|
3286
|
+
/**
|
|
3287
|
+
* Number of recipients the message was delivered to.
|
|
3288
|
+
*/
|
|
3289
|
+
deliveredTotal: number;
|
|
3290
|
+
/**
|
|
3291
|
+
* Data of the message.
|
|
3292
|
+
*/
|
|
3293
|
+
data: object;
|
|
3294
|
+
/**
|
|
3295
|
+
* Status of delivery.
|
|
3296
|
+
*/
|
|
3297
|
+
status: string;
|
|
3298
|
+
/**
|
|
3299
|
+
* Message description.
|
|
3300
|
+
*/
|
|
3301
|
+
description?: string;
|
|
3302
|
+
}
|
|
3303
|
+
/**
|
|
3304
|
+
* Topic
|
|
3305
|
+
*/
|
|
3306
|
+
export type Topic = {
|
|
3307
|
+
/**
|
|
3308
|
+
* Topic ID.
|
|
3309
|
+
*/
|
|
3310
|
+
$id: string;
|
|
3311
|
+
/**
|
|
3312
|
+
* Topic creation time in ISO 8601 format.
|
|
3313
|
+
*/
|
|
3314
|
+
$createdAt: string;
|
|
3315
|
+
/**
|
|
3316
|
+
* Topic update date in ISO 8601 format.
|
|
3317
|
+
*/
|
|
3318
|
+
$updatedAt: string;
|
|
3319
|
+
/**
|
|
3320
|
+
* The name of the topic.
|
|
3321
|
+
*/
|
|
3322
|
+
name: string;
|
|
3323
|
+
/**
|
|
3324
|
+
* Total count of subscribers subscribed to topic.
|
|
3325
|
+
*/
|
|
3326
|
+
total: number;
|
|
3327
|
+
/**
|
|
3328
|
+
* Description of the topic.
|
|
3329
|
+
*/
|
|
3330
|
+
description?: string;
|
|
3331
|
+
}
|
|
3332
|
+
/**
|
|
3333
|
+
* Subscriber
|
|
3334
|
+
*/
|
|
3335
|
+
export type Subscriber = {
|
|
3336
|
+
/**
|
|
3337
|
+
* Subscriber ID.
|
|
3338
|
+
*/
|
|
3339
|
+
$id: string;
|
|
3340
|
+
/**
|
|
3341
|
+
* Subscriber creation time in ISO 8601 format.
|
|
3342
|
+
*/
|
|
3343
|
+
$createdAt: string;
|
|
3344
|
+
/**
|
|
3345
|
+
* Subscriber update date in ISO 8601 format.
|
|
3346
|
+
*/
|
|
3347
|
+
$updatedAt: string;
|
|
3348
|
+
/**
|
|
3349
|
+
* Target ID.
|
|
3350
|
+
*/
|
|
3351
|
+
targetId: string;
|
|
3352
|
+
/**
|
|
3353
|
+
* Target.
|
|
3354
|
+
*/
|
|
3355
|
+
target: Target;
|
|
3356
|
+
/**
|
|
3357
|
+
* Topic ID.
|
|
3358
|
+
*/
|
|
3359
|
+
userId: string;
|
|
3360
|
+
/**
|
|
3361
|
+
* User Name.
|
|
3362
|
+
*/
|
|
3363
|
+
userName: string;
|
|
3364
|
+
/**
|
|
3365
|
+
* Topic ID.
|
|
3366
|
+
*/
|
|
3367
|
+
topicId: string;
|
|
3368
|
+
/**
|
|
3369
|
+
* The target provider type. Can be one of the following: `email`, `sms` or `push`.
|
|
3370
|
+
*/
|
|
3371
|
+
providerType: string;
|
|
3372
|
+
}
|
|
3373
|
+
/**
|
|
3374
|
+
* Target
|
|
3375
|
+
*/
|
|
3376
|
+
export type Target = {
|
|
3377
|
+
/**
|
|
3378
|
+
* Target ID.
|
|
3379
|
+
*/
|
|
3380
|
+
$id: string;
|
|
3381
|
+
/**
|
|
3382
|
+
* Target creation time in ISO 8601 format.
|
|
3383
|
+
*/
|
|
3384
|
+
$createdAt: string;
|
|
3385
|
+
/**
|
|
3386
|
+
* Target update date in ISO 8601 format.
|
|
3387
|
+
*/
|
|
3388
|
+
$updatedAt: string;
|
|
3389
|
+
/**
|
|
3390
|
+
* Target Name.
|
|
3391
|
+
*/
|
|
3392
|
+
name: string;
|
|
3393
|
+
/**
|
|
3394
|
+
* User ID.
|
|
3395
|
+
*/
|
|
3396
|
+
userId: string;
|
|
3397
|
+
/**
|
|
3398
|
+
* Provider ID.
|
|
3399
|
+
*/
|
|
3400
|
+
providerId?: string;
|
|
3401
|
+
/**
|
|
3402
|
+
* The target provider type. Can be one of the following: `email`, `sms` or `push`.
|
|
3403
|
+
*/
|
|
3404
|
+
providerType: string;
|
|
3405
|
+
/**
|
|
3406
|
+
* The target identifier.
|
|
3407
|
+
*/
|
|
3408
|
+
identifier: string;
|
|
3409
|
+
}
|
|
3079
3410
|
/**
|
|
3080
3411
|
* Migration
|
|
3081
3412
|
*/
|