node-appwrite 12.0.1 → 13.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 (526) hide show
  1. package/README.md +1 -1
  2. package/dist/client.d.mts +131 -0
  3. package/dist/client.d.ts +131 -0
  4. package/dist/client.js +302 -0
  5. package/dist/client.js.map +1 -0
  6. package/dist/client.mjs +296 -0
  7. package/dist/client.mjs.map +1 -0
  8. package/dist/enums/authentication-factor.d.mts +8 -0
  9. package/dist/enums/authentication-factor.d.ts +8 -0
  10. package/dist/enums/authentication-factor.js +13 -0
  11. package/dist/enums/authentication-factor.js.map +1 -0
  12. package/dist/enums/authentication-factor.mjs +12 -0
  13. package/dist/enums/authentication-factor.mjs.map +1 -0
  14. package/dist/enums/authenticator-type.d.mts +5 -0
  15. package/dist/enums/authenticator-type.d.ts +5 -0
  16. package/dist/enums/authenticator-type.js +10 -0
  17. package/dist/enums/authenticator-type.js.map +1 -0
  18. package/dist/enums/authenticator-type.mjs +9 -0
  19. package/dist/enums/authenticator-type.mjs.map +1 -0
  20. package/dist/enums/browser.d.mts +18 -0
  21. package/dist/enums/browser.d.ts +18 -0
  22. package/dist/enums/browser.js +23 -0
  23. package/dist/enums/browser.js.map +1 -0
  24. package/dist/enums/browser.mjs +22 -0
  25. package/dist/enums/browser.mjs.map +1 -0
  26. package/dist/enums/compression.d.mts +7 -0
  27. package/dist/enums/compression.d.ts +7 -0
  28. package/dist/enums/compression.js +12 -0
  29. package/dist/enums/compression.js.map +1 -0
  30. package/dist/enums/compression.mjs +11 -0
  31. package/dist/enums/compression.mjs.map +1 -0
  32. package/dist/enums/credit-card.d.mts +20 -0
  33. package/dist/enums/credit-card.d.ts +20 -0
  34. package/dist/enums/credit-card.js +25 -0
  35. package/dist/enums/credit-card.js.map +1 -0
  36. package/dist/enums/credit-card.mjs +24 -0
  37. package/dist/enums/credit-card.mjs.map +1 -0
  38. package/dist/enums/execution-method.d.mts +10 -0
  39. package/dist/enums/execution-method.d.ts +10 -0
  40. package/dist/enums/execution-method.js +15 -0
  41. package/dist/enums/execution-method.js.map +1 -0
  42. package/dist/enums/execution-method.mjs +14 -0
  43. package/dist/enums/execution-method.mjs.map +1 -0
  44. package/dist/enums/flag.d.mts +199 -0
  45. package/dist/enums/flag.d.ts +199 -0
  46. package/dist/enums/flag.js +204 -0
  47. package/dist/enums/flag.js.map +1 -0
  48. package/dist/enums/flag.mjs +203 -0
  49. package/dist/enums/flag.mjs.map +1 -0
  50. package/dist/enums/image-format.d.mts +9 -0
  51. package/dist/enums/image-format.d.ts +9 -0
  52. package/dist/enums/image-format.js +14 -0
  53. package/dist/enums/image-format.js.map +1 -0
  54. package/dist/enums/image-format.mjs +13 -0
  55. package/dist/enums/image-format.mjs.map +1 -0
  56. package/dist/enums/image-gravity.d.mts +13 -0
  57. package/dist/enums/image-gravity.d.ts +13 -0
  58. package/dist/enums/image-gravity.js +18 -0
  59. package/dist/enums/image-gravity.js.map +1 -0
  60. package/dist/enums/image-gravity.mjs +17 -0
  61. package/dist/enums/image-gravity.mjs.map +1 -0
  62. package/dist/enums/index-type.d.mts +7 -0
  63. package/dist/enums/index-type.d.ts +7 -0
  64. package/dist/enums/index-type.js +12 -0
  65. package/dist/enums/index-type.js.map +1 -0
  66. package/dist/enums/index-type.mjs +11 -0
  67. package/dist/enums/index-type.mjs.map +1 -0
  68. package/dist/enums/messaging-provider-type.d.mts +7 -0
  69. package/dist/enums/messaging-provider-type.d.ts +7 -0
  70. package/dist/enums/messaging-provider-type.js +12 -0
  71. package/dist/enums/messaging-provider-type.js.map +1 -0
  72. package/dist/enums/messaging-provider-type.mjs +11 -0
  73. package/dist/enums/messaging-provider-type.mjs.map +1 -0
  74. package/dist/enums/name.d.mts +16 -0
  75. package/dist/enums/name.d.ts +16 -0
  76. package/dist/enums/name.js +21 -0
  77. package/dist/enums/name.js.map +1 -0
  78. package/dist/enums/name.mjs +20 -0
  79. package/dist/enums/name.mjs.map +1 -0
  80. package/dist/enums/o-auth-provider.d.mts +43 -0
  81. package/dist/enums/o-auth-provider.d.ts +43 -0
  82. package/dist/enums/o-auth-provider.js +48 -0
  83. package/dist/enums/o-auth-provider.js.map +1 -0
  84. package/dist/enums/o-auth-provider.mjs +47 -0
  85. package/dist/enums/o-auth-provider.mjs.map +1 -0
  86. package/dist/enums/password-hash.d.mts +15 -0
  87. package/dist/enums/password-hash.d.ts +15 -0
  88. package/dist/enums/password-hash.js +20 -0
  89. package/dist/enums/password-hash.js.map +1 -0
  90. package/dist/enums/password-hash.mjs +19 -0
  91. package/dist/enums/password-hash.mjs.map +1 -0
  92. package/dist/enums/relation-mutate.d.mts +7 -0
  93. package/dist/enums/relation-mutate.d.ts +7 -0
  94. package/dist/enums/relation-mutate.js +12 -0
  95. package/dist/enums/relation-mutate.js.map +1 -0
  96. package/dist/enums/relation-mutate.mjs +11 -0
  97. package/dist/enums/relation-mutate.mjs.map +1 -0
  98. package/dist/enums/relationship-type.d.mts +8 -0
  99. package/dist/enums/relationship-type.d.ts +8 -0
  100. package/dist/enums/relationship-type.js +13 -0
  101. package/dist/enums/relationship-type.js.map +1 -0
  102. package/dist/enums/relationship-type.mjs +12 -0
  103. package/dist/enums/relationship-type.mjs.map +1 -0
  104. package/dist/enums/runtime.d.mts +49 -0
  105. package/dist/enums/runtime.d.ts +49 -0
  106. package/dist/enums/runtime.js +54 -0
  107. package/dist/enums/runtime.js.map +1 -0
  108. package/dist/enums/runtime.mjs +53 -0
  109. package/dist/enums/runtime.mjs.map +1 -0
  110. package/dist/enums/smtp-encryption.d.mts +7 -0
  111. package/dist/enums/smtp-encryption.d.ts +7 -0
  112. package/dist/enums/smtp-encryption.js +12 -0
  113. package/dist/enums/smtp-encryption.js.map +1 -0
  114. package/dist/enums/smtp-encryption.mjs +11 -0
  115. package/dist/enums/smtp-encryption.mjs.map +1 -0
  116. package/dist/id.d.mts +7 -0
  117. package/dist/id.d.ts +7 -0
  118. package/dist/id.js +29 -0
  119. package/dist/id.js.map +1 -0
  120. package/dist/id.mjs +28 -0
  121. package/dist/id.mjs.map +1 -0
  122. package/dist/index.d.mts +35 -0
  123. package/dist/index.d.ts +35 -0
  124. package/dist/index.js +180 -0
  125. package/dist/index.js.map +1 -0
  126. package/dist/index.mjs +35 -0
  127. package/dist/index.mjs.map +1 -0
  128. package/dist/inputFile.d.mts +9 -0
  129. package/dist/inputFile.d.ts +9 -0
  130. package/dist/inputFile.js +23 -0
  131. package/dist/inputFile.js.map +1 -0
  132. package/dist/inputFile.mjs +22 -0
  133. package/dist/inputFile.mjs.map +1 -0
  134. package/dist/models.d.mts +2414 -0
  135. package/dist/models.d.ts +2414 -0
  136. package/dist/models.js +4 -0
  137. package/dist/models.js.map +1 -0
  138. package/dist/models.mjs +3 -0
  139. package/dist/models.mjs.map +1 -0
  140. package/dist/permission.d.mts +9 -0
  141. package/dist/permission.d.ts +9 -0
  142. package/dist/permission.js +23 -0
  143. package/dist/permission.js.map +1 -0
  144. package/dist/permission.mjs +22 -0
  145. package/dist/permission.mjs.map +1 -0
  146. package/dist/query.d.mts +35 -0
  147. package/dist/query.d.ts +35 -0
  148. package/dist/query.js +49 -0
  149. package/dist/query.js.map +1 -0
  150. package/dist/query.mjs +48 -0
  151. package/dist/query.mjs.map +1 -0
  152. package/{lib/role.js → dist/role.d.mts} +18 -48
  153. package/dist/role.d.ts +72 -0
  154. package/dist/role.js +96 -0
  155. package/dist/role.js.map +1 -0
  156. package/dist/role.mjs +95 -0
  157. package/dist/role.mjs.map +1 -0
  158. package/dist/services/account.d.mts +478 -0
  159. package/dist/services/account.d.ts +478 -0
  160. package/dist/services/account.js +1331 -0
  161. package/dist/services/account.js.map +1 -0
  162. package/dist/services/account.mjs +1330 -0
  163. package/dist/services/account.mjs.map +1 -0
  164. package/dist/services/avatars.d.mts +118 -0
  165. package/dist/services/avatars.d.ts +118 -0
  166. package/dist/services/avatars.js +297 -0
  167. package/dist/services/avatars.js.map +1 -0
  168. package/dist/services/avatars.mjs +296 -0
  169. package/dist/services/avatars.mjs.map +1 -0
  170. package/dist/services/databases.d.mts +606 -0
  171. package/dist/services/databases.d.ts +606 -0
  172. package/dist/services/databases.js +1908 -0
  173. package/dist/services/databases.js.map +1 -0
  174. package/dist/services/databases.mjs +1907 -0
  175. package/dist/services/databases.mjs.map +1 -0
  176. package/dist/services/functions.d.mts +287 -0
  177. package/dist/services/functions.d.ts +287 -0
  178. package/dist/services/functions.js +837 -0
  179. package/dist/services/functions.js.map +1 -0
  180. package/dist/services/functions.mjs +836 -0
  181. package/dist/services/functions.mjs.map +1 -0
  182. package/dist/services/graphql.d.mts +30 -0
  183. package/dist/services/graphql.d.ts +30 -0
  184. package/dist/services/graphql.js +73 -0
  185. package/dist/services/graphql.js.map +1 -0
  186. package/dist/services/graphql.mjs +72 -0
  187. package/dist/services/graphql.mjs.map +1 -0
  188. package/dist/services/health.d.mts +235 -0
  189. package/dist/services/health.d.ts +235 -0
  190. package/dist/services/health.js +584 -0
  191. package/dist/services/health.js.map +1 -0
  192. package/dist/services/health.mjs +583 -0
  193. package/dist/services/health.mjs.map +1 -0
  194. package/dist/services/locale.d.mts +84 -0
  195. package/dist/services/locale.d.ts +84 -0
  196. package/dist/services/locale.js +189 -0
  197. package/dist/services/locale.js.map +1 -0
  198. package/dist/services/locale.mjs +188 -0
  199. package/dist/services/locale.mjs.map +1 -0
  200. package/dist/services/messaging.d.mts +689 -0
  201. package/dist/services/messaging.d.ts +689 -0
  202. package/dist/services/messaging.js +2156 -0
  203. package/dist/services/messaging.js.map +1 -0
  204. package/dist/services/messaging.mjs +2155 -0
  205. package/dist/services/messaging.mjs.map +1 -0
  206. package/dist/services/storage.d.mts +193 -0
  207. package/dist/services/storage.d.ts +193 -0
  208. package/dist/services/storage.js +550 -0
  209. package/dist/services/storage.js.map +1 -0
  210. package/dist/services/storage.mjs +549 -0
  211. package/dist/services/storage.mjs.map +1 -0
  212. package/dist/services/teams.d.mts +171 -0
  213. package/dist/services/teams.d.ts +171 -0
  214. package/dist/services/teams.js +466 -0
  215. package/dist/services/teams.js.map +1 -0
  216. package/dist/services/teams.mjs +465 -0
  217. package/dist/services/teams.mjs.map +1 -0
  218. package/dist/services/users.d.mts +491 -0
  219. package/dist/services/users.d.ts +491 -0
  220. package/dist/services/users.js +1465 -0
  221. package/dist/services/users.js.map +1 -0
  222. package/dist/services/users.mjs +1464 -0
  223. package/dist/services/users.mjs.map +1 -0
  224. package/package.json +39 -5
  225. package/.github/ISSUE_TEMPLATE/bug.yaml +0 -82
  226. package/.github/ISSUE_TEMPLATE/documentation.yaml +0 -32
  227. package/.github/ISSUE_TEMPLATE/feature.yaml +0 -40
  228. package/.travis.yml +0 -25
  229. package/CHANGELOG.md +0 -1
  230. package/docs/examples/account/create-anonymous-session.md +0 -9
  231. package/docs/examples/account/create-email-password-session.md +0 -12
  232. package/docs/examples/account/create-email-token.md +0 -13
  233. package/docs/examples/account/create-j-w-t.md +0 -9
  234. package/docs/examples/account/create-magic-u-r-l-token.md +0 -14
  235. package/docs/examples/account/create-mfa-authenticator.md +0 -12
  236. package/docs/examples/account/create-mfa-challenge.md +0 -11
  237. package/docs/examples/account/create-mfa-recovery-codes.md +0 -10
  238. package/docs/examples/account/create-o-auth2token.md +0 -14
  239. package/docs/examples/account/create-phone-token.md +0 -12
  240. package/docs/examples/account/create-phone-verification.md +0 -10
  241. package/docs/examples/account/create-recovery.md +0 -13
  242. package/docs/examples/account/create-session.md +0 -12
  243. package/docs/examples/account/create-verification.md +0 -12
  244. package/docs/examples/account/create.md +0 -14
  245. package/docs/examples/account/delete-identity.md +0 -12
  246. package/docs/examples/account/delete-mfa-authenticator.md +0 -13
  247. package/docs/examples/account/delete-session.md +0 -12
  248. package/docs/examples/account/delete-sessions.md +0 -10
  249. package/docs/examples/account/get-mfa-recovery-codes.md +0 -10
  250. package/docs/examples/account/get-prefs.md +0 -10
  251. package/docs/examples/account/get-session.md +0 -12
  252. package/docs/examples/account/get.md +0 -10
  253. package/docs/examples/account/list-identities.md +0 -12
  254. package/docs/examples/account/list-logs.md +0 -12
  255. package/docs/examples/account/list-mfa-factors.md +0 -10
  256. package/docs/examples/account/list-sessions.md +0 -10
  257. package/docs/examples/account/update-email.md +0 -13
  258. package/docs/examples/account/update-m-f-a.md +0 -12
  259. package/docs/examples/account/update-magic-u-r-l-session.md +0 -12
  260. package/docs/examples/account/update-mfa-authenticator.md +0 -13
  261. package/docs/examples/account/update-mfa-challenge.md +0 -13
  262. package/docs/examples/account/update-mfa-recovery-codes.md +0 -10
  263. package/docs/examples/account/update-name.md +0 -12
  264. package/docs/examples/account/update-password.md +0 -13
  265. package/docs/examples/account/update-phone-session.md +0 -12
  266. package/docs/examples/account/update-phone-verification.md +0 -13
  267. package/docs/examples/account/update-phone.md +0 -13
  268. package/docs/examples/account/update-prefs.md +0 -12
  269. package/docs/examples/account/update-recovery.md +0 -14
  270. package/docs/examples/account/update-session.md +0 -12
  271. package/docs/examples/account/update-status.md +0 -10
  272. package/docs/examples/account/update-verification.md +0 -13
  273. package/docs/examples/avatars/get-browser.md +0 -15
  274. package/docs/examples/avatars/get-credit-card.md +0 -15
  275. package/docs/examples/avatars/get-favicon.md +0 -12
  276. package/docs/examples/avatars/get-flag.md +0 -15
  277. package/docs/examples/avatars/get-image.md +0 -14
  278. package/docs/examples/avatars/get-initials.md +0 -15
  279. package/docs/examples/avatars/get-q-r.md +0 -15
  280. package/docs/examples/databases/create-boolean-attribute.md +0 -17
  281. package/docs/examples/databases/create-collection.md +0 -17
  282. package/docs/examples/databases/create-datetime-attribute.md +0 -17
  283. package/docs/examples/databases/create-document.md +0 -16
  284. package/docs/examples/databases/create-email-attribute.md +0 -17
  285. package/docs/examples/databases/create-enum-attribute.md +0 -18
  286. package/docs/examples/databases/create-float-attribute.md +0 -19
  287. package/docs/examples/databases/create-index.md +0 -17
  288. package/docs/examples/databases/create-integer-attribute.md +0 -19
  289. package/docs/examples/databases/create-ip-attribute.md +0 -17
  290. package/docs/examples/databases/create-relationship-attribute.md +0 -19
  291. package/docs/examples/databases/create-string-attribute.md +0 -19
  292. package/docs/examples/databases/create-url-attribute.md +0 -17
  293. package/docs/examples/databases/create.md +0 -14
  294. package/docs/examples/databases/delete-attribute.md +0 -14
  295. package/docs/examples/databases/delete-collection.md +0 -13
  296. package/docs/examples/databases/delete-document.md +0 -14
  297. package/docs/examples/databases/delete-index.md +0 -14
  298. package/docs/examples/databases/delete.md +0 -12
  299. package/docs/examples/databases/get-attribute.md +0 -14
  300. package/docs/examples/databases/get-collection.md +0 -13
  301. package/docs/examples/databases/get-document.md +0 -15
  302. package/docs/examples/databases/get-index.md +0 -14
  303. package/docs/examples/databases/get.md +0 -12
  304. package/docs/examples/databases/list-attributes.md +0 -14
  305. package/docs/examples/databases/list-collections.md +0 -14
  306. package/docs/examples/databases/list-documents.md +0 -14
  307. package/docs/examples/databases/list-indexes.md +0 -14
  308. package/docs/examples/databases/list.md +0 -13
  309. package/docs/examples/databases/update-boolean-attribute.md +0 -16
  310. package/docs/examples/databases/update-collection.md +0 -17
  311. package/docs/examples/databases/update-datetime-attribute.md +0 -16
  312. package/docs/examples/databases/update-document.md +0 -16
  313. package/docs/examples/databases/update-email-attribute.md +0 -16
  314. package/docs/examples/databases/update-enum-attribute.md +0 -17
  315. package/docs/examples/databases/update-float-attribute.md +0 -18
  316. package/docs/examples/databases/update-integer-attribute.md +0 -18
  317. package/docs/examples/databases/update-ip-attribute.md +0 -16
  318. package/docs/examples/databases/update-relationship-attribute.md +0 -15
  319. package/docs/examples/databases/update-string-attribute.md +0 -16
  320. package/docs/examples/databases/update-url-attribute.md +0 -16
  321. package/docs/examples/databases/update.md +0 -14
  322. package/docs/examples/functions/create-build.md +0 -14
  323. package/docs/examples/functions/create-deployment.md +0 -17
  324. package/docs/examples/functions/create-execution.md +0 -17
  325. package/docs/examples/functions/create-variable.md +0 -14
  326. package/docs/examples/functions/create.md +0 -31
  327. package/docs/examples/functions/delete-deployment.md +0 -13
  328. package/docs/examples/functions/delete-variable.md +0 -13
  329. package/docs/examples/functions/delete.md +0 -12
  330. package/docs/examples/functions/download-deployment.md +0 -13
  331. package/docs/examples/functions/get-deployment.md +0 -13
  332. package/docs/examples/functions/get-execution.md +0 -13
  333. package/docs/examples/functions/get-variable.md +0 -13
  334. package/docs/examples/functions/get.md +0 -12
  335. package/docs/examples/functions/list-deployments.md +0 -14
  336. package/docs/examples/functions/list-executions.md +0 -14
  337. package/docs/examples/functions/list-runtimes.md +0 -10
  338. package/docs/examples/functions/list-variables.md +0 -12
  339. package/docs/examples/functions/list.md +0 -13
  340. package/docs/examples/functions/update-deployment.md +0 -13
  341. package/docs/examples/functions/update-variable.md +0 -15
  342. package/docs/examples/functions/update.md +0 -27
  343. package/docs/examples/graphql/mutation.md +0 -12
  344. package/docs/examples/graphql/query.md +0 -12
  345. package/docs/examples/health/get-antivirus.md +0 -10
  346. package/docs/examples/health/get-cache.md +0 -10
  347. package/docs/examples/health/get-certificate.md +0 -12
  348. package/docs/examples/health/get-d-b.md +0 -10
  349. package/docs/examples/health/get-failed-jobs.md +0 -13
  350. package/docs/examples/health/get-pub-sub.md +0 -10
  351. package/docs/examples/health/get-queue-builds.md +0 -12
  352. package/docs/examples/health/get-queue-certificates.md +0 -12
  353. package/docs/examples/health/get-queue-databases.md +0 -13
  354. package/docs/examples/health/get-queue-deletes.md +0 -12
  355. package/docs/examples/health/get-queue-functions.md +0 -12
  356. package/docs/examples/health/get-queue-logs.md +0 -12
  357. package/docs/examples/health/get-queue-mails.md +0 -12
  358. package/docs/examples/health/get-queue-messaging.md +0 -12
  359. package/docs/examples/health/get-queue-migrations.md +0 -12
  360. package/docs/examples/health/get-queue-usage-dump.md +0 -12
  361. package/docs/examples/health/get-queue-usage.md +0 -12
  362. package/docs/examples/health/get-queue-webhooks.md +0 -12
  363. package/docs/examples/health/get-queue.md +0 -10
  364. package/docs/examples/health/get-storage-local.md +0 -10
  365. package/docs/examples/health/get-storage.md +0 -10
  366. package/docs/examples/health/get-time.md +0 -10
  367. package/docs/examples/health/get.md +0 -10
  368. package/docs/examples/locale/get.md +0 -10
  369. package/docs/examples/locale/list-codes.md +0 -10
  370. package/docs/examples/locale/list-continents.md +0 -10
  371. package/docs/examples/locale/list-countries-e-u.md +0 -10
  372. package/docs/examples/locale/list-countries-phones.md +0 -10
  373. package/docs/examples/locale/list-countries.md +0 -10
  374. package/docs/examples/locale/list-currencies.md +0 -10
  375. package/docs/examples/locale/list-languages.md +0 -10
  376. package/docs/examples/messaging/create-apns-provider.md +0 -19
  377. package/docs/examples/messaging/create-email.md +0 -23
  378. package/docs/examples/messaging/create-fcm-provider.md +0 -15
  379. package/docs/examples/messaging/create-mailgun-provider.md +0 -21
  380. package/docs/examples/messaging/create-msg91provider.md +0 -17
  381. package/docs/examples/messaging/create-push.md +0 -27
  382. package/docs/examples/messaging/create-sendgrid-provider.md +0 -19
  383. package/docs/examples/messaging/create-sms.md +0 -18
  384. package/docs/examples/messaging/create-smtp-provider.md +0 -25
  385. package/docs/examples/messaging/create-subscriber.md +0 -14
  386. package/docs/examples/messaging/create-telesign-provider.md +0 -17
  387. package/docs/examples/messaging/create-textmagic-provider.md +0 -17
  388. package/docs/examples/messaging/create-topic.md +0 -14
  389. package/docs/examples/messaging/create-twilio-provider.md +0 -17
  390. package/docs/examples/messaging/create-vonage-provider.md +0 -17
  391. package/docs/examples/messaging/delete-provider.md +0 -12
  392. package/docs/examples/messaging/delete-subscriber.md +0 -13
  393. package/docs/examples/messaging/delete-topic.md +0 -12
  394. package/docs/examples/messaging/delete.md +0 -12
  395. package/docs/examples/messaging/get-message.md +0 -12
  396. package/docs/examples/messaging/get-provider.md +0 -12
  397. package/docs/examples/messaging/get-subscriber.md +0 -13
  398. package/docs/examples/messaging/get-topic.md +0 -12
  399. package/docs/examples/messaging/list-message-logs.md +0 -13
  400. package/docs/examples/messaging/list-messages.md +0 -13
  401. package/docs/examples/messaging/list-provider-logs.md +0 -13
  402. package/docs/examples/messaging/list-providers.md +0 -13
  403. package/docs/examples/messaging/list-subscriber-logs.md +0 -13
  404. package/docs/examples/messaging/list-subscribers.md +0 -14
  405. package/docs/examples/messaging/list-targets.md +0 -13
  406. package/docs/examples/messaging/list-topic-logs.md +0 -13
  407. package/docs/examples/messaging/list-topics.md +0 -13
  408. package/docs/examples/messaging/update-apns-provider.md +0 -19
  409. package/docs/examples/messaging/update-email.md +0 -22
  410. package/docs/examples/messaging/update-fcm-provider.md +0 -15
  411. package/docs/examples/messaging/update-mailgun-provider.md +0 -21
  412. package/docs/examples/messaging/update-msg91provider.md +0 -17
  413. package/docs/examples/messaging/update-push.md +0 -27
  414. package/docs/examples/messaging/update-sendgrid-provider.md +0 -19
  415. package/docs/examples/messaging/update-sms.md +0 -18
  416. package/docs/examples/messaging/update-smtp-provider.md +0 -25
  417. package/docs/examples/messaging/update-telesign-provider.md +0 -17
  418. package/docs/examples/messaging/update-textmagic-provider.md +0 -17
  419. package/docs/examples/messaging/update-topic.md +0 -14
  420. package/docs/examples/messaging/update-twilio-provider.md +0 -17
  421. package/docs/examples/messaging/update-vonage-provider.md +0 -17
  422. package/docs/examples/storage/create-bucket.md +0 -21
  423. package/docs/examples/storage/create-file.md +0 -16
  424. package/docs/examples/storage/delete-bucket.md +0 -12
  425. package/docs/examples/storage/delete-file.md +0 -13
  426. package/docs/examples/storage/get-bucket.md +0 -12
  427. package/docs/examples/storage/get-file-download.md +0 -13
  428. package/docs/examples/storage/get-file-preview.md +0 -24
  429. package/docs/examples/storage/get-file-view.md +0 -13
  430. package/docs/examples/storage/get-file.md +0 -13
  431. package/docs/examples/storage/list-buckets.md +0 -13
  432. package/docs/examples/storage/list-files.md +0 -14
  433. package/docs/examples/storage/update-bucket.md +0 -21
  434. package/docs/examples/storage/update-file.md +0 -15
  435. package/docs/examples/teams/create-membership.md +0 -18
  436. package/docs/examples/teams/create.md +0 -14
  437. package/docs/examples/teams/delete-membership.md +0 -13
  438. package/docs/examples/teams/delete.md +0 -12
  439. package/docs/examples/teams/get-membership.md +0 -13
  440. package/docs/examples/teams/get-prefs.md +0 -12
  441. package/docs/examples/teams/get.md +0 -12
  442. package/docs/examples/teams/list-memberships.md +0 -14
  443. package/docs/examples/teams/list.md +0 -13
  444. package/docs/examples/teams/update-membership-status.md +0 -15
  445. package/docs/examples/teams/update-membership.md +0 -14
  446. package/docs/examples/teams/update-name.md +0 -13
  447. package/docs/examples/teams/update-prefs.md +0 -13
  448. package/docs/examples/users/create-argon2user.md +0 -15
  449. package/docs/examples/users/create-bcrypt-user.md +0 -15
  450. package/docs/examples/users/create-m-d5user.md +0 -15
  451. package/docs/examples/users/create-mfa-recovery-codes.md +0 -12
  452. package/docs/examples/users/create-p-h-pass-user.md +0 -15
  453. package/docs/examples/users/create-s-h-a-user.md +0 -16
  454. package/docs/examples/users/create-scrypt-modified-user.md +0 -18
  455. package/docs/examples/users/create-scrypt-user.md +0 -20
  456. package/docs/examples/users/create-session.md +0 -12
  457. package/docs/examples/users/create-target.md +0 -17
  458. package/docs/examples/users/create-token.md +0 -14
  459. package/docs/examples/users/create.md +0 -16
  460. package/docs/examples/users/delete-identity.md +0 -12
  461. package/docs/examples/users/delete-mfa-authenticator.md +0 -13
  462. package/docs/examples/users/delete-session.md +0 -13
  463. package/docs/examples/users/delete-sessions.md +0 -12
  464. package/docs/examples/users/delete-target.md +0 -13
  465. package/docs/examples/users/delete.md +0 -12
  466. package/docs/examples/users/get-mfa-recovery-codes.md +0 -12
  467. package/docs/examples/users/get-prefs.md +0 -12
  468. package/docs/examples/users/get-target.md +0 -13
  469. package/docs/examples/users/get.md +0 -12
  470. package/docs/examples/users/list-identities.md +0 -13
  471. package/docs/examples/users/list-logs.md +0 -13
  472. package/docs/examples/users/list-memberships.md +0 -12
  473. package/docs/examples/users/list-mfa-factors.md +0 -12
  474. package/docs/examples/users/list-sessions.md +0 -12
  475. package/docs/examples/users/list-targets.md +0 -13
  476. package/docs/examples/users/list.md +0 -13
  477. package/docs/examples/users/update-email-verification.md +0 -13
  478. package/docs/examples/users/update-email.md +0 -13
  479. package/docs/examples/users/update-labels.md +0 -13
  480. package/docs/examples/users/update-mfa-recovery-codes.md +0 -12
  481. package/docs/examples/users/update-mfa.md +0 -13
  482. package/docs/examples/users/update-name.md +0 -13
  483. package/docs/examples/users/update-password.md +0 -13
  484. package/docs/examples/users/update-phone-verification.md +0 -13
  485. package/docs/examples/users/update-phone.md +0 -13
  486. package/docs/examples/users/update-prefs.md +0 -13
  487. package/docs/examples/users/update-status.md +0 -13
  488. package/docs/examples/users/update-target.md +0 -16
  489. package/index.d.ts +0 -6656
  490. package/index.js +0 -75
  491. package/lib/client.js +0 -245
  492. package/lib/enums/authentication-factor.js +0 -8
  493. package/lib/enums/authenticator-type.js +0 -5
  494. package/lib/enums/browser.js +0 -18
  495. package/lib/enums/compression.js +0 -7
  496. package/lib/enums/credit-card.js +0 -20
  497. package/lib/enums/execution-method.js +0 -10
  498. package/lib/enums/flag.js +0 -198
  499. package/lib/enums/image-format.js +0 -9
  500. package/lib/enums/image-gravity.js +0 -13
  501. package/lib/enums/index-type.js +0 -7
  502. package/lib/enums/messaging-provider-type.js +0 -7
  503. package/lib/enums/name.js +0 -17
  504. package/lib/enums/o-auth-provider.js +0 -43
  505. package/lib/enums/password-hash.js +0 -15
  506. package/lib/enums/relation-mutate.js +0 -7
  507. package/lib/enums/relationship-type.js +0 -8
  508. package/lib/enums/runtime.js +0 -48
  509. package/lib/enums/smtp-encryption.js +0 -7
  510. package/lib/exception.js +0 -10
  511. package/lib/id.js +0 -32
  512. package/lib/inputFile.js +0 -117
  513. package/lib/permission.js +0 -24
  514. package/lib/query.js +0 -90
  515. package/lib/service.js +0 -10
  516. package/lib/services/account.js +0 -1365
  517. package/lib/services/avatars.js +0 -325
  518. package/lib/services/databases.js +0 -1987
  519. package/lib/services/functions.js +0 -930
  520. package/lib/services/graphql.js +0 -74
  521. package/lib/services/health.js +0 -513
  522. package/lib/services/locale.js +0 -169
  523. package/lib/services/messaging.js +0 -2218
  524. package/lib/services/storage.js +0 -663
  525. package/lib/services/teams.js +0 -479
  526. package/lib/services/users.js +0 -1463
