@appwrite.io/console 16.1.0 → 18.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 +3 -3
- package/dist/cjs/sdk.js +1808 -412
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +1805 -413
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +4339 -944
- package/package.json +5 -2
- package/types/client.d.ts +24 -11
- package/types/enums/billing-plan-group.d.ts +2 -1
- package/types/enums/build-runtime.d.ts +3 -0
- package/types/enums/cache-database.d.ts +1 -2
- package/types/enums/conversation-type.d.ts +9 -0
- package/types/enums/framework.d.ts +1 -0
- package/types/enums/id-token-provider.d.ts +4 -0
- package/types/enums/o-auth-2-auth-0-prompt.d.ts +5 -0
- package/types/enums/o-auth-2-discord-prompt.d.ts +4 -0
- package/types/enums/o-auth-2-github-prompt.d.ts +3 -0
- package/types/enums/o-auth-2-kakao-prompt.d.ts +6 -0
- package/types/enums/o-auth-2-microsoft-prompt.d.ts +6 -0
- package/types/enums/o-auth-2-okta-prompt.d.ts +5 -0
- package/types/enums/o-auth-2-salesforce-prompt.d.ts +4 -0
- package/types/enums/o-auth-2-zoho-prompt.d.ts +3 -0
- package/types/enums/organization-key-scopes.d.ts +2 -4
- package/types/enums/project-email-template-id.d.ts +3 -1
- package/types/enums/project-key-scopes.d.ts +1 -0
- package/types/enums/project-o-auth-2-auth-0-prompt.d.ts +5 -0
- package/types/enums/project-o-auth-2-discord-prompt.d.ts +4 -0
- package/types/enums/project-o-auth-2-git-hub-prompt.d.ts +3 -0
- package/types/enums/project-o-auth-2-kakao-prompt.d.ts +6 -0
- package/types/enums/project-o-auth-2-microsoft-prompt.d.ts +6 -0
- package/types/enums/project-o-auth-2-okta-prompt.d.ts +5 -0
- package/types/enums/project-o-auth-2-salesforce-prompt.d.ts +4 -0
- package/types/enums/project-o-auth-2-zoho-prompt.d.ts +3 -0
- package/types/enums/project-policy-id.d.ts +1 -0
- package/types/enums/query-suggestion-resource.d.ts +1 -3
- package/types/enums/runtime.d.ts +3 -0
- package/types/index.d.ts +23 -2
- package/types/models.d.ts +271 -562
- package/types/services/account.d.ts +167 -24
- package/types/services/console.d.ts +2 -2
- package/types/services/databases.d.ts +4 -4
- package/types/services/growth.d.ts +100 -0
- package/types/services/manager.d.ts +39 -14
- package/types/services/messaging.d.ts +94 -8
- package/types/services/organization.d.ts +165 -0
- package/types/services/organizations.d.ts +0 -19
- package/types/services/project.d.ts +93 -50
- package/types/services/projects.d.ts +0 -94
- package/types/services/push.d.ts +153 -0
- package/types/services/storage.d.ts +4 -4
- package/types/services/tables-db.d.ts +37 -37
- package/types/services/teams.d.ts +0 -25
- package/types/services/users.d.ts +4 -29
- package/types/topic.d.ts +34 -0
- package/types/enums/project-usage-range.d.ts +0 -4
|
@@ -2,8 +2,16 @@ import { Client } from '../client';
|
|
|
2
2
|
import type { Models } from '../models';
|
|
3
3
|
import { ProjectAuthMethodId } from '../enums/project-auth-method-id';
|
|
4
4
|
import { ProjectKeyScopes } from '../enums/project-key-scopes';
|
|
5
|
+
import { ProjectOAuth2Auth0Prompt } from '../enums/project-o-auth-2-auth-0-prompt';
|
|
6
|
+
import { ProjectOAuth2DiscordPrompt } from '../enums/project-o-auth-2-discord-prompt';
|
|
7
|
+
import { ProjectOAuth2GitHubPrompt } from '../enums/project-o-auth-2-git-hub-prompt';
|
|
5
8
|
import { ProjectOAuth2GooglePrompt } from '../enums/project-o-auth-2-google-prompt';
|
|
9
|
+
import { ProjectOAuth2KakaoPrompt } from '../enums/project-o-auth-2-kakao-prompt';
|
|
10
|
+
import { ProjectOAuth2MicrosoftPrompt } from '../enums/project-o-auth-2-microsoft-prompt';
|
|
6
11
|
import { ProjectOAuth2OidcPrompt } from '../enums/project-o-auth-2-oidc-prompt';
|
|
12
|
+
import { ProjectOAuth2OktaPrompt } from '../enums/project-o-auth-2-okta-prompt';
|
|
13
|
+
import { ProjectOAuth2SalesforcePrompt } from '../enums/project-o-auth-2-salesforce-prompt';
|
|
14
|
+
import { ProjectOAuth2ZohoPrompt } from '../enums/project-o-auth-2-zoho-prompt';
|
|
7
15
|
import { ProjectOAuthProviderId } from '../enums/project-o-auth-provider-id';
|
|
8
16
|
import { ProjectPolicyId } from '../enums/project-policy-id';
|
|
9
17
|
import { ProjectProtocolId } from '../enums/project-protocol-id';
|
|
@@ -11,7 +19,6 @@ import { ProjectServiceId } from '../enums/project-service-id';
|
|
|
11
19
|
import { ProjectSMTPSecure } from '../enums/project-smtp-secure';
|
|
12
20
|
import { ProjectEmailTemplateId } from '../enums/project-email-template-id';
|
|
13
21
|
import { ProjectEmailTemplateLocale } from '../enums/project-email-template-locale';
|
|
14
|
-
import { ProjectUsageRange } from '../enums/project-usage-range';
|
|
15
22
|
export declare class Project {
|
|
16
23
|
client: Client;
|
|
17
24
|
constructor(client: Client);
|
|
@@ -438,7 +445,9 @@ export declare class Project {
|
|
|
438
445
|
* @param {string} params.keyId - 'Key ID' of Apple OAuth2 app. For example: P4000000N8
|
|
439
446
|
* @param {string} params.teamId - 'Team ID' of Apple OAuth2 app. For example: D4000000R6
|
|
440
447
|
* @param {string} params.p8File - Contents of the Apple OAuth2 app .p8 private key file. The secret key wrapped by the PEM markers is 200 characters long. For example: -----BEGIN PRIVATE KEY-----MIGTAg...jy2Xbna-----END PRIVATE KEY-----
|
|
441
|
-
* @param {
|
|
448
|
+
* @param {string[]} params.nativeClientIds - App bundle IDs accepted as ID token audiences for native Sign in with Apple. For example: com.example.app. Together with the Services ID, these are the only client IDs whose tokens are trusted. Pass an empty array to clear the list.
|
|
449
|
+
* @param {boolean} params.enabled - Browser-based OAuth2 sign-in status. Set to true to enable new session creation through the redirect flow. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid. Has no effect on native sign-in, which is controlled by nativeEnabled only.
|
|
450
|
+
* @param {boolean} params.nativeEnabled - Native Sign in with Apple status. This is the only switch for creating sessions from ID tokens obtained on device and is independent of enabled. Needs a Services ID or at least one native client ID to match tokens against, but no key or team ID: this method verifies a signature rather than redeeming an authorization code.
|
|
442
451
|
* @throws {AppwriteException}
|
|
443
452
|
* @returns {Promise<Models.OAuth2Apple>}
|
|
444
453
|
*/
|
|
@@ -447,7 +456,9 @@ export declare class Project {
|
|
|
447
456
|
keyId?: string;
|
|
448
457
|
teamId?: string;
|
|
449
458
|
p8File?: string;
|
|
459
|
+
nativeClientIds?: string[];
|
|
450
460
|
enabled?: boolean;
|
|
461
|
+
nativeEnabled?: boolean;
|
|
451
462
|
}): Promise<Models.OAuth2Apple>;
|
|
452
463
|
/**
|
|
453
464
|
* Update the project OAuth2 Apple configuration.
|
|
@@ -456,12 +467,14 @@ export declare class Project {
|
|
|
456
467
|
* @param {string} keyId - 'Key ID' of Apple OAuth2 app. For example: P4000000N8
|
|
457
468
|
* @param {string} teamId - 'Team ID' of Apple OAuth2 app. For example: D4000000R6
|
|
458
469
|
* @param {string} p8File - Contents of the Apple OAuth2 app .p8 private key file. The secret key wrapped by the PEM markers is 200 characters long. For example: -----BEGIN PRIVATE KEY-----MIGTAg...jy2Xbna-----END PRIVATE KEY-----
|
|
459
|
-
* @param {
|
|
470
|
+
* @param {string[]} nativeClientIds - App bundle IDs accepted as ID token audiences for native Sign in with Apple. For example: com.example.app. Together with the Services ID, these are the only client IDs whose tokens are trusted. Pass an empty array to clear the list.
|
|
471
|
+
* @param {boolean} enabled - Browser-based OAuth2 sign-in status. Set to true to enable new session creation through the redirect flow. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid. Has no effect on native sign-in, which is controlled by nativeEnabled only.
|
|
472
|
+
* @param {boolean} nativeEnabled - Native Sign in with Apple status. This is the only switch for creating sessions from ID tokens obtained on device and is independent of enabled. Needs a Services ID or at least one native client ID to match tokens against, but no key or team ID: this method verifies a signature rather than redeeming an authorization code.
|
|
460
473
|
* @throws {AppwriteException}
|
|
461
474
|
* @returns {Promise<Models.OAuth2Apple>}
|
|
462
475
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
463
476
|
*/
|
|
464
|
-
updateOAuth2Apple(serviceId?: string, keyId?: string, teamId?: string, p8File?: string, enabled?: boolean): Promise<Models.OAuth2Apple>;
|
|
477
|
+
updateOAuth2Apple(serviceId?: string, keyId?: string, teamId?: string, p8File?: string, nativeClientIds?: string[], enabled?: boolean, nativeEnabled?: boolean): Promise<Models.OAuth2Apple>;
|
|
465
478
|
/**
|
|
466
479
|
* Update the project OAuth2 Appwrite configuration.
|
|
467
480
|
*
|
|
@@ -493,6 +506,7 @@ export declare class Project {
|
|
|
493
506
|
* @param {string} params.clientId - 'Client ID' of Auth0 OAuth2 app. For example: OaOkIA000000000000000000005KLSYq
|
|
494
507
|
* @param {string} params.clientSecret - 'Client Secret' of Auth0 OAuth2 app. For example: zXz0000-00000000000000000000000000000-00000000000000000000PJafnF
|
|
495
508
|
* @param {string} params.endpoint - Domain of Auth0 instance. For example: example.us.auth0.com
|
|
509
|
+
* @param {ProjectOAuth2Auth0Prompt[]} params.prompt - Array of Auth0 OAuth2 prompt values. If "none" is included, it must be the only element. "none" means: don't display any authentication or consent screens. "login" means: prompt the user to re-authenticate. "consent" means: prompt the user for consent. Pass an empty array to use the Auth0 default.
|
|
496
510
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
497
511
|
* @throws {AppwriteException}
|
|
498
512
|
* @returns {Promise<Models.OAuth2Auth0>}
|
|
@@ -501,6 +515,7 @@ export declare class Project {
|
|
|
501
515
|
clientId?: string;
|
|
502
516
|
clientSecret?: string;
|
|
503
517
|
endpoint?: string;
|
|
518
|
+
prompt?: ProjectOAuth2Auth0Prompt[];
|
|
504
519
|
enabled?: boolean;
|
|
505
520
|
}): Promise<Models.OAuth2Auth0>;
|
|
506
521
|
/**
|
|
@@ -509,12 +524,13 @@ export declare class Project {
|
|
|
509
524
|
* @param {string} clientId - 'Client ID' of Auth0 OAuth2 app. For example: OaOkIA000000000000000000005KLSYq
|
|
510
525
|
* @param {string} clientSecret - 'Client Secret' of Auth0 OAuth2 app. For example: zXz0000-00000000000000000000000000000-00000000000000000000PJafnF
|
|
511
526
|
* @param {string} endpoint - Domain of Auth0 instance. For example: example.us.auth0.com
|
|
527
|
+
* @param {ProjectOAuth2Auth0Prompt[]} prompt - Array of Auth0 OAuth2 prompt values. If "none" is included, it must be the only element. "none" means: don't display any authentication or consent screens. "login" means: prompt the user to re-authenticate. "consent" means: prompt the user for consent. Pass an empty array to use the Auth0 default.
|
|
512
528
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
513
529
|
* @throws {AppwriteException}
|
|
514
530
|
* @returns {Promise<Models.OAuth2Auth0>}
|
|
515
531
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
516
532
|
*/
|
|
517
|
-
updateOAuth2Auth0(clientId?: string, clientSecret?: string, endpoint?: string, enabled?: boolean): Promise<Models.OAuth2Auth0>;
|
|
533
|
+
updateOAuth2Auth0(clientId?: string, clientSecret?: string, endpoint?: string, prompt?: ProjectOAuth2Auth0Prompt[], enabled?: boolean): Promise<Models.OAuth2Auth0>;
|
|
518
534
|
/**
|
|
519
535
|
* Update the project OAuth2 Authentik configuration.
|
|
520
536
|
*
|
|
@@ -698,6 +714,7 @@ export declare class Project {
|
|
|
698
714
|
*
|
|
699
715
|
* @param {string} params.clientId - 'Client ID' of Discord OAuth2 app. For example: 950722000000343754
|
|
700
716
|
* @param {string} params.clientSecret - 'Client Secret' of Discord OAuth2 app. For example: YmPXnM000000000000000000002zFg5D
|
|
717
|
+
* @param {ProjectOAuth2DiscordPrompt[]} params.prompt - Array with at most one Discord OAuth2 prompt value. "none" means: skip the authorization screen for users who already authorized the app with the requested scopes. "consent" means: ask users who already authorized the app to approve it again. Pass an empty array to use the Discord default.
|
|
701
718
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
702
719
|
* @throws {AppwriteException}
|
|
703
720
|
* @returns {Promise<Models.OAuth2Discord>}
|
|
@@ -705,6 +722,7 @@ export declare class Project {
|
|
|
705
722
|
updateOAuth2Discord(params?: {
|
|
706
723
|
clientId?: string;
|
|
707
724
|
clientSecret?: string;
|
|
725
|
+
prompt?: ProjectOAuth2DiscordPrompt[];
|
|
708
726
|
enabled?: boolean;
|
|
709
727
|
}): Promise<Models.OAuth2Discord>;
|
|
710
728
|
/**
|
|
@@ -712,12 +730,13 @@ export declare class Project {
|
|
|
712
730
|
*
|
|
713
731
|
* @param {string} clientId - 'Client ID' of Discord OAuth2 app. For example: 950722000000343754
|
|
714
732
|
* @param {string} clientSecret - 'Client Secret' of Discord OAuth2 app. For example: YmPXnM000000000000000000002zFg5D
|
|
733
|
+
* @param {ProjectOAuth2DiscordPrompt[]} prompt - Array with at most one Discord OAuth2 prompt value. "none" means: skip the authorization screen for users who already authorized the app with the requested scopes. "consent" means: ask users who already authorized the app to approve it again. Pass an empty array to use the Discord default.
|
|
715
734
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
716
735
|
* @throws {AppwriteException}
|
|
717
736
|
* @returns {Promise<Models.OAuth2Discord>}
|
|
718
737
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
719
738
|
*/
|
|
720
|
-
updateOAuth2Discord(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Discord>;
|
|
739
|
+
updateOAuth2Discord(clientId?: string, clientSecret?: string, prompt?: ProjectOAuth2DiscordPrompt[], enabled?: boolean): Promise<Models.OAuth2Discord>;
|
|
721
740
|
/**
|
|
722
741
|
* Update the project OAuth2 Disqus configuration.
|
|
723
742
|
*
|
|
@@ -876,6 +895,7 @@ export declare class Project {
|
|
|
876
895
|
*
|
|
877
896
|
* @param {string} params.clientId - 'OAuth2 app Client ID, or App ID' of GitHub OAuth2 app. For example: e4d87900000000540733. Example of wrong value: 370006
|
|
878
897
|
* @param {string} params.clientSecret - 'Client Secret' of GitHub OAuth2 app. For example: 5e07c00000000000000000000000000000198bcc
|
|
898
|
+
* @param {ProjectOAuth2GitHubPrompt[]} params.prompt - Array of GitHub OAuth2 prompt values. "select_account" means: prompt the user to select an account. Pass an empty array to use the GitHub default.
|
|
879
899
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
880
900
|
* @throws {AppwriteException}
|
|
881
901
|
* @returns {Promise<Models.OAuth2Github>}
|
|
@@ -883,6 +903,7 @@ export declare class Project {
|
|
|
883
903
|
updateOAuth2GitHub(params?: {
|
|
884
904
|
clientId?: string;
|
|
885
905
|
clientSecret?: string;
|
|
906
|
+
prompt?: ProjectOAuth2GitHubPrompt[];
|
|
886
907
|
enabled?: boolean;
|
|
887
908
|
}): Promise<Models.OAuth2Github>;
|
|
888
909
|
/**
|
|
@@ -890,12 +911,13 @@ export declare class Project {
|
|
|
890
911
|
*
|
|
891
912
|
* @param {string} clientId - 'OAuth2 app Client ID, or App ID' of GitHub OAuth2 app. For example: e4d87900000000540733. Example of wrong value: 370006
|
|
892
913
|
* @param {string} clientSecret - 'Client Secret' of GitHub OAuth2 app. For example: 5e07c00000000000000000000000000000198bcc
|
|
914
|
+
* @param {ProjectOAuth2GitHubPrompt[]} prompt - Array of GitHub OAuth2 prompt values. "select_account" means: prompt the user to select an account. Pass an empty array to use the GitHub default.
|
|
893
915
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
894
916
|
* @throws {AppwriteException}
|
|
895
917
|
* @returns {Promise<Models.OAuth2Github>}
|
|
896
918
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
897
919
|
*/
|
|
898
|
-
updateOAuth2GitHub(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Github>;
|
|
920
|
+
updateOAuth2GitHub(clientId?: string, clientSecret?: string, prompt?: ProjectOAuth2GitHubPrompt[], enabled?: boolean): Promise<Models.OAuth2Github>;
|
|
899
921
|
/**
|
|
900
922
|
* Update the project OAuth2 Gitlab configuration.
|
|
901
923
|
*
|
|
@@ -930,7 +952,9 @@ export declare class Project {
|
|
|
930
952
|
* @param {string} params.clientId - 'Client ID' of Google OAuth2 app. For example: 120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com
|
|
931
953
|
* @param {string} params.clientSecret - 'Client Secret' of Google OAuth2 app. For example: GOCSPX-2k8gsR0000000000000000VNahJj
|
|
932
954
|
* @param {ProjectOAuth2GooglePrompt[]} params.prompt - Array of Google OAuth2 prompt values. If "none" is included, it must be the only element. "none" means: don't display any authentication or consent screens. Must not be specified with other values. "consent" means: prompt the user for consent. "select_account" means: prompt the user to select an account.
|
|
933
|
-
* @param {
|
|
955
|
+
* @param {string[]} params.nativeClientIds - Additional OAuth2 client IDs accepted as ID token audiences for native sign-in (Android and iOS client IDs). Together with the client ID, which is always accepted, these are the only client IDs whose tokens are trusted. Pass an empty array to clear the list.
|
|
956
|
+
* @param {boolean} params.enabled - Browser-based OAuth2 sign-in status. Set to true to enable new session creation through the redirect flow. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid. Has no effect on native sign-in, which is controlled by nativeEnabled only.
|
|
957
|
+
* @param {boolean} params.nativeEnabled - Native Google sign-in status. This is the only switch for creating sessions from ID tokens obtained on device and is independent of enabled. Needs a client ID or at least one native client ID to match tokens against, but no client secret: this method verifies a signature rather than redeeming an authorization code.
|
|
934
958
|
* @throws {AppwriteException}
|
|
935
959
|
* @returns {Promise<Models.OAuth2Google>}
|
|
936
960
|
*/
|
|
@@ -938,7 +962,9 @@ export declare class Project {
|
|
|
938
962
|
clientId?: string;
|
|
939
963
|
clientSecret?: string;
|
|
940
964
|
prompt?: ProjectOAuth2GooglePrompt[];
|
|
965
|
+
nativeClientIds?: string[];
|
|
941
966
|
enabled?: boolean;
|
|
967
|
+
nativeEnabled?: boolean;
|
|
942
968
|
}): Promise<Models.OAuth2Google>;
|
|
943
969
|
/**
|
|
944
970
|
* Update the project OAuth2 Google configuration.
|
|
@@ -946,12 +972,14 @@ export declare class Project {
|
|
|
946
972
|
* @param {string} clientId - 'Client ID' of Google OAuth2 app. For example: 120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com
|
|
947
973
|
* @param {string} clientSecret - 'Client Secret' of Google OAuth2 app. For example: GOCSPX-2k8gsR0000000000000000VNahJj
|
|
948
974
|
* @param {ProjectOAuth2GooglePrompt[]} prompt - Array of Google OAuth2 prompt values. If "none" is included, it must be the only element. "none" means: don't display any authentication or consent screens. Must not be specified with other values. "consent" means: prompt the user for consent. "select_account" means: prompt the user to select an account.
|
|
949
|
-
* @param {
|
|
975
|
+
* @param {string[]} nativeClientIds - Additional OAuth2 client IDs accepted as ID token audiences for native sign-in (Android and iOS client IDs). Together with the client ID, which is always accepted, these are the only client IDs whose tokens are trusted. Pass an empty array to clear the list.
|
|
976
|
+
* @param {boolean} enabled - Browser-based OAuth2 sign-in status. Set to true to enable new session creation through the redirect flow. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid. Has no effect on native sign-in, which is controlled by nativeEnabled only.
|
|
977
|
+
* @param {boolean} nativeEnabled - Native Google sign-in status. This is the only switch for creating sessions from ID tokens obtained on device and is independent of enabled. Needs a client ID or at least one native client ID to match tokens against, but no client secret: this method verifies a signature rather than redeeming an authorization code.
|
|
950
978
|
* @throws {AppwriteException}
|
|
951
979
|
* @returns {Promise<Models.OAuth2Google>}
|
|
952
980
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
953
981
|
*/
|
|
954
|
-
updateOAuth2Google(clientId?: string, clientSecret?: string, prompt?: ProjectOAuth2GooglePrompt[], enabled?: boolean): Promise<Models.OAuth2Google>;
|
|
982
|
+
updateOAuth2Google(clientId?: string, clientSecret?: string, prompt?: ProjectOAuth2GooglePrompt[], nativeClientIds?: string[], enabled?: boolean, nativeEnabled?: boolean): Promise<Models.OAuth2Google>;
|
|
955
983
|
/**
|
|
956
984
|
* Update the project OAuth2 Hugging Face configuration.
|
|
957
985
|
*
|
|
@@ -982,6 +1010,7 @@ export declare class Project {
|
|
|
982
1010
|
*
|
|
983
1011
|
* @param {string} params.clientId - 'REST API key' of Kakao OAuth2 app. For example: 839ff5000000000000000000013206de
|
|
984
1012
|
* @param {string} params.clientSecret - 'Client Secret' of Kakao OAuth2 app. For example: jLNVOK00000000000000000000yJebea. Generate it under Kakao Login > Security and set its status to enabled
|
|
1013
|
+
* @param {ProjectOAuth2KakaoPrompt[]} params.prompt - Array of Kakao OAuth2 prompt values. If "none" is included, it must be the only element. "none" means: don't display any authentication or consent screens. "login" means: prompt the user to re-authenticate. "create" means: prompt the user to sign up. "select_account" means: prompt the user to select an account. Pass an empty array to use the Kakao default.
|
|
985
1014
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
986
1015
|
* @throws {AppwriteException}
|
|
987
1016
|
* @returns {Promise<Models.OAuth2Kakao>}
|
|
@@ -989,6 +1018,7 @@ export declare class Project {
|
|
|
989
1018
|
updateOAuth2Kakao(params?: {
|
|
990
1019
|
clientId?: string;
|
|
991
1020
|
clientSecret?: string;
|
|
1021
|
+
prompt?: ProjectOAuth2KakaoPrompt[];
|
|
992
1022
|
enabled?: boolean;
|
|
993
1023
|
}): Promise<Models.OAuth2Kakao>;
|
|
994
1024
|
/**
|
|
@@ -996,12 +1026,13 @@ export declare class Project {
|
|
|
996
1026
|
*
|
|
997
1027
|
* @param {string} clientId - 'REST API key' of Kakao OAuth2 app. For example: 839ff5000000000000000000013206de
|
|
998
1028
|
* @param {string} clientSecret - 'Client Secret' of Kakao OAuth2 app. For example: jLNVOK00000000000000000000yJebea. Generate it under Kakao Login > Security and set its status to enabled
|
|
1029
|
+
* @param {ProjectOAuth2KakaoPrompt[]} prompt - Array of Kakao OAuth2 prompt values. If "none" is included, it must be the only element. "none" means: don't display any authentication or consent screens. "login" means: prompt the user to re-authenticate. "create" means: prompt the user to sign up. "select_account" means: prompt the user to select an account. Pass an empty array to use the Kakao default.
|
|
999
1030
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1000
1031
|
* @throws {AppwriteException}
|
|
1001
1032
|
* @returns {Promise<Models.OAuth2Kakao>}
|
|
1002
1033
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1003
1034
|
*/
|
|
1004
|
-
updateOAuth2Kakao(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Kakao>;
|
|
1035
|
+
updateOAuth2Kakao(clientId?: string, clientSecret?: string, prompt?: ProjectOAuth2KakaoPrompt[], enabled?: boolean): Promise<Models.OAuth2Kakao>;
|
|
1005
1036
|
/**
|
|
1006
1037
|
* Update the project OAuth2 Keycloak configuration.
|
|
1007
1038
|
*
|
|
@@ -1089,6 +1120,7 @@ export declare class Project {
|
|
|
1089
1120
|
* @param {string} params.applicationId - 'Entra ID Application ID, also known as Client ID' of Microsoft OAuth2 app. For example: 00001111-aaaa-2222-bbbb-3333cccc4444
|
|
1090
1121
|
* @param {string} params.applicationSecret - 'Entra ID Application Secret, also known as Client Secret' of Microsoft OAuth2 app. For example: A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u
|
|
1091
1122
|
* @param {string} params.tenant - Microsoft Entra ID tenant identifier. Use 'common', 'organizations', 'consumers' or a specific tenant ID. For example: common
|
|
1123
|
+
* @param {ProjectOAuth2MicrosoftPrompt[]} params.prompt - Array of Microsoft OAuth2 prompt values. "none" means: don't display any authentication or consent screens. "login" means: prompt the user to re-authenticate. "consent" means: prompt the user for consent. "select_account" means: prompt the user to select an account. Pass an empty array to use the Microsoft default.
|
|
1092
1124
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1093
1125
|
* @throws {AppwriteException}
|
|
1094
1126
|
* @returns {Promise<Models.OAuth2Microsoft>}
|
|
@@ -1097,6 +1129,7 @@ export declare class Project {
|
|
|
1097
1129
|
applicationId?: string;
|
|
1098
1130
|
applicationSecret?: string;
|
|
1099
1131
|
tenant?: string;
|
|
1132
|
+
prompt?: ProjectOAuth2MicrosoftPrompt[];
|
|
1100
1133
|
enabled?: boolean;
|
|
1101
1134
|
}): Promise<Models.OAuth2Microsoft>;
|
|
1102
1135
|
/**
|
|
@@ -1105,12 +1138,13 @@ export declare class Project {
|
|
|
1105
1138
|
* @param {string} applicationId - 'Entra ID Application ID, also known as Client ID' of Microsoft OAuth2 app. For example: 00001111-aaaa-2222-bbbb-3333cccc4444
|
|
1106
1139
|
* @param {string} applicationSecret - 'Entra ID Application Secret, also known as Client Secret' of Microsoft OAuth2 app. For example: A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u
|
|
1107
1140
|
* @param {string} tenant - Microsoft Entra ID tenant identifier. Use 'common', 'organizations', 'consumers' or a specific tenant ID. For example: common
|
|
1141
|
+
* @param {ProjectOAuth2MicrosoftPrompt[]} prompt - Array of Microsoft OAuth2 prompt values. "none" means: don't display any authentication or consent screens. "login" means: prompt the user to re-authenticate. "consent" means: prompt the user for consent. "select_account" means: prompt the user to select an account. Pass an empty array to use the Microsoft default.
|
|
1108
1142
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1109
1143
|
* @throws {AppwriteException}
|
|
1110
1144
|
* @returns {Promise<Models.OAuth2Microsoft>}
|
|
1111
1145
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1112
1146
|
*/
|
|
1113
|
-
updateOAuth2Microsoft(applicationId?: string, applicationSecret?: string, tenant?: string, enabled?: boolean): Promise<Models.OAuth2Microsoft>;
|
|
1147
|
+
updateOAuth2Microsoft(applicationId?: string, applicationSecret?: string, tenant?: string, prompt?: ProjectOAuth2MicrosoftPrompt[], enabled?: boolean): Promise<Models.OAuth2Microsoft>;
|
|
1114
1148
|
/**
|
|
1115
1149
|
* Update the project OAuth2 Notion configuration.
|
|
1116
1150
|
*
|
|
@@ -1186,6 +1220,7 @@ export declare class Project {
|
|
|
1186
1220
|
* @param {string} params.clientSecret - 'Client Secret' of Okta OAuth2 app. For example: Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV
|
|
1187
1221
|
* @param {string} params.domain - Okta company domain. Required when enabling the provider. For example: trial-6400025.okta.com. Example of wrong value: trial-6400025-admin.okta.com, or https://trial-6400025.okta.com/
|
|
1188
1222
|
* @param {string} params.authorizationServerId - Custom Authorization Servers. Optional, can be left empty or unconfigured. For example: aus000000000000000h7z
|
|
1223
|
+
* @param {ProjectOAuth2OktaPrompt[]} params.prompt - Array of Okta OAuth2 prompt values. If "none" is included, it must be the only element. "none" means: don't display any authentication or consent screens. "login" means: prompt the user to re-authenticate. "consent" means: prompt the user for consent. Pass an empty array to use the Okta default.
|
|
1189
1224
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1190
1225
|
* @throws {AppwriteException}
|
|
1191
1226
|
* @returns {Promise<Models.OAuth2Okta>}
|
|
@@ -1195,6 +1230,7 @@ export declare class Project {
|
|
|
1195
1230
|
clientSecret?: string;
|
|
1196
1231
|
domain?: string;
|
|
1197
1232
|
authorizationServerId?: string;
|
|
1233
|
+
prompt?: ProjectOAuth2OktaPrompt[];
|
|
1198
1234
|
enabled?: boolean;
|
|
1199
1235
|
}): Promise<Models.OAuth2Okta>;
|
|
1200
1236
|
/**
|
|
@@ -1204,12 +1240,13 @@ export declare class Project {
|
|
|
1204
1240
|
* @param {string} clientSecret - 'Client Secret' of Okta OAuth2 app. For example: Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV
|
|
1205
1241
|
* @param {string} domain - Okta company domain. Required when enabling the provider. For example: trial-6400025.okta.com. Example of wrong value: trial-6400025-admin.okta.com, or https://trial-6400025.okta.com/
|
|
1206
1242
|
* @param {string} authorizationServerId - Custom Authorization Servers. Optional, can be left empty or unconfigured. For example: aus000000000000000h7z
|
|
1243
|
+
* @param {ProjectOAuth2OktaPrompt[]} prompt - Array of Okta OAuth2 prompt values. If "none" is included, it must be the only element. "none" means: don't display any authentication or consent screens. "login" means: prompt the user to re-authenticate. "consent" means: prompt the user for consent. Pass an empty array to use the Okta default.
|
|
1207
1244
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1208
1245
|
* @throws {AppwriteException}
|
|
1209
1246
|
* @returns {Promise<Models.OAuth2Okta>}
|
|
1210
1247
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1211
1248
|
*/
|
|
1212
|
-
updateOAuth2Okta(clientId?: string, clientSecret?: string, domain?: string, authorizationServerId?: string, enabled?: boolean): Promise<Models.OAuth2Okta>;
|
|
1249
|
+
updateOAuth2Okta(clientId?: string, clientSecret?: string, domain?: string, authorizationServerId?: string, prompt?: ProjectOAuth2OktaPrompt[], enabled?: boolean): Promise<Models.OAuth2Okta>;
|
|
1213
1250
|
/**
|
|
1214
1251
|
* Update the project OAuth2 Paypal configuration.
|
|
1215
1252
|
*
|
|
@@ -1315,6 +1352,7 @@ export declare class Project {
|
|
|
1315
1352
|
*
|
|
1316
1353
|
* @param {string} params.customerKey - 'Consumer Key' of Salesforce OAuth2 app. For example: 3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq
|
|
1317
1354
|
* @param {string} params.customerSecret - 'Consumer Secret' of Salesforce OAuth2 app. For example: 3w000000000000e2
|
|
1355
|
+
* @param {ProjectOAuth2SalesforcePrompt[]} params.prompt - Array of Salesforce OAuth2 prompt values. "login" means: prompt the user to re-authenticate. "consent" means: prompt the user for consent. Pass an empty array to use the Salesforce default.
|
|
1318
1356
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1319
1357
|
* @throws {AppwriteException}
|
|
1320
1358
|
* @returns {Promise<Models.OAuth2Salesforce>}
|
|
@@ -1322,6 +1360,7 @@ export declare class Project {
|
|
|
1322
1360
|
updateOAuth2Salesforce(params?: {
|
|
1323
1361
|
customerKey?: string;
|
|
1324
1362
|
customerSecret?: string;
|
|
1363
|
+
prompt?: ProjectOAuth2SalesforcePrompt[];
|
|
1325
1364
|
enabled?: boolean;
|
|
1326
1365
|
}): Promise<Models.OAuth2Salesforce>;
|
|
1327
1366
|
/**
|
|
@@ -1329,12 +1368,13 @@ export declare class Project {
|
|
|
1329
1368
|
*
|
|
1330
1369
|
* @param {string} customerKey - 'Consumer Key' of Salesforce OAuth2 app. For example: 3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq
|
|
1331
1370
|
* @param {string} customerSecret - 'Consumer Secret' of Salesforce OAuth2 app. For example: 3w000000000000e2
|
|
1371
|
+
* @param {ProjectOAuth2SalesforcePrompt[]} prompt - Array of Salesforce OAuth2 prompt values. "login" means: prompt the user to re-authenticate. "consent" means: prompt the user for consent. Pass an empty array to use the Salesforce default.
|
|
1332
1372
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1333
1373
|
* @throws {AppwriteException}
|
|
1334
1374
|
* @returns {Promise<Models.OAuth2Salesforce>}
|
|
1335
1375
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1336
1376
|
*/
|
|
1337
|
-
updateOAuth2Salesforce(customerKey?: string, customerSecret?: string, enabled?: boolean): Promise<Models.OAuth2Salesforce>;
|
|
1377
|
+
updateOAuth2Salesforce(customerKey?: string, customerSecret?: string, prompt?: ProjectOAuth2SalesforcePrompt[], enabled?: boolean): Promise<Models.OAuth2Salesforce>;
|
|
1338
1378
|
/**
|
|
1339
1379
|
* Update the project OAuth2 Slack configuration.
|
|
1340
1380
|
*
|
|
@@ -1615,6 +1655,7 @@ export declare class Project {
|
|
|
1615
1655
|
*
|
|
1616
1656
|
* @param {string} params.clientId - 'Client ID' of Zoho OAuth2 app. For example: 1000.83C178000000000000000000RPNX0B
|
|
1617
1657
|
* @param {string} params.clientSecret - 'Client Secret' of Zoho OAuth2 app. For example: fb5cac000000000000000000000000000000a68f6e
|
|
1658
|
+
* @param {ProjectOAuth2ZohoPrompt[]} params.prompt - Array of Zoho OAuth2 prompt values. "consent" means: prompt the user for consent. Pass an empty array to use the Zoho default.
|
|
1618
1659
|
* @param {boolean} params.enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1619
1660
|
* @throws {AppwriteException}
|
|
1620
1661
|
* @returns {Promise<Models.OAuth2Zoho>}
|
|
@@ -1622,6 +1663,7 @@ export declare class Project {
|
|
|
1622
1663
|
updateOAuth2Zoho(params?: {
|
|
1623
1664
|
clientId?: string;
|
|
1624
1665
|
clientSecret?: string;
|
|
1666
|
+
prompt?: ProjectOAuth2ZohoPrompt[];
|
|
1625
1667
|
enabled?: boolean;
|
|
1626
1668
|
}): Promise<Models.OAuth2Zoho>;
|
|
1627
1669
|
/**
|
|
@@ -1629,12 +1671,13 @@ export declare class Project {
|
|
|
1629
1671
|
*
|
|
1630
1672
|
* @param {string} clientId - 'Client ID' of Zoho OAuth2 app. For example: 1000.83C178000000000000000000RPNX0B
|
|
1631
1673
|
* @param {string} clientSecret - 'Client Secret' of Zoho OAuth2 app. For example: fb5cac000000000000000000000000000000a68f6e
|
|
1674
|
+
* @param {ProjectOAuth2ZohoPrompt[]} prompt - Array of Zoho OAuth2 prompt values. "consent" means: prompt the user for consent. Pass an empty array to use the Zoho default.
|
|
1632
1675
|
* @param {boolean} enabled - OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1633
1676
|
* @throws {AppwriteException}
|
|
1634
1677
|
* @returns {Promise<Models.OAuth2Zoho>}
|
|
1635
1678
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1636
1679
|
*/
|
|
1637
|
-
updateOAuth2Zoho(clientId?: string, clientSecret?: string, enabled?: boolean): Promise<Models.OAuth2Zoho>;
|
|
1680
|
+
updateOAuth2Zoho(clientId?: string, clientSecret?: string, prompt?: ProjectOAuth2ZohoPrompt[], enabled?: boolean): Promise<Models.OAuth2Zoho>;
|
|
1638
1681
|
/**
|
|
1639
1682
|
* Update the project OAuth2 Zoom configuration.
|
|
1640
1683
|
*
|
|
@@ -2210,6 +2253,31 @@ export declare class Project {
|
|
|
2210
2253
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2211
2254
|
*/
|
|
2212
2255
|
updatePasswordPersonalDataPolicy(enabled: boolean): Promise<Models.Project>;
|
|
2256
|
+
/**
|
|
2257
|
+
* Updating this policy allows you to control if passwords are checked against the Have I Been Pwned breach database. When enabled, every password a user signs up, signs in or resets with is checked and the result is recorded on the user as `passwordPwned`. On its own the policy only records. Enable `users` to reject a breached password when a user signs up or sets a new password, and `sessions` to refuse a sign-in with a breached password until it is reset. Only the first five characters of the password hash are ever shared with the service. Options left out keep their current value.
|
|
2258
|
+
*
|
|
2259
|
+
* @param {boolean} params.enabled - Toggle password pwned policy. Set to true to check passwords against known data breaches and record the result on the user, or false to never check. Default is true. On its own this only records; use `users` and `sessions` to block. When changing this policy, existing passwords remain valid.
|
|
2260
|
+
* @param {boolean} params.sessions - Whether a sign-in with a breached password is refused until the password is reset. Default is false, which allows the sign-in and only records the result.
|
|
2261
|
+
* @param {boolean} params.users - Whether a breached password is rejected when a user signs up or sets a new password. Default is false, which allows the password and only records the result.
|
|
2262
|
+
* @throws {AppwriteException}
|
|
2263
|
+
* @returns {Promise<Models.Project>}
|
|
2264
|
+
*/
|
|
2265
|
+
updatePasswordPwnedPolicy(params?: {
|
|
2266
|
+
enabled?: boolean;
|
|
2267
|
+
sessions?: boolean;
|
|
2268
|
+
users?: boolean;
|
|
2269
|
+
}): Promise<Models.Project>;
|
|
2270
|
+
/**
|
|
2271
|
+
* Updating this policy allows you to control if passwords are checked against the Have I Been Pwned breach database. When enabled, every password a user signs up, signs in or resets with is checked and the result is recorded on the user as `passwordPwned`. On its own the policy only records. Enable `users` to reject a breached password when a user signs up or sets a new password, and `sessions` to refuse a sign-in with a breached password until it is reset. Only the first five characters of the password hash are ever shared with the service. Options left out keep their current value.
|
|
2272
|
+
*
|
|
2273
|
+
* @param {boolean} enabled - Toggle password pwned policy. Set to true to check passwords against known data breaches and record the result on the user, or false to never check. Default is true. On its own this only records; use `users` and `sessions` to block. When changing this policy, existing passwords remain valid.
|
|
2274
|
+
* @param {boolean} sessions - Whether a sign-in with a breached password is refused until the password is reset. Default is false, which allows the sign-in and only records the result.
|
|
2275
|
+
* @param {boolean} users - Whether a breached password is rejected when a user signs up or sets a new password. Default is false, which allows the password and only records the result.
|
|
2276
|
+
* @throws {AppwriteException}
|
|
2277
|
+
* @returns {Promise<Models.Project>}
|
|
2278
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2279
|
+
*/
|
|
2280
|
+
updatePasswordPwnedPolicy(enabled?: boolean, sessions?: boolean, users?: boolean): Promise<Models.Project>;
|
|
2213
2281
|
/**
|
|
2214
2282
|
* Update the password strength requirements for users in the project.
|
|
2215
2283
|
*
|
|
@@ -2339,22 +2407,22 @@ export declare class Project {
|
|
|
2339
2407
|
/**
|
|
2340
2408
|
* Get a policy by its unique ID. This endpoint returns the current configuration for the requested project policy.
|
|
2341
2409
|
*
|
|
2342
|
-
* @param {ProjectPolicyId} params.policyId - Policy ID. Can be one of: password-dictionary, password-history, password-strength, password-personal-data, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy, mfa-factors, deny-aliased-email, deny-disposable-email, deny-free-email, deny-corporate-email.
|
|
2410
|
+
* @param {ProjectPolicyId} params.policyId - Policy ID. Can be one of: password-dictionary, password-history, password-strength, password-personal-data, password-pwned, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy, mfa-factors, deny-aliased-email, deny-disposable-email, deny-free-email, deny-corporate-email.
|
|
2343
2411
|
* @throws {AppwriteException}
|
|
2344
|
-
* @returns {Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordStrength | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy | Models.PolicyMfaFactors | Models.PolicyDenyAliasedEmail | Models.PolicyDenyDisposableEmail | Models.PolicyDenyFreeEmail | Models.PolicyDenyCorporateEmail>}
|
|
2412
|
+
* @returns {Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordStrength | Models.PolicyPasswordPersonalData | Models.PolicyPasswordPwned | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy | Models.PolicyMfaFactors | Models.PolicyDenyAliasedEmail | Models.PolicyDenyDisposableEmail | Models.PolicyDenyFreeEmail | Models.PolicyDenyCorporateEmail>}
|
|
2345
2413
|
*/
|
|
2346
2414
|
getPolicy(params: {
|
|
2347
2415
|
policyId: ProjectPolicyId;
|
|
2348
|
-
}): Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordStrength | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy | Models.PolicyMfaFactors | Models.PolicyDenyAliasedEmail | Models.PolicyDenyDisposableEmail | Models.PolicyDenyFreeEmail | Models.PolicyDenyCorporateEmail>;
|
|
2416
|
+
}): Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordStrength | Models.PolicyPasswordPersonalData | Models.PolicyPasswordPwned | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy | Models.PolicyMfaFactors | Models.PolicyDenyAliasedEmail | Models.PolicyDenyDisposableEmail | Models.PolicyDenyFreeEmail | Models.PolicyDenyCorporateEmail>;
|
|
2349
2417
|
/**
|
|
2350
2418
|
* Get a policy by its unique ID. This endpoint returns the current configuration for the requested project policy.
|
|
2351
2419
|
*
|
|
2352
|
-
* @param {ProjectPolicyId} policyId - Policy ID. Can be one of: password-dictionary, password-history, password-strength, password-personal-data, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy, mfa-factors, deny-aliased-email, deny-disposable-email, deny-free-email, deny-corporate-email.
|
|
2420
|
+
* @param {ProjectPolicyId} policyId - Policy ID. Can be one of: password-dictionary, password-history, password-strength, password-personal-data, password-pwned, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy, mfa-factors, deny-aliased-email, deny-disposable-email, deny-free-email, deny-corporate-email.
|
|
2353
2421
|
* @throws {AppwriteException}
|
|
2354
|
-
* @returns {Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordStrength | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy | Models.PolicyMfaFactors | Models.PolicyDenyAliasedEmail | Models.PolicyDenyDisposableEmail | Models.PolicyDenyFreeEmail | Models.PolicyDenyCorporateEmail>}
|
|
2422
|
+
* @returns {Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordStrength | Models.PolicyPasswordPersonalData | Models.PolicyPasswordPwned | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy | Models.PolicyMfaFactors | Models.PolicyDenyAliasedEmail | Models.PolicyDenyDisposableEmail | Models.PolicyDenyFreeEmail | Models.PolicyDenyCorporateEmail>}
|
|
2355
2423
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2356
2424
|
*/
|
|
2357
|
-
getPolicy(policyId: ProjectPolicyId): Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordStrength | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy | Models.PolicyMfaFactors | Models.PolicyDenyAliasedEmail | Models.PolicyDenyDisposableEmail | Models.PolicyDenyFreeEmail | Models.PolicyDenyCorporateEmail>;
|
|
2425
|
+
getPolicy(policyId: ProjectPolicyId): Promise<Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordStrength | Models.PolicyPasswordPersonalData | Models.PolicyPasswordPwned | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy | Models.PolicyMfaFactors | Models.PolicyDenyAliasedEmail | Models.PolicyDenyDisposableEmail | Models.PolicyDenyFreeEmail | Models.PolicyDenyCorporateEmail>;
|
|
2358
2426
|
/**
|
|
2359
2427
|
* Update properties of a specific protocol. Use this endpoint to enable or disable a protocol in your project.
|
|
2360
2428
|
*
|
|
@@ -2489,7 +2557,7 @@ export declare class Project {
|
|
|
2489
2557
|
/**
|
|
2490
2558
|
* Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.
|
|
2491
2559
|
*
|
|
2492
|
-
* @param {ProjectEmailTemplateId} params.templateId - Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession
|
|
2560
|
+
* @param {ProjectEmailTemplateId} params.templateId - Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession, otpVerification, otpRecovery
|
|
2493
2561
|
* @param {ProjectEmailTemplateLocale} params.locale - Custom email template locale. If left empty, the fallback locale (en) will be used.
|
|
2494
2562
|
* @param {string} params.subject - Subject of the email template. Can be up to 255 characters.
|
|
2495
2563
|
* @param {string} params.message - Plain or HTML body of the email template message. Can be up to 10MB of content.
|
|
@@ -2513,7 +2581,7 @@ export declare class Project {
|
|
|
2513
2581
|
/**
|
|
2514
2582
|
* Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.
|
|
2515
2583
|
*
|
|
2516
|
-
* @param {ProjectEmailTemplateId} templateId - Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession
|
|
2584
|
+
* @param {ProjectEmailTemplateId} templateId - Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession, otpVerification, otpRecovery
|
|
2517
2585
|
* @param {ProjectEmailTemplateLocale} locale - Custom email template locale. If left empty, the fallback locale (en) will be used.
|
|
2518
2586
|
* @param {string} subject - Subject of the email template. Can be up to 255 characters.
|
|
2519
2587
|
* @param {string} message - Plain or HTML body of the email template message. Can be up to 10MB of content.
|
|
@@ -2529,7 +2597,7 @@ export declare class Project {
|
|
|
2529
2597
|
/**
|
|
2530
2598
|
* Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details.
|
|
2531
2599
|
*
|
|
2532
|
-
* @param {ProjectEmailTemplateId} params.templateId - Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession
|
|
2600
|
+
* @param {ProjectEmailTemplateId} params.templateId - Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession, otpVerification, otpRecovery
|
|
2533
2601
|
* @param {ProjectEmailTemplateLocale} params.locale - Custom email template locale. If left empty, the fallback locale (en) will be used.
|
|
2534
2602
|
* @throws {AppwriteException}
|
|
2535
2603
|
* @returns {Promise<Models.EmailTemplate>}
|
|
@@ -2541,38 +2609,13 @@ export declare class Project {
|
|
|
2541
2609
|
/**
|
|
2542
2610
|
* Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details.
|
|
2543
2611
|
*
|
|
2544
|
-
* @param {ProjectEmailTemplateId} templateId - Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession
|
|
2612
|
+
* @param {ProjectEmailTemplateId} templateId - Custom email template type. Can be one of: verification, magicSession, recovery, invitation, mfaChallenge, sessionAlert, otpSession, otpVerification, otpRecovery
|
|
2545
2613
|
* @param {ProjectEmailTemplateLocale} locale - Custom email template locale. If left empty, the fallback locale (en) will be used.
|
|
2546
2614
|
* @throws {AppwriteException}
|
|
2547
2615
|
* @returns {Promise<Models.EmailTemplate>}
|
|
2548
2616
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2549
2617
|
*/
|
|
2550
2618
|
getEmailTemplate(templateId: ProjectEmailTemplateId, locale?: ProjectEmailTemplateLocale): Promise<Models.EmailTemplate>;
|
|
2551
|
-
/**
|
|
2552
|
-
* Get comprehensive usage statistics for your project. View metrics including network requests, bandwidth, storage, function executions, database usage, and user activity. Specify a time range with startDate and endDate, and optionally set the data granularity with period (1h or 1d). The response includes both total counts and detailed breakdowns by resource, along with historical data over the specified period.
|
|
2553
|
-
*
|
|
2554
|
-
* @param {string} params.startDate - Starting date for the usage
|
|
2555
|
-
* @param {string} params.endDate - End date for the usage
|
|
2556
|
-
* @param {ProjectUsageRange} params.period - Period used
|
|
2557
|
-
* @throws {AppwriteException}
|
|
2558
|
-
* @returns {Promise<Models.UsageProject>}
|
|
2559
|
-
*/
|
|
2560
|
-
getUsage(params: {
|
|
2561
|
-
startDate: string;
|
|
2562
|
-
endDate: string;
|
|
2563
|
-
period?: ProjectUsageRange;
|
|
2564
|
-
}): Promise<Models.UsageProject>;
|
|
2565
|
-
/**
|
|
2566
|
-
* Get comprehensive usage statistics for your project. View metrics including network requests, bandwidth, storage, function executions, database usage, and user activity. Specify a time range with startDate and endDate, and optionally set the data granularity with period (1h or 1d). The response includes both total counts and detailed breakdowns by resource, along with historical data over the specified period.
|
|
2567
|
-
*
|
|
2568
|
-
* @param {string} startDate - Starting date for the usage
|
|
2569
|
-
* @param {string} endDate - End date for the usage
|
|
2570
|
-
* @param {ProjectUsageRange} period - Period used
|
|
2571
|
-
* @throws {AppwriteException}
|
|
2572
|
-
* @returns {Promise<Models.UsageProject>}
|
|
2573
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2574
|
-
*/
|
|
2575
|
-
getUsage(startDate: string, endDate: string, period?: ProjectUsageRange): Promise<Models.UsageProject>;
|
|
2576
2619
|
/**
|
|
2577
2620
|
* Get a list of all project environment variables.
|
|
2578
2621
|
*
|
|
@@ -164,100 +164,6 @@ export declare class Projects {
|
|
|
164
164
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
165
165
|
*/
|
|
166
166
|
updateConsoleAccess(projectId: string): Promise<{}>;
|
|
167
|
-
/**
|
|
168
|
-
* List all the project\'s dev keys. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.'
|
|
169
|
-
*
|
|
170
|
-
* @param {string} params.projectId - Project unique ID.
|
|
171
|
-
* @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. You may filter on the following attributes: accessedAt, expire
|
|
172
|
-
* @throws {AppwriteException}
|
|
173
|
-
* @returns {Promise<Models.DevKeyList>}
|
|
174
|
-
*/
|
|
175
|
-
listDevKeys(params: {
|
|
176
|
-
projectId: string;
|
|
177
|
-
queries?: string[];
|
|
178
|
-
}): Promise<Models.DevKeyList>;
|
|
179
|
-
/**
|
|
180
|
-
* List all the project\'s dev keys. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.'
|
|
181
|
-
*
|
|
182
|
-
* @param {string} projectId - Project unique ID.
|
|
183
|
-
* @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. You may filter on the following attributes: accessedAt, expire
|
|
184
|
-
* @throws {AppwriteException}
|
|
185
|
-
* @returns {Promise<Models.DevKeyList>}
|
|
186
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
187
|
-
*/
|
|
188
|
-
listDevKeys(projectId: string, queries?: string[]): Promise<Models.DevKeyList>;
|
|
189
|
-
/**
|
|
190
|
-
* Get a project\'s dev key by its unique ID. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.
|
|
191
|
-
*
|
|
192
|
-
* @param {string} params.projectId - Project unique ID.
|
|
193
|
-
* @param {string} params.keyId - Key unique ID.
|
|
194
|
-
* @throws {AppwriteException}
|
|
195
|
-
* @returns {Promise<Models.DevKey>}
|
|
196
|
-
*/
|
|
197
|
-
getDevKey(params: {
|
|
198
|
-
projectId: string;
|
|
199
|
-
keyId: string;
|
|
200
|
-
}): Promise<Models.DevKey>;
|
|
201
|
-
/**
|
|
202
|
-
* Get a project\'s dev key by its unique ID. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.
|
|
203
|
-
*
|
|
204
|
-
* @param {string} projectId - Project unique ID.
|
|
205
|
-
* @param {string} keyId - Key unique ID.
|
|
206
|
-
* @throws {AppwriteException}
|
|
207
|
-
* @returns {Promise<Models.DevKey>}
|
|
208
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
209
|
-
*/
|
|
210
|
-
getDevKey(projectId: string, keyId: string): Promise<Models.DevKey>;
|
|
211
|
-
/**
|
|
212
|
-
* Update a project\'s dev key by its unique ID. Use this endpoint to update a project\'s dev key name or expiration time.'
|
|
213
|
-
*
|
|
214
|
-
* @param {string} params.projectId - Project unique ID.
|
|
215
|
-
* @param {string} params.keyId - Key unique ID.
|
|
216
|
-
* @param {string} params.name - Key name. Max length: 128 chars.
|
|
217
|
-
* @param {string} params.expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
|
218
|
-
* @throws {AppwriteException}
|
|
219
|
-
* @returns {Promise<Models.DevKey>}
|
|
220
|
-
*/
|
|
221
|
-
updateDevKey(params: {
|
|
222
|
-
projectId: string;
|
|
223
|
-
keyId: string;
|
|
224
|
-
name: string;
|
|
225
|
-
expire: string;
|
|
226
|
-
}): Promise<Models.DevKey>;
|
|
227
|
-
/**
|
|
228
|
-
* Update a project\'s dev key by its unique ID. Use this endpoint to update a project\'s dev key name or expiration time.'
|
|
229
|
-
*
|
|
230
|
-
* @param {string} projectId - Project unique ID.
|
|
231
|
-
* @param {string} keyId - Key unique ID.
|
|
232
|
-
* @param {string} name - Key name. Max length: 128 chars.
|
|
233
|
-
* @param {string} expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
|
234
|
-
* @throws {AppwriteException}
|
|
235
|
-
* @returns {Promise<Models.DevKey>}
|
|
236
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
237
|
-
*/
|
|
238
|
-
updateDevKey(projectId: string, keyId: string, name: string, expire: string): Promise<Models.DevKey>;
|
|
239
|
-
/**
|
|
240
|
-
* Delete a project\'s dev key by its unique ID. Once deleted, the key will no longer allow bypassing of rate limits and better logging of errors.
|
|
241
|
-
*
|
|
242
|
-
* @param {string} params.projectId - Project unique ID.
|
|
243
|
-
* @param {string} params.keyId - Key unique ID.
|
|
244
|
-
* @throws {AppwriteException}
|
|
245
|
-
* @returns {Promise<{}>}
|
|
246
|
-
*/
|
|
247
|
-
deleteDevKey(params: {
|
|
248
|
-
projectId: string;
|
|
249
|
-
keyId: string;
|
|
250
|
-
}): Promise<{}>;
|
|
251
|
-
/**
|
|
252
|
-
* Delete a project\'s dev key by its unique ID. Once deleted, the key will no longer allow bypassing of rate limits and better logging of errors.
|
|
253
|
-
*
|
|
254
|
-
* @param {string} projectId - Project unique ID.
|
|
255
|
-
* @param {string} keyId - Key unique ID.
|
|
256
|
-
* @throws {AppwriteException}
|
|
257
|
-
* @returns {Promise<{}>}
|
|
258
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
259
|
-
*/
|
|
260
|
-
deleteDevKey(projectId: string, keyId: string): Promise<{}>;
|
|
261
167
|
/**
|
|
262
168
|
* Get a list of all the project's schedules. You can use the query params to filter your results.
|
|
263
169
|
*
|