@appwrite.io/console 2.1.3 → 2.2.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 (132) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/README.md +1 -1
  3. package/dist/cjs/sdk.js +1564 -187
  4. package/dist/cjs/sdk.js.map +1 -1
  5. package/dist/esm/sdk.js +1565 -188
  6. package/dist/esm/sdk.js.map +1 -1
  7. package/dist/iife/sdk.js +1564 -187
  8. package/docs/examples/account/create-key.md +15 -0
  9. package/docs/examples/account/delete-key.md +13 -0
  10. package/docs/examples/account/get-key.md +13 -0
  11. package/docs/examples/account/list-keys.md +13 -0
  12. package/docs/examples/account/update-key.md +16 -0
  13. package/docs/examples/avatars/get-screenshot.md +5 -5
  14. package/docs/examples/backups/create-archive.md +2 -2
  15. package/docs/examples/backups/create-policy.md +2 -2
  16. package/docs/examples/backups/create-restoration.md +2 -2
  17. package/docs/examples/console/{get-regions.md → list-regions.md} +1 -3
  18. package/docs/examples/databases/create-index.md +2 -2
  19. package/docs/examples/databases/create-longtext-attribute.md +18 -0
  20. package/docs/examples/databases/create-mediumtext-attribute.md +18 -0
  21. package/docs/examples/databases/create-text-attribute.md +18 -0
  22. package/docs/examples/databases/create-varchar-attribute.md +19 -0
  23. package/docs/examples/databases/update-collection.md +1 -1
  24. package/docs/examples/databases/update-longtext-attribute.md +18 -0
  25. package/docs/examples/databases/update-mediumtext-attribute.md +18 -0
  26. package/docs/examples/databases/update-text-attribute.md +18 -0
  27. package/docs/examples/databases/update-varchar-attribute.md +19 -0
  28. package/docs/examples/databases/update.md +1 -1
  29. package/docs/examples/functions/create.md +2 -2
  30. package/docs/examples/functions/list-templates.md +3 -3
  31. package/docs/examples/functions/update.md +2 -2
  32. package/docs/examples/migrations/create-appwrite-migration.md +2 -2
  33. package/docs/examples/migrations/create-firebase-migration.md +2 -2
  34. package/docs/examples/migrations/create-n-host-migration.md +2 -2
  35. package/docs/examples/migrations/create-supabase-migration.md +2 -2
  36. package/docs/examples/migrations/get-appwrite-report.md +2 -2
  37. package/docs/examples/migrations/get-firebase-report.md +2 -2
  38. package/docs/examples/migrations/get-n-host-report.md +2 -2
  39. package/docs/examples/migrations/get-supabase-report.md +2 -2
  40. package/docs/examples/organizations/create-key.md +16 -0
  41. package/docs/examples/organizations/create.md +2 -2
  42. package/docs/examples/organizations/delete-key.md +14 -0
  43. package/docs/examples/organizations/estimation-create-organization.md +2 -2
  44. package/docs/examples/organizations/estimation-update-plan.md +2 -2
  45. package/docs/examples/organizations/get-key.md +14 -0
  46. package/docs/examples/organizations/list-keys.md +14 -0
  47. package/docs/examples/organizations/list-regions.md +13 -0
  48. package/docs/examples/organizations/update-key.md +17 -0
  49. package/docs/examples/organizations/update-plan.md +2 -2
  50. package/docs/examples/projects/create-jwt.md +2 -2
  51. package/docs/examples/projects/create-key.md +2 -2
  52. package/docs/examples/projects/update-key.md +2 -2
  53. package/docs/examples/sites/list-templates.md +3 -3
  54. package/docs/examples/tablesdb/create-index.md +2 -2
  55. package/docs/examples/tablesdb/create-longtext-column.md +18 -0
  56. package/docs/examples/tablesdb/create-mediumtext-column.md +18 -0
  57. package/docs/examples/tablesdb/create-text-column.md +18 -0
  58. package/docs/examples/tablesdb/create-varchar-column.md +19 -0
  59. package/docs/examples/tablesdb/update-longtext-column.md +18 -0
  60. package/docs/examples/tablesdb/update-mediumtext-column.md +18 -0
  61. package/docs/examples/tablesdb/update-table.md +1 -1
  62. package/docs/examples/tablesdb/update-text-column.md +18 -0
  63. package/docs/examples/tablesdb/update-varchar-column.md +19 -0
  64. package/docs/examples/tablesdb/update.md +1 -1
  65. package/docs/examples/teams/create-membership.md +2 -2
  66. package/docs/examples/teams/update-membership.md +2 -2
  67. package/package.json +1 -1
  68. package/src/channel.ts +8 -4
  69. package/src/client.ts +3 -28
  70. package/src/enums/browser-permission.ts +22 -0
  71. package/src/enums/deployment-status.ts +1 -0
  72. package/src/enums/frameworks.ts +17 -0
  73. package/src/enums/order-by.ts +4 -0
  74. package/src/enums/resources.ts +13 -0
  75. package/src/enums/roles.ts +7 -0
  76. package/src/enums/runtimes.ts +66 -0
  77. package/src/enums/scopes.ts +65 -0
  78. package/src/enums/services.ts +5 -0
  79. package/src/enums/use-cases.ts +11 -0
  80. package/src/index.ts +9 -1
  81. package/src/models.ts +349 -1
  82. package/src/services/account.ts +364 -56
  83. package/src/services/assistant.ts +1 -1
  84. package/src/services/avatars.ts +17 -16
  85. package/src/services/backups.ts +37 -36
  86. package/src/services/console.ts +11 -42
  87. package/src/services/databases.ts +1060 -280
  88. package/src/services/domains.ts +44 -44
  89. package/src/services/functions.ts +60 -57
  90. package/src/services/graphql.ts +2 -2
  91. package/src/services/health.ts +22 -20
  92. package/src/services/messaging.ts +56 -56
  93. package/src/services/migrations.ts +79 -78
  94. package/src/services/organizations.ts +466 -70
  95. package/src/services/project.ts +5 -5
  96. package/src/services/projects.ts +86 -85
  97. package/src/services/proxy.ts +8 -8
  98. package/src/services/sites.ts +42 -40
  99. package/src/services/storage.ts +16 -16
  100. package/src/services/tables-db.ts +1050 -268
  101. package/src/services/teams.ts +31 -30
  102. package/src/services/tokens.ts +5 -5
  103. package/src/services/users.ts +49 -49
  104. package/src/services/vcs.ts +10 -10
  105. package/types/channel.d.ts +5 -4
  106. package/types/enums/browser-permission.d.ts +22 -0
  107. package/types/enums/deployment-status.d.ts +1 -0
  108. package/types/enums/frameworks.d.ts +17 -0
  109. package/types/enums/order-by.d.ts +4 -0
  110. package/types/enums/resources.d.ts +13 -0
  111. package/types/enums/roles.d.ts +7 -0
  112. package/types/enums/runtimes.d.ts +66 -0
  113. package/types/enums/scopes.d.ts +65 -0
  114. package/types/enums/services.d.ts +5 -0
  115. package/types/enums/use-cases.d.ts +11 -0
  116. package/types/index.d.ts +9 -1
  117. package/types/models.d.ts +341 -1
  118. package/types/services/account.d.ts +111 -0
  119. package/types/services/avatars.d.ts +5 -4
  120. package/types/services/backups.d.ts +13 -12
  121. package/types/services/console.d.ts +1 -13
  122. package/types/services/databases.d.ts +303 -8
  123. package/types/services/functions.d.ts +18 -15
  124. package/types/services/health.d.ts +2 -0
  125. package/types/services/migrations.d.ts +33 -32
  126. package/types/services/organizations.d.ts +161 -17
  127. package/types/services/projects.d.ts +13 -12
  128. package/types/services/sites.d.ts +9 -7
  129. package/types/services/tables-db.d.ts +305 -8
  130. package/types/services/teams.d.ts +9 -8
  131. package/src/enums/billing-plan.ts +0 -17
  132. package/types/enums/billing-plan.d.ts +0 -17
