@appwrite.io/console 18.4.0-rc.2 → 18.4.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.
@@ -0,0 +1,11 @@
1
+ import { Client } from './client';
2
+ import type { Payload } from './client';
3
+ export declare class Service {
4
+ /**
5
+ * The size for chunked uploads in bytes.
6
+ */
7
+ static CHUNK_SIZE: number;
8
+ client: Client;
9
+ constructor(client: Client);
10
+ static flatten(data: Payload, prefix?: string): Payload;
11
+ }
@@ -849,7 +849,7 @@ export declare class Account {
849
849
  /**
850
850
  * Get the list of verified passkeys registered by the currently logged in user.
851
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
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, name, accessedAt
853
853
  * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
854
854
  * @throws {AppwriteException}
855
855
  * @returns {Promise<Models.PasskeyList>}
@@ -861,7 +861,7 @@ export declare class Account {
861
861
  /**
862
862
  * Get the list of verified passkeys registered by the currently logged in user.
863
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
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, name, accessedAt
865
865
  * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
866
866
  * @throws {AppwriteException}
867
867
  * @returns {Promise<Models.PasskeyList>}
@@ -951,30 +951,27 @@ export declare class Account {
951
951
  */
952
952
  deletePasskey(passkeyId: string): Promise<{}>;
953
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.
954
+ * Complete a passkey registration started with [Create passkey](/docs/references/cloud/client-web/account#createPasskey). Pass the JSON form of the credential returned by `navigator.credentials.create()`, for example `credential.toJSON()`. Each registration can be verified once; a failed attempt requires starting it again.
955
955
  *
956
956
  * @param {string} params.passkeyId - Passkey ID.
957
- * @param {string} params.challengeId - Challenge ID returned when the passkey was created.
958
957
  * @param {object} params.credential - Registration credential returned by the authenticator, in the JSON form produced by `PublicKeyCredential.toJSON()`.
959
958
  * @throws {AppwriteException}
960
959
  * @returns {Promise<Models.Passkey>}
961
960
  */
962
961
  updatePasskeyVerification(params: {
963
962
  passkeyId: string;
964
- challengeId: string;
965
963
  credential: object;
966
964
  }): Promise<Models.Passkey>;
967
965
  /**
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.
966
+ * Complete a passkey registration started with [Create passkey](/docs/references/cloud/client-web/account#createPasskey). Pass the JSON form of the credential returned by `navigator.credentials.create()`, for example `credential.toJSON()`. Each registration can be verified once; a failed attempt requires starting it again.
969
967
  *
970
968
  * @param {string} passkeyId - Passkey ID.
971
- * @param {string} challengeId - Challenge ID returned when the passkey was created.
972
969
  * @param {object} credential - Registration credential returned by the authenticator, in the JSON form produced by `PublicKeyCredential.toJSON()`.
973
970
  * @throws {AppwriteException}
974
971
  * @returns {Promise<Models.Passkey>}
975
972
  * @deprecated Use the object parameter style method for a better developer experience.
976
973
  */
977
- updatePasskeyVerification(passkeyId: string, challengeId: string, credential: object): Promise<Models.Passkey>;
974
+ updatePasskeyVerification(passkeyId: string, credential: object): Promise<Models.Passkey>;
978
975
  /**
979
976
  * 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.
980
977
  *
@@ -1774,22 +1771,22 @@ export declare class Account {
1774
1771
  * @param {string} params.challengeId - Challenge ID returned by createPasskeyToken.
1775
1772
  * @param {object} params.credential - Authentication credential returned by the authenticator, in the JSON form produced by `PublicKeyCredential.toJSON()`.
1776
1773
  * @throws {AppwriteException}
1777
- * @returns {Promise<Models.Token>}
1774
+ * @returns {Promise<Models.TokenSecret>}
1778
1775
  */
1779
1776
  updatePasskeyToken(params: {
1780
1777
  challengeId: string;
1781
1778
  credential: object;
1782
- }): Promise<Models.Token>;
1779
+ }): Promise<Models.TokenSecret>;
1783
1780
  /**
1784
1781
  * 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
1782
  *
1786
1783
  * @param {string} challengeId - Challenge ID returned by createPasskeyToken.
1787
1784
  * @param {object} credential - Authentication credential returned by the authenticator, in the JSON form produced by `PublicKeyCredential.toJSON()`.
1788
1785
  * @throws {AppwriteException}
1789
- * @returns {Promise<Models.Token>}
1786
+ * @returns {Promise<Models.TokenSecret>}
1790
1787
  * @deprecated Use the object parameter style method for a better developer experience.
1791
1788
  */
