@appwrite.io/console 18.3.0 → 18.4.0-rc.1

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,254 @@
1
+ import { Client } from '../client';
2
+ import type { Models } from '../models';
3
+ import { AnalyticsInterval } from '../enums/analytics-interval';
4
+ import { AnalyticsDimension } from '../enums/analytics-dimension';
5
+ export declare class Analytics {
6
+ client: Client;
7
+ constructor(client: Client);
8
+ /**
9
+ * List analytics properties for the current project.
10
+ *
11
+ * @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: name, domain, timezone, enabled, public, snippetId
12
+ * @param {string} params.search - Search term to filter your list results. Matches the property ID, name and domain. Max length: 256 chars.
13
+ * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
14
+ * @throws {AppwriteException}
15
+ * @returns {Promise<Models.AnalyticsPropertyList>}
16
+ */
17
+ listProperties(params?: {
18
+ queries?: string[];
19
+ search?: string;
20
+ total?: boolean;
21
+ }): Promise<Models.AnalyticsPropertyList>;
22
+ /**
23
+ * List analytics properties for the current project.
24
+ *
25
+ * @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: name, domain, timezone, enabled, public, snippetId
26
+ * @param {string} search - Search term to filter your list results. Matches the property ID, name and domain. Max length: 256 chars.
27
+ * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
28
+ * @throws {AppwriteException}
29
+ * @returns {Promise<Models.AnalyticsPropertyList>}
30
+ * @deprecated Use the object parameter style method for a better developer experience.
31
+ */
32
+ listProperties(queries?: string[], search?: string, total?: boolean): Promise<Models.AnalyticsPropertyList>;
33
+ /**
34
+ * Create a new analytics property to track a website or application.
35
+ *
36
+ * @param {string} params.propertyId - Unique ID. Choose a custom ID or generate a random ID with `ID.unique()`. Max length is 36 chars.
37
+ * @param {string} params.name - Human-readable name for this property.
38
+ * @param {string} params.domain - Primary domain to track (e.g. example.com). Optional for native apps.
39
+ * @param {string} params.timezone - IANA timezone used for daily boundaries.
40
+ * @param {boolean} params.enabled - Whether tracking is enabled.
41
+ * @param {boolean} params.xpublic - Whether stats are publicly viewable.
42
+ * @param {string[]} params.allowedOrigins - Allowed origins for tracking. Use ["*"] to allow all.
43
+ * @throws {AppwriteException}
44
+ * @returns {Promise<Models.AnalyticsProperty>}
45
+ */
46
+ createProperty(params: {
47
+ propertyId: string;
48
+ name: string;
49
+ domain?: string;
50
+ timezone?: string;
51
+ enabled?: boolean;
52
+ xpublic?: boolean;
53
+ allowedOrigins?: string[];
54
+ }): Promise<Models.AnalyticsProperty>;
55
+ /**
56
+ * Create a new analytics property to track a website or application.
57
+ *
58
+ * @param {string} propertyId - Unique ID. Choose a custom ID or generate a random ID with `ID.unique()`. Max length is 36 chars.
59
+ * @param {string} name - Human-readable name for this property.
60
+ * @param {string} domain - Primary domain to track (e.g. example.com). Optional for native apps.
61
+ * @param {string} timezone - IANA timezone used for daily boundaries.
62
+ * @param {boolean} enabled - Whether tracking is enabled.
63
+ * @param {boolean} xpublic - Whether stats are publicly viewable.
64
+ * @param {string[]} allowedOrigins - Allowed origins for tracking. Use ["*"] to allow all.
65
+ * @throws {AppwriteException}
66
+ * @returns {Promise<Models.AnalyticsProperty>}
67
+ * @deprecated Use the object parameter style method for a better developer experience.
68
+ */
69
+ createProperty(propertyId: string, name: string, domain?: string, timezone?: string, enabled?: boolean, xpublic?: boolean, allowedOrigins?: string[]): Promise<Models.AnalyticsProperty>;
70
+ /**
71
+ * Get an analytics property by ID.
72
+ *
73
+ * @param {string} params.propertyId - Analytics property unique ID.
74
+ * @throws {AppwriteException}
75
+ * @returns {Promise<Models.AnalyticsProperty>}
76
+ */
77
+ getProperty(params: {
78
+ propertyId: string;
79
+ }): Promise<Models.AnalyticsProperty>;
80
+ /**
81
+ * Get an analytics property by ID.
82
+ *
83
+ * @param {string} propertyId - Analytics property unique ID.
84
+ * @throws {AppwriteException}
85
+ * @returns {Promise<Models.AnalyticsProperty>}
86
+ * @deprecated Use the object parameter style method for a better developer experience.
87
+ */
88
+ getProperty(propertyId: string): Promise<Models.AnalyticsProperty>;
89
+ /**
90
+ * Update an analytics property. Only the attributes you pass are changed; omitted attributes keep their current value.
91
+ *
92
+ * @param {string} params.propertyId - Analytics property unique ID.
93
+ * @param {string} params.name - Human-readable name for this property.
94
+ * @param {string} params.domain - Primary domain to track (e.g. example.com). Pass an empty string to clear it.
95
+ * @param {string} params.timezone - IANA timezone used for daily boundaries.
96
+ * @param {boolean} params.enabled - Whether tracking is enabled.
97
+ * @param {boolean} params.xpublic - Whether stats are publicly viewable.
98
+ * @param {string[]} params.allowedOrigins - Allowed origins for tracking. Use ["*"] to allow all.
99
+ * @throws {AppwriteException}
100
+ * @returns {Promise<Models.AnalyticsProperty>}
101
+ */
102
+ updateProperty(params: {
103
+ propertyId: string;
104
+ name?: string;
105
+ domain?: string;
106
+ timezone?: string;
107
+ enabled?: boolean;
108
+ xpublic?: boolean;
109
+ allowedOrigins?: string[];
110
+ }): Promise<Models.AnalyticsProperty>;
111
+ /**
112
+ * Update an analytics property. Only the attributes you pass are changed; omitted attributes keep their current value.
113
+ *
114
+ * @param {string} propertyId - Analytics property unique ID.
115
+ * @param {string} name - Human-readable name for this property.
116
+ * @param {string} domain - Primary domain to track (e.g. example.com). Pass an empty string to clear it.
117
+ * @param {string} timezone - IANA timezone used for daily boundaries.
118
+ * @param {boolean} enabled - Whether tracking is enabled.
119
+ * @param {boolean} xpublic - Whether stats are publicly viewable.
120
+ * @param {string[]} allowedOrigins - Allowed origins for tracking. Use ["*"] to allow all.
121
+ * @throws {AppwriteException}
122
+ * @returns {Promise<Models.AnalyticsProperty>}
123
+ * @deprecated Use the object parameter style method for a better developer experience.
124
+ */
125
+ updateProperty(propertyId: string, name?: string, domain?: string, timezone?: string, enabled?: boolean, xpublic?: boolean, allowedOrigins?: string[]): Promise<Models.AnalyticsProperty>;
126
+ /**
127
+ * Delete an analytics property along with every event and session collected for it. This cannot be undone.
128
+ *
129
+ * @param {string} params.propertyId - Analytics property unique ID.
130
+ * @throws {AppwriteException}
131
+ * @returns {Promise<{}>}
132
+ */
133
+ deleteProperty(params: {
134
+ propertyId: string;
135
+ }): Promise<{}>;
136
+ /**
137
+ * Delete an analytics property along with every event and session collected for it. This cannot be undone.
138
+ *
139
+ * @param {string} propertyId - Analytics property unique ID.
140
+ * @throws {AppwriteException}
141
+ * @returns {Promise<{}>}
142
+ * @deprecated Use the object parameter style method for a better developer experience.
143
+ */
144
+ deleteProperty(propertyId: string): Promise<{}>;
145
+ /**
146
+ * Send a tracking event from a browser, native app, or server-side SDK.
147
+ *
148
+ * @param {string} params.propertyId - Analytics property ID or snippet ID identifying the property.
149
+ * @param {string} params.name - Event name. "pageview" is just a conventional event name; events are not modeled specially.
150
+ * @param {string} params.url - Full page URL or screen identifier.
151
+ * @param {string} params.domain - Hostname (e.g. example.com).
152
+ * @param {string} params.referrer - Referrer URL.
153
+ * @param {number} params.screenWidth - Viewport width in CSS pixels.
154
+ * @param {string} params.sessionHash - Optional session hash (provided by SDK).
155
+ * @param {number} params.scrollDepth - Scroll depth percentage 0-100.
156
+ * @param {number} params.engagementTime - Engagement time in seconds, 0-4294967295.
157
+ * @param {string[]} params.props - Custom string properties as a flat key=value list (max 32 entries, alternating key,value).
158
+ * @param {string} params.userId - Override user ID. Requires API-key auth with analytics.write scope.
159
+ * @param {string} params.ip - Override IP address. Requires API-key auth with analytics.write scope.
160
+ * @param {string} params.userAgent - Override user agent. Requires API-key auth with analytics.write scope.
161
+ * @throws {AppwriteException}
162
+ * @returns {Promise<{}>}
163
+ */
164
+ createEvent(params: {
165
+ propertyId: string;
166
+ name: string;
167
+ url: string;
168
+ domain?: string;
169
+ referrer?: string;
170
+ screenWidth?: number;
171
+ sessionHash?: string;
172
+ scrollDepth?: number;
173
+ engagementTime?: number;
174
+ props?: string[];
175
+ userId?: string;
176
+ ip?: string;
177
+ userAgent?: string;
178
+ }): Promise<{}>;
179
+ /**
180
+ * Send a tracking event from a browser, native app, or server-side SDK.
181
+ *
182
+ * @param {string} propertyId - Analytics property ID or snippet ID identifying the property.
183
+ * @param {string} name - Event name. "pageview" is just a conventional event name; events are not modeled specially.
184
+ * @param {string} url - Full page URL or screen identifier.
185
+ * @param {string} domain - Hostname (e.g. example.com).
186
+ * @param {string} referrer - Referrer URL.
187
+ * @param {number} screenWidth - Viewport width in CSS pixels.
188
+ * @param {string} sessionHash - Optional session hash (provided by SDK).
189
+ * @param {number} scrollDepth - Scroll depth percentage 0-100.
190
+ * @param {number} engagementTime - Engagement time in seconds, 0-4294967295.
191
+ * @param {string[]} props - Custom string properties as a flat key=value list (max 32 entries, alternating key,value).
192
+ * @param {string} userId - Override user ID. Requires API-key auth with analytics.write scope.
193
+ * @param {string} ip - Override IP address. Requires API-key auth with analytics.write scope.
194
+ * @param {string} userAgent - Override user agent. Requires API-key auth with analytics.write scope.
195
+ * @throws {AppwriteException}
196
+ * @returns {Promise<{}>}
197
+ * @deprecated Use the object parameter style method for a better developer experience.
198
+ */
199
+ createEvent(propertyId: string, name: string, url: string, domain?: string, referrer?: string, screenWidth?: number, sessionHash?: string, scrollDepth?: number, engagementTime?: number, props?: string[], userId?: string, ip?: string, userAgent?: string): Promise<{}>;
200
+ /**
201
+ * Read analytics metrics (visitors, sessions, pageviews, events, bounceRate, …) for a property over a date range.
202
+ *
203
+ * **Three response shapes**, chosen by `dimensions[]` and `interval`:
204
+ * - Neither: one row aggregating the whole window, with `value` and `date` null. Only this shape carries `pageviews`, `visits`, `bounceRate`, `visitDuration`, `viewsPerVisit`, `scrollDepth` and `engagementTime`.
205
+ * - `dimensions[]`: one row per dimension value, ranked by visitors, with `value` set and `date` null.
206
+ * - `interval`: one row per time bucket in chronological order, with `date` set and `value` null.
207
+ *
208
+ * Combining `dimensions[]` with `interval` is not supported yet. `queries[]` filters the underlying events using standard Utopia query syntax.
209
+ *
210
+ * @param {string} params.propertyId - Analytics property unique ID.
211
+ * @param {string[]} params.queries - Up to 10 filter queries in Utopia syntax. Allowed attributes: country, region, city, browser, operatingSystem, device, screenSize, referrerSource, channel, utmSource, utmMedium, utmCampaign, utmContent, utmTerm, page, hostname, botName, botCategory, eventName. page, eventName are only accepted alongside `interval`, or with a breakdown on a dimension other than entryPage, exitPage. Allowed methods: equal, notEqual, contains, startsWith, endsWith. Example: `queries[]=equal("country", ["US"])`.
212
+ * @param {AnalyticsInterval} params.interval - Time bucket size. Omit (null) for a flat aggregate over the whole window. Allowed: 1h, 1d, 1w, 1m.
213
+ * @param {AnalyticsDimension[]} params.dimensions - Dimension to break the metrics down by. One at most for now; the parameter is a list so that cap can be raised without a breaking change. Allowed: country, region, city, browser, operatingSystem, device, screenSize, referrerSource, channel, utmSource, utmMedium, utmCampaign, utmContent, utmTerm, page, hostname, entryPage, exitPage, trafficType, botName, botCategory, eventName.
214
+ * @param {string} params.dateRange - Date range shorthand (e.g. 7d, 30d). Ignored for any bound you supply explicitly via startAt/endAt.
215
+ * @param {string} params.startAt - Explicit window start in ISO 8601. Defaults to endAt minus dateRange.
216
+ * @param {string} params.endAt - Explicit window end in ISO 8601. Defaults to the current time.
217
+ * @param {number} params.limit - Maximum number of ranked values to return.
218
+ * @throws {AppwriteException}
219
+ * @returns {Promise<Models.AnalyticsMetricList>}
220
+ */
221
+ listMetrics(params: {
222
+ propertyId: string;
223
+ queries?: string[];
224
+ interval?: AnalyticsInterval;
225
+ dimensions?: AnalyticsDimension[];
226
+ dateRange?: string;
227
+ startAt?: string;
228
+ endAt?: string;
229
+ limit?: number;
230
+ }): Promise<Models.AnalyticsMetricList>;
231
+ /**
232
+ * Read analytics metrics (visitors, sessions, pageviews, events, bounceRate, …) for a property over a date range.
233
+ *
234
+ * **Three response shapes**, chosen by `dimensions[]` and `interval`:
235
+ * - Neither: one row aggregating the whole window, with `value` and `date` null. Only this shape carries `pageviews`, `visits`, `bounceRate`, `visitDuration`, `viewsPerVisit`, `scrollDepth` and `engagementTime`.
236
+ * - `dimensions[]`: one row per dimension value, ranked by visitors, with `value` set and `date` null.
237
+ * - `interval`: one row per time bucket in chronological order, with `date` set and `value` null.
238
+ *
239
+ * Combining `dimensions[]` with `interval` is not supported yet. `queries[]` filters the underlying events using standard Utopia query syntax.
240
+ *
241
+ * @param {string} propertyId - Analytics property unique ID.
242
+ * @param {string[]} queries - Up to 10 filter queries in Utopia syntax. Allowed attributes: country, region, city, browser, operatingSystem, device, screenSize, referrerSource, channel, utmSource, utmMedium, utmCampaign, utmContent, utmTerm, page, hostname, botName, botCategory, eventName. page, eventName are only accepted alongside `interval`, or with a breakdown on a dimension other than entryPage, exitPage. Allowed methods: equal, notEqual, contains, startsWith, endsWith. Example: `queries[]=equal("country", ["US"])`.
243
+ * @param {AnalyticsInterval} interval - Time bucket size. Omit (null) for a flat aggregate over the whole window. Allowed: 1h, 1d, 1w, 1m.
244
+ * @param {AnalyticsDimension[]} dimensions - Dimension to break the metrics down by. One at most for now; the parameter is a list so that cap can be raised without a breaking change. Allowed: country, region, city, browser, operatingSystem, device, screenSize, referrerSource, channel, utmSource, utmMedium, utmCampaign, utmContent, utmTerm, page, hostname, entryPage, exitPage, trafficType, botName, botCategory, eventName.
245
+ * @param {string} dateRange - Date range shorthand (e.g. 7d, 30d). Ignored for any bound you supply explicitly via startAt/endAt.
246
+ * @param {string} startAt - Explicit window start in ISO 8601. Defaults to endAt minus dateRange.
247
+ * @param {string} endAt - Explicit window end in ISO 8601. Defaults to the current time.
248
+ * @param {number} limit - Maximum number of ranked values to return.
249
+ * @throws {AppwriteException}
250
+ * @returns {Promise<Models.AnalyticsMetricList>}
251
+ * @deprecated Use the object parameter style method for a better developer experience.
252
+ */
253
+ listMetrics(propertyId: string, queries?: string[], interval?: AnalyticsInterval, dimensions?: AnalyticsDimension[], dateRange?: string, startAt?: string, endAt?: string, limit?: number): Promise<Models.AnalyticsMetricList>;
254
+ }
@@ -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
  *
@@ -1,5 +1,4 @@
1
1
  import { Client } from '../client';
2
- import { Service } from '../service';
3
2
  import type { ResolvedTopic, Topic } from '../topic';
4
3
  /** A message delivered on a subscribed topic (the MQTT analog of a Realtime event). */
5
4
  export interface PushMessage {
@@ -58,7 +57,8 @@ export interface PushSubscription {
58
57
  * );
59
58
  * // sub.update({ background: true }); sub.unsubscribe();
60
59
  */
61
- export declare class Push extends Service {
60
+ export declare class Push {
61
+ client: Client;
62
62
  private mqtt;
63
63
  private connecting;
64
64
  private Buffer;
@@ -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
  *