@appwrite.io/console 8.1.0 → 8.1.1

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 (898) hide show
  1. package/README.md +1 -1
  2. package/dist/cjs/sdk.js +1 -1
  3. package/dist/cjs/sdk.js.map +1 -0
  4. package/dist/esm/sdk.js +29705 -0
  5. package/dist/esm/sdk.js.map +1 -0
  6. package/dist/iife/sdk.js +33515 -0
  7. package/package.json +5 -1
  8. package/types/channel.d.ts +74 -0
  9. package/types/client.d.ts +302 -0
  10. package/types/enums/adapter.d.ts +4 -0
  11. package/types/enums/api-service.d.ts +15 -0
  12. package/types/enums/api.d.ts +5 -0
  13. package/types/enums/appwrite-migration-resource.d.ts +27 -0
  14. package/types/enums/attribute-status.d.ts +7 -0
  15. package/types/enums/auth-method.d.ts +9 -0
  16. package/types/enums/authentication-factor.d.ts +6 -0
  17. package/types/enums/authenticator-type.d.ts +3 -0
  18. package/types/enums/backup-services.d.ts +8 -0
  19. package/types/enums/billing-plan-group.d.ts +5 -0
  20. package/types/enums/browser-permission.d.ts +22 -0
  21. package/types/enums/browser.d.ts +16 -0
  22. package/types/enums/build-runtime.d.ts +88 -0
  23. package/types/enums/column-status.d.ts +7 -0
  24. package/types/enums/compression.d.ts +5 -0
  25. package/types/enums/console-resource-type.d.ts +3 -0
  26. package/types/enums/credit-card.d.ts +19 -0
  27. package/types/enums/database-type.d.ts +6 -0
  28. package/types/enums/databases-index-type.d.ts +6 -0
  29. package/types/enums/deployment-download-type.d.ts +4 -0
  30. package/types/enums/deployment-status.d.ts +8 -0
  31. package/types/enums/domain-purchase-status.d.ts +6 -0
  32. package/types/enums/domain-transfer-status-enum.d.ts +10 -0
  33. package/types/enums/email-template-locale.d.ts +133 -0
  34. package/types/enums/email-template-type.d.ts +9 -0
  35. package/types/enums/execution-method.d.ts +9 -0
  36. package/types/enums/execution-status.d.ts +7 -0
  37. package/types/enums/execution-trigger.d.ts +5 -0
  38. package/types/enums/filter-type.d.ts +4 -0
  39. package/types/enums/firebase-migration-resource.d.ts +12 -0
  40. package/types/enums/flag.d.ts +197 -0
  41. package/types/enums/framework.d.ts +17 -0
  42. package/types/enums/frameworks.d.ts +17 -0
  43. package/types/enums/health-antivirus-status.d.ts +5 -0
  44. package/types/enums/health-check-status.d.ts +4 -0
  45. package/types/enums/image-format.d.ts +9 -0
  46. package/types/enums/image-gravity.d.ts +11 -0
  47. package/types/enums/index-status.d.ts +7 -0
  48. package/types/enums/message-priority.d.ts +4 -0
  49. package/types/enums/message-status.d.ts +7 -0
  50. package/types/enums/messaging-provider-type.d.ts +5 -0
  51. package/types/enums/n-host-migration-resource.d.ts +13 -0
  52. package/types/enums/name.d.ts +15 -0
  53. package/types/enums/o-auth-provider.d.ts +41 -0
  54. package/types/enums/order-by.d.ts +4 -0
  55. package/types/enums/password-hash.d.ts +13 -0
  56. package/types/enums/platform-type.d.ts +17 -0
  57. package/types/enums/platform.d.ts +4 -0
  58. package/types/enums/project-usage-range.d.ts +4 -0
  59. package/types/enums/proxy-resource-type.d.ts +4 -0
  60. package/types/enums/proxy-rule-deployment-resource-type.d.ts +4 -0
  61. package/types/enums/proxy-rule-status.d.ts +6 -0
  62. package/types/enums/region.d.ts +8 -0
  63. package/types/enums/registration-type.d.ts +6 -0
  64. package/types/enums/relation-mutate.d.ts +5 -0
  65. package/types/enums/relationship-type.d.ts +6 -0
  66. package/types/enums/resource-type.d.ts +6 -0
  67. package/types/enums/runtime.d.ts +88 -0
  68. package/types/enums/runtimes.d.ts +88 -0
  69. package/types/enums/scopes.d.ts +81 -0
  70. package/types/enums/sms-template-locale.d.ts +133 -0
  71. package/types/enums/sms-template-type.d.ts +6 -0
  72. package/types/enums/smtp-encryption.d.ts +5 -0
  73. package/types/enums/smtp-secure.d.ts +4 -0
  74. package/types/enums/status-code.d.ts +6 -0
  75. package/types/enums/status.d.ts +3 -0
  76. package/types/enums/supabase-migration-resource.d.ts +13 -0
  77. package/types/enums/tables-db-index-type.d.ts +6 -0
  78. package/types/enums/template-reference-type.d.ts +5 -0
  79. package/types/enums/theme.d.ts +4 -0
  80. package/types/enums/timezone.d.ts +421 -0
  81. package/types/enums/usage-range.d.ts +5 -0
  82. package/types/enums/use-cases.d.ts +16 -0
  83. package/types/enums/vcs-detection-type.d.ts +4 -0
  84. package/types/enums/vcs-reference-type.d.ts +5 -0
  85. package/types/id.d.ts +20 -0
  86. package/{src/index.ts → types/index.d.ts} +1 -1
  87. package/{src/models.ts → types/models.d.ts} +268 -518
  88. package/types/operator.d.ts +180 -0
  89. package/{src/permission.ts → types/permission.d.ts} +6 -20
  90. package/types/query.d.ts +442 -0
  91. package/{src/role.ts → types/role.d.ts} +28 -58
  92. package/types/service.d.ts +11 -0
  93. package/types/services/account.d.ts +1536 -0
  94. package/types/services/activities.d.ts +46 -0
  95. package/types/services/assistant.d.ts +24 -0
  96. package/{src/services/avatars.ts → types/services/avatars.d.ts} +91 -525
  97. package/types/services/backups.d.ts +277 -0
  98. package/types/services/console.d.ts +248 -0
  99. package/types/services/databases.d.ts +2435 -0
  100. package/types/services/domains.d.ts +1527 -0
  101. package/types/services/functions.d.ts +842 -0
  102. package/types/services/graphql.d.ts +43 -0
  103. package/types/services/health.d.ts +475 -0
  104. package/types/services/locale.d.ts +64 -0
  105. package/types/services/messaging.d.ts +1989 -0
  106. package/types/services/migrations.d.ts +417 -0
  107. package/types/services/organizations.d.ts +1009 -0
  108. package/types/services/project.d.ts +148 -0
  109. package/types/services/projects.d.ts +1626 -0
  110. package/types/services/proxy.d.ts +190 -0
  111. package/types/services/realtime.d.ts +134 -0
  112. package/types/services/sites.d.ts +800 -0
  113. package/types/services/storage.d.ts +467 -0
  114. package/types/services/tables-db.d.ts +2352 -0
  115. package/types/services/teams.d.ts +366 -0
  116. package/types/services/tokens.d.ts +119 -0
  117. package/types/services/users.d.ts +1208 -0
  118. package/types/services/vcs.d.ts +252 -0
  119. package/types/services/webhooks.d.ts +165 -0
  120. package/.github/workflows/autoclose.yml +0 -11
  121. package/.github/workflows/publish.yml +0 -43
  122. package/CHANGELOG.md +0 -169
  123. package/docs/examples/account/create-anonymous-session.md +0 -13
  124. package/docs/examples/account/create-billing-address.md +0 -20
  125. package/docs/examples/account/create-email-password-session.md +0 -16
  126. package/docs/examples/account/create-email-token.md +0 -17
  127. package/docs/examples/account/create-email-verification.md +0 -15
  128. package/docs/examples/account/create-jwt.md +0 -15
  129. package/docs/examples/account/create-key.md +0 -17
  130. package/docs/examples/account/create-magic-url-token.md +0 -18
  131. package/docs/examples/account/create-mfa-authenticator.md +0 -15
  132. package/docs/examples/account/create-mfa-challenge.md +0 -15
  133. package/docs/examples/account/create-mfa-recovery-codes.md +0 -13
  134. package/docs/examples/account/create-o-auth-2-session.md +0 -17
  135. package/docs/examples/account/create-o-auth-2-token.md +0 -17
  136. package/docs/examples/account/create-payment-method.md +0 -13
  137. package/docs/examples/account/create-phone-token.md +0 -16
  138. package/docs/examples/account/create-phone-verification.md +0 -13
  139. package/docs/examples/account/create-push-target.md +0 -17
  140. package/docs/examples/account/create-recovery.md +0 -16
  141. package/docs/examples/account/create-session.md +0 -16
  142. package/docs/examples/account/create-verification.md +0 -15
  143. package/docs/examples/account/create.md +0 -18
  144. package/docs/examples/account/delete-billing-address.md +0 -15
  145. package/docs/examples/account/delete-identity.md +0 -15
  146. package/docs/examples/account/delete-key.md +0 -15
  147. package/docs/examples/account/delete-mfa-authenticator.md +0 -15
  148. package/docs/examples/account/delete-payment-method.md +0 -15
  149. package/docs/examples/account/delete-push-target.md +0 -15
  150. package/docs/examples/account/delete-session.md +0 -15
  151. package/docs/examples/account/delete-sessions.md +0 -13
  152. package/docs/examples/account/delete.md +0 -13
  153. package/docs/examples/account/get-billing-address.md +0 -15
  154. package/docs/examples/account/get-coupon.md +0 -15
  155. package/docs/examples/account/get-key.md +0 -15
  156. package/docs/examples/account/get-mfa-recovery-codes.md +0 -13
  157. package/docs/examples/account/get-payment-method.md +0 -15
  158. package/docs/examples/account/get-prefs.md +0 -13
  159. package/docs/examples/account/get-session.md +0 -15
  160. package/docs/examples/account/get.md +0 -13
  161. package/docs/examples/account/list-billing-addresses.md +0 -15
  162. package/docs/examples/account/list-identities.md +0 -16
  163. package/docs/examples/account/list-invoices.md +0 -15
  164. package/docs/examples/account/list-keys.md +0 -15
  165. package/docs/examples/account/list-logs.md +0 -16
  166. package/docs/examples/account/list-mfa-factors.md +0 -13
  167. package/docs/examples/account/list-payment-methods.md +0 -15
  168. package/docs/examples/account/list-sessions.md +0 -13
  169. package/docs/examples/account/update-billing-address.md +0 -21
  170. package/docs/examples/account/update-email-verification.md +0 -16
  171. package/docs/examples/account/update-email.md +0 -16
  172. package/docs/examples/account/update-key.md +0 -18
  173. package/docs/examples/account/update-magic-url-session.md +0 -16
  174. package/docs/examples/account/update-mfa-authenticator.md +0 -16
  175. package/docs/examples/account/update-mfa-challenge.md +0 -16
  176. package/docs/examples/account/update-mfa-recovery-codes.md +0 -13
  177. package/docs/examples/account/update-mfa.md +0 -15
  178. package/docs/examples/account/update-name.md +0 -15
  179. package/docs/examples/account/update-password.md +0 -16
  180. package/docs/examples/account/update-payment-method-mandate-options.md +0 -15
  181. package/docs/examples/account/update-payment-method-provider.md +0 -18
  182. package/docs/examples/account/update-payment-method.md +0 -18
  183. package/docs/examples/account/update-phone-session.md +0 -16
  184. package/docs/examples/account/update-phone-verification.md +0 -16
  185. package/docs/examples/account/update-phone.md +0 -16
  186. package/docs/examples/account/update-prefs.md +0 -19
  187. package/docs/examples/account/update-push-target.md +0 -16
  188. package/docs/examples/account/update-recovery.md +0 -17
  189. package/docs/examples/account/update-session.md +0 -15
  190. package/docs/examples/account/update-status.md +0 -13
  191. package/docs/examples/account/update-verification.md +0 -16
  192. package/docs/examples/activities/get-event.md +0 -15
  193. package/docs/examples/activities/list-events.md +0 -15
  194. package/docs/examples/assistant/chat.md +0 -15
  195. package/docs/examples/avatars/get-browser.md +0 -18
  196. package/docs/examples/avatars/get-credit-card.md +0 -18
  197. package/docs/examples/avatars/get-favicon.md +0 -15
  198. package/docs/examples/avatars/get-flag.md +0 -18
  199. package/docs/examples/avatars/get-image.md +0 -17
  200. package/docs/examples/avatars/get-initials.md +0 -18
  201. package/docs/examples/avatars/get-qr.md +0 -18
  202. package/docs/examples/avatars/get-screenshot.md +0 -37
  203. package/docs/examples/backups/create-archive.md +0 -16
  204. package/docs/examples/backups/create-policy.md +0 -21
  205. package/docs/examples/backups/create-restoration.md +0 -18
  206. package/docs/examples/backups/delete-archive.md +0 -15
  207. package/docs/examples/backups/delete-policy.md +0 -15
  208. package/docs/examples/backups/get-archive.md +0 -15
  209. package/docs/examples/backups/get-policy.md +0 -15
  210. package/docs/examples/backups/get-restoration.md +0 -15
  211. package/docs/examples/backups/list-archives.md +0 -15
  212. package/docs/examples/backups/list-policies.md +0 -15
  213. package/docs/examples/backups/list-restorations.md +0 -15
  214. package/docs/examples/backups/update-policy.md +0 -19
  215. package/docs/examples/console/create-program-membership.md +0 -15
  216. package/docs/examples/console/create-source.md +0 -19
  217. package/docs/examples/console/get-campaign.md +0 -15
  218. package/docs/examples/console/get-coupon.md +0 -15
  219. package/docs/examples/console/get-plan.md +0 -15
  220. package/docs/examples/console/get-plans.md +0 -15
  221. package/docs/examples/console/get-program.md +0 -15
  222. package/docs/examples/console/get-resource.md +0 -16
  223. package/docs/examples/console/list-regions.md +0 -13
  224. package/docs/examples/console/suggest-columns.md +0 -19
  225. package/docs/examples/console/suggest-indexes.md +0 -18
  226. package/docs/examples/console/variables.md +0 -13
  227. package/docs/examples/databases/create-boolean-attribute.md +0 -20
  228. package/docs/examples/databases/create-collection.md +0 -22
  229. package/docs/examples/databases/create-datetime-attribute.md +0 -20
  230. package/docs/examples/databases/create-document.md +0 -26
  231. package/docs/examples/databases/create-documents.md +0 -18
  232. package/docs/examples/databases/create-email-attribute.md +0 -20
  233. package/docs/examples/databases/create-enum-attribute.md +0 -21
  234. package/docs/examples/databases/create-float-attribute.md +0 -22
  235. package/docs/examples/databases/create-index.md +0 -21
  236. package/docs/examples/databases/create-integer-attribute.md +0 -22
  237. package/docs/examples/databases/create-ip-attribute.md +0 -20
  238. package/docs/examples/databases/create-line-attribute.md +0 -19
  239. package/docs/examples/databases/create-longtext-attribute.md +0 -21
  240. package/docs/examples/databases/create-mediumtext-attribute.md +0 -21
  241. package/docs/examples/databases/create-operations.md +0 -26
  242. package/docs/examples/databases/create-point-attribute.md +0 -19
  243. package/docs/examples/databases/create-polygon-attribute.md +0 -19
  244. package/docs/examples/databases/create-relationship-attribute.md +0 -22
  245. package/docs/examples/databases/create-string-attribute.md +0 -22
  246. package/docs/examples/databases/create-text-attribute.md +0 -21
  247. package/docs/examples/databases/create-transaction.md +0 -15
  248. package/docs/examples/databases/create-url-attribute.md +0 -20
  249. package/docs/examples/databases/create-varchar-attribute.md +0 -22
  250. package/docs/examples/databases/create.md +0 -17
  251. package/docs/examples/databases/decrement-document-attribute.md +0 -21
  252. package/docs/examples/databases/delete-attribute.md +0 -17
  253. package/docs/examples/databases/delete-collection.md +0 -16
  254. package/docs/examples/databases/delete-document.md +0 -18
  255. package/docs/examples/databases/delete-documents.md +0 -18
  256. package/docs/examples/databases/delete-index.md +0 -17
  257. package/docs/examples/databases/delete-transaction.md +0 -15
  258. package/docs/examples/databases/delete.md +0 -15
  259. package/docs/examples/databases/get-attribute.md +0 -17
  260. package/docs/examples/databases/get-collection-usage.md +0 -17
  261. package/docs/examples/databases/get-collection.md +0 -16
  262. package/docs/examples/databases/get-document.md +0 -19
  263. package/docs/examples/databases/get-index.md +0 -17
  264. package/docs/examples/databases/get-transaction.md +0 -15
  265. package/docs/examples/databases/get-usage.md +0 -16
  266. package/docs/examples/databases/get.md +0 -15
  267. package/docs/examples/databases/increment-document-attribute.md +0 -21
  268. package/docs/examples/databases/list-attributes.md +0 -18
  269. package/docs/examples/databases/list-collection-logs.md +0 -17
  270. package/docs/examples/databases/list-collections.md +0 -18
  271. package/docs/examples/databases/list-document-logs.md +0 -18
  272. package/docs/examples/databases/list-documents.md +0 -20
  273. package/docs/examples/databases/list-indexes.md +0 -18
  274. package/docs/examples/databases/list-logs.md +0 -16
  275. package/docs/examples/databases/list-transactions.md +0 -15
  276. package/docs/examples/databases/list-usage.md +0 -15
  277. package/docs/examples/databases/list.md +0 -17
  278. package/docs/examples/databases/update-boolean-attribute.md +0 -20
  279. package/docs/examples/databases/update-collection.md +0 -20
  280. package/docs/examples/databases/update-datetime-attribute.md +0 -20
  281. package/docs/examples/databases/update-document.md +0 -26
  282. package/docs/examples/databases/update-documents.md +0 -25
  283. package/docs/examples/databases/update-email-attribute.md +0 -20
  284. package/docs/examples/databases/update-enum-attribute.md +0 -21
  285. package/docs/examples/databases/update-float-attribute.md +0 -22
  286. package/docs/examples/databases/update-integer-attribute.md +0 -22
  287. package/docs/examples/databases/update-ip-attribute.md +0 -20
  288. package/docs/examples/databases/update-line-attribute.md +0 -20
  289. package/docs/examples/databases/update-longtext-attribute.md +0 -20
  290. package/docs/examples/databases/update-mediumtext-attribute.md +0 -20
  291. package/docs/examples/databases/update-point-attribute.md +0 -20
  292. package/docs/examples/databases/update-polygon-attribute.md +0 -20
  293. package/docs/examples/databases/update-relationship-attribute.md +0 -19
  294. package/docs/examples/databases/update-string-attribute.md +0 -21
  295. package/docs/examples/databases/update-text-attribute.md +0 -20
  296. package/docs/examples/databases/update-transaction.md +0 -17
  297. package/docs/examples/databases/update-url-attribute.md +0 -20
  298. package/docs/examples/databases/update-varchar-attribute.md +0 -21
  299. package/docs/examples/databases/update.md +0 -17
  300. package/docs/examples/databases/upsert-document.md +0 -26
  301. package/docs/examples/databases/upsert-documents.md +0 -18
  302. package/docs/examples/domains/create-preset-google-workspace.md +0 -15
  303. package/docs/examples/domains/create-preset-i-cloud.md +0 -15
  304. package/docs/examples/domains/create-preset-mailgun.md +0 -15
  305. package/docs/examples/domains/create-preset-outlook.md +0 -15
  306. package/docs/examples/domains/create-preset-proton-mail.md +0 -15
  307. package/docs/examples/domains/create-preset-zoho.md +0 -15
  308. package/docs/examples/domains/create-purchase.md +0 -26
  309. package/docs/examples/domains/create-record-a.md +0 -19
  310. package/docs/examples/domains/create-record-aaaa.md +0 -19
  311. package/docs/examples/domains/create-record-alias.md +0 -19
  312. package/docs/examples/domains/create-record-caa.md +0 -19
  313. package/docs/examples/domains/create-record-cname.md +0 -19
  314. package/docs/examples/domains/create-record-https.md +0 -19
  315. package/docs/examples/domains/create-record-mx.md +0 -20
  316. package/docs/examples/domains/create-record-ns.md +0 -19
  317. package/docs/examples/domains/create-record-srv.md +0 -22
  318. package/docs/examples/domains/create-record-txt.md +0 -19
  319. package/docs/examples/domains/create-transfer-in.md +0 -19
  320. package/docs/examples/domains/create-transfer-out.md +0 -16
  321. package/docs/examples/domains/create.md +0 -16
  322. package/docs/examples/domains/delete-record.md +0 -16
  323. package/docs/examples/domains/delete.md +0 -15
  324. package/docs/examples/domains/get-preset-google-workspace.md +0 -15
  325. package/docs/examples/domains/get-preset-i-cloud.md +0 -15
  326. package/docs/examples/domains/get-preset-mailgun.md +0 -15
  327. package/docs/examples/domains/get-preset-outlook.md +0 -15
  328. package/docs/examples/domains/get-preset-proton-mail.md +0 -15
  329. package/docs/examples/domains/get-preset-zoho.md +0 -15
  330. package/docs/examples/domains/get-price.md +0 -17
  331. package/docs/examples/domains/get-record.md +0 -16
  332. package/docs/examples/domains/get-transfer-status.md +0 -15
  333. package/docs/examples/domains/get-zone.md +0 -15
  334. package/docs/examples/domains/get.md +0 -15
  335. package/docs/examples/domains/list-records.md +0 -16
  336. package/docs/examples/domains/list-suggestions.md +0 -20
  337. package/docs/examples/domains/list.md +0 -16
  338. package/docs/examples/domains/update-auto-renewal.md +0 -16
  339. package/docs/examples/domains/update-nameservers.md +0 -15
  340. package/docs/examples/domains/update-purchase.md +0 -16
  341. package/docs/examples/domains/update-record-a.md +0 -20
  342. package/docs/examples/domains/update-record-aaaa.md +0 -20
  343. package/docs/examples/domains/update-record-alias.md +0 -20
  344. package/docs/examples/domains/update-record-caa.md +0 -20
  345. package/docs/examples/domains/update-record-cname.md +0 -20
  346. package/docs/examples/domains/update-record-https.md +0 -20
  347. package/docs/examples/domains/update-record-mx.md +0 -21
  348. package/docs/examples/domains/update-record-ns.md +0 -20
  349. package/docs/examples/domains/update-record-srv.md +0 -23
  350. package/docs/examples/domains/update-record-txt.md +0 -20
  351. package/docs/examples/domains/update-team.md +0 -16
  352. package/docs/examples/domains/update-transfer-in.md +0 -16
  353. package/docs/examples/domains/update-zone.md +0 -16
  354. package/docs/examples/functions/create-deployment.md +0 -19
  355. package/docs/examples/functions/create-duplicate-deployment.md +0 -17
  356. package/docs/examples/functions/create-execution.md +0 -21
  357. package/docs/examples/functions/create-template-deployment.md +0 -21
  358. package/docs/examples/functions/create-variable.md +0 -18
  359. package/docs/examples/functions/create-vcs-deployment.md +0 -18
  360. package/docs/examples/functions/create.md +0 -34
  361. package/docs/examples/functions/delete-deployment.md +0 -16
  362. package/docs/examples/functions/delete-execution.md +0 -16
  363. package/docs/examples/functions/delete-variable.md +0 -16
  364. package/docs/examples/functions/delete.md +0 -15
  365. package/docs/examples/functions/get-deployment-download.md +0 -17
  366. package/docs/examples/functions/get-deployment.md +0 -16
  367. package/docs/examples/functions/get-execution.md +0 -16
  368. package/docs/examples/functions/get-template.md +0 -15
  369. package/docs/examples/functions/get-usage.md +0 -16
  370. package/docs/examples/functions/get-variable.md +0 -16
  371. package/docs/examples/functions/get.md +0 -15
  372. package/docs/examples/functions/list-deployments.md +0 -18
  373. package/docs/examples/functions/list-executions.md +0 -17
  374. package/docs/examples/functions/list-runtimes.md +0 -13
  375. package/docs/examples/functions/list-specifications.md +0 -13
  376. package/docs/examples/functions/list-templates.md +0 -19
  377. package/docs/examples/functions/list-usage.md +0 -15
  378. package/docs/examples/functions/list-variables.md +0 -15
  379. package/docs/examples/functions/list.md +0 -17
  380. package/docs/examples/functions/update-deployment-status.md +0 -16
  381. package/docs/examples/functions/update-function-deployment.md +0 -16
  382. package/docs/examples/functions/update-variable.md +0 -19
  383. package/docs/examples/functions/update.md +0 -34
  384. package/docs/examples/graphql/mutation.md +0 -15
  385. package/docs/examples/graphql/query.md +0 -15
  386. package/docs/examples/health/get-antivirus.md +0 -13
  387. package/docs/examples/health/get-cache.md +0 -13
  388. package/docs/examples/health/get-certificate.md +0 -15
  389. package/docs/examples/health/get-console-pausing.md +0 -16
  390. package/docs/examples/health/get-db.md +0 -13
  391. package/docs/examples/health/get-failed-jobs.md +0 -16
  392. package/docs/examples/health/get-pub-sub.md +0 -13
  393. package/docs/examples/health/get-queue-audits.md +0 -15
  394. package/docs/examples/health/get-queue-billing-project-aggregation.md +0 -15
  395. package/docs/examples/health/get-queue-billing-team-aggregation.md +0 -15
  396. package/docs/examples/health/get-queue-builds.md +0 -15
  397. package/docs/examples/health/get-queue-certificates.md +0 -15
  398. package/docs/examples/health/get-queue-databases.md +0 -16
  399. package/docs/examples/health/get-queue-deletes.md +0 -15
  400. package/docs/examples/health/get-queue-functions.md +0 -15
  401. package/docs/examples/health/get-queue-logs.md +0 -15
  402. package/docs/examples/health/get-queue-mails.md +0 -15
  403. package/docs/examples/health/get-queue-messaging.md +0 -15
  404. package/docs/examples/health/get-queue-migrations.md +0 -15
  405. package/docs/examples/health/get-queue-priority-builds.md +0 -15
  406. package/docs/examples/health/get-queue-region-manager.md +0 -15
  407. package/docs/examples/health/get-queue-stats-resources.md +0 -15
  408. package/docs/examples/health/get-queue-threats.md +0 -15
  409. package/docs/examples/health/get-queue-usage.md +0 -15
  410. package/docs/examples/health/get-queue-webhooks.md +0 -15
  411. package/docs/examples/health/get-storage-local.md +0 -13
  412. package/docs/examples/health/get-storage.md +0 -13
  413. package/docs/examples/health/get-time.md +0 -13
  414. package/docs/examples/health/get.md +0 -13
  415. package/docs/examples/locale/get.md +0 -13
  416. package/docs/examples/locale/list-codes.md +0 -13
  417. package/docs/examples/locale/list-continents.md +0 -13
  418. package/docs/examples/locale/list-countries-eu.md +0 -13
  419. package/docs/examples/locale/list-countries-phones.md +0 -13
  420. package/docs/examples/locale/list-countries.md +0 -13
  421. package/docs/examples/locale/list-currencies.md +0 -13
  422. package/docs/examples/locale/list-languages.md +0 -13
  423. package/docs/examples/messaging/create-apns-provider.md +0 -22
  424. package/docs/examples/messaging/create-email.md +0 -26
  425. package/docs/examples/messaging/create-fcm-provider.md +0 -18
  426. package/docs/examples/messaging/create-mailgun-provider.md +0 -24
  427. package/docs/examples/messaging/create-msg-91-provider.md +0 -20
  428. package/docs/examples/messaging/create-push.md +0 -33
  429. package/docs/examples/messaging/create-resend-provider.md +0 -22
  430. package/docs/examples/messaging/create-sendgrid-provider.md +0 -22
  431. package/docs/examples/messaging/create-sms.md +0 -21
  432. package/docs/examples/messaging/create-smtp-provider.md +0 -28
  433. package/docs/examples/messaging/create-subscriber.md +0 -17
  434. package/docs/examples/messaging/create-telesign-provider.md +0 -20
  435. package/docs/examples/messaging/create-textmagic-provider.md +0 -20
  436. package/docs/examples/messaging/create-topic.md +0 -17
  437. package/docs/examples/messaging/create-twilio-provider.md +0 -20
  438. package/docs/examples/messaging/create-vonage-provider.md +0 -20
  439. package/docs/examples/messaging/delete-provider.md +0 -15
  440. package/docs/examples/messaging/delete-subscriber.md +0 -16
  441. package/docs/examples/messaging/delete-topic.md +0 -15
  442. package/docs/examples/messaging/delete.md +0 -15
  443. package/docs/examples/messaging/get-message.md +0 -15
  444. package/docs/examples/messaging/get-provider.md +0 -15
  445. package/docs/examples/messaging/get-subscriber.md +0 -16
  446. package/docs/examples/messaging/get-topic.md +0 -15
  447. package/docs/examples/messaging/list-message-logs.md +0 -17
  448. package/docs/examples/messaging/list-messages.md +0 -17
  449. package/docs/examples/messaging/list-provider-logs.md +0 -17
  450. package/docs/examples/messaging/list-providers.md +0 -17
  451. package/docs/examples/messaging/list-subscriber-logs.md +0 -17
  452. package/docs/examples/messaging/list-subscribers.md +0 -18
  453. package/docs/examples/messaging/list-targets.md +0 -17
  454. package/docs/examples/messaging/list-topic-logs.md +0 -17
  455. package/docs/examples/messaging/list-topics.md +0 -17
  456. package/docs/examples/messaging/update-apns-provider.md +0 -22
  457. package/docs/examples/messaging/update-email.md +0 -26
  458. package/docs/examples/messaging/update-fcm-provider.md +0 -18
  459. package/docs/examples/messaging/update-mailgun-provider.md +0 -24
  460. package/docs/examples/messaging/update-msg-91-provider.md +0 -20
  461. package/docs/examples/messaging/update-push.md +0 -33
  462. package/docs/examples/messaging/update-resend-provider.md +0 -22
  463. package/docs/examples/messaging/update-sendgrid-provider.md +0 -22
  464. package/docs/examples/messaging/update-sms.md +0 -21
  465. package/docs/examples/messaging/update-smtp-provider.md +0 -28
  466. package/docs/examples/messaging/update-telesign-provider.md +0 -20
  467. package/docs/examples/messaging/update-textmagic-provider.md +0 -20
  468. package/docs/examples/messaging/update-topic.md +0 -17
  469. package/docs/examples/messaging/update-twilio-provider.md +0 -20
  470. package/docs/examples/messaging/update-vonage-provider.md +0 -20
  471. package/docs/examples/migrations/create-appwrite-migration.md +0 -18
  472. package/docs/examples/migrations/create-csv-export.md +0 -23
  473. package/docs/examples/migrations/create-csv-import.md +0 -18
  474. package/docs/examples/migrations/create-firebase-migration.md +0 -16
  475. package/docs/examples/migrations/create-n-host-migration.md +0 -22
  476. package/docs/examples/migrations/create-supabase-migration.md +0 -21
  477. package/docs/examples/migrations/delete.md +0 -15
  478. package/docs/examples/migrations/get-appwrite-report.md +0 -18
  479. package/docs/examples/migrations/get-firebase-report.md +0 -16
  480. package/docs/examples/migrations/get-n-host-report.md +0 -22
  481. package/docs/examples/migrations/get-supabase-report.md +0 -21
  482. package/docs/examples/migrations/get.md +0 -15
  483. package/docs/examples/migrations/list.md +0 -17
  484. package/docs/examples/migrations/retry.md +0 -15
  485. package/docs/examples/organizations/add-credit.md +0 -16
  486. package/docs/examples/organizations/cancel-downgrade.md +0 -15
  487. package/docs/examples/organizations/create-downgrade-feedback.md +0 -19
  488. package/docs/examples/organizations/create-invoice-payment.md +0 -17
  489. package/docs/examples/organizations/create-key.md +0 -18
  490. package/docs/examples/organizations/create.md +0 -24
  491. package/docs/examples/organizations/delete-backup-payment-method.md +0 -15
  492. package/docs/examples/organizations/delete-billing-address.md +0 -15
  493. package/docs/examples/organizations/delete-default-payment-method.md +0 -15
  494. package/docs/examples/organizations/delete-key.md +0 -16
  495. package/docs/examples/organizations/delete.md +0 -15
  496. package/docs/examples/organizations/estimation-create-organization.md +0 -19
  497. package/docs/examples/organizations/estimation-delete-organization.md +0 -15
  498. package/docs/examples/organizations/estimation-update-plan.md +0 -18
  499. package/docs/examples/organizations/get-aggregation.md +0 -18
  500. package/docs/examples/organizations/get-available-credits.md +0 -15
  501. package/docs/examples/organizations/get-billing-address.md +0 -16
  502. package/docs/examples/organizations/get-credit.md +0 -16
  503. package/docs/examples/organizations/get-invoice-download.md +0 -16
  504. package/docs/examples/organizations/get-invoice-view.md +0 -16
  505. package/docs/examples/organizations/get-invoice.md +0 -16
  506. package/docs/examples/organizations/get-key.md +0 -16
  507. package/docs/examples/organizations/get-payment-method.md +0 -16
  508. package/docs/examples/organizations/get-plan.md +0 -15
  509. package/docs/examples/organizations/get-scopes.md +0 -16
  510. package/docs/examples/organizations/get-usage.md +0 -17
  511. package/docs/examples/organizations/list-aggregations.md +0 -16
  512. package/docs/examples/organizations/list-credits.md +0 -16
  513. package/docs/examples/organizations/list-invoices.md +0 -16
  514. package/docs/examples/organizations/list-keys.md +0 -16
  515. package/docs/examples/organizations/list-regions.md +0 -15
  516. package/docs/examples/organizations/list.md +0 -16
  517. package/docs/examples/organizations/set-backup-payment-method.md +0 -16
  518. package/docs/examples/organizations/set-billing-address.md +0 -16
  519. package/docs/examples/organizations/set-billing-email.md +0 -16
  520. package/docs/examples/organizations/set-billing-tax-id.md +0 -16
  521. package/docs/examples/organizations/set-default-payment-method.md +0 -16
  522. package/docs/examples/organizations/update-budget.md +0 -17
  523. package/docs/examples/organizations/update-key.md +0 -19
  524. package/docs/examples/organizations/update-plan.md +0 -22
  525. package/docs/examples/organizations/validate-invoice.md +0 -16
  526. package/docs/examples/organizations/validate-payment.md +0 -16
  527. package/docs/examples/project/create-variable.md +0 -18
  528. package/docs/examples/project/delete-variable.md +0 -15
  529. package/docs/examples/project/get-usage.md +0 -17
  530. package/docs/examples/project/get-variable.md +0 -15
  531. package/docs/examples/project/list-variables.md +0 -16
  532. package/docs/examples/project/update-variable.md +0 -18
  533. package/docs/examples/projects/create-dev-key.md +0 -17
  534. package/docs/examples/projects/create-jwt.md +0 -17
  535. package/docs/examples/projects/create-key.md +0 -19
  536. package/docs/examples/projects/create-platform.md +0 -20
  537. package/docs/examples/projects/create-schedule.md +0 -20
  538. package/docs/examples/projects/create-smtp-test.md +0 -24
  539. package/docs/examples/projects/create.md +0 -27
  540. package/docs/examples/projects/delete-dev-key.md +0 -16
  541. package/docs/examples/projects/delete-email-template.md +0 -17
  542. package/docs/examples/projects/delete-key.md +0 -16
  543. package/docs/examples/projects/delete-platform.md +0 -16
  544. package/docs/examples/projects/delete-sms-template.md +0 -17
  545. package/docs/examples/projects/delete.md +0 -15
  546. package/docs/examples/projects/get-dev-key.md +0 -16
  547. package/docs/examples/projects/get-email-template.md +0 -17
  548. package/docs/examples/projects/get-key.md +0 -16
  549. package/docs/examples/projects/get-platform.md +0 -16
  550. package/docs/examples/projects/get-schedule.md +0 -16
  551. package/docs/examples/projects/get-sms-template.md +0 -17
  552. package/docs/examples/projects/get.md +0 -15
  553. package/docs/examples/projects/list-dev-keys.md +0 -16
  554. package/docs/examples/projects/list-keys.md +0 -17
  555. package/docs/examples/projects/list-platforms.md +0 -16
  556. package/docs/examples/projects/list-schedules.md +0 -17
  557. package/docs/examples/projects/list.md +0 -17
  558. package/docs/examples/projects/update-api-status-all.md +0 -16
  559. package/docs/examples/projects/update-api-status.md +0 -17
  560. package/docs/examples/projects/update-auth-duration.md +0 -16
  561. package/docs/examples/projects/update-auth-limit.md +0 -16
  562. package/docs/examples/projects/update-auth-password-dictionary.md +0 -16
  563. package/docs/examples/projects/update-auth-password-history.md +0 -16
  564. package/docs/examples/projects/update-auth-sessions-limit.md +0 -16
  565. package/docs/examples/projects/update-auth-status.md +0 -17
  566. package/docs/examples/projects/update-console-access.md +0 -15
  567. package/docs/examples/projects/update-dev-key.md +0 -18
  568. package/docs/examples/projects/update-email-template.md +0 -22
  569. package/docs/examples/projects/update-key.md +0 -19
  570. package/docs/examples/projects/update-labels.md +0 -16
  571. package/docs/examples/projects/update-memberships-privacy.md +0 -18
  572. package/docs/examples/projects/update-mock-numbers.md +0 -16
  573. package/docs/examples/projects/update-o-auth-2.md +0 -19
  574. package/docs/examples/projects/update-personal-data-check.md +0 -16
  575. package/docs/examples/projects/update-platform.md +0 -20
  576. package/docs/examples/projects/update-service-status-all.md +0 -16
  577. package/docs/examples/projects/update-service-status.md +0 -17
  578. package/docs/examples/projects/update-session-alerts.md +0 -16
  579. package/docs/examples/projects/update-session-invalidation.md +0 -16
  580. package/docs/examples/projects/update-sms-template.md +0 -18
  581. package/docs/examples/projects/update-smtp.md +0 -24
  582. package/docs/examples/projects/update-status.md +0 -16
  583. package/docs/examples/projects/update-team.md +0 -16
  584. package/docs/examples/projects/update.md +0 -25
  585. package/docs/examples/proxy/create-api-rule.md +0 -15
  586. package/docs/examples/proxy/create-function-rule.md +0 -17
  587. package/docs/examples/proxy/create-redirect-rule.md +0 -19
  588. package/docs/examples/proxy/create-site-rule.md +0 -17
  589. package/docs/examples/proxy/delete-rule.md +0 -15
  590. package/docs/examples/proxy/get-rule.md +0 -15
  591. package/docs/examples/proxy/list-rules.md +0 -17
  592. package/docs/examples/proxy/update-rule-verification.md +0 -15
  593. package/docs/examples/sites/create-deployment.md +0 -20
  594. package/docs/examples/sites/create-duplicate-deployment.md +0 -16
  595. package/docs/examples/sites/create-template-deployment.md +0 -21
  596. package/docs/examples/sites/create-variable.md +0 -18
  597. package/docs/examples/sites/create-vcs-deployment.md +0 -18
  598. package/docs/examples/sites/create.md +0 -35
  599. package/docs/examples/sites/delete-deployment.md +0 -16
  600. package/docs/examples/sites/delete-log.md +0 -16
  601. package/docs/examples/sites/delete-variable.md +0 -16
  602. package/docs/examples/sites/delete.md +0 -15
  603. package/docs/examples/sites/get-deployment-download.md +0 -17
  604. package/docs/examples/sites/get-deployment.md +0 -16
  605. package/docs/examples/sites/get-log.md +0 -16
  606. package/docs/examples/sites/get-template.md +0 -15
  607. package/docs/examples/sites/get-usage.md +0 -16
  608. package/docs/examples/sites/get-variable.md +0 -16
  609. package/docs/examples/sites/get.md +0 -15
  610. package/docs/examples/sites/list-deployments.md +0 -18
  611. package/docs/examples/sites/list-frameworks.md +0 -13
  612. package/docs/examples/sites/list-logs.md +0 -17
  613. package/docs/examples/sites/list-specifications.md +0 -13
  614. package/docs/examples/sites/list-templates.md +0 -18
  615. package/docs/examples/sites/list-usage.md +0 -15
  616. package/docs/examples/sites/list-variables.md +0 -15
  617. package/docs/examples/sites/list.md +0 -17
  618. package/docs/examples/sites/update-deployment-status.md +0 -16
  619. package/docs/examples/sites/update-site-deployment.md +0 -16
  620. package/docs/examples/sites/update-variable.md +0 -19
  621. package/docs/examples/sites/update.md +0 -35
  622. package/docs/examples/storage/create-bucket.md +0 -25
  623. package/docs/examples/storage/create-file.md +0 -18
  624. package/docs/examples/storage/delete-bucket.md +0 -15
  625. package/docs/examples/storage/delete-file.md +0 -16
  626. package/docs/examples/storage/get-bucket-usage.md +0 -16
  627. package/docs/examples/storage/get-bucket.md +0 -15
  628. package/docs/examples/storage/get-file-download.md +0 -17
  629. package/docs/examples/storage/get-file-preview.md +0 -28
  630. package/docs/examples/storage/get-file-view.md +0 -17
  631. package/docs/examples/storage/get-file.md +0 -16
  632. package/docs/examples/storage/get-usage.md +0 -15
  633. package/docs/examples/storage/list-buckets.md +0 -17
  634. package/docs/examples/storage/list-files.md +0 -18
  635. package/docs/examples/storage/update-bucket.md +0 -25
  636. package/docs/examples/storage/update-file.md +0 -18
  637. package/docs/examples/tablesdb/create-boolean-column.md +0 -20
  638. package/docs/examples/tablesdb/create-datetime-column.md +0 -20
  639. package/docs/examples/tablesdb/create-email-column.md +0 -20
  640. package/docs/examples/tablesdb/create-enum-column.md +0 -21
  641. package/docs/examples/tablesdb/create-float-column.md +0 -22
  642. package/docs/examples/tablesdb/create-index.md +0 -21
  643. package/docs/examples/tablesdb/create-integer-column.md +0 -22
  644. package/docs/examples/tablesdb/create-ip-column.md +0 -20
  645. package/docs/examples/tablesdb/create-line-column.md +0 -19
  646. package/docs/examples/tablesdb/create-longtext-column.md +0 -21
  647. package/docs/examples/tablesdb/create-mediumtext-column.md +0 -21
  648. package/docs/examples/tablesdb/create-operations.md +0 -26
  649. package/docs/examples/tablesdb/create-point-column.md +0 -19
  650. package/docs/examples/tablesdb/create-polygon-column.md +0 -19
  651. package/docs/examples/tablesdb/create-relationship-column.md +0 -22
  652. package/docs/examples/tablesdb/create-row.md +0 -26
  653. package/docs/examples/tablesdb/create-rows.md +0 -18
  654. package/docs/examples/tablesdb/create-string-column.md +0 -22
  655. package/docs/examples/tablesdb/create-table.md +0 -22
  656. package/docs/examples/tablesdb/create-text-column.md +0 -21
  657. package/docs/examples/tablesdb/create-transaction.md +0 -15
  658. package/docs/examples/tablesdb/create-url-column.md +0 -20
  659. package/docs/examples/tablesdb/create-varchar-column.md +0 -22
  660. package/docs/examples/tablesdb/create.md +0 -17
  661. package/docs/examples/tablesdb/decrement-row-column.md +0 -21
  662. package/docs/examples/tablesdb/delete-column.md +0 -17
  663. package/docs/examples/tablesdb/delete-index.md +0 -17
  664. package/docs/examples/tablesdb/delete-row.md +0 -18
  665. package/docs/examples/tablesdb/delete-rows.md +0 -18
  666. package/docs/examples/tablesdb/delete-table.md +0 -16
  667. package/docs/examples/tablesdb/delete-transaction.md +0 -15
  668. package/docs/examples/tablesdb/delete.md +0 -15
  669. package/docs/examples/tablesdb/get-column.md +0 -17
  670. package/docs/examples/tablesdb/get-index.md +0 -17
  671. package/docs/examples/tablesdb/get-row.md +0 -19
  672. package/docs/examples/tablesdb/get-table-usage.md +0 -17
  673. package/docs/examples/tablesdb/get-table.md +0 -16
  674. package/docs/examples/tablesdb/get-transaction.md +0 -15
  675. package/docs/examples/tablesdb/get-usage.md +0 -16
  676. package/docs/examples/tablesdb/get.md +0 -15
  677. package/docs/examples/tablesdb/increment-row-column.md +0 -21
  678. package/docs/examples/tablesdb/list-columns.md +0 -18
  679. package/docs/examples/tablesdb/list-indexes.md +0 -18
  680. package/docs/examples/tablesdb/list-row-logs.md +0 -18
  681. package/docs/examples/tablesdb/list-rows.md +0 -20
  682. package/docs/examples/tablesdb/list-table-logs.md +0 -17
  683. package/docs/examples/tablesdb/list-tables.md +0 -18
  684. package/docs/examples/tablesdb/list-transactions.md +0 -15
  685. package/docs/examples/tablesdb/list-usage.md +0 -15
  686. package/docs/examples/tablesdb/list.md +0 -17
  687. package/docs/examples/tablesdb/update-boolean-column.md +0 -20
  688. package/docs/examples/tablesdb/update-datetime-column.md +0 -20
  689. package/docs/examples/tablesdb/update-email-column.md +0 -20
  690. package/docs/examples/tablesdb/update-enum-column.md +0 -21
  691. package/docs/examples/tablesdb/update-float-column.md +0 -22
  692. package/docs/examples/tablesdb/update-integer-column.md +0 -22
  693. package/docs/examples/tablesdb/update-ip-column.md +0 -20
  694. package/docs/examples/tablesdb/update-line-column.md +0 -20
  695. package/docs/examples/tablesdb/update-longtext-column.md +0 -20
  696. package/docs/examples/tablesdb/update-mediumtext-column.md +0 -20
  697. package/docs/examples/tablesdb/update-point-column.md +0 -20
  698. package/docs/examples/tablesdb/update-polygon-column.md +0 -20
  699. package/docs/examples/tablesdb/update-relationship-column.md +0 -19
  700. package/docs/examples/tablesdb/update-row.md +0 -26
  701. package/docs/examples/tablesdb/update-rows.md +0 -25
  702. package/docs/examples/tablesdb/update-string-column.md +0 -21
  703. package/docs/examples/tablesdb/update-table.md +0 -20
  704. package/docs/examples/tablesdb/update-text-column.md +0 -20
  705. package/docs/examples/tablesdb/update-transaction.md +0 -17
  706. package/docs/examples/tablesdb/update-url-column.md +0 -20
  707. package/docs/examples/tablesdb/update-varchar-column.md +0 -21
  708. package/docs/examples/tablesdb/update.md +0 -17
  709. package/docs/examples/tablesdb/upsert-row.md +0 -26
  710. package/docs/examples/tablesdb/upsert-rows.md +0 -18
  711. package/docs/examples/teams/create-membership.md +0 -21
  712. package/docs/examples/teams/create.md +0 -17
  713. package/docs/examples/teams/delete-membership.md +0 -16
  714. package/docs/examples/teams/delete.md +0 -15
  715. package/docs/examples/teams/get-membership.md +0 -16
  716. package/docs/examples/teams/get-prefs.md +0 -15
  717. package/docs/examples/teams/get.md +0 -15
  718. package/docs/examples/teams/list-logs.md +0 -17
  719. package/docs/examples/teams/list-memberships.md +0 -18
  720. package/docs/examples/teams/list.md +0 -17
  721. package/docs/examples/teams/update-membership-status.md +0 -18
  722. package/docs/examples/teams/update-membership.md +0 -17
  723. package/docs/examples/teams/update-name.md +0 -16
  724. package/docs/examples/teams/update-prefs.md +0 -16
  725. package/docs/examples/tokens/create-file-token.md +0 -17
  726. package/docs/examples/tokens/delete.md +0 -15
  727. package/docs/examples/tokens/get.md +0 -15
  728. package/docs/examples/tokens/list.md +0 -18
  729. package/docs/examples/tokens/update.md +0 -16
  730. package/docs/examples/users/create-argon-2-user.md +0 -18
  731. package/docs/examples/users/create-bcrypt-user.md +0 -18
  732. package/docs/examples/users/create-jwt.md +0 -17
  733. package/docs/examples/users/create-md-5-user.md +0 -18
  734. package/docs/examples/users/create-mfa-recovery-codes.md +0 -15
  735. package/docs/examples/users/create-ph-pass-user.md +0 -18
  736. package/docs/examples/users/create-scrypt-modified-user.md +0 -21
  737. package/docs/examples/users/create-scrypt-user.md +0 -23
  738. package/docs/examples/users/create-session.md +0 -15
  739. package/docs/examples/users/create-sha-user.md +0 -19
  740. package/docs/examples/users/create-target.md +0 -20
  741. package/docs/examples/users/create-token.md +0 -17
  742. package/docs/examples/users/create.md +0 -19
  743. package/docs/examples/users/delete-identity.md +0 -15
  744. package/docs/examples/users/delete-mfa-authenticator.md +0 -16
  745. package/docs/examples/users/delete-session.md +0 -16
  746. package/docs/examples/users/delete-sessions.md +0 -15
  747. package/docs/examples/users/delete-target.md +0 -16
  748. package/docs/examples/users/delete.md +0 -15
  749. package/docs/examples/users/get-mfa-recovery-codes.md +0 -15
  750. package/docs/examples/users/get-prefs.md +0 -15
  751. package/docs/examples/users/get-target.md +0 -16
  752. package/docs/examples/users/get-usage.md +0 -15
  753. package/docs/examples/users/get.md +0 -15
  754. package/docs/examples/users/list-identities.md +0 -17
  755. package/docs/examples/users/list-logs.md +0 -17
  756. package/docs/examples/users/list-memberships.md +0 -18
  757. package/docs/examples/users/list-mfa-factors.md +0 -15
  758. package/docs/examples/users/list-sessions.md +0 -16
  759. package/docs/examples/users/list-targets.md +0 -17
  760. package/docs/examples/users/list.md +0 -17
  761. package/docs/examples/users/update-email-verification.md +0 -16
  762. package/docs/examples/users/update-email.md +0 -16
  763. package/docs/examples/users/update-impersonator.md +0 -16
  764. package/docs/examples/users/update-labels.md +0 -16
  765. package/docs/examples/users/update-mfa-recovery-codes.md +0 -15
  766. package/docs/examples/users/update-mfa.md +0 -16
  767. package/docs/examples/users/update-name.md +0 -16
  768. package/docs/examples/users/update-password.md +0 -16
  769. package/docs/examples/users/update-phone-verification.md +0 -16
  770. package/docs/examples/users/update-phone.md +0 -16
  771. package/docs/examples/users/update-prefs.md +0 -16
  772. package/docs/examples/users/update-status.md +0 -16
  773. package/docs/examples/users/update-target.md +0 -19
  774. package/docs/examples/vcs/create-repository-detection.md +0 -18
  775. package/docs/examples/vcs/create-repository.md +0 -17
  776. package/docs/examples/vcs/delete-installation.md +0 -15
  777. package/docs/examples/vcs/get-installation.md +0 -15
  778. package/docs/examples/vcs/get-repository-contents.md +0 -18
  779. package/docs/examples/vcs/get-repository.md +0 -16
  780. package/docs/examples/vcs/list-installations.md +0 -17
  781. package/docs/examples/vcs/list-repositories.md +0 -18
  782. package/docs/examples/vcs/list-repository-branches.md +0 -16
  783. package/docs/examples/vcs/update-external-deployments.md +0 -17
  784. package/docs/examples/webhooks/create.md +0 -22
  785. package/docs/examples/webhooks/delete.md +0 -15
  786. package/docs/examples/webhooks/get.md +0 -15
  787. package/docs/examples/webhooks/list.md +0 -16
  788. package/docs/examples/webhooks/update-signature.md +0 -15
  789. package/docs/examples/webhooks/update.md +0 -22
  790. package/rollup.config.js +0 -44
  791. package/src/channel.ts +0 -158
  792. package/src/client.ts +0 -1085
  793. package/src/enums/adapter.ts +0 -4
  794. package/src/enums/api-service.ts +0 -15
  795. package/src/enums/api.ts +0 -5
  796. package/src/enums/appwrite-migration-resource.ts +0 -27
  797. package/src/enums/attribute-status.ts +0 -7
  798. package/src/enums/auth-method.ts +0 -9
  799. package/src/enums/authentication-factor.ts +0 -6
  800. package/src/enums/authenticator-type.ts +0 -3
  801. package/src/enums/backup-services.ts +0 -8
  802. package/src/enums/billing-plan-group.ts +0 -5
  803. package/src/enums/browser-permission.ts +0 -22
  804. package/src/enums/browser.ts +0 -16
  805. package/src/enums/build-runtime.ts +0 -88
  806. package/src/enums/column-status.ts +0 -7
  807. package/src/enums/compression.ts +0 -5
  808. package/src/enums/console-resource-type.ts +0 -3
  809. package/src/enums/credit-card.ts +0 -19
  810. package/src/enums/database-type.ts +0 -6
  811. package/src/enums/databases-index-type.ts +0 -6
  812. package/src/enums/deployment-download-type.ts +0 -4
  813. package/src/enums/deployment-status.ts +0 -8
  814. package/src/enums/domain-purchase-status.ts +0 -6
  815. package/src/enums/domain-transfer-status-enum.ts +0 -10
  816. package/src/enums/email-template-locale.ts +0 -133
  817. package/src/enums/email-template-type.ts +0 -9
  818. package/src/enums/execution-method.ts +0 -9
  819. package/src/enums/execution-status.ts +0 -7
  820. package/src/enums/execution-trigger.ts +0 -5
  821. package/src/enums/filter-type.ts +0 -4
  822. package/src/enums/firebase-migration-resource.ts +0 -12
  823. package/src/enums/flag.ts +0 -197
  824. package/src/enums/framework.ts +0 -17
  825. package/src/enums/frameworks.ts +0 -17
  826. package/src/enums/health-antivirus-status.ts +0 -5
  827. package/src/enums/health-check-status.ts +0 -4
  828. package/src/enums/image-format.ts +0 -9
  829. package/src/enums/image-gravity.ts +0 -11
  830. package/src/enums/index-status.ts +0 -7
  831. package/src/enums/message-priority.ts +0 -4
  832. package/src/enums/message-status.ts +0 -7
  833. package/src/enums/messaging-provider-type.ts +0 -5
  834. package/src/enums/n-host-migration-resource.ts +0 -13
  835. package/src/enums/name.ts +0 -15
  836. package/src/enums/o-auth-provider.ts +0 -41
  837. package/src/enums/order-by.ts +0 -4
  838. package/src/enums/password-hash.ts +0 -13
  839. package/src/enums/platform-type.ts +0 -17
  840. package/src/enums/platform.ts +0 -4
  841. package/src/enums/project-usage-range.ts +0 -4
  842. package/src/enums/proxy-resource-type.ts +0 -4
  843. package/src/enums/proxy-rule-deployment-resource-type.ts +0 -4
  844. package/src/enums/proxy-rule-status.ts +0 -6
  845. package/src/enums/region.ts +0 -8
  846. package/src/enums/registration-type.ts +0 -6
  847. package/src/enums/relation-mutate.ts +0 -5
  848. package/src/enums/relationship-type.ts +0 -6
  849. package/src/enums/resource-type.ts +0 -6
  850. package/src/enums/runtime.ts +0 -88
  851. package/src/enums/runtimes.ts +0 -88
  852. package/src/enums/scopes.ts +0 -81
  853. package/src/enums/sms-template-locale.ts +0 -133
  854. package/src/enums/sms-template-type.ts +0 -6
  855. package/src/enums/smtp-encryption.ts +0 -5
  856. package/src/enums/smtp-secure.ts +0 -4
  857. package/src/enums/status-code.ts +0 -6
  858. package/src/enums/status.ts +0 -3
  859. package/src/enums/supabase-migration-resource.ts +0 -13
  860. package/src/enums/tables-db-index-type.ts +0 -6
  861. package/src/enums/template-reference-type.ts +0 -5
  862. package/src/enums/theme.ts +0 -4
  863. package/src/enums/timezone.ts +0 -421
  864. package/src/enums/usage-range.ts +0 -5
  865. package/src/enums/use-cases.ts +0 -16
  866. package/src/enums/vcs-detection-type.ts +0 -4
  867. package/src/enums/vcs-reference-type.ts +0 -5
  868. package/src/id.ts +0 -47
  869. package/src/operator.ts +0 -308
  870. package/src/query.ts +0 -576
  871. package/src/service.ts +0 -30
  872. package/src/services/account.ts +0 -4293
  873. package/src/services/activities.ts +0 -116
  874. package/src/services/assistant.ts +0 -67
  875. package/src/services/backups.ts +0 -754
  876. package/src/services/console.ts +0 -678
  877. package/src/services/databases.ts +0 -6376
  878. package/src/services/domains.ts +0 -4064
  879. package/src/services/functions.ts +0 -2224
  880. package/src/services/graphql.ts +0 -124
  881. package/src/services/health.ts +0 -1296
  882. package/src/services/locale.ts +0 -198
  883. package/src/services/messaging.ts +0 -5194
  884. package/src/services/migrations.ts +0 -1207
  885. package/src/services/organizations.ts +0 -2742
  886. package/src/services/project.ts +0 -404
  887. package/src/services/projects.ts +0 -4431
  888. package/src/services/proxy.ts +0 -532
  889. package/src/services/realtime.ts +0 -537
  890. package/src/services/sites.ts +0 -2131
  891. package/src/services/storage.ts +0 -1196
  892. package/src/services/tables-db.ts +0 -6256
  893. package/src/services/teams.ts +0 -959
  894. package/src/services/tokens.ts +0 -315
  895. package/src/services/users.ts +0 -3324
  896. package/src/services/vcs.ts +0 -676
  897. package/src/services/webhooks.ts +0 -451
  898. package/tsconfig.json +0 -24
