node-appwrite 10.0.1 → 11.1.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/README.md +1 -1
- package/docs/examples/functions/create.md +1 -1
- package/docs/examples/functions/update.md +1 -1
- package/docs/examples/health/get-queue-builds.md +20 -0
- package/docs/examples/health/get-queue-databases.md +20 -0
- package/docs/examples/health/get-queue-deletes.md +20 -0
- package/docs/examples/health/get-queue-mails.md +20 -0
- package/docs/examples/health/get-queue-messaging.md +20 -0
- package/docs/examples/health/get-queue-migrations.md +20 -0
- package/docs/examples/teams/create-membership.md +1 -1
- package/index.d.ts +297 -214
- package/lib/client.js +7 -7
- package/lib/query.js +1 -1
- package/lib/services/account.js +35 -31
- package/lib/services/avatars.js +11 -10
- package/lib/services/databases.js +48 -48
- package/lib/services/functions.js +26 -26
- package/lib/services/graphql.js +2 -2
- package/lib/services/health.js +177 -14
- package/lib/services/locale.js +7 -7
- package/lib/services/storage.js +12 -12
- package/lib/services/teams.js +19 -23
- package/lib/services/users.js +44 -42
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -341,7 +341,7 @@ declare module "node-appwrite" {
|
|
|
341
341
|
*/
|
|
342
342
|
$updatedAt: string;
|
|
343
343
|
/**
|
|
344
|
-
* Collection permissions. [Learn more about permissions](/docs/permissions).
|
|
344
|
+
* Collection permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
345
345
|
*/
|
|
346
346
|
$permissions: string[];
|
|
347
347
|
/**
|
|
@@ -357,7 +357,7 @@ declare module "node-appwrite" {
|
|
|
357
357
|
*/
|
|
358
358
|
enabled: boolean;
|
|
359
359
|
/**
|
|
360
|
-
* Whether document-level permissions are enabled. [Learn more about permissions](/docs/permissions).
|
|
360
|
+
* Whether document-level permissions are enabled. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
361
361
|
*/
|
|
362
362
|
documentSecurity: boolean;
|
|
363
363
|
/**
|
|
@@ -830,7 +830,7 @@ declare module "node-appwrite" {
|
|
|
830
830
|
*/
|
|
831
831
|
$updatedAt: string;
|
|
832
832
|
/**
|
|
833
|
-
* Document permissions. [Learn more about permissions](/docs/permissions).
|
|
833
|
+
* Document permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
834
834
|
*/
|
|
835
835
|
$permissions: string[];
|
|
836
836
|
}
|
|
@@ -1346,7 +1346,7 @@ declare module "node-appwrite" {
|
|
|
1346
1346
|
*/
|
|
1347
1347
|
$updatedAt: string;
|
|
1348
1348
|
/**
|
|
1349
|
-
* File permissions. [Learn more about permissions](/docs/permissions).
|
|
1349
|
+
* File permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
1350
1350
|
*/
|
|
1351
1351
|
$permissions: string[];
|
|
1352
1352
|
/**
|
|
@@ -1391,11 +1391,11 @@ declare module "node-appwrite" {
|
|
|
1391
1391
|
*/
|
|
1392
1392
|
$updatedAt: string;
|
|
1393
1393
|
/**
|
|
1394
|
-
* Bucket permissions. [Learn more about permissions](/docs/permissions).
|
|
1394
|
+
* Bucket permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
1395
1395
|
*/
|
|
1396
1396
|
$permissions: string[];
|
|
1397
1397
|
/**
|
|
1398
|
-
* Whether file-level security is enabled. [Learn more about permissions](/docs/permissions).
|
|
1398
|
+
* Whether file-level security is enabled. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
1399
1399
|
*/
|
|
1400
1400
|
fileSecurity: boolean;
|
|
1401
1401
|
/**
|
|
@@ -2152,13 +2152,14 @@ declare module "node-appwrite" {
|
|
|
2152
2152
|
static guests(): string;
|
|
2153
2153
|
static team(id: string, role?: string): string;
|
|
2154
2154
|
static member(id: string): string;
|
|
2155
|
+
static label(name: string): string;
|
|
2155
2156
|
}
|
|
2156
2157
|
|
|
2157
2158
|
export class Account extends Service {
|
|
2158
2159
|
constructor(client: Client);
|
|
2159
2160
|
|
|
2160
2161
|
/**
|
|
2161
|
-
* Get
|
|
2162
|
+
* Get account
|
|
2162
2163
|
*
|
|
2163
2164
|
* Get the currently logged in user.
|
|
2164
2165
|
*
|
|
@@ -2167,7 +2168,7 @@ declare module "node-appwrite" {
|
|
|
2167
2168
|
*/
|
|
2168
2169
|
get<Preferences extends Models.Preferences>(): Promise<Models.User<Preferences>>;
|
|
2169
2170
|
/**
|
|
2170
|
-
* Update
|
|
2171
|
+
* Update email
|
|
2171
2172
|
*
|
|
2172
2173
|
* Update currently logged in user account email address. After changing user
|
|
2173
2174
|
* address, the user confirmation status will get reset. A new confirmation
|
|
@@ -2205,7 +2206,7 @@ declare module "node-appwrite" {
|
|
|
2205
2206
|
*/
|
|
2206
2207
|
deleteIdentity(identityId: string): Promise<string>;
|
|
2207
2208
|
/**
|
|
2208
|
-
* List
|
|
2209
|
+
* List logs
|
|
2209
2210
|
*
|
|
2210
2211
|
* Get the list of latest security activity logs for the currently logged in
|
|
2211
2212
|
* user. Each log returns user IP address, location and date and time of log.
|
|
@@ -2216,7 +2217,7 @@ declare module "node-appwrite" {
|
|
|
2216
2217
|
*/
|
|
2217
2218
|
listLogs(queries?: string[]): Promise<Models.LogList>;
|
|
2218
2219
|
/**
|
|
2219
|
-
* Update
|
|
2220
|
+
* Update name
|
|
2220
2221
|
*
|
|
2221
2222
|
* Update currently logged in user account name.
|
|
2222
2223
|
*
|
|
@@ -2226,7 +2227,7 @@ declare module "node-appwrite" {
|
|
|
2226
2227
|
*/
|
|
2227
2228
|
updateName<Preferences extends Models.Preferences>(name: string): Promise<Models.User<Preferences>>;
|
|
2228
2229
|
/**
|
|
2229
|
-
* Update
|
|
2230
|
+
* Update password
|
|
2230
2231
|
*
|
|
2231
2232
|
* Update currently logged in user password. For validation, user is required
|
|
2232
2233
|
* to pass in the new password, and the old password. For users created with
|
|
@@ -2239,12 +2240,12 @@ declare module "node-appwrite" {
|
|
|
2239
2240
|
*/
|
|
2240
2241
|
updatePassword<Preferences extends Models.Preferences>(password: string, oldPassword?: string): Promise<Models.User<Preferences>>;
|
|
2241
2242
|
/**
|
|
2242
|
-
* Update
|
|
2243
|
+
* Update phone
|
|
2243
2244
|
*
|
|
2244
2245
|
* Update the currently logged in user's phone number. After updating the
|
|
2245
2246
|
* phone number, the phone verification status will be reset. A confirmation
|
|
2246
2247
|
* SMS is not sent automatically, however you can use the [POST
|
|
2247
|
-
* /account/verification/phone](/docs/client/account#
|
|
2248
|
+
* /account/verification/phone](https://appwrite.io/docs/references/cloud/client-web/account#createPhoneVerification)
|
|
2248
2249
|
* endpoint to send a confirmation SMS.
|
|
2249
2250
|
*
|
|
2250
2251
|
* @param {string} phone
|
|
@@ -2254,7 +2255,7 @@ declare module "node-appwrite" {
|
|
|
2254
2255
|
*/
|
|
2255
2256
|
updatePhone<Preferences extends Models.Preferences>(phone: string, password: string): Promise<Models.User<Preferences>>;
|
|
2256
2257
|
/**
|
|
2257
|
-
* Get
|
|
2258
|
+
* Get account preferences
|
|
2258
2259
|
*
|
|
2259
2260
|
* Get the preferences as a key-value object for the currently logged in user.
|
|
2260
2261
|
*
|
|
@@ -2263,7 +2264,7 @@ declare module "node-appwrite" {
|
|
|
2263
2264
|
*/
|
|
2264
2265
|
getPrefs<Preferences extends Models.Preferences>(): Promise<Preferences>;
|
|
2265
2266
|
/**
|
|
2266
|
-
* Update
|
|
2267
|
+
* Update preferences
|
|
2267
2268
|
*
|
|
2268
2269
|
* Update currently logged in user account preferences. The object you pass is
|
|
2269
2270
|
* stored as is, and replaces any previous value. The maximum allowed prefs
|
|
@@ -2275,16 +2276,16 @@ declare module "node-appwrite" {
|
|
|
2275
2276
|
*/
|
|
2276
2277
|
updatePrefs<Preferences extends Models.Preferences>(prefs: object): Promise<Models.User<Preferences>>;
|
|
2277
2278
|
/**
|
|
2278
|
-
* Create
|
|
2279
|
+
* Create password recovery
|
|
2279
2280
|
*
|
|
2280
2281
|
* Sends the user an email with a temporary secret key for password reset.
|
|
2281
2282
|
* When the user clicks the confirmation link he is redirected back to your
|
|
2282
2283
|
* app password reset URL with the secret key and email address values
|
|
2283
2284
|
* attached to the URL query string. Use the query string params to submit a
|
|
2284
2285
|
* request to the [PUT
|
|
2285
|
-
* /account/recovery](/docs/client/account#
|
|
2286
|
-
* complete the process. The verification link sent to the user's
|
|
2287
|
-
* address is valid for 1 hour.
|
|
2286
|
+
* /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#updateRecovery)
|
|
2287
|
+
* endpoint to complete the process. The verification link sent to the user's
|
|
2288
|
+
* email address is valid for 1 hour.
|
|
2288
2289
|
*
|
|
2289
2290
|
* @param {string} email
|
|
2290
2291
|
* @param {string} url
|
|
@@ -2293,12 +2294,13 @@ declare module "node-appwrite" {
|
|
|
2293
2294
|
*/
|
|
2294
2295
|
createRecovery(email: string, url: string): Promise<Models.Token>;
|
|
2295
2296
|
/**
|
|
2296
|
-
* Create
|
|
2297
|
+
* Create password recovery (confirmation)
|
|
2297
2298
|
*
|
|
2298
2299
|
* Use this endpoint to complete the user account password reset. Both the
|
|
2299
2300
|
* **userId** and **secret** arguments will be passed as query parameters to
|
|
2300
2301
|
* the redirect URL you have provided when sending your request to the [POST
|
|
2301
|
-
* /account/recovery](/docs/client/account#
|
|
2302
|
+
* /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#createRecovery)
|
|
2303
|
+
* endpoint.
|
|
2302
2304
|
*
|
|
2303
2305
|
* Please note that in order to avoid a [Redirect
|
|
2304
2306
|
* Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md)
|
|
@@ -2314,7 +2316,7 @@ declare module "node-appwrite" {
|
|
|
2314
2316
|
*/
|
|
2315
2317
|
updateRecovery(userId: string, secret: string, password: string, passwordAgain: string): Promise<Models.Token>;
|
|
2316
2318
|
/**
|
|
2317
|
-
* List
|
|
2319
|
+
* List sessions
|
|
2318
2320
|
*
|
|
2319
2321
|
* Get the list of active sessions across different devices for the currently
|
|
2320
2322
|
* logged in user.
|
|
@@ -2324,7 +2326,7 @@ declare module "node-appwrite" {
|
|
|
2324
2326
|
*/
|
|
2325
2327
|
listSessions(): Promise<Models.SessionList>;
|
|
2326
2328
|
/**
|
|
2327
|
-
* Delete
|
|
2329
|
+
* Delete sessions
|
|
2328
2330
|
*
|
|
2329
2331
|
* Delete all sessions from the user account and remove any sessions cookies
|
|
2330
2332
|
* from the end client.
|
|
@@ -2334,7 +2336,7 @@ declare module "node-appwrite" {
|
|
|
2334
2336
|
*/
|
|
2335
2337
|
deleteSessions(): Promise<string>;
|
|
2336
2338
|
/**
|
|
2337
|
-
* Get
|
|
2339
|
+
* Get session
|
|
2338
2340
|
*
|
|
2339
2341
|
* Use this endpoint to get a logged in user's session using a Session ID.
|
|
2340
2342
|
* Inputting 'current' will return the current session being used.
|
|
@@ -2345,7 +2347,7 @@ declare module "node-appwrite" {
|
|
|
2345
2347
|
*/
|
|
2346
2348
|
getSession(sessionId: string): Promise<Models.Session>;
|
|
2347
2349
|
/**
|
|
2348
|
-
* Update OAuth
|
|
2350
|
+
* Update OAuth session (refresh tokens)
|
|
2349
2351
|
*
|
|
2350
2352
|
* Access tokens have limited lifespan and expire to mitigate security risks.
|
|
2351
2353
|
* If session was created using an OAuth provider, this route can be used to
|
|
@@ -2357,12 +2359,13 @@ declare module "node-appwrite" {
|
|
|
2357
2359
|
*/
|
|
2358
2360
|
updateSession(sessionId: string): Promise<Models.Session>;
|
|
2359
2361
|
/**
|
|
2360
|
-
* Delete
|
|
2362
|
+
* Delete session
|
|
2361
2363
|
*
|
|
2362
2364
|
* Logout the user. Use 'current' as the session ID to logout on this device,
|
|
2363
2365
|
* use a session ID to logout on another device. If you're looking to logout
|
|
2364
2366
|
* the user on all devices, use [Delete
|
|
2365
|
-
* Sessions](/docs/client/account#
|
|
2367
|
+
* Sessions](https://appwrite.io/docs/references/cloud/client-web/account#deleteSessions)
|
|
2368
|
+
* instead.
|
|
2366
2369
|
*
|
|
2367
2370
|
* @param {string} sessionId
|
|
2368
2371
|
* @throws {AppwriteException}
|
|
@@ -2370,7 +2373,7 @@ declare module "node-appwrite" {
|
|
|
2370
2373
|
*/
|
|
2371
2374
|
deleteSession(sessionId: string): Promise<string>;
|
|
2372
2375
|
/**
|
|
2373
|
-
* Update
|
|
2376
|
+
* Update status
|
|
2374
2377
|
*
|
|
2375
2378
|
* Block the currently logged in user account. Behind the scene, the user
|
|
2376
2379
|
* record is not deleted but permanently blocked from any access. To
|
|
@@ -2381,7 +2384,7 @@ declare module "node-appwrite" {
|
|
|
2381
2384
|
*/
|
|
2382
2385
|
updateStatus<Preferences extends Models.Preferences>(): Promise<Models.User<Preferences>>;
|
|
2383
2386
|
/**
|
|
2384
|
-
* Create
|
|
2387
|
+
* Create email verification
|
|
2385
2388
|
*
|
|
2386
2389
|
* Use this endpoint to send a verification message to your user email address
|
|
2387
2390
|
* to confirm they are the valid owners of that address. Both the **userId**
|
|
@@ -2390,8 +2393,8 @@ declare module "node-appwrite" {
|
|
|
2390
2393
|
* should redirect the user back to your app and allow you to complete the
|
|
2391
2394
|
* verification process by verifying both the **userId** and **secret**
|
|
2392
2395
|
* parameters. Learn more about how to [complete the verification
|
|
2393
|
-
* process](/docs/client/account#
|
|
2394
|
-
* verification link sent to the user's email address is valid for 7 days.
|
|
2396
|
+
* process](https://appwrite.io/docs/references/cloud/client-web/account#updateVerification).
|
|
2397
|
+
* The verification link sent to the user's email address is valid for 7 days.
|
|
2395
2398
|
*
|
|
2396
2399
|
* Please note that in order to avoid a [Redirect
|
|
2397
2400
|
* Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md),
|
|
@@ -2405,7 +2408,7 @@ declare module "node-appwrite" {
|
|
|
2405
2408
|
*/
|
|
2406
2409
|
createVerification(url: string): Promise<Models.Token>;
|
|
2407
2410
|
/**
|
|
2408
|
-
* Create
|
|
2411
|
+
* Create email verification (confirmation)
|
|
2409
2412
|
*
|
|
2410
2413
|
* Use this endpoint to complete the user email verification process. Use both
|
|
2411
2414
|
* the **userId** and **secret** parameters that were attached to your app URL
|
|
@@ -2419,21 +2422,23 @@ declare module "node-appwrite" {
|
|
|
2419
2422
|
*/
|
|
2420
2423
|
updateVerification(userId: string, secret: string): Promise<Models.Token>;
|
|
2421
2424
|
/**
|
|
2422
|
-
* Create
|
|
2425
|
+
* Create phone verification
|
|
2423
2426
|
*
|
|
2424
2427
|
* Use this endpoint to send a verification SMS to the currently logged in
|
|
2425
2428
|
* user. This endpoint is meant for use after updating a user's phone number
|
|
2426
|
-
* using the
|
|
2429
|
+
* using the
|
|
2430
|
+
* [accountUpdatePhone](https://appwrite.io/docs/references/cloud/client-web/account#updatePhone)
|
|
2427
2431
|
* endpoint. Learn more about how to [complete the verification
|
|
2428
|
-
* process](/docs/client/account#
|
|
2429
|
-
* verification code sent to the user's phone number is valid for 15
|
|
2432
|
+
* process](https://appwrite.io/docs/references/cloud/client-web/account#updatePhoneVerification).
|
|
2433
|
+
* The verification code sent to the user's phone number is valid for 15
|
|
2434
|
+
* minutes.
|
|
2430
2435
|
*
|
|
2431
2436
|
* @throws {AppwriteException}
|
|
2432
2437
|
* @returns {Promise}
|
|
2433
2438
|
*/
|
|
2434
2439
|
createPhoneVerification(): Promise<Models.Token>;
|
|
2435
2440
|
/**
|
|
2436
|
-
* Create
|
|
2441
|
+
* Create phone verification (confirmation)
|
|
2437
2442
|
*
|
|
2438
2443
|
* Use this endpoint to complete the user phone verification process. Use the
|
|
2439
2444
|
* **userId** and **secret** that were sent to your user's phone number to
|
|
@@ -2451,12 +2456,13 @@ declare module "node-appwrite" {
|
|
|
2451
2456
|
constructor(client: Client);
|
|
2452
2457
|
|
|
2453
2458
|
/**
|
|
2454
|
-
* Get
|
|
2459
|
+
* Get browser icon
|
|
2455
2460
|
*
|
|
2456
2461
|
* You can use this endpoint to show different browser icons to your users.
|
|
2457
2462
|
* The code argument receives the browser code as it appears in your user [GET
|
|
2458
|
-
* /account/sessions](/docs/client/account#
|
|
2459
|
-
* width, height and quality arguments to change the output
|
|
2463
|
+
* /account/sessions](https://appwrite.io/docs/references/cloud/client-web/account#getSessions)
|
|
2464
|
+
* endpoint. Use width, height and quality arguments to change the output
|
|
2465
|
+
* settings.
|
|
2460
2466
|
*
|
|
2461
2467
|
* When one dimension is specified and the other is 0, the image is scaled
|
|
2462
2468
|
* with preserved aspect ratio. If both dimensions are 0, the API provides an
|
|
@@ -2472,7 +2478,7 @@ declare module "node-appwrite" {
|
|
|
2472
2478
|
*/
|
|
2473
2479
|
getBrowser(code: string, width?: number, height?: number, quality?: number): Promise<Buffer>;
|
|
2474
2480
|
/**
|
|
2475
|
-
* Get
|
|
2481
|
+
* Get credit card icon
|
|
2476
2482
|
*
|
|
2477
2483
|
* The credit card endpoint will return you the icon of the credit card
|
|
2478
2484
|
* provider you need. Use width, height and quality arguments to change the
|
|
@@ -2493,7 +2499,7 @@ declare module "node-appwrite" {
|
|
|
2493
2499
|
*/
|
|
2494
2500
|
getCreditCard(code: string, width?: number, height?: number, quality?: number): Promise<Buffer>;
|
|
2495
2501
|
/**
|
|
2496
|
-
* Get
|
|
2502
|
+
* Get favicon
|
|
2497
2503
|
*
|
|
2498
2504
|
* Use this endpoint to fetch the favorite icon (AKA favicon) of any remote
|
|
2499
2505
|
* website URL.
|
|
@@ -2505,12 +2511,12 @@ declare module "node-appwrite" {
|
|
|
2505
2511
|
*/
|
|
2506
2512
|
getFavicon(url: string): Promise<Buffer>;
|
|
2507
2513
|
/**
|
|
2508
|
-
* Get
|
|
2514
|
+
* Get country flag
|
|
2509
2515
|
*
|
|
2510
2516
|
* You can use this endpoint to show different country flags icons to your
|
|
2511
2517
|
* users. The code argument receives the 2 letter country code. Use width,
|
|
2512
2518
|
* height and quality arguments to change the output settings. Country codes
|
|
2513
|
-
* follow the [ISO 3166-1](
|
|
2519
|
+
* follow the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard.
|
|
2514
2520
|
*
|
|
2515
2521
|
* When one dimension is specified and the other is 0, the image is scaled
|
|
2516
2522
|
* with preserved aspect ratio. If both dimensions are 0, the API provides an
|
|
@@ -2527,7 +2533,7 @@ declare module "node-appwrite" {
|
|
|
2527
2533
|
*/
|
|
2528
2534
|
getFlag(code: string, width?: number, height?: number, quality?: number): Promise<Buffer>;
|
|
2529
2535
|
/**
|
|
2530
|
-
* Get
|
|
2536
|
+
* Get image from URL
|
|
2531
2537
|
*
|
|
2532
2538
|
* Use this endpoint to fetch a remote image URL and crop it to any image size
|
|
2533
2539
|
* you want. This endpoint is very useful if you need to crop and display
|
|
@@ -2548,7 +2554,7 @@ declare module "node-appwrite" {
|
|
|
2548
2554
|
*/
|
|
2549
2555
|
getImage(url: string, width?: number, height?: number): Promise<Buffer>;
|
|
2550
2556
|
/**
|
|
2551
|
-
* Get
|
|
2557
|
+
* Get user initials
|
|
2552
2558
|
*
|
|
2553
2559
|
* Use this endpoint to show your user initials avatar icon on your website or
|
|
2554
2560
|
* app. By default, this route will try to print your logged-in user name or
|
|
@@ -2576,7 +2582,7 @@ declare module "node-appwrite" {
|
|
|
2576
2582
|
*/
|
|
2577
2583
|
getInitials(name?: string, width?: number, height?: number, background?: string): Promise<Buffer>;
|
|
2578
2584
|
/**
|
|
2579
|
-
* Get QR
|
|
2585
|
+
* Get QR code
|
|
2580
2586
|
*
|
|
2581
2587
|
* Converts a given plain text to a QR code image. You can use the query
|
|
2582
2588
|
* parameters to change the size and style of the resulting image.
|
|
@@ -2595,7 +2601,7 @@ declare module "node-appwrite" {
|
|
|
2595
2601
|
constructor(client: Client);
|
|
2596
2602
|
|
|
2597
2603
|
/**
|
|
2598
|
-
* List
|
|
2604
|
+
* List databases
|
|
2599
2605
|
*
|
|
2600
2606
|
* Get a list of all databases from the current Appwrite project. You can use
|
|
2601
2607
|
* the search parameter to filter your results.
|
|
@@ -2607,7 +2613,7 @@ declare module "node-appwrite" {
|
|
|
2607
2613
|
*/
|
|
2608
2614
|
list(queries?: string[], search?: string): Promise<Models.DatabaseList>;
|
|
2609
2615
|
/**
|
|
2610
|
-
* Create
|
|
2616
|
+
* Create database
|
|
2611
2617
|
*
|
|
2612
2618
|
* Create a new Database.
|
|
2613
2619
|
*
|
|
@@ -2620,7 +2626,7 @@ declare module "node-appwrite" {
|
|
|
2620
2626
|
*/
|
|
2621
2627
|
create(databaseId: string, name: string, enabled?: boolean): Promise<Models.Database>;
|
|
2622
2628
|
/**
|
|
2623
|
-
* Get
|
|
2629
|
+
* Get database
|
|
2624
2630
|
*
|
|
2625
2631
|
* Get a database by its unique ID. This endpoint response returns a JSON
|
|
2626
2632
|
* object with the database metadata.
|
|
@@ -2631,7 +2637,7 @@ declare module "node-appwrite" {
|
|
|
2631
2637
|
*/
|
|
2632
2638
|
get(databaseId: string): Promise<Models.Database>;
|
|
2633
2639
|
/**
|
|
2634
|
-
* Update
|
|
2640
|
+
* Update database
|
|
2635
2641
|
*
|
|
2636
2642
|
* Update a database by its unique ID.
|
|
2637
2643
|
*
|
|
@@ -2643,7 +2649,7 @@ declare module "node-appwrite" {
|
|
|
2643
2649
|
*/
|
|
2644
2650
|
update(databaseId: string, name: string, enabled?: boolean): Promise<Models.Database>;
|
|
2645
2651
|
/**
|
|
2646
|
-
* Delete
|
|
2652
|
+
* Delete database
|
|
2647
2653
|
*
|
|
2648
2654
|
* Delete a database by its unique ID. Only API keys with with databases.write
|
|
2649
2655
|
* scope can delete a database.
|
|
@@ -2654,7 +2660,7 @@ declare module "node-appwrite" {
|
|
|
2654
2660
|
*/
|
|
2655
2661
|
delete(databaseId: string): Promise<string>;
|
|
2656
2662
|
/**
|
|
2657
|
-
* List
|
|
2663
|
+
* List collections
|
|
2658
2664
|
*
|
|
2659
2665
|
* Get a list of all collections that belong to the provided databaseId. You
|
|
2660
2666
|
* can use the search parameter to filter your results.
|
|
@@ -2667,12 +2673,12 @@ declare module "node-appwrite" {
|
|
|
2667
2673
|
*/
|
|
2668
2674
|
listCollections(databaseId: string, queries?: string[], search?: string): Promise<Models.CollectionList>;
|
|
2669
2675
|
/**
|
|
2670
|
-
* Create
|
|
2676
|
+
* Create collection
|
|
2671
2677
|
*
|
|
2672
2678
|
* Create a new Collection. Before using this route, you should create a new
|
|
2673
2679
|
* database resource using either a [server
|
|
2674
|
-
* integration](/docs/server/databases#databasesCreateCollection)
|
|
2675
|
-
* directly from your database console.
|
|
2680
|
+
* integration](https://appwrite.io/docs/server/databases#databasesCreateCollection)
|
|
2681
|
+
* API or directly from your database console.
|
|
2676
2682
|
*
|
|
2677
2683
|
* @param {string} databaseId
|
|
2678
2684
|
* @param {string} collectionId
|
|
@@ -2685,7 +2691,7 @@ declare module "node-appwrite" {
|
|
|
2685
2691
|
*/
|
|
2686
2692
|
createCollection(databaseId: string, collectionId: string, name: string, permissions?: string[], documentSecurity?: boolean, enabled?: boolean): Promise<Models.Collection>;
|
|
2687
2693
|
/**
|
|
2688
|
-
* Get
|
|
2694
|
+
* Get collection
|
|
2689
2695
|
*
|
|
2690
2696
|
* Get a collection by its unique ID. This endpoint response returns a JSON
|
|
2691
2697
|
* object with the collection metadata.
|
|
@@ -2697,7 +2703,7 @@ declare module "node-appwrite" {
|
|
|
2697
2703
|
*/
|
|
2698
2704
|
getCollection(databaseId: string, collectionId: string): Promise<Models.Collection>;
|
|
2699
2705
|
/**
|
|
2700
|
-
* Update
|
|
2706
|
+
* Update collection
|
|
2701
2707
|
*
|
|
2702
2708
|
* Update a collection by its unique ID.
|
|
2703
2709
|
*
|
|
@@ -2712,7 +2718,7 @@ declare module "node-appwrite" {
|
|
|
2712
2718
|
*/
|
|
2713
2719
|
updateCollection(databaseId: string, collectionId: string, name: string, permissions?: string[], documentSecurity?: boolean, enabled?: boolean): Promise<Models.Collection>;
|
|
2714
2720
|
/**
|
|
2715
|
-
* Delete
|
|
2721
|
+
* Delete collection
|
|
2716
2722
|
*
|
|
2717
2723
|
* Delete a collection by its unique ID. Only users with write permissions
|
|
2718
2724
|
* have access to delete this resource.
|
|
@@ -2724,7 +2730,7 @@ declare module "node-appwrite" {
|
|
|
2724
2730
|
*/
|
|
2725
2731
|
deleteCollection(databaseId: string, collectionId: string): Promise<string>;
|
|
2726
2732
|
/**
|
|
2727
|
-
* List
|
|
2733
|
+
* List attributes
|
|
2728
2734
|
*
|
|
2729
2735
|
* @param {string} databaseId
|
|
2730
2736
|
* @param {string} collectionId
|
|
@@ -2734,7 +2740,7 @@ declare module "node-appwrite" {
|
|
|
2734
2740
|
*/
|
|
2735
2741
|
listAttributes(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.AttributeList>;
|
|
2736
2742
|
/**
|
|
2737
|
-
* Create
|
|
2743
|
+
* Create boolean attribute
|
|
2738
2744
|
*
|
|
2739
2745
|
* Create a boolean attribute.
|
|
2740
2746
|
*
|
|
@@ -2750,7 +2756,7 @@ declare module "node-appwrite" {
|
|
|
2750
2756
|
*/
|
|
2751
2757
|
createBooleanAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: boolean, array?: boolean): Promise<Models.AttributeBoolean>;
|
|
2752
2758
|
/**
|
|
2753
|
-
* Update
|
|
2759
|
+
* Update boolean attribute
|
|
2754
2760
|
*
|
|
2755
2761
|
* @param {string} databaseId
|
|
2756
2762
|
* @param {string} collectionId
|
|
@@ -2762,7 +2768,7 @@ declare module "node-appwrite" {
|
|
|
2762
2768
|
*/
|
|
2763
2769
|
updateBooleanAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: boolean): Promise<Models.AttributeBoolean>;
|
|
2764
2770
|
/**
|
|
2765
|
-
* Create
|
|
2771
|
+
* Create datetime attribute
|
|
2766
2772
|
*
|
|
2767
2773
|
* @param {string} databaseId
|
|
2768
2774
|
* @param {string} collectionId
|
|
@@ -2775,7 +2781,7 @@ declare module "node-appwrite" {
|
|
|
2775
2781
|
*/
|
|
2776
2782
|
createDatetimeAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeDatetime>;
|
|
2777
2783
|
/**
|
|
2778
|
-
* Update
|
|
2784
|
+
* Update dateTime attribute
|
|
2779
2785
|
*
|
|
2780
2786
|
* @param {string} databaseId
|
|
2781
2787
|
* @param {string} collectionId
|
|
@@ -2787,7 +2793,7 @@ declare module "node-appwrite" {
|
|
|
2787
2793
|
*/
|
|
2788
2794
|
updateDatetimeAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeDatetime>;
|
|
2789
2795
|
/**
|
|
2790
|
-
* Create
|
|
2796
|
+
* Create email attribute
|
|
2791
2797
|
*
|
|
2792
2798
|
* Create an email attribute.
|
|
2793
2799
|
*
|
|
@@ -2803,7 +2809,7 @@ declare module "node-appwrite" {
|
|
|
2803
2809
|
*/
|
|
2804
2810
|
createEmailAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeEmail>;
|
|
2805
2811
|
/**
|
|
2806
|
-
* Update
|
|
2812
|
+
* Update email attribute
|
|
2807
2813
|
*
|
|
2808
2814
|
* Update an email attribute. Changing the `default` value will not update
|
|
2809
2815
|
* already existing documents.
|
|
@@ -2819,7 +2825,7 @@ declare module "node-appwrite" {
|
|
|
2819
2825
|
*/
|
|
2820
2826
|
updateEmailAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeEmail>;
|
|
2821
2827
|
/**
|
|
2822
|
-
* Create
|
|
2828
|
+
* Create enum attribute
|
|
2823
2829
|
*
|
|
2824
2830
|
* @param {string} databaseId
|
|
2825
2831
|
* @param {string} collectionId
|
|
@@ -2833,7 +2839,7 @@ declare module "node-appwrite" {
|
|
|
2833
2839
|
*/
|
|
2834
2840
|
createEnumAttribute(databaseId: string, collectionId: string, key: string, elements: string[], required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeEnum>;
|
|
2835
2841
|
/**
|
|
2836
|
-
* Update
|
|
2842
|
+
* Update enum attribute
|
|
2837
2843
|
*
|
|
2838
2844
|
* Update an enum attribute. Changing the `default` value will not update
|
|
2839
2845
|
* already existing documents.
|
|
@@ -2850,7 +2856,7 @@ declare module "node-appwrite" {
|
|
|
2850
2856
|
*/
|
|
2851
2857
|
updateEnumAttribute(databaseId: string, collectionId: string, key: string, elements: string[], required: boolean, xdefault?: string): Promise<Models.AttributeEnum>;
|
|
2852
2858
|
/**
|
|
2853
|
-
* Create
|
|
2859
|
+
* Create float attribute
|
|
2854
2860
|
*
|
|
2855
2861
|
* Create a float attribute. Optionally, minimum and maximum values can be
|
|
2856
2862
|
* provided.
|
|
@@ -2869,7 +2875,7 @@ declare module "node-appwrite" {
|
|
|
2869
2875
|
*/
|
|
2870
2876
|
createFloatAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min?: number, max?: number, xdefault?: number, array?: boolean): Promise<Models.AttributeFloat>;
|
|
2871
2877
|
/**
|
|
2872
|
-
* Update
|
|
2878
|
+
* Update float attribute
|
|
2873
2879
|
*
|
|
2874
2880
|
* Update a float attribute. Changing the `default` value will not update
|
|
2875
2881
|
* already existing documents.
|
|
@@ -2887,7 +2893,7 @@ declare module "node-appwrite" {
|
|
|
2887
2893
|
*/
|
|
2888
2894
|
updateFloatAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault?: number): Promise<Models.AttributeFloat>;
|
|
2889
2895
|
/**
|
|
2890
|
-
* Create
|
|
2896
|
+
* Create integer attribute
|
|
2891
2897
|
*
|
|
2892
2898
|
* Create an integer attribute. Optionally, minimum and maximum values can be
|
|
2893
2899
|
* provided.
|
|
@@ -2906,7 +2912,7 @@ declare module "node-appwrite" {
|
|
|
2906
2912
|
*/
|
|
2907
2913
|
createIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min?: number, max?: number, xdefault?: number, array?: boolean): Promise<Models.AttributeInteger>;
|
|
2908
2914
|
/**
|
|
2909
|
-
* Update
|
|
2915
|
+
* Update integer attribute
|
|
2910
2916
|
*
|
|
2911
2917
|
* Update an integer attribute. Changing the `default` value will not update
|
|
2912
2918
|
* already existing documents.
|
|
@@ -2924,7 +2930,7 @@ declare module "node-appwrite" {
|
|
|
2924
2930
|
*/
|
|
2925
2931
|
updateIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault?: number): Promise<Models.AttributeInteger>;
|
|
2926
2932
|
/**
|
|
2927
|
-
* Create IP
|
|
2933
|
+
* Create IP address attribute
|
|
2928
2934
|
*
|
|
2929
2935
|
* Create IP address attribute.
|
|
2930
2936
|
*
|
|
@@ -2940,7 +2946,7 @@ declare module "node-appwrite" {
|
|
|
2940
2946
|
*/
|
|
2941
2947
|
createIpAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeIp>;
|
|
2942
2948
|
/**
|
|
2943
|
-
* Update IP
|
|
2949
|
+
* Update IP address attribute
|
|
2944
2950
|
*
|
|
2945
2951
|
* Update an ip attribute. Changing the `default` value will not update
|
|
2946
2952
|
* already existing documents.
|
|
@@ -2956,10 +2962,10 @@ declare module "node-appwrite" {
|
|
|
2956
2962
|
*/
|
|
2957
2963
|
updateIpAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeIp>;
|
|
2958
2964
|
/**
|
|
2959
|
-
* Create
|
|
2965
|
+
* Create relationship attribute
|
|
2960
2966
|
*
|
|
2961
2967
|
* Create relationship attribute. [Learn more about relationship
|
|
2962
|
-
* attributes](/docs/databases-relationships#relationship-attributes).
|
|
2968
|
+
* attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
|
|
2963
2969
|
*
|
|
2964
2970
|
*
|
|
2965
2971
|
* @param {string} databaseId
|
|
@@ -2975,7 +2981,7 @@ declare module "node-appwrite" {
|
|
|
2975
2981
|
*/
|
|
2976
2982
|
createRelationshipAttribute(databaseId: string, collectionId: string, relatedCollectionId: string, type: string, twoWay?: boolean, key?: string, twoWayKey?: string, onDelete?: string): Promise<Models.AttributeRelationship>;
|
|
2977
2983
|
/**
|
|
2978
|
-
* Create
|
|
2984
|
+
* Create string attribute
|
|
2979
2985
|
*
|
|
2980
2986
|
* Create a string attribute.
|
|
2981
2987
|
*
|
|
@@ -2993,7 +2999,7 @@ declare module "node-appwrite" {
|
|
|
2993
2999
|
*/
|
|
2994
3000
|
createStringAttribute(databaseId: string, collectionId: string, key: string, size: number, required: boolean, xdefault?: string, array?: boolean, encrypt?: boolean): Promise<Models.AttributeString>;
|
|
2995
3001
|
/**
|
|
2996
|
-
* Update
|
|
3002
|
+
* Update string attribute
|
|
2997
3003
|
*
|
|
2998
3004
|
* Update a string attribute. Changing the `default` value will not update
|
|
2999
3005
|
* already existing documents.
|
|
@@ -3009,7 +3015,7 @@ declare module "node-appwrite" {
|
|
|
3009
3015
|
*/
|
|
3010
3016
|
updateStringAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeString>;
|
|
3011
3017
|
/**
|
|
3012
|
-
* Create URL
|
|
3018
|
+
* Create URL attribute
|
|
3013
3019
|
*
|
|
3014
3020
|
* Create a URL attribute.
|
|
3015
3021
|
*
|
|
@@ -3025,7 +3031,7 @@ declare module "node-appwrite" {
|
|
|
3025
3031
|
*/
|
|
3026
3032
|
createUrlAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeUrl>;
|
|
3027
3033
|
/**
|
|
3028
|
-
* Update URL
|
|
3034
|
+
* Update URL attribute
|
|
3029
3035
|
*
|
|
3030
3036
|
* Update an url attribute. Changing the `default` value will not update
|
|
3031
3037
|
* already existing documents.
|
|
@@ -3041,7 +3047,7 @@ declare module "node-appwrite" {
|
|
|
3041
3047
|
*/
|
|
3042
3048
|
updateUrlAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeUrl>;
|
|
3043
3049
|
/**
|
|
3044
|
-
* Get
|
|
3050
|
+
* Get attribute
|
|
3045
3051
|
*
|
|
3046
3052
|
* @param {string} databaseId
|
|
3047
3053
|
* @param {string} collectionId
|
|
@@ -3051,7 +3057,7 @@ declare module "node-appwrite" {
|
|
|
3051
3057
|
*/
|
|
3052
3058
|
getAttribute(databaseId: string, collectionId: string, key: string): Promise<any>;
|
|
3053
3059
|
/**
|
|
3054
|
-
* Delete
|
|
3060
|
+
* Delete attribute
|
|
3055
3061
|
*
|
|
3056
3062
|
* @param {string} databaseId
|
|
3057
3063
|
* @param {string} collectionId
|
|
@@ -3061,10 +3067,10 @@ declare module "node-appwrite" {
|
|
|
3061
3067
|
*/
|
|
3062
3068
|
deleteAttribute(databaseId: string, collectionId: string, key: string): Promise<string>;
|
|
3063
3069
|
/**
|
|
3064
|
-
* Update
|
|
3070
|
+
* Update relationship attribute
|
|
3065
3071
|
*
|
|
3066
3072
|
* Update relationship attribute. [Learn more about relationship
|
|
3067
|
-
* attributes](/docs/databases-relationships#relationship-attributes).
|
|
3073
|
+
* attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
|
|
3068
3074
|
*
|
|
3069
3075
|
*
|
|
3070
3076
|
* @param {string} databaseId
|
|
@@ -3076,7 +3082,7 @@ declare module "node-appwrite" {
|
|
|
3076
3082
|
*/
|
|
3077
3083
|
updateRelationshipAttribute(databaseId: string, collectionId: string, key: string, onDelete?: string): Promise<Models.AttributeRelationship>;
|
|
3078
3084
|
/**
|
|
3079
|
-
* List
|
|
3085
|
+
* List documents
|
|
3080
3086
|
*
|
|
3081
3087
|
* Get a list of all the user's documents in a given collection. You can use
|
|
3082
3088
|
* the query params to filter your results.
|
|
@@ -3089,12 +3095,12 @@ declare module "node-appwrite" {
|
|
|
3089
3095
|
*/
|
|
3090
3096
|
listDocuments<Document extends Models.Document>(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.DocumentList<Document>>;
|
|
3091
3097
|
/**
|
|
3092
|
-
* Create
|
|
3098
|
+
* Create document
|
|
3093
3099
|
*
|
|
3094
3100
|
* Create a new Document. Before using this route, you should create a new
|
|
3095
3101
|
* collection resource using either a [server
|
|
3096
|
-
* integration](/docs/server/databases#databasesCreateCollection)
|
|
3097
|
-
* directly from your database console.
|
|
3102
|
+
* integration](https://appwrite.io/docs/server/databases#databasesCreateCollection)
|
|
3103
|
+
* API or directly from your database console.
|
|
3098
3104
|
*
|
|
3099
3105
|
* @param {string} databaseId
|
|
3100
3106
|
* @param {string} collectionId
|
|
@@ -3106,7 +3112,7 @@ declare module "node-appwrite" {
|
|
|
3106
3112
|
*/
|
|
3107
3113
|
createDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, data: object, permissions?: string[]): Promise<Document>;
|
|
3108
3114
|
/**
|
|
3109
|
-
* Get
|
|
3115
|
+
* Get document
|
|
3110
3116
|
*
|
|
3111
3117
|
* Get a document by its unique ID. This endpoint response returns a JSON
|
|
3112
3118
|
* object with the document data.
|
|
@@ -3120,7 +3126,7 @@ declare module "node-appwrite" {
|
|
|
3120
3126
|
*/
|
|
3121
3127
|
getDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, queries?: string[]): Promise<Document>;
|
|
3122
3128
|
/**
|
|
3123
|
-
* Update
|
|
3129
|
+
* Update document
|
|
3124
3130
|
*
|
|
3125
3131
|
* Update a document by its unique ID. Using the patch method you can pass
|
|
3126
3132
|
* only specific fields that will get updated.
|
|
@@ -3135,7 +3141,7 @@ declare module "node-appwrite" {
|
|
|
3135
3141
|
*/
|
|
3136
3142
|
updateDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, data?: object, permissions?: string[]): Promise<Document>;
|
|
3137
3143
|
/**
|
|
3138
|
-
* Delete
|
|
3144
|
+
* Delete document
|
|
3139
3145
|
*
|
|
3140
3146
|
* Delete a document by its unique ID.
|
|
3141
3147
|
*
|
|
@@ -3147,7 +3153,7 @@ declare module "node-appwrite" {
|
|
|
3147
3153
|
*/
|
|
3148
3154
|
deleteDocument(databaseId: string, collectionId: string, documentId: string): Promise<string>;
|
|
3149
3155
|
/**
|
|
3150
|
-
* List
|
|
3156
|
+
* List indexes
|
|
3151
3157
|
*
|
|
3152
3158
|
* @param {string} databaseId
|
|
3153
3159
|
* @param {string} collectionId
|
|
@@ -3157,7 +3163,7 @@ declare module "node-appwrite" {
|
|
|
3157
3163
|
*/
|
|
3158
3164
|
listIndexes(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.IndexList>;
|
|
3159
3165
|
/**
|
|
3160
|
-
* Create
|
|
3166
|
+
* Create index
|
|
3161
3167
|
*
|
|
3162
3168
|
* @param {string} databaseId
|
|
3163
3169
|
* @param {string} collectionId
|
|
@@ -3170,7 +3176,7 @@ declare module "node-appwrite" {
|
|
|
3170
3176
|
*/
|
|
3171
3177
|
createIndex(databaseId: string, collectionId: string, key: string, type: string, attributes: string[], orders?: string[]): Promise<Models.Index>;
|
|
3172
3178
|
/**
|
|
3173
|
-
* Get
|
|
3179
|
+
* Get index
|
|
3174
3180
|
*
|
|
3175
3181
|
* @param {string} databaseId
|
|
3176
3182
|
* @param {string} collectionId
|
|
@@ -3180,7 +3186,7 @@ declare module "node-appwrite" {
|
|
|
3180
3186
|
*/
|
|
3181
3187
|
getIndex(databaseId: string, collectionId: string, key: string): Promise<Models.Index>;
|
|
3182
3188
|
/**
|
|
3183
|
-
* Delete
|
|
3189
|
+
* Delete index
|
|
3184
3190
|
*
|
|
3185
3191
|
* @param {string} databaseId
|
|
3186
3192
|
* @param {string} collectionId
|
|
@@ -3194,7 +3200,7 @@ declare module "node-appwrite" {
|
|
|
3194
3200
|
constructor(client: Client);
|
|
3195
3201
|
|
|
3196
3202
|
/**
|
|
3197
|
-
* List
|
|
3203
|
+
* List functions
|
|
3198
3204
|
*
|
|
3199
3205
|
* Get a list of all the project's functions. You can use the query params to
|
|
3200
3206
|
* filter your results.
|
|
@@ -3206,11 +3212,12 @@ declare module "node-appwrite" {
|
|
|
3206
3212
|
*/
|
|
3207
3213
|
list(queries?: string[], search?: string): Promise<Models.FunctionList>;
|
|
3208
3214
|
/**
|
|
3209
|
-
* Create
|
|
3215
|
+
* Create function
|
|
3210
3216
|
*
|
|
3211
3217
|
* Create a new function. You can pass a list of
|
|
3212
|
-
* [permissions](/docs/permissions) to allow different
|
|
3213
|
-
* with access to execute the function using the client
|
|
3218
|
+
* [permissions](https://appwrite.io/docs/permissions) to allow different
|
|
3219
|
+
* project users or team with access to execute the function using the client
|
|
3220
|
+
* API.
|
|
3214
3221
|
*
|
|
3215
3222
|
* @param {string} functionId
|
|
3216
3223
|
* @param {string} name
|
|
@@ -3246,7 +3253,7 @@ declare module "node-appwrite" {
|
|
|
3246
3253
|
*/
|
|
3247
3254
|
listRuntimes(): Promise<Models.RuntimeList>;
|
|
3248
3255
|
/**
|
|
3249
|
-
* Get
|
|
3256
|
+
* Get function
|
|
3250
3257
|
*
|
|
3251
3258
|
* Get a function by its unique ID.
|
|
3252
3259
|
*
|
|
@@ -3256,7 +3263,7 @@ declare module "node-appwrite" {
|
|
|
3256
3263
|
*/
|
|
3257
3264
|
get(functionId: string): Promise<Models.Function>;
|
|
3258
3265
|
/**
|
|
3259
|
-
* Update
|
|
3266
|
+
* Update function
|
|
3260
3267
|
*
|
|
3261
3268
|
* Update function by its unique ID.
|
|
3262
3269
|
*
|
|
@@ -3279,9 +3286,9 @@ declare module "node-appwrite" {
|
|
|
3279
3286
|
* @throws {AppwriteException}
|
|
3280
3287
|
* @returns {Promise}
|
|
3281
3288
|
*/
|
|
3282
|
-
update(functionId: string, name: string, runtime
|
|
3289
|
+
update(functionId: string, name: string, runtime?: string, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string): Promise<Models.Function>;
|
|
3283
3290
|
/**
|
|
3284
|
-
* Delete
|
|
3291
|
+
* Delete function
|
|
3285
3292
|
*
|
|
3286
3293
|
* Delete a function by its unique ID.
|
|
3287
3294
|
*
|
|
@@ -3291,7 +3298,7 @@ declare module "node-appwrite" {
|
|
|
3291
3298
|
*/
|
|
3292
3299
|
delete(functionId: string): Promise<string>;
|
|
3293
3300
|
/**
|
|
3294
|
-
* List
|
|
3301
|
+
* List deployments
|
|
3295
3302
|
*
|
|
3296
3303
|
* Get a list of all the project's code deployments. You can use the query
|
|
3297
3304
|
* params to filter your results.
|
|
@@ -3304,7 +3311,7 @@ declare module "node-appwrite" {
|
|
|
3304
3311
|
*/
|
|
3305
3312
|
listDeployments(functionId: string, queries?: string[], search?: string): Promise<Models.DeploymentList>;
|
|
3306
3313
|
/**
|
|
3307
|
-
* Create
|
|
3314
|
+
* Create deployment
|
|
3308
3315
|
*
|
|
3309
3316
|
* Create a new function code deployment. Use this endpoint to upload a new
|
|
3310
3317
|
* version of your code function. To execute your newly uploaded code, you'll
|
|
@@ -3313,7 +3320,7 @@ declare module "node-appwrite" {
|
|
|
3313
3320
|
* This endpoint accepts a tar.gz file compressed with your code. Make sure to
|
|
3314
3321
|
* include any dependencies your code has within the compressed file. You can
|
|
3315
3322
|
* learn more about code packaging in the [Appwrite Cloud Functions
|
|
3316
|
-
* tutorial](/docs/functions).
|
|
3323
|
+
* tutorial](https://appwrite.io/docs/functions).
|
|
3317
3324
|
*
|
|
3318
3325
|
* Use the "command" param to set the entrypoint used to execute your code.
|
|
3319
3326
|
*
|
|
@@ -3327,7 +3334,7 @@ declare module "node-appwrite" {
|
|
|
3327
3334
|
*/
|
|
3328
3335
|
createDeployment(functionId: string, code: InputFile, activate: boolean, entrypoint?: string, commands?: string): Promise<Models.Deployment>;
|
|
3329
3336
|
/**
|
|
3330
|
-
* Get
|
|
3337
|
+
* Get deployment
|
|
3331
3338
|
*
|
|
3332
3339
|
* Get a code deployment by its unique ID.
|
|
3333
3340
|
*
|
|
@@ -3338,7 +3345,7 @@ declare module "node-appwrite" {
|
|
|
3338
3345
|
*/
|
|
3339
3346
|
getDeployment(functionId: string, deploymentId: string): Promise<Models.Deployment>;
|
|
3340
3347
|
/**
|
|
3341
|
-
* Update
|
|
3348
|
+
* Update function deployment
|
|
3342
3349
|
*
|
|
3343
3350
|
* Update the function code deployment ID using the unique function ID. Use
|
|
3344
3351
|
* this endpoint to switch the code deployment that should be executed by the
|
|
@@ -3351,7 +3358,7 @@ declare module "node-appwrite" {
|
|
|
3351
3358
|
*/
|
|
3352
3359
|
updateDeployment(functionId: string, deploymentId: string): Promise<Models.Function>;
|
|
3353
3360
|
/**
|
|
3354
|
-
* Delete
|
|
3361
|
+
* Delete deployment
|
|
3355
3362
|
*
|
|
3356
3363
|
* Delete a code deployment by its unique ID.
|
|
3357
3364
|
*
|
|
@@ -3362,7 +3369,7 @@ declare module "node-appwrite" {
|
|
|
3362
3369
|
*/
|
|
3363
3370
|
deleteDeployment(functionId: string, deploymentId: string): Promise<string>;
|
|
3364
3371
|
/**
|
|
3365
|
-
* Create
|
|
3372
|
+
* Create build
|
|
3366
3373
|
*
|
|
3367
3374
|
* Create a new build for an Appwrite Function deployment. This endpoint can
|
|
3368
3375
|
* be used to retry a failed build.
|
|
@@ -3377,6 +3384,9 @@ declare module "node-appwrite" {
|
|
|
3377
3384
|
/**
|
|
3378
3385
|
* Download Deployment
|
|
3379
3386
|
*
|
|
3387
|
+
* Get a Deployment's contents by its unique ID. This endpoint supports range
|
|
3388
|
+
* requests for partial or streaming file download.
|
|
3389
|
+
*
|
|
3380
3390
|
* @param {string} functionId
|
|
3381
3391
|
* @param {string} deploymentId
|
|
3382
3392
|
* @throws {AppwriteException}
|
|
@@ -3384,7 +3394,7 @@ declare module "node-appwrite" {
|
|
|
3384
3394
|
*/
|
|
3385
3395
|
downloadDeployment(functionId: string, deploymentId: string): Promise<Buffer>;
|
|
3386
3396
|
/**
|
|
3387
|
-
* List
|
|
3397
|
+
* List executions
|
|
3388
3398
|
*
|
|
3389
3399
|
* Get a list of all the current user function execution logs. You can use the
|
|
3390
3400
|
* query params to filter your results.
|
|
@@ -3397,7 +3407,7 @@ declare module "node-appwrite" {
|
|
|
3397
3407
|
*/
|
|
3398
3408
|
listExecutions(functionId: string, queries?: string[], search?: string): Promise<Models.ExecutionList>;
|
|
3399
3409
|
/**
|
|
3400
|
-
* Create
|
|
3410
|
+
* Create execution
|
|
3401
3411
|
*
|
|
3402
3412
|
* Trigger a function execution. The returned object will return you the
|
|
3403
3413
|
* current execution status. You can ping the `Get Execution` endpoint to get
|
|
@@ -3415,7 +3425,7 @@ declare module "node-appwrite" {
|
|
|
3415
3425
|
*/
|
|
3416
3426
|
createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: string, headers?: object): Promise<Models.Execution>;
|
|
3417
3427
|
/**
|
|
3418
|
-
* Get
|
|
3428
|
+
* Get execution
|
|
3419
3429
|
*
|
|
3420
3430
|
* Get a function execution log by its unique ID.
|
|
3421
3431
|
*
|
|
@@ -3426,7 +3436,7 @@ declare module "node-appwrite" {
|
|
|
3426
3436
|
*/
|
|
3427
3437
|
getExecution(functionId: string, executionId: string): Promise<Models.Execution>;
|
|
3428
3438
|
/**
|
|
3429
|
-
* List
|
|
3439
|
+
* List variables
|
|
3430
3440
|
*
|
|
3431
3441
|
* Get a list of all variables of a specific function.
|
|
3432
3442
|
*
|
|
@@ -3436,7 +3446,7 @@ declare module "node-appwrite" {
|
|
|
3436
3446
|
*/
|
|
3437
3447
|
listVariables(functionId: string): Promise<Models.VariableList>;
|
|
3438
3448
|
/**
|
|
3439
|
-
* Create
|
|
3449
|
+
* Create variable
|
|
3440
3450
|
*
|
|
3441
3451
|
* Create a new function environment variable. These variables can be accessed
|
|
3442
3452
|
* in the function at runtime as environment variables.
|
|
@@ -3449,7 +3459,7 @@ declare module "node-appwrite" {
|
|
|
3449
3459
|
*/
|
|
3450
3460
|
createVariable(functionId: string, key: string, value: string): Promise<Models.Variable>;
|
|
3451
3461
|
/**
|
|
3452
|
-
* Get
|
|
3462
|
+
* Get variable
|
|
3453
3463
|
*
|
|
3454
3464
|
* Get a variable by its unique ID.
|
|
3455
3465
|
*
|
|
@@ -3460,7 +3470,7 @@ declare module "node-appwrite" {
|
|
|
3460
3470
|
*/
|
|
3461
3471
|
getVariable(functionId: string, variableId: string): Promise<Models.Variable>;
|
|
3462
3472
|
/**
|
|
3463
|
-
* Update
|
|
3473
|
+
* Update variable
|
|
3464
3474
|
*
|
|
3465
3475
|
* Update variable by its unique ID.
|
|
3466
3476
|
*
|
|
@@ -3473,7 +3483,7 @@ declare module "node-appwrite" {
|
|
|
3473
3483
|
*/
|
|
3474
3484
|
updateVariable(functionId: string, variableId: string, key: string, value?: string): Promise<Models.Variable>;
|
|
3475
3485
|
/**
|
|
3476
|
-
* Delete
|
|
3486
|
+
* Delete variable
|
|
3477
3487
|
*
|
|
3478
3488
|
* Delete a variable by its unique ID.
|
|
3479
3489
|
*
|
|
@@ -3488,7 +3498,7 @@ declare module "node-appwrite" {
|
|
|
3488
3498
|
constructor(client: Client);
|
|
3489
3499
|
|
|
3490
3500
|
/**
|
|
3491
|
-
* GraphQL
|
|
3501
|
+
* GraphQL endpoint
|
|
3492
3502
|
*
|
|
3493
3503
|
* Execute a GraphQL mutation.
|
|
3494
3504
|
*
|
|
@@ -3498,7 +3508,7 @@ declare module "node-appwrite" {
|
|
|
3498
3508
|
*/
|
|
3499
3509
|
query(query: object): Promise<any>;
|
|
3500
3510
|
/**
|
|
3501
|
-
* GraphQL
|
|
3511
|
+
* GraphQL endpoint
|
|
3502
3512
|
*
|
|
3503
3513
|
* Execute a GraphQL mutation.
|
|
3504
3514
|
*
|
|
@@ -3521,7 +3531,7 @@ declare module "node-appwrite" {
|
|
|
3521
3531
|
*/
|
|
3522
3532
|
get(): Promise<Models.HealthStatus>;
|
|
3523
3533
|
/**
|
|
3524
|
-
* Get
|
|
3534
|
+
* Get antivirus
|
|
3525
3535
|
*
|
|
3526
3536
|
* Check the Appwrite Antivirus server is up and connection is successful.
|
|
3527
3537
|
*
|
|
@@ -3530,7 +3540,7 @@ declare module "node-appwrite" {
|
|
|
3530
3540
|
*/
|
|
3531
3541
|
getAntivirus(): Promise<Models.HealthAntivirus>;
|
|
3532
3542
|
/**
|
|
3533
|
-
* Get
|
|
3543
|
+
* Get cache
|
|
3534
3544
|
*
|
|
3535
3545
|
* Check the Appwrite in-memory cache servers are up and connection is
|
|
3536
3546
|
* successful.
|
|
@@ -3549,7 +3559,7 @@ declare module "node-appwrite" {
|
|
|
3549
3559
|
*/
|
|
3550
3560
|
getDB(): Promise<Models.HealthStatus>;
|
|
3551
3561
|
/**
|
|
3552
|
-
* Get
|
|
3562
|
+
* Get pubsub
|
|
3553
3563
|
*
|
|
3554
3564
|
* Check the Appwrite pub-sub servers are up and connection is successful.
|
|
3555
3565
|
*
|
|
@@ -3558,7 +3568,7 @@ declare module "node-appwrite" {
|
|
|
3558
3568
|
*/
|
|
3559
3569
|
getPubSub(): Promise<Models.HealthStatus>;
|
|
3560
3570
|
/**
|
|
3561
|
-
* Get
|
|
3571
|
+
* Get queue
|
|
3562
3572
|
*
|
|
3563
3573
|
* Check the Appwrite queue messaging servers are up and connection is
|
|
3564
3574
|
* successful.
|
|
@@ -3568,45 +3578,116 @@ declare module "node-appwrite" {
|
|
|
3568
3578
|
*/
|
|
3569
3579
|
getQueue(): Promise<Models.HealthStatus>;
|
|
3570
3580
|
/**
|
|
3571
|
-
* Get
|
|
3581
|
+
* Get builds queue
|
|
3582
|
+
*
|
|
3583
|
+
* Get the number of builds that are waiting to be processed in the Appwrite
|
|
3584
|
+
* internal queue server.
|
|
3585
|
+
*
|
|
3586
|
+
* @param {number} threshold
|
|
3587
|
+
* @throws {AppwriteException}
|
|
3588
|
+
* @returns {Promise}
|
|
3589
|
+
*/
|
|
3590
|
+
getQueueBuilds(threshold?: number): Promise<Models.HealthQueue>;
|
|
3591
|
+
/**
|
|
3592
|
+
* Get certificates queue
|
|
3572
3593
|
*
|
|
3573
3594
|
* Get the number of certificates that are waiting to be issued against
|
|
3574
3595
|
* [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue
|
|
3575
3596
|
* server.
|
|
3576
3597
|
*
|
|
3598
|
+
* @param {number} threshold
|
|
3599
|
+
* @throws {AppwriteException}
|
|
3600
|
+
* @returns {Promise}
|
|
3601
|
+
*/
|
|
3602
|
+
getQueueCertificates(threshold?: number): Promise<Models.HealthQueue>;
|
|
3603
|
+
/**
|
|
3604
|
+
* Get databases queue
|
|
3605
|
+
*
|
|
3606
|
+
* Get the number of database changes that are waiting to be processed in the
|
|
3607
|
+
* Appwrite internal queue server.
|
|
3608
|
+
*
|
|
3609
|
+
* @param {string} name
|
|
3610
|
+
* @param {number} threshold
|
|
3577
3611
|
* @throws {AppwriteException}
|
|
3578
3612
|
* @returns {Promise}
|
|
3579
3613
|
*/
|
|
3580
|
-
|
|
3614
|
+
getQueueDatabases(name?: string, threshold?: number): Promise<Models.HealthQueue>;
|
|
3581
3615
|
/**
|
|
3582
|
-
* Get
|
|
3616
|
+
* Get deletes queue
|
|
3617
|
+
*
|
|
3618
|
+
* Get the number of background destructive changes that are waiting to be
|
|
3619
|
+
* processed in the Appwrite internal queue server.
|
|
3583
3620
|
*
|
|
3621
|
+
* @param {number} threshold
|
|
3584
3622
|
* @throws {AppwriteException}
|
|
3585
3623
|
* @returns {Promise}
|
|
3586
3624
|
*/
|
|
3587
|
-
|
|
3625
|
+
getQueueDeletes(threshold?: number): Promise<Models.HealthQueue>;
|
|
3588
3626
|
/**
|
|
3589
|
-
* Get
|
|
3627
|
+
* Get functions queue
|
|
3628
|
+
*
|
|
3629
|
+
* @param {number} threshold
|
|
3630
|
+
* @throws {AppwriteException}
|
|
3631
|
+
* @returns {Promise}
|
|
3632
|
+
*/
|
|
3633
|
+
getQueueFunctions(threshold?: number): Promise<Models.HealthQueue>;
|
|
3634
|
+
/**
|
|
3635
|
+
* Get logs queue
|
|
3590
3636
|
*
|
|
3591
3637
|
* Get the number of logs that are waiting to be processed in the Appwrite
|
|
3592
3638
|
* internal queue server.
|
|
3593
3639
|
*
|
|
3640
|
+
* @param {number} threshold
|
|
3594
3641
|
* @throws {AppwriteException}
|
|
3595
3642
|
* @returns {Promise}
|
|
3596
3643
|
*/
|
|
3597
|
-
getQueueLogs(): Promise<Models.HealthQueue>;
|
|
3644
|
+
getQueueLogs(threshold?: number): Promise<Models.HealthQueue>;
|
|
3598
3645
|
/**
|
|
3599
|
-
* Get
|
|
3646
|
+
* Get mails queue
|
|
3647
|
+
*
|
|
3648
|
+
* Get the number of mails that are waiting to be processed in the Appwrite
|
|
3649
|
+
* internal queue server.
|
|
3650
|
+
*
|
|
3651
|
+
* @param {number} threshold
|
|
3652
|
+
* @throws {AppwriteException}
|
|
3653
|
+
* @returns {Promise}
|
|
3654
|
+
*/
|
|
3655
|
+
getQueueMails(threshold?: number): Promise<Models.HealthQueue>;
|
|
3656
|
+
/**
|
|
3657
|
+
* Get messaging queue
|
|
3658
|
+
*
|
|
3659
|
+
* Get the number of messages that are waiting to be processed in the Appwrite
|
|
3660
|
+
* internal queue server.
|
|
3661
|
+
*
|
|
3662
|
+
* @param {number} threshold
|
|
3663
|
+
* @throws {AppwriteException}
|
|
3664
|
+
* @returns {Promise}
|
|
3665
|
+
*/
|
|
3666
|
+
getQueueMessaging(threshold?: number): Promise<Models.HealthQueue>;
|
|
3667
|
+
/**
|
|
3668
|
+
* Get migrations queue
|
|
3669
|
+
*
|
|
3670
|
+
* Get the number of migrations that are waiting to be processed in the
|
|
3671
|
+
* Appwrite internal queue server.
|
|
3672
|
+
*
|
|
3673
|
+
* @param {number} threshold
|
|
3674
|
+
* @throws {AppwriteException}
|
|
3675
|
+
* @returns {Promise}
|
|
3676
|
+
*/
|
|
3677
|
+
getQueueMigrations(threshold?: number): Promise<Models.HealthQueue>;
|
|
3678
|
+
/**
|
|
3679
|
+
* Get webhooks queue
|
|
3600
3680
|
*
|
|
3601
3681
|
* Get the number of webhooks that are waiting to be processed in the Appwrite
|
|
3602
3682
|
* internal queue server.
|
|
3603
3683
|
*
|
|
3684
|
+
* @param {number} threshold
|
|
3604
3685
|
* @throws {AppwriteException}
|
|
3605
3686
|
* @returns {Promise}
|
|
3606
3687
|
*/
|
|
3607
|
-
getQueueWebhooks(): Promise<Models.HealthQueue>;
|
|
3688
|
+
getQueueWebhooks(threshold?: number): Promise<Models.HealthQueue>;
|
|
3608
3689
|
/**
|
|
3609
|
-
* Get
|
|
3690
|
+
* Get local storage
|
|
3610
3691
|
*
|
|
3611
3692
|
* Check the Appwrite local storage device is up and connection is successful.
|
|
3612
3693
|
*
|
|
@@ -3615,7 +3696,7 @@ declare module "node-appwrite" {
|
|
|
3615
3696
|
*/
|
|
3616
3697
|
getStorageLocal(): Promise<Models.HealthStatus>;
|
|
3617
3698
|
/**
|
|
3618
|
-
* Get
|
|
3699
|
+
* Get time
|
|
3619
3700
|
*
|
|
3620
3701
|
* Check the Appwrite server time is synced with Google remote NTP server. We
|
|
3621
3702
|
* use this technology to smoothly handle leap seconds with no disruptive
|
|
@@ -3634,7 +3715,7 @@ declare module "node-appwrite" {
|
|
|
3634
3715
|
constructor(client: Client);
|
|
3635
3716
|
|
|
3636
3717
|
/**
|
|
3637
|
-
* Get
|
|
3718
|
+
* Get user locale
|
|
3638
3719
|
*
|
|
3639
3720
|
* Get the current user location based on IP. Returns an object with user
|
|
3640
3721
|
* country code, country name, continent name, continent code, ip address and
|
|
@@ -3658,7 +3739,7 @@ declare module "node-appwrite" {
|
|
|
3658
3739
|
*/
|
|
3659
3740
|
listCodes(): Promise<Models.LocaleCodeList>;
|
|
3660
3741
|
/**
|
|
3661
|
-
* List
|
|
3742
|
+
* List continents
|
|
3662
3743
|
*
|
|
3663
3744
|
* List of all continents. You can use the locale header to get the data in a
|
|
3664
3745
|
* supported language.
|
|
@@ -3668,7 +3749,7 @@ declare module "node-appwrite" {
|
|
|
3668
3749
|
*/
|
|
3669
3750
|
listContinents(): Promise<Models.ContinentList>;
|
|
3670
3751
|
/**
|
|
3671
|
-
* List
|
|
3752
|
+
* List countries
|
|
3672
3753
|
*
|
|
3673
3754
|
* List of all countries. You can use the locale header to get the data in a
|
|
3674
3755
|
* supported language.
|
|
@@ -3678,7 +3759,7 @@ declare module "node-appwrite" {
|
|
|
3678
3759
|
*/
|
|
3679
3760
|
listCountries(): Promise<Models.CountryList>;
|
|
3680
3761
|
/**
|
|
3681
|
-
* List EU
|
|
3762
|
+
* List EU countries
|
|
3682
3763
|
*
|
|
3683
3764
|
* List of all countries that are currently members of the EU. You can use the
|
|
3684
3765
|
* locale header to get the data in a supported language.
|
|
@@ -3688,7 +3769,7 @@ declare module "node-appwrite" {
|
|
|
3688
3769
|
*/
|
|
3689
3770
|
listCountriesEU(): Promise<Models.CountryList>;
|
|
3690
3771
|
/**
|
|
3691
|
-
* List
|
|
3772
|
+
* List countries phone codes
|
|
3692
3773
|
*
|
|
3693
3774
|
* List of all countries phone codes. You can use the locale header to get the
|
|
3694
3775
|
* data in a supported language.
|
|
@@ -3698,7 +3779,7 @@ declare module "node-appwrite" {
|
|
|
3698
3779
|
*/
|
|
3699
3780
|
listCountriesPhones(): Promise<Models.PhoneList>;
|
|
3700
3781
|
/**
|
|
3701
|
-
* List
|
|
3782
|
+
* List currencies
|
|
3702
3783
|
*
|
|
3703
3784
|
* List of all currencies, including currency symbol, name, plural, and
|
|
3704
3785
|
* decimal digits for all major and minor currencies. You can use the locale
|
|
@@ -3709,7 +3790,7 @@ declare module "node-appwrite" {
|
|
|
3709
3790
|
*/
|
|
3710
3791
|
listCurrencies(): Promise<Models.CurrencyList>;
|
|
3711
3792
|
/**
|
|
3712
|
-
* List
|
|
3793
|
+
* List languages
|
|
3713
3794
|
*
|
|
3714
3795
|
* List of all languages classified by ISO 639-1 including 2-letter code, name
|
|
3715
3796
|
* in English, and name in the respective language.
|
|
@@ -3754,7 +3835,7 @@ declare module "node-appwrite" {
|
|
|
3754
3835
|
*/
|
|
3755
3836
|
createBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: string, encryption?: boolean, antivirus?: boolean): Promise<Models.Bucket>;
|
|
3756
3837
|
/**
|
|
3757
|
-
* Get
|
|
3838
|
+
* Get bucket
|
|
3758
3839
|
*
|
|
3759
3840
|
* Get a storage bucket by its unique ID. This endpoint response returns a
|
|
3760
3841
|
* JSON object with the storage bucket metadata.
|
|
@@ -3765,7 +3846,7 @@ declare module "node-appwrite" {
|
|
|
3765
3846
|
*/
|
|
3766
3847
|
getBucket(bucketId: string): Promise<Models.Bucket>;
|
|
3767
3848
|
/**
|
|
3768
|
-
* Update
|
|
3849
|
+
* Update bucket
|
|
3769
3850
|
*
|
|
3770
3851
|
* Update a storage bucket by its unique ID.
|
|
3771
3852
|
*
|
|
@@ -3784,7 +3865,7 @@ declare module "node-appwrite" {
|
|
|
3784
3865
|
*/
|
|
3785
3866
|
updateBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: string, encryption?: boolean, antivirus?: boolean): Promise<Models.Bucket>;
|
|
3786
3867
|
/**
|
|
3787
|
-
* Delete
|
|
3868
|
+
* Delete bucket
|
|
3788
3869
|
*
|
|
3789
3870
|
* Delete a storage bucket by its unique ID.
|
|
3790
3871
|
*
|
|
@@ -3794,7 +3875,7 @@ declare module "node-appwrite" {
|
|
|
3794
3875
|
*/
|
|
3795
3876
|
deleteBucket(bucketId: string): Promise<string>;
|
|
3796
3877
|
/**
|
|
3797
|
-
* List
|
|
3878
|
+
* List files
|
|
3798
3879
|
*
|
|
3799
3880
|
* Get a list of all the user files. You can use the query params to filter
|
|
3800
3881
|
* your results.
|
|
@@ -3807,12 +3888,12 @@ declare module "node-appwrite" {
|
|
|
3807
3888
|
*/
|
|
3808
3889
|
listFiles(bucketId: string, queries?: string[], search?: string): Promise<Models.FileList>;
|
|
3809
3890
|
/**
|
|
3810
|
-
* Create
|
|
3891
|
+
* Create file
|
|
3811
3892
|
*
|
|
3812
3893
|
* Create a new file. Before using this route, you should create a new bucket
|
|
3813
3894
|
* resource using either a [server
|
|
3814
|
-
* integration](/docs/server/storage#storageCreateBucket)
|
|
3815
|
-
* your Appwrite console.
|
|
3895
|
+
* integration](https://appwrite.io/docs/server/storage#storageCreateBucket)
|
|
3896
|
+
* API or directly from your Appwrite console.
|
|
3816
3897
|
*
|
|
3817
3898
|
* Larger files should be uploaded using multiple requests with the
|
|
3818
3899
|
* [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range)
|
|
@@ -3837,7 +3918,7 @@ declare module "node-appwrite" {
|
|
|
3837
3918
|
*/
|
|
3838
3919
|
createFile(bucketId: string, fileId: string, file: InputFile, permissions?: string[]): Promise<Models.File>;
|
|
3839
3920
|
/**
|
|
3840
|
-
* Get
|
|
3921
|
+
* Get file
|
|
3841
3922
|
*
|
|
3842
3923
|
* Get a file by its unique ID. This endpoint response returns a JSON object
|
|
3843
3924
|
* with the file metadata.
|
|
@@ -3849,7 +3930,7 @@ declare module "node-appwrite" {
|
|
|
3849
3930
|
*/
|
|
3850
3931
|
getFile(bucketId: string, fileId: string): Promise<Models.File>;
|
|
3851
3932
|
/**
|
|
3852
|
-
* Update
|
|
3933
|
+
* Update file
|
|
3853
3934
|
*
|
|
3854
3935
|
* Update a file by its unique ID. Only users with write permissions have
|
|
3855
3936
|
* access to update this resource.
|
|
@@ -3875,7 +3956,7 @@ declare module "node-appwrite" {
|
|
|
3875
3956
|
*/
|
|
3876
3957
|
deleteFile(bucketId: string, fileId: string): Promise<string>;
|
|
3877
3958
|
/**
|
|
3878
|
-
* Get
|
|
3959
|
+
* Get file for download
|
|
3879
3960
|
*
|
|
3880
3961
|
* Get a file content by its unique ID. The endpoint response return with a
|
|
3881
3962
|
* 'Content-Disposition: attachment' header that tells the browser to start
|
|
@@ -3888,7 +3969,7 @@ declare module "node-appwrite" {
|
|
|
3888
3969
|
*/
|
|
3889
3970
|
getFileDownload(bucketId: string, fileId: string): Promise<Buffer>;
|
|
3890
3971
|
/**
|
|
3891
|
-
* Get
|
|
3972
|
+
* Get file preview
|
|
3892
3973
|
*
|
|
3893
3974
|
* Get a file preview image. Currently, this method supports preview for image
|
|
3894
3975
|
* files (jpg, png, and gif), other supported formats, like pdf, docs, slides,
|
|
@@ -3914,7 +3995,7 @@ declare module "node-appwrite" {
|
|
|
3914
3995
|
*/
|
|
3915
3996
|
getFilePreview(bucketId: string, fileId: string, width?: number, height?: number, gravity?: string, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: string): Promise<Buffer>;
|
|
3916
3997
|
/**
|
|
3917
|
-
* Get
|
|
3998
|
+
* Get file for view
|
|
3918
3999
|
*
|
|
3919
4000
|
* Get a file content by its unique ID. This endpoint is similar to the
|
|
3920
4001
|
* download method but returns with no 'Content-Disposition: attachment'
|
|
@@ -3931,7 +4012,7 @@ declare module "node-appwrite" {
|
|
|
3931
4012
|
constructor(client: Client);
|
|
3932
4013
|
|
|
3933
4014
|
/**
|
|
3934
|
-
* List
|
|
4015
|
+
* List teams
|
|
3935
4016
|
*
|
|
3936
4017
|
* Get a list of all the teams in which the current user is a member. You can
|
|
3937
4018
|
* use the parameters to filter your results.
|
|
@@ -3943,7 +4024,7 @@ declare module "node-appwrite" {
|
|
|
3943
4024
|
*/
|
|
3944
4025
|
list<Preferences extends Models.Preferences>(queries?: string[], search?: string): Promise<Models.TeamList<Preferences>>;
|
|
3945
4026
|
/**
|
|
3946
|
-
* Create
|
|
4027
|
+
* Create team
|
|
3947
4028
|
*
|
|
3948
4029
|
* Create a new team. The user who creates the team will automatically be
|
|
3949
4030
|
* assigned as the owner of the team. Only the users with the owner role can
|
|
@@ -3957,7 +4038,7 @@ declare module "node-appwrite" {
|
|
|
3957
4038
|
*/
|
|
3958
4039
|
create<Preferences extends Models.Preferences>(teamId: string, name: string, roles?: string[]): Promise<Models.Team<Preferences>>;
|
|
3959
4040
|
/**
|
|
3960
|
-
* Get
|
|
4041
|
+
* Get team
|
|
3961
4042
|
*
|
|
3962
4043
|
* Get a team by its ID. All team members have read access for this resource.
|
|
3963
4044
|
*
|
|
@@ -3967,7 +4048,7 @@ declare module "node-appwrite" {
|
|
|
3967
4048
|
*/
|
|
3968
4049
|
get<Preferences extends Models.Preferences>(teamId: string): Promise<Models.Team<Preferences>>;
|
|
3969
4050
|
/**
|
|
3970
|
-
* Update
|
|
4051
|
+
* Update name
|
|
3971
4052
|
*
|
|
3972
4053
|
* Update the team's name by its unique ID.
|
|
3973
4054
|
*
|
|
@@ -3978,7 +4059,7 @@ declare module "node-appwrite" {
|
|
|
3978
4059
|
*/
|
|
3979
4060
|
updateName<Preferences extends Models.Preferences>(teamId: string, name: string): Promise<Models.Team<Preferences>>;
|
|
3980
4061
|
/**
|
|
3981
|
-
* Delete
|
|
4062
|
+
* Delete team
|
|
3982
4063
|
*
|
|
3983
4064
|
* Delete a team using its ID. Only team members with the owner role can
|
|
3984
4065
|
* delete the team.
|
|
@@ -3989,7 +4070,7 @@ declare module "node-appwrite" {
|
|
|
3989
4070
|
*/
|
|
3990
4071
|
delete(teamId: string): Promise<string>;
|
|
3991
4072
|
/**
|
|
3992
|
-
* List
|
|
4073
|
+
* List team memberships
|
|
3993
4074
|
*
|
|
3994
4075
|
* Use this endpoint to list a team's members using the team's ID. All team
|
|
3995
4076
|
* members have read access to this endpoint.
|
|
@@ -4002,7 +4083,7 @@ declare module "node-appwrite" {
|
|
|
4002
4083
|
*/
|
|
4003
4084
|
listMemberships(teamId: string, queries?: string[], search?: string): Promise<Models.MembershipList>;
|
|
4004
4085
|
/**
|
|
4005
|
-
* Create
|
|
4086
|
+
* Create team membership
|
|
4006
4087
|
*
|
|
4007
4088
|
* Invite a new member to join your team. Provide an ID for existing users, or
|
|
4008
4089
|
* invite unregistered users using an email or phone number. If initiated from
|
|
@@ -4017,8 +4098,8 @@ declare module "node-appwrite" {
|
|
|
4017
4098
|
*
|
|
4018
4099
|
* Use the `url` parameter to redirect the user from the invitation email to
|
|
4019
4100
|
* your app. After the user is redirected, use the [Update Team Membership
|
|
4020
|
-
* Status](/docs/client/teams#
|
|
4021
|
-
* the user to accept the invitation to the team.
|
|
4101
|
+
* Status](https://appwrite.io/docs/references/cloud/client-web/teams#updateMembershipStatus)
|
|
4102
|
+
* endpoint to allow the user to accept the invitation to the team.
|
|
4022
4103
|
*
|
|
4023
4104
|
* Please note that to avoid a [Redirect
|
|
4024
4105
|
* Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md)
|
|
@@ -4028,17 +4109,17 @@ declare module "node-appwrite" {
|
|
|
4028
4109
|
*
|
|
4029
4110
|
* @param {string} teamId
|
|
4030
4111
|
* @param {string[]} roles
|
|
4031
|
-
* @param {string} url
|
|
4032
4112
|
* @param {string} email
|
|
4033
4113
|
* @param {string} userId
|
|
4034
4114
|
* @param {string} phone
|
|
4115
|
+
* @param {string} url
|
|
4035
4116
|
* @param {string} name
|
|
4036
4117
|
* @throws {AppwriteException}
|
|
4037
4118
|
* @returns {Promise}
|
|
4038
4119
|
*/
|
|
4039
|
-
createMembership(teamId: string, roles: string[],
|
|
4120
|
+
createMembership(teamId: string, roles: string[], email?: string, userId?: string, phone?: string, url?: string, name?: string): Promise<Models.Membership>;
|
|
4040
4121
|
/**
|
|
4041
|
-
* Get
|
|
4122
|
+
* Get team membership
|
|
4042
4123
|
*
|
|
4043
4124
|
* Get a team member by the membership unique id. All team members have read
|
|
4044
4125
|
* access for this resource.
|
|
@@ -4050,11 +4131,11 @@ declare module "node-appwrite" {
|
|
|
4050
4131
|
*/
|
|
4051
4132
|
getMembership(teamId: string, membershipId: string): Promise<Models.Membership>;
|
|
4052
4133
|
/**
|
|
4053
|
-
* Update
|
|
4134
|
+
* Update membership
|
|
4054
4135
|
*
|
|
4055
4136
|
* Modify the roles of a team member. Only team members with the owner role
|
|
4056
4137
|
* have access to this endpoint. Learn more about [roles and
|
|
4057
|
-
* permissions](/docs/permissions).
|
|
4138
|
+
* permissions](https://appwrite.io/docs/permissions).
|
|
4058
4139
|
*
|
|
4059
4140
|
*
|
|
4060
4141
|
* @param {string} teamId
|
|
@@ -4065,7 +4146,7 @@ declare module "node-appwrite" {
|
|
|
4065
4146
|
*/
|
|
4066
4147
|
updateMembership(teamId: string, membershipId: string, roles: string[]): Promise<Models.Membership>;
|
|
4067
4148
|
/**
|
|
4068
|
-
* Delete
|
|
4149
|
+
* Delete team membership
|
|
4069
4150
|
*
|
|
4070
4151
|
* This endpoint allows a user to leave a team or for a team owner to delete
|
|
4071
4152
|
* the membership of any other team member. You can also use this endpoint to
|
|
@@ -4078,7 +4159,7 @@ declare module "node-appwrite" {
|
|
|
4078
4159
|
*/
|
|
4079
4160
|
deleteMembership(teamId: string, membershipId: string): Promise<string>;
|
|
4080
4161
|
/**
|
|
4081
|
-
* Update
|
|
4162
|
+
* Update team membership status
|
|
4082
4163
|
*
|
|
4083
4164
|
* Use this endpoint to allow a user to accept an invitation to join a team
|
|
4084
4165
|
* after being redirected back to your app from the invitation email received
|
|
@@ -4097,11 +4178,11 @@ declare module "node-appwrite" {
|
|
|
4097
4178
|
*/
|
|
4098
4179
|
updateMembershipStatus(teamId: string, membershipId: string, userId: string, secret: string): Promise<Models.Membership>;
|
|
4099
4180
|
/**
|
|
4100
|
-
* Get
|
|
4181
|
+
* Get team preferences
|
|
4101
4182
|
*
|
|
4102
4183
|
* Get the team's shared preferences by its unique ID. If a preference doesn't
|
|
4103
4184
|
* need to be shared by all team members, prefer storing them in [user
|
|
4104
|
-
* preferences](/docs/client/account#
|
|
4185
|
+
* preferences](https://appwrite.io/docs/references/cloud/client-web/account#getPrefs).
|
|
4105
4186
|
*
|
|
4106
4187
|
* @param {string} teamId
|
|
4107
4188
|
* @throws {AppwriteException}
|
|
@@ -4109,7 +4190,7 @@ declare module "node-appwrite" {
|
|
|
4109
4190
|
*/
|
|
4110
4191
|
getPrefs<Preferences extends Models.Preferences>(teamId: string): Promise<Preferences>;
|
|
4111
4192
|
/**
|
|
4112
|
-
* Update
|
|
4193
|
+
* Update preferences
|
|
4113
4194
|
*
|
|
4114
4195
|
* Update the team's preferences by its unique ID. The object you pass is
|
|
4115
4196
|
* stored as is and replaces any previous value. The maximum allowed prefs
|
|
@@ -4126,7 +4207,7 @@ declare module "node-appwrite" {
|
|
|
4126
4207
|
constructor(client: Client);
|
|
4127
4208
|
|
|
4128
4209
|
/**
|
|
4129
|
-
* List
|
|
4210
|
+
* List users
|
|
4130
4211
|
*
|
|
4131
4212
|
* Get a list of all the project's users. You can use the query params to
|
|
4132
4213
|
* filter your results.
|
|
@@ -4138,7 +4219,7 @@ declare module "node-appwrite" {
|
|
|
4138
4219
|
*/
|
|
4139
4220
|
list<Preferences extends Models.Preferences>(queries?: string[], search?: string): Promise<Models.UserList<Preferences>>;
|
|
4140
4221
|
/**
|
|
4141
|
-
* Create
|
|
4222
|
+
* Create user
|
|
4142
4223
|
*
|
|
4143
4224
|
* Create a new user.
|
|
4144
4225
|
*
|
|
@@ -4152,12 +4233,12 @@ declare module "node-appwrite" {
|
|
|
4152
4233
|
*/
|
|
4153
4234
|
create<Preferences extends Models.Preferences>(userId: string, email?: string, phone?: string, password?: string, name?: string): Promise<Models.User<Preferences>>;
|
|
4154
4235
|
/**
|
|
4155
|
-
* Create
|
|
4236
|
+
* Create user with Argon2 password
|
|
4156
4237
|
*
|
|
4157
4238
|
* Create a new user. Password provided must be hashed with the
|
|
4158
4239
|
* [Argon2](https://en.wikipedia.org/wiki/Argon2) algorithm. Use the [POST
|
|
4159
|
-
* /users](/docs/server/users#usersCreate) endpoint to
|
|
4160
|
-
* plain text password.
|
|
4240
|
+
* /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to
|
|
4241
|
+
* create users with a plain text password.
|
|
4161
4242
|
*
|
|
4162
4243
|
* @param {string} userId
|
|
4163
4244
|
* @param {string} email
|
|
@@ -4168,12 +4249,12 @@ declare module "node-appwrite" {
|
|
|
4168
4249
|
*/
|
|
4169
4250
|
createArgon2User<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
|
|
4170
4251
|
/**
|
|
4171
|
-
* Create
|
|
4252
|
+
* Create user with bcrypt password
|
|
4172
4253
|
*
|
|
4173
4254
|
* Create a new user. Password provided must be hashed with the
|
|
4174
4255
|
* [Bcrypt](https://en.wikipedia.org/wiki/Bcrypt) algorithm. Use the [POST
|
|
4175
|
-
* /users](/docs/server/users#usersCreate) endpoint to
|
|
4176
|
-
* plain text password.
|
|
4256
|
+
* /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to
|
|
4257
|
+
* create users with a plain text password.
|
|
4177
4258
|
*
|
|
4178
4259
|
* @param {string} userId
|
|
4179
4260
|
* @param {string} email
|
|
@@ -4205,12 +4286,12 @@ declare module "node-appwrite" {
|
|
|
4205
4286
|
*/
|
|
4206
4287
|
deleteIdentity(identityId: string): Promise<string>;
|
|
4207
4288
|
/**
|
|
4208
|
-
* Create
|
|
4289
|
+
* Create user with MD5 password
|
|
4209
4290
|
*
|
|
4210
4291
|
* Create a new user. Password provided must be hashed with the
|
|
4211
4292
|
* [MD5](https://en.wikipedia.org/wiki/MD5) algorithm. Use the [POST
|
|
4212
|
-
* /users](/docs/server/users#usersCreate) endpoint to
|
|
4213
|
-
* plain text password.
|
|
4293
|
+
* /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to
|
|
4294
|
+
* create users with a plain text password.
|
|
4214
4295
|
*
|
|
4215
4296
|
* @param {string} userId
|
|
4216
4297
|
* @param {string} email
|
|
@@ -4221,12 +4302,12 @@ declare module "node-appwrite" {
|
|
|
4221
4302
|
*/
|
|
4222
4303
|
createMD5User<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
|
|
4223
4304
|
/**
|
|
4224
|
-
* Create
|
|
4305
|
+
* Create user with PHPass password
|
|
4225
4306
|
*
|
|
4226
4307
|
* Create a new user. Password provided must be hashed with the
|
|
4227
4308
|
* [PHPass](https://www.openwall.com/phpass/) algorithm. Use the [POST
|
|
4228
|
-
* /users](/docs/server/users#usersCreate) endpoint to
|
|
4229
|
-
* plain text password.
|
|
4309
|
+
* /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to
|
|
4310
|
+
* create users with a plain text password.
|
|
4230
4311
|
*
|
|
4231
4312
|
* @param {string} userId
|
|
4232
4313
|
* @param {string} email
|
|
@@ -4237,12 +4318,12 @@ declare module "node-appwrite" {
|
|
|
4237
4318
|
*/
|
|
4238
4319
|
createPHPassUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
|
|
4239
4320
|
/**
|
|
4240
|
-
* Create
|
|
4321
|
+
* Create user with Scrypt password
|
|
4241
4322
|
*
|
|
4242
4323
|
* Create a new user. Password provided must be hashed with the
|
|
4243
4324
|
* [Scrypt](https://github.com/Tarsnap/scrypt) algorithm. Use the [POST
|
|
4244
|
-
* /users](/docs/server/users#usersCreate) endpoint to
|
|
4245
|
-
* plain text password.
|
|
4325
|
+
* /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to
|
|
4326
|
+
* create users with a plain text password.
|
|
4246
4327
|
*
|
|
4247
4328
|
* @param {string} userId
|
|
4248
4329
|
* @param {string} email
|
|
@@ -4258,12 +4339,13 @@ declare module "node-appwrite" {
|
|
|
4258
4339
|
*/
|
|
4259
4340
|
createScryptUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, passwordSalt: string, passwordCpu: number, passwordMemory: number, passwordParallel: number, passwordLength: number, name?: string): Promise<Models.User<Preferences>>;
|
|
4260
4341
|
/**
|
|
4261
|
-
* Create
|
|
4342
|
+
* Create user with Scrypt modified password
|
|
4262
4343
|
*
|
|
4263
4344
|
* Create a new user. Password provided must be hashed with the [Scrypt
|
|
4264
4345
|
* Modified](https://gist.github.com/Meldiron/eecf84a0225eccb5a378d45bb27462cc)
|
|
4265
|
-
* algorithm. Use the [POST
|
|
4266
|
-
*
|
|
4346
|
+
* algorithm. Use the [POST
|
|
4347
|
+
* /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to
|
|
4348
|
+
* create users with a plain text password.
|
|
4267
4349
|
*
|
|
4268
4350
|
* @param {string} userId
|
|
4269
4351
|
* @param {string} email
|
|
@@ -4277,12 +4359,12 @@ declare module "node-appwrite" {
|
|
|
4277
4359
|
*/
|
|
4278
4360
|
createScryptModifiedUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, passwordSalt: string, passwordSaltSeparator: string, passwordSignerKey: string, name?: string): Promise<Models.User<Preferences>>;
|
|
4279
4361
|
/**
|
|
4280
|
-
* Create
|
|
4362
|
+
* Create user with SHA password
|
|
4281
4363
|
*
|
|
4282
4364
|
* Create a new user. Password provided must be hashed with the
|
|
4283
4365
|
* [SHA](https://en.wikipedia.org/wiki/Secure_Hash_Algorithm) algorithm. Use
|
|
4284
|
-
* the [POST /users](/docs/server/users#usersCreate)
|
|
4285
|
-
* with a plain text password.
|
|
4366
|
+
* the [POST /users](https://appwrite.io/docs/server/users#usersCreate)
|
|
4367
|
+
* endpoint to create users with a plain text password.
|
|
4286
4368
|
*
|
|
4287
4369
|
* @param {string} userId
|
|
4288
4370
|
* @param {string} email
|
|
@@ -4294,7 +4376,7 @@ declare module "node-appwrite" {
|
|
|
4294
4376
|
*/
|
|
4295
4377
|
createSHAUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, passwordVersion?: string, name?: string): Promise<Models.User<Preferences>>;
|
|
4296
4378
|
/**
|
|
4297
|
-
* Get
|
|
4379
|
+
* Get user
|
|
4298
4380
|
*
|
|
4299
4381
|
* Get a user by its unique ID.
|
|
4300
4382
|
*
|
|
@@ -4304,12 +4386,13 @@ declare module "node-appwrite" {
|
|
|
4304
4386
|
*/
|
|
4305
4387
|
get<Preferences extends Models.Preferences>(userId: string): Promise<Models.User<Preferences>>;
|
|
4306
4388
|
/**
|
|
4307
|
-
* Delete
|
|
4389
|
+
* Delete user
|
|
4308
4390
|
*
|
|
4309
4391
|
* Delete a user by its unique ID, thereby releasing it's ID. Since ID is
|
|
4310
4392
|
* released and can be reused, all user-related resources like documents or
|
|
4311
4393
|
* storage files should be deleted before user deletion. If you want to keep
|
|
4312
|
-
* ID reserved, use the
|
|
4394
|
+
* ID reserved, use the
|
|
4395
|
+
* [updateStatus](https://appwrite.io/docs/server/users#usersUpdateStatus)
|
|
4313
4396
|
* endpoint instead.
|
|
4314
4397
|
*
|
|
4315
4398
|
* @param {string} userId
|
|
@@ -4318,7 +4401,7 @@ declare module "node-appwrite" {
|
|
|
4318
4401
|
*/
|
|
4319
4402
|
delete(userId: string): Promise<string>;
|
|
4320
4403
|
/**
|
|
4321
|
-
* Update
|
|
4404
|
+
* Update email
|
|
4322
4405
|
*
|
|
4323
4406
|
* Update the user email by its unique ID.
|
|
4324
4407
|
*
|
|
@@ -4329,14 +4412,14 @@ declare module "node-appwrite" {
|
|
|
4329
4412
|
*/
|
|
4330
4413
|
updateEmail<Preferences extends Models.Preferences>(userId: string, email: string): Promise<Models.User<Preferences>>;
|
|
4331
4414
|
/**
|
|
4332
|
-
* Update
|
|
4415
|
+
* Update user labels
|
|
4333
4416
|
*
|
|
4334
4417
|
* Update the user labels by its unique ID.
|
|
4335
4418
|
*
|
|
4336
4419
|
* Labels can be used to grant access to resources. While teams are a way for
|
|
4337
4420
|
* user's to share access to a resource, labels can be defined by the
|
|
4338
4421
|
* developer to grant access without an invitation. See the [Permissions
|
|
4339
|
-
* docs](/docs/permissions) for more info.
|
|
4422
|
+
* docs](https://appwrite.io/docs/permissions) for more info.
|
|
4340
4423
|
*
|
|
4341
4424
|
* @param {string} userId
|
|
4342
4425
|
* @param {string[]} labels
|
|
@@ -4345,7 +4428,7 @@ declare module "node-appwrite" {
|
|
|
4345
4428
|
*/
|
|
4346
4429
|
updateLabels<Preferences extends Models.Preferences>(userId: string, labels: string[]): Promise<Models.User<Preferences>>;
|
|
4347
4430
|
/**
|
|
4348
|
-
* List
|
|
4431
|
+
* List user logs
|
|
4349
4432
|
*
|
|
4350
4433
|
* Get the user activity logs list by its unique ID.
|
|
4351
4434
|
*
|
|
@@ -4356,7 +4439,7 @@ declare module "node-appwrite" {
|
|
|
4356
4439
|
*/
|
|
4357
4440
|
listLogs(userId: string, queries?: string[]): Promise<Models.LogList>;
|
|
4358
4441
|
/**
|
|
4359
|
-
* List
|
|
4442
|
+
* List user memberships
|
|
4360
4443
|
*
|
|
4361
4444
|
* Get the user membership list by its unique ID.
|
|
4362
4445
|
*
|
|
@@ -4366,7 +4449,7 @@ declare module "node-appwrite" {
|
|
|
4366
4449
|
*/
|
|
4367
4450
|
listMemberships(userId: string): Promise<Models.MembershipList>;
|
|
4368
4451
|
/**
|
|
4369
|
-
* Update
|
|
4452
|
+
* Update name
|
|
4370
4453
|
*
|
|
4371
4454
|
* Update the user name by its unique ID.
|
|
4372
4455
|
*
|
|
@@ -4377,7 +4460,7 @@ declare module "node-appwrite" {
|
|
|
4377
4460
|
*/
|
|
4378
4461
|
updateName<Preferences extends Models.Preferences>(userId: string, name: string): Promise<Models.User<Preferences>>;
|
|
4379
4462
|
/**
|
|
4380
|
-
* Update
|
|
4463
|
+
* Update password
|
|
4381
4464
|
*
|
|
4382
4465
|
* Update the user password by its unique ID.
|
|
4383
4466
|
*
|
|
@@ -4388,7 +4471,7 @@ declare module "node-appwrite" {
|
|
|
4388
4471
|
*/
|
|
4389
4472
|
updatePassword<Preferences extends Models.Preferences>(userId: string, password: string): Promise<Models.User<Preferences>>;
|
|
4390
4473
|
/**
|
|
4391
|
-
* Update
|
|
4474
|
+
* Update phone
|
|
4392
4475
|
*
|
|
4393
4476
|
* Update the user phone by its unique ID.
|
|
4394
4477
|
*
|
|
@@ -4399,7 +4482,7 @@ declare module "node-appwrite" {
|
|
|
4399
4482
|
*/
|
|
4400
4483
|
updatePhone<Preferences extends Models.Preferences>(userId: string, number: string): Promise<Models.User<Preferences>>;
|
|
4401
4484
|
/**
|
|
4402
|
-
* Get
|
|
4485
|
+
* Get user preferences
|
|
4403
4486
|
*
|
|
4404
4487
|
* Get the user preferences by its unique ID.
|
|
4405
4488
|
*
|
|
@@ -4409,7 +4492,7 @@ declare module "node-appwrite" {
|
|
|
4409
4492
|
*/
|
|
4410
4493
|
getPrefs<Preferences extends Models.Preferences>(userId: string): Promise<Preferences>;
|
|
4411
4494
|
/**
|
|
4412
|
-
* Update
|
|
4495
|
+
* Update user preferences
|
|
4413
4496
|
*
|
|
4414
4497
|
* Update the user preferences by its unique ID. The object you pass is stored
|
|
4415
4498
|
* as is, and replaces any previous value. The maximum allowed prefs size is
|
|
@@ -4422,7 +4505,7 @@ declare module "node-appwrite" {
|
|
|
4422
4505
|
*/
|
|
4423
4506
|
updatePrefs<Preferences extends Models.Preferences>(userId: string, prefs: object): Promise<Preferences>;
|
|
4424
4507
|
/**
|
|
4425
|
-
* List
|
|
4508
|
+
* List user sessions
|
|
4426
4509
|
*
|
|
4427
4510
|
* Get the user sessions list by its unique ID.
|
|
4428
4511
|
*
|
|
@@ -4432,7 +4515,7 @@ declare module "node-appwrite" {
|
|
|
4432
4515
|
*/
|
|
4433
4516
|
listSessions(userId: string): Promise<Models.SessionList>;
|
|
4434
4517
|
/**
|
|
4435
|
-
* Delete
|
|
4518
|
+
* Delete user sessions
|
|
4436
4519
|
*
|
|
4437
4520
|
* Delete all user's sessions by using the user's unique ID.
|
|
4438
4521
|
*
|
|
@@ -4442,7 +4525,7 @@ declare module "node-appwrite" {
|
|
|
4442
4525
|
*/
|
|
4443
4526
|
deleteSessions(userId: string): Promise<string>;
|
|
4444
4527
|
/**
|
|
4445
|
-
* Delete
|
|
4528
|
+
* Delete user session
|
|
4446
4529
|
*
|
|
4447
4530
|
* Delete a user sessions by its unique ID.
|
|
4448
4531
|
*
|
|
@@ -4453,7 +4536,7 @@ declare module "node-appwrite" {
|
|
|
4453
4536
|
*/
|
|
4454
4537
|
deleteSession(userId: string, sessionId: string): Promise<string>;
|
|
4455
4538
|
/**
|
|
4456
|
-
* Update
|
|
4539
|
+
* Update user status
|
|
4457
4540
|
*
|
|
4458
4541
|
* Update the user status by its unique ID. Use this endpoint as an
|
|
4459
4542
|
* alternative to deleting a user if you want to keep user's ID reserved.
|
|
@@ -4465,7 +4548,7 @@ declare module "node-appwrite" {
|
|
|
4465
4548
|
*/
|
|
4466
4549
|
updateStatus<Preferences extends Models.Preferences>(userId: string, status: boolean): Promise<Models.User<Preferences>>;
|
|
4467
4550
|
/**
|
|
4468
|
-
* Update
|
|
4551
|
+
* Update email verification
|
|
4469
4552
|
*
|
|
4470
4553
|
* Update the user email verification status by its unique ID.
|
|
4471
4554
|
*
|
|
@@ -4476,7 +4559,7 @@ declare module "node-appwrite" {
|
|
|
4476
4559
|
*/
|
|
4477
4560
|
updateEmailVerification<Preferences extends Models.Preferences>(userId: string, emailVerification: boolean): Promise<Models.User<Preferences>>;
|
|
4478
4561
|
/**
|
|
4479
|
-
* Update
|
|
4562
|
+
* Update phone verification
|
|
4480
4563
|
*
|
|
4481
4564
|
* Update the user phone verification status by its unique ID.
|
|
4482
4565
|
*
|