node-appwrite 9.0.0 → 10.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (182) hide show
  1. package/README.md +2 -2
  2. package/docs/examples/account/create-phone-verification.md +1 -1
  3. package/docs/examples/account/create-recovery.md +1 -1
  4. package/docs/examples/account/create-verification.md +1 -1
  5. package/docs/examples/account/delete-identity.md +20 -0
  6. package/docs/examples/account/delete-session.md +1 -1
  7. package/docs/examples/account/delete-sessions.md +1 -1
  8. package/docs/examples/account/get-prefs.md +1 -1
  9. package/docs/examples/account/get-session.md +1 -1
  10. package/docs/examples/account/get.md +1 -1
  11. package/docs/examples/account/list-identities.md +20 -0
  12. package/docs/examples/account/list-logs.md +1 -1
  13. package/docs/examples/account/list-sessions.md +1 -1
  14. package/docs/examples/account/update-email.md +1 -1
  15. package/docs/examples/account/update-name.md +1 -1
  16. package/docs/examples/account/update-password.md +1 -1
  17. package/docs/examples/account/update-phone-verification.md +1 -1
  18. package/docs/examples/account/update-phone.md +1 -1
  19. package/docs/examples/account/update-prefs.md +1 -1
  20. package/docs/examples/account/update-recovery.md +1 -1
  21. package/docs/examples/account/update-session.md +1 -1
  22. package/docs/examples/account/update-status.md +1 -1
  23. package/docs/examples/account/update-verification.md +1 -1
  24. package/docs/examples/avatars/get-browser.md +1 -1
  25. package/docs/examples/avatars/get-credit-card.md +1 -1
  26. package/docs/examples/avatars/get-favicon.md +1 -1
  27. package/docs/examples/avatars/get-flag.md +1 -1
  28. package/docs/examples/avatars/get-image.md +1 -1
  29. package/docs/examples/avatars/get-initials.md +1 -1
  30. package/docs/examples/avatars/get-q-r.md +1 -1
  31. package/docs/examples/databases/create-boolean-attribute.md +1 -1
  32. package/docs/examples/databases/create-collection.md +1 -1
  33. package/docs/examples/databases/create-datetime-attribute.md +1 -1
  34. package/docs/examples/databases/create-document.md +1 -1
  35. package/docs/examples/databases/create-email-attribute.md +1 -1
  36. package/docs/examples/databases/create-enum-attribute.md +1 -1
  37. package/docs/examples/databases/create-float-attribute.md +1 -1
  38. package/docs/examples/databases/create-index.md +1 -1
  39. package/docs/examples/databases/create-integer-attribute.md +1 -1
  40. package/docs/examples/databases/create-ip-attribute.md +1 -1
  41. package/docs/examples/databases/create-relationship-attribute.md +1 -1
  42. package/docs/examples/databases/create-string-attribute.md +1 -1
  43. package/docs/examples/databases/create-url-attribute.md +1 -1
  44. package/docs/examples/databases/create.md +1 -1
  45. package/docs/examples/databases/delete-attribute.md +1 -1
  46. package/docs/examples/databases/delete-collection.md +1 -1
  47. package/docs/examples/databases/delete-document.md +1 -1
  48. package/docs/examples/databases/delete-index.md +1 -1
  49. package/docs/examples/databases/delete.md +1 -1
  50. package/docs/examples/databases/get-attribute.md +1 -1
  51. package/docs/examples/databases/get-collection.md +1 -1
  52. package/docs/examples/databases/get-document.md +1 -1
  53. package/docs/examples/databases/get-index.md +1 -1
  54. package/docs/examples/databases/get.md +1 -1
  55. package/docs/examples/databases/list-attributes.md +1 -1
  56. package/docs/examples/databases/list-collections.md +1 -1
  57. package/docs/examples/databases/list-documents.md +1 -1
  58. package/docs/examples/databases/list-indexes.md +1 -1
  59. package/docs/examples/databases/list.md +1 -1
  60. package/docs/examples/databases/update-boolean-attribute.md +1 -1
  61. package/docs/examples/databases/update-collection.md +1 -1
  62. package/docs/examples/databases/update-datetime-attribute.md +1 -1
  63. package/docs/examples/databases/update-document.md +1 -1
  64. package/docs/examples/databases/update-email-attribute.md +1 -1
  65. package/docs/examples/databases/update-enum-attribute.md +1 -1
  66. package/docs/examples/databases/update-float-attribute.md +1 -1
  67. package/docs/examples/databases/update-integer-attribute.md +1 -1
  68. package/docs/examples/databases/update-ip-attribute.md +1 -1
  69. package/docs/examples/databases/update-relationship-attribute.md +1 -1
  70. package/docs/examples/databases/update-string-attribute.md +1 -1
  71. package/docs/examples/databases/update-url-attribute.md +1 -1
  72. package/docs/examples/databases/update.md +1 -1
  73. package/docs/examples/functions/create-build.md +1 -1
  74. package/docs/examples/functions/create-deployment.md +2 -2
  75. package/docs/examples/functions/create-execution.md +1 -1
  76. package/docs/examples/functions/create-variable.md +1 -1
  77. package/docs/examples/functions/create.md +1 -1
  78. package/docs/examples/functions/delete-deployment.md +1 -1
  79. package/docs/examples/functions/delete-variable.md +1 -1
  80. package/docs/examples/functions/delete.md +1 -1
  81. package/docs/examples/functions/download-deployment.md +20 -0
  82. package/docs/examples/functions/get-deployment.md +1 -1
  83. package/docs/examples/functions/get-execution.md +1 -1
  84. package/docs/examples/functions/get-variable.md +1 -1
  85. package/docs/examples/functions/get.md +1 -1
  86. package/docs/examples/functions/list-deployments.md +1 -1
  87. package/docs/examples/functions/list-executions.md +1 -1
  88. package/docs/examples/functions/list-runtimes.md +1 -1
  89. package/docs/examples/functions/list-variables.md +1 -1
  90. package/docs/examples/functions/list.md +1 -1
  91. package/docs/examples/functions/update-deployment.md +1 -1
  92. package/docs/examples/functions/update-variable.md +1 -1
  93. package/docs/examples/functions/update.md +2 -2
  94. package/docs/examples/graphql/mutation.md +1 -1
  95. package/docs/examples/graphql/query.md +1 -1
  96. package/docs/examples/health/get-antivirus.md +1 -1
  97. package/docs/examples/health/get-cache.md +1 -1
  98. package/docs/examples/health/get-d-b.md +1 -1
  99. package/docs/examples/health/get-pub-sub.md +20 -0
  100. package/docs/examples/health/get-queue-certificates.md +1 -1
  101. package/docs/examples/health/get-queue-functions.md +1 -1
  102. package/docs/examples/health/get-queue-logs.md +1 -1
  103. package/docs/examples/health/get-queue-webhooks.md +1 -1
  104. package/docs/examples/health/get-queue.md +20 -0
  105. package/docs/examples/health/get-storage-local.md +1 -1
  106. package/docs/examples/health/get-time.md +1 -1
  107. package/docs/examples/health/get.md +1 -1
  108. package/docs/examples/locale/get.md +1 -1
  109. package/docs/examples/locale/list-codes.md +20 -0
  110. package/docs/examples/locale/list-continents.md +1 -1
  111. package/docs/examples/locale/list-countries-e-u.md +1 -1
  112. package/docs/examples/locale/list-countries-phones.md +1 -1
  113. package/docs/examples/locale/list-countries.md +1 -1
  114. package/docs/examples/locale/list-currencies.md +1 -1
  115. package/docs/examples/locale/list-languages.md +1 -1
  116. package/docs/examples/storage/create-bucket.md +1 -1
  117. package/docs/examples/storage/create-file.md +1 -1
  118. package/docs/examples/storage/delete-bucket.md +1 -1
  119. package/docs/examples/storage/delete-file.md +1 -1
  120. package/docs/examples/storage/get-bucket.md +1 -1
  121. package/docs/examples/storage/get-file-download.md +1 -1
  122. package/docs/examples/storage/get-file-preview.md +1 -1
  123. package/docs/examples/storage/get-file-view.md +1 -1
  124. package/docs/examples/storage/get-file.md +1 -1
  125. package/docs/examples/storage/list-buckets.md +1 -1
  126. package/docs/examples/storage/list-files.md +1 -1
  127. package/docs/examples/storage/update-bucket.md +1 -1
  128. package/docs/examples/storage/update-file.md +1 -1
  129. package/docs/examples/teams/create-membership.md +1 -1
  130. package/docs/examples/teams/create.md +1 -1
  131. package/docs/examples/teams/delete-membership.md +1 -1
  132. package/docs/examples/teams/delete.md +1 -1
  133. package/docs/examples/teams/get-membership.md +1 -1
  134. package/docs/examples/teams/get-prefs.md +1 -1
  135. package/docs/examples/teams/get.md +1 -1
  136. package/docs/examples/teams/list-memberships.md +1 -1
  137. package/docs/examples/teams/list.md +1 -1
  138. package/docs/examples/teams/update-membership-status.md +1 -1
  139. package/docs/examples/teams/{update-membership-roles.md → update-membership.md} +2 -2
  140. package/docs/examples/teams/update-name.md +1 -1
  141. package/docs/examples/teams/update-prefs.md +1 -1
  142. package/docs/examples/users/create-argon2user.md +1 -1
  143. package/docs/examples/users/create-bcrypt-user.md +1 -1
  144. package/docs/examples/users/create-m-d5user.md +1 -1
  145. package/docs/examples/users/create-p-h-pass-user.md +1 -1
  146. package/docs/examples/users/create-s-h-a-user.md +1 -1
  147. package/docs/examples/users/create-scrypt-modified-user.md +1 -1
  148. package/docs/examples/users/create-scrypt-user.md +1 -1
  149. package/docs/examples/users/create.md +1 -1
  150. package/docs/examples/users/delete-identity.md +20 -0
  151. package/docs/examples/users/delete-session.md +1 -1
  152. package/docs/examples/users/delete-sessions.md +1 -1
  153. package/docs/examples/users/delete.md +1 -1
  154. package/docs/examples/users/get-prefs.md +1 -1
  155. package/docs/examples/users/get.md +1 -1
  156. package/docs/examples/users/list-identities.md +20 -0
  157. package/docs/examples/users/list-logs.md +1 -1
  158. package/docs/examples/users/list-memberships.md +1 -1
  159. package/docs/examples/users/list-sessions.md +1 -1
  160. package/docs/examples/users/list.md +1 -1
  161. package/docs/examples/users/update-email-verification.md +1 -1
  162. package/docs/examples/users/update-email.md +1 -1
  163. package/docs/examples/users/update-labels.md +20 -0
  164. package/docs/examples/users/update-name.md +1 -1
  165. package/docs/examples/users/update-password.md +1 -1
  166. package/docs/examples/users/update-phone-verification.md +1 -1
  167. package/docs/examples/users/update-phone.md +1 -1
  168. package/docs/examples/users/update-prefs.md +1 -1
  169. package/docs/examples/users/update-status.md +1 -1
  170. package/index.d.ts +435 -55
  171. package/lib/client.js +4 -2
  172. package/lib/services/account.js +94 -50
  173. package/lib/services/avatars.js +14 -14
  174. package/lib/services/databases.js +120 -90
  175. package/lib/services/functions.js +212 -59
  176. package/lib/services/graphql.js +4 -4
  177. package/lib/services/health.js +57 -22
  178. package/lib/services/locale.js +32 -14
  179. package/lib/services/storage.js +33 -28
  180. package/lib/services/teams.js +29 -28
  181. package/lib/services/users.js +135 -50
  182. package/package.json +2 -2
