@appwrite.io/console 13.1.0 → 14.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/README.md +1 -1
  2. package/dist/cjs/sdk.js +5059 -687
  3. package/dist/cjs/sdk.js.map +1 -1
  4. package/dist/esm/sdk.js +5057 -688
  5. package/dist/esm/sdk.js.map +1 -1
  6. package/dist/iife/sdk.js +5061 -689
  7. package/package.json +1 -1
  8. package/types/enums/{site-adapter.d.ts → adapter.d.ts} +1 -1
  9. package/types/enums/{organization-addon.d.ts → addon.d.ts} +1 -1
  10. package/types/enums/appwrite-migration-resource.d.ts +13 -1
  11. package/types/enums/{function-runtime.d.ts → build-runtime.d.ts} +1 -1
  12. package/types/enums/embedding-model.d.ts +4 -1
  13. package/types/enums/{site-framework.d.ts → framework.d.ts} +1 -1
  14. package/types/enums/{migration-on-duplicate.d.ts → on-duplicate.d.ts} +1 -1
  15. package/types/enums/project-key-scopes.d.ts +3 -0
  16. package/types/enums/project-policy-id.d.ts +5 -1
  17. package/types/enums/query-suggestion-resource.d.ts +3 -0
  18. package/types/enums/{site-build-runtime.d.ts → runtime.d.ts} +1 -1
  19. package/types/enums/{redirect-status-code.d.ts → status-code.d.ts} +1 -1
  20. package/types/enums/status.d.ts +3 -0
  21. package/types/index.d.ts +11 -8
  22. package/types/models.d.ts +1490 -67
  23. package/types/services/account.d.ts +2 -2
  24. package/types/services/advisor.d.ts +123 -0
  25. package/types/services/apps.d.ts +302 -0
  26. package/types/services/compute.d.ts +1074 -0
  27. package/types/services/databases.d.ts +24 -24
  28. package/types/services/documents-db.d.ts +4 -1
  29. package/types/services/functions.d.ts +13 -13
  30. package/types/services/health.d.ts +8 -0
  31. package/types/services/messaging.d.ts +92 -0
  32. package/types/services/migrations.d.ts +13 -13
  33. package/types/services/organizations.d.ts +13 -13
  34. package/types/services/project.d.ts +96 -7
  35. package/types/services/projects.d.ts +5 -5
  36. package/types/services/proxy.d.ts +5 -5
  37. package/types/services/sites.d.ts +27 -27
  38. package/types/services/tables-db.d.ts +28 -25
  39. package/types/services/vectors-db.d.ts +4 -1
  40. package/types/enums/project-status.d.ts +0 -3
