@appwrite.io/console 2.0.0 → 2.1.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.
Files changed (49) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/README.md +2 -2
  3. package/dist/cjs/sdk.js +81 -15
  4. package/dist/cjs/sdk.js.map +1 -1
  5. package/dist/esm/sdk.js +77 -15
  6. package/dist/esm/sdk.js.map +1 -1
  7. package/dist/iife/sdk.js +3838 -15
  8. package/docs/examples/account/update-payment-method.md +1 -1
  9. package/docs/examples/projects/update-labels.md +14 -0
  10. package/package.json +7 -1
  11. package/rollup.config.js +40 -24
  12. package/src/client.ts +49 -10
  13. package/src/models.ts +432 -424
  14. package/src/query.ts +14 -11
  15. package/src/services/account.ts +20 -20
  16. package/src/services/avatars.ts +117 -117
  17. package/src/services/backups.ts +18 -18
  18. package/src/services/console.ts +24 -24
  19. package/src/services/databases.ts +119 -119
  20. package/src/services/domains.ts +204 -204
  21. package/src/services/functions.ts +30 -30
  22. package/src/services/health.ts +146 -146
  23. package/src/services/messaging.ts +54 -54
  24. package/src/services/migrations.ts +36 -36
  25. package/src/services/organizations.ts +42 -42
  26. package/src/services/projects.ts +146 -83
  27. package/src/services/sites.ts +30 -30
  28. package/src/services/storage.ts +49 -49
  29. package/src/services/tables-db.ts +119 -119
  30. package/src/services/users.ts +39 -39
  31. package/types/client.d.ts +27 -1
  32. package/types/models.d.ts +432 -424
  33. package/types/query.d.ts +8 -8
  34. package/types/services/account.d.ts +11 -11
  35. package/types/services/avatars.d.ts +82 -82
  36. package/types/services/backups.d.ts +8 -8
  37. package/types/services/console.d.ts +14 -14
  38. package/types/services/databases.d.ts +70 -70
  39. package/types/services/domains.d.ts +104 -104
  40. package/types/services/functions.d.ts +15 -15
  41. package/types/services/health.d.ts +72 -72
  42. package/types/services/messaging.d.ts +24 -24
  43. package/types/services/migrations.d.ts +16 -16
  44. package/types/services/organizations.d.ts +22 -22
  45. package/types/services/projects.d.ts +60 -38
  46. package/types/services/sites.d.ts +15 -15
  47. package/types/services/storage.d.ts +34 -34
  48. package/types/services/tables-db.d.ts +70 -70
  49. package/types/services/users.d.ts +24 -24
package/types/query.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- declare type QueryTypesSingle = string | number | boolean;
2
- export declare type QueryTypesList = string[] | number[] | boolean[] | Query[] | any[];
1
+ declare type QueryTypesSingle = string | number | bigint | boolean;
2
+ export declare type QueryTypesList = string[] | number[] | bigint[] | boolean[] | Query[] | any[];
3
3
  export declare type QueryTypes = QueryTypesSingle | QueryTypesList;
4
4
  declare type AttributesTypes = string | string[];
5
5
  /**
@@ -89,11 +89,11 @@ export declare class Query {
89
89
  * Filter resources where attribute is between start and end (inclusive).
90
90
  *
91
91
  * @param {string} attribute
92
- * @param {string | number} start
93
- * @param {string | number} end
92
+ * @param {string | number | bigint} start
93
+ * @param {string | number | bigint} end
94
94
  * @returns {string}
95
95
  */
96
- static between: (attribute: string, start: string | number, end: string | number) => string;
96
+ static between: (attribute: string, start: string | number | bigint, end: string | number | bigint) => string;
97
97
  /**
98
98
  * Filter resources where attribute starts with value.
99
99
  *
@@ -203,11 +203,11 @@ export declare class Query {
203
203
  * Filter resources where attribute is not between start and end (exclusive).
204
204
  *
205
205
  * @param {string} attribute
206
- * @param {string | number} start
207
- * @param {string | number} end
206
+ * @param {string | number | bigint} start
207
+ * @param {string | number | bigint} end
208
208
  * @returns {string}
209
209
  */
210
- static notBetween: (attribute: string, start: string | number, end: string | number) => string;
210
+ static notBetween: (attribute: string, start: string | number | bigint, end: string | number | bigint) => string;
211
211
  /**
212
212
  * Filter resources where attribute does not start with value.
213
213
  *
@@ -284,22 +284,22 @@ export declare class Account {
284
284
  /**
285
285
  * Use this endpoint to create a JSON Web Token. You can use the resulting JWT to authenticate on behalf of the current user when working with the Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes from its creation and will be invalid if the user will logout in that time frame.
286
286
  *
287
- * @param {number} params.duration - Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.
287
+ * @param {number | bigint} params.duration - Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.
288
288
  * @throws {AppwriteException}
289
289
  * @returns {Promise<Models.Jwt>}
290
290
  */