package/index.d.ts CHANGED
@@ -79,6 +79,19 @@ declare module "node-appwrite" {
79
79
  sessions: Session[];
80
80
  }
81
81
  /**
82
+ * Identities List
83
+ */
84
+ export type IdentityList = {
85
+ /**
86
+ * Total number of identities documents that matched your query.
87
+ */
88
+ total: number;
89
+ /**
90
+ * List of identities.
91
+ */
92
+ identities: Identity[];
93
+ }
94
+ /**
82
95
  * Logs List
83
96
  */
84
97
  export type LogList = {
@@ -274,6 +287,19 @@ declare module "node-appwrite" {
274
287
  variables: Variable[];
275
288
  }
276
289
  /**
290
+ * Locale codes list
291
+ */
292
+ export type LocaleCodeList = {
293
+ /**
294
+ * Total number of localeCodes documents that matched your query.
295
+ */
296
+ total: number;
297
+ /**
298
+ * List of localeCodes.
299
+ */
300
+ localeCodes: LocaleCode[];
301
+ }
302
+ /**
277
303
  * Database
278
304
  */
279
305
  export type Database = {
@@ -293,6 +319,10 @@ declare module "node-appwrite" {
293
319
  * Database update date in ISO 8601 format.
294
320
  */
295
321
  $updatedAt: string;
322
+ /**
323
+ * If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys.
324
+ */
325
+ enabled: boolean;
296
326
  }
297
327
  /**
298
328
  * Collection
@@ -323,7 +353,7 @@ declare module "node-appwrite" {
323
353
  */
324
354
  name: string;
325
355
  /**
326
- * Collection enabled.
356
+ * Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.
327
357
  */
328
358
  enabled: boolean;
329
359
  /**
@@ -369,6 +399,10 @@ declare module "node-appwrite" {
369
399
  */
370
400
  status: string;
371
401
  /**
402
+ * Error message. Displays error generated on failure of creating or deleting an attribute.
403
+ */
404
+ error: string;
405
+ /**
372
406
  * Is attribute required?
373
407
  */
374
408
  required: boolean;
@@ -402,6 +436,10 @@ declare module "node-appwrite" {
402
436
  */
403
437
  status: string;
404
438
  /**
439
+ * Error message. Displays error generated on failure of creating or deleting an attribute.
440
+ */
441
+ error: string;
442
+ /**
405
443
  * Is attribute required?
406
444
  */
407
445
  required: boolean;
@@ -439,6 +477,10 @@ declare module "node-appwrite" {
439
477
  */
440
478
  status: string;
441
479
  /**
480
+ * Error message. Displays error generated on failure of creating or deleting an attribute.
481
+ */
482
+ error: string;
483
+ /**
442
484
  * Is attribute required?
443
485
  */
444
486
  required: boolean;
@@ -476,6 +518,10 @@ declare module "node-appwrite" {
476
518
  */
477
519
  status: string;
478
520
  /**
521
+ * Error message. Displays error generated on failure of creating or deleting an attribute.
522
+ */
523
+ error: string;
524
+ /**
479
525
  * Is attribute required?
480
526
  */
481
527
  required: boolean;
@@ -505,6 +551,10 @@ declare module "node-appwrite" {
505
551
  */
506
552
  status: string;
507
553
  /**
554
+ * Error message. Displays error generated on failure of creating or deleting an attribute.
555
+ */
556
+ error: string;
557
+ /**
508
558
  * Is attribute required?
509
559
  */
510
560
  required: boolean;
@@ -538,6 +588,10 @@ declare module "node-appwrite" {
538
588
  */
539
589
  status: string;
540
590
  /**
591
+ * Error message. Displays error generated on failure of creating or deleting an attribute.
592
+ */
593
+ error: string;
594
+ /**
541
595
  * Is attribute required?
542
596
  */
543
597
  required: boolean;
@@ -575,6 +629,10 @@ declare module "node-appwrite" {
575
629
  */
576
630
  status: string;
577
631
  /**
632
+ * Error message. Displays error generated on failure of creating or deleting an attribute.
633
+ */
634
+ error: string;
635
+ /**
578
636
  * Is attribute required?
579
637
  */
580
638
  required: boolean;
@@ -608,6 +666,10 @@ declare module "node-appwrite" {
608
666
  */
609
667
  status: string;
610
668
  /**
669
+ * Error message. Displays error generated on failure of creating or deleting an attribute.
670
+ */
671
+ error: string;
672
+ /**
611
673
  * Is attribute required?
612
674
  */
613
675
  required: boolean;
@@ -641,6 +703,10 @@ declare module "node-appwrite" {
641
703
  */
642
704
  status: string;
643
705
  /**
706
+ * Error message. Displays error generated on failure of creating or deleting an attribute.
707
+ */
708
+ error: string;
709
+ /**
644
710
  * Is attribute required?
645
711
  */
646
712
  required: boolean;
@@ -674,6 +740,10 @@ declare module "node-appwrite" {
674
740
  */
675
741
  status: string;
676
742
  /**
743
+ * Error message. Displays error generated on failure of creating or deleting an attribute.
744
+ */
745
+ error: string;
746
+ /**
677
747
  * Is attribute required?
678
748
  */
679
749
  required: boolean;
@@ -723,6 +793,10 @@ declare module "node-appwrite" {
723
793
  */
724
794
  status: string;
725
795
  /**
796
+ * Error message. Displays error generated on failure of creating or deleting an index.
797
+ */
798
+ error: string;
799
+ /**
726
800
  * Index attributes.
727
801
  */
728
802
  attributes: string[];
@@ -890,6 +964,10 @@ declare module "node-appwrite" {
890
964
  */
891
965
  status: boolean;
892
966
  /**
967
+ * Labels for the user.
968
+ */
969
+ labels: string[];
970
+ /**
893
971
  * Password update time in ISO 8601 format.
894
972
  */
895
973
  passwordUpdate: string;
@@ -913,6 +991,10 @@ declare module "node-appwrite" {
913
991
  * User preferences as a key-value object
914
992
  */
915
993
  prefs: Preferences;
994
+ /**
995
+ * Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.
996
+ */
997
+ accessedAt: string;
916
998
  }
917
999
  /**
918
1000
  * AlgoMD5
@@ -1128,6 +1210,51 @@ declare module "node-appwrite" {
1128
1210
  current: boolean;
1129
1211
  }
1130
1212
  /**
1213
+ * Identity
1214
+ */
1215
+ export type Identity = {
1216
+ /**
1217
+ * Identity ID.
1218
+ */
1219
+ $id: string;
1220
+ /**
1221
+ * Identity creation date in ISO 8601 format.
1222
+ */
1223
+ $createdAt: string;
1224
+ /**
1225
+ * Identity update date in ISO 8601 format.
1226
+ */
1227
+ $updatedAt: string;
1228
+ /**
1229
+ * User ID.
1230
+ */
1231
+ userId: string;
1232
+ /**
1233
+ * Identity Provider.
1234
+ */
1235
+ provider: string;
1236
+ /**
1237
+ * ID of the User in the Identity Provider.
1238
+ */
1239
+ providerUid: string;
1240
+ /**
1241
+ * Email of the User in the Identity Provider.
1242
+ */
1243
+ providerEmail: string;
1244
+ /**
1245
+ * Identity Provider Access Token.
1246
+ */
1247
+ providerAccessToken: string;
1248
+ /**
1249
+ * The date of when the access token expires in ISO 8601 format.
1250
+ */
1251
+ providerAccessTokenExpiry: string;
1252
+ /**
1253
+ * Identity Provider Refresh Token.
1254
+ */
1255
+ providerRefreshToken: string;
1256
+ }
1257
+ /**
1131
1258
  * Token
1132
1259
  */
1133
1260
  export type Token = {
@@ -1186,6 +1313,19 @@ declare module "node-appwrite" {
1186
1313
  currency: string;
1187
1314
  }
1188
1315
  /**
1316
+ * LocaleCode
1317
+ */
1318
+ export type LocaleCode = {
1319
+ /**
1320
+ * Locale codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
1321
+ */
1322
+ code: string;
1323
+ /**
1324
+ * Locale name
1325
+ */
1326
+ name: string;
1327
+ }
1328
+ /**
1189
1329
  * File
1190
1330
  */
1191
1331
  export type File = {
@@ -1398,6 +1538,14 @@ declare module "node-appwrite" {
1398
1538
  */
1399
1539
  enabled: boolean;
1400
1540
  /**
1541
+ * Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration.
1542
+ */
1543
+ live: boolean;
1544
+ /**
1545
+ * Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.
1546
+ */
1547
+ logging: boolean;
1548
+ /**
1401
1549
  * Function execution runtime.
1402
1550
  */
1403
1551
  runtime: string;
@@ -1418,17 +1566,41 @@ declare module "node-appwrite" {
1418
1566
  */
1419
1567
  schedule: string;
1420
1568
  /**
1421
- * Function's next scheduled execution time in ISO 8601 format.
1569
+ * Function execution timeout in seconds.
1422
1570
  */
1423
- scheduleNext: string;
1571
+ timeout: number;
1424
1572
  /**
1425
- * Function's previous scheduled execution time in ISO 8601 format.
1573
+ * The entrypoint file used to execute the deployment.
1426
1574
  */
1427
- schedulePrevious: string;
1575
+ entrypoint: string;
1428
1576
  /**
1429
- * Function execution timeout in seconds.
1577
+ * The build command used to build the deployment.
1430
1578
  */
1431
- timeout: number;
1579
+ commands: string;
1580
+ /**
1581
+ * Version of Open Runtimes used for the function.
1582
+ */
1583
+ version: string;
1584
+ /**
1585
+ * Function VCS (Version Control System) installation id.
1586
+ */
1587
+ installationId: string;
1588
+ /**
1589
+ * VCS (Version Control System) Repository ID
1590
+ */
1591
+ providerRepositoryId: string;
1592
+ /**
1593
+ * VCS (Version Control System) branch name
1594
+ */
1595
+ providerBranch: string;
1596
+ /**
1597
+ * Path to function in VCS (Version Control System) repository
1598
+ */
1599
+ providerRootDirectory: string;
1600
+ /**
1601
+ * Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests
1602
+ */
1603
+ providerSilentMode: boolean;
1432
1604
  }
1433
1605
  /**
1434
1606
  * Runtime
@@ -1480,6 +1652,10 @@ declare module "node-appwrite" {
1480
1652
  */
1481
1653
  $updatedAt: string;
1482
1654
  /**
1655
+ * Type of deployment.
1656
+ */
1657
+ type: string;
1658
+ /**
1483
1659
  * Resource ID.
1484
1660
  */
1485
1661
  resourceId: string;
@@ -1504,21 +1680,57 @@ declare module "node-appwrite" {
1504
1680
  */
1505
1681
  activate: boolean;
1506
1682
  /**
1507
- * The deployment status. Possible values are "processing", "building", "pending", "ready", and "failed".
1683
+ * The deployment status. Possible values are "processing", "building", "waiting", "ready", and "failed".
1508
1684
  */
1509
1685
  status: string;
1510
1686
  /**
1511
- * The build stdout.
1687
+ * The build logs.
1512
1688
  */
1513
- buildStdout: string;
1514
- /**
1515
- * The build stderr.
1516
- */
1517
- buildStderr: string;
1689
+ buildLogs: string;
1518
1690
  /**
1519
1691
  * The current build time in seconds.
1520
1692
  */
1521
1693
  buildTime: number;
1694
+ /**
1695
+ * The name of the vcs provider repository
1696
+ */
1697
+ providerRepositoryName: string;
1698
+ /**
1699
+ * The name of the vcs provider repository owner
1700
+ */
1701
+ providerRepositoryOwner: string;
1702
+ /**
1703
+ * The url of the vcs provider repository
1704
+ */
1705
+ providerRepositoryUrl: string;
1706
+ /**
1707
+ * The branch of the vcs repository
1708
+ */
1709
+ providerBranch: string;
1710
+ /**
1711
+ * The commit hash of the vcs commit
1712
+ */
1713
+ providerCommitHash: string;
1714
+ /**
1715
+ * The url of vcs commit author
1716
+ */
1717
+ providerCommitAuthorUrl: string;
1718
+ /**
1719
+ * The name of vcs commit author
1720
+ */
1721
+ providerCommitAuthor: string;
1722
+ /**
1723
+ * The commit message
1724
+ */
1725
+ providerCommitMessage: string;
1726
+ /**
1727
+ * The url of the vcs commit
1728
+ */
1729
+ providerCommitUrl: string;
1730
+ /**
1731
+ * The branch of the vcs repository
1732
+ */
1733
+ providerBranchUrl: string;
1522
1734
  }
1523
1735
  /**
1524
1736
  * Execution
@@ -1553,23 +1765,39 @@ declare module "node-appwrite" {
1553
1765
  */
1554
1766
  status: string;
1555
1767
  /**
1556
- * The script status code.
1768
+ * HTTP request method type.
1769
+ */
1770
+ requestMethod: string;
1771
+ /**
1772
+ * HTTP request path and query.
1773
+ */
1774
+ requestPath: string;
1775
+ /**
1776
+ * HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.
1557
1777
  */
1558
- statusCode: number;
1778
+ requestHeaders: Headers[];
1559
1779
  /**
1560
- * The script response output string. Logs the last 4,000 characters of the execution response output.
1780
+ * HTTP response status code.
1561
1781
  */
1562
- response: string;
1782
+ responseStatusCode: number;
1563
1783
  /**
1564
- * The script stdout output string. Logs the last 4,000 characters of the execution stdout output. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.
1784
+ * HTTP response body. This will return empty unless execution is created as synchronous.
1565
1785
  */
1566
- stdout: string;
1786
+ responseBody: string;
1567
1787
  /**
1568
- * The script stderr output string. Logs the last 4,000 characters of the execution stderr output. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.
1788
+ * HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.
1569
1789
  */
1570
- stderr: string;
1790
+ responseHeaders: Headers[];
1571
1791
  /**
1572
- * The script execution duration in seconds.
1792
+ * Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.
1793
+ */
1794
+ logs: string;
1795
+ /**
1796
+ * Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.
1797
+ */
1798
+ errors: string;
1799
+ /**
1800
+ * Function execution duration in seconds.
1573
1801
  */
1574
1802
  duration: number;
1575
1803
  }
@@ -1598,9 +1826,13 @@ declare module "node-appwrite" {
1598
1826
  */
1599
1827
  value: string;
1600
1828
  /**
1601
- * Function ID.
1829
+ * Service to which the variable belongs. Possible values are "project", "function"
1602
1830
  */
1603
- functionId: string;
1831
+ resourceType: string;
1832
+ /**
1833
+ * ID of resource to which the variable belongs. If resourceType is "project", it is empty. If resourceType is "function", it is ID of the function.
1834
+ */
1835
+ resourceId: string;
1604
1836
  }
1605
1837
  /**
1606
1838
  * Country
@@ -1721,6 +1953,10 @@ declare module "node-appwrite" {
1721
1953
  * Health Status
1722
1954
  */
1723
1955
  export type HealthStatus = {
1956
+ /**
1957
+ * Name of the service.
1958
+ */
1959
+ name: string;
1724
1960
  /**
1725
1961
  * Duration in milliseconds how long the health check took.
1726
1962
  */
@@ -1747,6 +1983,19 @@ declare module "node-appwrite" {
1747
1983
  */
1748
1984
  diff: number;
1749
1985
  }
1986
+ /**
1987
+ * Headers
1988
+ */
1989
+ export type Headers = {
1990
+ /**
1991
+ * Header name.
1992
+ */
1993
+ name: string;
1994
+ /**
1995
+ * Header value.
1996
+ */
1997
+ value: string;
1998
+ }
1750
1999
  }
1751
2000
  export class Client {
1752
2001
  /**
@@ -1911,7 +2160,7 @@ declare module "node-appwrite" {
1911
2160
  /**
1912
2161
  * Get Account
1913
2162
  *
1914
- * Get currently logged in user data as JSON object.
2163
+ * Get the currently logged in user.
1915
2164
  *
1916
2165
  * @throws {AppwriteException}
1917
2166
  * @returns {Promise}
@@ -1935,11 +2184,31 @@ declare module "node-appwrite" {
1935
2184
  * @returns {Promise}
1936
2185
  */
1937
2186
  updateEmail<Preferences extends Models.Preferences>(email: string, password: string): Promise<Models.User<Preferences>>;
2187
+ /**
2188
+ * List Identities
2189
+ *
2190
+ * Get the list of identities for the currently logged in user.
2191
+ *
2192
+ * @param {string} queries
2193
+ * @throws {AppwriteException}
2194
+ * @returns {Promise}
2195
+ */
2196
+ listIdentities(queries?: string): Promise<Models.IdentityList>;
2197
+ /**
2198
+ * Delete Identity
2199
+ *
2200
+ * Delete an identity by its unique ID.
2201
+ *
2202
+ * @param {string} identityId
2203
+ * @throws {AppwriteException}
2204
+ * @returns {Promise}
2205
+ */
2206
+ deleteIdentity(identityId: string): Promise<string>;
1938
2207
  /**
1939
2208
  * List Logs
1940
2209
  *
1941
- * Get currently logged in user list of latest security activity logs. Each
1942
- * log returns user IP address, location and date and time of log.
2210
+ * Get the list of latest security activity logs for the currently logged in
2211
+ * user. Each log returns user IP address, location and date and time of log.
1943
2212
  *
1944
2213
  * @param {string[]} queries
1945
2214
  * @throws {AppwriteException}
@@ -1987,7 +2256,7 @@ declare module "node-appwrite" {
1987
2256
  /**
1988
2257
  * Get Account Preferences
1989
2258
  *
1990
- * Get currently logged in user preferences as a key-value object.
2259
+ * Get the preferences as a key-value object for the currently logged in user.
1991
2260
  *
1992
2261
  * @throws {AppwriteException}
1993
2262
  * @returns {Promise}
@@ -2047,8 +2316,8 @@ declare module "node-appwrite" {
2047
2316
  /**
2048
2317
  * List Sessions
2049
2318
  *
2050
- * Get currently logged in user list of active sessions across different
2051
- * devices.
2319
+ * Get the list of active sessions across different devices for the currently
2320
+ * logged in user.
2052
2321
  *
2053
2322
  * @throws {AppwriteException}
2054
2323
  * @returns {Promise}
@@ -2090,10 +2359,10 @@ declare module "node-appwrite" {
2090
2359
  /**
2091
2360
  * Delete Session
2092
2361
  *
2093
- * Use this endpoint to log out the currently logged in user from all their
2094
- * account sessions across all of their different devices. When using the
2095
- * Session ID argument, only the unique session ID provided is deleted.
2096
- *
2362
+ * Logout the user. Use 'current' as the session ID to logout on this device,
2363
+ * use a session ID to logout on another device. If you're looking to logout
2364
+ * the user on all devices, use [Delete
2365
+ * Sessions](/docs/client/account#accountDeleteSessions) instead.
2097
2366
  *
2098
2367
  * @param {string} sessionId
2099
2368
  * @throws {AppwriteException}
@@ -2345,10 +2614,11 @@ declare module "node-appwrite" {
2345
2614
  *
2346
2615
  * @param {string} databaseId
2347
2616
  * @param {string} name
2617
+ * @param {boolean} enabled
2348
2618
  * @throws {AppwriteException}
2349
2619
  * @returns {Promise}
2350
2620
  */
2351
- create(databaseId: string, name: string): Promise<Models.Database>;
2621
+ create(databaseId: string, name: string, enabled?: boolean): Promise<Models.Database>;
2352
2622
  /**
2353
2623
  * Get Database
2354
2624
  *
@@ -2367,10 +2637,11 @@ declare module "node-appwrite" {
2367
2637
  *
2368
2638
  * @param {string} databaseId
2369
2639
  * @param {string} name
2640
+ * @param {boolean} enabled
2370
2641
  * @throws {AppwriteException}
2371
2642
  * @returns {Promise}
2372
2643
  */
2373
- update(databaseId: string, name: string): Promise<Models.Database>;
2644
+ update(databaseId: string, name: string, enabled?: boolean): Promise<Models.Database>;
2374
2645
  /**
2375
2646
  * Delete Database
2376
2647
  *
@@ -2408,10 +2679,11 @@ declare module "node-appwrite" {
2408
2679
  * @param {string} name
2409
2680
  * @param {string[]} permissions
2410
2681
  * @param {boolean} documentSecurity
2682
+ * @param {boolean} enabled
2411
2683
  * @throws {AppwriteException}
2412
2684
  * @returns {Promise}
2413
2685
  */
2414
- createCollection(databaseId: string, collectionId: string, name: string, permissions?: string[], documentSecurity?: boolean): Promise<Models.Collection>;
2686
+ createCollection(databaseId: string, collectionId: string, name: string, permissions?: string[], documentSecurity?: boolean, enabled?: boolean): Promise<Models.Collection>;
2415
2687
  /**
2416
2688
  * Get Collection
2417
2689
  *
@@ -2456,10 +2728,11 @@ declare module "node-appwrite" {
2456
2728
  *
2457
2729
  * @param {string} databaseId
2458
2730
  * @param {string} collectionId
2731
+ * @param {string[]} queries
2459
2732
  * @throws {AppwriteException}
2460
2733
  * @returns {Promise}
2461
2734
  */
2462
- listAttributes(databaseId: string, collectionId: string): Promise<Models.AttributeList>;
2735
+ listAttributes(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.AttributeList>;
2463
2736
  /**
2464
2737
  * Create Boolean Attribute
2465
2738
  *
@@ -2714,10 +2987,11 @@ declare module "node-appwrite" {
2714
2987
  * @param {boolean} required
2715
2988
  * @param {string} default
2716
2989
  * @param {boolean} array
2990
+ * @param {boolean} encrypt
2717
2991
  * @throws {AppwriteException}
2718
2992
  * @returns {Promise}
2719
2993
  */
2720
- createStringAttribute(databaseId: string, collectionId: string, key: string, size: number, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeString>;
2994
+ createStringAttribute(databaseId: string, collectionId: string, key: string, size: number, required: boolean, xdefault?: string, array?: boolean, encrypt?: boolean): Promise<Models.AttributeString>;
2721
2995
  /**
2722
2996
  * Update String Attribute
2723
2997
  *
@@ -2877,10 +3151,11 @@ declare module "node-appwrite" {
2877
3151
  *
2878
3152
  * @param {string} databaseId
2879
3153
  * @param {string} collectionId
3154
+ * @param {string[]} queries
2880
3155
  * @throws {AppwriteException}
2881
3156
  * @returns {Promise}
2882
3157
  */
2883
- listIndexes(databaseId: string, collectionId: string): Promise<Models.IndexList>;
3158
+ listIndexes(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.IndexList>;
2884
3159
  /**
2885
3160
  * Create Index
2886
3161
  *
@@ -2945,10 +3220,22 @@ declare module "node-appwrite" {
2945
3220
  * @param {string} schedule
2946
3221
  * @param {number} timeout
2947
3222
  * @param {boolean} enabled
3223
+ * @param {boolean} logging
3224
+ * @param {string} entrypoint
3225
+ * @param {string} commands
3226
+ * @param {string} installationId
3227
+ * @param {string} providerRepositoryId
3228
+ * @param {string} providerBranch
3229
+ * @param {boolean} providerSilentMode
3230
+ * @param {string} providerRootDirectory
3231
+ * @param {string} templateRepository
3232
+ * @param {string} templateOwner
3233
+ * @param {string} templateRootDirectory
3234
+ * @param {string} templateBranch
2948
3235
  * @throws {AppwriteException}
2949
3236
  * @returns {Promise}
2950
3237
  */
2951
- create(functionId: string, name: string, runtime: string, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean): Promise<Models.Function>;
3238
+ create(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, templateRepository?: string, templateOwner?: string, templateRootDirectory?: string, templateBranch?: string): Promise<Models.Function>;
2952
3239
  /**
2953
3240
  * List runtimes
2954
3241
  *
@@ -2975,15 +3262,24 @@ declare module "node-appwrite" {
2975
3262
  *
2976
3263
  * @param {string} functionId
2977
3264
  * @param {string} name
3265
+ * @param {string} runtime
2978
3266
  * @param {string[]} execute
2979
3267
  * @param {string[]} events
2980
3268
  * @param {string} schedule
2981
3269
  * @param {number} timeout
2982
3270
  * @param {boolean} enabled
3271
+ * @param {boolean} logging
3272
+ * @param {string} entrypoint
3273
+ * @param {string} commands
3274
+ * @param {string} installationId
3275
+ * @param {string} providerRepositoryId
3276
+ * @param {string} providerBranch
3277
+ * @param {boolean} providerSilentMode
3278
+ * @param {string} providerRootDirectory
2983
3279
  * @throws {AppwriteException}
2984
3280
  * @returns {Promise}
2985
3281
  */
2986
- update(functionId: string, name: string, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean): Promise<Models.Function>;
3282
+ 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>;
2987
3283
  /**
2988
3284
  * Delete Function
2989
3285
  *
@@ -3019,16 +3315,17 @@ declare module "node-appwrite" {
3019
3315
  * learn more about code packaging in the [Appwrite Cloud Functions
3020
3316
  * tutorial](/docs/functions).
3021
3317
  *
3022
- * Use the "command" param to set the entry point used to execute your code.
3318
+ * Use the "command" param to set the entrypoint used to execute your code.
3023
3319
  *
3024
3320
  * @param {string} functionId
3025
- * @param {string} entrypoint
3026
3321
  * @param {InputFile} code
3027
3322
  * @param {boolean} activate
3323
+ * @param {string} entrypoint
3324
+ * @param {string} commands
3028
3325
  * @throws {AppwriteException}
3029
3326
  * @returns {Promise}
3030
3327
  */
3031
- createDeployment(functionId: string, entrypoint: string, code: InputFile, activate: boolean): Promise<Models.Deployment>;
3328
+ createDeployment(functionId: string, code: InputFile, activate: boolean, entrypoint?: string, commands?: string): Promise<Models.Deployment>;
3032
3329
  /**
3033
3330
  * Get Deployment
3034
3331
  *
@@ -3067,6 +3364,9 @@ declare module "node-appwrite" {
3067
3364
  /**
3068
3365
  * Create Build
3069
3366
  *
3367
+ * Create a new build for an Appwrite Function deployment. This endpoint can
3368
+ * be used to retry a failed build.
3369
+ *
3070
3370
  * @param {string} functionId
3071
3371
  * @param {string} deploymentId
3072
3372
  * @param {string} buildId
@@ -3074,6 +3374,15 @@ declare module "node-appwrite" {
3074
3374
  * @returns {Promise}
3075
3375
  */
3076
3376
  createBuild(functionId: string, deploymentId: string, buildId: string): Promise<any>;
3377
+ /**
3378
+ * Download Deployment
3379
+ *
3380
+ * @param {string} functionId
3381
+ * @param {string} deploymentId
3382
+ * @throws {AppwriteException}
3383
+ * @returns {Promise}
3384
+ */
3385
+ downloadDeployment(functionId: string, deploymentId: string): Promise<Buffer>;
3077
3386
  /**
3078
3387
  * List Executions
3079
3388
  *
@@ -3096,12 +3405,15 @@ declare module "node-appwrite" {
3096
3405
  * function execution process will start asynchronously.
3097
3406
  *
3098
3407
  * @param {string} functionId
3099
- * @param {string} data
3408
+ * @param {string} body
3100
3409
  * @param {boolean} async
3410
+ * @param {string} path
3411
+ * @param {string} method
3412
+ * @param {object} headers
3101
3413
  * @throws {AppwriteException}
3102
3414
  * @returns {Promise}
3103
3415
  */
3104
- createExecution(functionId: string, data?: string, async?: boolean): Promise<Models.Execution>;
3416
+ createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: string, headers?: object): Promise<Models.Execution>;
3105
3417
  /**
3106
3418
  * Get Execution
3107
3419
  *
@@ -3126,8 +3438,8 @@ declare module "node-appwrite" {
3126
3438
  /**
3127
3439
  * Create Variable
3128
3440
  *
3129
- * Create a new function variable. These variables can be accessed within
3130
- * function in the `env` object under the request variable.
3441
+ * Create a new function environment variable. These variables can be accessed
3442
+ * in the function at runtime as environment variables.
3131
3443
  *
3132
3444
  * @param {string} functionId
3133
3445
  * @param {string} key
@@ -3220,7 +3532,7 @@ declare module "node-appwrite" {
3220
3532
  /**
3221
3533
  * Get Cache
3222
3534
  *
3223
- * Check the Appwrite in-memory cache server is up and connection is
3535
+ * Check the Appwrite in-memory cache servers are up and connection is
3224
3536
  * successful.
3225
3537
  *
3226
3538
  * @throws {AppwriteException}
@@ -3230,12 +3542,31 @@ declare module "node-appwrite" {
3230
3542
  /**
3231
3543
  * Get DB
3232
3544
  *
3233
- * Check the Appwrite database server is up and connection is successful.
3545
+ * Check the Appwrite database servers are up and connection is successful.
3234
3546
  *
3235
3547
  * @throws {AppwriteException}
3236
3548
  * @returns {Promise}
3237
3549
  */
3238
3550
  getDB(): Promise<Models.HealthStatus>;
3551
+ /**
3552
+ * Get PubSub
3553
+ *
3554
+ * Check the Appwrite pub-sub servers are up and connection is successful.
3555
+ *
3556
+ * @throws {AppwriteException}
3557
+ * @returns {Promise}
3558
+ */
3559
+ getPubSub(): Promise<Models.HealthStatus>;
3560
+ /**
3561
+ * Get Queue
3562
+ *
3563
+ * Check the Appwrite queue messaging servers are up and connection is
3564
+ * successful.
3565
+ *
3566
+ * @throws {AppwriteException}
3567
+ * @returns {Promise}
3568
+ */
3569
+ getQueue(): Promise<Models.HealthStatus>;
3239
3570
  /**
3240
3571
  * Get Certificates Queue
3241
3572
  *
@@ -3316,6 +3647,16 @@ declare module "node-appwrite" {
3316
3647
  * @returns {Promise}
3317
3648
  */
3318
3649
  get(): Promise<Models.Locale>;
3650
+ /**
3651
+ * List Locale Codes
3652
+ *
3653
+ * List of all locale codes in [ISO
3654
+ * 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).
3655
+ *
3656
+ * @throws {AppwriteException}
3657
+ * @returns {Promise}
3658
+ */
3659
+ listCodes(): Promise<Models.LocaleCodeList>;
3319
3660
  /**
3320
3661
  * List Continents
3321
3662
  *
@@ -3515,11 +3856,12 @@ declare module "node-appwrite" {
3515
3856
  *
3516
3857
  * @param {string} bucketId
3517
3858
  * @param {string} fileId
3859
+ * @param {string} name
3518
3860
  * @param {string[]} permissions
3519
3861
  * @throws {AppwriteException}
3520
3862
  * @returns {Promise}
3521
3863
  */
3522
- updateFile(bucketId: string, fileId: string, permissions?: string[]): Promise<Models.File>;
3864
+ updateFile(bucketId: string, fileId: string, name?: string, permissions?: string[]): Promise<Models.File>;
3523
3865
  /**
3524
3866
  * Delete File
3525
3867
  *
@@ -3708,11 +4050,12 @@ declare module "node-appwrite" {
3708
4050
  */
3709
4051
  getMembership(teamId: string, membershipId: string): Promise<Models.Membership>;
3710
4052
  /**
3711
- * Update Membership Roles
4053
+ * Update Membership
3712
4054
  *
3713
4055
  * Modify the roles of a team member. Only team members with the owner role
3714
4056
  * have access to this endpoint. Learn more about [roles and
3715
4057
  * permissions](/docs/permissions).
4058
+ *
3716
4059
  *
3717
4060
  * @param {string} teamId
3718
4061
  * @param {string} membershipId
@@ -3720,7 +4063,7 @@ declare module "node-appwrite" {
3720
4063
  * @throws {AppwriteException}
3721
4064
  * @returns {Promise}
3722
4065
  */
3723
- updateMembershipRoles(teamId: string, membershipId: string, roles: string[]): Promise<Models.Membership>;
4066
+ updateMembership(teamId: string, membershipId: string, roles: string[]): Promise<Models.Membership>;
3724
4067
  /**
3725
4068
  * Delete Team Membership
3726
4069
  *
@@ -3840,6 +4183,27 @@ declare module "node-appwrite" {
3840
4183
  * @returns {Promise}
3841
4184
  */
3842
4185
  createBcryptUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
4186
+ /**
4187
+ * List Identities
4188
+ *
4189
+ * Get identities for all users.
4190
+ *
4191
+ * @param {string} queries
4192
+ * @param {string} search
4193
+ * @throws {AppwriteException}
4194
+ * @returns {Promise}
4195
+ */
4196
+ listIdentities(queries?: string, search?: string): Promise<Models.IdentityList>;
4197
+ /**
4198
+ * Delete Identity
4199
+ *
4200
+ * Delete an identity by its unique ID.
4201
+ *
4202
+ * @param {string} identityId
4203
+ * @throws {AppwriteException}
4204
+ * @returns {Promise}
4205
+ */
4206
+ deleteIdentity(identityId: string): Promise<string>;
3843
4207
  /**
3844
4208
  * Create User with MD5 Password
3845
4209
  *
@@ -3964,6 +4328,22 @@ declare module "node-appwrite" {
3964
4328
  * @returns {Promise}
3965
4329
  */
3966
4330
  updateEmail<Preferences extends Models.Preferences>(userId: string, email: string): Promise<Models.User<Preferences>>;
4331
+ /**
4332
+ * Update User Labels
4333
+ *
4334
+ * Update the user labels by its unique ID.
4335
+ *
4336
+ * Labels can be used to grant access to resources. While teams are a way for
4337
+ * user's to share access to a resource, labels can be defined by the
4338
+ * developer to grant access without an invitation. See the [Permissions
4339
+ * docs](/docs/permissions) for more info.
4340
+ *
4341
+ * @param {string} userId
4342
+ * @param {string[]} labels
4343
+ * @throws {AppwriteException}
4344
+ * @returns {Promise}
4345
+ */
4346
+ updateLabels<Preferences extends Models.Preferences>(userId: string, labels: string[]): Promise<Models.User<Preferences>>;
3967
4347
  /**
3968
4348
  * List User Logs
3969
4349
  *