appwrite-cli 12.0.1 → 13.0.0-rc.2

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 (801) hide show
  1. package/.github/workflows/build-verify.yml +71 -0
  2. package/.github/workflows/npm-publish.yml +41 -22
  3. package/CHANGELOG.md +108 -100
  4. package/LICENSE.md +1 -1
  5. package/README.md +58 -35
  6. package/bun.lock +625 -0
  7. package/dist/bundle.cjs +94853 -0
  8. package/dist/index.d.ts +3 -0
  9. package/dist/index.d.ts.map +1 -0
  10. package/dist/index.js +145 -0
  11. package/dist/index.js.map +1 -0
  12. package/dist/lib/client.d.ts +88 -0
  13. package/dist/lib/client.d.ts.map +1 -0
  14. package/dist/lib/client.js +238 -0
  15. package/dist/lib/client.js.map +1 -0
  16. package/dist/lib/commands/generic.d.ts +17 -0
  17. package/dist/lib/commands/generic.d.ts.map +1 -0
  18. package/dist/lib/commands/generic.js +292 -0
  19. package/dist/lib/commands/generic.js.map +1 -0
  20. package/dist/lib/commands/init.d.ts +3 -0
  21. package/dist/lib/commands/init.d.ts.map +1 -0
  22. package/{lib → dist/lib}/commands/init.js +186 -270
  23. package/dist/lib/commands/init.js.map +1 -0
  24. package/dist/lib/commands/pull.d.ts +8 -0
  25. package/dist/lib/commands/pull.d.ts.map +1 -0
  26. package/{lib → dist/lib}/commands/pull.js +159 -280
  27. package/dist/lib/commands/pull.js.map +1 -0
  28. package/dist/lib/commands/push.d.ts +4 -0
  29. package/dist/lib/commands/push.d.ts.map +1 -0
  30. package/dist/lib/commands/push.js +2127 -0
  31. package/dist/lib/commands/push.js.map +1 -0
  32. package/dist/lib/commands/run.d.ts +3 -0
  33. package/dist/lib/commands/run.d.ts.map +1 -0
  34. package/{lib → dist/lib}/commands/run.js +146 -187
  35. package/dist/lib/commands/run.js.map +1 -0
  36. package/dist/lib/commands/services/account.d.ts +3 -0
  37. package/dist/lib/commands/services/account.d.ts.map +1 -0
  38. package/dist/lib/commands/services/account.js +306 -0
  39. package/dist/lib/commands/services/account.js.map +1 -0
  40. package/dist/lib/commands/services/avatars.d.ts +3 -0
  41. package/dist/lib/commands/services/avatars.d.ts.map +1 -0
  42. package/dist/lib/commands/services/avatars.js +118 -0
  43. package/dist/lib/commands/services/avatars.js.map +1 -0
  44. package/dist/lib/commands/services/console.d.ts +3 -0
  45. package/dist/lib/commands/services/console.d.ts.map +1 -0
  46. package/dist/lib/commands/services/console.js +41 -0
  47. package/dist/lib/commands/services/console.js.map +1 -0
  48. package/dist/lib/commands/services/databases.d.ts +3 -0
  49. package/dist/lib/commands/services/databases.d.ts.map +1 -0
  50. package/dist/lib/commands/services/databases.js +612 -0
  51. package/dist/lib/commands/services/databases.js.map +1 -0
  52. package/dist/lib/commands/services/functions.d.ts +3 -0
  53. package/dist/lib/commands/services/functions.d.ts.map +1 -0
  54. package/dist/lib/commands/services/functions.js +258 -0
  55. package/dist/lib/commands/services/functions.js.map +1 -0
  56. package/dist/lib/commands/services/graphql.d.ts +3 -0
  57. package/dist/lib/commands/services/graphql.d.ts.map +1 -0
  58. package/dist/lib/commands/services/graphql.js +28 -0
  59. package/dist/lib/commands/services/graphql.js.map +1 -0
  60. package/dist/lib/commands/services/health.d.ts +3 -0
  61. package/dist/lib/commands/services/health.d.ts.map +1 -0
  62. package/dist/lib/commands/services/health.js +123 -0
  63. package/dist/lib/commands/services/health.js.map +1 -0
  64. package/dist/lib/commands/services/locale.d.ts +3 -0
  65. package/dist/lib/commands/services/locale.d.ts.map +1 -0
  66. package/dist/lib/commands/services/locale.js +52 -0
  67. package/dist/lib/commands/services/locale.js.map +1 -0
  68. package/dist/lib/commands/services/messaging.d.ts +3 -0
  69. package/dist/lib/commands/services/messaging.d.ts.map +1 -0
  70. package/dist/lib/commands/services/messaging.js +505 -0
  71. package/dist/lib/commands/services/messaging.js.map +1 -0
  72. package/dist/lib/commands/services/migrations.d.ts +3 -0
  73. package/dist/lib/commands/services/migrations.d.ts.map +1 -0
  74. package/dist/lib/commands/services/migrations.js +135 -0
  75. package/dist/lib/commands/services/migrations.js.map +1 -0
  76. package/dist/lib/commands/services/project.d.ts +3 -0
  77. package/dist/lib/commands/services/project.d.ts.map +1 -0
  78. package/dist/lib/commands/services/project.js +54 -0
  79. package/dist/lib/commands/services/project.js.map +1 -0
  80. package/dist/lib/commands/services/projects.d.ts +3 -0
  81. package/dist/lib/commands/services/projects.d.ts.map +1 -0
  82. package/dist/lib/commands/services/projects.js +415 -0
  83. package/dist/lib/commands/services/projects.js.map +1 -0
  84. package/dist/lib/commands/services/proxy.d.ts +3 -0
  85. package/dist/lib/commands/services/proxy.d.ts.map +1 -0
  86. package/dist/lib/commands/services/proxy.js +68 -0
  87. package/dist/lib/commands/services/proxy.js.map +1 -0
  88. package/dist/lib/commands/services/sites.d.ts +3 -0
  89. package/dist/lib/commands/services/sites.d.ts.map +1 -0
  90. package/dist/lib/commands/services/sites.js +242 -0
  91. package/dist/lib/commands/services/sites.js.map +1 -0
  92. package/dist/lib/commands/services/storage.d.ts +3 -0
  93. package/dist/lib/commands/services/storage.d.ts.map +1 -0
  94. package/dist/lib/commands/services/storage.js +153 -0
  95. package/dist/lib/commands/services/storage.js.map +1 -0
  96. package/dist/lib/commands/services/tablesdb.d.ts +3 -0
  97. package/dist/lib/commands/services/tablesdb.d.ts.map +1 -0
  98. package/dist/lib/commands/services/tablesdb.js +605 -0
  99. package/dist/lib/commands/services/tablesdb.js.map +1 -0
  100. package/dist/lib/commands/services/teams.d.ts +3 -0
  101. package/dist/lib/commands/services/teams.d.ts.map +1 -0
  102. package/dist/lib/commands/services/teams.js +123 -0
  103. package/dist/lib/commands/services/teams.js.map +1 -0
  104. package/dist/lib/commands/services/tokens.d.ts +3 -0
  105. package/dist/lib/commands/services/tokens.d.ts.map +1 -0
  106. package/dist/lib/commands/services/tokens.js +49 -0
  107. package/dist/lib/commands/services/tokens.js.map +1 -0
  108. package/dist/lib/commands/services/users.d.ts +3 -0
  109. package/dist/lib/commands/services/users.d.ts.map +1 -0
  110. package/dist/lib/commands/services/users.js +312 -0
  111. package/dist/lib/commands/services/users.js.map +1 -0
  112. package/dist/lib/commands/services/vcs.d.ts +3 -0
  113. package/dist/lib/commands/services/vcs.d.ts.map +1 -0
  114. package/dist/lib/commands/services/vcs.js +87 -0
  115. package/dist/lib/commands/services/vcs.js.map +1 -0
  116. package/dist/lib/commands/types.d.ts +3 -0
  117. package/dist/lib/commands/types.d.ts.map +1 -0
  118. package/dist/lib/commands/types.js +151 -0
  119. package/dist/lib/commands/types.js.map +1 -0
  120. package/dist/lib/commands/update.d.ts +3 -0
  121. package/dist/lib/commands/update.d.ts.map +1 -0
  122. package/{lib → dist/lib}/commands/update.js +62 -79
  123. package/dist/lib/commands/update.js.map +1 -0
  124. package/dist/lib/config.d.ts +118 -0
  125. package/dist/lib/config.d.ts.map +1 -0
  126. package/{lib → dist/lib}/config.js +173 -232
  127. package/dist/lib/config.js.map +1 -0
  128. package/dist/lib/emulation/docker.d.ts +7 -0
  129. package/dist/lib/emulation/docker.d.ts.map +1 -0
  130. package/dist/lib/emulation/docker.js +224 -0
  131. package/dist/lib/emulation/docker.js.map +1 -0
  132. package/dist/lib/emulation/utils.d.ts +29 -0
  133. package/dist/lib/emulation/utils.d.ts.map +1 -0
  134. package/{lib → dist/lib}/emulation/utils.js +70 -91
  135. package/dist/lib/emulation/utils.js.map +1 -0
  136. package/dist/lib/id.d.ts +7 -0
  137. package/dist/lib/id.d.ts.map +1 -0
  138. package/{lib → dist/lib}/id.js +5 -8
  139. package/dist/lib/id.js.map +1 -0
  140. package/dist/lib/paginate.d.ts +9 -0
  141. package/dist/lib/paginate.d.ts.map +1 -0
  142. package/{lib → dist/lib}/paginate.js +10 -19
  143. package/dist/lib/paginate.js.map +1 -0
  144. package/dist/lib/parser.d.ts +18 -0
  145. package/dist/lib/parser.d.ts.map +1 -0
  146. package/dist/lib/parser.js +225 -0
  147. package/dist/lib/parser.js.map +1 -0
  148. package/dist/lib/questions.d.ts +59 -0
  149. package/dist/lib/questions.d.ts.map +1 -0
  150. package/{lib → dist/lib}/questions.js +393 -500
  151. package/dist/lib/questions.js.map +1 -0
  152. package/dist/lib/sdks.d.ts +4 -0
  153. package/dist/lib/sdks.d.ts.map +1 -0
  154. package/dist/lib/sdks.js +61 -0
  155. package/dist/lib/sdks.js.map +1 -0
  156. package/dist/lib/services.d.ts +13 -0
  157. package/dist/lib/services.d.ts.map +1 -0
  158. package/dist/lib/services.js +47 -0
  159. package/dist/lib/services.js.map +1 -0
  160. package/dist/lib/spinner.d.ts +28 -0
  161. package/dist/lib/spinner.d.ts.map +1 -0
  162. package/dist/lib/spinner.js +91 -0
  163. package/dist/lib/spinner.js.map +1 -0
  164. package/dist/lib/type-generation/attribute.d.ts +17 -0
  165. package/dist/lib/type-generation/attribute.d.ts.map +1 -0
  166. package/{lib → dist/lib}/type-generation/attribute.js +2 -5
  167. package/dist/lib/type-generation/attribute.js.map +1 -0
  168. package/dist/lib/type-generation/languages/csharp.d.ts +7 -0
  169. package/dist/lib/type-generation/languages/csharp.d.ts.map +1 -0
  170. package/dist/lib/type-generation/languages/csharp.js +180 -0
  171. package/dist/lib/type-generation/languages/csharp.js.map +1 -0
  172. package/dist/lib/type-generation/languages/dart.d.ts +8 -0
  173. package/dist/lib/type-generation/languages/dart.d.ts.map +1 -0
  174. package/dist/lib/type-generation/languages/dart.js +197 -0
  175. package/dist/lib/type-generation/languages/dart.js.map +1 -0
  176. package/dist/lib/type-generation/languages/java.d.ts +7 -0
  177. package/dist/lib/type-generation/languages/java.d.ts.map +1 -0
  178. package/dist/lib/type-generation/languages/java.js +140 -0
  179. package/dist/lib/type-generation/languages/java.js.map +1 -0
  180. package/dist/lib/type-generation/languages/javascript.d.ts +9 -0
  181. package/dist/lib/type-generation/languages/javascript.d.ts.map +1 -0
  182. package/dist/lib/type-generation/languages/javascript.js +109 -0
  183. package/dist/lib/type-generation/languages/javascript.js.map +1 -0
  184. package/dist/lib/type-generation/languages/kotlin.d.ts +7 -0
  185. package/dist/lib/type-generation/languages/kotlin.d.ts.map +1 -0
  186. package/dist/lib/type-generation/languages/kotlin.js +95 -0
  187. package/dist/lib/type-generation/languages/kotlin.js.map +1 -0
  188. package/dist/lib/type-generation/languages/language.d.ts +43 -0
  189. package/dist/lib/type-generation/languages/language.d.ts.map +1 -0
  190. package/dist/lib/type-generation/languages/language.js +77 -0
  191. package/dist/lib/type-generation/languages/language.js.map +1 -0
  192. package/dist/lib/type-generation/languages/php.d.ts +7 -0
  193. package/dist/lib/type-generation/languages/php.d.ts.map +1 -0
  194. package/dist/lib/type-generation/languages/php.js +116 -0
  195. package/dist/lib/type-generation/languages/php.js.map +1 -0
  196. package/dist/lib/type-generation/languages/swift.d.ts +7 -0
  197. package/dist/lib/type-generation/languages/swift.d.ts.map +1 -0
  198. package/dist/lib/type-generation/languages/swift.js +179 -0
  199. package/dist/lib/type-generation/languages/swift.js.map +1 -0
  200. package/dist/lib/type-generation/languages/typescript.d.ts +9 -0
  201. package/dist/lib/type-generation/languages/typescript.d.ts.map +1 -0
  202. package/dist/lib/type-generation/languages/typescript.js +115 -0
  203. package/dist/lib/type-generation/languages/typescript.js.map +1 -0
  204. package/dist/lib/types.d.ts +277 -0
  205. package/dist/lib/types.d.ts.map +1 -0
  206. package/dist/lib/types.js +2 -0
  207. package/dist/lib/types.js.map +1 -0
  208. package/dist/lib/utils.d.ts +15 -0
  209. package/dist/lib/utils.d.ts.map +1 -0
  210. package/{lib → dist/lib}/utils.js +125 -167
  211. package/dist/lib/utils.js.map +1 -0
  212. package/dist/lib/validations.d.ts +2 -0
  213. package/dist/lib/validations.d.ts.map +1 -0
  214. package/dist/lib/validations.js +16 -0
  215. package/dist/lib/validations.js.map +1 -0
  216. package/dist/package.json +67 -0
  217. package/dist/scripts/generate-commands.d.ts +2 -0
  218. package/dist/scripts/generate-commands.d.ts.map +1 -0
  219. package/dist/scripts/generate-commands.js +398 -0
  220. package/dist/scripts/generate-commands.js.map +1 -0
  221. package/index.ts +168 -0
  222. package/install.ps1 +2 -5
  223. package/install.sh +1 -2
  224. package/lib/client.ts +292 -0
  225. package/lib/commands/generic.ts +440 -0
  226. package/lib/commands/init.ts +713 -0
  227. package/lib/commands/pull.ts +668 -0
  228. package/lib/commands/push.ts +3183 -0
  229. package/lib/commands/run.ts +416 -0
  230. package/lib/commands/services/account.ts +832 -0
  231. package/lib/commands/services/avatars.ts +400 -0
  232. package/lib/commands/services/console.ts +73 -0
  233. package/lib/commands/services/databases.ts +2080 -0
  234. package/lib/commands/services/functions.ts +855 -0
  235. package/lib/commands/services/graphql.ts +47 -0
  236. package/lib/commands/services/health.ts +322 -0
  237. package/lib/commands/services/locale.ts +99 -0
  238. package/lib/commands/services/messaging.ts +1871 -0
  239. package/lib/commands/services/migrations.ts +421 -0
  240. package/lib/commands/services/project.ts +116 -0
  241. package/lib/commands/services/projects.ts +1317 -0
  242. package/lib/commands/services/proxy.ts +163 -0
  243. package/lib/commands/services/sites.ts +777 -0
  244. package/lib/commands/services/storage.ts +547 -0
  245. package/lib/commands/services/tablesdb.ts +1928 -0
  246. package/lib/commands/services/teams.ts +294 -0
  247. package/lib/commands/services/tokens.ts +106 -0
  248. package/lib/commands/services/users.ts +886 -0
  249. package/lib/commands/services/vcs.ts +268 -0
  250. package/lib/commands/types.ts +220 -0
  251. package/lib/commands/update.ts +255 -0
  252. package/lib/config.ts +969 -0
  253. package/lib/emulation/docker.ts +312 -0
  254. package/lib/emulation/utils.ts +207 -0
  255. package/lib/id.ts +30 -0
  256. package/lib/paginate.ts +77 -0
  257. package/lib/parser.ts +264 -0
  258. package/lib/questions.ts +1167 -0
  259. package/lib/sdks.ts +84 -0
  260. package/lib/services.ts +72 -0
  261. package/lib/spinner.ts +131 -0
  262. package/lib/type-generation/attribute.ts +18 -0
  263. package/lib/type-generation/languages/{csharp.js → csharp.ts} +27 -14
  264. package/lib/type-generation/languages/{dart.js → dart.ts} +61 -46
  265. package/lib/type-generation/languages/{java.js → java.ts} +31 -18
  266. package/lib/type-generation/languages/{javascript.js → javascript.ts} +35 -24
  267. package/lib/type-generation/languages/{kotlin.js → kotlin.ts} +27 -14
  268. package/lib/type-generation/languages/{language.js → language.ts} +45 -43
  269. package/lib/type-generation/languages/{php.js → php.ts} +28 -15
  270. package/lib/type-generation/languages/{swift.js → swift.ts} +27 -14
  271. package/lib/type-generation/languages/{typescript.js → typescript.ts} +43 -26
  272. package/lib/types.ts +304 -0
  273. package/lib/utils.ts +352 -0
  274. package/lib/validations.ts +20 -0
  275. package/package.json +36 -19
  276. package/scoop/appwrite.config.json +19 -29
  277. package/scripts/generate-commands.ts +539 -0
  278. package/tsconfig.json +24 -0
  279. package/.github/workflows/autoclose.yml +0 -11
  280. package/docs/examples/account/create-anonymous-session.md +0 -1
  281. package/docs/examples/account/create-email-password-session.md +0 -3
  282. package/docs/examples/account/create-email-token.md +0 -3
  283. package/docs/examples/account/create-email-verification.md +0 -2
  284. package/docs/examples/account/create-jwt.md +0 -1
  285. package/docs/examples/account/create-magic-url-token.md +0 -3
  286. package/docs/examples/account/create-mfa-authenticator.md +0 -2
  287. package/docs/examples/account/create-mfa-challenge.md +0 -2
  288. package/docs/examples/account/create-mfa-recovery-codes.md +0 -1
  289. package/docs/examples/account/create-o-auth-2-session.md +0 -2
  290. package/docs/examples/account/create-o-auth-2-token.md +0 -2
  291. package/docs/examples/account/create-phone-token.md +0 -3
  292. package/docs/examples/account/create-phone-verification.md +0 -1
  293. package/docs/examples/account/create-push-target.md +0 -3
  294. package/docs/examples/account/create-recovery.md +0 -3
  295. package/docs/examples/account/create-session.md +0 -3
  296. package/docs/examples/account/create-verification.md +0 -2
  297. package/docs/examples/account/create.md +0 -4
  298. package/docs/examples/account/delete-identity.md +0 -2
  299. package/docs/examples/account/delete-mfa-authenticator.md +0 -2
  300. package/docs/examples/account/delete-push-target.md +0 -2
  301. package/docs/examples/account/delete-session.md +0 -2
  302. package/docs/examples/account/delete-sessions.md +0 -1
  303. package/docs/examples/account/delete.md +0 -1
  304. package/docs/examples/account/get-mfa-recovery-codes.md +0 -1
  305. package/docs/examples/account/get-prefs.md +0 -1
  306. package/docs/examples/account/get-session.md +0 -2
  307. package/docs/examples/account/get.md +0 -1
  308. package/docs/examples/account/list-identities.md +0 -1
  309. package/docs/examples/account/list-logs.md +0 -1
  310. package/docs/examples/account/list-mfa-factors.md +0 -1
  311. package/docs/examples/account/list-sessions.md +0 -1
  312. package/docs/examples/account/update-email-verification.md +0 -3
  313. package/docs/examples/account/update-email.md +0 -3
  314. package/docs/examples/account/update-magic-url-session.md +0 -3
  315. package/docs/examples/account/update-mfa-authenticator.md +0 -3
  316. package/docs/examples/account/update-mfa-challenge.md +0 -3
  317. package/docs/examples/account/update-mfa-recovery-codes.md +0 -1
  318. package/docs/examples/account/update-mfa.md +0 -2
  319. package/docs/examples/account/update-name.md +0 -2
  320. package/docs/examples/account/update-password.md +0 -2
  321. package/docs/examples/account/update-phone-session.md +0 -3
  322. package/docs/examples/account/update-phone-verification.md +0 -3
  323. package/docs/examples/account/update-phone.md +0 -3
  324. package/docs/examples/account/update-prefs.md +0 -2
  325. package/docs/examples/account/update-push-target.md +0 -3
  326. package/docs/examples/account/update-recovery.md +0 -4
  327. package/docs/examples/account/update-session.md +0 -2
  328. package/docs/examples/account/update-status.md +0 -1
  329. package/docs/examples/account/update-verification.md +0 -3
  330. package/docs/examples/console/get-resource.md +0 -3
  331. package/docs/examples/console/variables.md +0 -1
  332. package/docs/examples/databases/create-boolean-attribute.md +0 -5
  333. package/docs/examples/databases/create-collection.md +0 -4
  334. package/docs/examples/databases/create-datetime-attribute.md +0 -5
  335. package/docs/examples/databases/create-document.md +0 -5
  336. package/docs/examples/databases/create-documents.md +0 -4
  337. package/docs/examples/databases/create-email-attribute.md +0 -5
  338. package/docs/examples/databases/create-enum-attribute.md +0 -6
  339. package/docs/examples/databases/create-float-attribute.md +0 -5
  340. package/docs/examples/databases/create-index.md +0 -6
  341. package/docs/examples/databases/create-integer-attribute.md +0 -5
  342. package/docs/examples/databases/create-ip-attribute.md +0 -5
  343. package/docs/examples/databases/create-line-attribute.md +0 -5
  344. package/docs/examples/databases/create-operations.md +0 -2
  345. package/docs/examples/databases/create-point-attribute.md +0 -5
  346. package/docs/examples/databases/create-polygon-attribute.md +0 -5
  347. package/docs/examples/databases/create-relationship-attribute.md +0 -5
  348. package/docs/examples/databases/create-string-attribute.md +0 -6
  349. package/docs/examples/databases/create-transaction.md +0 -1
  350. package/docs/examples/databases/create-url-attribute.md +0 -5
  351. package/docs/examples/databases/create.md +0 -3
  352. package/docs/examples/databases/decrement-document-attribute.md +0 -5
  353. package/docs/examples/databases/delete-attribute.md +0 -4
  354. package/docs/examples/databases/delete-collection.md +0 -3
  355. package/docs/examples/databases/delete-document.md +0 -4
  356. package/docs/examples/databases/delete-documents.md +0 -3
  357. package/docs/examples/databases/delete-index.md +0 -4
  358. package/docs/examples/databases/delete-transaction.md +0 -2
  359. package/docs/examples/databases/delete.md +0 -2
  360. package/docs/examples/databases/get-attribute.md +0 -4
  361. package/docs/examples/databases/get-collection-usage.md +0 -3
  362. package/docs/examples/databases/get-collection.md +0 -3
  363. package/docs/examples/databases/get-document.md +0 -4
  364. package/docs/examples/databases/get-index.md +0 -4
  365. package/docs/examples/databases/get-transaction.md +0 -2
  366. package/docs/examples/databases/get-usage.md +0 -2
  367. package/docs/examples/databases/get.md +0 -2
  368. package/docs/examples/databases/increment-document-attribute.md +0 -5
  369. package/docs/examples/databases/list-attributes.md +0 -3
  370. package/docs/examples/databases/list-collection-logs.md +0 -3
  371. package/docs/examples/databases/list-collections.md +0 -2
  372. package/docs/examples/databases/list-document-logs.md +0 -4
  373. package/docs/examples/databases/list-documents.md +0 -3
  374. package/docs/examples/databases/list-indexes.md +0 -3
  375. package/docs/examples/databases/list-logs.md +0 -2
  376. package/docs/examples/databases/list-transactions.md +0 -1
  377. package/docs/examples/databases/list-usage.md +0 -1
  378. package/docs/examples/databases/list.md +0 -1
  379. package/docs/examples/databases/update-boolean-attribute.md +0 -6
  380. package/docs/examples/databases/update-collection.md +0 -4
  381. package/docs/examples/databases/update-datetime-attribute.md +0 -6
  382. package/docs/examples/databases/update-document.md +0 -4
  383. package/docs/examples/databases/update-documents.md +0 -3
  384. package/docs/examples/databases/update-email-attribute.md +0 -6
  385. package/docs/examples/databases/update-enum-attribute.md +0 -7
  386. package/docs/examples/databases/update-float-attribute.md +0 -6
  387. package/docs/examples/databases/update-integer-attribute.md +0 -6
  388. package/docs/examples/databases/update-ip-attribute.md +0 -6
  389. package/docs/examples/databases/update-line-attribute.md +0 -5
  390. package/docs/examples/databases/update-point-attribute.md +0 -5
  391. package/docs/examples/databases/update-polygon-attribute.md +0 -5
  392. package/docs/examples/databases/update-relationship-attribute.md +0 -4
  393. package/docs/examples/databases/update-string-attribute.md +0 -6
  394. package/docs/examples/databases/update-transaction.md +0 -2
  395. package/docs/examples/databases/update-url-attribute.md +0 -6
  396. package/docs/examples/databases/update.md +0 -3
  397. package/docs/examples/databases/upsert-document.md +0 -5
  398. package/docs/examples/databases/upsert-documents.md +0 -4
  399. package/docs/examples/functions/create-deployment.md +0 -4
  400. package/docs/examples/functions/create-duplicate-deployment.md +0 -3
  401. package/docs/examples/functions/create-execution.md +0 -2
  402. package/docs/examples/functions/create-template-deployment.md +0 -7
  403. package/docs/examples/functions/create-variable.md +0 -4
  404. package/docs/examples/functions/create-vcs-deployment.md +0 -4
  405. package/docs/examples/functions/create.md +0 -4
  406. package/docs/examples/functions/delete-deployment.md +0 -3
  407. package/docs/examples/functions/delete-execution.md +0 -3
  408. package/docs/examples/functions/delete-variable.md +0 -3
  409. package/docs/examples/functions/delete.md +0 -2
  410. package/docs/examples/functions/get-deployment-download.md +0 -3
  411. package/docs/examples/functions/get-deployment.md +0 -3
  412. package/docs/examples/functions/get-execution.md +0 -3
  413. package/docs/examples/functions/get-template.md +0 -2
  414. package/docs/examples/functions/get-usage.md +0 -2
  415. package/docs/examples/functions/get-variable.md +0 -3
  416. package/docs/examples/functions/get.md +0 -2
  417. package/docs/examples/functions/list-deployments.md +0 -2
  418. package/docs/examples/functions/list-executions.md +0 -2
  419. package/docs/examples/functions/list-runtimes.md +0 -1
  420. package/docs/examples/functions/list-specifications.md +0 -1
  421. package/docs/examples/functions/list-templates.md +0 -1
  422. package/docs/examples/functions/list-usage.md +0 -1
  423. package/docs/examples/functions/list-variables.md +0 -2
  424. package/docs/examples/functions/list.md +0 -1
  425. package/docs/examples/functions/update-deployment-status.md +0 -3
  426. package/docs/examples/functions/update-function-deployment.md +0 -3
  427. package/docs/examples/functions/update-variable.md +0 -4
  428. package/docs/examples/functions/update.md +0 -3
  429. package/docs/examples/graphql/mutation.md +0 -2
  430. package/docs/examples/graphql/query.md +0 -2
  431. package/docs/examples/health/get-antivirus.md +0 -1
  432. package/docs/examples/health/get-cache.md +0 -1
  433. package/docs/examples/health/get-certificate.md +0 -1
  434. package/docs/examples/health/get-db.md +0 -1
  435. package/docs/examples/health/get-failed-jobs.md +0 -2
  436. package/docs/examples/health/get-pub-sub.md +0 -1
  437. package/docs/examples/health/get-queue-builds.md +0 -1
  438. package/docs/examples/health/get-queue-certificates.md +0 -1
  439. package/docs/examples/health/get-queue-databases.md +0 -1
  440. package/docs/examples/health/get-queue-deletes.md +0 -1
  441. package/docs/examples/health/get-queue-functions.md +0 -1
  442. package/docs/examples/health/get-queue-logs.md +0 -1
  443. package/docs/examples/health/get-queue-mails.md +0 -1
  444. package/docs/examples/health/get-queue-messaging.md +0 -1
  445. package/docs/examples/health/get-queue-migrations.md +0 -1
  446. package/docs/examples/health/get-queue-stats-resources.md +0 -1
  447. package/docs/examples/health/get-queue-usage.md +0 -1
  448. package/docs/examples/health/get-queue-webhooks.md +0 -1
  449. package/docs/examples/health/get-storage-local.md +0 -1
  450. package/docs/examples/health/get-storage.md +0 -1
  451. package/docs/examples/health/get-time.md +0 -1
  452. package/docs/examples/health/get.md +0 -1
  453. package/docs/examples/locale/get.md +0 -1
  454. package/docs/examples/locale/list-codes.md +0 -1
  455. package/docs/examples/locale/list-continents.md +0 -1
  456. package/docs/examples/locale/list-countries-eu.md +0 -1
  457. package/docs/examples/locale/list-countries-phones.md +0 -1
  458. package/docs/examples/locale/list-countries.md +0 -1
  459. package/docs/examples/locale/list-currencies.md +0 -1
  460. package/docs/examples/locale/list-languages.md +0 -1
  461. package/docs/examples/messaging/create-apns-provider.md +0 -3
  462. package/docs/examples/messaging/create-email.md +0 -4
  463. package/docs/examples/messaging/create-fcm-provider.md +0 -3
  464. package/docs/examples/messaging/create-mailgun-provider.md +0 -3
  465. package/docs/examples/messaging/create-msg-91-provider.md +0 -3
  466. package/docs/examples/messaging/create-push.md +0 -2
  467. package/docs/examples/messaging/create-resend-provider.md +0 -3
  468. package/docs/examples/messaging/create-sendgrid-provider.md +0 -3
  469. package/docs/examples/messaging/create-sms.md +0 -3
  470. package/docs/examples/messaging/create-smtp-provider.md +0 -4
  471. package/docs/examples/messaging/create-subscriber.md +0 -4
  472. package/docs/examples/messaging/create-telesign-provider.md +0 -3
  473. package/docs/examples/messaging/create-textmagic-provider.md +0 -3
  474. package/docs/examples/messaging/create-topic.md +0 -3
  475. package/docs/examples/messaging/create-twilio-provider.md +0 -3
  476. package/docs/examples/messaging/create-vonage-provider.md +0 -3
  477. package/docs/examples/messaging/delete-provider.md +0 -2
  478. package/docs/examples/messaging/delete-subscriber.md +0 -3
  479. package/docs/examples/messaging/delete-topic.md +0 -2
  480. package/docs/examples/messaging/delete.md +0 -2
  481. package/docs/examples/messaging/get-message.md +0 -2
  482. package/docs/examples/messaging/get-provider.md +0 -2
  483. package/docs/examples/messaging/get-subscriber.md +0 -3
  484. package/docs/examples/messaging/get-topic.md +0 -2
  485. package/docs/examples/messaging/list-message-logs.md +0 -2
  486. package/docs/examples/messaging/list-messages.md +0 -1
  487. package/docs/examples/messaging/list-provider-logs.md +0 -2
  488. package/docs/examples/messaging/list-providers.md +0 -1
  489. package/docs/examples/messaging/list-subscriber-logs.md +0 -2
  490. package/docs/examples/messaging/list-subscribers.md +0 -2
  491. package/docs/examples/messaging/list-targets.md +0 -2
  492. package/docs/examples/messaging/list-topic-logs.md +0 -2
  493. package/docs/examples/messaging/list-topics.md +0 -1
  494. package/docs/examples/messaging/update-apns-provider.md +0 -2
  495. package/docs/examples/messaging/update-email.md +0 -2
  496. package/docs/examples/messaging/update-fcm-provider.md +0 -2
  497. package/docs/examples/messaging/update-mailgun-provider.md +0 -2
  498. package/docs/examples/messaging/update-msg-91-provider.md +0 -2
  499. package/docs/examples/messaging/update-push.md +0 -2
  500. package/docs/examples/messaging/update-resend-provider.md +0 -2
  501. package/docs/examples/messaging/update-sendgrid-provider.md +0 -2
  502. package/docs/examples/messaging/update-sms.md +0 -2
  503. package/docs/examples/messaging/update-smtp-provider.md +0 -2
  504. package/docs/examples/messaging/update-telesign-provider.md +0 -2
  505. package/docs/examples/messaging/update-textmagic-provider.md +0 -2
  506. package/docs/examples/messaging/update-topic.md +0 -2
  507. package/docs/examples/messaging/update-twilio-provider.md +0 -2
  508. package/docs/examples/messaging/update-vonage-provider.md +0 -2
  509. package/docs/examples/migrations/create-appwrite-migration.md +0 -5
  510. package/docs/examples/migrations/create-csv-export.md +0 -3
  511. package/docs/examples/migrations/create-csv-import.md +0 -4
  512. package/docs/examples/migrations/create-firebase-migration.md +0 -3
  513. package/docs/examples/migrations/create-n-host-migration.md +0 -8
  514. package/docs/examples/migrations/create-supabase-migration.md +0 -7
  515. package/docs/examples/migrations/delete.md +0 -2
  516. package/docs/examples/migrations/get-appwrite-report.md +0 -5
  517. package/docs/examples/migrations/get-firebase-report.md +0 -3
  518. package/docs/examples/migrations/get-n-host-report.md +0 -8
  519. package/docs/examples/migrations/get-supabase-report.md +0 -7
  520. package/docs/examples/migrations/get.md +0 -2
  521. package/docs/examples/migrations/list.md +0 -1
  522. package/docs/examples/migrations/retry.md +0 -2
  523. package/docs/examples/project/create-variable.md +0 -3
  524. package/docs/examples/project/delete-variable.md +0 -2
  525. package/docs/examples/project/get-usage.md +0 -3
  526. package/docs/examples/project/get-variable.md +0 -2
  527. package/docs/examples/project/list-variables.md +0 -1
  528. package/docs/examples/project/update-variable.md +0 -3
  529. package/docs/examples/projects/create-dev-key.md +0 -4
  530. package/docs/examples/projects/create-jwt.md +0 -3
  531. package/docs/examples/projects/create-key.md +0 -4
  532. package/docs/examples/projects/create-platform.md +0 -4
  533. package/docs/examples/projects/create-smtp-test.md +0 -6
  534. package/docs/examples/projects/create-webhook.md +0 -6
  535. package/docs/examples/projects/create.md +0 -4
  536. package/docs/examples/projects/delete-dev-key.md +0 -3
  537. package/docs/examples/projects/delete-email-template.md +0 -4
  538. package/docs/examples/projects/delete-key.md +0 -3
  539. package/docs/examples/projects/delete-platform.md +0 -3
  540. package/docs/examples/projects/delete-sms-template.md +0 -4
  541. package/docs/examples/projects/delete-webhook.md +0 -3
  542. package/docs/examples/projects/delete.md +0 -2
  543. package/docs/examples/projects/get-dev-key.md +0 -3
  544. package/docs/examples/projects/get-email-template.md +0 -4
  545. package/docs/examples/projects/get-key.md +0 -3
  546. package/docs/examples/projects/get-platform.md +0 -3
  547. package/docs/examples/projects/get-sms-template.md +0 -4
  548. package/docs/examples/projects/get-webhook.md +0 -3
  549. package/docs/examples/projects/get.md +0 -2
  550. package/docs/examples/projects/list-dev-keys.md +0 -2
  551. package/docs/examples/projects/list-keys.md +0 -2
  552. package/docs/examples/projects/list-platforms.md +0 -2
  553. package/docs/examples/projects/list-webhooks.md +0 -2
  554. package/docs/examples/projects/list.md +0 -1
  555. package/docs/examples/projects/update-api-status-all.md +0 -3
  556. package/docs/examples/projects/update-api-status.md +0 -4
  557. package/docs/examples/projects/update-auth-duration.md +0 -3
  558. package/docs/examples/projects/update-auth-limit.md +0 -3
  559. package/docs/examples/projects/update-auth-password-dictionary.md +0 -3
  560. package/docs/examples/projects/update-auth-password-history.md +0 -3
  561. package/docs/examples/projects/update-auth-sessions-limit.md +0 -3
  562. package/docs/examples/projects/update-auth-status.md +0 -4
  563. package/docs/examples/projects/update-dev-key.md +0 -5
  564. package/docs/examples/projects/update-email-template.md +0 -6
  565. package/docs/examples/projects/update-key.md +0 -5
  566. package/docs/examples/projects/update-memberships-privacy.md +0 -5
  567. package/docs/examples/projects/update-mock-numbers.md +0 -3
  568. package/docs/examples/projects/update-o-auth-2.md +0 -3
  569. package/docs/examples/projects/update-personal-data-check.md +0 -3
  570. package/docs/examples/projects/update-platform.md +0 -4
  571. package/docs/examples/projects/update-service-status-all.md +0 -3
  572. package/docs/examples/projects/update-service-status.md +0 -4
  573. package/docs/examples/projects/update-session-alerts.md +0 -3
  574. package/docs/examples/projects/update-session-invalidation.md +0 -3
  575. package/docs/examples/projects/update-sms-template.md +0 -5
  576. package/docs/examples/projects/update-smtp.md +0 -3
  577. package/docs/examples/projects/update-team.md +0 -3
  578. package/docs/examples/projects/update-webhook-signature.md +0 -3
  579. package/docs/examples/projects/update-webhook.md +0 -7
  580. package/docs/examples/projects/update.md +0 -3
  581. package/docs/examples/proxy/create-api-rule.md +0 -2
  582. package/docs/examples/proxy/create-function-rule.md +0 -3
  583. package/docs/examples/proxy/create-redirect-rule.md +0 -6
  584. package/docs/examples/proxy/create-site-rule.md +0 -3
  585. package/docs/examples/proxy/delete-rule.md +0 -2
  586. package/docs/examples/proxy/get-rule.md +0 -2
  587. package/docs/examples/proxy/list-rules.md +0 -1
  588. package/docs/examples/proxy/update-rule-verification.md +0 -2
  589. package/docs/examples/sites/create-deployment.md +0 -4
  590. package/docs/examples/sites/create-duplicate-deployment.md +0 -3
  591. package/docs/examples/sites/create-template-deployment.md +0 -7
  592. package/docs/examples/sites/create-variable.md +0 -4
  593. package/docs/examples/sites/create-vcs-deployment.md +0 -4
  594. package/docs/examples/sites/create.md +0 -5
  595. package/docs/examples/sites/delete-deployment.md +0 -3
  596. package/docs/examples/sites/delete-log.md +0 -3
  597. package/docs/examples/sites/delete-variable.md +0 -3
  598. package/docs/examples/sites/delete.md +0 -2
  599. package/docs/examples/sites/get-deployment-download.md +0 -3
  600. package/docs/examples/sites/get-deployment.md +0 -3
  601. package/docs/examples/sites/get-log.md +0 -3
  602. package/docs/examples/sites/get-template.md +0 -2
  603. package/docs/examples/sites/get-usage.md +0 -2
  604. package/docs/examples/sites/get-variable.md +0 -3
  605. package/docs/examples/sites/get.md +0 -2
  606. package/docs/examples/sites/list-deployments.md +0 -2
  607. package/docs/examples/sites/list-frameworks.md +0 -1
  608. package/docs/examples/sites/list-logs.md +0 -2
  609. package/docs/examples/sites/list-specifications.md +0 -1
  610. package/docs/examples/sites/list-templates.md +0 -1
  611. package/docs/examples/sites/list-usage.md +0 -1
  612. package/docs/examples/sites/list-variables.md +0 -2
  613. package/docs/examples/sites/list.md +0 -1
  614. package/docs/examples/sites/update-deployment-status.md +0 -3
  615. package/docs/examples/sites/update-site-deployment.md +0 -3
  616. package/docs/examples/sites/update-variable.md +0 -4
  617. package/docs/examples/sites/update.md +0 -4
  618. package/docs/examples/storage/create-bucket.md +0 -3
  619. package/docs/examples/storage/create-file.md +0 -4
  620. package/docs/examples/storage/delete-bucket.md +0 -2
  621. package/docs/examples/storage/delete-file.md +0 -3
  622. package/docs/examples/storage/get-bucket-usage.md +0 -2
  623. package/docs/examples/storage/get-bucket.md +0 -2
  624. package/docs/examples/storage/get-file-download.md +0 -3
  625. package/docs/examples/storage/get-file-preview.md +0 -3
  626. package/docs/examples/storage/get-file-view.md +0 -3
  627. package/docs/examples/storage/get-file.md +0 -3
  628. package/docs/examples/storage/get-usage.md +0 -1
  629. package/docs/examples/storage/list-buckets.md +0 -1
  630. package/docs/examples/storage/list-files.md +0 -2
  631. package/docs/examples/storage/update-bucket.md +0 -3
  632. package/docs/examples/storage/update-file.md +0 -3
  633. package/docs/examples/tablesdb/create-boolean-column.md +0 -5
  634. package/docs/examples/tablesdb/create-datetime-column.md +0 -5
  635. package/docs/examples/tablesdb/create-email-column.md +0 -5
  636. package/docs/examples/tablesdb/create-enum-column.md +0 -6
  637. package/docs/examples/tablesdb/create-float-column.md +0 -5
  638. package/docs/examples/tablesdb/create-index.md +0 -6
  639. package/docs/examples/tablesdb/create-integer-column.md +0 -5
  640. package/docs/examples/tablesdb/create-ip-column.md +0 -5
  641. package/docs/examples/tablesdb/create-line-column.md +0 -5
  642. package/docs/examples/tablesdb/create-operations.md +0 -2
  643. package/docs/examples/tablesdb/create-point-column.md +0 -5
  644. package/docs/examples/tablesdb/create-polygon-column.md +0 -5
  645. package/docs/examples/tablesdb/create-relationship-column.md +0 -5
  646. package/docs/examples/tablesdb/create-row.md +0 -5
  647. package/docs/examples/tablesdb/create-rows.md +0 -4
  648. package/docs/examples/tablesdb/create-string-column.md +0 -6
  649. package/docs/examples/tablesdb/create-table.md +0 -4
  650. package/docs/examples/tablesdb/create-transaction.md +0 -1
  651. package/docs/examples/tablesdb/create-url-column.md +0 -5
  652. package/docs/examples/tablesdb/create.md +0 -3
  653. package/docs/examples/tablesdb/decrement-row-column.md +0 -5
  654. package/docs/examples/tablesdb/delete-column.md +0 -4
  655. package/docs/examples/tablesdb/delete-index.md +0 -4
  656. package/docs/examples/tablesdb/delete-row.md +0 -4
  657. package/docs/examples/tablesdb/delete-rows.md +0 -3
  658. package/docs/examples/tablesdb/delete-table.md +0 -3
  659. package/docs/examples/tablesdb/delete-transaction.md +0 -2
  660. package/docs/examples/tablesdb/delete.md +0 -2
  661. package/docs/examples/tablesdb/get-column.md +0 -4
  662. package/docs/examples/tablesdb/get-index.md +0 -4
  663. package/docs/examples/tablesdb/get-row.md +0 -4
  664. package/docs/examples/tablesdb/get-table-usage.md +0 -3
  665. package/docs/examples/tablesdb/get-table.md +0 -3
  666. package/docs/examples/tablesdb/get-transaction.md +0 -2
  667. package/docs/examples/tablesdb/get-usage.md +0 -2
  668. package/docs/examples/tablesdb/get.md +0 -2
  669. package/docs/examples/tablesdb/increment-row-column.md +0 -5
  670. package/docs/examples/tablesdb/list-columns.md +0 -3
  671. package/docs/examples/tablesdb/list-indexes.md +0 -3
  672. package/docs/examples/tablesdb/list-row-logs.md +0 -4
  673. package/docs/examples/tablesdb/list-rows.md +0 -3
  674. package/docs/examples/tablesdb/list-table-logs.md +0 -3
  675. package/docs/examples/tablesdb/list-tables.md +0 -2
  676. package/docs/examples/tablesdb/list-transactions.md +0 -1
  677. package/docs/examples/tablesdb/list-usage.md +0 -1
  678. package/docs/examples/tablesdb/list.md +0 -1
  679. package/docs/examples/tablesdb/update-boolean-column.md +0 -6
  680. package/docs/examples/tablesdb/update-datetime-column.md +0 -6
  681. package/docs/examples/tablesdb/update-email-column.md +0 -6
  682. package/docs/examples/tablesdb/update-enum-column.md +0 -7
  683. package/docs/examples/tablesdb/update-float-column.md +0 -6
  684. package/docs/examples/tablesdb/update-integer-column.md +0 -6
  685. package/docs/examples/tablesdb/update-ip-column.md +0 -6
  686. package/docs/examples/tablesdb/update-line-column.md +0 -5
  687. package/docs/examples/tablesdb/update-point-column.md +0 -5
  688. package/docs/examples/tablesdb/update-polygon-column.md +0 -5
  689. package/docs/examples/tablesdb/update-relationship-column.md +0 -4
  690. package/docs/examples/tablesdb/update-row.md +0 -4
  691. package/docs/examples/tablesdb/update-rows.md +0 -3
  692. package/docs/examples/tablesdb/update-string-column.md +0 -6
  693. package/docs/examples/tablesdb/update-table.md +0 -4
  694. package/docs/examples/tablesdb/update-transaction.md +0 -2
  695. package/docs/examples/tablesdb/update-url-column.md +0 -6
  696. package/docs/examples/tablesdb/update.md +0 -3
  697. package/docs/examples/tablesdb/upsert-row.md +0 -4
  698. package/docs/examples/tablesdb/upsert-rows.md +0 -4
  699. package/docs/examples/teams/create-membership.md +0 -3
  700. package/docs/examples/teams/create.md +0 -3
  701. package/docs/examples/teams/delete-membership.md +0 -3
  702. package/docs/examples/teams/delete.md +0 -2
  703. package/docs/examples/teams/get-membership.md +0 -3
  704. package/docs/examples/teams/get-prefs.md +0 -2
  705. package/docs/examples/teams/get.md +0 -2
  706. package/docs/examples/teams/list-logs.md +0 -2
  707. package/docs/examples/teams/list-memberships.md +0 -2
  708. package/docs/examples/teams/list.md +0 -1
  709. package/docs/examples/teams/update-membership-status.md +0 -5
  710. package/docs/examples/teams/update-membership.md +0 -4
  711. package/docs/examples/teams/update-name.md +0 -3
  712. package/docs/examples/teams/update-prefs.md +0 -3
  713. package/docs/examples/tokens/create-file-token.md +0 -3
  714. package/docs/examples/tokens/delete.md +0 -2
  715. package/docs/examples/tokens/get.md +0 -2
  716. package/docs/examples/tokens/list.md +0 -3
  717. package/docs/examples/tokens/update.md +0 -2
  718. package/docs/examples/users/create-argon-2-user.md +0 -4
  719. package/docs/examples/users/create-bcrypt-user.md +0 -4
  720. package/docs/examples/users/create-jwt.md +0 -2
  721. package/docs/examples/users/create-md-5-user.md +0 -4
  722. package/docs/examples/users/create-mfa-recovery-codes.md +0 -2
  723. package/docs/examples/users/create-ph-pass-user.md +0 -4
  724. package/docs/examples/users/create-scrypt-modified-user.md +0 -7
  725. package/docs/examples/users/create-scrypt-user.md +0 -9
  726. package/docs/examples/users/create-session.md +0 -2
  727. package/docs/examples/users/create-sha-user.md +0 -4
  728. package/docs/examples/users/create-target.md +0 -5
  729. package/docs/examples/users/create-token.md +0 -2
  730. package/docs/examples/users/create.md +0 -2
  731. package/docs/examples/users/delete-identity.md +0 -2
  732. package/docs/examples/users/delete-mfa-authenticator.md +0 -3
  733. package/docs/examples/users/delete-session.md +0 -3
  734. package/docs/examples/users/delete-sessions.md +0 -2
  735. package/docs/examples/users/delete-target.md +0 -3
  736. package/docs/examples/users/delete.md +0 -2
  737. package/docs/examples/users/get-mfa-recovery-codes.md +0 -2
  738. package/docs/examples/users/get-prefs.md +0 -2
  739. package/docs/examples/users/get-target.md +0 -3
  740. package/docs/examples/users/get-usage.md +0 -1
  741. package/docs/examples/users/get.md +0 -2
  742. package/docs/examples/users/list-identities.md +0 -1
  743. package/docs/examples/users/list-logs.md +0 -2
  744. package/docs/examples/users/list-memberships.md +0 -2
  745. package/docs/examples/users/list-mfa-factors.md +0 -2
  746. package/docs/examples/users/list-sessions.md +0 -2
  747. package/docs/examples/users/list-targets.md +0 -2
  748. package/docs/examples/users/list.md +0 -1
  749. package/docs/examples/users/update-email-verification.md +0 -3
  750. package/docs/examples/users/update-email.md +0 -3
  751. package/docs/examples/users/update-labels.md +0 -3
  752. package/docs/examples/users/update-mfa-recovery-codes.md +0 -2
  753. package/docs/examples/users/update-mfa.md +0 -3
  754. package/docs/examples/users/update-name.md +0 -3
  755. package/docs/examples/users/update-password.md +0 -3
  756. package/docs/examples/users/update-phone-verification.md +0 -3
  757. package/docs/examples/users/update-phone.md +0 -3
  758. package/docs/examples/users/update-prefs.md +0 -3
  759. package/docs/examples/users/update-status.md +0 -3
  760. package/docs/examples/users/update-target.md +0 -3
  761. package/docs/examples/vcs/create-repository-detection.md +0 -4
  762. package/docs/examples/vcs/create-repository.md +0 -4
  763. package/docs/examples/vcs/delete-installation.md +0 -2
  764. package/docs/examples/vcs/get-installation.md +0 -2
  765. package/docs/examples/vcs/get-repository-contents.md +0 -3
  766. package/docs/examples/vcs/get-repository.md +0 -3
  767. package/docs/examples/vcs/list-installations.md +0 -1
  768. package/docs/examples/vcs/list-repositories.md +0 -3
  769. package/docs/examples/vcs/list-repository-branches.md +0 -3
  770. package/docs/examples/vcs/update-external-deployments.md +0 -4
  771. package/index.js +0 -147
  772. package/lib/client.js +0 -254
  773. package/lib/commands/account.js +0 -2121
  774. package/lib/commands/console.js +0 -127
  775. package/lib/commands/databases.js +0 -3590
  776. package/lib/commands/functions.js +0 -1732
  777. package/lib/commands/generic.js +0 -330
  778. package/lib/commands/graphql.js +0 -126
  779. package/lib/commands/health.js +0 -869
  780. package/lib/commands/locale.js +0 -316
  781. package/lib/commands/messaging.js +0 -3116
  782. package/lib/commands/migrations.js +0 -830
  783. package/lib/commands/organizations.js +0 -48
  784. package/lib/commands/project.js +0 -302
  785. package/lib/commands/projects.js +0 -2626
  786. package/lib/commands/proxy.js +0 -403
  787. package/lib/commands/push.js +0 -2570
  788. package/lib/commands/sites.js +0 -1654
  789. package/lib/commands/storage.js +0 -995
  790. package/lib/commands/tables-db.js +0 -3569
  791. package/lib/commands/teams.js +0 -683
  792. package/lib/commands/tokens.js +0 -261
  793. package/lib/commands/types.js +0 -191
  794. package/lib/commands/users.js +0 -2022
  795. package/lib/commands/vcs.js +0 -484
  796. package/lib/emulation/docker.js +0 -264
  797. package/lib/exception.js +0 -9
  798. package/lib/parser.js +0 -250
  799. package/lib/sdks.js +0 -60
  800. package/lib/spinner.js +0 -104
  801. package/lib/validations.js +0 -17