@@ -1089,7 +1089,7 @@ export declare class Databases {
1089
1089
  * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
1090
1090
  * @param {string} params.key - Attribute Key.
1091
1091
  * @param {boolean} params.required - Is attribute required?
1092
- * @param {any[]} params.xdefault - Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when attribute is required.
1092
+ * @param {any[][]} params.xdefault - Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when attribute is required.
1093
1093
  * @throws {AppwriteException}
1094
1094
  * @returns {Promise<Models.AttributeLine>}
1095
1095
  * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.createLineColumn` instead.
@@ -1099,7 +1099,7 @@ export declare class Databases {
1099
1099
  collectionId: string;
1100
1100
  key: string;
1101
1101
  required: boolean;
1102
- xdefault?: any[];
1102
+ xdefault?: any[][];
1103
1103
  }): Promise<Models.AttributeLine>;
1104
1104
  /**
1105
1105
  * Create a geometric line attribute.
@@ -1108,12 +1108,12 @@ export declare class Databases {
1108
1108
  * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
1109
1109
  * @param {string} key - Attribute Key.
1110
1110
  * @param {boolean} required - Is attribute required?
1111
- * @param {any[]} xdefault - Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when attribute is required.
1111
+ * @param {any[][]} xdefault - Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when attribute is required.
1112
1112
  * @throws {AppwriteException}
1113
1113
  * @returns {Promise<Models.AttributeLine>}
1114
1114
  * @deprecated Use the object parameter style method for a better developer experience.
1115
1115
  */
1116
- createLineAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: any[]): Promise<Models.AttributeLine>;
1116
+ createLineAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: any[][]): Promise<Models.AttributeLine>;
1117
1117
  /**
1118
1118
  * Update a line attribute. Changing the `default` value will not update already existing documents.
1119
1119
  *
@@ -1121,7 +1121,7 @@ export declare class Databases {
1121
1121
  * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#createCollection).
1122
1122
  * @param {string} params.key - Attribute Key.
1123
1123
  * @param {boolean} params.required - Is attribute required?
1124
- * @param {any[]} params.xdefault - Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when attribute is required.
1124
+ * @param {any[][]} params.xdefault - Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when attribute is required.
1125
1125
  * @param {string} params.newKey - New attribute key.
1126
1126
  * @throws {AppwriteException}
1127
1127
  * @returns {Promise<Models.AttributeLine>}
@@ -1132,7 +1132,7 @@ export declare class Databases {
1132
1132
  collectionId: string;
1133
1133
  key: string;
1134
1134
  required: boolean;
1135
- xdefault?: any[];
1135
+ xdefault?: any[][];
1136
1136
  newKey?: string;
1137
1137
  }): Promise<Models.AttributeLine>;
1138
1138
  /**
@@ -1142,13 +1142,13 @@ export declare class Databases {
1142
1142
  * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#createCollection).
1143
1143
  * @param {string} key - Attribute Key.
1144
1144
  * @param {boolean} required - Is attribute required?
1145
- * @param {any[]} xdefault - Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when attribute is required.
1145
+ * @param {any[][]} xdefault - Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when attribute is required.
1146
1146
  * @param {string} newKey - New attribute key.
1147
1147
  * @throws {AppwriteException}
1148
1148
  * @returns {Promise<Models.AttributeLine>}
1149
1149
  * @deprecated Use the object parameter style method for a better developer experience.
1150
1150
  */
1151
- updateLineAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: any[], newKey?: string): Promise<Models.AttributeLine>;
1151
+ updateLineAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: any[][], newKey?: string): Promise<Models.AttributeLine>;
1152
1152
  /**
1153
1153
  * Create a longtext attribute.
1154
1154
  *
@@ -1306,7 +1306,7 @@ export declare class Databases {
1306
1306
  * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
1307
1307
  * @param {string} params.key - Attribute Key.
1308
1308
  * @param {boolean} params.required - Is attribute required?
1309
- * @param {any[]} params.xdefault - Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.
1309
+ * @param {number[]} params.xdefault - Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.
1310
1310
  * @throws {AppwriteException}
1311
1311
  * @returns {Promise<Models.AttributePoint>}
1312
1312
  * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.createPointColumn` instead.
@@ -1316,7 +1316,7 @@ export declare class Databases {
1316
1316
  collectionId: string;
1317
1317
  key: string;
1318
1318
  required: boolean;
1319
- xdefault?: any[];
1319
+ xdefault?: number[];
1320
1320
  }): Promise<Models.AttributePoint>;
1321
1321
  /**
1322
1322
  * Create a geometric point attribute.
@@ -1325,12 +1325,12 @@ export declare class Databases {
1325
1325
  * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
1326
1326
  * @param {string} key - Attribute Key.
1327
1327
  * @param {boolean} required - Is attribute required?
1328
- * @param {any[]} xdefault - Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.
1328
+ * @param {number[]} xdefault - Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.
1329
1329
  * @throws {AppwriteException}
1330
1330
  * @returns {Promise<Models.AttributePoint>}
1331
1331
  * @deprecated Use the object parameter style method for a better developer experience.
1332
1332
  */
1333
- createPointAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: any[]): Promise<Models.AttributePoint>;
1333
+ createPointAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: number[]): Promise<Models.AttributePoint>;
1334
1334
  /**
1335
1335
  * Update a point attribute. Changing the `default` value will not update already existing documents.
1336
1336
  *
@@ -1338,7 +1338,7 @@ export declare class Databases {
1338
1338
  * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#createCollection).
1339
1339
  * @param {string} params.key - Attribute Key.
1340
1340
  * @param {boolean} params.required - Is attribute required?
1341
- * @param {any[]} params.xdefault - Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.
1341
+ * @param {number[]} params.xdefault - Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.
1342
1342
  * @param {string} params.newKey - New attribute key.
1343
1343
  * @throws {AppwriteException}
1344
1344
  * @returns {Promise<Models.AttributePoint>}
@@ -1349,7 +1349,7 @@ export declare class Databases {
1349
1349
  collectionId: string;
1350
1350
  key: string;
1351
1351
  required: boolean;
1352
- xdefault?: any[];
1352
+ xdefault?: number[];
1353
1353
  newKey?: string;
1354
1354
  }): Promise<Models.AttributePoint>;
1355
1355
  /**
@@ -1359,13 +1359,13 @@ export declare class Databases {
1359
1359
  * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#createCollection).
1360
1360
  * @param {string} key - Attribute Key.
1361
1361
  * @param {boolean} required - Is attribute required?
1362
- * @param {any[]} xdefault - Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.
1362
+ * @param {number[]} xdefault - Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.
1363
1363
  * @param {string} newKey - New attribute key.
1364
1364
  * @throws {AppwriteException}
1365
1365
  * @returns {Promise<Models.AttributePoint>}
1366
1366
  * @deprecated Use the object parameter style method for a better developer experience.
1367
1367
  */