1792
- updatePasskeyToken(challengeId: string, credential: object): Promise<Models.Token>;
1789
+ updatePasskeyToken(challengeId: string, credential: object): Promise<Models.TokenSecret>;
1793
1790
  /**
1794
1791
  * 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.
1795
1792
  *
@@ -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,passkey
42
+ * @param {ProjectAuthMethodId} params.methodId - Auth Method ID. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone
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,passkey
54
+ * @param {ProjectAuthMethodId} methodId - Auth Method ID. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone
55
55
  * @param {boolean} enabled - Auth method status.
56
56
  * @throws {AppwriteException}
57
57
  * @returns {Promise<Models.Project>}
@@ -1775,7 +1775,6 @@ export declare class Project {
1775
1775
  * @param {string} params.platformId - Platform 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.
1776
1776
  * @param {string} params.name - Platform name. Max length: 128 chars.
1777
1777
  * @param {string} params.applicationId - Android application ID. Max length: 256 chars.
1778
- * @param {string[]} params.fingerprints - SHA-256 fingerprints of the certificates your app is signed with, such as "14:6D:E9:...:2B:6A". Passkeys created in the app are accepted when its signature matches one. Find them under App signing in Play Console, or with `./gradlew signingReport`.
1779
1778
  * @throws {AppwriteException}
1780
1779
  * @returns {Promise<Models.PlatformAndroid>}
1781
1780
  */
@@ -1783,7 +1782,6 @@ export declare class Project {
1783
1782
  platformId: string;
1784
1783
  name: string;
1785
1784
  applicationId: string;
1786
- fingerprints?: string[];
1787
1785
  }): Promise<Models.PlatformAndroid>;
1788
1786
  /**
1789
1787
  * Create a new Android platform for your project. Use this endpoint to register a new Android platform where your users will run your application which will interact with the Appwrite API.
@@ -1791,19 +1789,17 @@ export declare class Project {
1791
1789
  * @param {string} platformId - Platform 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.
1792
1790
  * @param {string} name - Platform name. Max length: 128 chars.
1793
1791
  * @param {string} applicationId - Android application ID. Max length: 256 chars.
1794
- * @param {string[]} fingerprints - SHA-256 fingerprints of the certificates your app is signed with, such as "14:6D:E9:...:2B:6A". Passkeys created in the app are accepted when its signature matches one. Find them under App signing in Play Console, or with `./gradlew signingReport`.
1795
1792
  * @throws {AppwriteException}
1796
1793
  * @returns {Promise<Models.PlatformAndroid>}
1797
1794
  * @deprecated Use the object parameter style method for a better developer experience.
1798
1795
  */
1799
- createAndroidPlatform(platformId: string, name: string, applicationId: string, fingerprints?: string[]): Promise<Models.PlatformAndroid>;
1796
+ createAndroidPlatform(platformId: string, name: string, applicationId: string): Promise<Models.PlatformAndroid>;
1800
1797
  /**
1801
- * Update an Android platform by its unique ID. Use this endpoint to update the platform's name, application ID or signing certificate fingerprints.
1798
+ * Update an Android platform by its unique ID. Use this endpoint to update the platform's name or application ID.
1802
1799
  *
1803
1800
  * @param {string} params.platformId - Platform ID.
1804
1801
  * @param {string} params.name - Platform name. Max length: 128 chars.
1805
1802
  * @param {string} params.applicationId - Android application ID. Max length: 256 chars.
1806
- * @param {string[]} params.fingerprints - SHA-256 fingerprints of the certificates your app is signed with, such as "14:6D:E9:...:2B:6A". Passkeys created in the app are accepted when its signature matches one. Find them under App signing in Play Console, or with `./gradlew signingReport`. Omit to keep the current list, or pass an empty array to clear it.
1807
1803
  * @throws {AppwriteException}
1808
1804
  * @returns {Promise<Models.PlatformAndroid>}
1809
1805
  */