291
291
  createJWT(params?: {
292
- duration?: number;
292
+ duration?: number | bigint;
293
293
  }): Promise<Models.Jwt>;
294
294
  /**
295
295
  * Use this endpoint to create a JSON Web Token. You can use the resulting JWT to authenticate on behalf of the current user when working with the Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes from its creation and will be invalid if the user will logout in that time frame.
296
296
  *
297
- * @param {number} duration - Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.
297
+ * @param {number | bigint} duration - Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.
298
298
  * @throws {AppwriteException}
299
299
  * @returns {Promise<Models.Jwt>}
300
300
  * @deprecated Use the object parameter style method for a better developer experience.
301
301
  */
302
- createJWT(duration?: number): Promise<Models.Jwt>;
302
+ createJWT(duration?: number | bigint): Promise<Models.Jwt>;
303
303
  /**
304
304
  * Get the list of latest security activity logs for the currently logged in user. Each log returns user IP address, location and date and time of log.
305
305
  *
@@ -698,30 +698,30 @@ export declare class Account {
698
698
  * Update a new payment method for the current user account.
699
699
  *
700
700
  * @param {string} params.paymentMethodId - Unique ID of payment method
701
- * @param {number} params.expiryMonth - Payment expiry month
702
- * @param {number} params.expiryYear - Expiry year
701
+ * @param {number | bigint} params.expiryMonth - Payment expiry month
702
+ * @param {number | bigint} params.expiryYear - Expiry year
703
703
  * @param {string} params.state - State of the payment method country
704
704
  * @throws {AppwriteException}
705
705
  * @returns {Promise<Models.PaymentMethod>}
706
706
  */
707
707
  updatePaymentMethod(params: {
708
708
  paymentMethodId: string;
709
- expiryMonth: number;
710
- expiryYear: number;
709
+ expiryMonth: number | bigint;
710
+ expiryYear: number | bigint;
711
711
  state?: string;
712
712
  }): Promise<Models.PaymentMethod>;
713
713
  /**
714
714
  * Update a new payment method for the current user account.
715
715
  *
716
716
  * @param {string} paymentMethodId - Unique ID of payment method
717
- * @param {number} expiryMonth - Payment expiry month
718
- * @param {number} expiryYear - Expiry year
717
+ * @param {number | bigint} expiryMonth - Payment expiry month
718
+ * @param {number | bigint} expiryYear - Expiry year
719
719
  * @param {string} state - State of the payment method country
720
720
  * @throws {AppwriteException}
721
721
  * @returns {Promise<Models.PaymentMethod>}
722
722
  * @deprecated Use the object parameter style method for a better developer experience.
723
723
  */
724
- updatePaymentMethod(paymentMethodId: string, expiryMonth: number, expiryYear: number, state?: string): Promise<Models.PaymentMethod>;
724
+ updatePaymentMethod(paymentMethodId: string, expiryMonth: number | bigint, expiryYear: number | bigint, state?: string): Promise<Models.PaymentMethod>;
725
725
  /**
726
726
  * Delete a specific payment method from a user's account.
727
727
  *
@@ -14,17 +14,17 @@ export declare class Avatars {
14
14
  * When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.
15
15
  *
16
16
  * @param {Browser} params.code - Browser Code.
17
- * @param {number} params.width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
18
- * @param {number} params.height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
19
- * @param {number} params.quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
17
+ * @param {number | bigint} params.width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
18
+ * @param {number | bigint} params.height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
19
+ * @param {number | bigint} params.quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
20
20
  * @throws {AppwriteException}
21
21
  * @returns {string}
22
22
  */
23
23
  getBrowser(params: {
24
24
  code: Browser;
25
- width?: number;
26
- height?: number;
27
- quality?: number;
25
+ width?: number | bigint;
26
+ height?: number | bigint;
27
+ quality?: number | bigint;
28
28
  }): string;
29
29
  /**
30
30
  * You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET /account/sessions](https://appwrite.io/docs/references/cloud/client-web/account#getSessions) endpoint. Use width, height and quality arguments to change the output settings.
@@ -32,14 +32,14 @@ export declare class Avatars {
32
32
  * When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.
33
33
  *
34
34
  * @param {Browser} code - Browser Code.
35
- * @param {number} width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
36
- * @param {number} height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
37
- * @param {number} quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
35
+ * @param {number | bigint} width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
36
+ * @param {number | bigint} height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
37
+ * @param {number | bigint} quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
38
38
  * @throws {AppwriteException}
39
39
  * @returns {string}
40
40
  * @deprecated Use the object parameter style method for a better developer experience.
41
41
  */
