@appwrite.io/console 8.3.0 → 9.1.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 +1075 -874
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +1076 -875
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +1075 -874
- package/package.json +1 -1
- 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 +3 -3
- package/types/models.d.ts +178 -34
- package/types/services/account.d.ts +4 -4
- package/types/services/databases.d.ts +6 -3
- package/types/services/organizations.d.ts +2 -2
- 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 +32 -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.1.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
|
@@ -77,13 +77,12 @@ 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
79
|
export { Addon } from './enums/addon';
|
|
80
|
+
export { ProtocolId } from './enums/protocol-id';
|
|
81
|
+
export { ServiceId } from './enums/service-id';
|
|
80
82
|
export { ProjectUsageRange } from './enums/project-usage-range';
|
|
81
83
|
export { Region } from './enums/region';
|
|
82
|
-
export { Api } from './enums/api';
|
|
83
84
|
export { AuthMethod } from './enums/auth-method';
|
|
84
|
-
export { PlatformType } from './enums/platform-type';
|
|
85
85
|
export { ResourceType } from './enums/resource-type';
|
|
86
|
-
export { ApiService } from './enums/api-service';
|
|
87
86
|
export { SMTPSecure } from './enums/smtp-secure';
|
|
88
87
|
export { Status } from './enums/status';
|
|
89
88
|
export { EmailTemplateType } from './enums/email-template-type';
|
|
@@ -109,6 +108,7 @@ export { IndexStatus } from './enums/index-status';
|
|
|
109
108
|
export { DeploymentStatus } from './enums/deployment-status';
|
|
110
109
|
export { ExecutionTrigger } from './enums/execution-trigger';
|
|
111
110
|
export { ExecutionStatus } from './enums/execution-status';
|
|
111
|
+
export { PlatformType } from './enums/platform-type';
|
|
112
112
|
export { HealthAntivirusStatus } from './enums/health-antivirus-status';
|
|
113
113
|
export { HealthCheckStatus } from './enums/health-check-status';
|
|
114
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
|
*/
|
|
@@ -4518,7 +4509,7 @@ export declare namespace Models {
|
|
|
4518
4509
|
/**
|
|
4519
4510
|
* List of Platforms.
|
|
4520
4511
|
*/
|
|
4521
|
-
platforms:
|
|
4512
|
+
platforms: (Models.PlatformWeb | Models.PlatformApple | Models.PlatformAndroid | Models.PlatformWindows | Models.PlatformLinux)[];
|
|
4522
4513
|
/**
|
|
4523
4514
|
* List of Webhooks.
|
|
4524
4515
|
*/
|
|
@@ -4635,6 +4626,10 @@ export declare namespace Models {
|
|
|
4635
4626
|
* Health service status
|
|
4636
4627
|
*/
|
|
4637
4628
|
serviceStatusForHealth: boolean;
|
|
4629
|
+
/**
|
|
4630
|
+
* Project service status
|
|
4631
|
+
*/
|
|
4632
|
+
serviceStatusForProject: boolean;
|
|
4638
4633
|
/**
|
|
4639
4634
|
* Storage service status
|
|
4640
4635
|
*/
|
|
@@ -4647,6 +4642,10 @@ export declare namespace Models {
|
|
|
4647
4642
|
* Users service status
|
|
4648
4643
|
*/
|
|
4649
4644
|
serviceStatusForUsers: boolean;
|
|
4645
|
+
/**
|
|
4646
|
+
* VCS service status
|
|
4647
|
+
*/
|
|
4648
|
+
serviceStatusForVcs: boolean;
|
|
4650
4649
|
/**
|
|
4651
4650
|
* Sites service status
|
|
4652
4651
|
*/
|
|
@@ -4655,14 +4654,34 @@ export declare namespace Models {
|
|
|
4655
4654
|
* Functions service status
|
|
4656
4655
|
*/
|
|
4657
4656
|
serviceStatusForFunctions: boolean;
|
|
4657
|
+
/**
|
|
4658
|
+
* Proxy service status
|
|
4659
|
+
*/
|
|
4660
|
+
serviceStatusForProxy: boolean;
|
|
4658
4661
|
/**
|
|
4659
4662
|
* GraphQL service status
|
|
4660
4663
|
*/
|
|
4661
4664
|
serviceStatusForGraphql: boolean;
|
|
4665
|
+
/**
|
|
4666
|
+
* Migrations service status
|
|
4667
|
+
*/
|
|
4668
|
+
serviceStatusForMigrations: boolean;
|
|
4662
4669
|
/**
|
|
4663
4670
|
* Messaging service status
|
|
4664
4671
|
*/
|
|
4665
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;
|
|
4666
4685
|
/**
|
|
4667
4686
|
* Project region
|
|
4668
4687
|
*/
|
|
@@ -4709,21 +4728,21 @@ export declare namespace Models {
|
|
|
4709
4728
|
*/
|
|
4710
4729
|
events: string[];
|
|
4711
4730
|
/**
|
|
4712
|
-
*
|
|
4731
|
+
* Indicates if SSL / TLS certificate verification is enabled.
|
|
4713
4732
|
*/
|
|
4714
|
-
|
|
4733
|
+
tls: boolean;
|
|
4715
4734
|
/**
|
|
4716
4735
|
* HTTP basic authentication username.
|
|
4717
4736
|
*/
|
|
4718
|
-
|
|
4737
|
+
authUsername: string;
|
|
4719
4738
|
/**
|
|
4720
4739
|
* HTTP basic authentication password.
|
|
4721
4740
|
*/
|
|
4722
|
-
|
|
4741
|
+
authPassword: string;
|
|
4723
4742
|
/**
|
|
4724
|
-
* Signature key which can be used to
|
|
4743
|
+
* Signature key which can be used to validate incoming webhook payloads. Only returned on creation and secret rotation.
|
|
4725
4744
|
*/
|
|
4726
|
-
|
|
4745
|
+
secret: string;
|
|
4727
4746
|
/**
|
|
4728
4747
|
* Indicates if this webhook is enabled.
|
|
4729
4748
|
*/
|
|
@@ -4854,9 +4873,9 @@ export declare namespace Models {
|
|
|
4854
4873
|
enabled: boolean;
|
|
4855
4874
|
};
|
|
4856
4875
|
/**
|
|
4857
|
-
* Platform
|
|
4876
|
+
* Platform Web
|
|
4858
4877
|
*/
|
|
4859
|
-
export type
|
|
4878
|
+
export type PlatformWeb = {
|
|
4860
4879
|
/**
|
|
4861
4880
|
* Platform ID.
|
|
4862
4881
|
*/
|
|
@@ -4874,29 +4893,142 @@ export declare namespace Models {
|
|
|
4874
4893
|
*/
|
|
4875
4894
|
name: string;
|
|
4876
4895
|
/**
|
|
4877
|
-
* Platform type. Possible values are:
|
|
4896
|
+
* Platform type. Possible values are: windows, apple, android, linux, web.
|
|
4878
4897
|
*/
|
|
4879
4898
|
type: PlatformType;
|
|
4880
4899
|
/**
|
|
4881
|
-
*
|
|
4900
|
+
* Web app hostname. Empty string for other platforms.
|
|
4882
4901
|
*/
|
|
4883
|
-
|
|
4902
|
+
hostname: string;
|
|
4903
|
+
};
|
|
4904
|
+
/**
|
|
4905
|
+
* Platform Apple
|
|
4906
|
+
*/
|
|
4907
|
+
export type PlatformApple = {
|
|
4884
4908
|
/**
|
|
4885
|
-
*
|
|
4909
|
+
* Platform ID.
|
|
4886
4910
|
*/
|
|
4887
|
-
|
|
4911
|
+
$id: string;
|
|
4888
4912
|
/**
|
|
4889
|
-
*
|
|
4913
|
+
* Platform creation date in ISO 8601 format.
|
|
4890
4914
|
*/
|
|
4891
|
-
|
|
4915
|
+
$createdAt: string;
|
|
4892
4916
|
/**
|
|
4893
|
-
*
|
|
4917
|
+
* Platform update date in ISO 8601 format.
|
|
4894
4918
|
*/
|
|
4895
|
-
|
|
4919
|
+
$updatedAt: string;
|
|
4896
4920
|
/**
|
|
4897
|
-
*
|
|
4921
|
+
* Platform name.
|
|
4898
4922
|
*/
|
|
4899
|
-
|
|
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.
|
|
5009
|
+
*/
|
|
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)[];
|
|
4900
5032
|
};
|
|
4901
5033
|
/**
|
|
4902
5034
|
* Variable
|
|
@@ -6256,7 +6388,7 @@ export declare namespace Models {
|
|
|
6256
6388
|
/**
|
|
6257
6389
|
* Type of deployment. Possible values are "function", "site". Used if rule's type is "deployment".
|
|
6258
6390
|
*/
|
|
6259
|
-
deploymentResourceType
|
|
6391
|
+
deploymentResourceType?: ProxyRuleDeploymentResourceType;
|
|
6260
6392
|
/**
|
|
6261
6393
|
* ID deployment's resource. Used if type is "deployment"
|
|
6262
6394
|
*/
|
|
@@ -7520,6 +7652,18 @@ export declare namespace Models {
|
|
|
7520
7652
|
* Does plan support credit
|
|
7521
7653
|
*/
|
|
7522
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;
|
|
7523
7667
|
/**
|
|
7524
7668
|
* Does plan support backup policies.
|
|
7525
7669
|
*/
|
|
@@ -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.
|
|
@@ -373,6 +373,7 @@ export declare class Databases {
|
|
|
373
373
|
* @param {string[]} params.permissions - An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
374
374
|
* @param {boolean} params.documentSecurity - Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
375
375
|
* @param {boolean} params.enabled - Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.
|
|
376
|
+
* @param {boolean} params.purge - When true, purge all cached list responses for this collection as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.
|
|
376
377
|
* @throws {AppwriteException}
|
|
377
378
|
* @returns {Promise<Models.Collection>}
|
|
378
379
|
* @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.updateTable` instead.
|
|
@@ -384,6 +385,7 @@ export declare class Databases {
|
|
|
384
385
|
permissions?: string[];
|
|
385
386
|
documentSecurity?: boolean;
|
|
386
387
|
enabled?: boolean;
|
|
388
|
+
purge?: boolean;
|
|
387
389
|
}): Promise<Models.Collection>;
|
|
388
390
|
/**
|
|
389
391
|
* Update a collection by its unique ID.
|
|
@@ -394,11 +396,12 @@ export declare class Databases {
|
|
|
394
396
|
* @param {string[]} permissions - An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
395
397
|
* @param {boolean} documentSecurity - Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
396
398
|
* @param {boolean} enabled - Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.
|
|
399
|
+
* @param {boolean} purge - When true, purge all cached list responses for this collection as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.
|
|
397
400
|
* @throws {AppwriteException}
|
|
398
401
|
* @returns {Promise<Models.Collection>}
|
|
399
402
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
400
403
|
*/
|
|
401
|
-
updateCollection(databaseId: string, collectionId: string, name?: string, permissions?: string[], documentSecurity?: boolean, enabled?: boolean): Promise<Models.Collection>;
|
|
404
|
+
updateCollection(databaseId: string, collectionId: string, name?: string, permissions?: string[], documentSecurity?: boolean, enabled?: boolean, purge?: boolean): Promise<Models.Collection>;
|
|
402
405
|
/**
|
|
403
406
|
* Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.
|
|
404
407
|
*
|
|
@@ -1794,7 +1797,7 @@ export declare class Databases {
|
|
|
1794
1797
|
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
|
|
1795
1798
|
* @param {string} params.transactionId - Transaction ID to read uncommitted changes within the transaction.
|
|
1796
1799
|
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1797
|
-
* @param {number} params.ttl - TTL (seconds) for
|
|
1800
|
+
* @param {number} params.ttl - TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, collection, schema version (attributes and indexes), caller authorization roles, and the exact query — so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; document writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).
|
|
1798
1801
|
* @throws {AppwriteException}
|
|
1799
1802
|
* @returns {Promise<Models.DocumentList<Document>>}
|
|
1800
1803
|
* @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.listRows` instead.
|
|
@@ -1815,7 +1818,7 @@ export declare class Databases {
|
|
|
1815
1818
|
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
|
|
1816
1819
|
* @param {string} transactionId - Transaction ID to read uncommitted changes within the transaction.
|
|
1817
1820
|
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1818
|
-
* @param {number} ttl - TTL (seconds) for
|
|
1821
|
+
* @param {number} ttl - TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, collection, schema version (attributes and indexes), caller authorization roles, and the exact query — so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; document writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).
|
|
1819
1822
|
* @throws {AppwriteException}
|
|
1820
1823
|
* @returns {Promise<Models.DocumentList<Document>>}
|
|
1821
1824
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
@@ -1086,7 +1086,7 @@ export declare class Organizations {
|
|
|
1086
1086
|
*/
|
|
1087
1087
|
setBillingTaxId<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
|
|
1088
1088
|
organizationId: string;
|
|
1089
|
-
taxId
|
|
1089
|
+
taxId?: string;
|
|
1090
1090
|
}): Promise<Models.Organization<Preferences>>;
|
|
1091
1091
|
/**
|
|
1092
1092
|
* Set an organization's billing tax ID.
|
|
@@ -1097,7 +1097,7 @@ export declare class Organizations {
|
|
|
1097
1097
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
1098
1098
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1099
1099
|
*/
|
|
1100
|
-
setBillingTaxId<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, taxId
|
|
1100
|
+
setBillingTaxId<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, taxId?: string): Promise<Models.Organization<Preferences>>;
|
|
1101
1101
|
/**
|
|
1102
1102
|
* Get the usage data for an organization.
|
|
1103
1103
|
*
|