@appwrite.io/console 2.1.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.
- package/CHANGELOG.md +4 -0
- package/README.md +2 -2
- package/dist/cjs/sdk.js +55 -16
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +51 -16
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +3812 -16
- package/docs/examples/projects/update-labels.md +14 -0
- package/package.json +7 -1
- package/rollup.config.js +40 -24
- package/src/client.ts +20 -10
- package/src/models.ts +432 -424
- package/src/query.ts +14 -11
- package/src/services/account.ts +20 -20
- package/src/services/avatars.ts +117 -117
- package/src/services/backups.ts +18 -18
- package/src/services/console.ts +24 -24
- package/src/services/databases.ts +119 -119
- package/src/services/domains.ts +204 -204
- package/src/services/functions.ts +30 -30
- package/src/services/health.ts +146 -146
- package/src/services/messaging.ts +54 -54
- package/src/services/migrations.ts +36 -36
- package/src/services/organizations.ts +42 -42
- package/src/services/projects.ts +146 -83
- package/src/services/sites.ts +30 -30
- package/src/services/storage.ts +49 -49
- package/src/services/tables-db.ts +119 -119
- package/src/services/users.ts +39 -39
- package/types/client.d.ts +8 -1
- package/types/models.d.ts +432 -424
- package/types/query.d.ts +8 -8
- package/types/services/account.d.ts +11 -11
- package/types/services/avatars.d.ts +82 -82
- package/types/services/backups.d.ts +8 -8
- package/types/services/console.d.ts +14 -14
- package/types/services/databases.d.ts +70 -70
- package/types/services/domains.d.ts +104 -104
- package/types/services/functions.d.ts +15 -15
- package/types/services/health.d.ts +72 -72
- package/types/services/messaging.d.ts +24 -24
- package/types/services/migrations.d.ts +16 -16
- package/types/services/organizations.d.ts +22 -22
- package/types/services/projects.d.ts +60 -38
- package/types/services/sites.d.ts +15 -15
- package/types/services/storage.d.ts +34 -34
- package/types/services/tables-db.d.ts +70 -70
- package/types/services/users.d.ts +24 -24
|
@@ -18,7 +18,7 @@ export declare class Projects {
|
|
|
18
18
|
/**
|
|
19
19
|
* Get a list of all projects. You can use the query params to filter your results.
|
|
20
20
|
*
|
|
21
|
-
* @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, teamId
|
|
21
|
+
* @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, teamId, labels, search
|
|
22
22
|
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
23
23
|
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
24
24
|
* @throws {AppwriteException}
|
|
@@ -32,7 +32,7 @@ export declare class Projects {
|
|
|
32
32
|
/**
|
|
33
33
|
* Get a list of all projects. You can use the query params to filter your results.
|
|
34
34
|
*
|
|
35
|
-
* @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, teamId
|
|
35
|
+
* @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, teamId, labels, search
|
|
36
36
|
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
37
37
|
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
38
38
|
* @throws {AppwriteException}
|
|
@@ -282,68 +282,68 @@ export declare class Projects {
|
|
|
282
282
|
* Update how long sessions created within a project should stay active for.
|
|
283
283
|
*
|
|
284
284
|
* @param {string} params.projectId - Project unique ID.
|
|
285
|
-
* @param {number} params.duration - Project session length in seconds. Max length: 31536000 seconds.
|
|
285
|
+
* @param {number | bigint} params.duration - Project session length in seconds. Max length: 31536000 seconds.
|
|
286
286
|
* @throws {AppwriteException}
|
|
287
287
|
* @returns {Promise<Models.Project>}
|
|
288
288
|
*/
|
|
289
289
|
updateAuthDuration(params: {
|
|
290
290
|
projectId: string;
|
|
291
|
-
duration: number;
|
|
291
|
+
duration: number | bigint;
|
|
292
292
|
}): Promise<Models.Project>;
|
|
293
293
|
/**
|
|
294
294
|
* Update how long sessions created within a project should stay active for.
|
|
295
295
|
*
|
|
296
296
|
* @param {string} projectId - Project unique ID.
|
|
297
|
-
* @param {number} duration - Project session length in seconds. Max length: 31536000 seconds.
|
|
297
|
+
* @param {number | bigint} duration - Project session length in seconds. Max length: 31536000 seconds.
|
|
298
298
|
* @throws {AppwriteException}
|
|
299
299
|
* @returns {Promise<Models.Project>}
|
|
300
300
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
301
301
|
*/
|
|
302
|
-
updateAuthDuration(projectId: string, duration: number): Promise<Models.Project>;
|
|
302
|
+
updateAuthDuration(projectId: string, duration: number | bigint): Promise<Models.Project>;
|
|
303
303
|
/**
|
|
304
304
|
* Update the maximum number of users allowed in this project. Set to 0 for unlimited users.
|
|
305
305
|
*
|
|
306
306
|
* @param {string} params.projectId - Project unique ID.
|
|
307
|
-
* @param {number} params.limit - Set the max number of users allowed in this project. Use 0 for unlimited.
|
|
307
|
+
* @param {number | bigint} params.limit - Set the max number of users allowed in this project. Use 0 for unlimited.
|
|
308
308
|
* @throws {AppwriteException}
|
|
309
309
|
* @returns {Promise<Models.Project>}
|
|
310
310
|
*/
|
|
311
311
|
updateAuthLimit(params: {
|
|
312
312
|
projectId: string;
|
|
313
|
-
limit: number;
|
|
313
|
+
limit: number | bigint;
|
|
314
314
|
}): Promise<Models.Project>;
|
|
315
315
|
/**
|
|
316
316
|
* Update the maximum number of users allowed in this project. Set to 0 for unlimited users.
|
|
317
317
|
*
|
|
318
318
|
* @param {string} projectId - Project unique ID.
|
|
319
|
-
* @param {number} limit - Set the max number of users allowed in this project. Use 0 for unlimited.
|
|
319
|
+
* @param {number | bigint} limit - Set the max number of users allowed in this project. Use 0 for unlimited.
|
|
320
320
|
* @throws {AppwriteException}
|
|
321
321
|
* @returns {Promise<Models.Project>}
|
|
322
322
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
323
323
|
*/
|
|
324
|
-
updateAuthLimit(projectId: string, limit: number): Promise<Models.Project>;
|
|
324
|
+
updateAuthLimit(projectId: string, limit: number | bigint): Promise<Models.Project>;
|
|
325
325
|
/**
|
|
326
326
|
* Update the maximum number of sessions allowed per user within the project, if the limit is hit the oldest session will be deleted to make room for new sessions.
|
|
327
327
|
*
|
|
328
328
|
* @param {string} params.projectId - Project unique ID.
|
|
329
|
-
* @param {number} params.limit - Set the max number of users allowed in this project. Value allowed is between 1-100. Default is 10
|
|
329
|
+
* @param {number | bigint} params.limit - Set the max number of users allowed in this project. Value allowed is between 1-100. Default is 10
|
|
330
330
|
* @throws {AppwriteException}
|
|
331
331
|
* @returns {Promise<Models.Project>}
|
|
332
332
|
*/
|
|
333
333
|
updateAuthSessionsLimit(params: {
|
|
334
334
|
projectId: string;
|
|
335
|
-
limit: number;
|
|
335
|
+
limit: number | bigint;
|
|
336
336
|
}): Promise<Models.Project>;
|
|
337
337
|
/**
|
|
338
338
|
* Update the maximum number of sessions allowed per user within the project, if the limit is hit the oldest session will be deleted to make room for new sessions.
|
|
339
339
|
*
|
|
340
340
|
* @param {string} projectId - Project unique ID.
|
|
341
|
-
* @param {number} limit - Set the max number of users allowed in this project. Value allowed is between 1-100. Default is 10
|
|
341
|
+
* @param {number | bigint} limit - Set the max number of users allowed in this project. Value allowed is between 1-100. Default is 10
|
|
342
342
|
* @throws {AppwriteException}
|
|
343
343
|
* @returns {Promise<Models.Project>}
|
|
344
344
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
345
345
|
*/
|
|
346
|
-
updateAuthSessionsLimit(projectId: string, limit: number): Promise<Models.Project>;
|
|
346
|
+
updateAuthSessionsLimit(projectId: string, limit: number | bigint): Promise<Models.Project>;
|
|
347
347
|
/**
|
|
348
348
|
* Update project membership privacy settings. Use this endpoint to control what user information is visible to other team members, such as user name, email, and MFA status.
|
|
349
349
|
*
|
|
@@ -420,24 +420,24 @@ export declare class Projects {
|
|
|
420
420
|
* Update the authentication password history requirement. Use this endpoint to require new passwords to be different than the last X amount of previously used ones.
|
|
421
421
|
*
|
|
422
422
|
* @param {string} params.projectId - Project unique ID.
|
|
423
|
-
* @param {number} params.limit - Set the max number of passwords to store in user history. User can't choose a new password that is already stored in the password history list. Max number of passwords allowed in history is20. Default value is 0
|
|
423
|
+
* @param {number | bigint} params.limit - Set the max number of passwords to store in user history. User can't choose a new password that is already stored in the password history list. Max number of passwords allowed in history is20. Default value is 0
|
|
424
424
|
* @throws {AppwriteException}
|
|
425
425
|
* @returns {Promise<Models.Project>}
|
|
426
426
|
*/
|
|
427
427
|
updateAuthPasswordHistory(params: {
|
|
428
428
|
projectId: string;
|
|
429
|
-
limit: number;
|
|
429
|
+
limit: number | bigint;
|
|
430
430
|
}): Promise<Models.Project>;
|
|
431
431
|
/**
|
|
432
432
|
* Update the authentication password history requirement. Use this endpoint to require new passwords to be different than the last X amount of previously used ones.
|
|
433
433
|
*
|
|
434
434
|
* @param {string} projectId - Project unique ID.
|
|
435
|
-
* @param {number} limit - Set the max number of passwords to store in user history. User can't choose a new password that is already stored in the password history list. Max number of passwords allowed in history is20. Default value is 0
|
|
435
|
+
* @param {number | bigint} limit - Set the max number of passwords to store in user history. User can't choose a new password that is already stored in the password history list. Max number of passwords allowed in history is20. Default value is 0
|
|
436
436
|
* @throws {AppwriteException}
|
|
437
437
|
* @returns {Promise<Models.Project>}
|
|
438
438
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
439
439
|
*/
|
|
440
|
-
updateAuthPasswordHistory(projectId: string, limit: number): Promise<Models.Project>;
|
|
440
|
+
updateAuthPasswordHistory(projectId: string, limit: number | bigint): Promise<Models.Project>;
|
|
441
441
|
/**
|
|
442
442
|
* Enable or disable checking user passwords against their personal data. This helps prevent users from using personal information in their passwords.
|
|
443
443
|
*
|
|
@@ -653,26 +653,26 @@ export declare class Projects {
|
|
|
653
653
|
*
|
|
654
654
|
* @param {string} params.projectId - Project unique ID.
|
|
655
655
|
* @param {string[]} params.scopes - List of scopes allowed for JWT key. Maximum of 100 scopes are allowed.
|
|
656
|
-
* @param {number} params.duration - Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.
|
|
656
|
+
* @param {number | bigint} params.duration - Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.
|
|
657
657
|
* @throws {AppwriteException}
|
|
658
658
|
* @returns {Promise<Models.Jwt>}
|
|
659
659
|
*/
|
|
660
660
|
createJWT(params: {
|
|
661
661
|
projectId: string;
|
|
662
662
|
scopes: string[];
|
|
663
|
-
duration?: number;
|
|
663
|
+
duration?: number | bigint;
|
|
664
664
|
}): Promise<Models.Jwt>;
|
|
665
665
|
/**
|
|
666
666
|
* Create a new JWT token. This token can be used to authenticate users with custom scopes and expiration time.
|
|
667
667
|
*
|
|
668
668
|
* @param {string} projectId - Project unique ID.
|
|
669
669
|
* @param {string[]} scopes - List of scopes allowed for JWT key. Maximum of 100 scopes are allowed.
|
|
670
|
-
* @param {number} duration - Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.
|
|
670
|
+
* @param {number | bigint} duration - Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.
|
|
671
671
|
* @throws {AppwriteException}
|
|
672
672
|
* @returns {Promise<Models.Jwt>}
|
|
673
673
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
674
674
|
*/
|
|
675
|
-
createJWT(projectId: string, scopes: string[], duration?: number): Promise<Models.Jwt>;
|
|
675
|
+
createJWT(projectId: string, scopes: string[], duration?: number | bigint): Promise<Models.Jwt>;
|
|
676
676
|
/**
|
|
677
677
|
* Get a list of all API keys from the current project.
|
|
678
678
|
*
|
|
@@ -798,6 +798,28 @@ export declare class Projects {
|
|
|
798
798
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
799
799
|
*/
|
|
800
800
|
deleteKey(projectId: string, keyId: string): Promise<{}>;
|
|
801
|
+
/**
|
|
802
|
+
* Update the project labels by its unique ID. Labels can be used to easily filter projects in an organization.
|
|
803
|
+
*
|
|
804
|
+
* @param {string} params.projectId - Project unique ID.
|
|
805
|
+
* @param {string[]} params.labels - Array of project labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.
|
|
806
|
+
* @throws {AppwriteException}
|
|
807
|
+
* @returns {Promise<Models.Project>}
|
|
808
|
+
*/
|
|
809
|
+
updateLabels(params: {
|
|
810
|
+
projectId: string;
|
|
811
|
+
labels: string[];
|
|
812
|
+
}): Promise<Models.Project>;
|
|
813
|
+
/**
|
|
814
|
+
* Update the project labels by its unique ID. Labels can be used to easily filter projects in an organization.
|
|
815
|
+
*
|
|
816
|
+
* @param {string} projectId - Project unique ID.
|
|
817
|
+
* @param {string[]} labels - Array of project labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.
|
|
818
|
+
* @throws {AppwriteException}
|
|
819
|
+
* @returns {Promise<Models.Project>}
|
|
820
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
821
|
+
*/
|
|
822
|
+
updateLabels(projectId: string, labels: string[]): Promise<Models.Project>;
|
|
801
823
|
/**
|
|
802
824
|
* Update the OAuth2 provider configurations. Use this endpoint to set up or update the OAuth2 provider credentials or enable/disable providers.
|
|
803
825
|
*
|
|
@@ -1019,7 +1041,7 @@ export declare class Projects {
|
|
|
1019
1041
|
* @param {string} params.senderEmail - Email of the sender
|
|
1020
1042
|
* @param {string} params.replyTo - Reply to email
|
|
1021
1043
|
* @param {string} params.host - SMTP server host name
|
|
1022
|
-
* @param {number} params.port - SMTP server port
|
|
1044
|
+
* @param {number | bigint} params.port - SMTP server port
|
|
1023
1045
|
* @param {string} params.username - SMTP server username
|
|
1024
1046
|
* @param {string} params.password - SMTP server password
|
|
1025
1047
|
* @param {SMTPSecure} params.secure - Does SMTP server use secure connection
|
|
@@ -1034,7 +1056,7 @@ export declare class Projects {
|
|
|
1034
1056
|
senderEmail?: string;
|
|
1035
1057
|
replyTo?: string;
|
|
1036
1058
|
host?: string;
|
|
1037
|
-
port?: number;
|
|
1059
|
+
port?: number | bigint;
|
|
1038
1060
|
username?: string;
|
|
1039
1061
|
password?: string;
|
|
1040
1062
|
secure?: SMTPSecure;
|
|
@@ -1048,7 +1070,7 @@ export declare class Projects {
|
|
|
1048
1070
|
* @param {string} senderEmail - Email of the sender
|
|
1049
1071
|
* @param {string} replyTo - Reply to email
|
|
1050
1072
|
* @param {string} host - SMTP server host name
|
|
1051
|
-
* @param {number} port - SMTP server port
|
|
1073
|
+
* @param {number | bigint} port - SMTP server port
|
|
1052
1074
|
* @param {string} username - SMTP server username
|
|
1053
1075
|
* @param {string} password - SMTP server password
|
|
1054
1076
|
* @param {SMTPSecure} secure - Does SMTP server use secure connection
|
|
@@ -1056,7 +1078,7 @@ export declare class Projects {
|
|
|
1056
1078
|
* @returns {Promise<Models.Project>}
|
|
1057
1079
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1058
1080
|
*/
|
|
1059
|
-
updateSmtp(projectId: string, enabled: boolean, senderName?: string, senderEmail?: string, replyTo?: string, host?: string, port?: number, username?: string, password?: string, secure?: SMTPSecure): Promise<Models.Project>;
|
|
1081
|
+
updateSmtp(projectId: string, enabled: boolean, senderName?: string, senderEmail?: string, replyTo?: string, host?: string, port?: number | bigint, username?: string, password?: string, secure?: SMTPSecure): Promise<Models.Project>;
|
|
1060
1082
|
/**
|
|
1061
1083
|
* Update the SMTP configuration for your project. Use this endpoint to configure your project's SMTP provider with your custom settings for sending transactional emails.
|
|
1062
1084
|
*
|
|
@@ -1066,7 +1088,7 @@ export declare class Projects {
|
|
|
1066
1088
|
* @param {string} params.senderEmail - Email of the sender
|
|
1067
1089
|
* @param {string} params.replyTo - Reply to email
|
|
1068
1090
|
* @param {string} params.host - SMTP server host name
|
|
1069
|
-
* @param {number} params.port - SMTP server port
|
|
1091
|
+
* @param {number | bigint} params.port - SMTP server port
|
|
1070
1092
|
* @param {string} params.username - SMTP server username
|
|
1071
1093
|
* @param {string} params.password - SMTP server password
|
|
1072
1094
|
* @param {SMTPSecure} params.secure - Does SMTP server use secure connection
|
|
@@ -1080,7 +1102,7 @@ export declare class Projects {
|
|
|
1080
1102
|
senderEmail?: string;
|
|
1081
1103
|
replyTo?: string;
|
|
1082
1104
|
host?: string;
|
|
1083
|
-
port?: number;
|
|
1105
|
+
port?: number | bigint;
|
|
1084
1106
|
username?: string;
|
|
1085
1107
|
password?: string;
|
|
1086
1108
|
secure?: SMTPSecure;
|
|
@@ -1094,7 +1116,7 @@ export declare class Projects {
|
|
|
1094
1116
|
* @param {string} senderEmail - Email of the sender
|
|
1095
1117
|
* @param {string} replyTo - Reply to email
|
|
1096
1118
|
* @param {string} host - SMTP server host name
|
|
1097
|
-
* @param {number} port - SMTP server port
|
|
1119
|
+
* @param {number | bigint} port - SMTP server port
|
|
1098
1120
|
* @param {string} username - SMTP server username
|
|
1099
1121
|
* @param {string} password - SMTP server password
|
|
1100
1122
|
* @param {SMTPSecure} secure - Does SMTP server use secure connection
|
|
@@ -1102,7 +1124,7 @@ export declare class Projects {
|
|
|
1102
1124
|
* @returns {Promise<Models.Project>}
|
|
1103
1125
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1104
1126
|
*/
|
|
1105
|
-
updateSMTP(projectId: string, enabled: boolean, senderName?: string, senderEmail?: string, replyTo?: string, host?: string, port?: number, username?: string, password?: string, secure?: SMTPSecure): Promise<Models.Project>;
|
|
1127
|
+
updateSMTP(projectId: string, enabled: boolean, senderName?: string, senderEmail?: string, replyTo?: string, host?: string, port?: number | bigint, username?: string, password?: string, secure?: SMTPSecure): Promise<Models.Project>;
|
|
1106
1128
|
/**
|
|
1107
1129
|
* Send a test email to verify SMTP configuration.
|
|
1108
1130
|
*
|
|
@@ -1112,7 +1134,7 @@ export declare class Projects {
|
|
|
1112
1134
|
* @param {string} params.senderEmail - Email of the sender
|
|
1113
1135
|
* @param {string} params.host - SMTP server host name
|
|
1114
1136
|
* @param {string} params.replyTo - Reply to email
|
|
1115
|
-
* @param {number} params.port - SMTP server port
|
|
1137
|
+
* @param {number | bigint} params.port - SMTP server port
|
|
1116
1138
|
* @param {string} params.username - SMTP server username
|
|
1117
1139
|
* @param {string} params.password - SMTP server password
|
|
1118
1140
|
* @param {SMTPSecure} params.secure - Does SMTP server use secure connection
|
|
@@ -1127,7 +1149,7 @@ export declare class Projects {
|
|
|
1127
1149
|
senderEmail: string;
|
|
1128
1150
|
host: string;
|
|
1129
1151
|
replyTo?: string;
|
|
1130
|
-
port?: number;
|
|
1152
|
+
port?: number | bigint;
|
|
1131
1153
|
username?: string;
|
|
1132
1154
|
password?: string;
|
|
1133
1155
|
secure?: SMTPSecure;
|
|
@@ -1141,7 +1163,7 @@ export declare class Projects {
|
|
|
1141
1163
|
* @param {string} senderEmail - Email of the sender
|
|
1142
1164
|
* @param {string} host - SMTP server host name
|
|
1143
1165
|
* @param {string} replyTo - Reply to email
|
|
1144
|
-
* @param {number} port - SMTP server port
|
|
1166
|
+
* @param {number | bigint} port - SMTP server port
|
|
1145
1167
|
* @param {string} username - SMTP server username
|
|
1146
1168
|
* @param {string} password - SMTP server password
|
|
1147
1169
|
* @param {SMTPSecure} secure - Does SMTP server use secure connection
|
|
@@ -1149,7 +1171,7 @@ export declare class Projects {
|
|
|
1149
1171
|
* @returns {Promise<{}>}
|
|
1150
1172
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1151
1173
|
*/
|
|
1152
|
-
createSmtpTest(projectId: string, emails: string[], senderName: string, senderEmail: string, host: string, replyTo?: string, port?: number, username?: string, password?: string, secure?: SMTPSecure): Promise<{}>;
|
|
1174
|
+
createSmtpTest(projectId: string, emails: string[], senderName: string, senderEmail: string, host: string, replyTo?: string, port?: number | bigint, username?: string, password?: string, secure?: SMTPSecure): Promise<{}>;
|
|
1153
1175
|
/**
|
|
1154
1176
|
* Send a test email to verify SMTP configuration.
|
|
1155
1177
|
*
|
|
@@ -1159,7 +1181,7 @@ export declare class Projects {
|
|
|
1159
1181
|
* @param {string} params.senderEmail - Email of the sender
|
|
1160
1182
|
* @param {string} params.host - SMTP server host name
|
|
1161
1183
|
* @param {string} params.replyTo - Reply to email
|
|
1162
|
-
* @param {number} params.port - SMTP server port
|
|
1184
|
+
* @param {number | bigint} params.port - SMTP server port
|
|
1163
1185
|
* @param {string} params.username - SMTP server username
|
|
1164
1186
|
* @param {string} params.password - SMTP server password
|
|
1165
1187
|
* @param {SMTPSecure} params.secure - Does SMTP server use secure connection
|
|
@@ -1173,7 +1195,7 @@ export declare class Projects {
|
|
|
1173
1195
|
senderEmail: string;
|
|
1174
1196
|
host: string;
|
|
1175
1197
|
replyTo?: string;
|
|
1176
|
-
port?: number;
|
|
1198
|
+
port?: number | bigint;
|
|
1177
1199
|
username?: string;
|
|
1178
1200
|
password?: string;
|
|
1179
1201
|
secure?: SMTPSecure;
|
|
@@ -1187,7 +1209,7 @@ export declare class Projects {
|
|
|
1187
1209
|
* @param {string} senderEmail - Email of the sender
|
|
1188
1210
|
* @param {string} host - SMTP server host name
|
|
1189
1211
|
* @param {string} replyTo - Reply to email
|
|
1190
|
-
* @param {number} port - SMTP server port
|
|
1212
|
+
* @param {number | bigint} port - SMTP server port
|
|
1191
1213
|
* @param {string} username - SMTP server username
|
|
1192
1214
|
* @param {string} password - SMTP server password
|
|
1193
1215
|
* @param {SMTPSecure} secure - Does SMTP server use secure connection
|
|
@@ -1195,7 +1217,7 @@ export declare class Projects {
|
|
|
1195
1217
|
* @returns {Promise<{}>}
|
|
1196
1218
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1197
1219
|
*/
|
|
1198
|
-
createSMTPTest(projectId: string, emails: string[], senderName: string, senderEmail: string, host: string, replyTo?: string, port?: number, username?: string, password?: string, secure?: SMTPSecure): Promise<{}>;
|
|
1220
|
+
createSMTPTest(projectId: string, emails: string[], senderName: string, senderEmail: string, host: string, replyTo?: string, port?: number | bigint, username?: string, password?: string, secure?: SMTPSecure): Promise<{}>;
|
|
1199
1221
|
/**
|
|
1200
1222
|
* Update the status of a project
|
|
1201
1223
|
*
|
|
@@ -44,7 +44,7 @@ export declare class Sites {
|
|
|
44
44
|
* @param {BuildRuntime} params.buildRuntime - Runtime to use during build step.
|
|
45
45
|
* @param {boolean} params.enabled - Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.
|
|
46
46
|
* @param {boolean} params.logging - When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.
|
|
47
|
-
* @param {number} params.timeout - Maximum request time in seconds.
|
|
47
|
+
* @param {number | bigint} params.timeout - Maximum request time in seconds.
|
|
48
48
|
* @param {string} params.installCommand - Install Command.
|
|
49
49
|
* @param {string} params.buildCommand - Build Command.
|
|
50
50
|
* @param {string} params.outputDirectory - Output Directory for site.
|
|
@@ -66,7 +66,7 @@ export declare class Sites {
|
|
|
66
66
|
buildRuntime: BuildRuntime;
|
|
67
67
|
enabled?: boolean;
|
|
68
68
|
logging?: boolean;
|
|
69
|
-
timeout?: number;
|
|
69
|
+
timeout?: number | bigint;
|
|
70
70
|
installCommand?: string;
|
|
71
71
|
buildCommand?: string;
|
|
72
72
|
outputDirectory?: string;
|
|
@@ -88,7 +88,7 @@ export declare class Sites {
|
|
|
88
88
|
* @param {BuildRuntime} buildRuntime - Runtime to use during build step.
|
|
89
89
|
* @param {boolean} enabled - Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.
|
|
90
90
|
* @param {boolean} logging - When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.
|
|
91
|
-
* @param {number} timeout - Maximum request time in seconds.
|
|
91
|
+
* @param {number | bigint} timeout - Maximum request time in seconds.
|
|
92
92
|
* @param {string} installCommand - Install Command.
|
|
93
93
|
* @param {string} buildCommand - Build Command.
|
|
94
94
|
* @param {string} outputDirectory - Output Directory for site.
|
|
@@ -104,7 +104,7 @@ export declare class Sites {
|
|
|
104
104
|
* @returns {Promise<Models.Site>}
|
|
105
105
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
106
106
|
*/
|
|
107
|
-
create(siteId: string, name: string, framework: Framework, buildRuntime: BuildRuntime, enabled?: boolean, logging?: boolean, timeout?: number, installCommand?: string, buildCommand?: string, outputDirectory?: string, adapter?: Adapter, installationId?: string, fallbackFile?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string): Promise<Models.Site>;
|
|
107
|
+
create(siteId: string, name: string, framework: Framework, buildRuntime: BuildRuntime, enabled?: boolean, logging?: boolean, timeout?: number | bigint, installCommand?: string, buildCommand?: string, outputDirectory?: string, adapter?: Adapter, installationId?: string, fallbackFile?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string): Promise<Models.Site>;
|
|
108
108
|
/**
|
|
109
109
|
* Get a list of all frameworks that are currently available on the server instance.
|
|
110
110
|
*
|
|
@@ -124,29 +124,29 @@ export declare class Sites {
|
|
|
124
124
|
*
|
|
125
125
|
* @param {string[]} params.frameworks - List of frameworks allowed for filtering site templates. Maximum of 100 frameworks are allowed.
|
|
126
126
|
* @param {string[]} params.useCases - List of use cases allowed for filtering site templates. Maximum of 100 use cases are allowed.
|
|
127
|
-
* @param {number} params.limit - Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.
|
|
128
|
-
* @param {number} params.offset - Offset the list of returned templates. Maximum offset is 5000.
|
|
127
|
+
* @param {number | bigint} params.limit - Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.
|
|
128
|
+
* @param {number | bigint} params.offset - Offset the list of returned templates. Maximum offset is 5000.
|
|
129
129
|
* @throws {AppwriteException}
|
|
130
130
|
* @returns {Promise<Models.TemplateSiteList>}
|
|
131
131
|
*/
|
|
132
132
|
listTemplates(params?: {
|
|
133
133
|
frameworks?: string[];
|
|
134
134
|
useCases?: string[];
|
|
135
|
-
limit?: number;
|
|
136
|
-
offset?: number;
|
|
135
|
+
limit?: number | bigint;
|
|
136
|
+
offset?: number | bigint;
|
|
137
137
|
}): Promise<Models.TemplateSiteList>;
|
|
138
138
|
/**
|
|
139
139
|
* List available site templates. You can use template details in [createSite](/docs/references/cloud/server-nodejs/sites#create) method.
|
|
140
140
|
*
|
|
141
141
|
* @param {string[]} frameworks - List of frameworks allowed for filtering site templates. Maximum of 100 frameworks are allowed.
|
|
142
142
|
* @param {string[]} useCases - List of use cases allowed for filtering site templates. Maximum of 100 use cases are allowed.
|
|
143
|
-
* @param {number} limit - Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.
|
|
144
|
-
* @param {number} offset - Offset the list of returned templates. Maximum offset is 5000.
|
|
143
|
+
* @param {number | bigint} limit - Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.
|
|
144
|
+
* @param {number | bigint} offset - Offset the list of returned templates. Maximum offset is 5000.
|
|
145
145
|
* @throws {AppwriteException}
|
|
146
146
|
* @returns {Promise<Models.TemplateSiteList>}
|
|
147
147
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
148
148
|
*/
|
|
149
|
-
listTemplates(frameworks?: string[], useCases?: string[], limit?: number, offset?: number): Promise<Models.TemplateSiteList>;
|
|
149
|
+
listTemplates(frameworks?: string[], useCases?: string[], limit?: number | bigint, offset?: number | bigint): Promise<Models.TemplateSiteList>;
|
|
150
150
|
/**
|
|
151
151
|
* Get a site template using ID. You can use template details in [createSite](/docs/references/cloud/server-nodejs/sites#create) method.
|
|
152
152
|
*
|
|
@@ -212,7 +212,7 @@ export declare class Sites {
|
|
|
212
212
|
* @param {Framework} params.framework - Sites framework.
|
|
213
213
|
* @param {boolean} params.enabled - Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.
|
|
214
214
|
* @param {boolean} params.logging - When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.
|
|
215
|
-
* @param {number} params.timeout - Maximum request time in seconds.
|
|
215
|
+
* @param {number | bigint} params.timeout - Maximum request time in seconds.
|
|
216
216
|
* @param {string} params.installCommand - Install Command.
|
|
217
217
|
* @param {string} params.buildCommand - Build Command.
|
|
218
218
|
* @param {string} params.outputDirectory - Output Directory for site.
|
|
@@ -234,7 +234,7 @@ export declare class Sites {
|
|
|
234
234
|
framework: Framework;
|
|
235
235
|
enabled?: boolean;
|
|
236
236
|
logging?: boolean;
|
|
237
|
-
timeout?: number;
|
|
237
|
+
timeout?: number | bigint;
|
|
238
238
|
installCommand?: string;
|
|
239
239
|
buildCommand?: string;
|
|
240
240
|
outputDirectory?: string;
|
|
@@ -256,7 +256,7 @@ export declare class Sites {
|
|
|
256
256
|
* @param {Framework} framework - Sites framework.
|
|
257
257
|
* @param {boolean} enabled - Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.
|
|
258
258
|
* @param {boolean} logging - When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.
|
|
259
|
-
* @param {number} timeout - Maximum request time in seconds.
|
|
259
|
+
* @param {number | bigint} timeout - Maximum request time in seconds.
|
|
260
260
|
* @param {string} installCommand - Install Command.
|
|
261
261
|
* @param {string} buildCommand - Build Command.
|
|
262
262
|
* @param {string} outputDirectory - Output Directory for site.
|
|
@@ -273,7 +273,7 @@ export declare class Sites {
|
|
|
273
273
|
* @returns {Promise<Models.Site>}
|
|
274
274
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
275
275
|
*/
|
|
276
|
-
update(siteId: string, name: string, framework: Framework, enabled?: boolean, logging?: boolean, timeout?: number, installCommand?: string, buildCommand?: string, outputDirectory?: string, buildRuntime?: BuildRuntime, adapter?: Adapter, fallbackFile?: string, installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string): Promise<Models.Site>;
|
|
276
|
+
update(siteId: string, name: string, framework: Framework, enabled?: boolean, logging?: boolean, timeout?: number | bigint, installCommand?: string, buildCommand?: string, outputDirectory?: string, buildRuntime?: BuildRuntime, adapter?: Adapter, fallbackFile?: string, installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string): Promise<Models.Site>;
|
|
277
277
|
/**
|
|
278
278
|
* Delete a site by its unique ID.
|
|
279
279
|
*
|
|
@@ -40,9 +40,9 @@ export declare class Storage {
|
|
|
40
40
|
* @param {string[]} params.permissions - An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
41
41
|
* @param {boolean} params.fileSecurity - Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
42
42
|
* @param {boolean} params.enabled - Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.
|
|
43
|
-
* @param {number} params.maximumFileSize - Maximum file size allowed in bytes. Maximum allowed value is 5GB.
|
|
43
|
+
* @param {number | bigint} params.maximumFileSize - Maximum file size allowed in bytes. Maximum allowed value is 5GB.
|
|
44
44
|
* @param {string[]} params.allowedFileExtensions - Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
|
|
45
|
-
* @param {Compression} params.compression - Compression algorithm
|
|
45
|
+
* @param {Compression} params.compression - Compression algorithm chosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
|
|
46
46
|
* @param {boolean} params.encryption - Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
|
|
47
47
|
* @param {boolean} params.antivirus - Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
|
|
48
48
|
* @param {boolean} params.transformations - Are image transformations enabled?
|
|
@@ -55,7 +55,7 @@ export declare class Storage {
|
|
|
55
55
|
permissions?: string[];
|
|
56
56
|
fileSecurity?: boolean;
|
|
57
57
|
enabled?: boolean;
|
|
58
|
-
maximumFileSize?: number;
|
|
58
|
+
maximumFileSize?: number | bigint;
|
|
59
59
|
allowedFileExtensions?: string[];
|
|
60
60
|
compression?: Compression;
|
|
61
61
|
encryption?: boolean;
|
|
@@ -70,9 +70,9 @@ export declare class Storage {
|
|
|
70
70
|
* @param {string[]} permissions - An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
71
71
|
* @param {boolean} fileSecurity - Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
72
72
|
* @param {boolean} enabled - Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.
|
|
73
|
-
* @param {number} maximumFileSize - Maximum file size allowed in bytes. Maximum allowed value is 5GB.
|
|
73
|
+
* @param {number | bigint} maximumFileSize - Maximum file size allowed in bytes. Maximum allowed value is 5GB.
|
|
74
74
|
* @param {string[]} allowedFileExtensions - Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
|
|
75
|
-
* @param {Compression} compression - Compression algorithm
|
|
75
|
+
* @param {Compression} compression - Compression algorithm chosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
|
|
76
76
|
* @param {boolean} encryption - Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
|
|
77
77
|
* @param {boolean} antivirus - Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
|
|
78
78
|
* @param {boolean} transformations - Are image transformations enabled?
|
|
@@ -80,7 +80,7 @@ export declare class Storage {
|
|
|
80
80
|
* @returns {Promise<Models.Bucket>}
|
|
81
81
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
82
82
|
*/
|
|
83
|
-
createBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean, transformations?: boolean): Promise<Models.Bucket>;
|
|
83
|
+
createBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number | bigint, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean, transformations?: boolean): Promise<Models.Bucket>;
|
|
84
84
|
/**
|
|
85
85
|
* Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.
|
|
86
86
|
*
|
|
@@ -108,9 +108,9 @@ export declare class Storage {
|
|
|
108
108
|
* @param {string[]} params.permissions - An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
109
109
|
* @param {boolean} params.fileSecurity - Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
110
110
|
* @param {boolean} params.enabled - Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.
|
|
111
|
-
* @param {number} params.maximumFileSize - Maximum file size allowed in bytes. Maximum allowed value is 5GB.
|
|
111
|
+
* @param {number | bigint} params.maximumFileSize - Maximum file size allowed in bytes. Maximum allowed value is 5GB.
|
|
112
112
|
* @param {string[]} params.allowedFileExtensions - Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
|
|
113
|
-
* @param {Compression} params.compression - Compression algorithm
|
|
113
|
+
* @param {Compression} params.compression - Compression algorithm chosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
|
|
114
114
|
* @param {boolean} params.encryption - Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
|
|
115
115
|
* @param {boolean} params.antivirus - Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
|
|
116
116
|
* @param {boolean} params.transformations - Are image transformations enabled?
|
|
@@ -123,7 +123,7 @@ export declare class Storage {
|
|
|
123
123
|
permissions?: string[];
|
|
124
124
|
fileSecurity?: boolean;
|
|
125
125
|
enabled?: boolean;
|
|
126
|
-
maximumFileSize?: number;
|
|
126
|
+
maximumFileSize?: number | bigint;
|
|
127
127
|
allowedFileExtensions?: string[];
|
|
128
128
|
compression?: Compression;
|
|
129
129
|
encryption?: boolean;
|
|
@@ -138,9 +138,9 @@ export declare class Storage {
|
|
|
138
138
|
* @param {string[]} permissions - An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
139
139
|
* @param {boolean} fileSecurity - Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
140
140
|
* @param {boolean} enabled - Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.
|
|
141
|
-
* @param {number} maximumFileSize - Maximum file size allowed in bytes. Maximum allowed value is 5GB.
|
|
141
|
+
* @param {number | bigint} maximumFileSize - Maximum file size allowed in bytes. Maximum allowed value is 5GB.
|
|
142
142
|
* @param {string[]} allowedFileExtensions - Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
|
|
143
|
-
* @param {Compression} compression - Compression algorithm
|
|
143
|
+
* @param {Compression} compression - Compression algorithm chosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
|
|
144
144
|
* @param {boolean} encryption - Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
|
|
145
145
|
* @param {boolean} antivirus - Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
|
|
146
146
|
* @param {boolean} transformations - Are image transformations enabled?
|
|
@@ -148,7 +148,7 @@ export declare class Storage {
|
|
|
148
148
|
* @returns {Promise<Models.Bucket>}
|
|
149
149
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
150
150
|
*/
|
|
151
|
-
updateBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean, transformations?: boolean): Promise<Models.Bucket>;
|
|
151
|
+
updateBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number | bigint, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean, transformations?: boolean): Promise<Models.Bucket>;
|
|
152
152
|
/**
|
|
153
153
|
* Delete a storage bucket by its unique ID.
|
|
154
154
|
*
|
|
@@ -341,15 +341,15 @@ export declare class Storage {
|
|
|
341
341
|
*
|
|
342
342
|
* @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
|
|
343
343
|
* @param {string} params.fileId - File ID
|
|
344
|
-
* @param {number} params.width - Resize preview image width, Pass an integer between 0 to 4000.
|
|
345
|
-
* @param {number} params.height - Resize preview image height, Pass an integer between 0 to 4000.
|
|
344
|
+
* @param {number | bigint} params.width - Resize preview image width, Pass an integer between 0 to 4000.
|
|
345
|
+
* @param {number | bigint} params.height - Resize preview image height, Pass an integer between 0 to 4000.
|
|
346
346
|
* @param {ImageGravity} params.gravity - Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right
|
|
347
|
-
* @param {number} params.quality - Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
|
|
348
|
-
* @param {number} params.borderWidth - Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.
|
|
347
|
+
* @param {number | bigint} params.quality - Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
|
|
348
|
+
* @param {number | bigint} params.borderWidth - Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.
|
|
349
349
|
* @param {string} params.borderColor - Preview image border color. Use a valid HEX color, no # is needed for prefix.
|
|
350
|
-
* @param {number} params.borderRadius - Preview image border radius in pixels. Pass an integer between 0 to 4000.
|
|
351
|
-
* @param {number} params.opacity - Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.
|
|
352
|
-
* @param {number} params.rotation - Preview image rotation in degrees. Pass an integer between -360 and 360.
|
|
350
|
+
* @param {number | bigint} params.borderRadius - Preview image border radius in pixels. Pass an integer between 0 to 4000.
|
|
351
|
+
* @param {number | bigint} params.opacity - Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.
|
|
352
|
+
* @param {number | bigint} params.rotation - Preview image rotation in degrees. Pass an integer between -360 and 360.
|
|
353
353
|
* @param {string} params.background - Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.
|
|
354
354
|
* @param {ImageFormat} params.output - Output format type (jpeg, jpg, png, gif and webp).
|
|
355
355
|
* @param {string} params.token - File token for accessing this file.
|
|
@@ -359,15 +359,15 @@ export declare class Storage {
|
|
|
359
359
|
getFilePreview(params: {
|
|
360
360
|
bucketId: string;
|
|
361
361
|
fileId: string;
|
|
362
|
-
width?: number;
|
|
363
|
-
height?: number;
|
|
362
|
+
width?: number | bigint;
|
|
363
|
+
height?: number | bigint;
|
|
364
364
|
gravity?: ImageGravity;
|
|
365
|
-
quality?: number;
|
|
366
|
-
borderWidth?: number;
|
|
365
|
+
quality?: number | bigint;
|
|
366
|
+
borderWidth?: number | bigint;
|
|
367
367
|
borderColor?: string;
|
|
368
|
-
borderRadius?: number;
|
|
369
|
-
opacity?: number;
|
|
370
|
-
rotation?: number;
|
|
368
|
+
borderRadius?: number | bigint;
|
|
369
|
+
opacity?: number | bigint;
|
|
370
|
+
rotation?: number | bigint;
|
|
371
371
|
background?: string;
|
|
372
372
|
output?: ImageFormat;
|
|
373
373
|
token?: string;
|
|
@@ -377,15 +377,15 @@ export declare class Storage {
|
|
|
377
377
|
*
|
|
378
378
|
* @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
|
|
379
379
|
* @param {string} fileId - File ID
|
|
380
|
-
* @param {number} width - Resize preview image width, Pass an integer between 0 to 4000.
|
|
381
|
-
* @param {number} height - Resize preview image height, Pass an integer between 0 to 4000.
|
|
380
|
+
* @param {number | bigint} width - Resize preview image width, Pass an integer between 0 to 4000.
|
|
381
|
+
* @param {number | bigint} height - Resize preview image height, Pass an integer between 0 to 4000.
|
|
382
382
|
* @param {ImageGravity} gravity - Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right
|
|
383
|
-
* @param {number} quality - Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
|
|
384
|
-
* @param {number} borderWidth - Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.
|
|
383
|
+
* @param {number | bigint} quality - Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
|
|
384
|
+
* @param {number | bigint} borderWidth - Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.
|
|
385
385
|
* @param {string} borderColor - Preview image border color. Use a valid HEX color, no # is needed for prefix.
|
|
386
|
-
* @param {number} borderRadius - Preview image border radius in pixels. Pass an integer between 0 to 4000.
|
|
387
|
-
* @param {number} opacity - Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.
|
|
388
|
-
* @param {number} rotation - Preview image rotation in degrees. Pass an integer between -360 and 360.
|
|
386
|
+
* @param {number | bigint} borderRadius - Preview image border radius in pixels. Pass an integer between 0 to 4000.
|
|
387
|
+
* @param {number | bigint} opacity - Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.
|
|
388
|
+
* @param {number | bigint} rotation - Preview image rotation in degrees. Pass an integer between -360 and 360.
|
|
389
389
|
* @param {string} background - Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.
|
|
390
390
|
* @param {ImageFormat} output - Output format type (jpeg, jpg, png, gif and webp).
|
|
391
391
|
* @param {string} token - File token for accessing this file.
|
|
@@ -393,7 +393,7 @@ export declare class Storage {
|
|
|
393
393
|
* @returns {string}
|
|
394
394
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
395
395
|
*/
|
|
396
|
-
getFilePreview(bucketId: string, fileId: string, width?: number, height?: number, gravity?: ImageGravity, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: ImageFormat, token?: string): string;
|
|
396
|
+
getFilePreview(bucketId: string, fileId: string, width?: number | bigint, height?: number | bigint, gravity?: ImageGravity, quality?: number | bigint, borderWidth?: number | bigint, borderColor?: string, borderRadius?: number | bigint, opacity?: number | bigint, rotation?: number | bigint, background?: string, output?: ImageFormat, token?: string): string;
|
|
397
397
|
/**
|
|
398
398
|
* Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.
|
|
399
399
|
*
|