@@ -1811,20 +1807,18 @@ export declare class Project {
1811
1807
  platformId: string;
1812
1808
  name: string;
1813
1809
  applicationId: string;
1814
- fingerprints?: string[];
1815
1810
  }): Promise<Models.PlatformAndroid>;
1816
1811
  /**
1817
- * Update an Android platform by its unique ID. Use this endpoint to update the platform's name, application ID or signing certificate fingerprints.
1812
+ * Update an Android platform by its unique ID. Use this endpoint to update the platform's name or application ID.
1818
1813
  *
1819
1814
  * @param {string} platformId - Platform ID.
1820
1815
  * @param {string} name - Platform name. Max length: 128 chars.
1821
1816
  * @param {string} applicationId - Android application ID. Max length: 256 chars.
1822
- * @param {string[]} fingerprints - SHA-256 fingerprints of the certificates your app is signed with, such as "14:6D:E9:...:2B:6A". Passkeys created in the app are accepted when its signature matches one. Find them under App signing in Play Console, or with `./gradlew signingReport`. Omit to keep the current list, or pass an empty array to clear it.
1823
1817
  * @throws {AppwriteException}
1824
1818
  * @returns {Promise<Models.PlatformAndroid>}
1825
1819
  * @deprecated Use the object parameter style method for a better developer experience.
1826
1820
  */
1827
- updateAndroidPlatform(platformId: string, name: string, applicationId: string, fingerprints?: string[]): Promise<Models.PlatformAndroid>;
1821
+ updateAndroidPlatform(platformId: string, name: string, applicationId: string): Promise<Models.PlatformAndroid>;
1828
1822
  /**
1829
1823
  * Create a new Apple platform for your project. Use this endpoint to register a new Apple platform where your users will run your application which will interact with the Appwrite API.
1830
1824
  *
@@ -2224,27 +2218,24 @@ export declare class Project {
2224
2218
  */
2225
2219
  updateMFAFactorsPolicy(totp?: boolean, email?: boolean, phone?: boolean, custom?: boolean): Promise<Models.Project>;
2226
2220
  /**
2227
- * 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.
2221
+ * Set the relying party ID passkeys are bound to: the domain of your application. Passkeys work on the project's web platforms on that domain or its subdomains, and on the domain itself for Apple apps. A localhost web platform enables passkeys for local development without a relying party ID. The relying party ID cannot change while users have passkeys, and any change invalidates ceremonies in progress.
2228
2222
  *
2229
- * @param {string} params.rpId - Relying party ID: the domain of your application, such as `example.com`. Use `localhost` for local development.
2230
- * @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.
2223
+ * @param {string} params.rpId - Relying party ID: the domain of your application, such as `example.com`. Use `localhost` for local development, or an empty string to unset it.
2231
2224
  * @throws {AppwriteException}
2232
2225
  * @returns {Promise<Models.Project>}
2233
2226
  */
2234
- updatePasskeyPolicy(params?: {
2235
- rpId?: string;
2236
- origins?: string[];
2227
+ updatePasskeyPolicy(params: {
2228
+ rpId: string;
2237
2229
  }): Promise<Models.Project>;
2238
2230
  /**
2239
- * 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.
2231
+ * Set the relying party ID passkeys are bound to: the domain of your application. Passkeys work on the project's web platforms on that domain or its subdomains, and on the domain itself for Apple apps. A localhost web platform enables passkeys for local development without a relying party ID. The relying party ID cannot change while users have passkeys, and any change invalidates ceremonies in progress.
2240
2232
  *
2241
- * @param {string} rpId - Relying party ID: the domain of your application, such as `example.com`. Use `localhost` for local development.
2242
- * @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.
2233
+ * @param {string} rpId - Relying party ID: the domain of your application, such as `example.com`. Use `localhost` for local development, or an empty string to unset it.
2243
2234
  * @throws {AppwriteException}
2244
2235
  * @returns {Promise<Models.Project>}
2245
2236
  * @deprecated Use the object parameter style method for a better developer experience.
2246
2237
  */
2247
- updatePasskeyPolicy(rpId?: string, origins?: string[]): Promise<Models.Project>;
2238
+ updatePasskeyPolicy(rpId: string): Promise<Models.Project>;
2248
2239
  /**
2249
2240
  * 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.
2250
2241
  *
@@ -2460,22 +2451,22 @@ export declare class Project {
2460
2451
  /**
2461
2452
  * Get a policy by its unique ID. This endpoint returns the current configuration for the requested project policy.
2462
2453
  *
2463
- * @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.
2454
+ * @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.
2464
2455
  * @throws {AppwriteException}
2465
- * @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>}
2456
+ * @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>}
2466
2457
  */
2467
2458
  getPolicy(params: {
2468
2459
  policyId: ProjectPolicyId;
2469
- }): 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>;
2460
+ }): 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>;
2470
2461
  /**
2471
2462
  * Get a policy by its unique ID. This endpoint returns the current configuration for the requested project policy.
2472
2463
  *
2473
- * @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.
2464
+ * @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.
2474
2465
  * @throws {AppwriteException}
2475
- * @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>}
2466
+ * @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>}
2476
2467
  * @deprecated Use the object parameter style method for a better developer experience.
2477
2468
  */