package/src/client.ts DELETED
@@ -1,1085 +0,0 @@
1
- import { Models } from './models';
2
- import { Channel, ActionableChannel, ResolvedChannel } from './channel';
3
- import { Query } from './query';
4
- import JSONbigModule from 'json-bigint';
5
- const JSONbigParser = JSONbigModule({ storeAsString: false });
6
- const JSONbigSerializer = JSONbigModule({ useNativeBigInt: true });
7
-
8
- const MAX_SAFE = BigInt(Number.MAX_SAFE_INTEGER);
9
- const MIN_SAFE = BigInt(Number.MIN_SAFE_INTEGER);
10
- const MAX_INT64 = BigInt('9223372036854775807');
11
- const MIN_INT64 = BigInt('-9223372036854775808');
12
-
13
- function isBigNumber(value: any): boolean {
14
- return value !== null
15
- && typeof value === 'object'
16
- && value._isBigNumber === true
17
- && typeof value.isInteger === 'function'
18
- && typeof value.toFixed === 'function'
19
- && typeof value.toNumber === 'function';
20
- }
21
-
22
- function reviver(_key: string, value: any): any {
23
- if (isBigNumber(value)) {
24
- if (value.isInteger()) {
25
- const str = value.toFixed();
26
- const bi = BigInt(str);
27
- if (bi >= MIN_SAFE && bi <= MAX_SAFE) {
28
- return Number(str);
29
- }
30
- if (bi >= MIN_INT64 && bi <= MAX_INT64) {
31
- return bi;
32
- }
33
- return value.toNumber();
34
- }
35
- return value.toNumber();
36
- }
37
- return value;
38
- }
39
-
40
- const JSONbig = {
41
- parse: (text: string) => JSONbigParser.parse(text, reviver),
42
- stringify: JSONbigSerializer.stringify
43
- };
44
-
45
- /**
46
- * Payload type representing a key-value pair with string keys and any values.
47
- */
48
- type Payload = {
49
- [key: string]: any;
50
- }
51
-
52
- /**
53
- * Headers type representing a key-value pair with string keys and string values.
54
- */
55
- type Headers = {
56
- [key: string]: string;
57
- }
58
-
59
- /**
60
- * Realtime response structure with different types.
61
- */
62
- type RealtimeResponse = {
63
- /**
64
- * Type of the response: 'error', 'event', 'connected', 'response' or 'pong'.
65
- */
66
- type: 'error' | 'event' | 'connected' | 'response' | 'pong';
67
-
68
- /**
69
- * Data associated with the response based on the response type.
70
- */
71
- data: RealtimeResponseAuthenticated | RealtimeResponseConnected | RealtimeResponseError | RealtimeResponseEvent<unknown> | undefined;
72
- }
73
-
74
- /**
75
- * Realtime request structure for authentication.
76
- */
77
- type RealtimeRequest = {
78
- /**
79
- * Type of the request: 'authentication'.
80
- */
81
- type: 'authentication';
82
-
83
- /**
84
- * Data required for authentication.
85
- */
86
- data: RealtimeRequestAuthenticate;
87
- }
88
-
89
- /**
90
- * Realtime event response structure with generic payload type.
91
- */
92
- type RealtimeResponseEvent<T extends unknown> = {
93
- /**
94
- * List of event names associated with the response.
95
- */
96
- events: string[];
97
-
98
- /**
99
- * List of channel names associated with the response.
100
- */
101
- channels: string[];
102
-
103
- /**
104
- * Timestamp indicating the time of the event.
105
- */
106
- timestamp: string;
107
-
108
- /**
109
- * Payload containing event-specific data.
110
- */
111
- payload: T;
112
-
113
- /**
114
- * Subscription IDs this event matches (from backend, optional).
115
- */
116
- subscriptions?: string[];
117
- }
118
-
119
- /**
120
- * Realtime response structure for errors.
121
- */
122
- type RealtimeResponseError = {
123
- /**
124
- * Numeric error code indicating the type of error.
125
- */
126
- code: number;
127
-
128
- /**
129
- * Error message describing the encountered error.
130
- */
131
- message: string;
132
- }
133
-
134
- /**
135
- * Realtime response structure for a successful connection.
136
- */
137
- type RealtimeResponseConnected = {
138
- /**
139
- * List of channels the user is connected to.
140
- */
141
- channels: string[];
142
-
143
- /**
144
- * User object representing the connected user (optional).
145
- */
146
- user?: object;
147
-
148
- /**
149
- * Map slot index -> subscription ID from backend (optional).
150
- */
151
- subscriptions?: Record<string, string>;
152
- }
153
-
154
- /**
155
- * Realtime response structure for authenticated connections.
156
- */
157
- type RealtimeResponseAuthenticated = {
158
- /**
159
- * Destination channel for the response.
160
- */
161
- to: string;
162
-
163
- /**
164
- * Boolean indicating the success of the authentication process.
165
- */
166
- success: boolean;
167
-
168
- /**
169
- * User object representing the authenticated user.
170
- */
171
- user: object;
172
- }
173
-
174
- /**
175
- * Realtime request structure for authentication.
176
- */
177
- type RealtimeRequestAuthenticate = {
178
- /**
179
- * Session identifier for authentication.
180
- */
181
- session: string;
182
- }
183
-
184
- type TimeoutHandle = ReturnType<typeof setTimeout> | number;
185
-
186
- /**
187
- * Realtime interface representing the structure of a realtime communication object.
188
- */
189
- type Realtime = {
190
- /**
191
- * WebSocket instance for realtime communication.
192
- */
193
- socket?: WebSocket;
194
-
195
- /**
196
- * Timeout for reconnect operations.
197
- */
198
- timeout?: TimeoutHandle;
199
-
200
- /**
201
- * Heartbeat interval for the realtime connection.
202
- */
203
- heartbeat?: TimeoutHandle;
204
-
205
- /**
206
- * URL for establishing the WebSocket connection.
207
- */
208
- url?: string;
209
-
210
- /**
211
- * Last received message from the realtime server.
212
- */
213
- lastMessage?: RealtimeResponse;
214
-
215
- /**
216
- * Set of channel names the client is subscribed to.
217
- */
218
- channels: Set<string>;
219
-
220
- /**
221
- * Set of query strings the client is subscribed to.
222
- */
223
- queries: Set<string>;
224
-
225
- /**
226
- * Map of subscriptions containing channel names and corresponding callback functions.
227
- */
228
- subscriptions: Map<number, {
229
- channels: string[];
230
- queries: string[];
231
- callback: (payload: RealtimeResponseEvent<any>) => void
232
- }>;
233
-
234
- /**
235
- * Map slot index -> subscription ID (from backend, set on 'connected').
236
- */
237
- slotToSubscriptionId: Map<number, string>;
238
-
239
- /**
240
- * Map subscription ID -> slot index (for O(1) event dispatch).
241
- */
242
- subscriptionIdToSlot: Map<string, number>;
243
-
244
- /**
245
- * Counter for managing subscriptions.
246
- */
247
- subscriptionsCounter: number;
248
-
249
- /**
250
- * Boolean indicating whether automatic reconnection is enabled.
251
- */
252
- reconnect: boolean;
253
-
254
- /**
255
- * Number of reconnection attempts made.
256
- */
257
- reconnectAttempts: number;
258
-
259
- /**
260
- * Function to get the timeout duration for communication operations.
261
- */
262
- getTimeout: () => number;
263
-
264
- /**
265
- * Function to establish a WebSocket connection.
266
- */
267
- connect: () => void;
268
-
269
- /**
270
- * Function to create a new WebSocket instance.
271
- */
272
- createSocket: () => void;
273
-
274
- /**
275
- * Function to create a new heartbeat interval.
276
- */
277
- createHeartbeat: () => void;
278
-
279
- /**
280
- * Function to clean up resources associated with specified channels.
281
- *
282
- * @param {string[]} channels - List of channel names to clean up.
283
- */
284
- cleanUp: (channels: string[], queries: string[]) => void;
285
-
286
- /**
287
- * Function to handle incoming messages from the WebSocket connection.
288
- *
289
- * @param {MessageEvent} event - Event containing the received message.
290
- */
291
- onMessage: (event: MessageEvent) => void;
292
- }
293
-
294
- /**
295
- * Type representing upload progress information.
296
- */
297
- type UploadProgress = {
298
- /**
299
- * Identifier for the upload progress.
300
- */
301
- $id: string;
302
-
303
- /**
304
- * Current progress of the upload (in percentage).
305
- */
306
- progress: number;
307
-
308
- /**
309
- * Total size uploaded (in bytes) during the upload process.
310
- */
311
- sizeUploaded: number;
312
-
313
- /**
314
- * Total number of chunks that need to be uploaded.
315
- */
316
- chunksTotal: number;
317
-
318
- /**
319
- * Number of chunks that have been successfully uploaded.
320
- */
321
- chunksUploaded: number;
322
- }
323
-
324
- /**
325
- * Exception thrown by the package
326
- */
327
- class AppwriteException extends Error {
328
- /**
329
- * The error code associated with the exception.
330
- */
331
- code: number;
332
-
333
- /**
334
- * The response string associated with the exception.
335
- */
336
- response: string;
337
-
338
- /**
339
- * Error type.
340
- * See [Error Types](https://appwrite.io/docs/response-codes#errorTypes) for more information.
341
- */
342
- type: string;
343
-
344
- /**
345
- * Initializes a Appwrite Exception.
346
- *
347
- * @param {string} message - The error message.
348
- * @param {number} code - The error code. Default is 0.
349
- * @param {string} type - The error type. Default is an empty string.
350
- * @param {string} response - The response string. Default is an empty string.
351
- */
352
- constructor(message: string, code: number = 0, type: string = '', response: string = '') {
353
- super(message);
354
- this.name = 'AppwriteException';
355
- this.message = message;
356
- this.code = code;
357
- this.type = type;
358
- this.response = response;
359
- }
360
- }
361
-
362
- /**
363
- * Client that handles requests to Appwrite
364
- */
365
- class Client {
366
- static CHUNK_SIZE = 1024 * 1024 * 5;
367
-
368
- /**
369
- * Holds configuration such as project.
370
- */
371
- config: {
372
- endpoint: string;
373
- endpointRealtime: string;
374
- project: string;
375
- key: string;
376
- jwt: string;
377
- locale: string;
378
- mode: string;
379
- cookie: string;
380
- impersonateuserid: string;
381
- impersonateuseremail: string;
382
- impersonateuserphone: string;
383
- platform: string;
384
- selfSigned: boolean;
385
- session?: string;
386
- } = {
387
- endpoint: 'https://cloud.appwrite.io/v1',
388
- endpointRealtime: '',
389
- project: '',
390
- key: '',
391
- jwt: '',
392
- locale: '',
393
- mode: '',
394
- cookie: '',
395
- impersonateuserid: '',
396
- impersonateuseremail: '',
397
- impersonateuserphone: '',
398
- platform: '',
399
- selfSigned: false,
400
- session: undefined,
401
- };
402
- /**
403
- * Custom headers for API requests.
404
- */
405
- headers: Headers = {
406
- 'x-sdk-name': 'Console',
407
- 'x-sdk-platform': 'console',
408
- 'x-sdk-language': 'web',
409
- 'x-sdk-version': '8.1.0',
410
- 'X-Appwrite-Response-Format': '1.9.0',
411
- };
412
-
413
- /**
414
- * Get Headers
415
- *
416
- * Returns a copy of the current request headers, including any
417
- * authentication headers. Handle with care.
418
- *
419
- * @returns {Headers}
420
- */
421
- getHeaders(): Headers {
422
- return { ...this.headers };
423
- }
424
-
425
- /**
426
- * Set Endpoint
427
- *
428
- * Your project endpoint
429
- *
430
- * @param {string} endpoint
431
- *
432
- * @returns {this}
433
- */
434
- setEndpoint(endpoint: string): this {
435
- if (!endpoint || typeof endpoint !== 'string') {
436
- throw new AppwriteException('Endpoint must be a valid string');
437
- }
438
-
439
- if (!endpoint.startsWith('http://') && !endpoint.startsWith('https://')) {
440
- throw new AppwriteException('Invalid endpoint URL: ' + endpoint);
441
- }
442
-
443
- this.config.endpoint = endpoint;
444
- this.config.endpointRealtime = endpoint.replace('https://', 'wss://').replace('http://', 'ws://');
445
-
446
- return this;
447
- }
448
-
449
- /**
450
- * Set Realtime Endpoint
451
- *
452
- * @param {string} endpointRealtime
453
- *
454
- * @returns {this}
455
- */
456
- setEndpointRealtime(endpointRealtime: string): this {
457
- if (!endpointRealtime || typeof endpointRealtime !== 'string') {
458
- throw new AppwriteException('Endpoint must be a valid string');
459
- }
460
-
461
- if (!endpointRealtime.startsWith('ws://') && !endpointRealtime.startsWith('wss://')) {
462
- throw new AppwriteException('Invalid realtime endpoint URL: ' + endpointRealtime);
463
- }
464
-
465
- this.config.endpointRealtime = endpointRealtime;
466
- return this;
467
- }
468
-
469
- /**
470
- * Set self-signed
471
- *
472
- * @param {boolean} selfSigned
473
- *
474
- * @returns {this}
475
- */
476
- setSelfSigned(selfSigned: boolean): this {
477
- this.config.selfSigned = selfSigned;
478
- return this;
479
- }
480
-
481
- /**
482
- * Set Project
483
- *
484
- * Your project ID
485
- *
486
- * @param value string
487
- *
488
- * @return {this}
489
- */
490
- setProject(value: string): this {
491
- this.headers['X-Appwrite-Project'] = value;
492
- this.config.project = value;
493
- return this;
494
- }
495
- /**
496
- * Set Key
497
- *
498
- * Your secret API key
499
- *
500
- * @param value string
501
- *
502
- * @return {this}
503
- */
504
- setKey(value: string): this {
505
- this.headers['X-Appwrite-Key'] = value;
506
- this.config.key = value;
507
- return this;
508
- }
509
- /**
510
- * Set JWT
511
- *
512
- * Your secret JSON Web Token
513
- *
514
- * @param value string
515
- *
516
- * @return {this}
517
- */
518
- setJWT(value: string): this {
519
- this.headers['X-Appwrite-JWT'] = value;
520
- this.config.jwt = value;
521
- return this;
522
- }
523
- /**
524
- * Set Locale
525
- *
526
- * @param value string
527
- *
528
- * @return {this}
529
- */
530
- setLocale(value: string): this {
531
- this.headers['X-Appwrite-Locale'] = value;
532
- this.config.locale = value;
533
- return this;
534
- }
535
- /**
536
- * Set Mode
537
- *
538
- * @param value string
539
- *
540
- * @return {this}
541
- */
542
- setMode(value: string): this {
543
- this.headers['X-Appwrite-Mode'] = value;
544
- this.config.mode = value;
545
- return this;
546
- }
547
- /**
548
- * Set Cookie
549
- *
550
- * The user cookie to authenticate with
551
- *
552
- * @param value string
553
- *
554
- * @return {this}
555
- */
556
- setCookie(value: string): this {
557
- this.headers['Cookie'] = value;
558
- this.config.cookie = value;
559
- return this;
560
- }
561
- /**
562
- * Set ImpersonateUserId
563
- *
564
- * Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data.
565
- *
566
- * @param value string
567
- *
568
- * @return {this}
569
- */
570
- setImpersonateUserId(value: string): this {
571
- this.headers['X-Appwrite-Impersonate-User-Id'] = value;
572
- this.config.impersonateuserid = value;
573
- return this;
574
- }
575
- /**
576
- * Set ImpersonateUserEmail
577
- *
578
- * Impersonate a user by email on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data.
579
- *
580
- * @param value string
581
- *
582
- * @return {this}
583
- */
584
- setImpersonateUserEmail(value: string): this {
585
- this.headers['X-Appwrite-Impersonate-User-Email'] = value;
586
- this.config.impersonateuseremail = value;
587
- return this;
588
- }
589
- /**
590
- * Set ImpersonateUserPhone
591
- *
592
- * Impersonate a user by phone on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data.
593
- *
594
- * @param value string
595
- *
596
- * @return {this}
597
- */
598
- setImpersonateUserPhone(value: string): this {
599
- this.headers['X-Appwrite-Impersonate-User-Phone'] = value;
600
- this.config.impersonateuserphone = value;
601
- return this;
602
- }
603
- /**
604
- * Set Platform
605
- *
606
- * The platform type (Appwrite or Imagine)
607
- *
608
- * @param value string
609
- *
610
- * @return {this}
611
- */
612
- setPlatform(value: string): this {
613
- this.headers['X-Appwrite-Platform'] = value;
614
- this.config.platform = value;
615
- return this;
616
- }
617
-
618
- private realtime: Realtime = {
619
- socket: undefined,
620
- timeout: undefined,
621
- heartbeat: undefined,
622
- url: '',
623
- channels: new Set(),
624
- queries: new Set(),
625
- subscriptions: new Map(),
626
- slotToSubscriptionId: new Map(),
627
- subscriptionIdToSlot: new Map(),
628
- subscriptionsCounter: 0,
629
- reconnect: true,
630
- reconnectAttempts: 0,
631
- lastMessage: undefined,
632
- connect: () => {
633
- clearTimeout(this.realtime.timeout);
634
- this.realtime.timeout = window?.setTimeout(() => {
635
- this.realtime.createSocket();
636
- }, 50);
637
- },
638
- getTimeout: () => {
639
- switch (true) {
640
- case this.realtime.reconnectAttempts < 5:
641
- return 1000;
642
- case this.realtime.reconnectAttempts < 15:
643
- return 5000;
644
- case this.realtime.reconnectAttempts < 100:
645
- return 10_000;
646
- default:
647
- return 60_000;
648
- }
649
- },
650
- createHeartbeat: () => {
651
- if (this.realtime.heartbeat) {
652
- clearTimeout(this.realtime.heartbeat);
653
- }
654
-
655
- this.realtime.heartbeat = window?.setInterval(() => {
656
- this.realtime.socket?.send(JSONbig.stringify({
657
- type: 'ping'
658
- }));
659
- }, 20_000);
660
- },
661
- createSocket: () => {
662
- if (this.realtime.subscriptions.size < 1) {
663
- this.realtime.reconnect = false;
664
- this.realtime.socket?.close();
665
- return;
666
- }
667
-
668
- const encodedProject = encodeURIComponent((this.config.project as string) ?? '');
669
- let queryParams = 'project=' + encodedProject;
670
-
671
- this.realtime.channels.forEach(channel => {
672
- queryParams += '&channels[]=' + encodeURIComponent(channel);
673
- });
674
-
675
- // Per-subscription queries: channel[slot][]=query so server can route events by subscription
676
- const selectAllQuery = Query.select(['*']).toString();
677
- this.realtime.subscriptions.forEach((sub, slot) => {
678
- const queries = sub.queries.length > 0 ? sub.queries : [selectAllQuery];
679
- sub.channels.forEach(channel => {
680
- queries.forEach(query => {
681
- queryParams += '&' + encodeURIComponent(channel) + '[' + slot + '][]=' + encodeURIComponent(query);
682
- });
683
- });
684
- });
685
-
686
- const url = this.config.endpointRealtime + '/realtime?' + queryParams;
687
-
688
- if (
689
- url !== this.realtime.url || // Check if URL is present
690
- !this.realtime.socket || // Check if WebSocket has not been created
691
- this.realtime.socket?.readyState > WebSocket.OPEN // Check if WebSocket is CLOSING (3) or CLOSED (4)
692
- ) {
693
- if (
694
- this.realtime.socket &&
695
- this.realtime.socket?.readyState < WebSocket.CLOSING // Close WebSocket if it is CONNECTING (0) or OPEN (1)
696
- ) {
697
- this.realtime.reconnect = false;
698
- this.realtime.socket.close();
699
- }
700
-
701
- this.realtime.url = url;
702
- this.realtime.socket = new WebSocket(url);
703
- this.realtime.socket.addEventListener('message', this.realtime.onMessage);
704
- this.realtime.socket.addEventListener('open', _event => {
705
- this.realtime.reconnectAttempts = 0;
706
- this.realtime.createHeartbeat();
707
- });
708
- this.realtime.socket.addEventListener('close', event => {
709
- if (
710
- !this.realtime.reconnect ||
711
- (
712
- this.realtime?.lastMessage?.type === 'error' && // Check if last message was of type error
713
- (<RealtimeResponseError>this.realtime?.lastMessage.data).code === 1008 // Check for policy violation 1008
714
- )
715
- ) {
716
- this.realtime.reconnect = true;
717
- return;
718
- }
719
-
720
- const timeout = this.realtime.getTimeout();
721
- console.error(`Realtime got disconnected. Reconnect will be attempted in ${timeout / 1000} seconds.`, event.reason);
722
-
723
- setTimeout(() => {
724
- this.realtime.reconnectAttempts++;
725
- this.realtime.createSocket();
726
- }, timeout);
727
- })
728
- }
729
- },
730
- onMessage: (event) => {
731
- try {
732
- const message: RealtimeResponse = JSONbig.parse(event.data);
733
- this.realtime.lastMessage = message;
734
- switch (message.type) {
735
- case 'connected': {
736
- const messageData = <RealtimeResponseConnected>message.data;
737
- if (messageData?.subscriptions) {
738
- this.realtime.slotToSubscriptionId.clear();
739
- this.realtime.subscriptionIdToSlot.clear();
740
- for (const [slotStr, subscriptionId] of Object.entries(messageData.subscriptions)) {
741
- const slot = Number(slotStr);
742
- if (!isNaN(slot) && typeof subscriptionId === 'string') {
743
- this.realtime.slotToSubscriptionId.set(slot, subscriptionId);
744
- this.realtime.subscriptionIdToSlot.set(subscriptionId, slot);
745
- }
746
- }
747
- }
748
-
749
- let session = this.config.session;
750
- if (!session) {
751
- const cookie = JSONbig.parse(window.localStorage.getItem('cookieFallback') ?? '{}');
752
- session = cookie?.[`a_session_${this.config.project}`];
753
- }
754
- if (session && !messageData?.user) {
755
- this.realtime.socket?.send(JSONbig.stringify(<RealtimeRequest>{
756
- type: 'authentication',
757
- data: {
758
- session
759
- }
760
- }));
761
- }
762
- break;
763
- }
764
- case 'event': {
765
- const data = <RealtimeResponseEvent<unknown>>message.data;
766
- if (!data?.channels) break;
767
-
768
- const eventSubIds = data.subscriptions;
769
- if (eventSubIds && eventSubIds.length > 0) {
770
- for (const subscriptionId of eventSubIds) {
771
- const slot = this.realtime.subscriptionIdToSlot.get(subscriptionId);
772
- if (slot !== undefined) {
773
- const subscription = this.realtime.subscriptions.get(slot);
774
- if (subscription) {
775
- setTimeout(() => subscription.callback(data));
776
- }
777
- }
778
- }
779
- } else {
780
- const isSubscribed = data.channels.some(channel => this.realtime.channels.has(channel));
781
- if (!isSubscribed) break;
782
- this.realtime.subscriptions.forEach(subscription => {
783
- if (data.channels.some(channel => subscription.channels.includes(channel))) {
784
- setTimeout(() => subscription.callback(data));
785
- }
786
- });
787
- }
788
- break;
789
- }
790
- case 'pong':
791
- break; // Handle pong response if needed
792
- case 'error':
793
- throw message.data;
794
- default:
795
- break;
796
- }
797
- } catch (e) {
798
- console.error(e);
799
- }
800
- },
801
- cleanUp: (channels, queries) => {
802
- this.realtime.channels.forEach(channel => {
803
- if (channels.includes(channel)) {
804
- let found = Array.from(this.realtime.subscriptions).some(([_key, subscription] )=> {
805
- return subscription.channels.includes(channel);
806
- })
807
-
808
- if (!found) {
809
- this.realtime.channels.delete(channel);
810
- }
811
- }
812
- })
813
-
814
- this.realtime.queries.forEach(query => {
815
- if (queries.includes(query)) {
816
- let found = Array.from(this.realtime.subscriptions).some(([_key, subscription]) => {
817
- return subscription.queries?.includes(query);
818
- });
819
-
820
- if (!found) {
821
- this.realtime.queries.delete(query);
822
- }
823
- }
824
- })
825
- }
826
- }
827
-
828
- /**
829
- * Subscribes to Appwrite events and passes you the payload in realtime.
830
- *
831
- * @deprecated Use the Realtime service instead.
832
- * @see Realtime
833
- *
834
- * @param {string|string[]|Channel<any>|ActionableChannel|ResolvedChannel|(Channel<any>|ActionableChannel|ResolvedChannel)[]} channels
835
- * Channel to subscribe - pass a single channel as a string or Channel builder instance, or multiple with an array.
836
- *
837
- * Possible channels are:
838
- * - account
839
- * - collections
840
- * - collections.[ID]
841
- * - collections.[ID].documents
842
- * - documents
843
- * - documents.[ID]
844
- * - files
845
- * - files.[ID]
846
- * - executions
847
- * - executions.[ID]
848
- * - functions.[ID]
849
- * - teams
850
- * - teams.[ID]
851
- * - memberships
852
- * - memberships.[ID]
853
- *
854
- * You can also use Channel builders:
855
- * - Channel.database('db').collection('col').document('doc').create()
856
- * - Channel.bucket('bucket').file('file').update()
857
- * - Channel.function('func').execution('exec').delete()
858
- * - Channel.team('team').create()
859
- * - Channel.membership('membership').update()
860
- * @param {(payload: RealtimeMessage) => void} callback Is called on every realtime update.
861
- * @returns {() => void} Unsubscribes from events.
862
- */
863
- subscribe<T extends unknown>(
864
- channels: string | string[] | Channel<any> | ActionableChannel | ResolvedChannel | (Channel<any> | ActionableChannel | ResolvedChannel)[],
865
- callback: (payload: RealtimeResponseEvent<T>) => void,
866
- queries: (string | Query)[] = []
867
- ): () => void {
868
- const channelArray = Array.isArray(channels) ? channels : [channels];
869
- // Convert Channel instances to strings
870
- const channelStrings = channelArray.map(ch => {
871
- if (typeof ch === 'string') {
872
- return ch;
873
- }
874
- // All Channel instances have toString() method
875
- if (ch && typeof (ch as Channel<any>).toString === 'function') {
876
- return (ch as Channel<any>).toString();
877
- }
878
- // Fallback to generic string conversion
879
- return String(ch);
880
- });
881
- channelStrings.forEach(channel => this.realtime.channels.add(channel));
882
-
883
- const queryStrings = (queries ?? []).map(q => typeof q === 'string' ? q : q.toString());
884
- queryStrings.forEach(query => this.realtime.queries.add(query));
885
-
886
- const counter = this.realtime.subscriptionsCounter++;
887
- this.realtime.subscriptions.set(counter, {
888
- channels: channelStrings,
889
- queries: queryStrings,
890
- callback
891
- });
892
-
893
- this.realtime.connect();
894
-
895
- return () => {
896
- this.realtime.subscriptions.delete(counter);
897
- this.realtime.cleanUp(channelStrings, queryStrings);
898
- this.realtime.connect();
899
- }
900
- }
901
-
902
- prepareRequest(method: string, url: URL, headers: Headers = {}, params: Payload = {}): { uri: string, options: RequestInit } {
903
- method = method.toUpperCase();
904
-
905
- headers = Object.assign({}, this.headers, headers);
906
-
907
- if (typeof window !== 'undefined' && window.localStorage) {
908
- const cookieFallback = window.localStorage.getItem('cookieFallback');
909
- if (cookieFallback) {
910
- headers['X-Fallback-Cookies'] = cookieFallback;
911
- }
912
- }
913
-
914
- let options: RequestInit = {
915
- method,
916
- headers,
917
- };
918
-
919
- if (headers['X-Appwrite-Dev-Key'] === undefined) {
920
- options.credentials = 'include';
921
- }
922
-
923
- if (method === 'GET') {
924
- for (const [key, value] of Object.entries(Client.flatten(params))) {
925
- url.searchParams.append(key, value);
926
- }
927
- } else {
928
- switch (headers['content-type']) {
929
- case 'application/json':
930
- options.body = JSONbig.stringify(params);
931
- break;
932
-
933
- case 'multipart/form-data':
934
- const formData = new FormData();
935
-
936
- for (const [key, value] of Object.entries(params)) {
937
- if (value instanceof File) {
938
- formData.append(key, value, value.name);
939
- } else if (Array.isArray(value)) {
940
- for (const nestedValue of value) {
941
- formData.append(`${key}[]`, nestedValue);
942
- }
943
- } else {
944
- formData.append(key, value);
945
- }
946
- }
947
-
948
- options.body = formData;
949
- delete headers['content-type'];
950
- break;
951
- }
952
- }
953
-
954
- return { uri: url.toString(), options };
955
- }
956
-
957
- async chunkedUpload(method: string, url: URL, headers: Headers = {}, originalPayload: Payload = {}, onProgress: (progress: UploadProgress) => void) {
958
- const [fileParam, file] = Object.entries(originalPayload).find(([_, value]) => value instanceof File) ?? [];
959
-
960
- if (!file || !fileParam) {
961
- throw new Error('File not found in payload');
962
- }
963
-
964
- if (file.size <= Client.CHUNK_SIZE) {
965
- return await this.call(method, url, headers, originalPayload);
966
- }
967
-
968
- let start = 0;
969
- let response = null;
970
-
971
- while (start < file.size) {
972
- let end = start + Client.CHUNK_SIZE; // Prepare end for the next chunk
973
- if (end >= file.size) {
974
- end = file.size; // Adjust for the last chunk to include the last byte
975
- }
976
-
977
- headers['content-range'] = `bytes ${start}-${end-1}/${file.size}`;
978
- const chunk = file.slice(start, end);
979
-
980
- let payload = { ...originalPayload };
981
- payload[fileParam] = new File([chunk], file.name);
982
-
983
- response = await this.call(method, url, headers, payload);
984
-
985
- if (onProgress && typeof onProgress === 'function') {
986
- onProgress({
987
- $id: response.$id,
988
- progress: Math.round((end / file.size) * 100),
989
- sizeUploaded: end,
990
- chunksTotal: Math.ceil(file.size / Client.CHUNK_SIZE),
991
- chunksUploaded: Math.ceil(end / Client.CHUNK_SIZE)
992
- });
993
- }
994
-
995
- if (response && response.$id) {
996
- headers['x-appwrite-id'] = response.$id;
997
- }
998
-
999
- start = end;
1000
- }
1001
-
1002
- return response;
1003
- }
1004
-
1005
- async ping(): Promise<string> {
1006
- return this.call('GET', new URL(this.config.endpoint + '/ping'));
1007
- }
1008
-
1009
- async call(method: string, url: URL, headers: Headers = {}, params: Payload = {}, responseType = 'json'): Promise<any> {
1010
- const { uri, options } = this.prepareRequest(method, url, headers, params);
1011
-
1012
- let data: any = null;
1013
-
1014
- const response = await fetch(uri, options);
1015
-
1016
- // type opaque: No-CORS, different-origin response (CORS-issue)
1017
- if (response.type === 'opaque') {
1018
- throw new AppwriteException(
1019
- `Invalid Origin. Register your new client (${window.location.host}) as a new Web platform on your project console dashboard`,
1020
- 403,
1021
- "forbidden",
1022
- ""
1023
- );
1024
- }
1025
-
1026
- const warnings = response.headers.get('x-appwrite-warning');
1027
- if (warnings) {
1028
- warnings.split(';').forEach((warning: string) => console.warn('Warning: ' + warning));
1029
- }
1030
-
1031
- if (response.headers.get('content-type')?.includes('application/json')) {
1032
- data = JSONbig.parse(await response.text());
1033
- } else if (responseType === 'arrayBuffer') {
1034
- data = await response.arrayBuffer();
1035
- } else {
1036
- data = {
1037
- message: await response.text()
1038
- };
1039
- }
1040
-
1041
- if (400 <= response.status) {
1042
- let responseText = '';
1043
- if (response.headers.get('content-type')?.includes('application/json') || responseType === 'arrayBuffer') {
1044
- responseText = JSONbig.stringify(data);
1045
- } else {
1046
- responseText = data?.message;
1047
- }
1048
- throw new AppwriteException(data?.message, response.status, data?.type, responseText);
1049
- }
1050
-
1051
- const cookieFallback = response.headers.get('X-Fallback-Cookies');
1052
-
1053
- if (typeof window !== 'undefined' && window.localStorage && cookieFallback) {
1054
- window.console.warn('Appwrite is using localStorage for session management. Increase your security by adding a custom domain as your API endpoint.');
1055
- window.localStorage.setItem('cookieFallback', cookieFallback);
1056
- }
1057
-
1058
- if (data && typeof data === 'object') {
1059
- data.toString = () => JSONbig.stringify(data);
1060
- }
1061
-
1062
- return data;
1063
- }
1064
-
1065
- static flatten(data: Payload, prefix = ''): Payload {
1066
- let output: Payload = {};
1067
-
1068
- for (const [key, value] of Object.entries(data)) {
1069
- let finalKey = prefix ? prefix + '[' + key +']' : key;
1070
- if (Array.isArray(value)) {
1071
- output = { ...output, ...Client.flatten(value, finalKey) };
1072
- } else {
1073
- output[finalKey] = value;
1074
- }
1075
- }
1076
-
1077
- return output;
1078
- }
1079
- }
1080
-
1081
- export { Client, AppwriteException };
1082
- export { Query } from './query';
1083
- export type { Models, Payload, UploadProgress };
1084
- export type { RealtimeResponseEvent };
1085
- export type { QueryTypes, QueryTypesList } from './query';