1368
- updatePointAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: any[], newKey?: string): Promise<Models.AttributePoint>;
1368
+ updatePointAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: number[], newKey?: string): Promise<Models.AttributePoint>;
1369
1369
  /**
1370
1370
  * Create a geometric polygon attribute.
1371
1371
  *
@@ -1373,7 +1373,7 @@ export declare class Databases {
1373
1373
  * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
1374
1374
  * @param {string} params.key - Attribute Key.
1375
1375
  * @param {boolean} params.required - Is attribute required?
1376
- * @param {any[]} params.xdefault - Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.
1376
+ * @param {any[][]} params.xdefault - Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.
1377
1377
  * @throws {AppwriteException}
1378
1378
  * @returns {Promise<Models.AttributePolygon>}
1379
1379
  * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.createPolygonColumn` instead.
@@ -1383,7 +1383,7 @@ export declare class Databases {
1383
1383
  collectionId: string;
1384
1384
  key: string;
1385
1385
  required: boolean;
1386
- xdefault?: any[];
1386
+ xdefault?: any[][];
1387
1387
  }): Promise<Models.AttributePolygon>;
1388
1388
  /**
1389
1389
  * Create a geometric polygon attribute.
@@ -1392,12 +1392,12 @@ export declare class Databases {
1392
1392
  * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
1393
1393
  * @param {string} key - Attribute Key.
1394
1394
  * @param {boolean} required - Is attribute required?
1395
- * @param {any[]} xdefault - Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.
1395
+ * @param {any[][]} xdefault - Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.
1396
1396
  * @throws {AppwriteException}
1397
1397
  * @returns {Promise<Models.AttributePolygon>}
1398
1398
  * @deprecated Use the object parameter style method for a better developer experience.
1399
1399
  */
1400
- createPolygonAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: any[]): Promise<Models.AttributePolygon>;
1400
+ createPolygonAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: any[][]): Promise<Models.AttributePolygon>;
1401
1401
  /**
1402
1402
  * Update a polygon attribute. Changing the `default` value will not update already existing documents.
1403
1403
  *
@@ -1405,7 +1405,7 @@ export declare class Databases {
1405
1405
  * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#createCollection).
1406
1406
  * @param {string} params.key - Attribute Key.
1407
1407
  * @param {boolean} params.required - Is attribute required?
1408
- * @param {any[]} params.xdefault - Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.
1408
+ * @param {any[][]} params.xdefault - Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.
1409
1409
  * @param {string} params.newKey - New attribute key.
1410
1410
  * @throws {AppwriteException}
1411
1411
  * @returns {Promise<Models.AttributePolygon>}
@@ -1416,7 +1416,7 @@ export declare class Databases {
1416
1416
  collectionId: string;
1417
1417
  key: string;
1418
1418
  required: boolean;
1419
- xdefault?: any[];
1419
+ xdefault?: any[][];
1420
1420
  newKey?: string;
1421
1421
  }): Promise<Models.AttributePolygon>;
1422
1422
  /**
@@ -1426,13 +1426,13 @@ export declare class Databases {
1426
1426
  * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#createCollection).
1427
1427
  * @param {string} key - Attribute Key.
1428
1428
  * @param {boolean} required - Is attribute required?
1429
- * @param {any[]} xdefault - Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.
1429
+ * @param {any[][]} xdefault - Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.
1430
1430
  * @param {string} newKey - New attribute key.
1431
1431
  * @throws {AppwriteException}
1432
1432
  * @returns {Promise<Models.AttributePolygon>}
1433
1433
  * @deprecated Use the object parameter style method for a better developer experience.
1434
1434
  */
1435
- updatePolygonAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: any[], newKey?: string): Promise<Models.AttributePolygon>;
1435
+ updatePolygonAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: any[][], newKey?: string): Promise<Models.AttributePolygon>;
1436
1436
  /**
1437
1437
  * Create relationship attribute. [Learn more about relationship attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
1438
1438
  *
@@ -35,6 +35,7 @@ export declare class DocumentsDB {
35
35
  * @param {string} params.databaseId - Unique 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.
36
36
  * @param {string} params.name - Database name. Max length: 128 chars.
37
37
  * @param {boolean} params.enabled - Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.
38
+ * @param {string} params.dedicatedDatabaseId - Optional dedicated database (compute) ID to attach this database to. Leave empty to create a database on the shared pool.
38
39
  * @throws {AppwriteException}
39
40
  * @returns {Promise<Models.Database>}
40
41
  */
@@ -42,6 +43,7 @@ export declare class DocumentsDB {
42
43
  databaseId: string;
43
44
  name: string;
44
45
  enabled?: boolean;
46
+ dedicatedDatabaseId?: string;
45
47
  }): Promise<Models.Database>;
