@appwrite.io/console 8.2.0 → 9.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.
- package/README.md +2 -2
- package/dist/cjs/sdk.js +1198 -856
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +1199 -857
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +1200 -858
- package/package.json +1 -1
- package/types/enums/addon.d.ts +3 -0
- package/types/enums/o-auth-provider.d.ts +1 -0
- package/types/enums/platform-type.d.ts +4 -14
- package/types/enums/protocol-id.d.ts +5 -0
- package/types/enums/scopes.d.ts +4 -4
- package/types/enums/{api-service.d.ts → service-id.d.ts} +5 -1
- package/types/index.d.ts +4 -3
- package/types/models.d.ts +312 -40
- package/types/services/account.d.ts +4 -4
- package/types/services/databases.d.ts +6 -3
- package/types/services/migrations.d.ts +8 -0
- package/types/services/organizations.d.ts +139 -0
- package/types/services/project.d.ts +549 -0
- package/types/services/projects.d.ts +0 -433
- package/types/services/tables-db.d.ts +6 -3
- package/types/services/webhooks.d.ts +26 -26
- package/types/enums/api.d.ts +0 -5
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@appwrite.io/console",
|
|
3
3
|
"homepage": "https://appwrite.io/support",
|
|
4
4
|
"description": "Appwrite is an open-source self-hosted backend server that abstracts and simplifies complex and repetitive development tasks behind a very simple REST API",
|
|
5
|
-
"version": "
|
|
5
|
+
"version": "9.0.0",
|
|
6
6
|
"license": "BSD-3-Clause",
|
|
7
7
|
"main": "dist/cjs/sdk.js",
|
|
8
8
|
"exports": {
|
|
@@ -1,17 +1,7 @@
|
|
|
1
1
|
export declare enum PlatformType {
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
Flutterios = "flutter-ios",
|
|
5
|
-
Flutterandroid = "flutter-android",
|
|
6
|
-
Flutterlinux = "flutter-linux",
|
|
7
|
-
Fluttermacos = "flutter-macos",
|
|
8
|
-
Flutterwindows = "flutter-windows",
|
|
9
|
-
Appleios = "apple-ios",
|
|
10
|
-
Applemacos = "apple-macos",
|
|
11
|
-
Applewatchos = "apple-watchos",
|
|
12
|
-
Appletvos = "apple-tvos",
|
|
2
|
+
Windows = "windows",
|
|
3
|
+
Apple = "apple",
|
|
13
4
|
Android = "android",
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
Reactnativeandroid = "react-native-android"
|
|
5
|
+
Linux = "linux",
|
|
6
|
+
Web = "web"
|
|
17
7
|
}
|
package/types/enums/scopes.d.ts
CHANGED
|
@@ -61,6 +61,10 @@ export declare enum Scopes {
|
|
|
61
61
|
WebhooksWrite = "webhooks.write",
|
|
62
62
|
ProjectRead = "project.read",
|
|
63
63
|
ProjectWrite = "project.write",
|
|
64
|
+
KeysRead = "keys.read",
|
|
65
|
+
KeysWrite = "keys.write",
|
|
66
|
+
PlatformsRead = "platforms.read",
|
|
67
|
+
PlatformsWrite = "platforms.write",
|
|
64
68
|
PoliciesWrite = "policies.write",
|
|
65
69
|
PoliciesRead = "policies.read",
|
|
66
70
|
ArchivesRead = "archives.read",
|
|
@@ -70,12 +74,8 @@ export declare enum Scopes {
|
|
|
70
74
|
DomainsRead = "domains.read",
|
|
71
75
|
DomainsWrite = "domains.write",
|
|
72
76
|
EventsRead = "events.read",
|
|
73
|
-
PlatformsRead = "platforms.read",
|
|
74
|
-
PlatformsWrite = "platforms.write",
|
|
75
77
|
ProjectsRead = "projects.read",
|
|
76
78
|
ProjectsWrite = "projects.write",
|
|
77
|
-
KeysRead = "keys.read",
|
|
78
|
-
KeysWrite = "keys.write",
|
|
79
79
|
DevKeysRead = "devKeys.read",
|
|
80
80
|
DevKeysWrite = "devKeys.write"
|
|
81
81
|
}
|
|
@@ -1,15 +1,19 @@
|
|
|
1
|
-
export declare enum
|
|
1
|
+
export declare enum ServiceId {
|
|
2
2
|
Account = "account",
|
|
3
3
|
Avatars = "avatars",
|
|
4
4
|
Databases = "databases",
|
|
5
5
|
Tablesdb = "tablesdb",
|
|
6
6
|
Locale = "locale",
|
|
7
7
|
Health = "health",
|
|
8
|
+
Project = "project",
|
|
8
9
|
Storage = "storage",
|
|
9
10
|
Teams = "teams",
|
|
10
11
|
Users = "users",
|
|
12
|
+
Vcs = "vcs",
|
|
11
13
|
Sites = "sites",
|
|
12
14
|
Functions = "functions",
|
|
15
|
+
Proxy = "proxy",
|
|
13
16
|
Graphql = "graphql",
|
|
17
|
+
Migrations = "migrations",
|
|
14
18
|
Messaging = "messaging"
|
|
15
19
|
}
|
package/types/index.d.ts
CHANGED
|
@@ -76,13 +76,13 @@ export { AppwriteMigrationResource } from './enums/appwrite-migration-resource';
|
|
|
76
76
|
export { FirebaseMigrationResource } from './enums/firebase-migration-resource';
|
|
77
77
|
export { NHostMigrationResource } from './enums/n-host-migration-resource';
|
|
78
78
|
export { SupabaseMigrationResource } from './enums/supabase-migration-resource';
|
|
79
|
+
export { Addon } from './enums/addon';
|
|
80
|
+
export { ProtocolId } from './enums/protocol-id';
|
|
81
|
+
export { ServiceId } from './enums/service-id';
|
|
79
82
|
export { ProjectUsageRange } from './enums/project-usage-range';
|
|
80
83
|
export { Region } from './enums/region';
|
|
81
|
-
export { Api } from './enums/api';
|
|
82
84
|
export { AuthMethod } from './enums/auth-method';
|
|
83
|
-
export { PlatformType } from './enums/platform-type';
|
|
84
85
|
export { ResourceType } from './enums/resource-type';
|
|
85
|
-
export { ApiService } from './enums/api-service';
|
|
86
86
|
export { SMTPSecure } from './enums/smtp-secure';
|
|
87
87
|
export { Status } from './enums/status';
|
|
88
88
|
export { EmailTemplateType } from './enums/email-template-type';
|
|
@@ -108,6 +108,7 @@ export { IndexStatus } from './enums/index-status';
|
|
|
108
108
|
export { DeploymentStatus } from './enums/deployment-status';
|
|
109
109
|
export { ExecutionTrigger } from './enums/execution-trigger';
|
|
110
110
|
export { ExecutionStatus } from './enums/execution-status';
|
|
111
|
+
export { PlatformType } from './enums/platform-type';
|
|
111
112
|
export { HealthAntivirusStatus } from './enums/health-antivirus-status';
|
|
112
113
|
export { HealthCheckStatus } from './enums/health-check-status';
|
|
113
114
|
export { ProxyRuleDeploymentResourceType } from './enums/proxy-rule-deployment-resource-type';
|
package/types/models.d.ts
CHANGED
|
@@ -435,19 +435,6 @@ export declare namespace Models {
|
|
|
435
435
|
*/
|
|
436
436
|
devKeys: DevKey[];
|
|
437
437
|
};
|
|
438
|
-
/**
|
|
439
|
-
* Platforms List
|
|
440
|
-
*/
|
|
441
|
-
export type PlatformList = {
|
|
442
|
-
/**
|
|
443
|
-
* Total number of platforms that matched your query.
|
|
444
|
-
*/
|
|
445
|
-
total: number;
|
|
446
|
-
/**
|
|
447
|
-
* List of platforms.
|
|
448
|
-
*/
|
|
449
|
-
platforms: Platform[];
|
|
450
|
-
};
|
|
451
438
|
/**
|
|
452
439
|
* Countries List
|
|
453
440
|
*/
|
|
@@ -2622,6 +2609,10 @@ export declare namespace Models {
|
|
|
2622
2609
|
* API mode when event triggered.
|
|
2623
2610
|
*/
|
|
2624
2611
|
mode: string;
|
|
2612
|
+
/**
|
|
2613
|
+
* User type who triggered the audit log. Possible values: user, admin, guest, keyProject, keyAccount, keyOrganization.
|
|
2614
|
+
*/
|
|
2615
|
+
userType: string;
|
|
2625
2616
|
/**
|
|
2626
2617
|
* IP session in use when the session was created.
|
|
2627
2618
|
*/
|
|
@@ -4475,6 +4466,18 @@ export declare namespace Models {
|
|
|
4475
4466
|
* Whether or not to check the user password for similarity with their personal data.
|
|
4476
4467
|
*/
|
|
4477
4468
|
authPersonalDataCheck: boolean;
|
|
4469
|
+
/**
|
|
4470
|
+
* Whether or not to disallow disposable email addresses during signup and email updates.
|
|
4471
|
+
*/
|
|
4472
|
+
authDisposableEmails: boolean;
|
|
4473
|
+
/**
|
|
4474
|
+
* Whether or not to require canonical email addresses during signup and email updates.
|
|
4475
|
+
*/
|
|
4476
|
+
authCanonicalEmails: boolean;
|
|
4477
|
+
/**
|
|
4478
|
+
* Whether or not to disallow free email addresses during signup and email updates.
|
|
4479
|
+
*/
|
|
4480
|
+
authFreeEmails: boolean;
|
|
4478
4481
|
/**
|
|
4479
4482
|
* An array of mock numbers and their corresponding verification codes (OTPs).
|
|
4480
4483
|
*/
|
|
@@ -4506,7 +4509,7 @@ export declare namespace Models {
|
|
|
4506
4509
|
/**
|
|
4507
4510
|
* List of Platforms.
|
|
4508
4511
|
*/
|
|
4509
|
-
platforms:
|
|
4512
|
+
platforms: (Models.PlatformWeb | Models.PlatformApple | Models.PlatformAndroid | Models.PlatformWindows | Models.PlatformLinux)[];
|
|
4510
4513
|
/**
|
|
4511
4514
|
* List of Webhooks.
|
|
4512
4515
|
*/
|
|
@@ -4623,6 +4626,10 @@ export declare namespace Models {
|
|
|
4623
4626
|
* Health service status
|
|
4624
4627
|
*/
|
|
4625
4628
|
serviceStatusForHealth: boolean;
|
|
4629
|
+
/**
|
|
4630
|
+
* Project service status
|
|
4631
|
+
*/
|
|
4632
|
+
serviceStatusForProject: boolean;
|
|
4626
4633
|
/**
|
|
4627
4634
|
* Storage service status
|
|
4628
4635
|
*/
|
|
@@ -4635,6 +4642,10 @@ export declare namespace Models {
|
|
|
4635
4642
|
* Users service status
|
|
4636
4643
|
*/
|
|
4637
4644
|
serviceStatusForUsers: boolean;
|
|
4645
|
+
/**
|
|
4646
|
+
* VCS service status
|
|
4647
|
+
*/
|
|
4648
|
+
serviceStatusForVcs: boolean;
|
|
4638
4649
|
/**
|
|
4639
4650
|
* Sites service status
|
|
4640
4651
|
*/
|
|
@@ -4643,14 +4654,34 @@ export declare namespace Models {
|
|
|
4643
4654
|
* Functions service status
|
|
4644
4655
|
*/
|
|
4645
4656
|
serviceStatusForFunctions: boolean;
|
|
4657
|
+
/**
|
|
4658
|
+
* Proxy service status
|
|
4659
|
+
*/
|
|
4660
|
+
serviceStatusForProxy: boolean;
|
|
4646
4661
|
/**
|
|
4647
4662
|
* GraphQL service status
|
|
4648
4663
|
*/
|
|
4649
4664
|
serviceStatusForGraphql: boolean;
|
|
4665
|
+
/**
|
|
4666
|
+
* Migrations service status
|
|
4667
|
+
*/
|
|
4668
|
+
serviceStatusForMigrations: boolean;
|
|
4650
4669
|
/**
|
|
4651
4670
|
* Messaging service status
|
|
4652
4671
|
*/
|
|
4653
4672
|
serviceStatusForMessaging: boolean;
|
|
4673
|
+
/**
|
|
4674
|
+
* REST protocol status
|
|
4675
|
+
*/
|
|
4676
|
+
protocolStatusForRest: boolean;
|
|
4677
|
+
/**
|
|
4678
|
+
* GraphQL protocol status
|
|
4679
|
+
*/
|
|
4680
|
+
protocolStatusForGraphql: boolean;
|
|
4681
|
+
/**
|
|
4682
|
+
* Websocket protocol status
|
|
4683
|
+
*/
|
|
4684
|
+
protocolStatusForWebsocket: boolean;
|
|
4654
4685
|
/**
|
|
4655
4686
|
* Project region
|
|
4656
4687
|
*/
|
|
@@ -4697,21 +4728,21 @@ export declare namespace Models {
|
|
|
4697
4728
|
*/
|
|
4698
4729
|
events: string[];
|
|
4699
4730
|
/**
|
|
4700
|
-
*
|
|
4731
|
+
* Indicates if SSL / TLS certificate verification is enabled.
|
|
4701
4732
|
*/
|
|
4702
|
-
|
|
4733
|
+
tls: boolean;
|
|
4703
4734
|
/**
|
|
4704
4735
|
* HTTP basic authentication username.
|
|
4705
4736
|
*/
|
|
4706
|
-
|
|
4737
|
+
authUsername: string;
|
|
4707
4738
|
/**
|
|
4708
4739
|
* HTTP basic authentication password.
|
|
4709
4740
|
*/
|
|
4710
|
-
|
|
4741
|
+
authPassword: string;
|
|
4711
4742
|
/**
|
|
4712
|
-
* Signature key which can be used to
|
|
4743
|
+
* Signature key which can be used to validate incoming webhook payloads.
|
|
4713
4744
|
*/
|
|
4714
|
-
|
|
4745
|
+
secret: string;
|
|
4715
4746
|
/**
|
|
4716
4747
|
* Indicates if this webhook is enabled.
|
|
4717
4748
|
*/
|
|
@@ -4842,9 +4873,9 @@ export declare namespace Models {
|
|
|
4842
4873
|
enabled: boolean;
|
|
4843
4874
|
};
|
|
4844
4875
|
/**
|
|
4845
|
-
* Platform
|
|
4876
|
+
* Platform Web
|
|
4846
4877
|
*/
|
|
4847
|
-
export type
|
|
4878
|
+
export type PlatformWeb = {
|
|
4848
4879
|
/**
|
|
4849
4880
|
* Platform ID.
|
|
4850
4881
|
*/
|
|
@@ -4862,29 +4893,142 @@ export declare namespace Models {
|
|
|
4862
4893
|
*/
|
|
4863
4894
|
name: string;
|
|
4864
4895
|
/**
|
|
4865
|
-
* Platform type. Possible values are:
|
|
4896
|
+
* Platform type. Possible values are: windows, apple, android, linux, web.
|
|
4866
4897
|
*/
|
|
4867
4898
|
type: PlatformType;
|
|
4868
4899
|
/**
|
|
4869
|
-
*
|
|
4900
|
+
* Web app hostname. Empty string for other platforms.
|
|
4870
4901
|
*/
|
|
4871
|
-
|
|
4902
|
+
hostname: string;
|
|
4903
|
+
};
|
|
4904
|
+
/**
|
|
4905
|
+
* Platform Apple
|
|
4906
|
+
*/
|
|
4907
|
+
export type PlatformApple = {
|
|
4872
4908
|
/**
|
|
4873
|
-
*
|
|
4909
|
+
* Platform ID.
|
|
4874
4910
|
*/
|
|
4875
|
-
|
|
4911
|
+
$id: string;
|
|
4876
4912
|
/**
|
|
4877
|
-
*
|
|
4913
|
+
* Platform creation date in ISO 8601 format.
|
|
4878
4914
|
*/
|
|
4879
|
-
|
|
4915
|
+
$createdAt: string;
|
|
4880
4916
|
/**
|
|
4881
|
-
*
|
|
4917
|
+
* Platform update date in ISO 8601 format.
|
|
4882
4918
|
*/
|
|
4883
|
-
|
|
4919
|
+
$updatedAt: string;
|
|
4884
4920
|
/**
|
|
4885
|
-
*
|
|
4921
|
+
* Platform name.
|
|
4922
|
+
*/
|
|
4923
|
+
name: string;
|
|
4924
|
+
/**
|
|
4925
|
+
* Platform type. Possible values are: windows, apple, android, linux, web.
|
|
4926
|
+
*/
|
|
4927
|
+
type: PlatformType;
|
|
4928
|
+
/**
|
|
4929
|
+
* Apple bundle identifier.
|
|
4930
|
+
*/
|
|
4931
|
+
bundleIdentifier: string;
|
|
4932
|
+
};
|
|
4933
|
+
/**
|
|
4934
|
+
* Platform Android
|
|
4935
|
+
*/
|
|
4936
|
+
export type PlatformAndroid = {
|
|
4937
|
+
/**
|
|
4938
|
+
* Platform ID.
|
|
4939
|
+
*/
|
|
4940
|
+
$id: string;
|
|
4941
|
+
/**
|
|
4942
|
+
* Platform creation date in ISO 8601 format.
|
|
4943
|
+
*/
|
|
4944
|
+
$createdAt: string;
|
|
4945
|
+
/**
|
|
4946
|
+
* Platform update date in ISO 8601 format.
|
|
4947
|
+
*/
|
|
4948
|
+
$updatedAt: string;
|
|
4949
|
+
/**
|
|
4950
|
+
* Platform name.
|
|
4951
|
+
*/
|
|
4952
|
+
name: string;
|
|
4953
|
+
/**
|
|
4954
|
+
* Platform type. Possible values are: windows, apple, android, linux, web.
|
|
4955
|
+
*/
|
|
4956
|
+
type: PlatformType;
|
|
4957
|
+
/**
|
|
4958
|
+
* Android application ID.
|
|
4959
|
+
*/
|
|
4960
|
+
applicationId: string;
|
|
4961
|
+
};
|
|
4962
|
+
/**
|
|
4963
|
+
* Platform Windows
|
|
4964
|
+
*/
|
|
4965
|
+
export type PlatformWindows = {
|
|
4966
|
+
/**
|
|
4967
|
+
* Platform ID.
|
|
4968
|
+
*/
|
|
4969
|
+
$id: string;
|
|
4970
|
+
/**
|
|
4971
|
+
* Platform creation date in ISO 8601 format.
|
|
4972
|
+
*/
|
|
4973
|
+
$createdAt: string;
|
|
4974
|
+
/**
|
|
4975
|
+
* Platform update date in ISO 8601 format.
|
|
4976
|
+
*/
|
|
4977
|
+
$updatedAt: string;
|
|
4978
|
+
/**
|
|
4979
|
+
* Platform name.
|
|
4980
|
+
*/
|
|
4981
|
+
name: string;
|
|
4982
|
+
/**
|
|
4983
|
+
* Platform type. Possible values are: windows, apple, android, linux, web.
|
|
4984
|
+
*/
|
|
4985
|
+
type: PlatformType;
|
|
4986
|
+
/**
|
|
4987
|
+
* Windows package identifier name.
|
|
4988
|
+
*/
|
|
4989
|
+
packageIdentifierName: string;
|
|
4990
|
+
};
|
|
4991
|
+
/**
|
|
4992
|
+
* Platform Linux
|
|
4993
|
+
*/
|
|
4994
|
+
export type PlatformLinux = {
|
|
4995
|
+
/**
|
|
4996
|
+
* Platform ID.
|
|
4997
|
+
*/
|
|
4998
|
+
$id: string;
|
|
4999
|
+
/**
|
|
5000
|
+
* Platform creation date in ISO 8601 format.
|
|
5001
|
+
*/
|
|
5002
|
+
$createdAt: string;
|
|
5003
|
+
/**
|
|
5004
|
+
* Platform update date in ISO 8601 format.
|
|
5005
|
+
*/
|
|
5006
|
+
$updatedAt: string;
|
|
5007
|
+
/**
|
|
5008
|
+
* Platform name.
|
|
4886
5009
|
*/
|
|
4887
|
-
|
|
5010
|
+
name: string;
|
|
5011
|
+
/**
|
|
5012
|
+
* Platform type. Possible values are: windows, apple, android, linux, web.
|
|
5013
|
+
*/
|
|
5014
|
+
type: PlatformType;
|
|
5015
|
+
/**
|
|
5016
|
+
* Linux package name.
|
|
5017
|
+
*/
|
|
5018
|
+
packageName: string;
|
|
5019
|
+
};
|
|
5020
|
+
/**
|
|
5021
|
+
* Platforms List
|
|
5022
|
+
*/
|
|
5023
|
+
export type PlatformList = {
|
|
5024
|
+
/**
|
|
5025
|
+
* Total number of platforms in the given project.
|
|
5026
|
+
*/
|
|
5027
|
+
total: number;
|
|
5028
|
+
/**
|
|
5029
|
+
* List of platforms.
|
|
5030
|
+
*/
|
|
5031
|
+
platforms: (Models.PlatformWeb | Models.PlatformApple | Models.PlatformAndroid | Models.PlatformWindows | Models.PlatformLinux)[];
|
|
4888
5032
|
};
|
|
4889
5033
|
/**
|
|
4890
5034
|
* Variable
|
|
@@ -6230,27 +6374,27 @@ export declare namespace Models {
|
|
|
6230
6374
|
*/
|
|
6231
6375
|
trigger: string;
|
|
6232
6376
|
/**
|
|
6233
|
-
* URL to redirect to.
|
|
6377
|
+
* URL to redirect to. Used if type is "redirect"
|
|
6234
6378
|
*/
|
|
6235
6379
|
redirectUrl: string;
|
|
6236
6380
|
/**
|
|
6237
|
-
* Status code to apply during redirect.
|
|
6381
|
+
* Status code to apply during redirect. Used if type is "redirect"
|
|
6238
6382
|
*/
|
|
6239
6383
|
redirectStatusCode: number;
|
|
6240
6384
|
/**
|
|
6241
|
-
* ID of deployment.
|
|
6385
|
+
* ID of deployment. Used if type is "deployment"
|
|
6242
6386
|
*/
|
|
6243
6387
|
deploymentId: string;
|
|
6244
6388
|
/**
|
|
6245
|
-
* Type of deployment. Possible values are "function", "site".
|
|
6389
|
+
* Type of deployment. Possible values are "function", "site". Used if rule's type is "deployment".
|
|
6246
6390
|
*/
|
|
6247
|
-
deploymentResourceType
|
|
6391
|
+
deploymentResourceType?: ProxyRuleDeploymentResourceType;
|
|
6248
6392
|
/**
|
|
6249
|
-
* ID
|
|
6393
|
+
* ID deployment's resource. Used if type is "deployment"
|
|
6250
6394
|
*/
|
|
6251
6395
|
deploymentResourceId: string;
|
|
6252
6396
|
/**
|
|
6253
|
-
* Name of Git branch that updates rule.
|
|
6397
|
+
* Name of Git branch that updates rule. Used if type is "deployment"
|
|
6254
6398
|
*/
|
|
6255
6399
|
deploymentVcsProviderBranch: string;
|
|
6256
6400
|
/**
|
|
@@ -6473,6 +6617,10 @@ export declare namespace Models {
|
|
|
6473
6617
|
* Whether the database adapter uses integer sequence IDs.
|
|
6474
6618
|
*/
|
|
6475
6619
|
supportForIntegerIds: boolean;
|
|
6620
|
+
/**
|
|
6621
|
+
* Whether email verification for console users is required. Can be "true" or "false".
|
|
6622
|
+
*/
|
|
6623
|
+
_APP_CONSOLE_EMAIL_VERIFICATION: string;
|
|
6476
6624
|
};
|
|
6477
6625
|
/**
|
|
6478
6626
|
* MFA Challenge
|
|
@@ -7504,6 +7652,18 @@ export declare namespace Models {
|
|
|
7504
7652
|
* Does plan support credit
|
|
7505
7653
|
*/
|
|
7506
7654
|
supportsCredits: boolean;
|
|
7655
|
+
/**
|
|
7656
|
+
* Does plan support blocking disposable email addresses.
|
|
7657
|
+
*/
|
|
7658
|
+
supportsDisposableEmailValidation: boolean;
|
|
7659
|
+
/**
|
|
7660
|
+
* Does plan support requiring canonical email addresses.
|
|
7661
|
+
*/
|
|
7662
|
+
supportsCanonicalEmailValidation: boolean;
|
|
7663
|
+
/**
|
|
7664
|
+
* Does plan support blocking free email addresses.
|
|
7665
|
+
*/
|
|
7666
|
+
supportsFreeEmailValidation: boolean;
|
|
7507
7667
|
/**
|
|
7508
7668
|
* Does plan support backup policies.
|
|
7509
7669
|
*/
|
|
@@ -7512,6 +7672,10 @@ export declare namespace Models {
|
|
|
7512
7672
|
* Whether usage addons are calculated per project.
|
|
7513
7673
|
*/
|
|
7514
7674
|
usagePerProject: boolean;
|
|
7675
|
+
/**
|
|
7676
|
+
* Supported addons for this plan
|
|
7677
|
+
*/
|
|
7678
|
+
supportedAddons: BillingPlanSupportedAddons;
|
|
7515
7679
|
/**
|
|
7516
7680
|
* How many policies does plan support
|
|
7517
7681
|
*/
|
|
@@ -7604,6 +7768,15 @@ export declare namespace Models {
|
|
|
7604
7768
|
*/
|
|
7605
7769
|
dailyCredits?: number;
|
|
7606
7770
|
};
|
|
7771
|
+
/**
|
|
7772
|
+
* BillingPlanSupportedAddons
|
|
7773
|
+
*/
|
|
7774
|
+
export type BillingPlanSupportedAddons = {
|
|
7775
|
+
/**
|
|
7776
|
+
* Whether the plan supports BAA (Business Associate Agreement) addon
|
|
7777
|
+
*/
|
|
7778
|
+
baa: boolean;
|
|
7779
|
+
};
|
|
7607
7780
|
/**
|
|
7608
7781
|
* BillingLimits
|
|
7609
7782
|
*/
|
|
@@ -8175,6 +8348,10 @@ export declare namespace Models {
|
|
|
8175
8348
|
* Invoice ID against which the payment needs to be validated.
|
|
8176
8349
|
*/
|
|
8177
8350
|
invoiceId: string;
|
|
8351
|
+
/**
|
|
8352
|
+
* Addon ID to use when calling the addon validate endpoint. Empty when authentication is not for an addon.
|
|
8353
|
+
*/
|
|
8354
|
+
addonId: string;
|
|
8178
8355
|
};
|
|
8179
8356
|
/**
|
|
8180
8357
|
* paymentMethod
|
|
@@ -9027,6 +9204,88 @@ export declare namespace Models {
|
|
|
9027
9204
|
*/
|
|
9028
9205
|
available: boolean;
|
|
9029
9206
|
};
|
|
9207
|
+
/**
|
|
9208
|
+
* Addon
|
|
9209
|
+
*/
|
|
9210
|
+
export type Addon = {
|
|
9211
|
+
/**
|
|
9212
|
+
* Addon ID.
|
|
9213
|
+
*/
|
|
9214
|
+
$id: string;
|
|
9215
|
+
/**
|
|
9216
|
+
* Addon creation time in ISO 8601 format.
|
|
9217
|
+
*/
|
|
9218
|
+
$createdAt: string;
|
|
9219
|
+
/**
|
|
9220
|
+
* Addon update date in ISO 8601 format.
|
|
9221
|
+
*/
|
|
9222
|
+
$updatedAt: string;
|
|
9223
|
+
/**
|
|
9224
|
+
* Addon permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
9225
|
+
*/
|
|
9226
|
+
$permissions: string[];
|
|
9227
|
+
/**
|
|
9228
|
+
* Addon key
|
|
9229
|
+
*/
|
|
9230
|
+
key: string;
|
|
9231
|
+
/**
|
|
9232
|
+
* Resource type (organization or project)
|
|
9233
|
+
*/
|
|
9234
|
+
resourceType: string;
|
|
9235
|
+
/**
|
|
9236
|
+
* Resource ID
|
|
9237
|
+
*/
|
|
9238
|
+
resourceId: string;
|
|
9239
|
+
/**
|
|
9240
|
+
* Payment status. Possible values: pending (awaiting payment confirmation e.g. 3DS), active (payment confirmed and addon is running).
|
|
9241
|
+
*/
|
|
9242
|
+
status: string;
|
|
9243
|
+
/**
|
|
9244
|
+
* Current value for this billing cycle. For toggle addons: 1 (on) or 0 (off). For numeric addons: the active quantity.
|
|
9245
|
+
*/
|
|
9246
|
+
currentValue: number;
|
|
9247
|
+
/**
|
|
9248
|
+
* Value to apply at the start of the next billing cycle. Null means no change is scheduled. For toggle addons, 0 means the addon will be removed at the next cycle.
|
|
9249
|
+
*/
|
|
9250
|
+
nextValue?: number;
|
|
9251
|
+
};
|
|
9252
|
+
/**
|
|
9253
|
+
* AddonPrice
|
|
9254
|
+
*/
|
|
9255
|
+
export type AddonPrice = {
|
|
9256
|
+
/**
|
|
9257
|
+
* Addon key.
|
|
9258
|
+
*/
|
|
9259
|
+
addonKey: string;
|
|
9260
|
+
/**
|
|
9261
|
+
* Addon display name.
|
|
9262
|
+
*/
|
|
9263
|
+
name: string;
|
|
9264
|
+
/**
|
|
9265
|
+
* Full monthly price of the addon.
|
|
9266
|
+
*/
|
|
9267
|
+
monthlyPrice: number;
|
|
9268
|
+
/**
|
|
9269
|
+
* Calculated prorated amount for the current billing cycle.
|
|
9270
|
+
*/
|
|
9271
|
+
proratedAmount: number;
|
|
9272
|
+
/**
|
|
9273
|
+
* Days remaining in the current billing cycle.
|
|
9274
|
+
*/
|
|
9275
|
+
remainingDays: number;
|
|
9276
|
+
/**
|
|
9277
|
+
* Total days in the billing cycle.
|
|
9278
|
+
*/
|
|
9279
|
+
totalCycleDays: number;
|
|
9280
|
+
/**
|
|
9281
|
+
* Currency code.
|
|
9282
|
+
*/
|
|
9283
|
+
currency: string;
|
|
9284
|
+
/**
|
|
9285
|
+
* When the current billing cycle ends.
|
|
9286
|
+
*/
|
|
9287
|
+
billingCycleEnd: string;
|
|
9288
|
+
};
|
|
9030
9289
|
/**
|
|
9031
9290
|
* domainTransferOut
|
|
9032
9291
|
*/
|
|
@@ -9053,6 +9312,19 @@ export declare namespace Models {
|
|
|
9053
9312
|
*/
|
|
9054
9313
|
timestamp: string;
|
|
9055
9314
|
};
|
|
9315
|
+
/**
|
|
9316
|
+
* Addons list
|
|
9317
|
+
*/
|
|
9318
|
+
export type AddonList = {
|
|
9319
|
+
/**
|
|
9320
|
+
* Total number of addons that matched your query.
|
|
9321
|
+
*/
|
|
9322
|
+
total: number;
|
|
9323
|
+
/**
|
|
9324
|
+
* List of addons.
|
|
9325
|
+
*/
|
|
9326
|
+
addons: Addon[];
|
|
9327
|
+
};
|
|
9056
9328
|
/**
|
|
9057
9329
|
* Activity event list
|
|
9058
9330
|
*/
|
|
@@ -1076,7 +1076,7 @@ export declare class Account {
|
|
|
1076
1076
|
* A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
|
|
1077
1077
|
*
|
|
1078
1078
|
*
|
|
1079
|
-
* @param {OAuthProvider} params.provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.
|
|
1079
|
+
* @param {OAuthProvider} params.provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.
|
|
1080
1080
|
* @param {string} params.success - URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
|
|
1081
1081
|
* @param {string} params.failure - URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
|
|
1082
1082
|
* @param {string[]} params.scopes - A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.
|
|
@@ -1097,7 +1097,7 @@ export declare class Account {
|
|
|
1097
1097
|
* A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
|
|
1098
1098
|
*
|
|
1099
1099
|
*
|
|
1100
|
-
* @param {OAuthProvider} provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.
|
|
1100
|
+
* @param {OAuthProvider} provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.
|
|
1101
1101
|
* @param {string} success - URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
|
|
1102
1102
|
* @param {string} failure - URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
|
|
1103
1103
|
* @param {string[]} scopes - A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.
|
|
@@ -1353,7 +1353,7 @@ export declare class Account {
|
|
|
1353
1353
|
*
|
|
1354
1354
|
* A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
|
|
1355
1355
|
*
|
|
1356
|
-
* @param {OAuthProvider} params.provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.
|
|
1356
|
+
* @param {OAuthProvider} params.provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.
|
|
1357
1357
|
* @param {string} params.success - URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
|
|
1358
1358
|
* @param {string} params.failure - URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
|
|
1359
1359
|
* @param {string[]} params.scopes - A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.
|
|
@@ -1373,7 +1373,7 @@ export declare class Account {
|
|
|
1373
1373
|
*
|
|
1374
1374
|
* A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
|
|
1375
1375
|
*
|
|
1376
|
-
* @param {OAuthProvider} provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.
|
|
1376
|
+
* @param {OAuthProvider} provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.
|
|
1377
1377
|
* @param {string} success - URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
|
|
1378
1378
|
* @param {string} failure - URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
|
|
1379
1379
|
* @param {string[]} scopes - A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.
|