@@ -0,0 +1,1331 @@
1
+ 'use strict';
2
+
3
+ var client = require('../client');
4
+
5
+ class Account {
6
+ constructor(client) {
7
+ this.client = client;
8
+ }
9
+ /**
10
+ * Get account
11
+ *
12
+ * Get the currently logged in user.
13
+ *
14
+ * @throws {AppwriteException}
15
+ * @returns {Promise<Models.User<Preferences>>}
16
+ */
17
+ async get() {
18
+ const apiPath = "/account";
19
+ const payload = {};
20
+ const uri = new URL(this.client.config.endpoint + apiPath);
21
+ const apiHeaders = {
22
+ "content-type": "application/json"
23
+ };
24
+ return await this.client.call(
25
+ "get",
26
+ uri,
27
+ apiHeaders,
28
+ payload
29
+ );
30
+ }
31
+ /**
32
+ * Create account
33
+ *
34
+ * Use this endpoint to allow a new user to register a new account in your project. After the user registration completes successfully, you can use the [/account/verfication](https://appwrite.io/docs/references/cloud/client-web/account#createVerification) route to start verifying the user email address. To allow the new user to login to their new account, you need to create a new [account session](https://appwrite.io/docs/references/cloud/client-web/account#createEmailSession).
35
+ *
36
+ * @param {string} userId
37
+ * @param {string} email
38
+ * @param {string} password
39
+ * @param {string} name
40
+ * @throws {AppwriteException}
41
+ * @returns {Promise<Models.User<Preferences>>}
42
+ */
43
+ async create(userId, email, password, name) {
44
+ if (typeof userId === "undefined") {
45
+ throw new client.AppwriteException('Missing required parameter: "userId"');
46
+ }
47
+ if (typeof email === "undefined") {
48
+ throw new client.AppwriteException('Missing required parameter: "email"');
49
+ }
50
+ if (typeof password === "undefined") {
51
+ throw new client.AppwriteException('Missing required parameter: "password"');
52
+ }
53
+ const apiPath = "/account";
54
+ const payload = {};
55
+ if (typeof userId !== "undefined") {
56
+ payload["userId"] = userId;
57
+ }
58
+ if (typeof email !== "undefined") {
59
+ payload["email"] = email;
60
+ }
61
+ if (typeof password !== "undefined") {
62
+ payload["password"] = password;
63
+ }
64
+ if (typeof name !== "undefined") {
65
+ payload["name"] = name;
66
+ }
67
+ const uri = new URL(this.client.config.endpoint + apiPath);
68
+ const apiHeaders = {
69
+ "content-type": "application/json"
70
+ };
71
+ return await this.client.call(
72
+ "post",
73
+ uri,
74
+ apiHeaders,
75
+ payload
76
+ );
77
+ }
78
+ /**
79
+ * Update email
80
+ *
81
+ * Update currently logged in user account email address. After changing user address, the user confirmation status will get reset. A new confirmation email is not sent automatically however you can use the send confirmation email endpoint again to send the confirmation email. For security measures, user password is required to complete this request.
82
+ This endpoint can also be used to convert an anonymous account to a normal one, by passing an email address and a new password.
83
+
84
+ *
85
+ * @param {string} email
86
+ * @param {string} password
87
+ * @throws {AppwriteException}
88
+ * @returns {Promise<Models.User<Preferences>>}
89
+ */
90
+ async updateEmail(email, password) {
91
+ if (typeof email === "undefined") {
92
+ throw new client.AppwriteException('Missing required parameter: "email"');
93
+ }
94
+ if (typeof password === "undefined") {
95
+ throw new client.AppwriteException('Missing required parameter: "password"');
96
+ }
97
+ const apiPath = "/account/email";
98
+ const payload = {};
99
+ if (typeof email !== "undefined") {
100
+ payload["email"] = email;
101
+ }
102
+ if (typeof password !== "undefined") {
103
+ payload["password"] = password;
104
+ }
105
+ const uri = new URL(this.client.config.endpoint + apiPath);
106
+ const apiHeaders = {
107
+ "content-type": "application/json"
108
+ };
109
+ return await this.client.call(
110
+ "patch",
111
+ uri,
112
+ apiHeaders,
113
+ payload
114
+ );
115
+ }
116
+ /**
117
+ * List Identities
118
+ *
119
+ * Get the list of identities for the currently logged in user.
120
+ *
121
+ * @param {string[]} queries
122
+ * @throws {AppwriteException}
123
+ * @returns {Promise<Models.IdentityList>}
124
+ */
125
+ async listIdentities(queries) {
126
+ const apiPath = "/account/identities";
127
+ const payload = {};
128
+ if (typeof queries !== "undefined") {
129
+ payload["queries"] = queries;
130
+ }
131
+ const uri = new URL(this.client.config.endpoint + apiPath);
132
+ const apiHeaders = {
133
+ "content-type": "application/json"
134
+ };
135
+ return await this.client.call(
136
+ "get",
137
+ uri,
138
+ apiHeaders,
139
+ payload
140
+ );
141
+ }
142
+ /**
143
+ * Delete identity
144
+ *
145
+ * Delete an identity by its unique ID.
146
+ *
147
+ * @param {string} identityId
148
+ * @throws {AppwriteException}
149
+ * @returns {Promise<{}>}
150
+ */
151
+ async deleteIdentity(identityId) {
152
+ if (typeof identityId === "undefined") {
153
+ throw new client.AppwriteException('Missing required parameter: "identityId"');
154
+ }
155
+ const apiPath = "/account/identities/{identityId}".replace("{identityId}", identityId);
156
+ const payload = {};
157
+ const uri = new URL(this.client.config.endpoint + apiPath);
158
+ const apiHeaders = {
159
+ "content-type": "application/json"
160
+ };
161
+ return await this.client.call(
162
+ "delete",
163
+ uri,
164
+ apiHeaders,
165
+ payload
166
+ );
167
+ }
168
+ /**
169
+ * Create JWT
170
+ *
171
+ * Use this endpoint to create a JSON Web Token. You can use the resulting JWT to authenticate on behalf of the current user when working with the Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes from its creation and will be invalid if the user will logout in that time frame.
172
+ *
173
+ * @throws {AppwriteException}
174
+ * @returns {Promise<Models.Jwt>}
175
+ */
176
+ async createJWT() {
177
+ const apiPath = "/account/jwt";
178
+ const payload = {};
179
+ const uri = new URL(this.client.config.endpoint + apiPath);
180
+ const apiHeaders = {
181
+ "content-type": "application/json"
182
+ };
183
+ return await this.client.call(
184
+ "post",
185
+ uri,
186
+ apiHeaders,
187
+ payload
188
+ );
189
+ }
190
+ /**
191
+ * List logs
192
+ *
193
+ * Get the list of latest security activity logs for the currently logged in user. Each log returns user IP address, location and date and time of log.
194
+ *
195
+ * @param {string[]} queries
196
+ * @throws {AppwriteException}
197
+ * @returns {Promise<Models.LogList>}
198
+ */
199
+ async listLogs(queries) {
200
+ const apiPath = "/account/logs";
201
+ const payload = {};
202
+ if (typeof queries !== "undefined") {
203
+ payload["queries"] = queries;
204
+ }
205
+ const uri = new URL(this.client.config.endpoint + apiPath);
206
+ const apiHeaders = {
207
+ "content-type": "application/json"
208
+ };
209
+ return await this.client.call(
210
+ "get",
211
+ uri,
212
+ apiHeaders,
213
+ payload
214
+ );
215
+ }
216
+ /**
217
+ * Update MFA
218
+ *
219
+ * Enable or disable MFA on an account.
220
+ *
221
+ * @param {boolean} mfa
222
+ * @throws {AppwriteException}
223
+ * @returns {Promise<Models.User<Preferences>>}
224
+ */
225
+ async updateMFA(mfa) {
226
+ if (typeof mfa === "undefined") {
227
+ throw new client.AppwriteException('Missing required parameter: "mfa"');
228
+ }
229
+ const apiPath = "/account/mfa";
230
+ const payload = {};
231
+ if (typeof mfa !== "undefined") {
232
+ payload["mfa"] = mfa;
233
+ }
234
+ const uri = new URL(this.client.config.endpoint + apiPath);
235
+ const apiHeaders = {
236
+ "content-type": "application/json"
237
+ };
238
+ return await this.client.call(
239
+ "patch",
240
+ uri,
241
+ apiHeaders,
242
+ payload
243
+ );
244
+ }
245
+ /**
246
+ * Add Authenticator
247
+ *
248
+ * Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](/docs/references/cloud/client-web/account#updateMfaAuthenticator) method.
249
+ *
250
+ * @param {AuthenticatorType} type
251
+ * @throws {AppwriteException}
252
+ * @returns {Promise<Models.MfaType>}
253
+ */
254
+ async createMfaAuthenticator(type) {
255
+ if (typeof type === "undefined") {
256
+ throw new client.AppwriteException('Missing required parameter: "type"');
257
+ }
258
+ const apiPath = "/account/mfa/authenticators/{type}".replace("{type}", type);
259
+ const payload = {};
260
+ const uri = new URL(this.client.config.endpoint + apiPath);
261
+ const apiHeaders = {
262
+ "content-type": "application/json"
263
+ };
264
+ return await this.client.call(
265
+ "post",
266
+ uri,
267
+ apiHeaders,
268
+ payload
269
+ );
270
+ }
271
+ /**
272
+ * Verify Authenticator
273
+ *
274
+ * Verify an authenticator app after adding it using the [add authenticator](/docs/references/cloud/client-web/account#createMfaAuthenticator) method. add
275
+ *
276
+ * @param {AuthenticatorType} type
277
+ * @param {string} otp
278
+ * @throws {AppwriteException}
279
+ * @returns {Promise<Models.User<Preferences>>}
280
+ */
281
+ async updateMfaAuthenticator(type, otp) {
282
+ if (typeof type === "undefined") {
283
+ throw new client.AppwriteException('Missing required parameter: "type"');
284
+ }
285
+ if (typeof otp === "undefined") {
286
+ throw new client.AppwriteException('Missing required parameter: "otp"');
287
+ }
288
+ const apiPath = "/account/mfa/authenticators/{type}".replace("{type}", type);
289
+ const payload = {};
290
+ if (typeof otp !== "undefined") {
291
+ payload["otp"] = otp;
292
+ }
293
+ const uri = new URL(this.client.config.endpoint + apiPath);
294
+ const apiHeaders = {
295
+ "content-type": "application/json"
296
+ };
297
+ return await this.client.call(
298
+ "put",
299
+ uri,
300
+ apiHeaders,
301
+ payload
302
+ );
303
+ }
304
+ /**
305
+ * Delete Authenticator
306
+ *
307
+ * Delete an authenticator for a user by ID.
308
+ *
309
+ * @param {AuthenticatorType} type
310
+ * @param {string} otp
311
+ * @throws {AppwriteException}
312
+ * @returns {Promise<{}>}
313
+ */
314
+ async deleteMfaAuthenticator(type, otp) {
315
+ if (typeof type === "undefined") {
316
+ throw new client.AppwriteException('Missing required parameter: "type"');
317
+ }
318
+ if (typeof otp === "undefined") {
319
+ throw new client.AppwriteException('Missing required parameter: "otp"');
320
+ }
321
+ const apiPath = "/account/mfa/authenticators/{type}".replace("{type}", type);
322
+ const payload = {};
323
+ if (typeof otp !== "undefined") {
324
+ payload["otp"] = otp;
325
+ }
326
+ const uri = new URL(this.client.config.endpoint + apiPath);
327
+ const apiHeaders = {
328
+ "content-type": "application/json"
329
+ };
330
+ return await this.client.call(
331
+ "delete",
332
+ uri,
333
+ apiHeaders,
334
+ payload
335
+ );
336
+ }
337
+ /**
338
+ * Create 2FA Challenge
339
+ *
340
+ * Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge) method.
341
+ *
342
+ * @param {AuthenticationFactor} factor
343
+ * @throws {AppwriteException}
344
+ * @returns {Promise<Models.MfaChallenge>}
345
+ */
346
+ async createMfaChallenge(factor) {
347
+ if (typeof factor === "undefined") {
348
+ throw new client.AppwriteException('Missing required parameter: "factor"');
349
+ }
350
+ const apiPath = "/account/mfa/challenge";
351
+ const payload = {};
352
+ if (typeof factor !== "undefined") {
353
+ payload["factor"] = factor;
354
+ }
355
+ const uri = new URL(this.client.config.endpoint + apiPath);
356
+ const apiHeaders = {
357
+ "content-type": "application/json"
358
+ };
359
+ return await this.client.call(
360
+ "post",
361
+ uri,
362
+ apiHeaders,
363
+ payload
364
+ );
365
+ }
366
+ /**
367
+ * Create MFA Challenge (confirmation)
368
+ *
369
+ * Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) method.
370
+ *
371
+ * @param {string} challengeId
372
+ * @param {string} otp
373
+ * @throws {AppwriteException}
374
+ * @returns {Promise<{}>}
375
+ */
376
+ async updateMfaChallenge(challengeId, otp) {
377
+ if (typeof challengeId === "undefined") {
378
+ throw new client.AppwriteException('Missing required parameter: "challengeId"');
379
+ }
380
+ if (typeof otp === "undefined") {
381
+ throw new client.AppwriteException('Missing required parameter: "otp"');
382
+ }
383
+ const apiPath = "/account/mfa/challenge";
384
+ const payload = {};
385
+ if (typeof challengeId !== "undefined") {
386
+ payload["challengeId"] = challengeId;
387
+ }
388
+ if (typeof otp !== "undefined") {
389
+ payload["otp"] = otp;
390
+ }
391
+ const uri = new URL(this.client.config.endpoint + apiPath);
392
+ const apiHeaders = {
393
+ "content-type": "application/json"
394
+ };
395
+ return await this.client.call(
396
+ "put",
397
+ uri,
398
+ apiHeaders,
399
+ payload
400
+ );
401
+ }
402
+ /**
403
+ * List Factors
404
+ *
405
+ * List the factors available on the account to be used as a MFA challange.
406
+ *
407
+ * @throws {AppwriteException}
408
+ * @returns {Promise<Models.MfaFactors>}
409
+ */
410
+ async listMfaFactors() {
411
+ const apiPath = "/account/mfa/factors";
412
+ const payload = {};
413
+ const uri = new URL(this.client.config.endpoint + apiPath);
414
+ const apiHeaders = {
415
+ "content-type": "application/json"
416
+ };
417
+ return await this.client.call(
418
+ "get",
419
+ uri,
420
+ apiHeaders,
421
+ payload
422
+ );
423
+ }
424
+ /**
425
+ * Get MFA Recovery Codes
426
+ *
427
+ * Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) method. An OTP challenge is required to read recovery codes.
428
+ *
429
+ * @throws {AppwriteException}
430
+ * @returns {Promise<Models.MfaRecoveryCodes>}
431
+ */
432
+ async getMfaRecoveryCodes() {
433
+ const apiPath = "/account/mfa/recovery-codes";
434
+ const payload = {};
435
+ const uri = new URL(this.client.config.endpoint + apiPath);
436
+ const apiHeaders = {
437
+ "content-type": "application/json"
438
+ };
439
+ return await this.client.call(
440
+ "get",
441
+ uri,
442
+ apiHeaders,
443
+ payload
444
+ );
445
+ }
446
+ /**
447
+ * Create MFA Recovery Codes
448
+ *
449
+ * Generate recovery codes as backup for MFA flow. It&#039;s recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) method.
450
+ *
451
+ * @throws {AppwriteException}
452
+ * @returns {Promise<Models.MfaRecoveryCodes>}
453
+ */
454
+ async createMfaRecoveryCodes() {
455
+ const apiPath = "/account/mfa/recovery-codes";
456
+ const payload = {};
457
+ const uri = new URL(this.client.config.endpoint + apiPath);
458
+ const apiHeaders = {
459
+ "content-type": "application/json"
460
+ };
461
+ return await this.client.call(
462
+ "post",
463
+ uri,
464
+ apiHeaders,
465
+ payload
466
+ );
467
+ }
468
+ /**
469
+ * Regenerate MFA Recovery Codes
470
+ *
471
+ * Regenerate recovery codes that can be used as backup for MFA flow. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) method. An OTP challenge is required to regenreate recovery codes.
472
+ *
473
+ * @throws {AppwriteException}
474
+ * @returns {Promise<Models.MfaRecoveryCodes>}
475
+ */
476
+ async updateMfaRecoveryCodes() {
477
+ const apiPath = "/account/mfa/recovery-codes";
478
+ const payload = {};
479
+ const uri = new URL(this.client.config.endpoint + apiPath);
480
+ const apiHeaders = {
481
+ "content-type": "application/json"
482
+ };
483
+ return await this.client.call(
484
+ "patch",
485
+ uri,
486
+ apiHeaders,
487
+ payload
488
+ );
489
+ }
490
+ /**
491
+ * Update name
492
+ *
493
+ * Update currently logged in user account name.
494
+ *
495
+ * @param {string} name
496
+ * @throws {AppwriteException}
497
+ * @returns {Promise<Models.User<Preferences>>}
498
+ */
499
+ async updateName(name) {
500
+ if (typeof name === "undefined") {
501
+ throw new client.AppwriteException('Missing required parameter: "name"');
502
+ }
503
+ const apiPath = "/account/name";
504
+ const payload = {};
505
+ if (typeof name !== "undefined") {
506
+ payload["name"] = name;
507
+ }
508
+ const uri = new URL(this.client.config.endpoint + apiPath);
509
+ const apiHeaders = {
510
+ "content-type": "application/json"
511
+ };
512
+ return await this.client.call(
513
+ "patch",
514
+ uri,
515
+ apiHeaders,
516
+ payload
517
+ );
518
+ }
519
+ /**
520
+ * Update password
521
+ *
522
+ * Update currently logged in user password. For validation, user is required to pass in the new password, and the old password. For users created with OAuth, Team Invites and Magic URL, oldPassword is optional.
523
+ *
524
+ * @param {string} password
525
+ * @param {string} oldPassword
526
+ * @throws {AppwriteException}
527
+ * @returns {Promise<Models.User<Preferences>>}
528
+ */
529
+ async updatePassword(password, oldPassword) {
530
+ if (typeof password === "undefined") {
531
+ throw new client.AppwriteException('Missing required parameter: "password"');
532
+ }
533
+ const apiPath = "/account/password";
534
+ const payload = {};
535
+ if (typeof password !== "undefined") {
536
+ payload["password"] = password;
537
+ }
538
+ if (typeof oldPassword !== "undefined") {
539
+ payload["oldPassword"] = oldPassword;
540
+ }
541
+ const uri = new URL(this.client.config.endpoint + apiPath);
542
+ const apiHeaders = {
543
+ "content-type": "application/json"
544
+ };
545
+ return await this.client.call(
546
+ "patch",
547
+ uri,
548
+ apiHeaders,
549
+ payload
550
+ );
551
+ }
552
+ /**
553
+ * Update phone
554
+ *
555
+ * Update the currently logged in user&#039;s phone number. After updating the phone number, the phone verification status will be reset. A confirmation SMS is not sent automatically, however you can use the [POST /account/verification/phone](https://appwrite.io/docs/references/cloud/client-web/account#createPhoneVerification) endpoint to send a confirmation SMS.
556
+ *
557
+ * @param {string} phone
558
+ * @param {string} password
559
+ * @throws {AppwriteException}
560
+ * @returns {Promise<Models.User<Preferences>>}
561
+ */
562
+ async updatePhone(phone, password) {
563
+ if (typeof phone === "undefined") {
564
+ throw new client.AppwriteException('Missing required parameter: "phone"');
565
+ }
566
+ if (typeof password === "undefined") {
567
+ throw new client.AppwriteException('Missing required parameter: "password"');
568
+ }
569
+ const apiPath = "/account/phone";
570
+ const payload = {};
571
+ if (typeof phone !== "undefined") {
572
+ payload["phone"] = phone;
573
+ }
574
+ if (typeof password !== "undefined") {
575
+ payload["password"] = password;
576
+ }
577
+ const uri = new URL(this.client.config.endpoint + apiPath);
578
+ const apiHeaders = {
579
+ "content-type": "application/json"
580
+ };
581
+ return await this.client.call(
582
+ "patch",
583
+ uri,
584
+ apiHeaders,
585
+ payload
586
+ );
587
+ }
588
+ /**
589
+ * Get account preferences
590
+ *
591
+ * Get the preferences as a key-value object for the currently logged in user.
592
+ *
593
+ * @throws {AppwriteException}
594
+ * @returns {Promise<Preferences>}
595
+ */
596
+ async getPrefs() {
597
+ const apiPath = "/account/prefs";
598
+ const payload = {};
599
+ const uri = new URL(this.client.config.endpoint + apiPath);
600
+ const apiHeaders = {
601
+ "content-type": "application/json"
602
+ };
603
+ return await this.client.call(
604
+ "get",
605
+ uri,
606
+ apiHeaders,
607
+ payload
608
+ );
609
+ }
610
+ /**
611
+ * Update preferences
612
+ *
613
+ * Update currently logged in user account preferences. The object you pass is stored as is, and replaces any previous value. The maximum allowed prefs size is 64kB and throws error if exceeded.
614
+ *
615
+ * @param {Partial<Preferences>} prefs
616
+ * @throws {AppwriteException}
617
+ * @returns {Promise<Models.User<Preferences>>}
618
+ */
619
+ async updatePrefs(prefs) {
620
+ if (typeof prefs === "undefined") {
621
+ throw new client.AppwriteException('Missing required parameter: "prefs"');
622
+ }
623
+ const apiPath = "/account/prefs";
624
+ const payload = {};
625
+ if (typeof prefs !== "undefined") {
626
+ payload["prefs"] = prefs;
627
+ }
628
+ const uri = new URL(this.client.config.endpoint + apiPath);
629
+ const apiHeaders = {
630
+ "content-type": "application/json"
631
+ };
632
+ return await this.client.call(
633
+ "patch",
634
+ uri,
635
+ apiHeaders,
636
+ payload
637
+ );
638
+ }
639
+ /**
640
+ * Create password recovery
641
+ *
642
+ * Sends the user an email with a temporary secret key for password reset. When the user clicks the confirmation link he is redirected back to your app password reset URL with the secret key and email address values attached to the URL query string. Use the query string params to submit a request to the [PUT /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#updateRecovery) endpoint to complete the process. The verification link sent to the user&#039;s email address is valid for 1 hour.
643
+ *
644
+ * @param {string} email
645
+ * @param {string} url
646
+ * @throws {AppwriteException}
647
+ * @returns {Promise<Models.Token>}
648
+ */
649
+ async createRecovery(email, url) {
650
+ if (typeof email === "undefined") {
651
+ throw new client.AppwriteException('Missing required parameter: "email"');
652
+ }
653
+ if (typeof url === "undefined") {
654
+ throw new client.AppwriteException('Missing required parameter: "url"');
655
+ }
656
+ const apiPath = "/account/recovery";
657
+ const payload = {};
658
+ if (typeof email !== "undefined") {
659
+ payload["email"] = email;
660
+ }
661
+ if (typeof url !== "undefined") {
662
+ payload["url"] = url;
663
+ }
664
+ const uri = new URL(this.client.config.endpoint + apiPath);
665
+ const apiHeaders = {
666
+ "content-type": "application/json"
667
+ };
668
+ return await this.client.call(
669
+ "post",
670
+ uri,
671
+ apiHeaders,
672
+ payload
673
+ );
674
+ }
675
+ /**
676
+ * Create password recovery (confirmation)
677
+ *
678
+ * Use this endpoint to complete the user account password reset. Both the **userId** and **secret** arguments will be passed as query parameters to the redirect URL you have provided when sending your request to the [POST /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#createRecovery) endpoint.
679
+
680
+ Please note that in order to avoid a [Redirect Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) the only valid redirect URLs are the ones from domains you have set when adding your platforms in the console interface.
681
+ *
682
+ * @param {string} userId
683
+ * @param {string} secret
684
+ * @param {string} password
685
+ * @throws {AppwriteException}
686
+ * @returns {Promise<Models.Token>}
687
+ */
688
+ async updateRecovery(userId, secret, password) {
689
+ if (typeof userId === "undefined") {
690
+ throw new client.AppwriteException('Missing required parameter: "userId"');
691
+ }
692
+ if (typeof secret === "undefined") {
693
+ throw new client.AppwriteException('Missing required parameter: "secret"');
694
+ }
695
+ if (typeof password === "undefined") {
696
+ throw new client.AppwriteException('Missing required parameter: "password"');
697
+ }
698
+ const apiPath = "/account/recovery";
699
+ const payload = {};
700
+ if (typeof userId !== "undefined") {
701
+ payload["userId"] = userId;
702
+ }
703
+ if (typeof secret !== "undefined") {
704
+ payload["secret"] = secret;
705
+ }
706
+ if (typeof password !== "undefined") {
707
+ payload["password"] = password;
708
+ }
709
+ const uri = new URL(this.client.config.endpoint + apiPath);
710
+ const apiHeaders = {
711
+ "content-type": "application/json"
712
+ };
713
+ return await this.client.call(
714
+ "put",
715
+ uri,
716
+ apiHeaders,
717
+ payload
718
+ );
719
+ }
720
+ /**
721
+ * List sessions
722
+ *
723
+ * Get the list of active sessions across different devices for the currently logged in user.
724
+ *
725
+ * @throws {AppwriteException}
726
+ * @returns {Promise<Models.SessionList>}
727
+ */
728
+ async listSessions() {
729
+ const apiPath = "/account/sessions";
730
+ const payload = {};
731
+ const uri = new URL(this.client.config.endpoint + apiPath);
732
+ const apiHeaders = {
733
+ "content-type": "application/json"
734
+ };
735
+ return await this.client.call(
736
+ "get",
737
+ uri,
738
+ apiHeaders,
739
+ payload
740
+ );
741
+ }
742
+ /**
743
+ * Delete sessions
744
+ *
745
+ * Delete all sessions from the user account and remove any sessions cookies from the end client.
746
+ *
747
+ * @throws {AppwriteException}
748
+ * @returns {Promise<{}>}
749
+ */
750
+ async deleteSessions() {
751
+ const apiPath = "/account/sessions";
752
+ const payload = {};
753
+ const uri = new URL(this.client.config.endpoint + apiPath);
754
+ const apiHeaders = {
755
+ "content-type": "application/json"
756
+ };
757
+ return await this.client.call(
758
+ "delete",
759
+ uri,
760
+ apiHeaders,
761
+ payload
762
+ );
763
+ }
764
+ /**
765
+ * Create anonymous session
766
+ *
767
+ * Use this endpoint to allow a new user to register an anonymous account in your project. This route will also create a new session for the user. To allow the new user to convert an anonymous account to a normal account, you need to update its [email and password](https://appwrite.io/docs/references/cloud/client-web/account#updateEmail) or create an [OAuth2 session](https://appwrite.io/docs/references/cloud/client-web/account#CreateOAuth2Session).
768
+ *
769
+ * @throws {AppwriteException}
770
+ * @returns {Promise<Models.Session>}
771
+ */
772
+ async createAnonymousSession() {
773
+ const apiPath = "/account/sessions/anonymous";
774
+ const payload = {};
775
+ const uri = new URL(this.client.config.endpoint + apiPath);
776
+ const apiHeaders = {
777
+ "content-type": "application/json"
778
+ };
779
+ return await this.client.call(
780
+ "post",
781
+ uri,
782
+ apiHeaders,
783
+ payload
784
+ );
785
+ }
786
+ /**
787
+ * Create email password session
788
+ *
789
+ * Allow the user to login into their account by providing a valid email and password combination. This route will create a new session for the user.
790
+
791
+ A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
792
+ *
793
+ * @param {string} email
794
+ * @param {string} password
795
+ * @throws {AppwriteException}
796
+ * @returns {Promise<Models.Session>}
797
+ */
798
+ async createEmailPasswordSession(email, password) {
799
+ if (typeof email === "undefined") {
800
+ throw new client.AppwriteException('Missing required parameter: "email"');
801
+ }
802
+ if (typeof password === "undefined") {
803
+ throw new client.AppwriteException('Missing required parameter: "password"');
804
+ }
805
+ const apiPath = "/account/sessions/email";
806
+ const payload = {};
807
+ if (typeof email !== "undefined") {
808
+ payload["email"] = email;
809
+ }
810
+ if (typeof password !== "undefined") {
811
+ payload["password"] = password;
812
+ }
813
+ const uri = new URL(this.client.config.endpoint + apiPath);
814
+ const apiHeaders = {
815
+ "content-type": "application/json"
816
+ };
817
+ return await this.client.call(
818
+ "post",
819
+ uri,
820
+ apiHeaders,
821
+ payload
822
+ );
823
+ }
824
+ /**
825
+ * Update magic URL session
826
+ *
827
+ * Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.
828
+ *
829
+ * @param {string} userId
830
+ * @param {string} secret
831
+ * @throws {AppwriteException}
832
+ * @returns {Promise<Models.Session>}
833
+ */
834
+ async updateMagicURLSession(userId, secret) {
835
+ if (typeof userId === "undefined") {
836
+ throw new client.AppwriteException('Missing required parameter: "userId"');
837
+ }
838
+ if (typeof secret === "undefined") {
839
+ throw new client.AppwriteException('Missing required parameter: "secret"');
840
+ }
841
+ const apiPath = "/account/sessions/magic-url";
842
+ const payload = {};
843
+ if (typeof userId !== "undefined") {
844
+ payload["userId"] = userId;
845
+ }
846
+ if (typeof secret !== "undefined") {
847
+ payload["secret"] = secret;
848
+ }
849
+ const uri = new URL(this.client.config.endpoint + apiPath);
850
+ const apiHeaders = {
851
+ "content-type": "application/json"
852
+ };
853
+ return await this.client.call(
854
+ "put",
855
+ uri,
856
+ apiHeaders,
857
+ payload
858
+ );
859
+ }
860
+ /**
861
+ * Update phone session
862
+ *
863
+ * Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.
864
+ *
865
+ * @param {string} userId
866
+ * @param {string} secret
867
+ * @throws {AppwriteException}
868
+ * @returns {Promise<Models.Session>}
869
+ */
870
+ async updatePhoneSession(userId, secret) {
871
+ if (typeof userId === "undefined") {
872
+ throw new client.AppwriteException('Missing required parameter: "userId"');
873
+ }
874
+ if (typeof secret === "undefined") {
875
+ throw new client.AppwriteException('Missing required parameter: "secret"');
876
+ }
877
+ const apiPath = "/account/sessions/phone";
878
+ const payload = {};
879
+ if (typeof userId !== "undefined") {
880
+ payload["userId"] = userId;
881
+ }
882
+ if (typeof secret !== "undefined") {
883
+ payload["secret"] = secret;
884
+ }
885
+ const uri = new URL(this.client.config.endpoint + apiPath);
886
+ const apiHeaders = {
887
+ "content-type": "application/json"
888
+ };
889
+ return await this.client.call(
890
+ "put",
891
+ uri,
892
+ apiHeaders,
893
+ payload
894
+ );
895
+ }
896
+ /**
897
+ * Create session
898
+ *
899
+ * Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.
900
+ *
901
+ * @param {string} userId
902
+ * @param {string} secret
903
+ * @throws {AppwriteException}
904
+ * @returns {Promise<Models.Session>}
905
+ */
906
+ async createSession(userId, secret) {
907
+ if (typeof userId === "undefined") {
908
+ throw new client.AppwriteException('Missing required parameter: "userId"');
909
+ }
910
+ if (typeof secret === "undefined") {
911
+ throw new client.AppwriteException('Missing required parameter: "secret"');
912
+ }
913
+ const apiPath = "/account/sessions/token";
914
+ const payload = {};
915
+ if (typeof userId !== "undefined") {
916
+ payload["userId"] = userId;
917
+ }
918
+ if (typeof secret !== "undefined") {
919
+ payload["secret"] = secret;
920
+ }
921
+ const uri = new URL(this.client.config.endpoint + apiPath);
922
+ const apiHeaders = {
923
+ "content-type": "application/json"
924
+ };
925
+ return await this.client.call(
926
+ "post",
927
+ uri,
928
+ apiHeaders,
929
+ payload
930
+ );
931
+ }
932
+ /**
933
+ * Get session
934
+ *
935
+ * Use this endpoint to get a logged in user&#039;s session using a Session ID. Inputting &#039;current&#039; will return the current session being used.
936
+ *
937
+ * @param {string} sessionId
938
+ * @throws {AppwriteException}
939
+ * @returns {Promise<Models.Session>}
940
+ */
941
+ async getSession(sessionId) {
942
+ if (typeof sessionId === "undefined") {
943
+ throw new client.AppwriteException('Missing required parameter: "sessionId"');
944
+ }
945
+ const apiPath = "/account/sessions/{sessionId}".replace("{sessionId}", sessionId);
946
+ const payload = {};
947
+ const uri = new URL(this.client.config.endpoint + apiPath);
948
+ const apiHeaders = {
949
+ "content-type": "application/json"
950
+ };
951
+ return await this.client.call(
952
+ "get",
953
+ uri,
954
+ apiHeaders,
955
+ payload
956
+ );
957
+ }
958
+ /**
959
+ * Update session
960
+ *
961
+ * Use this endpoint to extend a session&#039;s length. Extending a session is useful when session expiry is short. If the session was created using an OAuth provider, this endpoint refreshes the access token from the provider.
962
+ *
963
+ * @param {string} sessionId
964
+ * @throws {AppwriteException}
965
+ * @returns {Promise<Models.Session>}
966
+ */
967
+ async updateSession(sessionId) {
968
+ if (typeof sessionId === "undefined") {
969
+ throw new client.AppwriteException('Missing required parameter: "sessionId"');
970
+ }
971
+ const apiPath = "/account/sessions/{sessionId}".replace("{sessionId}", sessionId);
972
+ const payload = {};
973
+ const uri = new URL(this.client.config.endpoint + apiPath);
974
+ const apiHeaders = {
975
+ "content-type": "application/json"
976
+ };
977
+ return await this.client.call(
978
+ "patch",
979
+ uri,
980
+ apiHeaders,
981
+ payload
982
+ );
983
+ }
984
+ /**
985
+ * Delete session
986
+ *
987
+ * Logout the user. Use &#039;current&#039; as the session ID to logout on this device, use a session ID to logout on another device. If you&#039;re looking to logout the user on all devices, use [Delete Sessions](https://appwrite.io/docs/references/cloud/client-web/account#deleteSessions) instead.
988
+ *
989
+ * @param {string} sessionId
990
+ * @throws {AppwriteException}
991
+ * @returns {Promise<{}>}
992
+ */
993
+ async deleteSession(sessionId) {
994
+ if (typeof sessionId === "undefined") {
995
+ throw new client.AppwriteException('Missing required parameter: "sessionId"');
996
+ }
997
+ const apiPath = "/account/sessions/{sessionId}".replace("{sessionId}", sessionId);
998
+ const payload = {};
999
+ const uri = new URL(this.client.config.endpoint + apiPath);
1000
+ const apiHeaders = {
1001
+ "content-type": "application/json"
1002
+ };
1003
+ return await this.client.call(
1004
+ "delete",
1005
+ uri,
1006
+ apiHeaders,
1007
+ payload
1008
+ );
1009
+ }
1010
+ /**
1011
+ * Update status
1012
+ *
1013
+ * Block the currently logged in user account. Behind the scene, the user record is not deleted but permanently blocked from any access. To completely delete a user, use the Users API instead.
1014
+ *
1015
+ * @throws {AppwriteException}
1016
+ * @returns {Promise<Models.User<Preferences>>}
1017
+ */
1018
+ async updateStatus() {
1019
+ const apiPath = "/account/status";
1020
+ const payload = {};
1021
+ const uri = new URL(this.client.config.endpoint + apiPath);
1022
+ const apiHeaders = {
1023
+ "content-type": "application/json"
1024
+ };
1025
+ return await this.client.call(
1026
+ "patch",
1027
+ uri,
1028
+ apiHeaders,
1029
+ payload
1030
+ );
1031
+ }
1032
+ /**
1033
+ * Create email token (OTP)
1034
+ *
1035
+ * Sends the user an email with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint to complete the login process. The secret sent to the user&#039;s email is valid for 15 minutes.
1036
+
1037
+ A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
1038
+ *
1039
+ * @param {string} userId
1040
+ * @param {string} email
1041
+ * @param {boolean} phrase
1042
+ * @throws {AppwriteException}
1043
+ * @returns {Promise<Models.Token>}
1044
+ */
1045
+ async createEmailToken(userId, email, phrase) {
1046
+ if (typeof userId === "undefined") {
1047
+ throw new client.AppwriteException('Missing required parameter: "userId"');
1048
+ }
1049
+ if (typeof email === "undefined") {
1050
+ throw new client.AppwriteException('Missing required parameter: "email"');
1051
+ }
1052
+ const apiPath = "/account/tokens/email";
1053
+ const payload = {};
1054
+ if (typeof userId !== "undefined") {
1055
+ payload["userId"] = userId;
1056
+ }
1057
+ if (typeof email !== "undefined") {
1058
+ payload["email"] = email;
1059
+ }
1060
+ if (typeof phrase !== "undefined") {
1061
+ payload["phrase"] = phrase;
1062
+ }
1063
+ const uri = new URL(this.client.config.endpoint + apiPath);
1064
+ const apiHeaders = {
1065
+ "content-type": "application/json"
1066
+ };
1067
+ return await this.client.call(
1068
+ "post",
1069
+ uri,
1070
+ apiHeaders,
1071
+ payload
1072
+ );
1073
+ }
1074
+ /**
1075
+ * Create magic URL token
1076
+ *
1077
+ * Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [POST /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint to complete the login process. The link sent to the user&#039;s email address is valid for 1 hour. If you are on a mobile device you can leave the URL parameter empty, so that the login completion will be handled by your Appwrite instance by default.
1078
+
1079
+ A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
1080
+
1081
+ *
1082
+ * @param {string} userId
1083
+ * @param {string} email
1084
+ * @param {string} url
1085
+ * @param {boolean} phrase
1086
+ * @throws {AppwriteException}
1087
+ * @returns {Promise<Models.Token>}
1088
+ */
1089
+ async createMagicURLToken(userId, email, url, phrase) {
1090
+ if (typeof userId === "undefined") {
1091
+ throw new client.AppwriteException('Missing required parameter: "userId"');
1092
+ }
1093
+ if (typeof email === "undefined") {
1094
+ throw new client.AppwriteException('Missing required parameter: "email"');
1095
+ }
1096
+ const apiPath = "/account/tokens/magic-url";
1097
+ const payload = {};
1098
+ if (typeof userId !== "undefined") {
1099
+ payload["userId"] = userId;
1100
+ }
1101
+ if (typeof email !== "undefined") {
1102
+ payload["email"] = email;
1103
+ }
1104
+ if (typeof url !== "undefined") {
1105
+ payload["url"] = url;
1106
+ }
1107
+ if (typeof phrase !== "undefined") {
1108
+ payload["phrase"] = phrase;
1109
+ }
1110
+ const uri = new URL(this.client.config.endpoint + apiPath);
1111
+ const apiHeaders = {
1112
+ "content-type": "application/json"
1113
+ };
1114
+ return await this.client.call(
1115
+ "post",
1116
+ uri,
1117
+ apiHeaders,
1118
+ payload
1119
+ );
1120
+ }
1121
+ /**
1122
+ * Create OAuth2 token
1123
+ *
1124
+ * Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL&#039;s back to your app when login is completed.
1125
+
1126
+ If authentication succeeds, `userId` and `secret` of a token will be appended to the success URL as query parameters. These can be used to create a new session using the [Create session](https://appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint.
1127
+
1128
+ A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
1129
+ *
1130
+ * @param {OAuthProvider} provider
1131
+ * @param {string} success
1132
+ * @param {string} failure
1133
+ * @param {string[]} scopes
1134
+ * @throws {AppwriteException}
1135
+ * @returns {Promise<string>}
1136
+ */
1137
+ async createOAuth2Token(provider, success, failure, scopes) {
1138
+ if (typeof provider === "undefined") {
1139
+ throw new client.AppwriteException('Missing required parameter: "provider"');
1140
+ }
1141
+ const apiPath = "/account/tokens/oauth2/{provider}".replace("{provider}", provider);
1142
+ const payload = {};
1143
+ if (typeof success !== "undefined") {
1144
+ payload["success"] = success;
1145
+ }
1146
+ if (typeof failure !== "undefined") {
1147
+ payload["failure"] = failure;
1148
+ }
1149
+ if (typeof scopes !== "undefined") {
1150
+ payload["scopes"] = scopes;
1151
+ }
1152
+ const uri = new URL(this.client.config.endpoint + apiPath);
1153
+ const apiHeaders = {
1154
+ "content-type": "application/json"
1155
+ };
1156
+ return await this.client.redirect(
1157
+ "get",
1158
+ uri,
1159
+ apiHeaders,
1160
+ payload
1161
+ );
1162
+ }
1163
+ /**
1164
+ * Create phone token
1165
+ *
1166
+ * Sends the user an SMS with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint to complete the login process. The secret sent to the user&#039;s phone is valid for 15 minutes.
1167
+
1168
+ A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
1169
+ *
1170
+ * @param {string} userId
1171
+ * @param {string} phone
1172
+ * @throws {AppwriteException}
1173
+ * @returns {Promise<Models.Token>}
1174
+ */
1175
+ async createPhoneToken(userId, phone) {
1176
+ if (typeof userId === "undefined") {
1177
+ throw new client.AppwriteException('Missing required parameter: "userId"');
1178
+ }
1179
+ if (typeof phone === "undefined") {
1180
+ throw new client.AppwriteException('Missing required parameter: "phone"');
1181
+ }
1182
+ const apiPath = "/account/tokens/phone";
1183
+ const payload = {};
1184
+ if (typeof userId !== "undefined") {
1185
+ payload["userId"] = userId;
1186
+ }
1187
+ if (typeof phone !== "undefined") {
1188
+ payload["phone"] = phone;
1189
+ }
1190
+ const uri = new URL(this.client.config.endpoint + apiPath);
1191
+ const apiHeaders = {
1192
+ "content-type": "application/json"
1193
+ };
1194
+ return await this.client.call(
1195
+ "post",
1196
+ uri,
1197
+ apiHeaders,
1198
+ payload
1199
+ );
1200
+ }
1201
+ /**
1202
+ * Create email verification
1203
+ *
1204
+ * Use this endpoint to send a verification message to your user email address to confirm they are the valid owners of that address. Both the **userId** and **secret** arguments will be passed as query parameters to the URL you have provided to be attached to the verification email. The provided URL should redirect the user back to your app and allow you to complete the verification process by verifying both the **userId** and **secret** parameters. Learn more about how to [complete the verification process](https://appwrite.io/docs/references/cloud/client-web/account#updateVerification). The verification link sent to the user&#039;s email address is valid for 7 days.
1205
+
1206
+ Please note that in order to avoid a [Redirect Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md), the only valid redirect URLs are the ones from domains you have set when adding your platforms in the console interface.
1207
+
1208
+ *
1209
+ * @param {string} url
1210
+ * @throws {AppwriteException}
1211
+ * @returns {Promise<Models.Token>}
1212
+ */
1213
+ async createVerification(url) {
1214
+ if (typeof url === "undefined") {
1215
+ throw new client.AppwriteException('Missing required parameter: "url"');
1216
+ }
1217
+ const apiPath = "/account/verification";
1218
+ const payload = {};
1219
+ if (typeof url !== "undefined") {
1220
+ payload["url"] = url;
1221
+ }
1222
+ const uri = new URL(this.client.config.endpoint + apiPath);
1223
+ const apiHeaders = {
1224
+ "content-type": "application/json"
1225
+ };
1226
+ return await this.client.call(
1227
+ "post",
1228
+ uri,
1229
+ apiHeaders,
1230
+ payload
1231
+ );
1232
+ }
1233
+ /**
1234
+ * Create email verification (confirmation)
1235
+ *
1236
+ * Use this endpoint to complete the user email verification process. Use both the **userId** and **secret** parameters that were attached to your app URL to verify the user email ownership. If confirmed this route will return a 200 status code.
1237
+ *
1238
+ * @param {string} userId
1239
+ * @param {string} secret
1240
+ * @throws {AppwriteException}
1241
+ * @returns {Promise<Models.Token>}
1242
+ */
1243
+ async updateVerification(userId, secret) {
1244
+ if (typeof userId === "undefined") {
1245
+ throw new client.AppwriteException('Missing required parameter: "userId"');
1246
+ }
1247
+ if (typeof secret === "undefined") {
1248
+ throw new client.AppwriteException('Missing required parameter: "secret"');
1249
+ }
1250
+ const apiPath = "/account/verification";
1251
+ const payload = {};
1252
+ if (typeof userId !== "undefined") {
1253
+ payload["userId"] = userId;
1254
+ }
1255
+ if (typeof secret !== "undefined") {
1256
+ payload["secret"] = secret;
1257
+ }
1258
+ const uri = new URL(this.client.config.endpoint + apiPath);
1259
+ const apiHeaders = {
1260
+ "content-type": "application/json"
1261
+ };
1262
+ return await this.client.call(
1263
+ "put",
1264
+ uri,
1265
+ apiHeaders,
1266
+ payload
1267
+ );
1268
+ }
1269
+ /**
1270
+ * Create phone verification
1271
+ *
1272
+ * Use this endpoint to send a verification SMS to the currently logged in user. This endpoint is meant for use after updating a user&#039;s phone number using the [accountUpdatePhone](https://appwrite.io/docs/references/cloud/client-web/account#updatePhone) endpoint. Learn more about how to [complete the verification process](https://appwrite.io/docs/references/cloud/client-web/account#updatePhoneVerification). The verification code sent to the user&#039;s phone number is valid for 15 minutes.
1273
+ *
1274
+ * @throws {AppwriteException}
1275
+ * @returns {Promise<Models.Token>}
1276
+ */
1277
+ async createPhoneVerification() {
1278
+ const apiPath = "/account/verification/phone";
1279
+ const payload = {};
1280
+ const uri = new URL(this.client.config.endpoint + apiPath);
1281
+ const apiHeaders = {
1282
+ "content-type": "application/json"
1283
+ };
1284
+ return await this.client.call(
1285
+ "post",
1286
+ uri,
1287
+ apiHeaders,
1288
+ payload
1289
+ );
1290
+ }
1291
+ /**
1292
+ * Create phone verification (confirmation)
1293
+ *
1294
+ * Use this endpoint to complete the user phone verification process. Use the **userId** and **secret** that were sent to your user&#039;s phone number to verify the user email ownership. If confirmed this route will return a 200 status code.
1295
+ *
1296
+ * @param {string} userId
1297
+ * @param {string} secret
1298
+ * @throws {AppwriteException}
1299
+ * @returns {Promise<Models.Token>}
1300
+ */
1301
+ async updatePhoneVerification(userId, secret) {
1302
+ if (typeof userId === "undefined") {
1303
+ throw new client.AppwriteException('Missing required parameter: "userId"');
1304
+ }
1305
+ if (typeof secret === "undefined") {
1306
+ throw new client.AppwriteException('Missing required parameter: "secret"');
1307
+ }
1308
+ const apiPath = "/account/verification/phone";
1309
+ const payload = {};
1310
+ if (typeof userId !== "undefined") {
1311
+ payload["userId"] = userId;
1312
+ }
1313
+ if (typeof secret !== "undefined") {
1314
+ payload["secret"] = secret;
1315
+ }
1316
+ const uri = new URL(this.client.config.endpoint + apiPath);
1317
+ const apiHeaders = {
1318
+ "content-type": "application/json"
1319
+ };
1320
+ return await this.client.call(
1321
+ "put",
1322
+ uri,
1323
+ apiHeaders,
1324
+ payload
1325
+ );
1326
+ }
1327
+ }
1328
+
1329
+ exports.Account = Account;
1330
+ //# sourceMappingURL=out.js.map
1331
+ //# sourceMappingURL=account.js.map