42
- getBrowser(code: Browser, width?: number, height?: number, quality?: number): string;
42
+ getBrowser(code: Browser, width?: number | bigint, height?: number | bigint, quality?: number | bigint): string;
43
43
  /**
44
44
  * The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.
45
45
  *
@@ -47,17 +47,17 @@ export declare class Avatars {
47
47
  *
48
48
  *
49
49
  * @param {CreditCard} params.code - Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, unionpay, visa, mir, maestro, rupay.
50
- * @param {number} params.width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
51
- * @param {number} params.height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
52
- * @param {number} params.quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
50
+ * @param {number | bigint} params.width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
51
+ * @param {number | bigint} params.height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
52
+ * @param {number | bigint} params.quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
53
53
  * @throws {AppwriteException}
54
54
  * @returns {string}
55
55
  */
56
56
  getCreditCard(params: {
57
57
  code: CreditCard;
58
- width?: number;
59
- height?: number;
60
- quality?: number;
58
+ width?: number | bigint;
59
+ height?: number | bigint;
60
+ quality?: number | bigint;
61
61
  }): string;
62
62
  /**
63
63
  * The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.
@@ -66,14 +66,14 @@ export declare class Avatars {
66
66
  *
67
67
  *
68
68
  * @param {CreditCard} code - Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, unionpay, visa, mir, maestro, rupay.
69
- * @param {number} width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
70
- * @param {number} height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
71
- * @param {number} quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
69
+ * @param {number | bigint} width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
70
+ * @param {number | bigint} height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
71
+ * @param {number | bigint} quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
72
72
  * @throws {AppwriteException}
73
73
  * @returns {string}
74
74
  * @deprecated Use the object parameter style method for a better developer experience.
75
75
  */
76
- getCreditCard(code: CreditCard, width?: number, height?: number, quality?: number): string;
76
+ getCreditCard(code: CreditCard, width?: number | bigint, height?: number | bigint, quality?: number | bigint): string;
77
77
  /**
78
78
  * Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.
79
79
  *
@@ -104,17 +104,17 @@ export declare class Avatars {
104
104
  *
105
105
  *
106
106
  * @param {Flag} params.code - Country Code. ISO Alpha-2 country code format.
107
- * @param {number} params.width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
108
- * @param {number} params.height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
109
- * @param {number} params.quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
107
+ * @param {number | bigint} params.width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
108
+ * @param {number | bigint} params.height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
109
+ * @param {number | bigint} params.quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
110
110
  * @throws {AppwriteException}
111
111
  * @returns {string}
112
112
  */
113
113
  getFlag(params: {
114
114
  code: Flag;
115
- width?: number;
116
- height?: number;
117
- quality?: number;
115
+ width?: number | bigint;
116
+ height?: number | bigint;
117
+ quality?: number | bigint;
118
118
  }): string;
119
119
  /**
120
120
  * You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard.
@@ -123,14 +123,14 @@ export declare class Avatars {
123
123
  *
124
124
  *
125
125
  * @param {Flag} code - Country Code. ISO Alpha-2 country code format.
126
- * @param {number} width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
127
- * @param {number} height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
128
- * @param {number} quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
126
+ * @param {number | bigint} width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
127
+ * @param {number | bigint} height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
128
+ * @param {number | bigint} quality - Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
129
129
  * @throws {AppwriteException}
130
130
  * @returns {string}
131
131
  * @deprecated Use the object parameter style method for a better developer experience.
132
132
  */
133
- getFlag(code: Flag, width?: number, height?: number, quality?: number): string;
133
+ getFlag(code: Flag, width?: number | bigint, height?: number | bigint, quality?: number | bigint): string;
134
134
  /**
135
135
  * Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.
136
136
  *
@@ -139,15 +139,15 @@ export declare class Avatars {
139
139
  * This endpoint does not follow HTTP redirects.
140
140
  *
141
141
  * @param {string} params.url - Image URL which you want to crop.
142
- * @param {number} params.width - Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.
143
- * @param {number} params.height - Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.
142
+ * @param {number | bigint} params.width - Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.
143
+ * @param {number | bigint} params.height - Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.
144
144
  * @throws {AppwriteException}
145
145
  * @returns {string}
146
146
  */
147
147
  getImage(params: {
148
148
  url: string;
149
- width?: number;
150
- height?: number;
149
+ width?: number | bigint;
150
+ height?: number | bigint;
151
151
  }): string;
