@appwrite.io/console 18.3.0-rc.1 → 18.3.0-rc.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/cjs/sdk.js +1695 -1
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +1694 -2
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +1695 -1
- package/package.json +1 -1
- package/types/enums/platform-resource-type.d.ts +11 -0
- package/types/enums/project-auth-method-id.d.ts +2 -1
- package/types/enums/project-key-scopes.d.ts +2 -0
- package/types/enums/project-policy-id.d.ts +2 -1
- package/types/enums/project-resource-type.d.ts +13 -0
- package/types/enums/query-suggestion-resource.d.ts +7 -0
- package/types/enums/video-output.d.ts +5 -0
- package/types/enums/video-rendition-status.d.ts +9 -0
- package/types/index.d.ts +6 -0
- package/types/models.d.ts +450 -42
- package/types/services/account.d.ts +158 -0
- package/types/services/admin.d.ts +80 -0
- package/types/services/project.d.ts +30 -8
- package/types/services/users.d.ts +69 -0
- package/types/services/videos.d.ts +860 -0
|
@@ -846,6 +846,135 @@ export declare class Account {
|
|
|
846
846
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
847
847
|
*/
|
|
848
848
|
updateName<Preferences extends Models.Preferences = Models.DefaultPreferences>(name: string): Promise<Models.User<Preferences>>;
|
|
849
|
+
/**
|
|
850
|
+
* Get the list of verified passkeys registered by the currently logged in user.
|
|
851
|
+
*
|
|
852
|
+
* @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 and order on the following attributes: $id, $createdAt, $updatedAt
|
|
853
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
854
|
+
* @throws {AppwriteException}
|
|
855
|
+
* @returns {Promise<Models.PasskeyList>}
|
|
856
|
+
*/
|
|
857
|
+
listPasskeys(params?: {
|
|
858
|
+
queries?: string[];
|
|
859
|
+
total?: boolean;
|
|
860
|
+
}): Promise<Models.PasskeyList>;
|
|
861
|
+
/**
|
|
862
|
+
* Get the list of verified passkeys registered by the currently logged in user.
|
|
863
|
+
*
|
|
864
|
+
* @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 and order on the following attributes: $id, $createdAt, $updatedAt
|
|
865
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
866
|
+
* @throws {AppwriteException}
|
|
867
|
+
* @returns {Promise<Models.PasskeyList>}
|
|
868
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
869
|
+
*/
|
|
870
|
+
listPasskeys(queries?: string[], total?: boolean): Promise<Models.PasskeyList>;
|
|
871
|
+
/**
|
|
872
|
+
* Start registering a passkey for the currently logged in user. The session must have signed in or completed an MFA challenge within the last 10 minutes. Pass the returned `publicKey` options to `navigator.credentials.create()`, then complete the registration with [Update passkey verification](/docs/references/cloud/client-web/account#updatePasskeyVerification). The passkey stays pending until verified, and the challenge expires after 5 minutes.
|
|
873
|
+
*
|
|
874
|
+
* @param {string} params.passkeyId - Passkey ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
875
|
+
* @param {string} params.name - Passkey name, shown when listing passkeys. Max length: 128 chars.
|
|
876
|
+
* @throws {AppwriteException}
|
|
877
|
+
* @returns {Promise<Models.PasskeyChallenge>}
|
|
878
|
+
*/
|
|
879
|
+
createPasskey(params?: {
|
|
880
|
+
passkeyId?: string;
|
|
881
|
+
name?: string;
|
|
882
|
+
}): Promise<Models.PasskeyChallenge>;
|
|
883
|
+
/**
|
|
884
|
+
* Start registering a passkey for the currently logged in user. The session must have signed in or completed an MFA challenge within the last 10 minutes. Pass the returned `publicKey` options to `navigator.credentials.create()`, then complete the registration with [Update passkey verification](/docs/references/cloud/client-web/account#updatePasskeyVerification). The passkey stays pending until verified, and the challenge expires after 5 minutes.
|
|
885
|
+
*
|
|
886
|
+
* @param {string} passkeyId - Passkey ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
887
|
+
* @param {string} name - Passkey name, shown when listing passkeys. Max length: 128 chars.
|
|
888
|
+
* @throws {AppwriteException}
|
|
889
|
+
* @returns {Promise<Models.PasskeyChallenge>}
|
|
890
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
891
|
+
*/
|
|
892
|
+
createPasskey(passkeyId?: string, name?: string): Promise<Models.PasskeyChallenge>;
|
|
893
|
+
/**
|
|
894
|
+
* Get a verified passkey of the currently logged in user by its unique ID.
|
|
895
|
+
*
|
|
896
|
+
* @param {string} params.passkeyId - Passkey ID.
|
|
897
|
+
* @throws {AppwriteException}
|
|
898
|
+
* @returns {Promise<Models.Passkey>}
|
|
899
|
+
*/
|
|
900
|
+
getPasskey(params: {
|
|
901
|
+
passkeyId: string;
|
|
902
|
+
}): Promise<Models.Passkey>;
|
|
903
|
+
/**
|
|
904
|
+
* Get a verified passkey of the currently logged in user by its unique ID.
|
|
905
|
+
*
|
|
906
|
+
* @param {string} passkeyId - Passkey ID.
|
|
907
|
+
* @throws {AppwriteException}
|
|
908
|
+
* @returns {Promise<Models.Passkey>}
|
|
909
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
910
|
+
*/
|
|
911
|
+
getPasskey(passkeyId: string): Promise<Models.Passkey>;
|
|
912
|
+
/**
|
|
913
|
+
* Rename a passkey of the currently logged in user.
|
|
914
|
+
*
|
|
915
|
+
* @param {string} params.passkeyId - Passkey ID.
|
|
916
|
+
* @param {string} params.name - Passkey name. Max length: 128 chars.
|
|
917
|
+
* @throws {AppwriteException}
|
|
918
|
+
* @returns {Promise<Models.Passkey>}
|
|
919
|
+
*/
|
|
920
|
+
updatePasskey(params: {
|
|
921
|
+
passkeyId: string;
|
|
922
|
+
name: string;
|
|
923
|
+
}): Promise<Models.Passkey>;
|
|
924
|
+
/**
|
|
925
|
+
* Rename a passkey of the currently logged in user.
|
|
926
|
+
*
|
|
927
|
+
* @param {string} passkeyId - Passkey ID.
|
|
928
|
+
* @param {string} name - Passkey name. Max length: 128 chars.
|
|
929
|
+
* @throws {AppwriteException}
|
|
930
|
+
* @returns {Promise<Models.Passkey>}
|
|
931
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
932
|
+
*/
|
|
933
|
+
updatePasskey(passkeyId: string, name: string): Promise<Models.Passkey>;
|
|
934
|
+
/**
|
|
935
|
+
* Delete a passkey from the currently logged in user. The passkey can no longer be used to sign in, although it may remain stored on the user's device. The session must have signed in or completed an MFA challenge within the last 10 minutes.
|
|
936
|
+
*
|
|
937
|
+
* @param {string} params.passkeyId - Passkey ID.
|
|
938
|
+
* @throws {AppwriteException}
|
|
939
|
+
* @returns {Promise<{}>}
|
|
940
|
+
*/
|
|
941
|
+
deletePasskey(params: {
|
|
942
|
+
passkeyId: string;
|
|
943
|
+
}): Promise<{}>;
|
|
944
|
+
/**
|
|
945
|
+
* Delete a passkey from the currently logged in user. The passkey can no longer be used to sign in, although it may remain stored on the user's device. The session must have signed in or completed an MFA challenge within the last 10 minutes.
|
|
946
|
+
*
|
|
947
|
+
* @param {string} passkeyId - Passkey ID.
|
|
948
|
+
* @throws {AppwriteException}
|
|
949
|
+
* @returns {Promise<{}>}
|
|
950
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
951
|
+
*/
|
|
952
|
+
deletePasskey(passkeyId: string): Promise<{}>;
|
|
953
|
+
/**
|
|
954
|
+
* Complete a passkey registration started with [Create passkey](/docs/references/cloud/client-web/account#createPasskey). Pass the challenge ID and the JSON form of the credential returned by `navigator.credentials.create()`, for example `credential.toJSON()`. Each challenge can only be used once.
|
|
955
|
+
*
|
|
956
|
+
* @param {string} params.passkeyId - Passkey ID.
|
|
957
|
+
* @param {string} params.challengeId - Challenge ID returned when the passkey was created.
|
|
958
|
+
* @param {object} params.credential - Registration credential returned by the authenticator, in the JSON form produced by `PublicKeyCredential.toJSON()`.
|
|
959
|
+
* @throws {AppwriteException}
|
|
960
|
+
* @returns {Promise<Models.Passkey>}
|
|
961
|
+
*/
|
|
962
|
+
updatePasskeyVerification(params: {
|
|
963
|
+
passkeyId: string;
|
|
964
|
+
challengeId: string;
|
|
965
|
+
credential: object;
|
|
966
|
+
}): Promise<Models.Passkey>;
|
|
967
|
+
/**
|
|
968
|
+
* Complete a passkey registration started with [Create passkey](/docs/references/cloud/client-web/account#createPasskey). Pass the challenge ID and the JSON form of the credential returned by `navigator.credentials.create()`, for example `credential.toJSON()`. Each challenge can only be used once.
|
|
969
|
+
*
|
|
970
|
+
* @param {string} passkeyId - Passkey ID.
|
|
971
|
+
* @param {string} challengeId - Challenge ID returned when the passkey was created.
|
|
972
|
+
* @param {object} credential - Registration credential returned by the authenticator, in the JSON form produced by `PublicKeyCredential.toJSON()`.
|
|
973
|
+
* @throws {AppwriteException}
|
|
974
|
+
* @returns {Promise<Models.Passkey>}
|
|
975
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
976
|
+
*/
|
|
977
|
+
updatePasskeyVerification(passkeyId: string, challengeId: string, credential: object): Promise<Models.Passkey>;
|
|
849
978
|
/**
|
|
850
979
|
* Update currently logged in user password. For validation, user is required to pass in the new password, and the old password. For users created with OAuth, Team Invites and Magic URL, oldPassword is optional.
|
|
851
980
|
*
|
|
@@ -1632,6 +1761,35 @@ export declare class Account {
|
|
|
1632
1761
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1633
1762
|
*/
|
|
1634
1763
|
createOAuth2Token(provider: OAuthProvider, success?: string, failure?: string, scopes?: string[]): void | string;
|
|
1764
|
+
/**
|
|
1765
|
+
* Start signing in with a passkey. No email or user ID is needed: pass the returned `publicKey` options to `navigator.credentials.get()` and the user picks one of their passkeys. Then call [Update passkey token](/docs/references/cloud/client-web/account#updatePasskeyToken) with the credential to receive a token, and exchange it with [Create session](/docs/references/cloud/client-web/account#createSession). The challenge expires after 5 minutes.
|
|
1766
|
+
*
|
|
1767
|
+
* @throws {AppwriteException}
|
|
1768
|
+
* @returns {Promise<Models.PasskeyChallenge>}
|
|
1769
|
+
*/
|
|
1770
|
+
createPasskeyToken(): Promise<Models.PasskeyChallenge>;
|
|
1771
|
+
/**
|
|
1772
|
+
* Complete a passkey sign-in started with [Create passkey token](/docs/references/cloud/client-web/account#createPasskeyToken). Pass the challenge ID and the JSON form of the credential returned by `navigator.credentials.get()`, for example `credential.toJSON()`. The returned token includes its secret and expires after 1 minute: exchange it for a session with [Create session](/docs/references/cloud/client-web/account#createSession). Passkeys require user verification, so the session also satisfies MFA. Each challenge can only be used once.
|
|
1773
|
+
*
|
|
1774
|
+
* @param {string} params.challengeId - Challenge ID returned by createPasskeyToken.
|
|
1775
|
+
* @param {object} params.credential - Authentication credential returned by the authenticator, in the JSON form produced by `PublicKeyCredential.toJSON()`.
|
|
1776
|
+
* @throws {AppwriteException}
|
|
1777
|
+
* @returns {Promise<Models.Token>}
|
|
1778
|
+
*/
|
|
1779
|
+
updatePasskeyToken(params: {
|
|
1780
|
+
challengeId: string;
|
|
1781
|
+
credential: object;
|
|
1782
|
+
}): Promise<Models.Token>;
|
|
1783
|
+
/**
|
|
1784
|
+
* Complete a passkey sign-in started with [Create passkey token](/docs/references/cloud/client-web/account#createPasskeyToken). Pass the challenge ID and the JSON form of the credential returned by `navigator.credentials.get()`, for example `credential.toJSON()`. The returned token includes its secret and expires after 1 minute: exchange it for a session with [Create session](/docs/references/cloud/client-web/account#createSession). Passkeys require user verification, so the session also satisfies MFA. Each challenge can only be used once.
|
|
1785
|
+
*
|
|
1786
|
+
* @param {string} challengeId - Challenge ID returned by createPasskeyToken.
|
|
1787
|
+
* @param {object} credential - Authentication credential returned by the authenticator, in the JSON form produced by `PublicKeyCredential.toJSON()`.
|
|
1788
|
+
* @throws {AppwriteException}
|
|
1789
|
+
* @returns {Promise<Models.Token>}
|
|
1790
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1791
|
+
*/
|
|
1792
|
+
updatePasskeyToken(challengeId: string, credential: object): Promise<Models.Token>;
|
|
1635
1793
|
/**
|
|
1636
1794
|
* Sends the user an SMS with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint to complete the login process. The secret sent to the user's phone is valid for 15 minutes.
|
|
1637
1795
|
*
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
import { Client } from '../client';
|
|
2
|
+
import { PlatformResourceType } from '../enums/platform-resource-type';
|
|
3
|
+
import { ProjectResourceType } from '../enums/project-resource-type';
|
|
4
|
+
export declare class Admin {
|
|
5
|
+
client: Client;
|
|
6
|
+
constructor(client: Client);
|
|
7
|
+
/**
|
|
8
|
+
* Delete everything cached from the platform database in the region serving the request.
|
|
9
|
+
*
|
|
10
|
+
* @throws {AppwriteException}
|
|
11
|
+
* @returns {Promise<{}>}
|
|
12
|
+
*/
|
|
13
|
+
deletePlatformCache(): Promise<{}>;
|
|
14
|
+
/**
|
|
15
|
+
* Delete the cache of one platform resource, or of every resource of a type, in the region serving the request.
|
|
16
|
+
*
|
|
17
|
+
* @param {PlatformResourceType} params.resourceType - Resource type.
|
|
18
|
+
* @param {string} params.resourceId - Resource ID. Leave empty to delete the cache of every resource of this type.
|
|
19
|
+
* @throws {AppwriteException}
|
|
20
|
+
* @returns {Promise<{}>}
|
|
21
|
+
*/
|
|
22
|
+
deletePlatformResourceCache(params: {
|
|
23
|
+
resourceType: PlatformResourceType;
|
|
24
|
+
resourceId?: string;
|
|
25
|
+
}): Promise<{}>;
|
|
26
|
+
/**
|
|
27
|
+
* Delete the cache of one platform resource, or of every resource of a type, in the region serving the request.
|
|
28
|
+
*
|
|
29
|
+
* @param {PlatformResourceType} resourceType - Resource type.
|
|
30
|
+
* @param {string} resourceId - Resource ID. Leave empty to delete the cache of every resource of this type.
|
|
31
|
+
* @throws {AppwriteException}
|
|
32
|
+
* @returns {Promise<{}>}
|
|
33
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
34
|
+
*/
|
|
35
|
+
deletePlatformResourceCache(resourceType: PlatformResourceType, resourceId?: string): Promise<{}>;
|
|
36
|
+
/**
|
|
37
|
+
* Delete everything cached for a project. Send the request to the project's region.
|
|
38
|
+
*
|
|
39
|
+
* @param {string} params.projectId - Project ID.
|
|
40
|
+
* @throws {AppwriteException}
|
|
41
|
+
* @returns {Promise<{}>}
|
|
42
|
+
*/
|
|
43
|
+
deleteProjectCache(params: {
|
|
44
|
+
projectId: string;
|
|
45
|
+
}): Promise<{}>;
|
|
46
|
+
/**
|
|
47
|
+
* Delete everything cached for a project. Send the request to the project's region.
|
|
48
|
+
*
|
|
49
|
+
* @param {string} projectId - Project ID.
|
|
50
|
+
* @throws {AppwriteException}
|
|
51
|
+
* @returns {Promise<{}>}
|
|
52
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
53
|
+
*/
|
|
54
|
+
deleteProjectCache(projectId: string): Promise<{}>;
|
|
55
|
+
/**
|
|
56
|
+
* Delete the cache of one project resource, or of every resource of a type. Send the request to the project's region.
|
|
57
|
+
*
|
|
58
|
+
* @param {string} params.projectId - Project ID.
|
|
59
|
+
* @param {ProjectResourceType} params.resourceType - Resource type.
|
|
60
|
+
* @param {string} params.resourceId - Resource ID. Leave empty to delete the cache of every resource of this type.
|
|
61
|
+
* @throws {AppwriteException}
|
|
62
|
+
* @returns {Promise<{}>}
|
|
63
|
+
*/
|
|
64
|
+
deleteProjectResourceCache(params: {
|
|
65
|
+
projectId: string;
|
|
66
|
+
resourceType: ProjectResourceType;
|
|
67
|
+
resourceId?: string;
|
|
68
|
+
}): Promise<{}>;
|
|
69
|
+
/**
|
|
70
|
+
* Delete the cache of one project resource, or of every resource of a type. Send the request to the project's region.
|
|
71
|
+
*
|
|
72
|
+
* @param {string} projectId - Project ID.
|
|
73
|
+
* @param {ProjectResourceType} resourceType - Resource type.
|
|
74
|
+
* @param {string} resourceId - Resource ID. Leave empty to delete the cache of every resource of this type.
|
|
75
|
+
* @throws {AppwriteException}
|
|
76
|
+
* @returns {Promise<{}>}
|
|
77
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
78
|
+
*/
|
|
79
|
+
deleteProjectResourceCache(projectId: string, resourceType: ProjectResourceType, resourceId?: string): Promise<{}>;
|
|
80
|
+
}
|
|
@@ -39,7 +39,7 @@ export declare class Project {
|
|
|
39
39
|
/**
|
|
40
40
|
* Update properties of a specific auth method. Use this endpoint to enable or disable a method in your project.
|
|
41
41
|
*
|
|
42
|
-
* @param {ProjectAuthMethodId} params.methodId - Auth Method ID. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone
|
|
42
|
+
* @param {ProjectAuthMethodId} params.methodId - Auth Method ID. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone,passkey
|
|
43
43
|
* @param {boolean} params.enabled - Auth method status.
|
|
44
44
|
* @throws {AppwriteException}
|
|
45
45
|
* @returns {Promise<Models.Project>}
|
|
@@ -51,7 +51,7 @@ export declare class Project {
|
|
|
51
51
|
/**
|
|
52
52
|
* Update properties of a specific auth method. Use this endpoint to enable or disable a method in your project.
|
|
53
53
|
*
|
|
54
|
-
* @param {ProjectAuthMethodId} methodId - Auth Method ID. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone
|
|
54
|
+
* @param {ProjectAuthMethodId} methodId - Auth Method ID. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone,passkey
|
|
55
55
|
* @param {boolean} enabled - Auth method status.
|
|
56
56
|
* @throws {AppwriteException}
|
|
57
57
|
* @returns {Promise<Models.Project>}
|
|
@@ -2217,6 +2217,28 @@ export declare class Project {
|
|
|
2217
2217
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2218
2218
|
*/
|
|
2219
2219
|
updateMFAFactorsPolicy(totp?: boolean, email?: boolean, phone?: boolean, custom?: boolean): Promise<Models.Project>;
|
|
2220
|
+
/**
|
|
2221
|
+
* Configure the relying party passkeys are bound to. The relying party ID is the domain of your application, and origins are the exact web origins allowed to register and sign in with passkeys. Passkeys stay unavailable until both are set and the passkey auth method is enabled. The relying party ID cannot change while users have passkeys, and any change invalidates ceremonies in progress.
|
|
2222
|
+
*
|
|
2223
|
+
* @param {string} params.rpId - Relying party ID: the domain of your application, such as `example.com`. Use `localhost` for local development.
|
|
2224
|
+
* @param {string[]} params.origins - Web origins allowed to use passkeys, such as `https://example.com` or `https://app.example.com`. Each must be HTTPS on the relying party ID or one of its subdomains, without a path. HTTP is only allowed for `localhost`. Maximum of 10 origins.
|
|
2225
|
+
* @throws {AppwriteException}
|
|
2226
|
+
* @returns {Promise<Models.Project>}
|
|
2227
|
+
*/
|
|
2228
|
+
updatePasskeyPolicy(params?: {
|
|
2229
|
+
rpId?: string;
|
|
2230
|
+
origins?: string[];
|
|
2231
|
+
}): Promise<Models.Project>;
|
|
2232
|
+
/**
|
|
2233
|
+
* Configure the relying party passkeys are bound to. The relying party ID is the domain of your application, and origins are the exact web origins allowed to register and sign in with passkeys. Passkeys stay unavailable until both are set and the passkey auth method is enabled. The relying party ID cannot change while users have passkeys, and any change invalidates ceremonies in progress.
|
|
2234
|
+
*
|
|
2235
|
+
* @param {string} rpId - Relying party ID: the domain of your application, such as `example.com`. Use `localhost` for local development.
|
|
2236
|
+
* @param {string[]} origins - Web origins allowed to use passkeys, such as `https://example.com` or `https://app.example.com`. Each must be HTTPS on the relying party ID or one of its subdomains, without a path. HTTP is only allowed for `localhost`. Maximum of 10 origins.
|
|
2237
|
+
* @throws {AppwriteException}
|
|
2238
|
+
* @returns {Promise<Models.Project>}
|
|
2239
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2240
|
+
*/
|
|
2241
|
+
updatePasskeyPolicy(rpId?: string, origins?: string[]): Promise<Models.Project>;
|
|
2220
2242
|
/**
|
|
2221
2243
|
* Updating this policy allows you to control if new passwords are checked against most common passwords dictionary. When enabled, and user changes their password, password must not be contained in the dictionary.
|
|
2222
2244
|
*
|
|
@@ -2432,22 +2454,22 @@ export declare class Project {
|
|
|
2432
2454
|
/**
|
|
2433
2455
|
* Get a policy by its unique ID. This endpoint returns the current configuration for the requested project policy.
|
|
2434
2456
|
*
|
|
2435
|
-
* @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.
|
|
2457
|
+
* @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, passkey.
|
|
2436
2458
|
* @throws {AppwriteException}
|
|
2437
|
-
* @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>}
|
|
2459
|
+
* @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 | Models.PolicyPasskey>}
|
|
2438
2460
|
*/
|
|
2439
2461
|
getPolicy(params: {
|
|
2440
2462
|
policyId: ProjectPolicyId;
|
|
2441
|
-
}): 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>;
|
|
2463
|
+
}): 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 | Models.PolicyPasskey>;
|
|
2442
2464
|
/**
|
|
2443
2465
|
* Get a policy by its unique ID. This endpoint returns the current configuration for the requested project policy.
|
|
2444
2466
|
*
|
|
2445
|
-
* @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.
|
|
2467
|
+
* @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, passkey.
|
|
2446
2468
|
* @throws {AppwriteException}
|
|
2447
|
-
* @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>}
|
|
2469
|
+
* @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 | Models.PolicyPasskey>}
|
|
2448
2470
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2449
2471
|
*/
|
|
2450
|
-
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>;
|
|
2472
|
+
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 | Models.PolicyPasskey>;
|
|
2451
2473
|
/**
|
|
2452
2474
|
* Update properties of a specific protocol. Use this endpoint to enable or disable a protocol in your project.
|
|
2453
2475
|
*
|
|
@@ -804,6 +804,75 @@ export declare class Users {
|
|
|
804
804
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
805
805
|
*/
|
|
806
806
|
updateName<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, name: string): Promise<Models.User<Preferences>>;
|
|
807
|
+
/**
|
|
808
|
+
* Get the list of verified passkeys registered by a user.
|
|
809
|
+
*
|
|
810
|
+
* @param {string} params.userId - User ID.
|
|
811
|
+
* @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 and order on the following attributes: $id, $createdAt, $updatedAt
|
|
812
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
813
|
+
* @throws {AppwriteException}
|
|
814
|
+
* @returns {Promise<Models.PasskeyList>}
|
|
815
|
+
*/
|
|
816
|
+
listPasskeys(params: {
|
|
817
|
+
userId: string;
|
|
818
|
+
queries?: string[];
|
|
819
|
+
total?: boolean;
|
|
820
|
+
}): Promise<Models.PasskeyList>;
|
|
821
|
+
/**
|
|
822
|
+
* Get the list of verified passkeys registered by a user.
|
|
823
|
+
*
|
|
824
|
+
* @param {string} userId - User ID.
|
|
825
|
+
* @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 and order on the following attributes: $id, $createdAt, $updatedAt
|
|
826
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
827
|
+
* @throws {AppwriteException}
|
|
828
|
+
* @returns {Promise<Models.PasskeyList>}
|
|
829
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
830
|
+
*/
|
|
831
|
+
listPasskeys(userId: string, queries?: string[], total?: boolean): Promise<Models.PasskeyList>;
|
|
832
|
+
/**
|
|
833
|
+
* Get a verified passkey of a user by its unique ID.
|
|
834
|
+
*
|
|
835
|
+
* @param {string} params.userId - User ID.
|
|
836
|
+
* @param {string} params.passkeyId - Passkey ID.
|
|
837
|
+
* @throws {AppwriteException}
|
|
838
|
+
* @returns {Promise<Models.Passkey>}
|
|
839
|
+
*/
|
|
840
|
+
getPasskey(params: {
|
|
841
|
+
userId: string;
|
|
842
|
+
passkeyId: string;
|
|
843
|
+
}): Promise<Models.Passkey>;
|
|
844
|
+
/**
|
|
845
|
+
* Get a verified passkey of a user by its unique ID.
|
|
846
|
+
*
|
|
847
|
+
* @param {string} userId - User ID.
|
|
848
|
+
* @param {string} passkeyId - Passkey ID.
|
|
849
|
+
* @throws {AppwriteException}
|
|
850
|
+
* @returns {Promise<Models.Passkey>}
|
|
851
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
852
|
+
*/
|
|
853
|
+
getPasskey(userId: string, passkeyId: string): Promise<Models.Passkey>;
|
|
854
|
+
/**
|
|
855
|
+
* Delete a passkey from a user, for example when a device is lost. The passkey can no longer be used to sign in.
|
|
856
|
+
*
|
|
857
|
+
* @param {string} params.userId - User ID.
|
|
858
|
+
* @param {string} params.passkeyId - Passkey ID.
|
|
859
|
+
* @throws {AppwriteException}
|
|
860
|
+
* @returns {Promise<{}>}
|
|
861
|
+
*/
|
|
862
|
+
deletePasskey(params: {
|
|
863
|
+
userId: string;
|
|
864
|
+
passkeyId: string;
|
|
865
|
+
}): Promise<{}>;
|
|
866
|
+
/**
|
|
867
|
+
* Delete a passkey from a user, for example when a device is lost. The passkey can no longer be used to sign in.
|
|
868
|
+
*
|
|
869
|
+
* @param {string} userId - User ID.
|
|
870
|
+
* @param {string} passkeyId - Passkey ID.
|
|
871
|
+
* @throws {AppwriteException}
|
|
872
|
+
* @returns {Promise<{}>}
|
|
873
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
874
|
+
*/
|
|
875
|
+
deletePasskey(userId: string, passkeyId: string): Promise<{}>;
|
|
807
876
|
/**
|
|
808
877
|
* Update the user password by its unique ID.
|
|
809
878
|
*
|