@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
@@ -1,1196 +0,0 @@
1
- import { Service } from '../service';
2
- import { AppwriteException, Client, type Payload, UploadProgress } from '../client';
3
- import type { Models } from '../models';
4
-
5
- import { Compression } from '../enums/compression';
6
- import { ImageGravity } from '../enums/image-gravity';
7
- import { ImageFormat } from '../enums/image-format';
8
- import { UsageRange } from '../enums/usage-range';
9
-
10
- export class Storage {
11
- client: Client;
12
-
13
- constructor(client: Client) {
14
- this.client = client;
15
- }
16
-
17
- /**
18
- * Get a list of all the storage buckets. You can use the query params to filter your results.
19
- *
20
- * @param {string[]} params.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: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus, transformations
21
- * @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
22
- * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
23
- * @throws {AppwriteException}
24
- * @returns {Promise<Models.BucketList>}
25
- */
26
- listBuckets(params?: { queries?: string[], search?: string, total?: boolean }): Promise<Models.BucketList>;
27
- /**
28
- * Get a list of all the storage buckets. You can use the query params to filter your results.
29
- *
30
- * @param {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: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus, transformations
31
- * @param {string} search - Search term to filter your list results. Max length: 256 chars.
32
- * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
33
- * @throws {AppwriteException}
34
- * @returns {Promise<Models.BucketList>}
35
- * @deprecated Use the object parameter style method for a better developer experience.
36
- */
37
- listBuckets(queries?: string[], search?: string, total?: boolean): Promise<Models.BucketList>;
38
- listBuckets(
39
- paramsOrFirst?: { queries?: string[], search?: string, total?: boolean } | string[],
40
- ...rest: [(string)?, (boolean)?]
41
- ): Promise<Models.BucketList> {
42
- let params: { queries?: string[], search?: string, total?: boolean };
43
-
44
- if (!paramsOrFirst || (paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
45
- params = (paramsOrFirst || {}) as { queries?: string[], search?: string, total?: boolean };
46
- } else {
47
- params = {
48
- queries: paramsOrFirst as string[],
49
- search: rest[0] as string,
50
- total: rest[1] as boolean
51
- };
52
- }
53
-
54
- const queries = params.queries;
55
- const search = params.search;
56
- const total = params.total;
57
-
58
-
59
- const apiPath = '/storage/buckets';
60
- const payload: Payload = {};
61
- if (typeof queries !== 'undefined') {
62
- payload['queries'] = queries;
63
- }
64
- if (typeof search !== 'undefined') {
65
- payload['search'] = search;
66
- }
67
- if (typeof total !== 'undefined') {
68
- payload['total'] = total;
69
- }
70
- const uri = new URL(this.client.config.endpoint + apiPath);
71
-
72
- const apiHeaders: { [header: string]: string } = {
73
- }
74
-
75
- return this.client.call(
76
- 'get',
77
- uri,
78
- apiHeaders,
79
- payload
80
- );
81
- }
82
-
83
- /**
84
- * Create a new storage bucket.
85
- *
86
- * @param {string} params.bucketId - Unique 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.
87
- * @param {string} params.name - Bucket name
88
- * @param {string[]} params.permissions - An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
89
- * @param {boolean} params.fileSecurity - Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https://appwrite.io/docs/permissions).
90
- * @param {boolean} params.enabled - Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.
91
- * @param {number} params.maximumFileSize - Maximum file size allowed in bytes. Maximum allowed value is 5GB.
92
- * @param {string[]} params.allowedFileExtensions - Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
93
- * @param {Compression} params.compression - Compression algorithm chosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
94
- * @param {boolean} params.encryption - Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
95
- * @param {boolean} params.antivirus - Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
96
- * @param {boolean} params.transformations - Are image transformations enabled?
97
- * @throws {AppwriteException}
98
- * @returns {Promise<Models.Bucket>}
99
- */
100
- createBucket(params: { bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean, transformations?: boolean }): Promise<Models.Bucket>;
101
- /**
102
- * Create a new storage bucket.
103
- *
104
- * @param {string} bucketId - Unique 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.
105
- * @param {string} name - Bucket name
106
- * @param {string[]} permissions - An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
107
- * @param {boolean} fileSecurity - Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https://appwrite.io/docs/permissions).
108
- * @param {boolean} enabled - Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.
109
- * @param {number} maximumFileSize - Maximum file size allowed in bytes. Maximum allowed value is 5GB.
110
- * @param {string[]} allowedFileExtensions - Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
111
- * @param {Compression} compression - Compression algorithm chosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
112
- * @param {boolean} encryption - Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
113
- * @param {boolean} antivirus - Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
114
- * @param {boolean} transformations - Are image transformations enabled?
115
- * @throws {AppwriteException}
116
- * @returns {Promise<Models.Bucket>}
117
- * @deprecated Use the object parameter style method for a better developer experience.
118
- */
119
- createBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean, transformations?: boolean): Promise<Models.Bucket>;
120
- createBucket(
121
- paramsOrFirst: { bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean, transformations?: boolean } | string,
122
- ...rest: [(string)?, (string[])?, (boolean)?, (boolean)?, (number)?, (string[])?, (Compression)?, (boolean)?, (boolean)?, (boolean)?]
123
- ): Promise<Models.Bucket> {
124
- let params: { bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean, transformations?: boolean };
125
-
126
- if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
127
- params = (paramsOrFirst || {}) as { bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean, transformations?: boolean };
128
- } else {
129
- params = {
130
- bucketId: paramsOrFirst as string,
131
- name: rest[0] as string,
132
- permissions: rest[1] as string[],
133
- fileSecurity: rest[2] as boolean,
134
- enabled: rest[3] as boolean,
135
- maximumFileSize: rest[4] as number,
136
- allowedFileExtensions: rest[5] as string[],
137
- compression: rest[6] as Compression,
138
- encryption: rest[7] as boolean,
139
- antivirus: rest[8] as boolean,
140
- transformations: rest[9] as boolean
141
- };
142
- }
143
-
144
- const bucketId = params.bucketId;
145
- const name = params.name;
146
- const permissions = params.permissions;
147
- const fileSecurity = params.fileSecurity;
148
- const enabled = params.enabled;
149
- const maximumFileSize = params.maximumFileSize;
150
- const allowedFileExtensions = params.allowedFileExtensions;
151
- const compression = params.compression;
152
- const encryption = params.encryption;
153
- const antivirus = params.antivirus;
154
- const transformations = params.transformations;
155
-
156
- if (typeof bucketId === 'undefined') {
157
- throw new AppwriteException('Missing required parameter: "bucketId"');
158
- }
159
- if (typeof name === 'undefined') {
160
- throw new AppwriteException('Missing required parameter: "name"');
161
- }
162
-
163
- const apiPath = '/storage/buckets';
164
- const payload: Payload = {};
165
- if (typeof bucketId !== 'undefined') {
166
- payload['bucketId'] = bucketId;
167
- }
168
- if (typeof name !== 'undefined') {
169
- payload['name'] = name;
170
- }
171
- if (typeof permissions !== 'undefined') {
172
- payload['permissions'] = permissions;
173
- }
174
- if (typeof fileSecurity !== 'undefined') {
175
- payload['fileSecurity'] = fileSecurity;
176
- }
177
- if (typeof enabled !== 'undefined') {
178
- payload['enabled'] = enabled;
179
- }
180
- if (typeof maximumFileSize !== 'undefined') {
181
- payload['maximumFileSize'] = maximumFileSize;
182
- }
183
- if (typeof allowedFileExtensions !== 'undefined') {
184
- payload['allowedFileExtensions'] = allowedFileExtensions;
185
- }
186
- if (typeof compression !== 'undefined') {
187
- payload['compression'] = compression;
188
- }
189
- if (typeof encryption !== 'undefined') {
190
- payload['encryption'] = encryption;
191
- }
192
- if (typeof antivirus !== 'undefined') {
193
- payload['antivirus'] = antivirus;
194
- }
195
- if (typeof transformations !== 'undefined') {
196
- payload['transformations'] = transformations;
197
- }
198
- const uri = new URL(this.client.config.endpoint + apiPath);
199
-
200
- const apiHeaders: { [header: string]: string } = {
201
- 'content-type': 'application/json',
202
- }
203
-
204
- return this.client.call(
205
- 'post',
206
- uri,
207
- apiHeaders,
208
- payload
209
- );
210
- }
211
-
212
- /**
213
- * Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.
214
- *
215
- * @param {string} params.bucketId - Bucket unique ID.
216
- * @throws {AppwriteException}
217
- * @returns {Promise<Models.Bucket>}
218
- */
219
- getBucket(params: { bucketId: string }): Promise<Models.Bucket>;
220
- /**
221
- * Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.
222
- *
223
- * @param {string} bucketId - Bucket unique ID.
224
- * @throws {AppwriteException}
225
- * @returns {Promise<Models.Bucket>}
226
- * @deprecated Use the object parameter style method for a better developer experience.
227
- */
228
- getBucket(bucketId: string): Promise<Models.Bucket>;
229
- getBucket(
230
- paramsOrFirst: { bucketId: string } | string
231
- ): Promise<Models.Bucket> {
232
- let params: { bucketId: string };
233
-
234
- if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
235
- params = (paramsOrFirst || {}) as { bucketId: string };
236
- } else {
237
- params = {
238
- bucketId: paramsOrFirst as string
239
- };
240
- }
241
-
242
- const bucketId = params.bucketId;
243
-
244
- if (typeof bucketId === 'undefined') {
245
- throw new AppwriteException('Missing required parameter: "bucketId"');
246
- }
247
-
248
- const apiPath = '/storage/buckets/{bucketId}'.replace('{bucketId}', bucketId);
249
- const payload: Payload = {};
250
- const uri = new URL(this.client.config.endpoint + apiPath);
251
-
252
- const apiHeaders: { [header: string]: string } = {
253
- }
254
-
255
- return this.client.call(
256
- 'get',
257
- uri,
258
- apiHeaders,
259
- payload
260
- );
261
- }
262
-
263
- /**
264
- * Update a storage bucket by its unique ID.
265
- *
266
- * @param {string} params.bucketId - Bucket unique ID.
267
- * @param {string} params.name - Bucket name
268
- * @param {string[]} params.permissions - An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
269
- * @param {boolean} params.fileSecurity - Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https://appwrite.io/docs/permissions).
270
- * @param {boolean} params.enabled - Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.
271
- * @param {number} params.maximumFileSize - Maximum file size allowed in bytes. Maximum allowed value is 5GB.
272
- * @param {string[]} params.allowedFileExtensions - Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
273
- * @param {Compression} params.compression - Compression algorithm chosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
274
- * @param {boolean} params.encryption - Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
275
- * @param {boolean} params.antivirus - Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
276
- * @param {boolean} params.transformations - Are image transformations enabled?
277
- * @throws {AppwriteException}
278
- * @returns {Promise<Models.Bucket>}
279
- */
280
- updateBucket(params: { bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean, transformations?: boolean }): Promise<Models.Bucket>;
281
- /**
282
- * Update a storage bucket by its unique ID.
283
- *
284
- * @param {string} bucketId - Bucket unique ID.
285
- * @param {string} name - Bucket name
286
- * @param {string[]} permissions - An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
287
- * @param {boolean} fileSecurity - Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https://appwrite.io/docs/permissions).
288
- * @param {boolean} enabled - Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.
289
- * @param {number} maximumFileSize - Maximum file size allowed in bytes. Maximum allowed value is 5GB.
290
- * @param {string[]} allowedFileExtensions - Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
291
- * @param {Compression} compression - Compression algorithm chosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
292
- * @param {boolean} encryption - Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
293
- * @param {boolean} antivirus - Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
294
- * @param {boolean} transformations - Are image transformations enabled?
295
- * @throws {AppwriteException}
296
- * @returns {Promise<Models.Bucket>}
297
- * @deprecated Use the object parameter style method for a better developer experience.
298
- */
299
- updateBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean, transformations?: boolean): Promise<Models.Bucket>;
300
- updateBucket(
301
- paramsOrFirst: { bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean, transformations?: boolean } | string,
302
- ...rest: [(string)?, (string[])?, (boolean)?, (boolean)?, (number)?, (string[])?, (Compression)?, (boolean)?, (boolean)?, (boolean)?]
303
- ): Promise<Models.Bucket> {
304
- let params: { bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean, transformations?: boolean };
305
-
306
- if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
307
- params = (paramsOrFirst || {}) as { bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean, transformations?: boolean };
308
- } else {
309
- params = {
310
- bucketId: paramsOrFirst as string,
311
- name: rest[0] as string,
312
- permissions: rest[1] as string[],
313
- fileSecurity: rest[2] as boolean,
314
- enabled: rest[3] as boolean,
315
- maximumFileSize: rest[4] as number,
316
- allowedFileExtensions: rest[5] as string[],
317
- compression: rest[6] as Compression,
318
- encryption: rest[7] as boolean,
319
- antivirus: rest[8] as boolean,
320
- transformations: rest[9] as boolean
321
- };
322
- }
323
-
324
- const bucketId = params.bucketId;
325
- const name = params.name;
326
- const permissions = params.permissions;
327
- const fileSecurity = params.fileSecurity;
328
- const enabled = params.enabled;
329
- const maximumFileSize = params.maximumFileSize;
330
- const allowedFileExtensions = params.allowedFileExtensions;
331
- const compression = params.compression;
332
- const encryption = params.encryption;
333
- const antivirus = params.antivirus;
334
- const transformations = params.transformations;
335
-
336
- if (typeof bucketId === 'undefined') {
337
- throw new AppwriteException('Missing required parameter: "bucketId"');
338
- }
339
- if (typeof name === 'undefined') {
340
- throw new AppwriteException('Missing required parameter: "name"');
341
- }
342
-
343
- const apiPath = '/storage/buckets/{bucketId}'.replace('{bucketId}', bucketId);
344
- const payload: Payload = {};
345
- if (typeof name !== 'undefined') {
346
- payload['name'] = name;
347
- }
348
- if (typeof permissions !== 'undefined') {
349
- payload['permissions'] = permissions;
350
- }
351
- if (typeof fileSecurity !== 'undefined') {
352
- payload['fileSecurity'] = fileSecurity;
353
- }
354
- if (typeof enabled !== 'undefined') {
355
- payload['enabled'] = enabled;
356
- }
357
- if (typeof maximumFileSize !== 'undefined') {
358
- payload['maximumFileSize'] = maximumFileSize;
359
- }
360
- if (typeof allowedFileExtensions !== 'undefined') {
361
- payload['allowedFileExtensions'] = allowedFileExtensions;
362
- }
363
- if (typeof compression !== 'undefined') {
364
- payload['compression'] = compression;
365
- }
366
- if (typeof encryption !== 'undefined') {
367
- payload['encryption'] = encryption;
368
- }
369
- if (typeof antivirus !== 'undefined') {
370
- payload['antivirus'] = antivirus;
371
- }
372
- if (typeof transformations !== 'undefined') {
373
- payload['transformations'] = transformations;
374
- }
375
- const uri = new URL(this.client.config.endpoint + apiPath);
376
-
377
- const apiHeaders: { [header: string]: string } = {
378
- 'content-type': 'application/json',
379
- }
380
-
381
- return this.client.call(
382
- 'put',
383
- uri,
384
- apiHeaders,
385
- payload
386
- );
387
- }
388
-
389
- /**
390
- * Delete a storage bucket by its unique ID.
391
- *
392
- * @param {string} params.bucketId - Bucket unique ID.
393
- * @throws {AppwriteException}
394
- * @returns {Promise<{}>}
395
- */
396
- deleteBucket(params: { bucketId: string }): Promise<{}>;
397
- /**
398
- * Delete a storage bucket by its unique ID.
399
- *
400
- * @param {string} bucketId - Bucket unique ID.
401
- * @throws {AppwriteException}
402
- * @returns {Promise<{}>}
403
- * @deprecated Use the object parameter style method for a better developer experience.
404
- */
405
- deleteBucket(bucketId: string): Promise<{}>;
406
- deleteBucket(
407
- paramsOrFirst: { bucketId: string } | string
408
- ): Promise<{}> {
409
- let params: { bucketId: string };
410
-
411
- if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
412
- params = (paramsOrFirst || {}) as { bucketId: string };
413
- } else {
414
- params = {
415
- bucketId: paramsOrFirst as string
416
- };
417
- }
418
-
419
- const bucketId = params.bucketId;
420
-
421
- if (typeof bucketId === 'undefined') {
422
- throw new AppwriteException('Missing required parameter: "bucketId"');
423
- }
424
-
425
- const apiPath = '/storage/buckets/{bucketId}'.replace('{bucketId}', bucketId);
426
- const payload: Payload = {};
427
- const uri = new URL(this.client.config.endpoint + apiPath);
428
-
429
- const apiHeaders: { [header: string]: string } = {
430
- 'content-type': 'application/json',
431
- }
432
-
433
- return this.client.call(
434
- 'delete',
435
- uri,
436
- apiHeaders,
437
- payload
438
- );
439
- }
440
-
441
- /**
442
- * Get a list of all the user files. You can use the query params to filter your results.
443
- *
444
- * @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
445
- * @param {string[]} params.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, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded
446
- * @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
447
- * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
448
- * @throws {AppwriteException}
449
- * @returns {Promise<Models.FileList>}
450
- */
451
- listFiles(params: { bucketId: string, queries?: string[], search?: string, total?: boolean }): Promise<Models.FileList>;
452
- /**
453
- * Get a list of all the user files. You can use the query params to filter your results.
454
- *
455
- * @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
456
- * @param {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, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded
457
- * @param {string} search - Search term to filter your list results. Max length: 256 chars.
458
- * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
459
- * @throws {AppwriteException}
460
- * @returns {Promise<Models.FileList>}
461
- * @deprecated Use the object parameter style method for a better developer experience.
462
- */
463
- listFiles(bucketId: string, queries?: string[], search?: string, total?: boolean): Promise<Models.FileList>;
464
- listFiles(
465
- paramsOrFirst: { bucketId: string, queries?: string[], search?: string, total?: boolean } | string,
466
- ...rest: [(string[])?, (string)?, (boolean)?]
467
- ): Promise<Models.FileList> {
468
- let params: { bucketId: string, queries?: string[], search?: string, total?: boolean };
469
-
470
- if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
471
- params = (paramsOrFirst || {}) as { bucketId: string, queries?: string[], search?: string, total?: boolean };
472
- } else {
473
- params = {
474
- bucketId: paramsOrFirst as string,
475
- queries: rest[0] as string[],
476
- search: rest[1] as string,
477
- total: rest[2] as boolean
478
- };
479
- }
480
-
481
- const bucketId = params.bucketId;
482
- const queries = params.queries;
483
- const search = params.search;
484
- const total = params.total;
485
-
486
- if (typeof bucketId === 'undefined') {
487
- throw new AppwriteException('Missing required parameter: "bucketId"');
488
- }
489
-
490
- const apiPath = '/storage/buckets/{bucketId}/files'.replace('{bucketId}', bucketId);
491
- const payload: Payload = {};
492
- if (typeof queries !== 'undefined') {
493
- payload['queries'] = queries;
494
- }
495
- if (typeof search !== 'undefined') {
496
- payload['search'] = search;
497
- }
498
- if (typeof total !== 'undefined') {
499
- payload['total'] = total;
500
- }
501
- const uri = new URL(this.client.config.endpoint + apiPath);
502
-
503
- const apiHeaders: { [header: string]: string } = {
504
- }
505
-
506
- return this.client.call(
507
- 'get',
508
- uri,
509
- apiHeaders,
510
- payload
511
- );
512
- }
513
-
514
- /**
515
- * Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https://appwrite.io/docs/server/storage#storageCreateBucket) API or directly from your Appwrite console.
516
- *
517
- * Larger files should be uploaded using multiple requests with the [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.
518
- *
519
- * When the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.
520
- *
521
- * If you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.
522
- *
523
- *
524
- * @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
525
- * @param {string} params.fileId - File 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.
526
- * @param {File} params.file - Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https://appwrite.io/docs/products/storage/upload-download#input-file).
527
- * @param {string[]} params.permissions - An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
528
- * @throws {AppwriteException}
529
- * @returns {Promise<Models.File>}
530
- */
531
- createFile(params: { bucketId: string, fileId: string, file: File, permissions?: string[], onProgress?: (progress: UploadProgress) => void }): Promise<Models.File>;
532
- /**
533
- * Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https://appwrite.io/docs/server/storage#storageCreateBucket) API or directly from your Appwrite console.
534
- *
535
- * Larger files should be uploaded using multiple requests with the [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.
536
- *
537
- * When the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.
538
- *
539
- * If you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.
540
- *
541
- *
542
- * @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
543
- * @param {string} fileId - File 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.
544
- * @param {File} file - Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https://appwrite.io/docs/products/storage/upload-download#input-file).
545
- * @param {string[]} permissions - An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
546
- * @throws {AppwriteException}
547
- * @returns {Promise<Models.File>}
548
- * @deprecated Use the object parameter style method for a better developer experience.
549
- */
550
- createFile(bucketId: string, fileId: string, file: File, permissions?: string[], onProgress?: (progress: UploadProgress) => void): Promise<Models.File>;
551
- createFile(
552
- paramsOrFirst: { bucketId: string, fileId: string, file: File, permissions?: string[], onProgress?: (progress: UploadProgress) => void } | string,
553
- ...rest: [(string)?, (File)?, (string[])?,((progress: UploadProgress) => void)?]
554
- ): Promise<Models.File> {
555
- let params: { bucketId: string, fileId: string, file: File, permissions?: string[] };
556
- let onProgress: ((progress: UploadProgress) => void);
557
-
558
- if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
559
- params = (paramsOrFirst || {}) as { bucketId: string, fileId: string, file: File, permissions?: string[] };
560
- onProgress = paramsOrFirst?.onProgress as ((progress: UploadProgress) => void);
561
- } else {
562
- params = {
563
- bucketId: paramsOrFirst as string,
564
- fileId: rest[0] as string,
565
- file: rest[1] as File,
566
- permissions: rest[2] as string[]
567
- };
568
- onProgress = rest[3] as ((progress: UploadProgress) => void);
569
- }
570
-
571
- const bucketId = params.bucketId;
572
- const fileId = params.fileId;
573
- const file = params.file;
574
- const permissions = params.permissions;
575
-
576
- if (typeof bucketId === 'undefined') {
577
- throw new AppwriteException('Missing required parameter: "bucketId"');
578
- }
579
- if (typeof fileId === 'undefined') {
580
- throw new AppwriteException('Missing required parameter: "fileId"');
581
- }
582
- if (typeof file === 'undefined') {
583
- throw new AppwriteException('Missing required parameter: "file"');
584
- }
585
-
586
- const apiPath = '/storage/buckets/{bucketId}/files'.replace('{bucketId}', bucketId);
587
- const payload: Payload = {};
588
- if (typeof fileId !== 'undefined') {
589
- payload['fileId'] = fileId;
590
- }
591
- if (typeof file !== 'undefined') {
592
- payload['file'] = file;
593
- }
594
- if (typeof permissions !== 'undefined') {
595
- payload['permissions'] = permissions;
596
- }
597
- const uri = new URL(this.client.config.endpoint + apiPath);
598
-
599
- const apiHeaders: { [header: string]: string } = {
600
- 'content-type': 'multipart/form-data',
601
- }
602
-
603
- return this.client.chunkedUpload(
604
- 'post',
605
- uri,
606
- apiHeaders,
607
- payload,
608
- onProgress
609
- );
610
- }
611
-
612
- /**
613
- * Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.
614
- *
615
- * @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
616
- * @param {string} params.fileId - File ID.
617
- * @throws {AppwriteException}
618
- * @returns {Promise<Models.File>}
619
- */
620
- getFile(params: { bucketId: string, fileId: string }): Promise<Models.File>;
621
- /**
622
- * Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.
623
- *
624
- * @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
625
- * @param {string} fileId - File ID.
626
- * @throws {AppwriteException}
627
- * @returns {Promise<Models.File>}
628
- * @deprecated Use the object parameter style method for a better developer experience.
629
- */
630
- getFile(bucketId: string, fileId: string): Promise<Models.File>;
631
- getFile(
632
- paramsOrFirst: { bucketId: string, fileId: string } | string,
633
- ...rest: [(string)?]
634
- ): Promise<Models.File> {
635
- let params: { bucketId: string, fileId: string };
636
-
637
- if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
638
- params = (paramsOrFirst || {}) as { bucketId: string, fileId: string };
639
- } else {
640
- params = {
641
- bucketId: paramsOrFirst as string,
642
- fileId: rest[0] as string
643
- };
644
- }
645
-
646
- const bucketId = params.bucketId;
647
- const fileId = params.fileId;
648
-
649
- if (typeof bucketId === 'undefined') {
650
- throw new AppwriteException('Missing required parameter: "bucketId"');
651
- }
652
- if (typeof fileId === 'undefined') {
653
- throw new AppwriteException('Missing required parameter: "fileId"');
654
- }
655
-
656
- const apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
657
- const payload: Payload = {};
658
- const uri = new URL(this.client.config.endpoint + apiPath);
659
-
660
- const apiHeaders: { [header: string]: string } = {
661
- }
662
-
663
- return this.client.call(
664
- 'get',
665
- uri,
666
- apiHeaders,
667
- payload
668
- );
669
- }
670
-
671
- /**
672
- * Update a file by its unique ID. Only users with write permissions have access to update this resource.
673
- *
674
- * @param {string} params.bucketId - Bucket unique ID.
675
- * @param {string} params.fileId - File ID.
676
- * @param {string} params.name - File name.
677
- * @param {string[]} params.permissions - An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
678
- * @throws {AppwriteException}
679
- * @returns {Promise<Models.File>}
680
- */
681
- updateFile(params: { bucketId: string, fileId: string, name?: string, permissions?: string[] }): Promise<Models.File>;
682
- /**
683
- * Update a file by its unique ID. Only users with write permissions have access to update this resource.
684
- *
685
- * @param {string} bucketId - Bucket unique ID.
686
- * @param {string} fileId - File ID.
687
- * @param {string} name - File name.
688
- * @param {string[]} permissions - An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
689
- * @throws {AppwriteException}
690
- * @returns {Promise<Models.File>}
691
- * @deprecated Use the object parameter style method for a better developer experience.
692
- */
693
- updateFile(bucketId: string, fileId: string, name?: string, permissions?: string[]): Promise<Models.File>;
694
- updateFile(
695
- paramsOrFirst: { bucketId: string, fileId: string, name?: string, permissions?: string[] } | string,
696
- ...rest: [(string)?, (string)?, (string[])?]
697
- ): Promise<Models.File> {
698
- let params: { bucketId: string, fileId: string, name?: string, permissions?: string[] };
699
-
700
- if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
701
- params = (paramsOrFirst || {}) as { bucketId: string, fileId: string, name?: string, permissions?: string[] };
702
- } else {
703
- params = {
704
- bucketId: paramsOrFirst as string,
705
- fileId: rest[0] as string,
706
- name: rest[1] as string,
707
- permissions: rest[2] as string[]
708
- };
709
- }
710
-
711
- const bucketId = params.bucketId;
712
- const fileId = params.fileId;
713
- const name = params.name;
714
- const permissions = params.permissions;
715
-
716
- if (typeof bucketId === 'undefined') {
717
- throw new AppwriteException('Missing required parameter: "bucketId"');
718
- }
719
- if (typeof fileId === 'undefined') {
720
- throw new AppwriteException('Missing required parameter: "fileId"');
721
- }
722
-
723
- const apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
724
- const payload: Payload = {};
725
- if (typeof name !== 'undefined') {
726
- payload['name'] = name;
727
- }
728
- if (typeof permissions !== 'undefined') {
729
- payload['permissions'] = permissions;
730
- }
731
- const uri = new URL(this.client.config.endpoint + apiPath);
732
-
733
- const apiHeaders: { [header: string]: string } = {
734
- 'content-type': 'application/json',
735
- }
736
-
737
- return this.client.call(
738
- 'put',
739
- uri,
740
- apiHeaders,
741
- payload
742
- );
743
- }
744
-
745
- /**
746
- * Delete a file by its unique ID. Only users with write permissions have access to delete this resource.
747
- *
748
- * @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
749
- * @param {string} params.fileId - File ID.
750
- * @throws {AppwriteException}
751
- * @returns {Promise<{}>}
752
- */
753
- deleteFile(params: { bucketId: string, fileId: string }): Promise<{}>;
754
- /**
755
- * Delete a file by its unique ID. Only users with write permissions have access to delete this resource.
756
- *
757
- * @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
758
- * @param {string} fileId - File ID.
759
- * @throws {AppwriteException}
760
- * @returns {Promise<{}>}
761
- * @deprecated Use the object parameter style method for a better developer experience.
762
- */
763
- deleteFile(bucketId: string, fileId: string): Promise<{}>;
764
- deleteFile(
765
- paramsOrFirst: { bucketId: string, fileId: string } | string,
766
- ...rest: [(string)?]
767
- ): Promise<{}> {
768
- let params: { bucketId: string, fileId: string };
769
-
770
- if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
771
- params = (paramsOrFirst || {}) as { bucketId: string, fileId: string };
772
- } else {
773
- params = {
774
- bucketId: paramsOrFirst as string,
775
- fileId: rest[0] as string
776
- };
777
- }
778
-
779
- const bucketId = params.bucketId;
780
- const fileId = params.fileId;
781
-
782
- if (typeof bucketId === 'undefined') {
783
- throw new AppwriteException('Missing required parameter: "bucketId"');
784
- }
785
- if (typeof fileId === 'undefined') {
786
- throw new AppwriteException('Missing required parameter: "fileId"');
787
- }
788
-
789
- const apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
790
- const payload: Payload = {};
791
- const uri = new URL(this.client.config.endpoint + apiPath);
792
-
793
- const apiHeaders: { [header: string]: string } = {
794
- 'content-type': 'application/json',
795
- }
796
-
797
- return this.client.call(
798
- 'delete',
799
- uri,
800
- apiHeaders,
801
- payload
802
- );
803
- }
804
-
805
- /**
806
- * Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.
807
- *
808
- * @param {string} params.bucketId - Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
809
- * @param {string} params.fileId - File ID.
810
- * @param {string} params.token - File token for accessing this file.
811
- * @throws {AppwriteException}
812
- * @returns {string}
813
- */
814
- getFileDownload(params: { bucketId: string, fileId: string, token?: string }): string;
815
- /**
816
- * Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.
817
- *
818
- * @param {string} bucketId - Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
819
- * @param {string} fileId - File ID.
820
- * @param {string} token - File token for accessing this file.
821
- * @throws {AppwriteException}
822
- * @returns {string}
823
- * @deprecated Use the object parameter style method for a better developer experience.
824
- */
825
- getFileDownload(bucketId: string, fileId: string, token?: string): string;
826
- getFileDownload(
827
- paramsOrFirst: { bucketId: string, fileId: string, token?: string } | string,
828
- ...rest: [(string)?, (string)?]
829
- ): string {
830
- let params: { bucketId: string, fileId: string, token?: string };
831
-
832
- if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
833
- params = (paramsOrFirst || {}) as { bucketId: string, fileId: string, token?: string };
834
- } else {
835
- params = {
836
- bucketId: paramsOrFirst as string,
837
- fileId: rest[0] as string,
838
- token: rest[1] as string
839
- };
840
- }
841
-
842
- const bucketId = params.bucketId;
843
- const fileId = params.fileId;
844
- const token = params.token;
845
-
846
- if (typeof bucketId === 'undefined') {
847
- throw new AppwriteException('Missing required parameter: "bucketId"');
848
- }
849
- if (typeof fileId === 'undefined') {
850
- throw new AppwriteException('Missing required parameter: "fileId"');
851
- }
852
-
853
- const apiPath = '/storage/buckets/{bucketId}/files/{fileId}/download'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
854
- const payload: Payload = {};
855
- if (typeof token !== 'undefined') {
856
- payload['token'] = token;
857
- }
858
- const uri = new URL(this.client.config.endpoint + apiPath);
859
-
860
- const apiHeaders: { [header: string]: string } = {
861
- }
862
-
863
- payload['project'] = this.client.config.project;
864
-
865
- for (const [key, value] of Object.entries(Service.flatten(payload))) {
866
- uri.searchParams.append(key, value);
867
- }
868
-
869
- return uri.toString();
870
- }
871
-
872
- /**
873
- * Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.
874
- *
875
- * @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
876
- * @param {string} params.fileId - File ID
877
- * @param {number} params.width - Resize preview image width, Pass an integer between 0 to 4000.
878
- * @param {number} params.height - Resize preview image height, Pass an integer between 0 to 4000.
879
- * @param {ImageGravity} params.gravity - Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right
880
- * @param {number} params.quality - Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
881
- * @param {number} params.borderWidth - Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.
882
- * @param {string} params.borderColor - Preview image border color. Use a valid HEX color, no # is needed for prefix.
883
- * @param {number} params.borderRadius - Preview image border radius in pixels. Pass an integer between 0 to 4000.
884
- * @param {number} params.opacity - Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.
885
- * @param {number} params.rotation - Preview image rotation in degrees. Pass an integer between -360 and 360.
886
- * @param {string} params.background - Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.
887
- * @param {ImageFormat} params.output - Output format type (jpeg, jpg, png, gif and webp).
888
- * @param {string} params.token - File token for accessing this file.
889
- * @throws {AppwriteException}
890
- * @returns {string}
891
- */
892
- getFilePreview(params: { bucketId: string, fileId: string, width?: number, height?: number, gravity?: ImageGravity, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: ImageFormat, token?: string }): string;
893
- /**
894
- * Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.
895
- *
896
- * @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
897
- * @param {string} fileId - File ID
898
- * @param {number} width - Resize preview image width, Pass an integer between 0 to 4000.
899
- * @param {number} height - Resize preview image height, Pass an integer between 0 to 4000.
900
- * @param {ImageGravity} gravity - Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right
901
- * @param {number} quality - Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
902
- * @param {number} borderWidth - Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.
903
- * @param {string} borderColor - Preview image border color. Use a valid HEX color, no # is needed for prefix.
904
- * @param {number} borderRadius - Preview image border radius in pixels. Pass an integer between 0 to 4000.
905
- * @param {number} opacity - Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.
906
- * @param {number} rotation - Preview image rotation in degrees. Pass an integer between -360 and 360.
907
- * @param {string} background - Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.
908
- * @param {ImageFormat} output - Output format type (jpeg, jpg, png, gif and webp).
909
- * @param {string} token - File token for accessing this file.
910
- * @throws {AppwriteException}
911
- * @returns {string}
912
- * @deprecated Use the object parameter style method for a better developer experience.
913
- */
914
- getFilePreview(bucketId: string, fileId: string, width?: number, height?: number, gravity?: ImageGravity, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: ImageFormat, token?: string): string;
915
- getFilePreview(
916
- paramsOrFirst: { bucketId: string, fileId: string, width?: number, height?: number, gravity?: ImageGravity, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: ImageFormat, token?: string } | string,
917
- ...rest: [(string)?, (number)?, (number)?, (ImageGravity)?, (number)?, (number)?, (string)?, (number)?, (number)?, (number)?, (string)?, (ImageFormat)?, (string)?]
918
- ): string {
919
- let params: { bucketId: string, fileId: string, width?: number, height?: number, gravity?: ImageGravity, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: ImageFormat, token?: string };
920
-
921
- if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
922
- params = (paramsOrFirst || {}) as { bucketId: string, fileId: string, width?: number, height?: number, gravity?: ImageGravity, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: ImageFormat, token?: string };
923
- } else {
924
- params = {
925
- bucketId: paramsOrFirst as string,
926
- fileId: rest[0] as string,
927
- width: rest[1] as number,
928
- height: rest[2] as number,
929
- gravity: rest[3] as ImageGravity,
930
- quality: rest[4] as number,
931
- borderWidth: rest[5] as number,
932
- borderColor: rest[6] as string,
933
- borderRadius: rest[7] as number,
934
- opacity: rest[8] as number,
935
- rotation: rest[9] as number,
936
- background: rest[10] as string,
937
- output: rest[11] as ImageFormat,
938
- token: rest[12] as string
939
- };
940
- }
941
-
942
- const bucketId = params.bucketId;
943
- const fileId = params.fileId;
944
- const width = params.width;
945
- const height = params.height;
946
- const gravity = params.gravity;
947
- const quality = params.quality;
948
- const borderWidth = params.borderWidth;
949
- const borderColor = params.borderColor;
950
- const borderRadius = params.borderRadius;
951
- const opacity = params.opacity;
952
- const rotation = params.rotation;
953
- const background = params.background;
954
- const output = params.output;
955
- const token = params.token;
956
-
957
- if (typeof bucketId === 'undefined') {
958
- throw new AppwriteException('Missing required parameter: "bucketId"');
959
- }
960
- if (typeof fileId === 'undefined') {
961
- throw new AppwriteException('Missing required parameter: "fileId"');
962
- }
963
-
964
- const apiPath = '/storage/buckets/{bucketId}/files/{fileId}/preview'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
965
- const payload: Payload = {};
966
- if (typeof width !== 'undefined') {
967
- payload['width'] = width;
968
- }
969
- if (typeof height !== 'undefined') {
970
- payload['height'] = height;
971
- }
972
- if (typeof gravity !== 'undefined') {
973
- payload['gravity'] = gravity;
974
- }
975
- if (typeof quality !== 'undefined') {
976
- payload['quality'] = quality;
977
- }
978
- if (typeof borderWidth !== 'undefined') {
979
- payload['borderWidth'] = borderWidth;
980
- }
981
- if (typeof borderColor !== 'undefined') {
982
- payload['borderColor'] = borderColor;
983
- }
984
- if (typeof borderRadius !== 'undefined') {
985
- payload['borderRadius'] = borderRadius;
986
- }
987
- if (typeof opacity !== 'undefined') {
988
- payload['opacity'] = opacity;
989
- }
990
- if (typeof rotation !== 'undefined') {
991
- payload['rotation'] = rotation;
992
- }
993
- if (typeof background !== 'undefined') {
994
- payload['background'] = background;
995
- }
996
- if (typeof output !== 'undefined') {
997
- payload['output'] = output;
998
- }
999
- if (typeof token !== 'undefined') {
1000
- payload['token'] = token;
1001
- }
1002
- const uri = new URL(this.client.config.endpoint + apiPath);
1003
-
1004
- const apiHeaders: { [header: string]: string } = {
1005
- }
1006
-
1007
- payload['project'] = this.client.config.project;
1008
-
1009
- for (const [key, value] of Object.entries(Service.flatten(payload))) {
1010
- uri.searchParams.append(key, value);
1011
- }
1012
-
1013
- return uri.toString();
1014
- }
1015
-
1016
- /**
1017
- * Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.
1018
- *
1019
- * @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
1020
- * @param {string} params.fileId - File ID.
1021
- * @param {string} params.token - File token for accessing this file.
1022
- * @throws {AppwriteException}
1023
- * @returns {string}
1024
- */
1025
- getFileView(params: { bucketId: string, fileId: string, token?: string }): string;
1026
- /**
1027
- * Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.
1028
- *
1029
- * @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
1030
- * @param {string} fileId - File ID.
1031
- * @param {string} token - File token for accessing this file.
1032
- * @throws {AppwriteException}
1033
- * @returns {string}
1034
- * @deprecated Use the object parameter style method for a better developer experience.
1035
- */
1036
- getFileView(bucketId: string, fileId: string, token?: string): string;
1037
- getFileView(
1038
- paramsOrFirst: { bucketId: string, fileId: string, token?: string } | string,
1039
- ...rest: [(string)?, (string)?]
1040
- ): string {
1041
- let params: { bucketId: string, fileId: string, token?: string };
1042
-
1043
- if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
1044
- params = (paramsOrFirst || {}) as { bucketId: string, fileId: string, token?: string };
1045
- } else {
1046
- params = {
1047
- bucketId: paramsOrFirst as string,
1048
- fileId: rest[0] as string,
1049
- token: rest[1] as string
1050
- };
1051
- }
1052
-
1053
- const bucketId = params.bucketId;
1054
- const fileId = params.fileId;
1055
- const token = params.token;
1056
-
1057
- if (typeof bucketId === 'undefined') {
1058
- throw new AppwriteException('Missing required parameter: "bucketId"');
1059
- }
1060
- if (typeof fileId === 'undefined') {
1061
- throw new AppwriteException('Missing required parameter: "fileId"');
1062
- }
1063
-
1064
- const apiPath = '/storage/buckets/{bucketId}/files/{fileId}/view'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
1065
- const payload: Payload = {};
1066
- if (typeof token !== 'undefined') {
1067
- payload['token'] = token;
1068
- }
1069
- const uri = new URL(this.client.config.endpoint + apiPath);
1070
-
1071
- const apiHeaders: { [header: string]: string } = {
1072
- }
1073
-
1074
- payload['project'] = this.client.config.project;
1075
-
1076
- for (const [key, value] of Object.entries(Service.flatten(payload))) {
1077
- uri.searchParams.append(key, value);
1078
- }
1079
-
1080
- return uri.toString();
1081
- }
1082
-
1083
- /**
1084
- * Get usage metrics and statistics for all buckets in the project. You can view the total number of buckets, files, storage usage. 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.
1085
- *
1086
- *
1087
- * @param {UsageRange} params.range - Date range.
1088
- * @throws {AppwriteException}
1089
- * @returns {Promise<Models.UsageStorage>}
1090
- */
1091
- getUsage(params?: { range?: UsageRange }): Promise<Models.UsageStorage>;
1092
- /**
1093
- * Get usage metrics and statistics for all buckets in the project. You can view the total number of buckets, files, storage usage. 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.
1094
- *
1095
- *
1096
- * @param {UsageRange} range - Date range.
1097
- * @throws {AppwriteException}
1098
- * @returns {Promise<Models.UsageStorage>}
1099
- * @deprecated Use the object parameter style method for a better developer experience.
1100
- */
1101
- getUsage(range?: UsageRange): Promise<Models.UsageStorage>;
1102
- getUsage(
1103
- paramsOrFirst?: { range?: UsageRange } | UsageRange
1104
- ): Promise<Models.UsageStorage> {
1105
- let params: { range?: UsageRange };
1106
-
1107
- if (!paramsOrFirst || (paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst) && ('range' in paramsOrFirst))) {
1108
- params = (paramsOrFirst || {}) as { range?: UsageRange };
1109
- } else {
1110
- params = {
1111
- range: paramsOrFirst as UsageRange
1112
- };
1113
- }
1114
-
1115
- const range = params.range;
1116
-
1117
-
1118
- const apiPath = '/storage/usage';
1119
- const payload: Payload = {};
1120
- if (typeof range !== 'undefined') {
1121
- payload['range'] = range;
1122
- }
1123
- const uri = new URL(this.client.config.endpoint + apiPath);
1124
-
1125
- const apiHeaders: { [header: string]: string } = {
1126
- }
1127
-
1128
- return this.client.call(
1129
- 'get',
1130
- uri,
1131
- apiHeaders,
1132
- payload
1133
- );
1134
- }
1135
-
1136
- /**
1137
- * Get usage metrics and statistics a specific bucket in the project. You can view the total number of files, storage usage. 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.
1138
- *
1139
- *
1140
- * @param {string} params.bucketId - Bucket ID.
1141
- * @param {UsageRange} params.range - Date range.
1142
- * @throws {AppwriteException}
1143
- * @returns {Promise<Models.UsageBuckets>}
1144
- */
1145
- getBucketUsage(params: { bucketId: string, range?: UsageRange }): Promise<Models.UsageBuckets>;
1146
- /**
1147
- * Get usage metrics and statistics a specific bucket in the project. You can view the total number of files, storage usage. 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.
1148
- *
1149
- *
1150
- * @param {string} bucketId - Bucket ID.
1151
- * @param {UsageRange} range - Date range.
1152
- * @throws {AppwriteException}
1153
- * @returns {Promise<Models.UsageBuckets>}
1154
- * @deprecated Use the object parameter style method for a better developer experience.
1155
- */
1156
- getBucketUsage(bucketId: string, range?: UsageRange): Promise<Models.UsageBuckets>;
1157
- getBucketUsage(
1158
- paramsOrFirst: { bucketId: string, range?: UsageRange } | string,
1159
- ...rest: [(UsageRange)?]
1160
- ): Promise<Models.UsageBuckets> {
1161
- let params: { bucketId: string, range?: UsageRange };
1162
-
1163
- if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
1164
- params = (paramsOrFirst || {}) as { bucketId: string, range?: UsageRange };
1165
- } else {
1166
- params = {
1167
- bucketId: paramsOrFirst as string,
1168
- range: rest[0] as UsageRange
1169
- };
1170
- }
1171
-
1172
- const bucketId = params.bucketId;
1173
- const range = params.range;
1174
-
1175
- if (typeof bucketId === 'undefined') {
1176
- throw new AppwriteException('Missing required parameter: "bucketId"');
1177
- }
1178
-
1179
- const apiPath = '/storage/{bucketId}/usage'.replace('{bucketId}', bucketId);
1180
- const payload: Payload = {};
1181
- if (typeof range !== 'undefined') {
1182
- payload['range'] = range;
1183
- }
1184
- const uri = new URL(this.client.config.endpoint + apiPath);
1185
-
1186
- const apiHeaders: { [header: string]: string } = {
1187
- }
1188
-
1189
- return this.client.call(
1190
- 'get',
1191
- uri,
1192
- apiHeaders,
1193
- payload
1194
- );
1195
- }
1196
- }