46
48
  /**
47
49
  * Create a new Database.
@@ -50,11 +52,12 @@ export declare class DocumentsDB {
50
52
  * @param {string} databaseId - Unique 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.
51
53
  * @param {string} name - Database name. Max length: 128 chars.
52
54
  * @param {boolean} enabled - Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.
55
+ * @param {string} dedicatedDatabaseId - Optional dedicated database (compute) ID to attach this database to. Leave empty to create a database on the shared pool.
53
56
  * @throws {AppwriteException}
54
57
  * @returns {Promise<Models.Database>}
55
58
  * @deprecated Use the object parameter style method for a better developer experience.
56
59
  */
57
- create(databaseId: string, name: string, enabled?: boolean): Promise<Models.Database>;
60
+ create(databaseId: string, name: string, enabled?: boolean, dedicatedDatabaseId?: string): Promise<Models.Database>;
58
61
  /**
59
62
  * List transactions across all databases.
60
63
  *
@@ -1,6 +1,6 @@
1
1
  import { Client, UploadProgress } from '../client';
2
2
  import type { Models } from '../models';
3
- import { FunctionRuntime } from '../enums/function-runtime';
3
+ import { Runtime } from '../enums/runtime';
4
4
  import { ProjectKeyScopes } from '../enums/project-key-scopes';
5
5
  import { FunctionTemplateUseCase } from '../enums/function-template-use-case';
6
6
  import { UsageRange } from '../enums/usage-range';
@@ -41,7 +41,7 @@ export declare class Functions {
41
41
  *
42
42
  * @param {string} params.functionId - Function 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.
43
43
  * @param {string} params.name - Function name. Max length: 128 chars.
44
- * @param {FunctionRuntime} params.runtime - Execution runtime.
44
+ * @param {Runtime} params.runtime - Execution runtime.
45
45
  * @param {string[]} params.execute - An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
46
46
  * @param {string[]} params.events - Events list. Maximum of 100 events are allowed.
47
47
  * @param {string} params.schedule - Schedule CRON syntax.
@@ -67,7 +67,7 @@ export declare class Functions {
67
67
  create(params: {
68
68
  functionId: string;
69
69
  name: string;
70
- runtime: FunctionRuntime;
70
+ runtime: Runtime;
71
71
  execute?: string[];
72
72
  events?: string[];
73
73
  schedule?: string;
@@ -93,7 +93,7 @@ export declare class Functions {
93
93
  *
94
94
  * @param {string} functionId - Function 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.
95
95
  * @param {string} name - Function name. Max length: 128 chars.
96
- * @param {FunctionRuntime} runtime - Execution runtime.
96
+ * @param {Runtime} runtime - Execution runtime.
97
97
  * @param {string[]} execute - An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
98
98
  * @param {string[]} events - Events list. Maximum of 100 events are allowed.
99
99
  * @param {string} schedule - Schedule CRON syntax.
@@ -117,7 +117,7 @@ export declare class Functions {
117
117
  * @returns {Promise<Models.Function>}
118
118
  * @deprecated Use the object parameter style method for a better developer experience.
119
119
  */