152
152
  /**
153
153
  * Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.
@@ -157,13 +157,13 @@ export declare class Avatars {
157
157
  * This endpoint does not follow HTTP redirects.
158
158
  *
159
159
  * @param {string} url - Image URL which you want to crop.
160
- * @param {number} width - Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.
161
- * @param {number} height - Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.
160
+ * @param {number | bigint} width - Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.
161
+ * @param {number | bigint} height - Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.
162
162
  * @throws {AppwriteException}
163
163
  * @returns {string}
164
164
  * @deprecated Use the object parameter style method for a better developer experience.
165
165
  */
166
- getImage(url: string, width?: number, height?: number): string;
166
+ getImage(url: string, width?: number | bigint, height?: number | bigint): string;
167
167
  /**
168
168
  * Use this endpoint to show your user initials avatar icon on your website or app. By default, this route will try to print your logged-in user name or email initials. You can also overwrite the user name if you pass the 'name' parameter. If no name is given and no user is logged, an empty avatar will be returned.
169
169
  *
@@ -173,16 +173,16 @@ export declare class Avatars {
173
173
  *
174
174
  *
175
175
  * @param {string} params.name - Full Name. When empty, current user name or email will be used. Max length: 128 chars.
176
- * @param {number} params.width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
177
- * @param {number} params.height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
176
+ * @param {number | bigint} params.width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
177
+ * @param {number | bigint} params.height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
178
178
  * @param {string} params.background - Changes background color. By default a random color will be picked and stay will persistent to the given name.
179
179
  * @throws {AppwriteException}
180
180
  * @returns {string}
181
181
  */
182
182
  getInitials(params?: {
183
183
  name?: string;
184
- width?: number;
185
- height?: number;
184
+ width?: number | bigint;
185
+ height?: number | bigint;
186
186
  background?: string;
187
187
  }): string;
188
188
  /**
@@ -194,29 +194,29 @@ export declare class Avatars {
194
194
  *
195
195
  *
196
196
  * @param {string} name - Full Name. When empty, current user name or email will be used. Max length: 128 chars.
197
- * @param {number} width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
198
- * @param {number} height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
197
+ * @param {number | bigint} width - Image width. Pass an integer between 0 to 2000. Defaults to 100.
198
+ * @param {number | bigint} height - Image height. Pass an integer between 0 to 2000. Defaults to 100.
199
199
  * @param {string} background - Changes background color. By default a random color will be picked and stay will persistent to the given name.
200
200
  * @throws {AppwriteException}
201
201
  * @returns {string}
202
202
  * @deprecated Use the object parameter style method for a better developer experience.
203
203
  */
204
- getInitials(name?: string, width?: number, height?: number, background?: string): string;
204
+ getInitials(name?: string, width?: number | bigint, height?: number | bigint, background?: string): string;
205
205
  /**
206
206
  * Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image.
207
207
  *
208
208
  *
209
209
  * @param {string} params.text - Plain text to be converted to QR code image.
210
- * @param {number} params.size - QR code size. Pass an integer between 1 to 1000. Defaults to 400.
211
- * @param {number} params.margin - Margin from edge. Pass an integer between 0 to 10. Defaults to 1.
210
+ * @param {number | bigint} params.size - QR code size. Pass an integer between 1 to 1000. Defaults to 400.
211
+ * @param {number | bigint} params.margin - Margin from edge. Pass an integer between 0 to 10. Defaults to 1.
212
212
  * @param {boolean} params.download - Return resulting image with 'Content-Disposition: attachment ' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.
213
213
  * @throws {AppwriteException}
214
214
  * @returns {string}
215
215
  */
216
216
  getQR(params: {
217
217
  text: string;
218
- size?: number;
219
- margin?: number;
218
+ size?: number | bigint;
219
+ margin?: number | bigint;
220
220
  download?: boolean;
221
221
  }): string;
222
222
  /**
@@ -224,14 +224,14 @@ export declare class Avatars {
224
224
  *
225
225
  *
226
226
  * @param {string} text - Plain text to be converted to QR code image.
227
- * @param {number} size - QR code size. Pass an integer between 1 to 1000. Defaults to 400.
228
- * @param {number} margin - Margin from edge. Pass an integer between 0 to 10. Defaults to 1.
227
+ * @param {number | bigint} size - QR code size. Pass an integer between 1 to 1000. Defaults to 400.
228
+ * @param {number | bigint} margin - Margin from edge. Pass an integer between 0 to 10. Defaults to 1.
229
229
  * @param {boolean} download - Return resulting image with 'Content-Disposition: attachment ' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.
230
230
  * @throws {AppwriteException}
231
231
  * @returns {string}
232
232
  * @deprecated Use the object parameter style method for a better developer experience.
233
233
  */
