appbuild-oceanbase-console 1.12.2 → 1.13.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.
- package/dist/cjs/package.json +3 -0
- package/dist/cjs/sdk.js +3837 -1017
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/package.json +3 -0
- package/dist/esm/sdk.js +3831 -1018
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +10131 -3554
- package/package.json +7 -2
- package/types/channel.d.ts +74 -0
- package/types/client.d.ts +84 -16
- package/types/enums/appwrite-migration-resource.d.ts +25 -0
- package/types/enums/backup-services.d.ts +5 -0
- package/types/enums/billing-plan-group.d.ts +5 -0
- package/types/enums/browser-permission.d.ts +22 -0
- package/types/enums/domain-purchase-status.d.ts +6 -0
- package/types/enums/domain-transfer-status-enum.d.ts +10 -0
- package/types/enums/filter-type.d.ts +4 -0
- package/types/enums/firebase-migration-resource.d.ts +12 -0
- package/types/enums/frameworks.d.ts +17 -0
- package/types/enums/n-host-migration-resource.d.ts +13 -0
- package/types/enums/order-by.d.ts +4 -0
- package/types/enums/registration-type.d.ts +6 -0
- package/types/enums/resource-type.d.ts +6 -0
- package/types/enums/runtimes.d.ts +180 -0
- package/types/enums/scopes.d.ts +70 -0
- package/types/enums/supabase-migration-resource.d.ts +13 -0
- package/types/enums/template-reference-type.d.ts +5 -0
- package/types/enums/use-cases.d.ts +11 -0
- package/types/enums/vcs-reference-type.d.ts +5 -0
- package/types/index.d.ts +119 -96
- package/types/migrations.d.ts +10 -9
- package/types/models.d.ts +1270 -136
- package/types/query.d.ts +60 -8
- package/types/services/account.d.ts +162 -39
- package/types/services/activities.d.ts +46 -0
- package/types/services/avatars.d.ts +9 -8
- package/types/services/backups.d.ts +13 -12
- package/types/services/console.d.ts +41 -3
- package/types/services/databases.d.ts +384 -68
- package/types/services/domains.d.ts +223 -0
- package/types/services/functions.d.ts +46 -31
- package/types/services/health.d.ts +49 -6
- package/types/services/messaging.d.ts +2 -2
- package/types/services/organizations.d.ts +203 -36
- package/types/services/projects.d.ts +151 -210
- package/types/services/realtime.d.ts +26 -10
- package/types/services/sites.d.ts +49 -29
- package/types/services/storage.d.ts +12 -12
- package/types/services/tables-db.d.ts +352 -34
- package/types/services/teams.d.ts +4 -4
- package/types/services/users.d.ts +26 -2
- package/types/services/vcs.d.ts +4 -1
- package/types/services/webhooks.d.ts +165 -0
|
@@ -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
|
|
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
|
|
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
|
*
|
|
@@ -301,6 +302,8 @@ export declare class TablesDB {
|
|
|
301
302
|
* @param {string[]} params.permissions - An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
302
303
|
* @param {boolean} params.rowSecurity - Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a row. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
303
304
|
* @param {boolean} params.enabled - Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.
|
|
305
|
+
* @param {object[]} params.columns - Array of column definitions to create. Each column should contain: key (string), type (string: string, integer, float, boolean, datetime, relationship), size (integer, required for string type), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.
|
|
306
|
+
* @param {object[]} params.indexes - Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of column keys), orders (array of ASC/DESC, optional), and lengths (array of integers, optional).
|
|
304
307
|
* @throws {AppwriteException}
|
|
305
308
|
* @returns {Promise<Models.Table>}
|
|
306
309
|
*/
|
|
@@ -311,6 +314,8 @@ export declare class TablesDB {
|
|
|
311
314
|
permissions?: string[];
|
|
312
315
|
rowSecurity?: boolean;
|
|
313
316
|
enabled?: boolean;
|
|
317
|
+
columns?: object[];
|
|
318
|
+
indexes?: object[];
|
|
314
319
|
}): Promise<Models.Table>;
|
|
315
320
|
/**
|
|
316
321
|
* Create a new Table. Before using this route, you should create a new database resource using either a [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable) API or directly from your database console.
|
|
@@ -321,11 +326,13 @@ export declare class TablesDB {
|
|
|
321
326
|
* @param {string[]} permissions - An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
322
327
|
* @param {boolean} rowSecurity - Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a row. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
323
328
|
* @param {boolean} enabled - Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.
|
|
329
|
+
* @param {object[]} columns - Array of column definitions to create. Each column should contain: key (string), type (string: string, integer, float, boolean, datetime, relationship), size (integer, required for string type), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.
|
|
330
|
+
* @param {object[]} indexes - Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of column keys), orders (array of ASC/DESC, optional), and lengths (array of integers, optional).
|
|
324
331
|
* @throws {AppwriteException}
|
|
325
332
|
* @returns {Promise<Models.Table>}
|
|
326
333
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
327
334
|
*/
|
|
328
|
-
createTable(databaseId: string, tableId: string, name: string, permissions?: string[], rowSecurity?: boolean, enabled?: boolean): Promise<Models.Table>;
|
|
335
|
+
createTable(databaseId: string, tableId: string, name: string, permissions?: string[], rowSecurity?: boolean, enabled?: boolean, columns?: object[], indexes?: object[]): Promise<Models.Table>;
|
|
329
336
|
/**
|
|
330
337
|
* Get a table by its unique ID. This endpoint response returns a JSON object with the table metadata.
|
|
331
338
|
*
|
|
@@ -363,7 +370,7 @@ export declare class TablesDB {
|
|
|
363
370
|
updateTable(params: {
|
|
364
371
|
databaseId: string;
|
|
365
372
|
tableId: string;
|
|
366
|
-
name
|
|
373
|
+
name?: string;
|
|
367
374
|
permissions?: string[];
|
|
368
375
|
rowSecurity?: boolean;
|
|
369
376
|
enabled?: boolean;
|
|
@@ -381,7 +388,7 @@ export declare class TablesDB {
|
|
|
381
388
|
* @returns {Promise<Models.Table>}
|
|
382
389
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
383
390
|
*/
|
|
384
|
-
updateTable(databaseId: string, tableId: string, name
|
|
391
|
+
updateTable(databaseId: string, tableId: string, name?: string, permissions?: string[], rowSecurity?: boolean, enabled?: boolean): Promise<Models.Table>;
|
|
385
392
|
/**
|
|
386
393
|
* Delete a table by its unique ID. Only users with write permissions have access to delete this resource.
|
|
387
394
|
*
|
|
@@ -810,9 +817,9 @@ export declare class TablesDB {
|
|
|
810
817
|
* @param {string} params.tableId - Table ID.
|
|
811
818
|
* @param {string} params.key - Column Key.
|
|
812
819
|
* @param {boolean} params.required - Is column required?
|
|
813
|
-
* @param {number} params.min - Minimum value
|
|
814
|
-
* @param {number} params.max - Maximum value
|
|
815
|
-
* @param {number} params.xdefault - Default value. Cannot be set when column is required.
|
|
820
|
+
* @param {number | bigint} params.min - Minimum value
|
|
821
|
+
* @param {number | bigint} params.max - Maximum value
|
|
822
|
+
* @param {number | bigint} params.xdefault - Default value. Cannot be set when column is required.
|
|
816
823
|
* @param {boolean} params.array - Is column an array?
|
|
817
824
|
* @throws {AppwriteException}
|
|
818
825
|
* @returns {Promise<Models.ColumnInteger>}
|
|
@@ -822,9 +829,9 @@ export declare class TablesDB {
|
|
|
822
829
|
tableId: string;
|
|
823
830
|
key: string;
|
|
824
831
|
required: boolean;
|
|
825
|
-
min?: number;
|
|
826
|
-
max?: number;
|
|
827
|
-
xdefault?: number;
|
|
832
|
+
min?: number | bigint;
|
|
833
|
+
max?: number | bigint;
|
|
834
|
+
xdefault?: number | bigint;
|
|
828
835
|
array?: boolean;
|
|
829
836
|
}): Promise<Models.ColumnInteger>;
|
|
830
837
|
/**
|
|
@@ -835,15 +842,15 @@ export declare class TablesDB {
|
|
|
835
842
|
* @param {string} tableId - Table ID.
|
|
836
843
|
* @param {string} key - Column Key.
|
|
837
844
|
* @param {boolean} required - Is column required?
|
|
838
|
-
* @param {number} min - Minimum value
|
|
839
|
-
* @param {number} max - Maximum value
|
|
840
|
-
* @param {number} xdefault - Default value. Cannot be set when column is required.
|
|
845
|
+
* @param {number | bigint} min - Minimum value
|
|
846
|
+
* @param {number | bigint} max - Maximum value
|
|
847
|
+
* @param {number | bigint} xdefault - Default value. Cannot be set when column is required.
|
|
841
848
|
* @param {boolean} array - Is column an array?
|
|
842
849
|
* @throws {AppwriteException}
|
|
843
850
|
* @returns {Promise<Models.ColumnInteger>}
|
|
844
851
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
845
852
|
*/
|
|
846
|
-
createIntegerColumn(databaseId: string, tableId: string, key: string, required: boolean, min?: number, max?: number, xdefault?: number, array?: boolean): Promise<Models.ColumnInteger>;
|
|
853
|
+
createIntegerColumn(databaseId: string, tableId: string, key: string, required: boolean, min?: number | bigint, max?: number | bigint, xdefault?: number | bigint, array?: boolean): Promise<Models.ColumnInteger>;
|
|
847
854
|
/**
|
|
848
855
|
* Update an integer column. Changing the `default` value will not update already existing rows.
|
|
849
856
|
*
|
|
@@ -852,9 +859,9 @@ export declare class TablesDB {
|
|
|
852
859
|
* @param {string} params.tableId - Table ID.
|
|
853
860
|
* @param {string} params.key - Column Key.
|
|
854
861
|
* @param {boolean} params.required - Is column required?
|
|
855
|
-
* @param {number} params.xdefault - Default value. Cannot be set when column is required.
|
|
856
|
-
* @param {number} params.min - Minimum value
|
|
857
|
-
* @param {number} params.max - Maximum value
|
|
862
|
+
* @param {number | bigint} params.xdefault - Default value. Cannot be set when column is required.
|
|
863
|
+
* @param {number | bigint} params.min - Minimum value
|
|
864
|
+
* @param {number | bigint} params.max - Maximum value
|
|
858
865
|
* @param {string} params.newKey - New Column Key.
|
|
859
866
|
* @throws {AppwriteException}
|
|
860
867
|
* @returns {Promise<Models.ColumnInteger>}
|
|
@@ -864,9 +871,9 @@ export declare class TablesDB {
|
|
|
864
871
|
tableId: string;
|
|
865
872
|
key: string;
|
|
866
873
|
required: boolean;
|
|
867
|
-
xdefault?: number;
|
|
868
|
-
min?: number;
|
|
869
|
-
max?: number;
|
|
874
|
+
xdefault?: number | bigint;
|
|
875
|
+
min?: number | bigint;
|
|
876
|
+
max?: number | bigint;
|
|
870
877
|
newKey?: string;
|
|
871
878
|
}): Promise<Models.ColumnInteger>;
|
|
872
879
|
/**
|
|
@@ -877,15 +884,15 @@ export declare class TablesDB {
|
|
|
877
884
|
* @param {string} tableId - Table ID.
|
|
878
885
|
* @param {string} key - Column Key.
|
|
879
886
|
* @param {boolean} required - Is column required?
|
|
880
|
-
* @param {number} xdefault - Default value. Cannot be set when column is required.
|
|
881
|
-
* @param {number} min - Minimum value
|
|
882
|
-
* @param {number} max - Maximum value
|
|
887
|
+
* @param {number | bigint} xdefault - Default value. Cannot be set when column is required.
|
|
888
|
+
* @param {number | bigint} min - Minimum value
|
|
889
|
+
* @param {number | bigint} max - Maximum value
|
|
883
890
|
* @param {string} newKey - New Column Key.
|
|
884
891
|
* @throws {AppwriteException}
|
|
885
892
|
* @returns {Promise<Models.ColumnInteger>}
|
|
886
893
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
887
894
|
*/
|
|
888
|
-
updateIntegerColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: number, min?: number, max?: number, newKey?: string): Promise<Models.ColumnInteger>;
|
|
895
|
+
updateIntegerColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: number | bigint, min?: number | bigint, max?: number | bigint, newKey?: string): Promise<Models.ColumnInteger>;
|
|
889
896
|
/**
|
|
890
897
|
* Create IP address column.
|
|
891
898
|
*
|
|
@@ -1023,6 +1030,156 @@ export declare class TablesDB {
|
|
|
1023
1030
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1024
1031
|
*/
|
|
1025
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
|
+
* @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.
|
|
1044
|
+
* @throws {AppwriteException}
|
|
1045
|
+
* @returns {Promise<Models.ColumnLongtext>}
|
|
1046
|
+
*/
|
|
1047
|
+
createLongtextColumn(params: {
|
|
1048
|
+
databaseId: string;
|
|
1049
|
+
tableId: string;
|
|
1050
|
+
key: string;
|
|
1051
|
+
required: boolean;
|
|
1052
|
+
xdefault?: string;
|
|
1053
|
+
array?: boolean;
|
|
1054
|
+
encrypt?: boolean;
|
|
1055
|
+
}): Promise<Models.ColumnLongtext>;
|
|
1056
|
+
/**
|
|
1057
|
+
* Create a longtext column.
|
|
1058
|
+
*
|
|
1059
|
+
*
|
|
1060
|
+
* @param {string} databaseId - Database ID.
|
|
1061
|
+
* @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).
|
|
1062
|
+
* @param {string} key - Column Key.
|
|
1063
|
+
* @param {boolean} required - Is column required?
|
|
1064
|
+
* @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
1065
|
+
* @param {boolean} array - Is column an array?
|
|
1066
|
+
* @param {boolean} 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.
|
|
1067
|
+
* @throws {AppwriteException}
|
|
1068
|
+
* @returns {Promise<Models.ColumnLongtext>}
|
|
1069
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1070
|
+
*/
|
|
1071
|
+
createLongtextColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, array?: boolean, encrypt?: boolean): Promise<Models.ColumnLongtext>;
|
|
1072
|
+
/**
|
|
1073
|
+
* Update a longtext column. Changing the `default` value will not update already existing rows.
|
|
1074
|
+
*
|
|
1075
|
+
*
|
|
1076
|
+
* @param {string} params.databaseId - Database ID.
|
|
1077
|
+
* @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).
|
|
1078
|
+
* @param {string} params.key - Column Key.
|
|
1079
|
+
* @param {boolean} params.required - Is column required?
|
|
1080
|
+
* @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
1081
|
+
* @param {string} params.newKey - New Column Key.
|
|
1082
|
+
* @throws {AppwriteException}
|
|
1083
|
+
* @returns {Promise<Models.ColumnLongtext>}
|
|
1084
|
+
*/
|
|
1085
|
+
updateLongtextColumn(params: {
|
|
1086
|
+
databaseId: string;
|
|
1087
|
+
tableId: string;
|
|
1088
|
+
key: string;
|
|
1089
|
+
required: boolean;
|
|
1090
|
+
xdefault?: string;
|
|
1091
|
+
newKey?: string;
|
|
1092
|
+
}): Promise<Models.ColumnLongtext>;
|
|
1093
|
+
/**
|
|
1094
|
+
* Update a longtext column. Changing the `default` value will not update already existing rows.
|
|
1095
|
+
*
|
|
1096
|
+
*
|
|
1097
|
+
* @param {string} databaseId - Database ID.
|
|
1098
|
+
* @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).
|
|
1099
|
+
* @param {string} key - Column Key.
|
|
1100
|
+
* @param {boolean} required - Is column required?
|
|
1101
|
+
* @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
1102
|
+
* @param {string} newKey - New Column Key.
|
|
1103
|
+
* @throws {AppwriteException}
|
|
1104
|
+
* @returns {Promise<Models.ColumnLongtext>}
|
|
1105
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1106
|
+
*/
|
|
1107
|
+
updateLongtextColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.ColumnLongtext>;
|
|
1108
|
+
/**
|
|
1109
|
+
* Create a mediumtext column.
|
|
1110
|
+
*
|
|
1111
|
+
*
|
|
1112
|
+
* @param {string} params.databaseId - Database ID.
|
|
1113
|
+
* @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).
|
|
1114
|
+
* @param {string} params.key - Column Key.
|
|
1115
|
+
* @param {boolean} params.required - Is column required?
|
|
1116
|
+
* @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
1117
|
+
* @param {boolean} params.array - Is column an array?
|
|
1118
|
+
* @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.
|
|
1119
|
+
* @throws {AppwriteException}
|
|
1120
|
+
* @returns {Promise<Models.ColumnMediumtext>}
|
|
1121
|
+
*/
|
|
1122
|
+
createMediumtextColumn(params: {
|
|
1123
|
+
databaseId: string;
|
|
1124
|
+
tableId: string;
|
|
1125
|
+
key: string;
|
|
1126
|
+
required: boolean;
|
|
1127
|
+
xdefault?: string;
|
|
1128
|
+
array?: boolean;
|
|
1129
|
+
encrypt?: boolean;
|
|
1130
|
+
}): Promise<Models.ColumnMediumtext>;
|
|
1131
|
+
/**
|
|
1132
|
+
* Create a mediumtext column.
|
|
1133
|
+
*
|
|
1134
|
+
*
|
|
1135
|
+
* @param {string} databaseId - Database ID.
|
|
1136
|
+
* @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).
|
|
1137
|
+
* @param {string} key - Column Key.
|
|
1138
|
+
* @param {boolean} required - Is column required?
|
|
1139
|
+
* @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
1140
|
+
* @param {boolean} array - Is column an array?
|
|
1141
|
+
* @param {boolean} 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.
|
|
1142
|
+
* @throws {AppwriteException}
|
|
1143
|
+
* @returns {Promise<Models.ColumnMediumtext>}
|
|
1144
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1145
|
+
*/
|
|
1146
|
+
createMediumtextColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, array?: boolean, encrypt?: boolean): Promise<Models.ColumnMediumtext>;
|
|
1147
|
+
/**
|
|
1148
|
+
* Update a mediumtext column. Changing the `default` value will not update already existing rows.
|
|
1149
|
+
*
|
|
1150
|
+
*
|
|
1151
|
+
* @param {string} params.databaseId - Database ID.
|
|
1152
|
+
* @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).
|
|
1153
|
+
* @param {string} params.key - Column Key.
|
|
1154
|
+
* @param {boolean} params.required - Is column required?
|
|
1155
|
+
* @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
1156
|
+
* @param {string} params.newKey - New Column Key.
|
|
1157
|
+
* @throws {AppwriteException}
|
|
1158
|
+
* @returns {Promise<Models.ColumnMediumtext>}
|
|
1159
|
+
*/
|
|
1160
|
+
updateMediumtextColumn(params: {
|
|
1161
|
+
databaseId: string;
|
|
1162
|
+
tableId: string;
|
|
1163
|
+
key: string;
|
|
1164
|
+
required: boolean;
|
|
1165
|
+
xdefault?: string;
|
|
1166
|
+
newKey?: string;
|
|
1167
|
+
}): Promise<Models.ColumnMediumtext>;
|
|
1168
|
+
/**
|
|
1169
|
+
* Update a mediumtext column. Changing the `default` value will not update already existing rows.
|
|
1170
|
+
*
|
|
1171
|
+
*
|
|
1172
|
+
* @param {string} databaseId - Database ID.
|
|
1173
|
+
* @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).
|
|
1174
|
+
* @param {string} key - Column Key.
|
|
1175
|
+
* @param {boolean} required - Is column required?
|
|
1176
|
+
* @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
1177
|
+
* @param {string} newKey - New Column Key.
|
|
1178
|
+
* @throws {AppwriteException}
|
|
1179
|
+
* @returns {Promise<Models.ColumnMediumtext>}
|
|
1180
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1181
|
+
*/
|
|
1182
|
+
updateMediumtextColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.ColumnMediumtext>;
|
|
1026
1183
|
/**
|
|
1027
1184
|
* Create a geometric point column.
|
|
1028
1185
|
*
|
|
@@ -1209,6 +1366,7 @@ export declare class TablesDB {
|
|
|
1209
1366
|
* @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.
|
|
1210
1367
|
* @throws {AppwriteException}
|
|
1211
1368
|
* @returns {Promise<Models.ColumnString>}
|
|
1369
|
+
* @deprecated This API has been deprecated since 1.9.0. Please use `TablesDB.createTextColumn` instead.
|
|
1212
1370
|
*/
|
|
1213
1371
|
createStringColumn(params: {
|
|
1214
1372
|
databaseId: string;
|
|
@@ -1250,6 +1408,7 @@ export declare class TablesDB {
|
|
|
1250
1408
|
* @param {string} params.newKey - New Column Key.
|
|
1251
1409
|
* @throws {AppwriteException}
|
|
1252
1410
|
* @returns {Promise<Models.ColumnString>}
|
|
1411
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.updateTextColumn` instead.
|
|
1253
1412
|
*/
|
|
1254
1413
|
updateStringColumn(params: {
|
|
1255
1414
|
databaseId: string;
|
|
@@ -1276,6 +1435,81 @@ export declare class TablesDB {
|
|
|
1276
1435
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1277
1436
|
*/
|
|
1278
1437
|
updateStringColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, size?: number, newKey?: string): Promise<Models.ColumnString>;
|
|
1438
|
+
/**
|
|
1439
|
+
* Create a text column.
|
|
1440
|
+
*
|
|
1441
|
+
*
|
|
1442
|
+
* @param {string} params.databaseId - Database ID.
|
|
1443
|
+
* @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).
|
|
1444
|
+
* @param {string} params.key - Column Key.
|
|
1445
|
+
* @param {boolean} params.required - Is column required?
|
|
1446
|
+
* @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
1447
|
+
* @param {boolean} params.array - Is column an array?
|
|
1448
|
+
* @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.
|
|
1449
|
+
* @throws {AppwriteException}
|
|
1450
|
+
* @returns {Promise<Models.ColumnText>}
|
|
1451
|
+
*/
|
|
1452
|
+
createTextColumn(params: {
|
|
1453
|
+
databaseId: string;
|
|
1454
|
+
tableId: string;
|
|
1455
|
+
key: string;
|
|
1456
|
+
required: boolean;
|
|
1457
|
+
xdefault?: string;
|
|
1458
|
+
array?: boolean;
|
|
1459
|
+
encrypt?: boolean;
|
|
1460
|
+
}): Promise<Models.ColumnText>;
|
|
1461
|
+
/**
|
|
1462
|
+
* Create a text column.
|
|
1463
|
+
*
|
|
1464
|
+
*
|
|
1465
|
+
* @param {string} databaseId - Database ID.
|
|
1466
|
+
* @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).
|
|
1467
|
+
* @param {string} key - Column Key.
|
|
1468
|
+
* @param {boolean} required - Is column required?
|
|
1469
|
+
* @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
1470
|
+
* @param {boolean} array - Is column an array?
|
|
1471
|
+
* @param {boolean} 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.
|
|
1472
|
+
* @throws {AppwriteException}
|
|
1473
|
+
* @returns {Promise<Models.ColumnText>}
|
|
1474
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1475
|
+
*/
|
|
1476
|
+
createTextColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, array?: boolean, encrypt?: boolean): Promise<Models.ColumnText>;
|
|
1477
|
+
/**
|
|
1478
|
+
* Update a text column. Changing the `default` value will not update already existing rows.
|
|
1479
|
+
*
|
|
1480
|
+
*
|
|
1481
|
+
* @param {string} params.databaseId - Database ID.
|
|
1482
|
+
* @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).
|
|
1483
|
+
* @param {string} params.key - Column Key.
|
|
1484
|
+
* @param {boolean} params.required - Is column required?
|
|
1485
|
+
* @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
1486
|
+
* @param {string} params.newKey - New Column Key.
|
|
1487
|
+
* @throws {AppwriteException}
|
|
1488
|
+
* @returns {Promise<Models.ColumnText>}
|
|
1489
|
+
*/
|
|
1490
|
+
updateTextColumn(params: {
|
|
1491
|
+
databaseId: string;
|
|
1492
|
+
tableId: string;
|
|
1493
|
+
key: string;
|
|
1494
|
+
required: boolean;
|
|
1495
|
+
xdefault?: string;
|
|
1496
|
+
newKey?: string;
|
|
1497
|
+
}): Promise<Models.ColumnText>;
|
|
1498
|
+
/**
|
|
1499
|
+
* Update a text column. Changing the `default` value will not update already existing rows.
|
|
1500
|
+
*
|
|
1501
|
+
*
|
|
1502
|
+
* @param {string} databaseId - Database ID.
|
|
1503
|
+
* @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).
|
|
1504
|
+
* @param {string} key - Column Key.
|
|
1505
|
+
* @param {boolean} required - Is column required?
|
|
1506
|
+
* @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
1507
|
+
* @param {string} newKey - New Column Key.
|
|
1508
|
+
* @throws {AppwriteException}
|
|
1509
|
+
* @returns {Promise<Models.ColumnText>}
|
|
1510
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1511
|
+
*/
|
|
1512
|
+
updateTextColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.ColumnText>;
|
|
1279
1513
|
/**
|
|
1280
1514
|
* Create a URL column.
|
|
1281
1515
|
*
|
|
@@ -1348,6 +1582,87 @@ export declare class TablesDB {
|
|
|
1348
1582
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1349
1583
|
*/
|
|
1350
1584
|
updateUrlColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.ColumnUrl>;
|
|
1585
|
+
/**
|
|
1586
|
+
* Create a varchar column.
|
|
1587
|
+
*
|
|
1588
|
+
*
|
|
1589
|
+
* @param {string} params.databaseId - Database ID.
|
|
1590
|
+
* @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).
|
|
1591
|
+
* @param {string} params.key - Column Key.
|
|
1592
|
+
* @param {number} params.size - Column size for varchar columns, in number of characters. Maximum size is 16381.
|
|
1593
|
+
* @param {boolean} params.required - Is column required?
|
|
1594
|
+
* @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
1595
|
+
* @param {boolean} params.array - Is column an array?
|
|
1596
|
+
* @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.
|
|
1597
|
+
* @throws {AppwriteException}
|
|
1598
|
+
* @returns {Promise<Models.ColumnVarchar>}
|
|
1599
|
+
*/
|
|
1600
|
+
createVarcharColumn(params: {
|
|
1601
|
+
databaseId: string;
|
|
1602
|
+
tableId: string;
|
|
1603
|
+
key: string;
|
|
1604
|
+
size: number;
|
|
1605
|
+
required: boolean;
|
|
1606
|
+
xdefault?: string;
|
|
1607
|
+
array?: boolean;
|
|
1608
|
+
encrypt?: boolean;
|
|
1609
|
+
}): Promise<Models.ColumnVarchar>;
|
|
1610
|
+
/**
|
|
1611
|
+
* Create a varchar column.
|
|
1612
|
+
*
|
|
1613
|
+
*
|
|
1614
|
+
* @param {string} databaseId - Database ID.
|
|
1615
|
+
* @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).
|
|
1616
|
+
* @param {string} key - Column Key.
|
|
1617
|
+
* @param {number} size - Column size for varchar columns, in number of characters. Maximum size is 16381.
|
|
1618
|
+
* @param {boolean} required - Is column required?
|
|
1619
|
+
* @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
1620
|
+
* @param {boolean} array - Is column an array?
|
|
1621
|
+
* @param {boolean} 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.
|
|
1622
|
+
* @throws {AppwriteException}
|
|
1623
|
+
* @returns {Promise<Models.ColumnVarchar>}
|
|
1624
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1625
|
+
*/
|
|
1626
|
+
createVarcharColumn(databaseId: string, tableId: string, key: string, size: number, required: boolean, xdefault?: string, array?: boolean, encrypt?: boolean): Promise<Models.ColumnVarchar>;
|
|
1627
|
+
/**
|
|
1628
|
+
* Update a varchar column. Changing the `default` value will not update already existing rows.
|
|
1629
|
+
*
|
|
1630
|
+
*
|
|
1631
|
+
* @param {string} params.databaseId - Database ID.
|
|
1632
|
+
* @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).
|
|
1633
|
+
* @param {string} params.key - Column Key.
|
|
1634
|
+
* @param {boolean} params.required - Is column required?
|
|
1635
|
+
* @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
1636
|
+
* @param {number} params.size - Maximum size of the varchar column.
|
|
1637
|
+
* @param {string} params.newKey - New Column Key.
|
|
1638
|
+
* @throws {AppwriteException}
|
|
1639
|
+
* @returns {Promise<Models.ColumnVarchar>}
|
|
1640
|
+
*/
|
|
1641
|
+
updateVarcharColumn(params: {
|
|
1642
|
+
databaseId: string;
|
|
1643
|
+
tableId: string;
|
|
1644
|
+
key: string;
|
|
1645
|
+
required: boolean;
|
|
1646
|
+
xdefault?: string;
|
|
1647
|
+
size?: number;
|
|
1648
|
+
newKey?: string;
|
|
1649
|
+
}): Promise<Models.ColumnVarchar>;
|
|
1650
|
+
/**
|
|
1651
|
+
* Update a varchar column. Changing the `default` value will not update already existing rows.
|
|
1652
|
+
*
|
|
1653
|
+
*
|
|
1654
|
+
* @param {string} databaseId - Database ID.
|
|
1655
|
+
* @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).
|
|
1656
|
+
* @param {string} key - Column Key.
|
|
1657
|
+
* @param {boolean} required - Is column required?
|
|
1658
|
+
* @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
1659
|
+
* @param {number} size - Maximum size of the varchar column.
|
|
1660
|
+
* @param {string} newKey - New Column Key.
|
|
1661
|
+
* @throws {AppwriteException}
|
|
1662
|
+
* @returns {Promise<Models.ColumnVarchar>}
|
|
1663
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1664
|
+
*/
|
|
1665
|
+
updateVarcharColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, size?: number, newKey?: string): Promise<Models.ColumnVarchar>;
|
|
1351
1666
|
/**
|
|
1352
1667
|
* Get column by ID.
|
|
1353
1668
|
*
|
|
@@ -1355,13 +1670,13 @@ export declare class TablesDB {
|
|
|
1355
1670
|
* @param {string} params.tableId - Table ID.
|
|
1356
1671
|
* @param {string} params.key - Column Key.
|
|
1357
1672
|
* @throws {AppwriteException}
|
|
1358
|
-
* @returns {Promise<
|
|
1673
|
+
* @returns {Promise<Models.ColumnBoolean | Models.ColumnInteger | Models.ColumnFloat | Models.ColumnEmail | Models.ColumnEnum | Models.ColumnUrl | Models.ColumnIp | Models.ColumnDatetime | Models.ColumnRelationship | Models.ColumnString>}
|
|
1359
1674
|
*/
|
|
1360
1675
|
getColumn(params: {
|
|
1361
1676
|
databaseId: string;
|
|
1362
1677
|
tableId: string;
|
|
1363
1678
|
key: string;
|
|
1364
|
-
}): Promise<
|
|
1679
|
+
}): Promise<Models.ColumnBoolean | Models.ColumnInteger | Models.ColumnFloat | Models.ColumnEmail | Models.ColumnEnum | Models.ColumnUrl | Models.ColumnIp | Models.ColumnDatetime | Models.ColumnRelationship | Models.ColumnString>;
|
|
1365
1680
|
/**
|
|
1366
1681
|
* Get column by ID.
|
|
1367
1682
|
*
|
|
@@ -1369,10 +1684,10 @@ export declare class TablesDB {
|
|
|
1369
1684
|
* @param {string} tableId - Table ID.
|
|
1370
1685
|
* @param {string} key - Column Key.
|
|
1371
1686
|
* @throws {AppwriteException}
|
|
1372
|
-
* @returns {Promise<
|
|
1687
|
+
* @returns {Promise<Models.ColumnBoolean | Models.ColumnInteger | Models.ColumnFloat | Models.ColumnEmail | Models.ColumnEnum | Models.ColumnUrl | Models.ColumnIp | Models.ColumnDatetime | Models.ColumnRelationship | Models.ColumnString>}
|
|
1373
1688
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1374
1689
|
*/
|
|
1375
|
-
getColumn(databaseId: string, tableId: string, key: string): Promise<
|
|
1690
|
+
getColumn(databaseId: string, tableId: string, key: string): Promise<Models.ColumnBoolean | Models.ColumnInteger | Models.ColumnFloat | Models.ColumnEmail | Models.ColumnEnum | Models.ColumnUrl | Models.ColumnIp | Models.ColumnDatetime | Models.ColumnRelationship | Models.ColumnString>;
|
|
1376
1691
|
/**
|
|
1377
1692
|
* Deletes a column.
|
|
1378
1693
|
*
|
|
@@ -1468,7 +1783,7 @@ export declare class TablesDB {
|
|
|
1468
1783
|
* @param {string} params.key - Index Key.
|
|
1469
1784
|
* @param {IndexType} params.type - Index type.
|
|
1470
1785
|
* @param {string[]} params.columns - Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.
|
|
1471
|
-
* @param {
|
|
1786
|
+
* @param {OrderBy[]} params.orders - Array of index orders. Maximum of 100 orders are allowed.
|
|
1472
1787
|
* @param {number[]} params.lengths - Length of index. Maximum of 100
|
|
1473
1788
|
* @throws {AppwriteException}
|
|
1474
1789
|
* @returns {Promise<Models.ColumnIndex>}
|
|
@@ -1479,7 +1794,7 @@ export declare class TablesDB {
|
|
|
1479
1794
|
key: string;
|
|
1480
1795
|
type: IndexType;
|
|
1481
1796
|
columns: string[];
|
|
1482
|
-
orders?:
|
|
1797
|
+
orders?: OrderBy[];
|
|
1483
1798
|
lengths?: number[];
|
|
1484
1799
|
}): Promise<Models.ColumnIndex>;
|
|
1485
1800
|
/**
|
|
@@ -1491,13 +1806,13 @@ export declare class TablesDB {
|
|
|
1491
1806
|
* @param {string} key - Index Key.
|
|
1492
1807
|
* @param {IndexType} type - Index type.
|
|
1493
1808
|
* @param {string[]} columns - Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.
|
|
1494
|
-
* @param {
|
|
1809
|
+
* @param {OrderBy[]} orders - Array of index orders. Maximum of 100 orders are allowed.
|
|
1495
1810
|
* @param {number[]} lengths - Length of index. Maximum of 100
|
|
1496
1811
|
* @throws {AppwriteException}
|
|
1497
1812
|
* @returns {Promise<Models.ColumnIndex>}
|
|
1498
1813
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1499
1814
|
*/
|
|
1500
|
-
createIndex(databaseId: string, tableId: string, key: string, type: IndexType, columns: string[], orders?:
|
|
1815
|
+
createIndex(databaseId: string, tableId: string, key: string, type: IndexType, columns: string[], orders?: OrderBy[], lengths?: number[]): Promise<Models.ColumnIndex>;
|
|
1501
1816
|
/**
|
|
1502
1817
|
* Get index by ID.
|
|
1503
1818
|
*
|
|
@@ -1581,6 +1896,7 @@ export declare class TablesDB {
|
|
|
1581
1896
|
* @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.
|
|
1582
1897
|
* @param {string} params.transactionId - Transaction ID to read uncommitted changes within the transaction.
|
|
1583
1898
|
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1899
|
+
* @param {number} params.ttl - TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).
|
|
1584
1900
|
* @throws {AppwriteException}
|
|
1585
1901
|
* @returns {Promise<Models.RowList<Row>>}
|
|
1586
1902
|
*/
|
|
@@ -1590,6 +1906,7 @@ export declare class TablesDB {
|
|
|
1590
1906
|
queries?: string[];
|
|
1591
1907
|
transactionId?: string;
|
|
1592
1908
|
total?: boolean;
|
|
1909
|
+
ttl?: number;
|
|
1593
1910
|
}): Promise<Models.RowList<Row>>;
|
|
1594
1911
|
/**
|
|
1595
1912
|
* Get a list of all the user's rows in a given table. You can use the query params to filter your results.
|
|
@@ -1599,11 +1916,12 @@ export declare class TablesDB {
|
|
|
1599
1916
|
* @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.
|
|
1600
1917
|
* @param {string} transactionId - Transaction ID to read uncommitted changes within the transaction.
|
|
1601
1918
|
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1919
|
+
* @param {number} ttl - TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).
|
|
1602
1920
|
* @throws {AppwriteException}
|
|
1603
1921
|
* @returns {Promise<Models.RowList<Row>>}
|
|
1604
1922
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1605
1923
|
*/
|
|
1606
|
-
listRows<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, queries?: string[], transactionId?: string, total?: boolean): Promise<Models.RowList<Row>>;
|
|
1924
|
+
listRows<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, queries?: string[], transactionId?: string, total?: boolean, ttl?: number): Promise<Models.RowList<Row>>;
|
|
1607
1925
|
/**
|
|
1608
1926
|
* Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable) API or directly from your database console.
|
|
1609
1927
|
*
|
|
@@ -177,7 +177,7 @@ export declare class Teams {
|
|
|
177
177
|
*
|
|
178
178
|
*
|
|
179
179
|
* @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
|
|
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 81 characters long.
|
|
181
181
|
* @param {string} params.email - Email of the new team member.
|
|
182
182
|
* @param {string} params.userId - ID of the user to be added to a team.
|
|
183
183
|
* @param {string} params.phone - Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
@@ -206,7 +206,7 @@ export declare class Teams {
|
|
|
206
206
|
*
|
|
207
207
|
*
|
|
208
208
|
* @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
|
|
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 81 characters long.
|
|
210
210
|
* @param {string} email - Email of the new team member.
|
|
211
211
|
* @param {string} userId - ID of the user to be added to a team.
|
|
212
212
|
* @param {string} phone - Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
@@ -245,7 +245,7 @@ export declare class Teams {
|
|
|
245
245
|
*
|
|
246
246
|
* @param {string} params.teamId - Team ID.
|
|
247
247
|
* @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
|
|
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 81 characters long.
|
|
249
249
|
* @throws {AppwriteException}
|
|
250
250
|
* @returns {Promise<Models.Membership>}
|
|
251
251
|
*/
|
|
@@ -260,7 +260,7 @@ export declare class Teams {
|
|
|
260
260
|
*
|
|
261
261
|
* @param {string} teamId - Team ID.
|
|
262
262
|
* @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
|
|
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 81 characters long.
|
|
264
264
|
* @throws {AppwriteException}
|
|
265
265
|
* @returns {Promise<Models.Membership>}
|
|
266
266
|
* @deprecated Use the object parameter style method for a better developer experience.
|