120
- create(functionId: string, name: string, runtime: FunctionRuntime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: ProjectKeyScopes[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, providerBranches?: string[], providerPaths?: string[], buildSpecification?: string, runtimeSpecification?: string, deploymentRetention?: number): Promise<Models.Function>;
120
+ create(functionId: string, name: string, runtime: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: ProjectKeyScopes[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, providerBranches?: string[], providerPaths?: string[], buildSpecification?: string, runtimeSpecification?: string, deploymentRetention?: number): Promise<Models.Function>;
121
121
  /**
122
122
  * Get a list of all runtimes that are currently active on your instance.
123
123
  *
@@ -135,7 +135,7 @@ export declare class Functions {
135
135
  /**
136
136
  * List available function templates. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.
137
137
  *
138
- * @param {FunctionRuntime[]} params.runtimes - List of runtimes allowed for filtering function templates. Maximum of 100 runtimes are allowed.
138
+ * @param {Runtime[]} params.runtimes - List of runtimes allowed for filtering function templates. Maximum of 100 runtimes are allowed.
139
139
  * @param {FunctionTemplateUseCase[]} params.useCases - List of use cases allowed for filtering function templates. Maximum of 100 use cases are allowed.
140
140
  * @param {number} params.limit - Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.
141
141
  * @param {number} params.offset - Offset the list of returned templates. Maximum offset is 5000.
@@ -144,7 +144,7 @@ export declare class Functions {
144
144
  * @returns {Promise<Models.TemplateFunctionList>}
145
145
  */
146
146
  listTemplates(params?: {
147
- runtimes?: FunctionRuntime[];
147
+ runtimes?: Runtime[];
148
148
  useCases?: FunctionTemplateUseCase[];
149
149
  limit?: number;
150
150
  offset?: number;
@@ -153,7 +153,7 @@ export declare class Functions {
153
153
  /**
154
154
  * List available function templates. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.
155
155
  *
156
- * @param {FunctionRuntime[]} runtimes - List of runtimes allowed for filtering function templates. Maximum of 100 runtimes are allowed.
156
+ * @param {Runtime[]} runtimes - List of runtimes allowed for filtering function templates. Maximum of 100 runtimes are allowed.
157
157
  * @param {FunctionTemplateUseCase[]} useCases - List of use cases allowed for filtering function templates. Maximum of 100 use cases are allowed.
158
158
  * @param {number} limit - Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.
159
159
  * @param {number} offset - Offset the list of returned templates. Maximum offset is 5000.
@@ -162,7 +162,7 @@ export declare class Functions {
162
162
  * @returns {Promise<Models.TemplateFunctionList>}
163
163
  * @deprecated Use the object parameter style method for a better developer experience.
164
164
  */
165
- listTemplates(runtimes?: FunctionRuntime[], useCases?: FunctionTemplateUseCase[], limit?: number, offset?: number, total?: boolean): Promise<Models.TemplateFunctionList>;
165
+ listTemplates(runtimes?: Runtime[], useCases?: FunctionTemplateUseCase[], limit?: number, offset?: number, total?: boolean): Promise<Models.TemplateFunctionList>;
166
166
  /**
167
167
  * Get a function template using ID. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.
168
168
  *
@@ -225,7 +225,7 @@ export declare class Functions {
225
225
  *
226
226
  * @param {string} params.functionId - Function ID.
227
227
  * @param {string} params.name - Function name. Max length: 128 chars.
228
- * @param {FunctionRuntime} params.runtime - Execution runtime.
228
+ * @param {Runtime} params.runtime - Execution runtime.
229
229
  * @param {string[]} params.execute - An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
230
230
  * @param {string[]} params.events - Events list. Maximum of 100 events are allowed.
231
231
  * @param {string} params.schedule - Schedule CRON syntax.
@@ -251,7 +251,7 @@ export declare class Functions {
251
251
  update(params: {
252
252
  functionId: string;
253
253
  name: string;
254
- runtime?: FunctionRuntime;
254
+ runtime?: Runtime;
255
255
  execute?: string[];
256
256
  events?: string[];
257
257
  schedule?: string;
@@ -277,7 +277,7 @@ export declare class Functions {
277
277
  *
278
278
  * @param {string} functionId - Function ID.
279
279
  * @param {string} name - Function name. Max length: 128 chars.
280
- * @param {FunctionRuntime} runtime - Execution runtime.
280
+ * @param {Runtime} runtime - Execution runtime.
281
281
  * @param {string[]} execute - An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
282
282
  * @param {string[]} events - Events list. Maximum of 100 events are allowed.
283
283
  * @param {string} schedule - Schedule CRON syntax.
@@ -301,7 +301,7 @@ export declare class Functions {
301
301
  * @returns {Promise<Models.Function>}
302
302
  * @deprecated Use the object parameter style method for a better developer experience.
303
303
  */
304
- update(functionId: string, name: string, runtime?: FunctionRuntime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: ProjectKeyScopes[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, providerBranches?: string[], providerPaths?: string[], buildSpecification?: string, runtimeSpecification?: string, deploymentRetention?: number): Promise<Models.Function>;
304
+ update(functionId: string, name: string, runtime?: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: ProjectKeyScopes[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, providerBranches?: string[], providerPaths?: string[], buildSpecification?: string, runtimeSpecification?: string, deploymentRetention?: number): Promise<Models.Function>;
305
305
  /**
306
306
  * Delete a function by its unique ID.
307
307
  *
@@ -18,6 +18,14 @@ export declare class Health {
18
18
  * @returns {Promise<Models.HealthAntivirus>}
19
19
  */
20
20
  getAntivirus(): Promise<Models.HealthAntivirus>;
21
+ /**
22
+ * Check the database that backs the audit and activity store. When the connection is reachable the endpoint returns a passing status with its response time.
23
+ *
24
+ *
25
+ * @throws {AppwriteException}
26
+ * @returns {Promise<Models.HealthStatusList>}
27
+ */
28
+ getAuditsDB(): Promise<Models.HealthStatusList>;
21
29
  /**
22
30
  * Check the Appwrite in-memory cache servers are up and connection is successful.
23
31
  *
@@ -1149,6 +1149,98 @@ export declare class Messaging {
1149
1149
  * @deprecated Use the object parameter style method for a better developer experience.
1150
1150
  */
1151
1151
  updateSendgridProvider(providerId: string, name?: string, enabled?: boolean, apiKey?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string): Promise<Models.Provider>;
1152
+ /**
1153
+ * Create a new Amazon SES provider.
1154
+ *
1155
+ * @param {string} params.providerId - Provider 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.
1156
+ * @param {string} params.name - Provider name.
1157
+ * @param {string} params.accessKey - AWS access key ID.
1158
+ * @param {string} params.secretKey - AWS secret access key.
1159
+ * @param {string} params.region - AWS region, for example us-east-1.
1160
+ * @param {string} params.fromName - Sender Name.
1161
+ * @param {string} params.fromEmail - Sender email address.
1162
+ * @param {string} params.replyToName - Name set in the reply to field for the mail. Default value is sender name.
1163
+ * @param {string} params.replyToEmail - Email set in the reply to field for the mail. Default value is sender email.
1164
+ * @param {boolean} params.enabled - Set as enabled.
1165
+ * @throws {AppwriteException}
1166
+ * @returns {Promise<Models.Provider>}
1167
+ */
1168
+ createSesProvider(params: {
1169
+ providerId: string;
1170
+ name: string;
1171
+ accessKey?: string;
1172
+ secretKey?: string;
1173
+ region?: string;
1174
+ fromName?: string;
1175
+ fromEmail?: string;
1176
+ replyToName?: string;
1177
+ replyToEmail?: string;
1178
+ enabled?: boolean;
1179
+ }): Promise<Models.Provider>;
1180
+ /**
1181
+ * Create a new Amazon SES provider.
1182
+ *
1183
+ * @param {string} providerId - Provider 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.
1184
+ * @param {string} name - Provider name.
1185
+ * @param {string} accessKey - AWS access key ID.
1186
+ * @param {string} secretKey - AWS secret access key.
1187
+ * @param {string} region - AWS region, for example us-east-1.
1188
+ * @param {string} fromName - Sender Name.
1189
+ * @param {string} fromEmail - Sender email address.
1190
+ * @param {string} replyToName - Name set in the reply to field for the mail. Default value is sender name.
1191
+ * @param {string} replyToEmail - Email set in the reply to field for the mail. Default value is sender email.
1192
+ * @param {boolean} enabled - Set as enabled.
1193
+ * @throws {AppwriteException}
1194
+ * @returns {Promise<Models.Provider>}
1195
+ * @deprecated Use the object parameter style method for a better developer experience.
1196
+ */
1197
+ createSesProvider(providerId: string, name: string, accessKey?: string, secretKey?: string, region?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider>;
1198
+ /**
1199
+ * Update an Amazon SES provider by its unique ID.
1200
+ *
1201
+ * @param {string} params.providerId - Provider ID.
1202
+ * @param {string} params.name - Provider name.
1203
+ * @param {boolean} params.enabled - Set as enabled.
1204
+ * @param {string} params.accessKey - AWS access key ID.
1205
+ * @param {string} params.secretKey - AWS secret access key.
1206
+ * @param {string} params.region - AWS region, for example us-east-1.
1207
+ * @param {string} params.fromName - Sender Name.
1208
+ * @param {string} params.fromEmail - Sender email address.
1209
+ * @param {string} params.replyToName - Name set in the Reply To field for the mail. Default value is Sender Name.
1210
+ * @param {string} params.replyToEmail - Email set in the Reply To field for the mail. Default value is Sender Email.
1211
+ * @throws {AppwriteException}
1212
+ * @returns {Promise<Models.Provider>}
1213
+ */
1214
+ updateSesProvider(params: {
1215
+ providerId: string;
1216
+ name?: string;
1217
+ enabled?: boolean;
1218
+ accessKey?: string;
1219
+ secretKey?: string;
1220
+ region?: string;
1221
+ fromName?: string;
1222
+ fromEmail?: string;
1223
+ replyToName?: string;
1224
+ replyToEmail?: string;
1225
+ }): Promise<Models.Provider>;
1226
+ /**
1227
+ * Update an Amazon SES provider by its unique ID.
1228
+ *
1229
+ * @param {string} providerId - Provider ID.
1230
+ * @param {string} name - Provider name.
1231
+ * @param {boolean} enabled - Set as enabled.
1232
+ * @param {string} accessKey - AWS access key ID.
1233
+ * @param {string} secretKey - AWS secret access key.
1234
+ * @param {string} region - AWS region, for example us-east-1.
1235
+ * @param {string} fromName - Sender Name.
1236
+ * @param {string} fromEmail - Sender email address.
1237
+ * @param {string} replyToName - Name set in the Reply To field for the mail. Default value is Sender Name.
1238
+ * @param {string} replyToEmail - Email set in the Reply To field for the mail. Default value is Sender Email.
1239
+ * @throws {AppwriteException}
1240
+ * @returns {Promise<Models.Provider>}
1241
+ * @deprecated Use the object parameter style method for a better developer experience.
1242
+ */
1243
+ updateSesProvider(providerId: string, name?: string, enabled?: boolean, accessKey?: string, secretKey?: string, region?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string): Promise<Models.Provider>;
1152
1244
  /**
1153
1245
  * Create a new SMTP provider.
1154
1246
  *
@@ -1,7 +1,7 @@
1
1
  import { Client } from '../client';
2
2
  import type { Models } from '../models';
3
3
  import { AppwriteMigrationResource } from '../enums/appwrite-migration-resource';
4
- import { MigrationOnDuplicate } from '../enums/migration-on-duplicate';
4
+ import { OnDuplicate } from '../enums/on-duplicate';
5
5
  import { FirebaseMigrationResource } from '../enums/firebase-migration-resource';
6
6
  import { NHostMigrationResource } from '../enums/n-host-migration-resource';
7
7
  import { SupabaseMigrationResource } from '../enums/supabase-migration-resource';
@@ -40,7 +40,7 @@ export declare class Migrations {
40
40
  * @param {string} params.endpoint - Source Appwrite endpoint
41
41
  * @param {string} params.projectId - Source Project ID
42
42
  * @param {string} params.apiKey - Source API Key
43
- * @param {MigrationOnDuplicate} params.onDuplicate - Behavior when a row with an existing $id is encountered. "fail" (default): abort on first conflict. "skip": silently ignore. "overwrite": replace existing row.
43
+ * @param {OnDuplicate} params.onDuplicate - Behavior when a row with an existing $id is encountered. "fail" (default): abort on first conflict. "skip": silently ignore. "overwrite": replace existing row.
44
44
  * @throws {AppwriteException}
45
45
  * @returns {Promise<Models.Migration>}
46
46
  */
@@ -49,7 +49,7 @@ export declare class Migrations {
49
49
  endpoint: string;
50
50
  projectId: string;
51
51
  apiKey: string;
52
- onDuplicate?: MigrationOnDuplicate;
52
+ onDuplicate?: OnDuplicate;
53
53
  }): Promise<Models.Migration>;
54
54
  /**
55
55
  * Migrate data from another Appwrite project to your current project. This endpoint allows you to migrate resources like databases, collections, documents, users, and files from an existing Appwrite project.
@@ -58,12 +58,12 @@ export declare class Migrations {
58
58
  * @param {string} endpoint - Source Appwrite endpoint
59
59
  * @param {string} projectId - Source Project ID
60
60
  * @param {string} apiKey - Source API Key
61
- * @param {MigrationOnDuplicate} onDuplicate - Behavior when a row with an existing $id is encountered. "fail" (default): abort on first conflict. "skip": silently ignore. "overwrite": replace existing row.
61
+ * @param {OnDuplicate} onDuplicate - Behavior when a row with an existing $id is encountered. "fail" (default): abort on first conflict. "skip": silently ignore. "overwrite": replace existing row.
62
62
  * @throws {AppwriteException}
63
63
  * @returns {Promise<Models.Migration>}
64
64
  * @deprecated Use the object parameter style method for a better developer experience.
65
65
  */
66
- createAppwriteMigration(resources: AppwriteMigrationResource[], endpoint: string, projectId: string, apiKey: string, onDuplicate?: MigrationOnDuplicate): Promise<Models.Migration>;
66
+ createAppwriteMigration(resources: AppwriteMigrationResource[], endpoint: string, projectId: string, apiKey: string, onDuplicate?: OnDuplicate): Promise<Models.Migration>;
67
67
  /**
68
68
  * Generate a report of the data in an Appwrite project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
69
69
  *
@@ -142,7 +142,7 @@ export declare class Migrations {
142
142
  * @param {string} params.fileId - File ID.
143
143
  * @param {string} params.resourceId - Composite ID in the format {databaseId:collectionId}, identifying a collection within a database.
144
144
  * @param {boolean} params.internalFile - Is the file stored in an internal bucket?
145
- * @param {MigrationOnDuplicate} params.onDuplicate - Behavior when a row with an existing $id is encountered. "fail" (default): abort on first conflict. "skip": silently ignore. "overwrite": replace existing row.
145
+ * @param {OnDuplicate} params.onDuplicate - Behavior when a row with an existing $id is encountered. "fail" (default): abort on first conflict. "skip": silently ignore. "overwrite": replace existing row.
146
146
  * @throws {AppwriteException}
147
147
  * @returns {Promise<Models.Migration>}
148
148
  */
@@ -151,7 +151,7 @@ export declare class Migrations {
151
151
  fileId: string;
152
152
  resourceId: string;
153
153
  internalFile?: boolean;
154
- onDuplicate?: MigrationOnDuplicate;
154
+ onDuplicate?: OnDuplicate;
155
155
  }): Promise<Models.Migration>;
156
156
  /**
157
157
  * Import documents from a CSV file into your Appwrite database. This endpoint allows you to import documents from a CSV file uploaded to Appwrite Storage bucket.
@@ -160,12 +160,12 @@ export declare class Migrations {
160
160
  * @param {string} fileId - File ID.
161
161
  * @param {string} resourceId - Composite ID in the format {databaseId:collectionId}, identifying a collection within a database.
162
162
  * @param {boolean} internalFile - Is the file stored in an internal bucket?
163
- * @param {MigrationOnDuplicate} onDuplicate - Behavior when a row with an existing $id is encountered. "fail" (default): abort on first conflict. "skip": silently ignore. "overwrite": replace existing row.
163
+ * @param {OnDuplicate} onDuplicate - Behavior when a row with an existing $id is encountered. "fail" (default): abort on first conflict. "skip": silently ignore. "overwrite": replace existing row.
164
164
  * @throws {AppwriteException}
165
165
  * @returns {Promise<Models.Migration>}
166
166
  * @deprecated Use the object parameter style method for a better developer experience.
167
167
  */
168
- createCSVImport(bucketId: string, fileId: string, resourceId: string, internalFile?: boolean, onDuplicate?: MigrationOnDuplicate): Promise<Models.Migration>;
168
+ createCSVImport(bucketId: string, fileId: string, resourceId: string, internalFile?: boolean, onDuplicate?: OnDuplicate): Promise<Models.Migration>;
169
169
  /**
170
170
  * Migrate data from a Firebase project to your Appwrite project. This endpoint allows you to migrate resources like authentication and other supported services from a Firebase project.
171
171
  *
@@ -251,7 +251,7 @@ export declare class Migrations {
251
251
  * @param {string} params.fileId - File ID.
252
252
  * @param {string} params.resourceId - Composite ID in the format {databaseId:collectionId}, identifying a collection within a database.
253
253
  * @param {boolean} params.internalFile - Is the file stored in an internal bucket?
254
- * @param {MigrationOnDuplicate} params.onDuplicate - Behavior when a row with an existing $id is encountered. "fail" (default): abort on first conflict. "skip": silently ignore. "overwrite": replace existing row.
254
+ * @param {OnDuplicate} params.onDuplicate - Behavior when a row with an existing $id is encountered. "fail" (default): abort on first conflict. "skip": silently ignore. "overwrite": replace existing row.
255
255
  * @throws {AppwriteException}
256
256
  * @returns {Promise<Models.Migration>}
257
257
  */
@@ -260,7 +260,7 @@ export declare class Migrations {
260
260
  fileId: string;
261
261
  resourceId: string;
262
262
  internalFile?: boolean;
263
- onDuplicate?: MigrationOnDuplicate;
263
+ onDuplicate?: OnDuplicate;
264
264
  }): Promise<Models.Migration>;
265
265
  /**
266
266
  * Import documents from a JSON file into your Appwrite database. This endpoint allows you to import documents from a JSON file uploaded to Appwrite Storage bucket.
@@ -270,12 +270,12 @@ export declare class Migrations {
270
270
  * @param {string} fileId - File ID.
271
271
  * @param {string} resourceId - Composite ID in the format {databaseId:collectionId}, identifying a collection within a database.
272
272
  * @param {boolean} internalFile - Is the file stored in an internal bucket?
273
- * @param {MigrationOnDuplicate} onDuplicate - Behavior when a row with an existing $id is encountered. "fail" (default): abort on first conflict. "skip": silently ignore. "overwrite": replace existing row.
273
+ * @param {OnDuplicate} onDuplicate - Behavior when a row with an existing $id is encountered. "fail" (default): abort on first conflict. "skip": silently ignore. "overwrite": replace existing row.
274
274
  * @throws {AppwriteException}
275
275
  * @returns {Promise<Models.Migration>}
276
276
  * @deprecated Use the object parameter style method for a better developer experience.
277
277
  */
278
- createJSONImport(bucketId: string, fileId: string, resourceId: string, internalFile?: boolean, onDuplicate?: MigrationOnDuplicate): Promise<Models.Migration>;
278
+ createJSONImport(bucketId: string, fileId: string, resourceId: string, internalFile?: boolean, onDuplicate?: OnDuplicate): Promise<Models.Migration>;
279
279
  /**
280
280
  * Migrate data from an NHost project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from an NHost project.
281
281
  *