234
- getQR(text: string, size?: number, margin?: number, download?: boolean): string;
234
+ getQR(text: string, size?: number | bigint, margin?: number | bigint, download?: boolean): string;
235
235
  /**
236
236
  * Use this endpoint to capture a screenshot of any website URL. This endpoint uses a headless browser to render the webpage and capture it as an image.
237
237
  *
@@ -241,23 +241,23 @@ export declare class Avatars {
241
241
  *
242
242
  * @param {string} params.url - Website URL which you want to capture.
243
243
  * @param {object} params.headers - HTTP headers to send with the browser request. Defaults to empty.
244
- * @param {number} params.viewportWidth - Browser viewport width. Pass an integer between 1 to 1920. Defaults to 1280.
245
- * @param {number} params.viewportHeight - Browser viewport height. Pass an integer between 1 to 1080. Defaults to 720.
246
- * @param {number} params.scale - Browser scale factor. Pass a number between 0.1 to 3. Defaults to 1.
244
+ * @param {number | bigint} params.viewportWidth - Browser viewport width. Pass an integer between 1 to 1920. Defaults to 1280.
245
+ * @param {number | bigint} params.viewportHeight - Browser viewport height. Pass an integer between 1 to 1080. Defaults to 720.
246
+ * @param {number | bigint} params.scale - Browser scale factor. Pass a number between 0.1 to 3. Defaults to 1.
247
247
  * @param {Theme} params.theme - Browser theme. Pass "light" or "dark". Defaults to "light".
248
248
  * @param {string} params.userAgent - Custom user agent string. Defaults to browser default.
249
249
  * @param {boolean} params.fullpage - Capture full page scroll. Pass 0 for viewport only, or 1 for full page. Defaults to 0.
250
250
  * @param {string} params.locale - Browser locale (e.g., "en-US", "fr-FR"). Defaults to browser default.
251
251
  * @param {Timezone} params.timezone - IANA timezone identifier (e.g., "America/New_York", "Europe/London"). Defaults to browser default.
252
- * @param {number} params.latitude - Geolocation latitude. Pass a number between -90 to 90. Defaults to 0.
253
- * @param {number} params.longitude - Geolocation longitude. Pass a number between -180 to 180. Defaults to 0.
254
- * @param {number} params.accuracy - Geolocation accuracy in meters. Pass a number between 0 to 100000. Defaults to 0.
252
+ * @param {number | bigint} params.latitude - Geolocation latitude. Pass a number between -90 to 90. Defaults to 0.
253
+ * @param {number | bigint} params.longitude - Geolocation longitude. Pass a number between -180 to 180. Defaults to 0.
254
+ * @param {number | bigint} params.accuracy - Geolocation accuracy in meters. Pass a number between 0 to 100000. Defaults to 0.
255
255
  * @param {boolean} params.touch - Enable touch support. Pass 0 for no touch, or 1 for touch enabled. Defaults to 0.
256
256
  * @param {string[]} params.permissions - Browser permissions to grant. Pass an array of permission names like ["geolocation", "camera", "microphone"]. Defaults to empty.
257
- * @param {number} params.sleep - Wait time in seconds before taking the screenshot. Pass an integer between 0 to 10. Defaults to 0.
258
- * @param {number} params.width - Output image width. Pass 0 to use original width, or an integer between 1 to 2000. Defaults to 0 (original width).
259
- * @param {number} params.height - Output image height. Pass 0 to use original height, or an integer between 1 to 2000. Defaults to 0 (original height).
260
- * @param {number} params.quality - Screenshot quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
257
+ * @param {number | bigint} params.sleep - Wait time in seconds before taking the screenshot. Pass an integer between 0 to 10. Defaults to 0.
258
+ * @param {number | bigint} params.width - Output image width. Pass 0 to use original width, or an integer between 1 to 2000. Defaults to 0 (original width).
259
+ * @param {number | bigint} params.height - Output image height. Pass 0 to use original height, or an integer between 1 to 2000. Defaults to 0 (original height).
260
+ * @param {number | bigint} params.quality - Screenshot quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
261
261
  * @param {ImageFormat} params.output - Output format type (jpeg, jpg, png, gif and webp).
262
262
  * @throws {AppwriteException}
263
263
  * @returns {string}
@@ -265,23 +265,23 @@ export declare class Avatars {
265
265
  getScreenshot(params: {
266
266
  url: string;
267
267
  headers?: object;
268
- viewportWidth?: number;
269
- viewportHeight?: number;
270
- scale?: number;
268
+ viewportWidth?: number | bigint;
269
+ viewportHeight?: number | bigint;
270
+ scale?: number | bigint;
271
271
  theme?: Theme;
272
272
  userAgent?: string;
273
273
  fullpage?: boolean;
274
274
  locale?: string;
275
275
  timezone?: Timezone;
276
- latitude?: number;
277
- longitude?: number;
278
- accuracy?: number;
276
+ latitude?: number | bigint;
277
+ longitude?: number | bigint;
278
+ accuracy?: number | bigint;
279
279
  touch?: boolean;
280
280
  permissions?: string[];
281
- sleep?: number;
282
- width?: number;
283
- height?: number;
284
- quality?: number;
281
+ sleep?: number | bigint;
282
+ width?: number | bigint;
283
+ height?: number | bigint;
284
+ quality?: number | bigint;
285
285
  output?: ImageFormat;
286
286
  }): string;
287
287
  /**
@@ -293,27 +293,27 @@ export declare class Avatars {
293
293
  *
294
294
  * @param {string} url - Website URL which you want to capture.
295
295
  * @param {object} headers - HTTP headers to send with the browser request. Defaults to empty.
296
- * @param {number} viewportWidth - Browser viewport width. Pass an integer between 1 to 1920. Defaults to 1280.
297
- * @param {number} viewportHeight - Browser viewport height. Pass an integer between 1 to 1080. Defaults to 720.
298
- * @param {number} scale - Browser scale factor. Pass a number between 0.1 to 3. Defaults to 1.
296
+ * @param {number | bigint} viewportWidth - Browser viewport width. Pass an integer between 1 to 1920. Defaults to 1280.
297
+ * @param {number | bigint} viewportHeight - Browser viewport height. Pass an integer between 1 to 1080. Defaults to 720.
298
+ * @param {number | bigint} scale - Browser scale factor. Pass a number between 0.1 to 3. Defaults to 1.
299
299
  * @param {Theme} theme - Browser theme. Pass "light" or "dark". Defaults to "light".
300
300
  * @param {string} userAgent - Custom user agent string. Defaults to browser default.
301
301
  * @param {boolean} fullpage - Capture full page scroll. Pass 0 for viewport only, or 1 for full page. Defaults to 0.
302
302
  * @param {string} locale - Browser locale (e.g., "en-US", "fr-FR"). Defaults to browser default.
303
303
  * @param {Timezone} timezone - IANA timezone identifier (e.g., "America/New_York", "Europe/London"). Defaults to browser default.
304
- * @param {number} latitude - Geolocation latitude. Pass a number between -90 to 90. Defaults to 0.
305
- * @param {number} longitude - Geolocation longitude. Pass a number between -180 to 180. Defaults to 0.
306
- * @param {number} accuracy - Geolocation accuracy in meters. Pass a number between 0 to 100000. Defaults to 0.
304
+ * @param {number | bigint} latitude - Geolocation latitude. Pass a number between -90 to 90. Defaults to 0.
305
+ * @param {number | bigint} longitude - Geolocation longitude. Pass a number between -180 to 180. Defaults to 0.
306
+ * @param {number | bigint} accuracy - Geolocation accuracy in meters. Pass a number between 0 to 100000. Defaults to 0.
307
307
  * @param {boolean} touch - Enable touch support. Pass 0 for no touch, or 1 for touch enabled. Defaults to 0.
308
308
  * @param {string[]} permissions - Browser permissions to grant. Pass an array of permission names like ["geolocation", "camera", "microphone"]. Defaults to empty.
309
- * @param {number} sleep - Wait time in seconds before taking the screenshot. Pass an integer between 0 to 10. Defaults to 0.
310
- * @param {number} width - Output image width. Pass 0 to use original width, or an integer between 1 to 2000. Defaults to 0 (original width).
311
- * @param {number} height - Output image height. Pass 0 to use original height, or an integer between 1 to 2000. Defaults to 0 (original height).
312
- * @param {number} quality - Screenshot quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
309
+ * @param {number | bigint} sleep - Wait time in seconds before taking the screenshot. Pass an integer between 0 to 10. Defaults to 0.
310
+ * @param {number | bigint} width - Output image width. Pass 0 to use original width, or an integer between 1 to 2000. Defaults to 0 (original width).
311
+ * @param {number | bigint} height - Output image height. Pass 0 to use original height, or an integer between 1 to 2000. Defaults to 0 (original height).
312
+ * @param {number | bigint} quality - Screenshot quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
313
313
  * @param {ImageFormat} output - Output format type (jpeg, jpg, png, gif and webp).
314
314
  * @throws {AppwriteException}
315
315
  * @returns {string}
316
316
  * @deprecated Use the object parameter style method for a better developer experience.
317
317
  */