2478
- 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>;
2469
+ 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>;
2479
2470
  /**
2480
2471
  * Update properties of a specific protocol. Use this endpoint to enable or disable a protocol in your project.
2481
2472
  *
@@ -1,4 +1,5 @@
1
1
  import { Client } from '../client';
2
+ import { Service } from '../service';
2
3
  import type { ResolvedTopic, Topic } from '../topic';
3
4
  /** A message delivered on a subscribed topic (the MQTT analog of a Realtime event). */
4
5
  export interface PushMessage {
@@ -57,8 +58,7 @@ export interface PushSubscription {
57
58
  * );
58
59
  * // sub.update({ background: true }); sub.unsubscribe();
59
60
  */
60
- export declare class Push {
61
- client: Client;
61
+ export declare class Push extends Service {
62
62
  private mqtt;
63
63
  private connecting;
64
64
  private Buffer;
@@ -272,7 +272,6 @@ export declare class Teams {
272
272
  *
273
273
  * @param {string} params.teamId - Team ID.
274
274
  * @param {string[]} params.roles - Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 81 characters long.
275
- * @param {string} params.membershipId - Membership 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.
276
275
  * @param {string} params.email - Email of the new team member.
277
276
  * @param {string} params.userId - ID of the user to be added to a team.
278
277
  * @param {string} params.phone - Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
@@ -284,7 +283,6 @@ export declare class Teams {
284
283
  createMembership(params: {
285
284
  teamId: string;
286
285
  roles: string[];
287
- membershipId?: string;
288
286
  email?: string;
289
287
  userId?: string;
290
288
  phone?: string;
@@ -303,7 +301,6 @@ export declare class Teams {
303
301
  *
304
302
  * @param {string} teamId - Team ID.
305
303
  * @param {string[]} roles - Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 81 characters long.
306
- * @param {string} membershipId - Membership 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.
307
304
  * @param {string} email - Email of the new team member.
308
305
  * @param {string} userId - ID of the user to be added to a team.
309
306
  * @param {string} phone - Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
@@ -313,7 +310,7 @@ export declare class Teams {
313
310
  * @returns {Promise<Models.Membership>}
314
311
  * @deprecated Use the object parameter style method for a better developer experience.
315
312
  */
316
- createMembership(teamId: string, roles: string[], membershipId?: string, email?: string, userId?: string, phone?: string, url?: string, name?: string): Promise<Models.Membership>;
313
+ createMembership(teamId: string, roles: string[], email?: string, userId?: string, phone?: string, url?: string, name?: string): Promise<Models.Membership>;
317
314
  /**
318
315
  * Get a team member by the membership unique id. All team members have read access for this resource. Hide sensitive attributes from the response by toggling membership privacy in the Console.
319
316
  *
@@ -808,7 +808,7 @@ export declare class Users {
808
808
  * Get the list of verified passkeys registered by a user.
809
809
  *
810
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
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, name, accessedAt
812
812
  * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
813
813
  * @throws {AppwriteException}
814
814
  * @returns {Promise<Models.PasskeyList>}
@@ -822,7 +822,7 @@ export declare class Users {
822
822
  * Get the list of verified passkeys registered by a user.
823
823
  *
824
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
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, name, accessedAt
826
826
  * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
827
827
  * @throws {AppwriteException}
828
828
  * @returns {Promise<Models.PasskeyList>}
@@ -851,6 +851,31 @@ export declare class Users {
851
851
  * @deprecated Use the object parameter style method for a better developer experience.
852
852
  */
853
853
  getPasskey(userId: string, passkeyId: string): Promise<Models.Passkey>;
854
+ /**
855
+ * Rename a passkey of a user.
856
+ *
857
+ * @param {string} params.userId - User ID.
858
+ * @param {string} params.passkeyId - Passkey ID.
859
+ * @param {string} params.name - Passkey name. Max length: 128 chars.
860
+ * @throws {AppwriteException}
861
+ * @returns {Promise<Models.Passkey>}
862
+ */
863
+ updatePasskey(params: {
864
+ userId: string;
865
+ passkeyId: string;
866
+ name: string;
867
+ }): Promise<Models.Passkey>;
868
+ /**
869
+ * Rename a passkey of a user.
870
+ *
871
+ * @param {string} userId - User ID.
872
+ * @param {string} passkeyId - Passkey ID.
873
+ * @param {string} name - Passkey name. Max length: 128 chars.
874
+ * @throws {AppwriteException}
875
+ * @returns {Promise<Models.Passkey>}
876
+ * @deprecated Use the object parameter style method for a better developer experience.
877
+ */
878
+ updatePasskey(userId: string, passkeyId: string, name: string): Promise<Models.Passkey>;
854
879
  /**
855
880
  * Delete a passkey from a user, for example when a device is lost. The passkey can no longer be used to sign in.
856
881
  *
@@ -1,24 +0,0 @@
1
- export declare enum AnalyticsDimension {
2
- Country = "country",
3
- Region = "region",
4
- City = "city",
5
- Browser = "browser",
6
- OperatingSystem = "operatingSystem",
7
- Device = "device",
8
- ScreenSize = "screenSize",
9
- ReferrerSource = "referrerSource",
10
- Channel = "channel",
11
- UtmSource = "utmSource",
12
- UtmMedium = "utmMedium",
13
- UtmCampaign = "utmCampaign",
14
- UtmContent = "utmContent",
15
- UtmTerm = "utmTerm",
16
- Page = "page",
17
- Hostname = "hostname",
18
- EntryPage = "entryPage",
19
- ExitPage = "exitPage",
20
- TrafficType = "trafficType",
21
- BotName = "botName",
22
- BotCategory = "botCategory",
23
- EventName = "eventName"
24
- }
@@ -1,6 +0,0 @@
1
- export declare enum AnalyticsInterval {
2
- OneHour = "1h",
3
- OneDay = "1d",
4
- OneWeek = "1w",
5
- OneMonth = "1m"
6
- }
@@ -1,11 +0,0 @@
1
- export declare enum PlatformResourceType {
2
- Projects = "projects",
3
- Organizations = "organizations",
4
- Users = "users",
5
- Memberships = "memberships",
6
- Rules = "rules",
7
- Keys = "keys",
8
- Platforms = "platforms",
9
- Webhooks = "webhooks",
10
- Certificates = "certificates"
11
- }
@@ -1,13 +0,0 @@
1
- export declare enum ProjectResourceType {
2
- Users = "users",
3
- Teams = "teams",
4
- Memberships = "memberships",
5
- Databases = "databases",
6
- Buckets = "buckets",
7
- Functions = "functions",
8
- Sites = "sites",
9
- Deployments = "deployments",
10
- Topics = "topics",
11
- Providers = "providers",
12
- Messages = "messages"
13
- }
@@ -1,5 +0,0 @@
1
- export declare enum VideoOutput {
2
- Hls = "hls",
3
- Dash = "dash",
4
- Cmaf = "cmaf"
5
- }
@@ -1,9 +0,0 @@
1
- export declare enum VideoRenditionStatus {
2
- Pending = "pending",
3
- Started = "started",
4
- Ended = "ended",
5
- Uploading = "uploading",
6
- Ready = "ready",
7
- Error = "error",
8
- Aborted = "aborted"
9
- }
@@ -1,80 +0,0 @@
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
- }