@@ -1,2022 +0,0 @@
1
- const fs = require('fs');
2
- const pathLib = require('path');
3
- const tar = require("tar");
4
- const ignore = require("ignore");
5
- const { promisify } = require('util');
6
- const libClient = require('../client.js');
7
- const { getAllFiles, showConsoleLink } = require('../utils.js');
8
- const { Command } = require('commander');
9
- const { sdkForProject, sdkForConsole } = require('../sdks')
10
- const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log, warn } = require('../parser')
11
- const { localConfig, globalConfig } = require("../config");
12
- const { File } = require('undici');
13
- const { ReadableStream } = require('stream/web');
14
-
15
- /**
16
- * @param {fs.ReadStream} readStream
17
- * @returns {ReadableStream}
18
- */
19
- function convertReadStreamToReadableStream(readStream) {
20
- return new ReadableStream({
21
- start(controller) {
22
- readStream.on("data", (chunk) => {
23
- controller.enqueue(chunk);
24
- });
25
- readStream.on("end", () => {
26
- controller.close();
27
- });
28
- readStream.on("error", (err) => {
29
- controller.error(err);
30
- });
31
- },
32
- cancel() {
33
- readStream.destroy();
34
- },
35
- });
36
- }
37
-
38
- const users = new Command("users").description(commandDescriptions['users'] ?? '').configureHelp({
39
- helpWidth: process.stdout.columns || 80
40
- })
41
-
42
- /**
43
- * @typedef {Object} UsersListRequestParams
44
- * @property {string[]} queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels
45
- * @property {string} search Search term to filter your list results. Max length: 256 chars.
46
- * @property {boolean} total When set to false, the total count returned will be 0 and will not be calculated.
47
- * @property {boolean} overrideForCli
48
- * @property {boolean} parseOutput
49
- * @property {libClient | undefined} sdk
50
- */
51
-
52
- /**
53
- * @param {UsersListRequestParams} params
54
- */
55
- const usersList = async ({queries,search,total,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
56
- let client = !sdk ? await sdkForProject() :
57
- sdk;
58
- let apiPath = '/users';
59
- let payload = {};
60
- if (typeof queries !== 'undefined') {
61
- payload['queries'] = queries;
62
- }
63
- if (typeof search !== 'undefined') {
64
- payload['search'] = search;
65
- }
66
- if (typeof total !== 'undefined') {
67
- payload['total'] = total;
68
- }
69
-
70
- let response = undefined;
71
-
72
- response = await client.call('get', apiPath, {
73
- }, payload);
74
-
75
- if (parseOutput) {
76
- if(console) {
77
- showConsoleLink('users', 'list');
78
- } else {
79
- parse(response)
80
- }
81
- }
82
-
83
- return response;
84
-
85
- }
86
- /**
87
- * @typedef {Object} UsersCreateRequestParams
88
- * @property {string} userId User ID. Choose a custom ID or generate a random ID with 'ID.unique()'. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
89
- * @property {string} email User email.
90
- * @property {string} phone Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
91
- * @property {string} password Plain text user password. Must be at least 8 chars.
92
- * @property {string} name User name. Max length: 128 chars.
93
- * @property {boolean} overrideForCli
94
- * @property {boolean} parseOutput
95
- * @property {libClient | undefined} sdk
96
- */
97
-
98
- /**
99
- * @param {UsersCreateRequestParams} params
100
- */
101
- const usersCreate = async ({userId,email,phone,password,name,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
102
- let client = !sdk ? await sdkForProject() :
103
- sdk;
104
- let apiPath = '/users';
105
- let payload = {};
106
- if (typeof userId !== 'undefined') {
107
- payload['userId'] = userId;
108
- }
109
- if (typeof email !== 'undefined') {
110
- payload['email'] = email;
111
- }
112
- if (typeof phone !== 'undefined') {
113
- payload['phone'] = phone;
114
- }
115
- if (typeof password !== 'undefined') {
116
- payload['password'] = password;
117
- }
118
- if (typeof name !== 'undefined') {
119
- payload['name'] = name;
120
- }
121
-
122
- let response = undefined;
123
-
124
- response = await client.call('post', apiPath, {
125
- 'content-type': 'application/json',
126
- }, payload);
127
-
128
- if (parseOutput) {
129
- parse(response)
130
- }
131
-
132
- return response;
133
-
134
- }
135
- /**
136
- * @typedef {Object} UsersCreateArgon2UserRequestParams
137
- * @property {string} userId User ID. Choose a custom ID or generate a random ID with 'ID.unique()'. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
138
- * @property {string} email User email.
139
- * @property {string} password User password hashed using Argon2.
140
- * @property {string} name User name. Max length: 128 chars.
141
- * @property {boolean} overrideForCli
142
- * @property {boolean} parseOutput
143
- * @property {libClient | undefined} sdk
144
- */
145
-
146
- /**
147
- * @param {UsersCreateArgon2UserRequestParams} params
148
- */
149
- const usersCreateArgon2User = async ({userId,email,password,name,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
150
- let client = !sdk ? await sdkForProject() :
151
- sdk;
152
- let apiPath = '/users/argon2';
153
- let payload = {};
154
- if (typeof userId !== 'undefined') {
155
- payload['userId'] = userId;
156
- }
157
- if (typeof email !== 'undefined') {
158
- payload['email'] = email;
159
- }
160
- if (typeof password !== 'undefined') {
161
- payload['password'] = password;
162
- }
163
- if (typeof name !== 'undefined') {
164
- payload['name'] = name;
165
- }
166
-
167
- let response = undefined;
168
-
169
- response = await client.call('post', apiPath, {
170
- 'content-type': 'application/json',
171
- }, payload);
172
-
173
- if (parseOutput) {
174
- parse(response)
175
- }
176
-
177
- return response;
178
-
179
- }
180
- /**
181
- * @typedef {Object} UsersCreateBcryptUserRequestParams
182
- * @property {string} userId User ID. Choose a custom ID or generate a random ID with 'ID.unique()'. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
183
- * @property {string} email User email.
184
- * @property {string} password User password hashed using Bcrypt.
185
- * @property {string} name User name. Max length: 128 chars.
186
- * @property {boolean} overrideForCli
187
- * @property {boolean} parseOutput
188
- * @property {libClient | undefined} sdk
189
- */
190
-
191
- /**
192
- * @param {UsersCreateBcryptUserRequestParams} params
193
- */
194
- const usersCreateBcryptUser = async ({userId,email,password,name,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
195
- let client = !sdk ? await sdkForProject() :
196
- sdk;
197
- let apiPath = '/users/bcrypt';
198
- let payload = {};
199
- if (typeof userId !== 'undefined') {
200
- payload['userId'] = userId;
201
- }
202
- if (typeof email !== 'undefined') {
203
- payload['email'] = email;
204
- }
205
- if (typeof password !== 'undefined') {
206
- payload['password'] = password;
207
- }
208
- if (typeof name !== 'undefined') {
209
- payload['name'] = name;
210
- }
211
-
212
- let response = undefined;
213
-
214
- response = await client.call('post', apiPath, {
215
- 'content-type': 'application/json',
216
- }, payload);
217
-
218
- if (parseOutput) {
219
- parse(response)
220
- }
221
-
222
- return response;
223
-
224
- }
225
- /**
226
- * @typedef {Object} UsersListIdentitiesRequestParams
227
- * @property {string[]} queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, provider, providerUid, providerEmail, providerAccessTokenExpiry
228
- * @property {string} search Search term to filter your list results. Max length: 256 chars.
229
- * @property {boolean} total When set to false, the total count returned will be 0 and will not be calculated.
230
- * @property {boolean} overrideForCli
231
- * @property {boolean} parseOutput
232
- * @property {libClient | undefined} sdk
233
- */
234
-
235
- /**
236
- * @param {UsersListIdentitiesRequestParams} params
237
- */
238
- const usersListIdentities = async ({queries,search,total,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
239
- let client = !sdk ? await sdkForProject() :
240
- sdk;
241
- let apiPath = '/users/identities';
242
- let payload = {};
243
- if (typeof queries !== 'undefined') {
244
- payload['queries'] = queries;
245
- }
246
- if (typeof search !== 'undefined') {
247
- payload['search'] = search;
248
- }
249
- if (typeof total !== 'undefined') {
250
- payload['total'] = total;
251
- }
252
-
253
- let response = undefined;
254
-
255
- response = await client.call('get', apiPath, {
256
- }, payload);
257
-
258
- if (parseOutput) {
259
- parse(response)
260
- }
261
-
262
- return response;
263
-
264
- }
265
- /**
266
- * @typedef {Object} UsersDeleteIdentityRequestParams
267
- * @property {string} identityId Identity ID.
268
- * @property {boolean} overrideForCli
269
- * @property {boolean} parseOutput
270
- * @property {libClient | undefined} sdk
271
- */
272
-
273
- /**
274
- * @param {UsersDeleteIdentityRequestParams} params
275
- */
276
- const usersDeleteIdentity = async ({identityId,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
277
- let client = !sdk ? await sdkForProject() :
278
- sdk;
279
- let apiPath = '/users/identities/{identityId}'.replace('{identityId}', identityId);
280
- let payload = {};
281
-
282
- let response = undefined;
283
-
284
- response = await client.call('delete', apiPath, {
285
- 'content-type': 'application/json',
286
- }, payload);
287
-
288
- if (parseOutput) {
289
- parse(response)
290
- }
291
-
292
- return response;
293
-
294
- }
295
- /**
296
- * @typedef {Object} UsersCreateMD5UserRequestParams
297
- * @property {string} userId User ID. Choose a custom ID or generate a random ID with 'ID.unique()'. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
298
- * @property {string} email User email.
299
- * @property {string} password User password hashed using MD5.
300
- * @property {string} name User name. Max length: 128 chars.
301
- * @property {boolean} overrideForCli
302
- * @property {boolean} parseOutput
303
- * @property {libClient | undefined} sdk
304
- */
305
-
306
- /**
307
- * @param {UsersCreateMD5UserRequestParams} params
308
- */
309
- const usersCreateMD5User = async ({userId,email,password,name,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
310
- let client = !sdk ? await sdkForProject() :
311
- sdk;
312
- let apiPath = '/users/md5';
313
- let payload = {};
314
- if (typeof userId !== 'undefined') {
315
- payload['userId'] = userId;
316
- }
317
- if (typeof email !== 'undefined') {
318
- payload['email'] = email;
319
- }
320
- if (typeof password !== 'undefined') {
321
- payload['password'] = password;
322
- }
323
- if (typeof name !== 'undefined') {
324
- payload['name'] = name;
325
- }
326
-
327
- let response = undefined;
328
-
329
- response = await client.call('post', apiPath, {
330
- 'content-type': 'application/json',
331
- }, payload);
332
-
333
- if (parseOutput) {
334
- parse(response)
335
- }
336
-
337
- return response;
338
-
339
- }
340
- /**
341
- * @typedef {Object} UsersCreatePHPassUserRequestParams
342
- * @property {string} userId User ID. Choose a custom ID or pass the string 'ID.unique()'to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
343
- * @property {string} email User email.
344
- * @property {string} password User password hashed using PHPass.
345
- * @property {string} name User name. Max length: 128 chars.
346
- * @property {boolean} overrideForCli
347
- * @property {boolean} parseOutput
348
- * @property {libClient | undefined} sdk
349
- */
350
-
351
- /**
352
- * @param {UsersCreatePHPassUserRequestParams} params
353
- */
354
- const usersCreatePHPassUser = async ({userId,email,password,name,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
355
- let client = !sdk ? await sdkForProject() :
356
- sdk;
357
- let apiPath = '/users/phpass';
358
- let payload = {};
359
- if (typeof userId !== 'undefined') {
360
- payload['userId'] = userId;
361
- }
362
- if (typeof email !== 'undefined') {
363
- payload['email'] = email;
364
- }
365
- if (typeof password !== 'undefined') {
366
- payload['password'] = password;
367
- }
368
- if (typeof name !== 'undefined') {
369
- payload['name'] = name;
370
- }
371
-
372
- let response = undefined;
373
-
374
- response = await client.call('post', apiPath, {
375
- 'content-type': 'application/json',
376
- }, payload);
377
-
378
- if (parseOutput) {
379
- parse(response)
380
- }
381
-
382
- return response;
383
-
384
- }
385
- /**
386
- * @typedef {Object} UsersCreateScryptUserRequestParams
387
- * @property {string} userId User ID. Choose a custom ID or generate a random ID with 'ID.unique()'. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
388
- * @property {string} email User email.
389
- * @property {string} password User password hashed using Scrypt.
390
- * @property {string} passwordSalt Optional salt used to hash password.
391
- * @property {number} passwordCpu Optional CPU cost used to hash password.
392
- * @property {number} passwordMemory Optional memory cost used to hash password.
393
- * @property {number} passwordParallel Optional parallelization cost used to hash password.
394
- * @property {number} passwordLength Optional hash length used to hash password.
395
- * @property {string} name User name. Max length: 128 chars.
396
- * @property {boolean} overrideForCli
397
- * @property {boolean} parseOutput
398
- * @property {libClient | undefined} sdk
399
- */
400
-
401
- /**
402
- * @param {UsersCreateScryptUserRequestParams} params
403
- */
404
- const usersCreateScryptUser = async ({userId,email,password,passwordSalt,passwordCpu,passwordMemory,passwordParallel,passwordLength,name,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
405
- let client = !sdk ? await sdkForProject() :
406
- sdk;
407
- let apiPath = '/users/scrypt';
408
- let payload = {};
409
- if (typeof userId !== 'undefined') {
410
- payload['userId'] = userId;
411
- }
412
- if (typeof email !== 'undefined') {
413
- payload['email'] = email;
414
- }
415
- if (typeof password !== 'undefined') {
416
- payload['password'] = password;
417
- }
418
- if (typeof passwordSalt !== 'undefined') {
419
- payload['passwordSalt'] = passwordSalt;
420
- }
421
- if (typeof passwordCpu !== 'undefined') {
422
- payload['passwordCpu'] = passwordCpu;
423
- }
424
- if (typeof passwordMemory !== 'undefined') {
425
- payload['passwordMemory'] = passwordMemory;
426
- }
427
- if (typeof passwordParallel !== 'undefined') {
428
- payload['passwordParallel'] = passwordParallel;
429
- }
430
- if (typeof passwordLength !== 'undefined') {
431
- payload['passwordLength'] = passwordLength;
432
- }
433
- if (typeof name !== 'undefined') {
434
- payload['name'] = name;
435
- }
436
-
437
- let response = undefined;
438
-
439
- response = await client.call('post', apiPath, {
440
- 'content-type': 'application/json',
441
- }, payload);
442
-
443
- if (parseOutput) {
444
- parse(response)
445
- }
446
-
447
- return response;
448
-
449
- }
450
- /**
451
- * @typedef {Object} UsersCreateScryptModifiedUserRequestParams
452
- * @property {string} userId User ID. Choose a custom ID or generate a random ID with 'ID.unique()'. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
453
- * @property {string} email User email.
454
- * @property {string} password User password hashed using Scrypt Modified.
455
- * @property {string} passwordSalt Salt used to hash password.
456
- * @property {string} passwordSaltSeparator Salt separator used to hash password.
457
- * @property {string} passwordSignerKey Signer key used to hash password.
458
- * @property {string} name User name. Max length: 128 chars.
459
- * @property {boolean} overrideForCli
460
- * @property {boolean} parseOutput
461
- * @property {libClient | undefined} sdk
462
- */
463
-
464
- /**
465
- * @param {UsersCreateScryptModifiedUserRequestParams} params
466
- */
467
- const usersCreateScryptModifiedUser = async ({userId,email,password,passwordSalt,passwordSaltSeparator,passwordSignerKey,name,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
468
- let client = !sdk ? await sdkForProject() :
469
- sdk;
470
- let apiPath = '/users/scrypt-modified';
471
- let payload = {};
472
- if (typeof userId !== 'undefined') {
473
- payload['userId'] = userId;
474
- }
475
- if (typeof email !== 'undefined') {
476
- payload['email'] = email;
477
- }
478
- if (typeof password !== 'undefined') {
479
- payload['password'] = password;
480
- }
481
- if (typeof passwordSalt !== 'undefined') {
482
- payload['passwordSalt'] = passwordSalt;
483
- }
484
- if (typeof passwordSaltSeparator !== 'undefined') {
485
- payload['passwordSaltSeparator'] = passwordSaltSeparator;
486
- }
487
- if (typeof passwordSignerKey !== 'undefined') {
488
- payload['passwordSignerKey'] = passwordSignerKey;
489
- }
490
- if (typeof name !== 'undefined') {
491
- payload['name'] = name;
492
- }
493
-
494
- let response = undefined;
495
-
496
- response = await client.call('post', apiPath, {
497
- 'content-type': 'application/json',
498
- }, payload);
499
-
500
- if (parseOutput) {
501
- parse(response)
502
- }
503
-
504
- return response;
505
-
506
- }
507
- /**
508
- * @typedef {Object} UsersCreateSHAUserRequestParams
509
- * @property {string} userId User ID. Choose a custom ID or generate a random ID with 'ID.unique()'. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
510
- * @property {string} email User email.
511
- * @property {string} password User password hashed using SHA.
512
- * @property {PasswordHash} passwordVersion Optional SHA version used to hash password. Allowed values are: 'sha1', 'sha224', 'sha256', 'sha384', 'sha512/224', 'sha512/256', 'sha512', 'sha3-224', 'sha3-256', 'sha3-384', 'sha3-512'
513
- * @property {string} name User name. Max length: 128 chars.
514
- * @property {boolean} overrideForCli
515
- * @property {boolean} parseOutput
516
- * @property {libClient | undefined} sdk
517
- */
518
-
519
- /**
520
- * @param {UsersCreateSHAUserRequestParams} params
521
- */
522
- const usersCreateSHAUser = async ({userId,email,password,passwordVersion,name,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
523
- let client = !sdk ? await sdkForProject() :
524
- sdk;
525
- let apiPath = '/users/sha';
526
- let payload = {};
527
- if (typeof userId !== 'undefined') {
528
- payload['userId'] = userId;
529
- }
530
- if (typeof email !== 'undefined') {
531
- payload['email'] = email;
532
- }
533
- if (typeof password !== 'undefined') {
534
- payload['password'] = password;
535
- }
536
- if (typeof passwordVersion !== 'undefined') {
537
- payload['passwordVersion'] = passwordVersion;
538
- }
539
- if (typeof name !== 'undefined') {
540
- payload['name'] = name;
541
- }
542
-
543
- let response = undefined;
544
-
545
- response = await client.call('post', apiPath, {
546
- 'content-type': 'application/json',
547
- }, payload);
548
-
549
- if (parseOutput) {
550
- parse(response)
551
- }
552
-
553
- return response;
554
-
555
- }
556
- /**
557
- * @typedef {Object} UsersGetUsageRequestParams
558
- * @property {UsageRange} range Date range.
559
- * @property {boolean} overrideForCli
560
- * @property {boolean} parseOutput
561
- * @property {libClient | undefined} sdk
562
- */
563
-
564
- /**
565
- * @param {UsersGetUsageRequestParams} params
566
- */
567
- const usersGetUsage = async ({range,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
568
- let client = !sdk ? await sdkForProject() :
569
- sdk;
570
- let apiPath = '/users/usage';
571
- let payload = {};
572
- if (typeof range !== 'undefined') {
573
- payload['range'] = range;
574
- }
575
-
576
- let response = undefined;
577
-
578
- response = await client.call('get', apiPath, {
579
- }, payload);
580
-
581
- if (parseOutput) {
582
- parse(response)
583
- }
584
-
585
- return response;
586
-
587
- }
588
- /**
589
- * @typedef {Object} UsersGetRequestParams
590
- * @property {string} userId User ID.
591
- * @property {boolean} overrideForCli
592
- * @property {boolean} parseOutput
593
- * @property {libClient | undefined} sdk
594
- */
595
-
596
- /**
597
- * @param {UsersGetRequestParams} params
598
- */
599
- const usersGet = async ({userId,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
600
- let client = !sdk ? await sdkForProject() :
601
- sdk;
602
- let apiPath = '/users/{userId}'.replace('{userId}', userId);
603
- let payload = {};
604
-
605
- let response = undefined;
606
-
607
- response = await client.call('get', apiPath, {
608
- }, payload);
609
-
610
- if (parseOutput) {
611
- if(console) {
612
- showConsoleLink('users', 'get', userId);
613
- } else {
614
- parse(response)
615
- }
616
- }
617
-
618
- return response;
619
-
620
- }
621
- /**
622
- * @typedef {Object} UsersDeleteRequestParams
623
- * @property {string} userId User ID.
624
- * @property {boolean} overrideForCli
625
- * @property {boolean} parseOutput
626
- * @property {libClient | undefined} sdk
627
- */
628
-
629
- /**
630
- * @param {UsersDeleteRequestParams} params
631
- */
632
- const usersDelete = async ({userId,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
633
- let client = !sdk ? await sdkForProject() :
634
- sdk;
635
- let apiPath = '/users/{userId}'.replace('{userId}', userId);
636
- let payload = {};
637
-
638
- let response = undefined;
639
-
640
- response = await client.call('delete', apiPath, {
641
- 'content-type': 'application/json',
642
- }, payload);
643
-
644
- if (parseOutput) {
645
- parse(response)
646
- }
647
-
648
- return response;
649
-
650
- }
651
- /**
652
- * @typedef {Object} UsersUpdateEmailRequestParams
653
- * @property {string} userId User ID.
654
- * @property {string} email User email.
655
- * @property {boolean} overrideForCli
656
- * @property {boolean} parseOutput
657
- * @property {libClient | undefined} sdk
658
- */
659
-
660
- /**
661
- * @param {UsersUpdateEmailRequestParams} params
662
- */
663
- const usersUpdateEmail = async ({userId,email,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
664
- let client = !sdk ? await sdkForProject() :
665
- sdk;
666
- let apiPath = '/users/{userId}/email'.replace('{userId}', userId);
667
- let payload = {};
668
- if (typeof email !== 'undefined') {
669
- payload['email'] = email;
670
- }
671
-
672
- let response = undefined;
673
-
674
- response = await client.call('patch', apiPath, {
675
- 'content-type': 'application/json',
676
- }, payload);
677
-
678
- if (parseOutput) {
679
- parse(response)
680
- }
681
-
682
- return response;
683
-
684
- }
685
- /**
686
- * @typedef {Object} UsersCreateJWTRequestParams
687
- * @property {string} userId User ID.
688
- * @property {string} sessionId Session ID. Use the string 'recent' to use the most recent session. Defaults to the most recent session.
689
- * @property {number} duration Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.
690
- * @property {boolean} overrideForCli
691
- * @property {boolean} parseOutput
692
- * @property {libClient | undefined} sdk
693
- */
694
-
695
- /**
696
- * @param {UsersCreateJWTRequestParams} params
697
- */
698
- const usersCreateJWT = async ({userId,sessionId,duration,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
699
- let client = !sdk ? await sdkForProject() :
700
- sdk;
701
- let apiPath = '/users/{userId}/jwts'.replace('{userId}', userId);
702
- let payload = {};
703
- if (typeof sessionId !== 'undefined') {
704
- payload['sessionId'] = sessionId;
705
- }
706
- if (typeof duration !== 'undefined') {
707
- payload['duration'] = duration;
708
- }
709
-
710
- let response = undefined;
711
-
712
- response = await client.call('post', apiPath, {
713
- 'content-type': 'application/json',
714
- }, payload);
715
-
716
- if (parseOutput) {
717
- parse(response)
718
- }
719
-
720
- return response;
721
-
722
- }
723
- /**
724
- * @typedef {Object} UsersUpdateLabelsRequestParams
725
- * @property {string} userId User ID.
726
- * @property {string[]} labels Array of user labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.
727
- * @property {boolean} overrideForCli
728
- * @property {boolean} parseOutput
729
- * @property {libClient | undefined} sdk
730
- */
731
-
732
- /**
733
- * @param {UsersUpdateLabelsRequestParams} params
734
- */
735
- const usersUpdateLabels = async ({userId,labels,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
736
- let client = !sdk ? await sdkForProject() :
737
- sdk;
738
- let apiPath = '/users/{userId}/labels'.replace('{userId}', userId);
739
- let payload = {};
740
- labels = labels === true ? [] : labels;
741
- if (typeof labels !== 'undefined') {
742
- payload['labels'] = labels;
743
- }
744
-
745
- let response = undefined;
746
-
747
- response = await client.call('put', apiPath, {
748
- 'content-type': 'application/json',
749
- }, payload);
750
-
751
- if (parseOutput) {
752
- parse(response)
753
- }
754
-
755
- return response;
756
-
757
- }
758
- /**
759
- * @typedef {Object} UsersListLogsRequestParams
760
- * @property {string} userId User ID.
761
- * @property {string[]} queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
762
- * @property {boolean} total When set to false, the total count returned will be 0 and will not be calculated.
763
- * @property {boolean} overrideForCli
764
- * @property {boolean} parseOutput
765
- * @property {libClient | undefined} sdk
766
- */
767
-
768
- /**
769
- * @param {UsersListLogsRequestParams} params
770
- */
771
- const usersListLogs = async ({userId,queries,total,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
772
- let client = !sdk ? await sdkForProject() :
773
- sdk;
774
- let apiPath = '/users/{userId}/logs'.replace('{userId}', userId);
775
- let payload = {};
776
- if (typeof queries !== 'undefined') {
777
- payload['queries'] = queries;
778
- }
779
- if (typeof total !== 'undefined') {
780
- payload['total'] = total;
781
- }
782
-
783
- let response = undefined;
784
-
785
- response = await client.call('get', apiPath, {
786
- }, payload);
787
-
788
- if (parseOutput) {
789
- parse(response)
790
- }
791
-
792
- return response;
793
-
794
- }
795
- /**
796
- * @typedef {Object} UsersListMembershipsRequestParams
797
- * @property {string} userId User ID.
798
- * @property {string[]} queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, teamId, invited, joined, confirm, roles
799
- * @property {string} search Search term to filter your list results. Max length: 256 chars.
800
- * @property {boolean} total When set to false, the total count returned will be 0 and will not be calculated.
801
- * @property {boolean} overrideForCli
802
- * @property {boolean} parseOutput
803
- * @property {libClient | undefined} sdk
804
- */
805
-
806
- /**
807
- * @param {UsersListMembershipsRequestParams} params
808
- */
809
- const usersListMemberships = async ({userId,queries,search,total,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
810
- let client = !sdk ? await sdkForProject() :
811
- sdk;
812
- let apiPath = '/users/{userId}/memberships'.replace('{userId}', userId);
813
- let payload = {};
814
- if (typeof queries !== 'undefined') {
815
- payload['queries'] = queries;
816
- }
817
- if (typeof search !== 'undefined') {
818
- payload['search'] = search;
819
- }
820
- if (typeof total !== 'undefined') {
821
- payload['total'] = total;
822
- }
823
-
824
- let response = undefined;
825
-
826
- response = await client.call('get', apiPath, {
827
- }, payload);
828
-
829
- if (parseOutput) {
830
- parse(response)
831
- }
832
-
833
- return response;
834
-
835
- }
836
- /**
837
- * @typedef {Object} UsersUpdateMFARequestParams
838
- * @property {string} userId User ID.
839
- * @property {boolean} mfa Enable or disable MFA.
840
- * @property {boolean} overrideForCli
841
- * @property {boolean} parseOutput
842
- * @property {libClient | undefined} sdk
843
- */
844
-
845
- /**
846
- * @param {UsersUpdateMFARequestParams} params
847
- */
848
- const usersUpdateMFA = async ({userId,mfa,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
849
- let client = !sdk ? await sdkForProject() :
850
- sdk;
851
- let apiPath = '/users/{userId}/mfa'.replace('{userId}', userId);
852
- let payload = {};
853
- if (typeof mfa !== 'undefined') {
854
- payload['mfa'] = mfa;
855
- }
856
-
857
- let response = undefined;
858
-
859
- response = await client.call('patch', apiPath, {
860
- 'content-type': 'application/json',
861
- }, payload);
862
-
863
- if (parseOutput) {
864
- parse(response)
865
- }
866
-
867
- return response;
868
-
869
- }
870
- /**
871
- * @typedef {Object} UsersDeleteMFAAuthenticatorRequestParams
872
- * @property {string} userId User ID.
873
- * @property {AuthenticatorType} type Type of authenticator.
874
- * @property {boolean} overrideForCli
875
- * @property {boolean} parseOutput
876
- * @property {libClient | undefined} sdk
877
- */
878
-
879
- /**
880
- * @param {UsersDeleteMFAAuthenticatorRequestParams} params
881
- */
882
- const usersDeleteMFAAuthenticator = async ({userId,type,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
883
- let client = !sdk ? await sdkForProject() :
884
- sdk;
885
- let apiPath = '/users/{userId}/mfa/authenticators/{type}'.replace('{userId}', userId).replace('{type}', type);
886
- let payload = {};
887
-
888
- let response = undefined;
889
-
890
- response = await client.call('delete', apiPath, {
891
- 'content-type': 'application/json',
892
- }, payload);
893
-
894
- if (parseOutput) {
895
- parse(response)
896
- }
897
-
898
- return response;
899
-
900
- }
901
- /**
902
- * @typedef {Object} UsersListMFAFactorsRequestParams
903
- * @property {string} userId User ID.
904
- * @property {boolean} overrideForCli
905
- * @property {boolean} parseOutput
906
- * @property {libClient | undefined} sdk
907
- */
908
-
909
- /**
910
- * @param {UsersListMFAFactorsRequestParams} params
911
- */
912
- const usersListMFAFactors = async ({userId,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
913
- let client = !sdk ? await sdkForProject() :
914
- sdk;
915
- let apiPath = '/users/{userId}/mfa/factors'.replace('{userId}', userId);
916
- let payload = {};
917
-
918
- let response = undefined;
919
-
920
- response = await client.call('get', apiPath, {
921
- }, payload);
922
-
923
- if (parseOutput) {
924
- parse(response)
925
- }
926
-
927
- return response;
928
-
929
- }
930
- /**
931
- * @typedef {Object} UsersGetMFARecoveryCodesRequestParams
932
- * @property {string} userId User ID.
933
- * @property {boolean} overrideForCli
934
- * @property {boolean} parseOutput
935
- * @property {libClient | undefined} sdk
936
- */
937
-
938
- /**
939
- * @param {UsersGetMFARecoveryCodesRequestParams} params
940
- */
941
- const usersGetMFARecoveryCodes = async ({userId,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
942
- let client = !sdk ? await sdkForProject() :
943
- sdk;
944
- let apiPath = '/users/{userId}/mfa/recovery-codes'.replace('{userId}', userId);
945
- let payload = {};
946
-
947
- let response = undefined;
948
-
949
- response = await client.call('get', apiPath, {
950
- }, payload);
951
-
952
- if (parseOutput) {
953
- parse(response)
954
- }
955
-
956
- return response;
957
-
958
- }
959
- /**
960
- * @typedef {Object} UsersUpdateMFARecoveryCodesRequestParams
961
- * @property {string} userId User ID.
962
- * @property {boolean} overrideForCli
963
- * @property {boolean} parseOutput
964
- * @property {libClient | undefined} sdk
965
- */
966
-
967
- /**
968
- * @param {UsersUpdateMFARecoveryCodesRequestParams} params
969
- */
970
- const usersUpdateMFARecoveryCodes = async ({userId,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
971
- let client = !sdk ? await sdkForProject() :
972
- sdk;
973
- let apiPath = '/users/{userId}/mfa/recovery-codes'.replace('{userId}', userId);
974
- let payload = {};
975
-
976
- let response = undefined;
977
-
978
- response = await client.call('put', apiPath, {
979
- 'content-type': 'application/json',
980
- }, payload);
981
-
982
- if (parseOutput) {
983
- parse(response)
984
- }
985
-
986
- return response;
987
-
988
- }
989
- /**
990
- * @typedef {Object} UsersCreateMFARecoveryCodesRequestParams
991
- * @property {string} userId User ID.
992
- * @property {boolean} overrideForCli
993
- * @property {boolean} parseOutput
994
- * @property {libClient | undefined} sdk
995
- */
996
-
997
- /**
998
- * @param {UsersCreateMFARecoveryCodesRequestParams} params
999
- */
1000
- const usersCreateMFARecoveryCodes = async ({userId,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
1001
- let client = !sdk ? await sdkForProject() :
1002
- sdk;
1003
- let apiPath = '/users/{userId}/mfa/recovery-codes'.replace('{userId}', userId);
1004
- let payload = {};
1005
-
1006
- let response = undefined;
1007
-
1008
- response = await client.call('patch', apiPath, {
1009
- 'content-type': 'application/json',
1010
- }, payload);
1011
-
1012
- if (parseOutput) {
1013
- parse(response)
1014
- }
1015
-
1016
- return response;
1017
-
1018
- }
1019
- /**
1020
- * @typedef {Object} UsersUpdateNameRequestParams
1021
- * @property {string} userId User ID.
1022
- * @property {string} name User name. Max length: 128 chars.
1023
- * @property {boolean} overrideForCli
1024
- * @property {boolean} parseOutput
1025
- * @property {libClient | undefined} sdk
1026
- */
1027
-
1028
- /**
1029
- * @param {UsersUpdateNameRequestParams} params
1030
- */
1031
- const usersUpdateName = async ({userId,name,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
1032
- let client = !sdk ? await sdkForProject() :
1033
- sdk;
1034
- let apiPath = '/users/{userId}/name'.replace('{userId}', userId);
1035
- let payload = {};
1036
- if (typeof name !== 'undefined') {
1037
- payload['name'] = name;
1038
- }
1039
-
1040
- let response = undefined;
1041
-
1042
- response = await client.call('patch', apiPath, {
1043
- 'content-type': 'application/json',
1044
- }, payload);
1045
-
1046
- if (parseOutput) {
1047
- parse(response)
1048
- }
1049
-
1050
- return response;
1051
-
1052
- }
1053
- /**
1054
- * @typedef {Object} UsersUpdatePasswordRequestParams
1055
- * @property {string} userId User ID.
1056
- * @property {string} password New user password. Must be at least 8 chars.
1057
- * @property {boolean} overrideForCli
1058
- * @property {boolean} parseOutput
1059
- * @property {libClient | undefined} sdk
1060
- */
1061
-
1062
- /**
1063
- * @param {UsersUpdatePasswordRequestParams} params
1064
- */
1065
- const usersUpdatePassword = async ({userId,password,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
1066
- let client = !sdk ? await sdkForProject() :
1067
- sdk;
1068
- let apiPath = '/users/{userId}/password'.replace('{userId}', userId);
1069
- let payload = {};
1070
- if (typeof password !== 'undefined') {
1071
- payload['password'] = password;
1072
- }
1073
-
1074
- let response = undefined;
1075
-
1076
- response = await client.call('patch', apiPath, {
1077
- 'content-type': 'application/json',
1078
- }, payload);
1079
-
1080
- if (parseOutput) {
1081
- parse(response)
1082
- }
1083
-
1084
- return response;
1085
-
1086
- }
1087
- /**
1088
- * @typedef {Object} UsersUpdatePhoneRequestParams
1089
- * @property {string} userId User ID.
1090
- * @property {string} number User phone number.
1091
- * @property {boolean} overrideForCli
1092
- * @property {boolean} parseOutput
1093
- * @property {libClient | undefined} sdk
1094
- */
1095
-
1096
- /**
1097
- * @param {UsersUpdatePhoneRequestParams} params
1098
- */
1099
- const usersUpdatePhone = async ({userId,number,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
1100
- let client = !sdk ? await sdkForProject() :
1101
- sdk;
1102
- let apiPath = '/users/{userId}/phone'.replace('{userId}', userId);
1103
- let payload = {};
1104
- if (typeof number !== 'undefined') {
1105
- payload['number'] = number;
1106
- }
1107
-
1108
- let response = undefined;
1109
-
1110
- response = await client.call('patch', apiPath, {
1111
- 'content-type': 'application/json',
1112
- }, payload);
1113
-
1114
- if (parseOutput) {
1115
- parse(response)
1116
- }
1117
-
1118
- return response;
1119
-
1120
- }
1121
- /**
1122
- * @typedef {Object} UsersGetPrefsRequestParams
1123
- * @property {string} userId User ID.
1124
- * @property {boolean} overrideForCli
1125
- * @property {boolean} parseOutput
1126
- * @property {libClient | undefined} sdk
1127
- */
1128
-
1129
- /**
1130
- * @param {UsersGetPrefsRequestParams} params
1131
- */
1132
- const usersGetPrefs = async ({userId,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
1133
- let client = !sdk ? await sdkForProject() :
1134
- sdk;
1135
- let apiPath = '/users/{userId}/prefs'.replace('{userId}', userId);
1136
- let payload = {};
1137
-
1138
- let response = undefined;
1139
-
1140
- response = await client.call('get', apiPath, {
1141
- }, payload);
1142
-
1143
- if (parseOutput) {
1144
- parse(response)
1145
- }
1146
-
1147
- return response;
1148
-
1149
- }
1150
- /**
1151
- * @typedef {Object} UsersUpdatePrefsRequestParams
1152
- * @property {string} userId User ID.
1153
- * @property {object} prefs Prefs key-value JSON object.
1154
- * @property {boolean} overrideForCli
1155
- * @property {boolean} parseOutput
1156
- * @property {libClient | undefined} sdk
1157
- */
1158
-
1159
- /**
1160
- * @param {UsersUpdatePrefsRequestParams} params
1161
- */
1162
- const usersUpdatePrefs = async ({userId,prefs,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
1163
- let client = !sdk ? await sdkForProject() :
1164
- sdk;
1165
- let apiPath = '/users/{userId}/prefs'.replace('{userId}', userId);
1166
- let payload = {};
1167
- if (typeof prefs !== 'undefined') {
1168
- payload['prefs'] = JSON.parse(prefs);
1169
- }
1170
-
1171
- let response = undefined;
1172
-
1173
- response = await client.call('patch', apiPath, {
1174
- 'content-type': 'application/json',
1175
- }, payload);
1176
-
1177
- if (parseOutput) {
1178
- parse(response)
1179
- }
1180
-
1181
- return response;
1182
-
1183
- }
1184
- /**
1185
- * @typedef {Object} UsersListSessionsRequestParams
1186
- * @property {string} userId User ID.
1187
- * @property {boolean} total When set to false, the total count returned will be 0 and will not be calculated.
1188
- * @property {boolean} overrideForCli
1189
- * @property {boolean} parseOutput
1190
- * @property {libClient | undefined} sdk
1191
- */
1192
-
1193
- /**
1194
- * @param {UsersListSessionsRequestParams} params
1195
- */
1196
- const usersListSessions = async ({userId,total,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
1197
- let client = !sdk ? await sdkForProject() :
1198
- sdk;
1199
- let apiPath = '/users/{userId}/sessions'.replace('{userId}', userId);
1200
- let payload = {};
1201
- if (typeof total !== 'undefined') {
1202
- payload['total'] = total;
1203
- }
1204
-
1205
- let response = undefined;
1206
-
1207
- response = await client.call('get', apiPath, {
1208
- }, payload);
1209
-
1210
- if (parseOutput) {
1211
- if(console) {
1212
- showConsoleLink('users', 'listSessions', userId);
1213
- } else {
1214
- parse(response)
1215
- }
1216
- }
1217
-
1218
- return response;
1219
-
1220
- }
1221
- /**
1222
- * @typedef {Object} UsersCreateSessionRequestParams
1223
- * @property {string} userId User ID. Choose a custom ID or generate a random ID with 'ID.unique()'. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
1224
- * @property {boolean} overrideForCli
1225
- * @property {boolean} parseOutput
1226
- * @property {libClient | undefined} sdk
1227
- */
1228
-
1229
- /**
1230
- * @param {UsersCreateSessionRequestParams} params
1231
- */
1232
- const usersCreateSession = async ({userId,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
1233
- let client = !sdk ? await sdkForProject() :
1234
- sdk;
1235
- let apiPath = '/users/{userId}/sessions'.replace('{userId}', userId);
1236
- let payload = {};
1237
-
1238
- let response = undefined;
1239
-
1240
- response = await client.call('post', apiPath, {
1241
- 'content-type': 'application/json',
1242
- }, payload);
1243
-
1244
- if (parseOutput) {
1245
- parse(response)
1246
- }
1247
-
1248
- return response;
1249
-
1250
- }
1251
- /**
1252
- * @typedef {Object} UsersDeleteSessionsRequestParams
1253
- * @property {string} userId User ID.
1254
- * @property {boolean} overrideForCli
1255
- * @property {boolean} parseOutput
1256
- * @property {libClient | undefined} sdk
1257
- */
1258
-
1259
- /**
1260
- * @param {UsersDeleteSessionsRequestParams} params
1261
- */
1262
- const usersDeleteSessions = async ({userId,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
1263
- let client = !sdk ? await sdkForProject() :
1264
- sdk;
1265
- let apiPath = '/users/{userId}/sessions'.replace('{userId}', userId);
1266
- let payload = {};
1267
-
1268
- let response = undefined;
1269
-
1270
- response = await client.call('delete', apiPath, {
1271
- 'content-type': 'application/json',
1272
- }, payload);
1273
-
1274
- if (parseOutput) {
1275
- parse(response)
1276
- }
1277
-
1278
- return response;
1279
-
1280
- }
1281
- /**
1282
- * @typedef {Object} UsersDeleteSessionRequestParams
1283
- * @property {string} userId User ID.
1284
- * @property {string} sessionId Session ID.
1285
- * @property {boolean} overrideForCli
1286
- * @property {boolean} parseOutput
1287
- * @property {libClient | undefined} sdk
1288
- */
1289
-
1290
- /**
1291
- * @param {UsersDeleteSessionRequestParams} params
1292
- */
1293
- const usersDeleteSession = async ({userId,sessionId,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
1294
- let client = !sdk ? await sdkForProject() :
1295
- sdk;
1296
- let apiPath = '/users/{userId}/sessions/{sessionId}'.replace('{userId}', userId).replace('{sessionId}', sessionId);
1297
- let payload = {};
1298
-
1299
- let response = undefined;
1300
-
1301
- response = await client.call('delete', apiPath, {
1302
- 'content-type': 'application/json',
1303
- }, payload);
1304
-
1305
- if (parseOutput) {
1306
- parse(response)
1307
- }
1308
-
1309
- return response;
1310
-
1311
- }
1312
- /**
1313
- * @typedef {Object} UsersUpdateStatusRequestParams
1314
- * @property {string} userId User ID.
1315
- * @property {boolean} status User Status. To activate the user pass 'true' and to block the user pass 'false'.
1316
- * @property {boolean} overrideForCli
1317
- * @property {boolean} parseOutput
1318
- * @property {libClient | undefined} sdk
1319
- */
1320
-
1321
- /**
1322
- * @param {UsersUpdateStatusRequestParams} params
1323
- */
1324
- const usersUpdateStatus = async ({userId,status,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
1325
- let client = !sdk ? await sdkForProject() :
1326
- sdk;
1327
- let apiPath = '/users/{userId}/status'.replace('{userId}', userId);
1328
- let payload = {};
1329
- if (typeof status !== 'undefined') {
1330
- payload['status'] = status;
1331
- }
1332
-
1333
- let response = undefined;
1334
-
1335
- response = await client.call('patch', apiPath, {
1336
- 'content-type': 'application/json',
1337
- }, payload);
1338
-
1339
- if (parseOutput) {
1340
- parse(response)
1341
- }
1342
-
1343
- return response;
1344
-
1345
- }
1346
- /**
1347
- * @typedef {Object} UsersListTargetsRequestParams
1348
- * @property {string} userId User ID.
1349
- * @property {string[]} queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, providerId, identifier, providerType
1350
- * @property {boolean} total When set to false, the total count returned will be 0 and will not be calculated.
1351
- * @property {boolean} overrideForCli
1352
- * @property {boolean} parseOutput
1353
- * @property {libClient | undefined} sdk
1354
- */
1355
-
1356
- /**
1357
- * @param {UsersListTargetsRequestParams} params
1358
- */
1359
- const usersListTargets = async ({userId,queries,total,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
1360
- let client = !sdk ? await sdkForProject() :
1361
- sdk;
1362
- let apiPath = '/users/{userId}/targets'.replace('{userId}', userId);
1363
- let payload = {};
1364
- if (typeof queries !== 'undefined') {
1365
- payload['queries'] = queries;
1366
- }
1367
- if (typeof total !== 'undefined') {
1368
- payload['total'] = total;
1369
- }
1370
-
1371
- let response = undefined;
1372
-
1373
- response = await client.call('get', apiPath, {
1374
- }, payload);
1375
-
1376
- if (parseOutput) {
1377
- parse(response)
1378
- }
1379
-
1380
- return response;
1381
-
1382
- }
1383
- /**
1384
- * @typedef {Object} UsersCreateTargetRequestParams
1385
- * @property {string} userId User ID.
1386
- * @property {string} targetId Target ID. Choose a custom ID or generate a random ID with 'ID.unique()'. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
1387
- * @property {MessagingProviderType} providerType The target provider type. Can be one of the following: 'email', 'sms' or 'push'.
1388
- * @property {string} identifier The target identifier (token, email, phone etc.)
1389
- * @property {string} providerId Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.
1390
- * @property {string} name Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.
1391
- * @property {boolean} overrideForCli
1392
- * @property {boolean} parseOutput
1393
- * @property {libClient | undefined} sdk
1394
- */
1395
-
1396
- /**
1397
- * @param {UsersCreateTargetRequestParams} params
1398
- */
1399
- const usersCreateTarget = async ({userId,targetId,providerType,identifier,providerId,name,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
1400
- let client = !sdk ? await sdkForProject() :
1401
- sdk;
1402
- let apiPath = '/users/{userId}/targets'.replace('{userId}', userId);
1403
- let payload = {};
1404
- if (typeof targetId !== 'undefined') {
1405
- payload['targetId'] = targetId;
1406
- }
1407
- if (typeof providerType !== 'undefined') {
1408
- payload['providerType'] = providerType;
1409
- }
1410
- if (typeof identifier !== 'undefined') {
1411
- payload['identifier'] = identifier;
1412
- }
1413
- if (typeof providerId !== 'undefined') {
1414
- payload['providerId'] = providerId;
1415
- }
1416
- if (typeof name !== 'undefined') {
1417
- payload['name'] = name;
1418
- }
1419
-
1420
- let response = undefined;
1421
-
1422
- response = await client.call('post', apiPath, {
1423
- 'content-type': 'application/json',
1424
- }, payload);
1425
-
1426
- if (parseOutput) {
1427
- parse(response)
1428
- }
1429
-
1430
- return response;
1431
-
1432
- }
1433
- /**
1434
- * @typedef {Object} UsersGetTargetRequestParams
1435
- * @property {string} userId User ID.
1436
- * @property {string} targetId Target ID.
1437
- * @property {boolean} overrideForCli
1438
- * @property {boolean} parseOutput
1439
- * @property {libClient | undefined} sdk
1440
- */
1441
-
1442
- /**
1443
- * @param {UsersGetTargetRequestParams} params
1444
- */
1445
- const usersGetTarget = async ({userId,targetId,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
1446
- let client = !sdk ? await sdkForProject() :
1447
- sdk;
1448
- let apiPath = '/users/{userId}/targets/{targetId}'.replace('{userId}', userId).replace('{targetId}', targetId);
1449
- let payload = {};
1450
-
1451
- let response = undefined;
1452
-
1453
- response = await client.call('get', apiPath, {
1454
- }, payload);
1455
-
1456
- if (parseOutput) {
1457
- parse(response)
1458
- }
1459
-
1460
- return response;
1461
-
1462
- }
1463
- /**
1464
- * @typedef {Object} UsersUpdateTargetRequestParams
1465
- * @property {string} userId User ID.
1466
- * @property {string} targetId Target ID.
1467
- * @property {string} identifier The target identifier (token, email, phone etc.)
1468
- * @property {string} providerId Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.
1469
- * @property {string} name Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.
1470
- * @property {boolean} overrideForCli
1471
- * @property {boolean} parseOutput
1472
- * @property {libClient | undefined} sdk
1473
- */
1474
-
1475
- /**
1476
- * @param {UsersUpdateTargetRequestParams} params
1477
- */
1478
- const usersUpdateTarget = async ({userId,targetId,identifier,providerId,name,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
1479
- let client = !sdk ? await sdkForProject() :
1480
- sdk;
1481
- let apiPath = '/users/{userId}/targets/{targetId}'.replace('{userId}', userId).replace('{targetId}', targetId);
1482
- let payload = {};
1483
- if (typeof identifier !== 'undefined') {
1484
- payload['identifier'] = identifier;
1485
- }
1486
- if (typeof providerId !== 'undefined') {
1487
- payload['providerId'] = providerId;
1488
- }
1489
- if (typeof name !== 'undefined') {
1490
- payload['name'] = name;
1491
- }
1492
-
1493
- let response = undefined;
1494
-
1495
- response = await client.call('patch', apiPath, {
1496
- 'content-type': 'application/json',
1497
- }, payload);
1498
-
1499
- if (parseOutput) {
1500
- parse(response)
1501
- }
1502
-
1503
- return response;
1504
-
1505
- }
1506
- /**
1507
- * @typedef {Object} UsersDeleteTargetRequestParams
1508
- * @property {string} userId User ID.
1509
- * @property {string} targetId Target ID.
1510
- * @property {boolean} overrideForCli
1511
- * @property {boolean} parseOutput
1512
- * @property {libClient | undefined} sdk
1513
- */
1514
-
1515
- /**
1516
- * @param {UsersDeleteTargetRequestParams} params
1517
- */
1518
- const usersDeleteTarget = async ({userId,targetId,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
1519
- let client = !sdk ? await sdkForProject() :
1520
- sdk;
1521
- let apiPath = '/users/{userId}/targets/{targetId}'.replace('{userId}', userId).replace('{targetId}', targetId);
1522
- let payload = {};
1523
-
1524
- let response = undefined;
1525
-
1526
- response = await client.call('delete', apiPath, {
1527
- 'content-type': 'application/json',
1528
- }, payload);
1529
-
1530
- if (parseOutput) {
1531
- parse(response)
1532
- }
1533
-
1534
- return response;
1535
-
1536
- }
1537
- /**
1538
- * @typedef {Object} UsersCreateTokenRequestParams
1539
- * @property {string} userId User ID.
1540
- * @property {number} length Token length in characters. The default length is 6 characters
1541
- * @property {number} expire Token expiration period in seconds. The default expiration is 15 minutes.
1542
- * @property {boolean} overrideForCli
1543
- * @property {boolean} parseOutput
1544
- * @property {libClient | undefined} sdk
1545
- */
1546
-
1547
- /**
1548
- * @param {UsersCreateTokenRequestParams} params
1549
- */
1550
- const usersCreateToken = async ({userId,length,expire,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
1551
- let client = !sdk ? await sdkForProject() :
1552
- sdk;
1553
- let apiPath = '/users/{userId}/tokens'.replace('{userId}', userId);
1554
- let payload = {};
1555
- if (typeof length !== 'undefined') {
1556
- payload['length'] = length;
1557
- }
1558
- if (typeof expire !== 'undefined') {
1559
- payload['expire'] = expire;
1560
- }
1561
-
1562
- let response = undefined;
1563
-
1564
- response = await client.call('post', apiPath, {
1565
- 'content-type': 'application/json',
1566
- }, payload);
1567
-
1568
- if (parseOutput) {
1569
- parse(response)
1570
- }
1571
-
1572
- return response;
1573
-
1574
- }
1575
- /**
1576
- * @typedef {Object} UsersUpdateEmailVerificationRequestParams
1577
- * @property {string} userId User ID.
1578
- * @property {boolean} emailVerification User email verification status.
1579
- * @property {boolean} overrideForCli
1580
- * @property {boolean} parseOutput
1581
- * @property {libClient | undefined} sdk
1582
- */
1583
-
1584
- /**
1585
- * @param {UsersUpdateEmailVerificationRequestParams} params
1586
- */
1587
- const usersUpdateEmailVerification = async ({userId,emailVerification,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
1588
- let client = !sdk ? await sdkForProject() :
1589
- sdk;
1590
- let apiPath = '/users/{userId}/verification'.replace('{userId}', userId);
1591
- let payload = {};
1592
- if (typeof emailVerification !== 'undefined') {
1593
- payload['emailVerification'] = emailVerification;
1594
- }
1595
-
1596
- let response = undefined;
1597
-
1598
- response = await client.call('patch', apiPath, {
1599
- 'content-type': 'application/json',
1600
- }, payload);
1601
-
1602
- if (parseOutput) {
1603
- parse(response)
1604
- }
1605
-
1606
- return response;
1607
-
1608
- }
1609
- /**
1610
- * @typedef {Object} UsersUpdatePhoneVerificationRequestParams
1611
- * @property {string} userId User ID.
1612
- * @property {boolean} phoneVerification User phone verification status.
1613
- * @property {boolean} overrideForCli
1614
- * @property {boolean} parseOutput
1615
- * @property {libClient | undefined} sdk
1616
- */
1617
-
1618
- /**
1619
- * @param {UsersUpdatePhoneVerificationRequestParams} params
1620
- */
1621
- const usersUpdatePhoneVerification = async ({userId,phoneVerification,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
1622
- let client = !sdk ? await sdkForProject() :
1623
- sdk;
1624
- let apiPath = '/users/{userId}/verification/phone'.replace('{userId}', userId);
1625
- let payload = {};
1626
- if (typeof phoneVerification !== 'undefined') {
1627
- payload['phoneVerification'] = phoneVerification;
1628
- }
1629
-
1630
- let response = undefined;
1631
-
1632
- response = await client.call('patch', apiPath, {
1633
- 'content-type': 'application/json',
1634
- }, payload);
1635
-
1636
- if (parseOutput) {
1637
- parse(response)
1638
- }
1639
-
1640
- return response;
1641
-
1642
- }
1643
- users
1644
- .command(`list`)
1645
- .description(`Get a list of all the project's users. You can use the query params to filter your results.`)
1646
- .option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels`)
1647
- .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
1648
- .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
1649
- .option(`--console`, `Get the resource console url`)
1650
- .action(actionRunner(usersList))
1651
-
1652
- users
1653
- .command(`create`)
1654
- .description(`Create a new user.`)
1655
- .requiredOption(`--user-id <user-id>`, `User ID. Choose a custom ID or generate a random ID with 'ID.unique()'. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.`)
1656
- .option(`--email <email>`, `User email.`)
1657
- .option(`--phone <phone>`, `Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.`)
1658
- .option(`--password <password>`, `Plain text user password. Must be at least 8 chars.`)
1659
- .option(`--name <name>`, `User name. Max length: 128 chars.`)
1660
- .action(actionRunner(usersCreate))
1661
-
1662
- users
1663
- .command(`create-argon-2-user`)
1664
- .description(`Create a new user. Password provided must be hashed with the [Argon2](https://en.wikipedia.org/wiki/Argon2) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.`)
1665
- .requiredOption(`--user-id <user-id>`, `User ID. Choose a custom ID or generate a random ID with 'ID.unique()'. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.`)
1666
- .requiredOption(`--email <email>`, `User email.`)
1667
- .requiredOption(`--password <password>`, `User password hashed using Argon2.`)
1668
- .option(`--name <name>`, `User name. Max length: 128 chars.`)
1669
- .action(actionRunner(usersCreateArgon2User))
1670
-
1671
- users
1672
- .command(`create-bcrypt-user`)
1673
- .description(`Create a new user. Password provided must be hashed with the [Bcrypt](https://en.wikipedia.org/wiki/Bcrypt) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.`)
1674
- .requiredOption(`--user-id <user-id>`, `User ID. Choose a custom ID or generate a random ID with 'ID.unique()'. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.`)
1675
- .requiredOption(`--email <email>`, `User email.`)
1676
- .requiredOption(`--password <password>`, `User password hashed using Bcrypt.`)
1677
- .option(`--name <name>`, `User name. Max length: 128 chars.`)
1678
- .action(actionRunner(usersCreateBcryptUser))
1679
-
1680
- users
1681
- .command(`list-identities`)
1682
- .description(`Get identities for all users.`)
1683
- .option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, provider, providerUid, providerEmail, providerAccessTokenExpiry`)
1684
- .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
1685
- .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
1686
- .action(actionRunner(usersListIdentities))
1687
-
1688
- users
1689
- .command(`delete-identity`)
1690
- .description(`Delete an identity by its unique ID.`)
1691
- .requiredOption(`--identity-id <identity-id>`, `Identity ID.`)
1692
- .action(actionRunner(usersDeleteIdentity))
1693
-
1694
- users
1695
- .command(`create-md-5-user`)
1696
- .description(`Create a new user. Password provided must be hashed with the [MD5](https://en.wikipedia.org/wiki/MD5) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.`)
1697
- .requiredOption(`--user-id <user-id>`, `User ID. Choose a custom ID or generate a random ID with 'ID.unique()'. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.`)
1698
- .requiredOption(`--email <email>`, `User email.`)
1699
- .requiredOption(`--password <password>`, `User password hashed using MD5.`)
1700
- .option(`--name <name>`, `User name. Max length: 128 chars.`)
1701
- .action(actionRunner(usersCreateMD5User))
1702
-
1703
- users
1704
- .command(`create-ph-pass-user`)
1705
- .description(`Create a new user. Password provided must be hashed with the [PHPass](https://www.openwall.com/phpass/) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.`)
1706
- .requiredOption(`--user-id <user-id>`, `User ID. Choose a custom ID or pass the string 'ID.unique()'to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.`)
1707
- .requiredOption(`--email <email>`, `User email.`)
1708
- .requiredOption(`--password <password>`, `User password hashed using PHPass.`)
1709
- .option(`--name <name>`, `User name. Max length: 128 chars.`)
1710
- .action(actionRunner(usersCreatePHPassUser))
1711
-
1712
- users
1713
- .command(`create-scrypt-user`)
1714
- .description(`Create a new user. Password provided must be hashed with the [Scrypt](https://github.com/Tarsnap/scrypt) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.`)
1715
- .requiredOption(`--user-id <user-id>`, `User ID. Choose a custom ID or generate a random ID with 'ID.unique()'. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.`)
1716
- .requiredOption(`--email <email>`, `User email.`)
1717
- .requiredOption(`--password <password>`, `User password hashed using Scrypt.`)
1718
- .requiredOption(`--password-salt <password-salt>`, `Optional salt used to hash password.`)
1719
- .requiredOption(`--password-cpu <password-cpu>`, `Optional CPU cost used to hash password.`, parseInteger)
1720
- .requiredOption(`--password-memory <password-memory>`, `Optional memory cost used to hash password.`, parseInteger)
1721
- .requiredOption(`--password-parallel <password-parallel>`, `Optional parallelization cost used to hash password.`, parseInteger)
1722
- .requiredOption(`--password-length <password-length>`, `Optional hash length used to hash password.`, parseInteger)
1723
- .option(`--name <name>`, `User name. Max length: 128 chars.`)
1724
- .action(actionRunner(usersCreateScryptUser))
1725
-
1726
- users
1727
- .command(`create-scrypt-modified-user`)
1728
- .description(`Create a new user. Password provided must be hashed with the [Scrypt Modified](https://gist.github.com/Meldiron/eecf84a0225eccb5a378d45bb27462cc) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.`)
1729
- .requiredOption(`--user-id <user-id>`, `User ID. Choose a custom ID or generate a random ID with 'ID.unique()'. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.`)
1730
- .requiredOption(`--email <email>`, `User email.`)
1731
- .requiredOption(`--password <password>`, `User password hashed using Scrypt Modified.`)
1732
- .requiredOption(`--password-salt <password-salt>`, `Salt used to hash password.`)
1733
- .requiredOption(`--password-salt-separator <password-salt-separator>`, `Salt separator used to hash password.`)
1734
- .requiredOption(`--password-signer-key <password-signer-key>`, `Signer key used to hash password.`)
1735
- .option(`--name <name>`, `User name. Max length: 128 chars.`)
1736
- .action(actionRunner(usersCreateScryptModifiedUser))
1737
-
1738
- users
1739
- .command(`create-sha-user`)
1740
- .description(`Create a new user. Password provided must be hashed with the [SHA](https://en.wikipedia.org/wiki/Secure_Hash_Algorithm) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.`)
1741
- .requiredOption(`--user-id <user-id>`, `User ID. Choose a custom ID or generate a random ID with 'ID.unique()'. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.`)
1742
- .requiredOption(`--email <email>`, `User email.`)
1743
- .requiredOption(`--password <password>`, `User password hashed using SHA.`)
1744
- .option(`--password-version <password-version>`, `Optional SHA version used to hash password. Allowed values are: 'sha1', 'sha224', 'sha256', 'sha384', 'sha512/224', 'sha512/256', 'sha512', 'sha3-224', 'sha3-256', 'sha3-384', 'sha3-512'`)
1745
- .option(`--name <name>`, `User name. Max length: 128 chars.`)
1746
- .action(actionRunner(usersCreateSHAUser))
1747
-
1748
- users
1749
- .command(`get-usage`)
1750
- .description(`Get usage metrics and statistics for all users in the project. You can view the total number of users and sessions. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days. `)
1751
- .option(`--range <range>`, `Date range.`)
1752
- .action(actionRunner(usersGetUsage))
1753
-
1754
- users
1755
- .command(`get`)
1756
- .description(`Get a user by its unique ID.`)
1757
- .requiredOption(`--user-id <user-id>`, `User ID.`)
1758
- .option(`--console`, `Get the resource console url`)
1759
- .action(actionRunner(usersGet))
1760
-
1761
- users
1762
- .command(`delete`)
1763
- .description(`Delete a user by its unique ID, thereby releasing it's ID. Since ID is released and can be reused, all user-related resources like documents or storage files should be deleted before user deletion. If you want to keep ID reserved, use the [updateStatus](https://appwrite.io/docs/server/users#usersUpdateStatus) endpoint instead.`)
1764
- .requiredOption(`--user-id <user-id>`, `User ID.`)
1765
- .action(actionRunner(usersDelete))
1766
-
1767
- users
1768
- .command(`update-email`)
1769
- .description(`Update the user email by its unique ID.`)
1770
- .requiredOption(`--user-id <user-id>`, `User ID.`)
1771
- .requiredOption(`--email <email>`, `User email.`)
1772
- .action(actionRunner(usersUpdateEmail))
1773
-
1774
- users
1775
- .command(`create-jwt`)
1776
- .description(`Use this endpoint to create a JSON Web Token for user by its unique ID. You can use the resulting JWT to authenticate on behalf of the user. The JWT secret will become invalid if the session it uses gets deleted.`)
1777
- .requiredOption(`--user-id <user-id>`, `User ID.`)
1778
- .option(`--session-id <session-id>`, `Session ID. Use the string 'recent' to use the most recent session. Defaults to the most recent session.`)
1779
- .option(`--duration <duration>`, `Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.`, parseInteger)
1780
- .action(actionRunner(usersCreateJWT))
1781
-
1782
- users
1783
- .command(`update-labels`)
1784
- .description(`Update the user labels by its unique ID. Labels can be used to grant access to resources. While teams are a way for user's to share access to a resource, labels can be defined by the developer to grant access without an invitation. See the [Permissions docs](https://appwrite.io/docs/permissions) for more info.`)
1785
- .requiredOption(`--user-id <user-id>`, `User ID.`)
1786
- .requiredOption(`--labels [labels...]`, `Array of user labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.`)
1787
- .action(actionRunner(usersUpdateLabels))
1788
-
1789
- users
1790
- .command(`list-logs`)
1791
- .description(`Get the user activity logs list by its unique ID.`)
1792
- .requiredOption(`--user-id <user-id>`, `User ID.`)
1793
- .option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset`)
1794
- .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
1795
- .action(actionRunner(usersListLogs))
1796
-
1797
- users
1798
- .command(`list-memberships`)
1799
- .description(`Get the user membership list by its unique ID.`)
1800
- .requiredOption(`--user-id <user-id>`, `User ID.`)
1801
- .option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, teamId, invited, joined, confirm, roles`)
1802
- .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
1803
- .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
1804
- .action(actionRunner(usersListMemberships))
1805
-
1806
- users
1807
- .command(`update-mfa`)
1808
- .description(`Enable or disable MFA on a user account.`)
1809
- .requiredOption(`--user-id <user-id>`, `User ID.`)
1810
- .requiredOption(`--mfa [value]`, `Enable or disable MFA.`, (value) => value === undefined ? true : parseBool(value))
1811
- .action(actionRunner(usersUpdateMFA))
1812
-
1813
- users
1814
- .command(`delete-mfa-authenticator`)
1815
- .description(`Delete an authenticator app.`)
1816
- .requiredOption(`--user-id <user-id>`, `User ID.`)
1817
- .requiredOption(`--type <type>`, `Type of authenticator.`)
1818
- .action(actionRunner(usersDeleteMFAAuthenticator))
1819
-
1820
- users
1821
- .command(`list-mfa-factors`)
1822
- .description(`List the factors available on the account to be used as a MFA challange.`)
1823
- .requiredOption(`--user-id <user-id>`, `User ID.`)
1824
- .action(actionRunner(usersListMFAFactors))
1825
-
1826
- users
1827
- .command(`get-mfa-recovery-codes`)
1828
- .description(`Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) method.`)
1829
- .requiredOption(`--user-id <user-id>`, `User ID.`)
1830
- .action(actionRunner(usersGetMFARecoveryCodes))
1831
-
1832
- users
1833
- .command(`update-mfa-recovery-codes`)
1834
- .description(`Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) method.`)
1835
- .requiredOption(`--user-id <user-id>`, `User ID.`)
1836
- .action(actionRunner(usersUpdateMFARecoveryCodes))
1837
-
1838
- users
1839
- .command(`create-mfa-recovery-codes`)
1840
- .description(`Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) method by client SDK.`)
1841
- .requiredOption(`--user-id <user-id>`, `User ID.`)
1842
- .action(actionRunner(usersCreateMFARecoveryCodes))
1843
-
1844
- users
1845
- .command(`update-name`)
1846
- .description(`Update the user name by its unique ID.`)
1847
- .requiredOption(`--user-id <user-id>`, `User ID.`)
1848
- .requiredOption(`--name <name>`, `User name. Max length: 128 chars.`)
1849
- .action(actionRunner(usersUpdateName))
1850
-
1851
- users
1852
- .command(`update-password`)
1853
- .description(`Update the user password by its unique ID.`)
1854
- .requiredOption(`--user-id <user-id>`, `User ID.`)
1855
- .requiredOption(`--password <password>`, `New user password. Must be at least 8 chars.`)
1856
- .action(actionRunner(usersUpdatePassword))
1857
-
1858
- users
1859
- .command(`update-phone`)
1860
- .description(`Update the user phone by its unique ID.`)
1861
- .requiredOption(`--user-id <user-id>`, `User ID.`)
1862
- .requiredOption(`--number <number>`, `User phone number.`)
1863
- .action(actionRunner(usersUpdatePhone))
1864
-
1865
- users
1866
- .command(`get-prefs`)
1867
- .description(`Get the user preferences by its unique ID.`)
1868
- .requiredOption(`--user-id <user-id>`, `User ID.`)
1869
- .action(actionRunner(usersGetPrefs))
1870
-
1871
- users
1872
- .command(`update-prefs`)
1873
- .description(`Update the user preferences by its unique ID. 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.`)
1874
- .requiredOption(`--user-id <user-id>`, `User ID.`)
1875
- .requiredOption(`--prefs <prefs>`, `Prefs key-value JSON object.`)
1876
- .action(actionRunner(usersUpdatePrefs))
1877
-
1878
- users
1879
- .command(`list-sessions`)
1880
- .description(`Get the user sessions list by its unique ID.`)
1881
- .requiredOption(`--user-id <user-id>`, `User ID.`)
1882
- .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
1883
- .option(`--console`, `Get the resource console url`)
1884
- .action(actionRunner(usersListSessions))
1885
-
1886
- users
1887
- .command(`create-session`)
1888
- .description(`Creates a session for a user. Returns an immediately usable session object. If you want to generate a token for a custom authentication flow, use the [POST /users/{userId}/tokens](https://appwrite.io/docs/server/users#createToken) endpoint.`)
1889
- .requiredOption(`--user-id <user-id>`, `User ID. Choose a custom ID or generate a random ID with 'ID.unique()'. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.`)
1890
- .action(actionRunner(usersCreateSession))
1891
-
1892
- users
1893
- .command(`delete-sessions`)
1894
- .description(`Delete all user's sessions by using the user's unique ID.`)
1895
- .requiredOption(`--user-id <user-id>`, `User ID.`)
1896
- .action(actionRunner(usersDeleteSessions))
1897
-
1898
- users
1899
- .command(`delete-session`)
1900
- .description(`Delete a user sessions by its unique ID.`)
1901
- .requiredOption(`--user-id <user-id>`, `User ID.`)
1902
- .requiredOption(`--session-id <session-id>`, `Session ID.`)
1903
- .action(actionRunner(usersDeleteSession))
1904
-
1905
- users
1906
- .command(`update-status`)
1907
- .description(`Update the user status by its unique ID. Use this endpoint as an alternative to deleting a user if you want to keep user's ID reserved.`)
1908
- .requiredOption(`--user-id <user-id>`, `User ID.`)
1909
- .requiredOption(`--status [value]`, `User Status. To activate the user pass 'true' and to block the user pass 'false'.`, (value) => value === undefined ? true : parseBool(value))
1910
- .action(actionRunner(usersUpdateStatus))
1911
-
1912
- users
1913
- .command(`list-targets`)
1914
- .description(`List the messaging targets that are associated with a user.`)
1915
- .requiredOption(`--user-id <user-id>`, `User ID.`)
1916
- .option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, providerId, identifier, providerType`)
1917
- .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
1918
- .action(actionRunner(usersListTargets))
1919
-
1920
- users
1921
- .command(`create-target`)
1922
- .description(`Create a messaging target.`)
1923
- .requiredOption(`--user-id <user-id>`, `User ID.`)
1924
- .requiredOption(`--target-id <target-id>`, `Target ID. Choose a custom ID or generate a random ID with 'ID.unique()'. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.`)
1925
- .requiredOption(`--provider-type <provider-type>`, `The target provider type. Can be one of the following: 'email', 'sms' or 'push'.`)
1926
- .requiredOption(`--identifier <identifier>`, `The target identifier (token, email, phone etc.)`)
1927
- .option(`--provider-id <provider-id>`, `Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.`)
1928
- .option(`--name <name>`, `Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.`)
1929
- .action(actionRunner(usersCreateTarget))
1930
-
1931
- users
1932
- .command(`get-target`)
1933
- .description(`Get a user's push notification target by ID.`)
1934
- .requiredOption(`--user-id <user-id>`, `User ID.`)
1935
- .requiredOption(`--target-id <target-id>`, `Target ID.`)
1936
- .action(actionRunner(usersGetTarget))
1937
-
1938
- users
1939
- .command(`update-target`)
1940
- .description(`Update a messaging target.`)
1941
- .requiredOption(`--user-id <user-id>`, `User ID.`)
1942
- .requiredOption(`--target-id <target-id>`, `Target ID.`)
1943
- .option(`--identifier <identifier>`, `The target identifier (token, email, phone etc.)`)
1944
- .option(`--provider-id <provider-id>`, `Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.`)
1945
- .option(`--name <name>`, `Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.`)
1946
- .action(actionRunner(usersUpdateTarget))
1947
-
1948
- users
1949
- .command(`delete-target`)
1950
- .description(`Delete a messaging target.`)
1951
- .requiredOption(`--user-id <user-id>`, `User ID.`)
1952
- .requiredOption(`--target-id <target-id>`, `Target ID.`)
1953
- .action(actionRunner(usersDeleteTarget))
1954
-
1955
- users
1956
- .command(`create-token`)
1957
- .description(`Returns a token with a secret key for creating a session. Use the user ID and secret and submit a request to the [PUT /account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint to complete the login process. `)
1958
- .requiredOption(`--user-id <user-id>`, `User ID.`)
1959
- .option(`--length <length>`, `Token length in characters. The default length is 6 characters`, parseInteger)
1960
- .option(`--expire <expire>`, `Token expiration period in seconds. The default expiration is 15 minutes.`, parseInteger)
1961
- .action(actionRunner(usersCreateToken))
1962
-
1963
- users
1964
- .command(`update-email-verification`)
1965
- .description(`Update the user email verification status by its unique ID.`)
1966
- .requiredOption(`--user-id <user-id>`, `User ID.`)
1967
- .requiredOption(`--email-verification [value]`, `User email verification status.`, (value) => value === undefined ? true : parseBool(value))
1968
- .action(actionRunner(usersUpdateEmailVerification))
1969
-
1970
- users
1971
- .command(`update-phone-verification`)
1972
- .description(`Update the user phone verification status by its unique ID.`)
1973
- .requiredOption(`--user-id <user-id>`, `User ID.`)
1974
- .requiredOption(`--phone-verification [value]`, `User phone verification status.`, (value) => value === undefined ? true : parseBool(value))
1975
- .action(actionRunner(usersUpdatePhoneVerification))
1976
-
1977
- module.exports = {
1978
- users,
1979
- usersList,
1980
- usersCreate,
1981
- usersCreateArgon2User,
1982
- usersCreateBcryptUser,
1983
- usersListIdentities,
1984
- usersDeleteIdentity,
1985
- usersCreateMD5User,
1986
- usersCreatePHPassUser,
1987
- usersCreateScryptUser,
1988
- usersCreateScryptModifiedUser,
1989
- usersCreateSHAUser,
1990
- usersGetUsage,
1991
- usersGet,
1992
- usersDelete,
1993
- usersUpdateEmail,
1994
- usersCreateJWT,
1995
- usersUpdateLabels,
1996
- usersListLogs,
1997
- usersListMemberships,
1998
- usersUpdateMFA,
1999
- usersDeleteMFAAuthenticator,
2000
- usersListMFAFactors,
2001
- usersGetMFARecoveryCodes,
2002
- usersUpdateMFARecoveryCodes,
2003
- usersCreateMFARecoveryCodes,
2004
- usersUpdateName,
2005
- usersUpdatePassword,
2006
- usersUpdatePhone,
2007
- usersGetPrefs,
2008
- usersUpdatePrefs,
2009
- usersListSessions,
2010
- usersCreateSession,
2011
- usersDeleteSessions,
2012
- usersDeleteSession,
2013
- usersUpdateStatus,
2014
- usersListTargets,
2015
- usersCreateTarget,
2016
- usersGetTarget,
2017
- usersUpdateTarget,
2018
- usersDeleteTarget,
2019
- usersCreateToken,
2020
- usersUpdateEmailVerification,
2021
- usersUpdatePhoneVerification
2022
- };