318
- getScreenshot(url: string, headers?: object, viewportWidth?: number, viewportHeight?: number, scale?: number, theme?: Theme, userAgent?: string, fullpage?: boolean, locale?: string, timezone?: Timezone, latitude?: number, longitude?: number, accuracy?: number, touch?: boolean, permissions?: string[], sleep?: number, width?: number, height?: number, quality?: number, output?: ImageFormat): string;
318
+ getScreenshot(url: string, headers?: object, viewportWidth?: number | bigint, viewportHeight?: number | bigint, scale?: number | bigint, theme?: Theme, userAgent?: string, fullpage?: boolean, locale?: string, timezone?: Timezone, latitude?: number | bigint, longitude?: number | bigint, accuracy?: number | bigint, touch?: boolean, permissions?: string[], sleep?: number | bigint, width?: number | bigint, height?: number | bigint, quality?: number | bigint, output?: ImageFormat): string;
319
319
  }
@@ -106,7 +106,7 @@ export declare class Backups {
106
106
  *
107
107
  * @param {string} params.policyId - Policy 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.
108
108
  * @param {string[]} params.services - Array of services to backup
109
- * @param {number} params.retention - Days to keep backups before deletion
109
+ * @param {number | bigint} params.retention - Days to keep backups before deletion
110
110
  * @param {string} params.schedule - Schedule CRON syntax.
111
111
  * @param {string} params.name - Policy name. Max length: 128 chars.
112
112
  * @param {string} params.resourceId - Resource ID. When set, only this single resource will be backed up.
@@ -117,7 +117,7 @@ export declare class Backups {
117
117
  createPolicy(params: {
118
118
  policyId: string;
119
119
  services: string[];
120
- retention: number;
120
+ retention: number | bigint;
121
121
  schedule: string;
122
122
  name?: string;
123
123
  resourceId?: string;
@@ -128,7 +128,7 @@ export declare class Backups {
128
128
  *
129
129
  * @param {string} policyId - Policy 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.
130
130
  * @param {string[]} services - Array of services to backup
131
- * @param {number} retention - Days to keep backups before deletion
131
+ * @param {number | bigint} retention - Days to keep backups before deletion
132
132
  * @param {string} schedule - Schedule CRON syntax.
133
133
  * @param {string} name - Policy name. Max length: 128 chars.
134
134
  * @param {string} resourceId - Resource ID. When set, only this single resource will be backed up.
@@ -137,7 +137,7 @@ export declare class Backups {
137
137
  * @returns {Promise<Models.BackupPolicy>}
138
138
  * @deprecated Use the object parameter style method for a better developer experience.
139
139
  */
140
- createPolicy(policyId: string, services: string[], retention: number, schedule: string, name?: string, resourceId?: string, enabled?: boolean): Promise<Models.BackupPolicy>;
140
+ createPolicy(policyId: string, services: string[], retention: number | bigint, schedule: string, name?: string, resourceId?: string, enabled?: boolean): Promise<Models.BackupPolicy>;
141
141
  /**
142
142
  * Get a backup policy using it's ID.
143
143
  *
@@ -162,7 +162,7 @@ export declare class Backups {
162
162
  *
163
163
  * @param {string} params.policyId - Policy ID. Choose a custom ID`. 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.
164
164
  * @param {string} params.name - Policy name. Max length: 128 chars.
165
- * @param {number} params.retention - Days to keep backups before deletion
165
+ * @param {number | bigint} params.retention - Days to keep backups before deletion
166
166
  * @param {string} params.schedule - Cron expression
167
167
  * @param {boolean} params.enabled - Is Backup enabled? When set to 'disabled', No backup will be taken
168
168
  * @throws {AppwriteException}
@@ -171,7 +171,7 @@ export declare class Backups {
171
171
  updatePolicy(params: {
172
172
  policyId: string;
173
173
  name?: string;
174
- retention?: number;
174
+ retention?: number | bigint;
175
175
  schedule?: string;
176
176
  enabled?: boolean;
177
177
  }): Promise<Models.BackupPolicy>;
@@ -180,14 +180,14 @@ export declare class Backups {
180
180
  *
181
181
  * @param {string} policyId - Policy ID. Choose a custom ID`. 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.
182
182
  * @param {string} name - Policy name. Max length: 128 chars.
183
- * @param {number} retention - Days to keep backups before deletion
183
+ * @param {number | bigint} retention - Days to keep backups before deletion
184
184
  * @param {string} schedule - Cron expression
185
185
  * @param {boolean} enabled - Is Backup enabled? When set to 'disabled', No backup will be taken
186
186
  * @throws {AppwriteException}
187
187
  * @returns {Promise<Models.BackupPolicy>}
188
188
  * @deprecated Use the object parameter style method for a better developer experience.
189
189
  */
190
- updatePolicy(policyId: string, name?: string, retention?: number, schedule?: string, enabled?: boolean): Promise<Models.BackupPolicy>;
190
+ updatePolicy(policyId: string, name?: string, retention?: number | bigint, schedule?: string, enabled?: boolean): Promise<Models.BackupPolicy>;
191
191
  /**
192
192
  * Delete a policy using it's ID.
193
193
  *
@@ -197,8 +197,8 @@ export declare class Console {
197
197
  * @param {string} params.databaseId - Database ID.
198
198
  * @param {string} params.tableId - Table ID.
199
199
  * @param {string} params.context - Optional user provided context to refine suggestions.
200
- * @param {number} params.min - Minimum number of suggestions to generate.
201
- * @param {number} params.max - Maximum number of suggestions to generate.
200
+ * @param {number | bigint} params.min - Minimum number of suggestions to generate.
201
+ * @param {number | bigint} params.max - Maximum number of suggestions to generate.
202
202
  * @throws {AppwriteException}
203
203
  * @returns {Promise<Models.ColumnList>}
204
204
  */
@@ -206,8 +206,8 @@ export declare class Console {
206
206
  databaseId: string;
207
207
  tableId: string;
208
208
  context?: string;
209
- min?: number;
210
- max?: number;
209
+ min?: number | bigint;
210
+ max?: number | bigint;
211
211
  }): Promise<Models.ColumnList>;
212
212
  /**
213
213
  * Suggests column names and their size limits based on the provided table name. The API will also analyze other tables in the same database to provide context-aware suggestions, ensuring consistency across schema design. Users may optionally provide custom context to further refine the suggestions.
@@ -215,41 +215,41 @@ export declare class Console {
215
215
  * @param {string} databaseId - Database ID.
216
216
  * @param {string} tableId - Table ID.
217
217
  * @param {string} context - Optional user provided context to refine suggestions.
218
- * @param {number} min - Minimum number of suggestions to generate.
219
- * @param {number} max - Maximum number of suggestions to generate.
218
+ * @param {number | bigint} min - Minimum number of suggestions to generate.
219
+ * @param {number | bigint} max - Maximum number of suggestions to generate.
220
220
  * @throws {AppwriteException}
221
221
  * @returns {Promise<Models.ColumnList>}
222
222
  * @deprecated Use the object parameter style method for a better developer experience.
223
223
  */
224
- suggestColumns(databaseId: string, tableId: string, context?: string, min?: number, max?: number): Promise<Models.ColumnList>;
224
+ suggestColumns(databaseId: string, tableId: string, context?: string, min?: number | bigint, max?: number | bigint): Promise<Models.ColumnList>;
225
225
  /**
226
226
  * Suggests database indexes for table columns based on the provided table structure and existing columns. The API will also analyze the table's column types, names, and patterns to recommend optimal indexes that improve query performance for common database operations like filtering, sorting, and searching.
227
227
  *
228
228
  * @param {string} params.databaseId - Database ID.
229
229
  * @param {string} params.tableId - Table ID.
230
- * @param {number} params.min - Minimum number of suggestions to generate.
231
- * @param {number} params.max - Maximum number of suggestions to generate.
230
+ * @param {number | bigint} params.min - Minimum number of suggestions to generate.
231
+ * @param {number | bigint} params.max - Maximum number of suggestions to generate.
232
232
  * @throws {AppwriteException}
233
233
  * @returns {Promise<Models.ColumnIndexList>}
234
234
  */
235
235
  suggestIndexes(params: {
236
236
  databaseId: string;
237
237
  tableId: string;
238
- min?: number;
239
- max?: number;
238
+ min?: number | bigint;
239
+ max?: number | bigint;
240
240
  }): Promise<Models.ColumnIndexList>;
241
241
  /**
242
242
  * Suggests database indexes for table columns based on the provided table structure and existing columns. The API will also analyze the table's column types, names, and patterns to recommend optimal indexes that improve query performance for common database operations like filtering, sorting, and searching.
243
243
  *
244
244
  * @param {string} databaseId - Database ID.
245
245
  * @param {string} tableId - Table ID.
246
- * @param {number} min - Minimum number of suggestions to generate.
247
- * @param {number} max - Maximum number of suggestions to generate.
246
+ * @param {number | bigint} min - Minimum number of suggestions to generate.
247
+ * @param {number | bigint} max - Maximum number of suggestions to generate.
248
248
  * @throws {AppwriteException}
249
249
  * @returns {Promise<Models.ColumnIndexList>}
250
250
  * @deprecated Use the object parameter style method for a better developer experience.
251
251
  */
252
- suggestIndexes(databaseId: string, tableId: string, min?: number, max?: number): Promise<Models.ColumnIndexList>;
252
+ suggestIndexes(databaseId: string, tableId: string, min?: number | bigint, max?: number | bigint): Promise<Models.ColumnIndexList>;
253
253
  /**
254
254
  * Get all Environment Variables that are relevant for the console.
255
255
  *