@@ -4,6 +4,7 @@ import { UsageRange } from '../enums/usage-range';
4
4
  import { RelationshipType } from '../enums/relationship-type';
5
5
  import { RelationMutate } from '../enums/relation-mutate';
6
6
  import { IndexType } from '../enums/index-type';
7
+ import { OrderBy } from '../enums/order-by';
7
8
  export declare class TablesDB {
8
9
  client: Client;
9
10
  constructor(client: Client);
@@ -231,7 +232,7 @@ export declare class TablesDB {
231
232
  */
232
233
  update(params: {
233
234
  databaseId: string;
234
- name: string;
235
+ name?: string;
235
236
  enabled?: boolean;
236
237
  }): Promise<Models.Database>;
237
238
  /**
@@ -244,7 +245,7 @@ export declare class TablesDB {
244
245
  * @returns {Promise<Models.Database>}
245
246
  * @deprecated Use the object parameter style method for a better developer experience.
246
247
  */
247
- update(databaseId: string, name: string, enabled?: boolean): Promise<Models.Database>;
248
+ update(databaseId: string, name?: string, enabled?: boolean): Promise<Models.Database>;
248
249
  /**
249
250
  * Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.
250
251
  *
@@ -369,7 +370,7 @@ export declare class TablesDB {
369
370
  updateTable(params: {
370
371
  databaseId: string;
371
372
  tableId: string;
372
- name: string;
373
+ name?: string;
373
374
  permissions?: string[];
374
375
  rowSecurity?: boolean;
375
376
  enabled?: boolean;
@@ -387,7 +388,7 @@ export declare class TablesDB {
387
388
  * @returns {Promise<Models.Table>}
388
389
  * @deprecated Use the object parameter style method for a better developer experience.
389
390
  */
390
- updateTable(databaseId: string, tableId: string, name: string, permissions?: string[], rowSecurity?: boolean, enabled?: boolean): Promise<Models.Table>;
391
+ updateTable(databaseId: string, tableId: string, name?: string, permissions?: string[], rowSecurity?: boolean, enabled?: boolean): Promise<Models.Table>;
391
392
  /**
392
393
  * Delete a table by its unique ID. Only users with write permissions have access to delete this resource.
393
394
  *
@@ -1029,6 +1030,150 @@ export declare class TablesDB {
1029
1030
  * @deprecated Use the object parameter style method for a better developer experience.
1030
1031
  */
1031
1032
  updateLineColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: any[], newKey?: string): Promise<Models.ColumnLine>;
1033
+ /**
1034
+ * Create a longtext column.
1035
+ *
1036
+ *
1037
+ * @param {string} params.databaseId - Database ID.
1038
+ * @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
1039
+ * @param {string} params.key - Column Key.
1040
+ * @param {boolean} params.required - Is column required?
1041
+ * @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
1042
+ * @param {boolean} params.array - Is column an array?
1043
+ * @throws {AppwriteException}
1044
+ * @returns {Promise<Models.ColumnLongtext>}
1045
+ */
1046
+ createLongtextColumn(params: {
1047
+ databaseId: string;
1048
+ tableId: string;
1049
+ key: string;
1050
+ required: boolean;
1051
+ xdefault?: string;
1052
+ array?: boolean;
1053
+ }): Promise<Models.ColumnLongtext>;
1054
+ /**
1055
+ * Create a longtext column.
1056
+ *
1057
+ *
1058
+ * @param {string} databaseId - Database ID.
1059
+ * @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
1060
+ * @param {string} key - Column Key.
1061
+ * @param {boolean} required - Is column required?
1062
+ * @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
1063
+ * @param {boolean} array - Is column an array?
1064
+ * @throws {AppwriteException}
1065
+ * @returns {Promise<Models.ColumnLongtext>}
1066
+ * @deprecated Use the object parameter style method for a better developer experience.
1067
+ */
1068
+ createLongtextColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.ColumnLongtext>;
1069
+ /**
1070
+ * Update a longtext column. Changing the `default` value will not update already existing rows.
1071
+ *
1072
+ *
1073
+ * @param {string} params.databaseId - Database ID.
1074
+ * @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
1075
+ * @param {string} params.key - Column Key.
1076
+ * @param {boolean} params.required - Is column required?
1077
+ * @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
1078
+ * @param {string} params.newKey - New Column Key.
1079
+ * @throws {AppwriteException}
1080
+ * @returns {Promise<Models.ColumnLongtext>}
1081
+ */
1082
+ updateLongtextColumn(params: {
1083
+ databaseId: string;
1084
+ tableId: string;
1085
+ key: string;
1086
+ required: boolean;
1087
+ xdefault?: string;
1088
+ newKey?: string;
1089
+ }): Promise<Models.ColumnLongtext>;
1090
+ /**
1091
+ * Update a longtext column. Changing the `default` value will not update already existing rows.
1092
+ *
1093
+ *
1094
+ * @param {string} databaseId - Database ID.
1095
+ * @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
1096
+ * @param {string} key - Column Key.
1097
+ * @param {boolean} required - Is column required?
1098
+ * @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
1099
+ * @param {string} newKey - New Column Key.
1100
+ * @throws {AppwriteException}
1101
+ * @returns {Promise<Models.ColumnLongtext>}
1102
+ * @deprecated Use the object parameter style method for a better developer experience.
1103
+ */
1104
+ updateLongtextColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.ColumnLongtext>;
1105
+ /**
1106
+ * Create a mediumtext column.
1107
+ *
1108
+ *
1109
+ * @param {string} params.databaseId - Database ID.
1110
+ * @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
1111
+ * @param {string} params.key - Column Key.
1112
+ * @param {boolean} params.required - Is column required?
1113
+ * @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
1114
+ * @param {boolean} params.array - Is column an array?
1115
+ * @throws {AppwriteException}
1116
+ * @returns {Promise<Models.ColumnMediumtext>}
1117
+ */
1118
+ createMediumtextColumn(params: {
1119
+ databaseId: string;
1120
+ tableId: string;
1121
+ key: string;
1122
+ required: boolean;
1123
+ xdefault?: string;
1124
+ array?: boolean;
1125
+ }): Promise<Models.ColumnMediumtext>;
1126
+ /**
1127
+ * Create a mediumtext column.
1128
+ *
1129
+ *
1130
+ * @param {string} databaseId - Database ID.
1131
+ * @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
1132
+ * @param {string} key - Column Key.
1133
+ * @param {boolean} required - Is column required?
1134
+ * @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
1135
+ * @param {boolean} array - Is column an array?
1136
+ * @throws {AppwriteException}
1137
+ * @returns {Promise<Models.ColumnMediumtext>}
1138
+ * @deprecated Use the object parameter style method for a better developer experience.
1139
+ */
1140
+ createMediumtextColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.ColumnMediumtext>;
1141
+ /**
1142
+ * Update a mediumtext column. Changing the `default` value will not update already existing rows.
1143
+ *
1144
+ *
1145
+ * @param {string} params.databaseId - Database ID.
1146
+ * @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
1147
+ * @param {string} params.key - Column Key.
1148
+ * @param {boolean} params.required - Is column required?
1149
+ * @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
1150
+ * @param {string} params.newKey - New Column Key.
1151
+ * @throws {AppwriteException}
1152
+ * @returns {Promise<Models.ColumnMediumtext>}
1153
+ */
1154
+ updateMediumtextColumn(params: {
1155
+ databaseId: string;
1156
+ tableId: string;
1157
+ key: string;
1158
+ required: boolean;
1159
+ xdefault?: string;
1160
+ newKey?: string;
1161
+ }): Promise<Models.ColumnMediumtext>;
1162
+ /**
1163
+ * Update a mediumtext column. Changing the `default` value will not update already existing rows.
1164
+ *
1165
+ *
1166
+ * @param {string} databaseId - Database ID.
1167
+ * @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
1168
+ * @param {string} key - Column Key.
1169
+ * @param {boolean} required - Is column required?
1170
+ * @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
1171
+ * @param {string} newKey - New Column Key.
1172
+ * @throws {AppwriteException}
1173
+ * @returns {Promise<Models.ColumnMediumtext>}
1174
+ * @deprecated Use the object parameter style method for a better developer experience.
1175
+ */
1176
+ updateMediumtextColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.ColumnMediumtext>;
1032
1177
  /**
1033
1178
  * Create a geometric point column.
1034
1179
  *
@@ -1215,6 +1360,7 @@ export declare class TablesDB {
1215
1360
  * @param {boolean} params.encrypt - Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.
1216
1361
  * @throws {AppwriteException}
1217
1362
  * @returns {Promise<Models.ColumnString>}
1363
+ * @deprecated This API has been deprecated since 1.9.0. Please use `TablesDB.createTextColumn` instead.
1218
1364
  */
1219
1365
  createStringColumn(params: {
1220
1366
  databaseId: string;
@@ -1256,6 +1402,7 @@ export declare class TablesDB {
1256
1402
  * @param {string} params.newKey - New Column Key.
1257
1403
  * @throws {AppwriteException}
1258
1404
  * @returns {Promise<Models.ColumnString>}
1405
+ * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.updateTextColumn` instead.
1259
1406
  */
1260
1407
  updateStringColumn(params: {
1261
1408
  databaseId: string;
@@ -1282,6 +1429,78 @@ export declare class TablesDB {
1282
1429
  * @deprecated Use the object parameter style method for a better developer experience.
1283
1430
  */
1284
1431
  updateStringColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, size?: number, newKey?: string): Promise<Models.ColumnString>;
1432
+ /**
1433
+ * Create a text column.
1434
+ *
1435
+ *
1436
+ * @param {string} params.databaseId - Database ID.
1437
+ * @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
1438
+ * @param {string} params.key - Column Key.
1439
+ * @param {boolean} params.required - Is column required?
1440
+ * @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
1441
+ * @param {boolean} params.array - Is column an array?
1442
+ * @throws {AppwriteException}
1443
+ * @returns {Promise<Models.ColumnText>}
1444
+ */
1445
+ createTextColumn(params: {
1446
+ databaseId: string;
1447
+ tableId: string;
1448
+ key: string;
1449
+ required: boolean;
1450
+ xdefault?: string;
1451
+ array?: boolean;
1452
+ }): Promise<Models.ColumnText>;
1453
+ /**
1454
+ * Create a text column.
1455
+ *
1456
+ *
1457
+ * @param {string} databaseId - Database ID.
1458
+ * @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
1459
+ * @param {string} key - Column Key.
1460
+ * @param {boolean} required - Is column required?
1461
+ * @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
1462
+ * @param {boolean} array - Is column an array?
1463
+ * @throws {AppwriteException}
1464
+ * @returns {Promise<Models.ColumnText>}
1465
+ * @deprecated Use the object parameter style method for a better developer experience.
1466
+ */
1467
+ createTextColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.ColumnText>;
1468
+ /**
1469
+ * Update a text column. Changing the `default` value will not update already existing rows.
1470
+ *
1471
+ *
1472
+ * @param {string} params.databaseId - Database ID.
1473
+ * @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
1474
+ * @param {string} params.key - Column Key.
1475
+ * @param {boolean} params.required - Is column required?
1476
+ * @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
1477
+ * @param {string} params.newKey - New Column Key.
1478
+ * @throws {AppwriteException}
1479
+ * @returns {Promise<Models.ColumnText>}
1480
+ */
1481
+ updateTextColumn(params: {
1482
+ databaseId: string;
1483
+ tableId: string;
1484
+ key: string;
1485
+ required: boolean;
1486
+ xdefault?: string;
1487
+ newKey?: string;
1488
+ }): Promise<Models.ColumnText>;
1489
+ /**
1490
+ * Update a text column. Changing the `default` value will not update already existing rows.
1491
+ *
1492
+ *
1493
+ * @param {string} databaseId - Database ID.
1494
+ * @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
1495
+ * @param {string} key - Column Key.
1496
+ * @param {boolean} required - Is column required?
1497
+ * @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
1498
+ * @param {string} newKey - New Column Key.
1499
+ * @throws {AppwriteException}
1500
+ * @returns {Promise<Models.ColumnText>}
1501
+ * @deprecated Use the object parameter style method for a better developer experience.
1502
+ */
1503
+ updateTextColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.ColumnText>;
1285
1504
  /**
1286
1505
  * Create a URL column.
1287
1506
  *
@@ -1354,6 +1573,84 @@ export declare class TablesDB {
1354
1573
  * @deprecated Use the object parameter style method for a better developer experience.
1355
1574
  */
1356
1575
  updateUrlColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.ColumnUrl>;
1576
+ /**
1577
+ * Create a varchar column.
1578
+ *
1579
+ *
1580
+ * @param {string} params.databaseId - Database ID.
1581
+ * @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
1582
+ * @param {string} params.key - Column Key.
1583
+ * @param {number} params.size - Column size for varchar columns, in number of characters. Maximum size is 16381.
1584
+ * @param {boolean} params.required - Is column required?
1585
+ * @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
1586
+ * @param {boolean} params.array - Is column an array?
1587
+ * @throws {AppwriteException}
1588
+ * @returns {Promise<Models.ColumnVarchar>}
1589
+ */
1590
+ createVarcharColumn(params: {
1591
+ databaseId: string;
1592
+ tableId: string;
1593
+ key: string;
1594
+ size: number;
1595
+ required: boolean;
1596
+ xdefault?: string;
1597
+ array?: boolean;
1598
+ }): Promise<Models.ColumnVarchar>;
1599
+ /**
1600
+ * Create a varchar column.
1601
+ *
1602
+ *
1603
+ * @param {string} databaseId - Database ID.
1604
+ * @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
1605
+ * @param {string} key - Column Key.
1606
+ * @param {number} size - Column size for varchar columns, in number of characters. Maximum size is 16381.
1607
+ * @param {boolean} required - Is column required?
1608
+ * @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
1609
+ * @param {boolean} array - Is column an array?
1610
+ * @throws {AppwriteException}
1611
+ * @returns {Promise<Models.ColumnVarchar>}
1612
+ * @deprecated Use the object parameter style method for a better developer experience.
1613
+ */
1614
+ createVarcharColumn(databaseId: string, tableId: string, key: string, size: number, required: boolean, xdefault?: string, array?: boolean): Promise<Models.ColumnVarchar>;
1615
+ /**
1616
+ * Update a varchar column. Changing the `default` value will not update already existing rows.
1617
+ *
1618
+ *
1619
+ * @param {string} params.databaseId - Database ID.
1620
+ * @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
1621
+ * @param {string} params.key - Column Key.
1622
+ * @param {boolean} params.required - Is column required?
1623
+ * @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
1624
+ * @param {number} params.size - Maximum size of the varchar column.
1625
+ * @param {string} params.newKey - New Column Key.
1626
+ * @throws {AppwriteException}
1627
+ * @returns {Promise<Models.ColumnVarchar>}
1628
+ */
1629
+ updateVarcharColumn(params: {
1630
+ databaseId: string;
1631
+ tableId: string;
1632
+ key: string;
1633
+ required: boolean;
1634
+ xdefault?: string;
1635
+ size?: number;
1636
+ newKey?: string;
1637
+ }): Promise<Models.ColumnVarchar>;
1638
+ /**
1639
+ * Update a varchar column. Changing the `default` value will not update already existing rows.
1640
+ *
1641
+ *
1642
+ * @param {string} databaseId - Database ID.
1643
+ * @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
1644
+ * @param {string} key - Column Key.
1645
+ * @param {boolean} required - Is column required?
1646
+ * @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
1647
+ * @param {number} size - Maximum size of the varchar column.
1648
+ * @param {string} newKey - New Column Key.
1649
+ * @throws {AppwriteException}
1650
+ * @returns {Promise<Models.ColumnVarchar>}
1651
+ * @deprecated Use the object parameter style method for a better developer experience.
1652
+ */
1653
+ updateVarcharColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, size?: number, newKey?: string): Promise<Models.ColumnVarchar>;
1357
1654
  /**
1358
1655
  * Get column by ID.
1359
1656
  *
@@ -1474,7 +1771,7 @@ export declare class TablesDB {
1474
1771
  * @param {string} params.key - Index Key.
1475
1772
  * @param {IndexType} params.type - Index type.
1476
1773
  * @param {string[]} params.columns - Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.
1477
- * @param {string[]} params.orders - Array of index orders. Maximum of 100 orders are allowed.
1774
+ * @param {OrderBy[]} params.orders - Array of index orders. Maximum of 100 orders are allowed.
1478
1775
  * @param {number[]} params.lengths - Length of index. Maximum of 100
1479
1776
  * @throws {AppwriteException}
1480
1777
  * @returns {Promise<Models.ColumnIndex>}
@@ -1485,7 +1782,7 @@ export declare class TablesDB {
1485
1782
  key: string;
1486
1783
  type: IndexType;
1487
1784
  columns: string[];
1488
- orders?: string[];
1785
+ orders?: OrderBy[];
1489
1786
  lengths?: number[];
1490
1787
  }): Promise<Models.ColumnIndex>;
1491
1788
  /**
@@ -1497,13 +1794,13 @@ export declare class TablesDB {
1497
1794
  * @param {string} key - Index Key.
1498
1795
  * @param {IndexType} type - Index type.
1499
1796
  * @param {string[]} columns - Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.
1500
- * @param {string[]} orders - Array of index orders. Maximum of 100 orders are allowed.
1797
+ * @param {OrderBy[]} orders - Array of index orders. Maximum of 100 orders are allowed.
1501
1798
  * @param {number[]} lengths - Length of index. Maximum of 100
1502
1799
  * @throws {AppwriteException}
1503
1800
  * @returns {Promise<Models.ColumnIndex>}
1504
1801
  * @deprecated Use the object parameter style method for a better developer experience.
1505
1802
  */
1506
- createIndex(databaseId: string, tableId: string, key: string, type: IndexType, columns: string[], orders?: string[], lengths?: number[]): Promise<Models.ColumnIndex>;
1803
+ createIndex(databaseId: string, tableId: string, key: string, type: IndexType, columns: string[], orders?: OrderBy[], lengths?: number[]): Promise<Models.ColumnIndex>;
1507
1804
  /**
1508
1805
  * Get index by ID.
1509
1806
  *
@@ -1,5 +1,6 @@
1
1
  import { Client } from '../client';
2
2
  import type { Models } from '../models';
3
+ import { Roles } from '../enums/roles';
3
4
  export declare class Teams {
4
5
  client: Client;
5
6
  constructor(client: Client);
@@ -177,7 +178,7 @@ export declare class Teams {
177
178
  *
178
179
  *
179
180
  * @param {string} params.teamId - Team ID.
180
- * @param {string[]} params.roles - Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
181
+ * @param {Roles[]} params.roles - Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
181
182
  * @param {string} params.email - Email of the new team member.
182
183
  * @param {string} params.userId - ID of the user to be added to a team.
183
184
  * @param {string} params.phone - Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
@@ -188,7 +189,7 @@ export declare class Teams {
188
189
  */
189
190
  createMembership(params: {
190
191
  teamId: string;
191
- roles: string[];
192
+ roles: Roles[];
192
193
  email?: string;
193
194
  userId?: string;
194
195
  phone?: string;
@@ -206,7 +207,7 @@ export declare class Teams {
206
207
  *
207
208
  *
208
209
  * @param {string} teamId - Team ID.
209
- * @param {string[]} roles - Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
210
+ * @param {Roles[]} roles - Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
210
211
  * @param {string} email - Email of the new team member.
211
212
  * @param {string} userId - ID of the user to be added to a team.
212
213
  * @param {string} phone - Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
@@ -216,7 +217,7 @@ export declare class Teams {
216
217
  * @returns {Promise<Models.Membership>}
217
218
  * @deprecated Use the object parameter style method for a better developer experience.
218
219
  */
219
- createMembership(teamId: string, roles: string[], email?: string, userId?: string, phone?: string, url?: string, name?: string): Promise<Models.Membership>;
220
+ createMembership(teamId: string, roles: Roles[], email?: string, userId?: string, phone?: string, url?: string, name?: string): Promise<Models.Membership>;
220
221
  /**
221
222
  * Get a team member by the membership unique id. All team members have read access for this resource. Hide sensitive attributes from the response by toggling membership privacy in the Console.
222
223
  *
@@ -245,14 +246,14 @@ export declare class Teams {
245
246
  *
246
247
  * @param {string} params.teamId - Team ID.
247
248
  * @param {string} params.membershipId - Membership ID.
248
- * @param {string[]} params.roles - An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
249
+ * @param {Roles[]} params.roles - An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
249
250
  * @throws {AppwriteException}
250
251
  * @returns {Promise<Models.Membership>}
251
252
  */
252
253
  updateMembership(params: {
253
254
  teamId: string;
254
255
  membershipId: string;
255
- roles: string[];
256
+ roles: Roles[];
256
257
  }): Promise<Models.Membership>;
257
258
  /**
258
259
  * Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](https://appwrite.io/docs/permissions).
@@ -260,12 +261,12 @@ export declare class Teams {
260
261
  *
261
262
  * @param {string} teamId - Team ID.
262
263
  * @param {string} membershipId - Membership ID.
263
- * @param {string[]} roles - An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
264
+ * @param {Roles[]} roles - An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
264
265
  * @throws {AppwriteException}
265
266
  * @returns {Promise<Models.Membership>}
266
267
  * @deprecated Use the object parameter style method for a better developer experience.
267
268
  */
268
- updateMembership(teamId: string, membershipId: string, roles: string[]): Promise<Models.Membership>;
269
+ updateMembership(teamId: string, membershipId: string, roles: Roles[]): Promise<Models.Membership>;
269
270
  /**
270
271
  * This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.
271
272
  *
@@ -1,17 +0,0 @@
1
- export enum BillingPlan {
2
- Tier0 = 'tier-0',
3
- Tier1 = 'tier-1',
4
- Tier2 = 'tier-2',
5
- Imaginetier0 = 'imagine-tier-0',
6
- Imaginetier1 = 'imagine-tier-1',
7
- Imaginetier150 = 'imagine-tier-1-50',
8
- Imaginetier1100 = 'imagine-tier-1-100',
9
- Imaginetier1200 = 'imagine-tier-1-200',
10
- Imaginetier1290 = 'imagine-tier-1-290',
11
- Imaginetier1480 = 'imagine-tier-1-480',
12
- Imaginetier1700 = 'imagine-tier-1-700',
13
- Imaginetier1900 = 'imagine-tier-1-900',
14
- Imaginetier11100 = 'imagine-tier-1-1100',
15
- Imaginetier11650 = 'imagine-tier-1-1650',
16
- Imaginetier12200 = 'imagine-tier-1-2200',
17
- }
@@ -1,17 +0,0 @@
1
- export declare enum BillingPlan {
2
- Tier0 = "tier-0",
3
- Tier1 = "tier-1",
4
- Tier2 = "tier-2",
5
- Imaginetier0 = "imagine-tier-0",
6
- Imaginetier1 = "imagine-tier-1",
7
- Imaginetier150 = "imagine-tier-1-50",
8
- Imaginetier1100 = "imagine-tier-1-100",
9
- Imaginetier1200 = "imagine-tier-1-200",
10
- Imaginetier1290 = "imagine-tier-1-290",
11
- Imaginetier1480 = "imagine-tier-1-480",
12
- Imaginetier1700 = "imagine-tier-1-700",
13
- Imaginetier1900 = "imagine-tier-1-900",
14
- Imaginetier11100 = "imagine-tier-1-1100",
15
- Imaginetier11650 = "imagine-tier-1-1650",
16
- Imaginetier12200 = "imagine-tier-1-2200"
17
- }