@appwrite.io/console 1.5.2 → 1.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (607) hide show
  1. package/CHANGELOG.md +9 -1
  2. package/README.md +3 -3
  3. package/dist/cjs/sdk.js +11874 -11100
  4. package/dist/cjs/sdk.js.map +1 -1
  5. package/dist/esm/sdk.js +11872 -11101
  6. package/dist/esm/sdk.js.map +1 -1
  7. package/dist/iife/sdk.js +11874 -11100
  8. package/docs/examples/account/create-anonymous-session.md +1 -1
  9. package/docs/examples/account/create-billing-address.md +1 -1
  10. package/docs/examples/account/create-email-password-session.md +1 -1
  11. package/docs/examples/account/create-email-token.md +1 -1
  12. package/docs/examples/account/create-j-w-t.md +1 -1
  13. package/docs/examples/account/create-magic-u-r-l-token.md +1 -1
  14. package/docs/examples/account/create-mfa-authenticator.md +1 -1
  15. package/docs/examples/account/create-mfa-challenge.md +1 -1
  16. package/docs/examples/account/create-mfa-recovery-codes.md +1 -1
  17. package/docs/examples/account/create-o-auth2session.md +1 -1
  18. package/docs/examples/account/create-o-auth2token.md +1 -1
  19. package/docs/examples/account/create-payment-method.md +1 -1
  20. package/docs/examples/account/create-phone-token.md +1 -1
  21. package/docs/examples/account/create-phone-verification.md +1 -1
  22. package/docs/examples/account/create-push-target.md +1 -1
  23. package/docs/examples/account/create-recovery.md +1 -1
  24. package/docs/examples/account/create-session.md +1 -1
  25. package/docs/examples/account/create-verification.md +1 -1
  26. package/docs/examples/account/create.md +1 -1
  27. package/docs/examples/account/delete-billing-address.md +1 -1
  28. package/docs/examples/account/delete-identity.md +1 -1
  29. package/docs/examples/account/delete-mfa-authenticator.md +1 -1
  30. package/docs/examples/account/delete-payment-method.md +1 -1
  31. package/docs/examples/account/delete-push-target.md +1 -1
  32. package/docs/examples/account/delete-session.md +1 -1
  33. package/docs/examples/account/delete-sessions.md +1 -1
  34. package/docs/examples/account/delete.md +1 -1
  35. package/docs/examples/account/get-billing-address.md +1 -1
  36. package/docs/examples/account/get-coupon.md +1 -1
  37. package/docs/examples/account/get-mfa-recovery-codes.md +1 -1
  38. package/docs/examples/account/get-payment-method.md +1 -1
  39. package/docs/examples/account/get-prefs.md +1 -1
  40. package/docs/examples/account/get-session.md +1 -1
  41. package/docs/examples/account/get.md +1 -1
  42. package/docs/examples/account/list-billing-addresses.md +1 -1
  43. package/docs/examples/account/list-identities.md +1 -1
  44. package/docs/examples/account/list-invoices.md +1 -1
  45. package/docs/examples/account/list-logs.md +1 -1
  46. package/docs/examples/account/list-mfa-factors.md +1 -1
  47. package/docs/examples/account/list-payment-methods.md +1 -1
  48. package/docs/examples/account/list-sessions.md +1 -1
  49. package/docs/examples/account/update-billing-address.md +1 -1
  50. package/docs/examples/account/update-email.md +1 -1
  51. package/docs/examples/account/update-m-f-a.md +1 -1
  52. package/docs/examples/account/update-magic-u-r-l-session.md +1 -1
  53. package/docs/examples/account/update-mfa-authenticator.md +1 -1
  54. package/docs/examples/account/update-mfa-challenge.md +1 -1
  55. package/docs/examples/account/update-mfa-recovery-codes.md +1 -1
  56. package/docs/examples/account/update-name.md +1 -1
  57. package/docs/examples/account/update-password.md +1 -1
  58. package/docs/examples/account/update-payment-method-mandate-options.md +1 -1
  59. package/docs/examples/account/update-payment-method-provider.md +1 -1
  60. package/docs/examples/account/update-payment-method.md +1 -1
  61. package/docs/examples/account/update-phone-session.md +1 -1
  62. package/docs/examples/account/update-phone-verification.md +1 -1
  63. package/docs/examples/account/update-phone.md +1 -1
  64. package/docs/examples/account/update-prefs.md +1 -1
  65. package/docs/examples/account/update-push-target.md +1 -1
  66. package/docs/examples/account/update-recovery.md +1 -1
  67. package/docs/examples/account/update-session.md +1 -1
  68. package/docs/examples/account/update-status.md +1 -1
  69. package/docs/examples/account/update-verification.md +1 -1
  70. package/docs/examples/assistant/chat.md +1 -1
  71. package/docs/examples/avatars/get-browser.md +2 -2
  72. package/docs/examples/avatars/get-credit-card.md +2 -2
  73. package/docs/examples/avatars/get-favicon.md +1 -1
  74. package/docs/examples/avatars/get-flag.md +2 -2
  75. package/docs/examples/avatars/get-image.md +1 -1
  76. package/docs/examples/avatars/get-initials.md +1 -1
  77. package/docs/examples/avatars/get-q-r.md +1 -1
  78. package/docs/examples/backups/create-archive.md +1 -1
  79. package/docs/examples/backups/create-policy.md +1 -1
  80. package/docs/examples/backups/create-restoration.md +1 -1
  81. package/docs/examples/backups/delete-archive.md +1 -1
  82. package/docs/examples/backups/delete-policy.md +1 -1
  83. package/docs/examples/backups/get-archive.md +1 -1
  84. package/docs/examples/backups/get-policy.md +1 -1
  85. package/docs/examples/backups/get-restoration.md +1 -1
  86. package/docs/examples/backups/list-archives.md +1 -1
  87. package/docs/examples/backups/list-policies.md +1 -1
  88. package/docs/examples/backups/list-restorations.md +1 -1
  89. package/docs/examples/backups/update-policy.md +1 -1
  90. package/docs/examples/console/create-program-membership.md +1 -1
  91. package/docs/examples/console/create-source.md +1 -1
  92. package/docs/examples/console/get-campaign.md +1 -1
  93. package/docs/examples/console/get-coupon.md +1 -1
  94. package/docs/examples/console/get-resource.md +14 -0
  95. package/docs/examples/console/plans.md +1 -1
  96. package/docs/examples/console/regions.md +1 -1
  97. package/docs/examples/console/variables.md +1 -1
  98. package/docs/examples/databases/create-boolean-attribute.md +1 -1
  99. package/docs/examples/databases/create-collection.md +1 -1
  100. package/docs/examples/databases/create-datetime-attribute.md +1 -1
  101. package/docs/examples/databases/create-document.md +4 -2
  102. package/docs/examples/databases/create-documents.md +15 -0
  103. package/docs/examples/databases/create-email-attribute.md +1 -1
  104. package/docs/examples/databases/create-enum-attribute.md +1 -1
  105. package/docs/examples/databases/create-float-attribute.md +1 -1
  106. package/docs/examples/databases/create-index.md +3 -2
  107. package/docs/examples/databases/create-integer-attribute.md +1 -1
  108. package/docs/examples/databases/create-ip-attribute.md +1 -1
  109. package/docs/examples/databases/create-relationship-attribute.md +1 -1
  110. package/docs/examples/databases/create-string-attribute.md +1 -1
  111. package/docs/examples/databases/create-url-attribute.md +1 -1
  112. package/docs/examples/databases/create.md +1 -1
  113. package/docs/examples/databases/delete-attribute.md +1 -1
  114. package/docs/examples/databases/delete-collection.md +1 -1
  115. package/docs/examples/databases/delete-document.md +1 -1
  116. package/docs/examples/databases/delete-documents.md +15 -0
  117. package/docs/examples/databases/delete-index.md +1 -1
  118. package/docs/examples/databases/delete.md +1 -1
  119. package/docs/examples/databases/get-attribute.md +1 -1
  120. package/docs/examples/databases/get-collection-usage.md +1 -1
  121. package/docs/examples/databases/get-collection.md +1 -1
  122. package/docs/examples/databases/get-database-usage.md +1 -1
  123. package/docs/examples/databases/get-document.md +1 -1
  124. package/docs/examples/databases/get-index.md +1 -1
  125. package/docs/examples/databases/get-usage.md +1 -1
  126. package/docs/examples/databases/get.md +1 -1
  127. package/docs/examples/databases/list-attributes.md +1 -1
  128. package/docs/examples/databases/list-collection-logs.md +1 -1
  129. package/docs/examples/databases/list-collections.md +1 -1
  130. package/docs/examples/databases/list-document-logs.md +1 -1
  131. package/docs/examples/databases/list-documents.md +1 -1
  132. package/docs/examples/databases/list-indexes.md +1 -1
  133. package/docs/examples/databases/list-logs.md +1 -1
  134. package/docs/examples/databases/list.md +1 -1
  135. package/docs/examples/databases/update-boolean-attribute.md +1 -1
  136. package/docs/examples/databases/update-collection.md +1 -1
  137. package/docs/examples/databases/update-datetime-attribute.md +1 -1
  138. package/docs/examples/databases/update-document.md +1 -1
  139. package/docs/examples/databases/update-documents.md +16 -0
  140. package/docs/examples/databases/update-email-attribute.md +1 -1
  141. package/docs/examples/databases/update-enum-attribute.md +1 -1
  142. package/docs/examples/databases/update-float-attribute.md +1 -1
  143. package/docs/examples/databases/update-integer-attribute.md +1 -1
  144. package/docs/examples/databases/update-ip-attribute.md +1 -1
  145. package/docs/examples/databases/update-relationship-attribute.md +1 -1
  146. package/docs/examples/databases/update-string-attribute.md +1 -1
  147. package/docs/examples/databases/update-url-attribute.md +1 -1
  148. package/docs/examples/databases/update.md +1 -1
  149. package/docs/examples/databases/upsert-documents.md +15 -0
  150. package/docs/examples/domains/create-preset-google-workspace.md +13 -0
  151. package/docs/examples/domains/create-preset-i-cloud.md +13 -0
  152. package/docs/examples/domains/create-preset-mailgun.md +13 -0
  153. package/docs/examples/domains/create-preset-outlook.md +13 -0
  154. package/docs/examples/domains/create-preset-proton-mail.md +13 -0
  155. package/docs/examples/domains/create-preset-zoho.md +13 -0
  156. package/docs/examples/domains/create-record-a-a-a-a.md +17 -0
  157. package/docs/examples/domains/create-record-a.md +17 -0
  158. package/docs/examples/domains/create-record-alias.md +17 -0
  159. package/docs/examples/domains/create-record-c-a-a.md +17 -0
  160. package/docs/examples/domains/create-record-c-n-a-m-e.md +17 -0
  161. package/docs/examples/domains/create-record-h-t-t-p-s.md +17 -0
  162. package/docs/examples/domains/create-record-m-x.md +18 -0
  163. package/docs/examples/domains/create-record-n-s.md +17 -0
  164. package/docs/examples/domains/create-record-s-r-v.md +20 -0
  165. package/docs/examples/domains/create-record-t-x-t.md +17 -0
  166. package/docs/examples/domains/create.md +14 -0
  167. package/docs/examples/domains/delete-record.md +14 -0
  168. package/docs/examples/domains/delete.md +13 -0
  169. package/docs/examples/domains/get-preset-google-workspace.md +13 -0
  170. package/docs/examples/domains/get-preset-i-cloud.md +13 -0
  171. package/docs/examples/domains/get-preset-mailgun.md +13 -0
  172. package/docs/examples/domains/get-preset-outlook.md +13 -0
  173. package/docs/examples/domains/get-preset-proton-mail.md +13 -0
  174. package/docs/examples/domains/get-preset-zoho.md +13 -0
  175. package/docs/examples/domains/get-record.md +14 -0
  176. package/docs/examples/domains/get-zone.md +13 -0
  177. package/docs/examples/domains/get.md +13 -0
  178. package/docs/examples/domains/list-records.md +14 -0
  179. package/docs/examples/domains/list.md +14 -0
  180. package/docs/examples/domains/update-nameservers.md +13 -0
  181. package/docs/examples/domains/update-record-a-a-a-a.md +18 -0
  182. package/docs/examples/domains/update-record-a.md +18 -0
  183. package/docs/examples/domains/update-record-alias.md +18 -0
  184. package/docs/examples/domains/update-record-c-a-a.md +18 -0
  185. package/docs/examples/domains/update-record-c-n-a-m-e.md +18 -0
  186. package/docs/examples/domains/update-record-h-t-t-p-s.md +18 -0
  187. package/docs/examples/domains/update-record-m-x.md +19 -0
  188. package/docs/examples/domains/update-record-n-s.md +18 -0
  189. package/docs/examples/domains/update-record-s-r-v.md +21 -0
  190. package/docs/examples/domains/update-record-t-x-t.md +18 -0
  191. package/docs/examples/domains/update-team.md +14 -0
  192. package/docs/examples/domains/update-zone.md +14 -0
  193. package/docs/examples/functions/create-deployment.md +1 -1
  194. package/docs/examples/functions/create-duplicate-deployment.md +15 -0
  195. package/docs/examples/functions/create-execution.md +1 -1
  196. package/docs/examples/functions/create-template-deployment.md +18 -0
  197. package/docs/examples/functions/create-variable.md +3 -2
  198. package/docs/examples/functions/create-vcs-deployment.md +16 -0
  199. package/docs/examples/functions/create.md +3 -3
  200. package/docs/examples/functions/delete-deployment.md +1 -1
  201. package/docs/examples/functions/delete-execution.md +1 -1
  202. package/docs/examples/functions/delete-variable.md +1 -1
  203. package/docs/examples/functions/delete.md +1 -1
  204. package/docs/examples/functions/get-deployment-download.md +4 -3
  205. package/docs/examples/functions/get-deployment.md +1 -1
  206. package/docs/examples/functions/get-execution.md +1 -1
  207. package/docs/examples/functions/get-template.md +1 -1
  208. package/docs/examples/functions/get-usage.md +2 -1
  209. package/docs/examples/functions/get-variable.md +1 -1
  210. package/docs/examples/functions/get.md +1 -1
  211. package/docs/examples/functions/list-deployments.md +1 -1
  212. package/docs/examples/functions/list-executions.md +2 -3
  213. package/docs/examples/functions/list-runtimes.md +1 -1
  214. package/docs/examples/functions/list-specifications.md +1 -1
  215. package/docs/examples/functions/list-templates.md +1 -1
  216. package/docs/examples/functions/list-usage.md +13 -0
  217. package/docs/examples/functions/list-variables.md +1 -1
  218. package/docs/examples/functions/list.md +1 -1
  219. package/docs/examples/functions/update-deployment-status.md +14 -0
  220. package/docs/examples/functions/update-function-deployment.md +14 -0
  221. package/docs/examples/functions/update-variable.md +3 -2
  222. package/docs/examples/functions/update.md +1 -1
  223. package/docs/examples/graphql/mutation.md +1 -1
  224. package/docs/examples/graphql/query.md +1 -1
  225. package/docs/examples/health/get-antivirus.md +1 -1
  226. package/docs/examples/health/get-cache.md +1 -1
  227. package/docs/examples/health/get-certificate.md +1 -1
  228. package/docs/examples/health/get-d-b.md +1 -1
  229. package/docs/examples/health/get-failed-jobs.md +1 -1
  230. package/docs/examples/health/get-pub-sub.md +1 -1
  231. package/docs/examples/health/get-queue-billing-aggregation.md +1 -1
  232. package/docs/examples/health/get-queue-builds.md +1 -1
  233. package/docs/examples/health/get-queue-certificates.md +1 -1
  234. package/docs/examples/health/get-queue-databases.md +1 -1
  235. package/docs/examples/health/get-queue-deletes.md +1 -1
  236. package/docs/examples/health/get-queue-functions.md +1 -1
  237. package/docs/examples/health/get-queue-logs.md +1 -1
  238. package/docs/examples/health/get-queue-mails.md +1 -1
  239. package/docs/examples/health/get-queue-messaging.md +1 -1
  240. package/docs/examples/health/get-queue-migrations.md +1 -1
  241. package/docs/examples/health/get-queue-priority-builds.md +1 -1
  242. package/docs/examples/health/get-queue-region-manager.md +13 -0
  243. package/docs/examples/health/get-queue-stats-resources.md +1 -1
  244. package/docs/examples/health/get-queue-usage.md +1 -1
  245. package/docs/examples/health/get-queue-webhooks.md +1 -1
  246. package/docs/examples/health/get-storage-local.md +1 -1
  247. package/docs/examples/health/get-storage.md +1 -1
  248. package/docs/examples/health/get-time.md +1 -1
  249. package/docs/examples/health/get.md +1 -1
  250. package/docs/examples/locale/get.md +1 -1
  251. package/docs/examples/locale/list-codes.md +1 -1
  252. package/docs/examples/locale/list-continents.md +1 -1
  253. package/docs/examples/locale/list-countries-e-u.md +1 -1
  254. package/docs/examples/locale/list-countries-phones.md +1 -1
  255. package/docs/examples/locale/list-countries.md +1 -1
  256. package/docs/examples/locale/list-currencies.md +1 -1
  257. package/docs/examples/locale/list-languages.md +1 -1
  258. package/docs/examples/messaging/create-apns-provider.md +1 -1
  259. package/docs/examples/messaging/create-email.md +1 -1
  260. package/docs/examples/messaging/create-fcm-provider.md +1 -1
  261. package/docs/examples/messaging/create-mailgun-provider.md +1 -1
  262. package/docs/examples/messaging/create-msg91provider.md +1 -1
  263. package/docs/examples/messaging/create-push.md +1 -1
  264. package/docs/examples/messaging/create-sendgrid-provider.md +1 -1
  265. package/docs/examples/messaging/create-sms.md +1 -1
  266. package/docs/examples/messaging/create-smtp-provider.md +1 -1
  267. package/docs/examples/messaging/create-subscriber.md +1 -1
  268. package/docs/examples/messaging/create-telesign-provider.md +1 -1
  269. package/docs/examples/messaging/create-textmagic-provider.md +1 -1
  270. package/docs/examples/messaging/create-topic.md +1 -1
  271. package/docs/examples/messaging/create-twilio-provider.md +1 -1
  272. package/docs/examples/messaging/create-vonage-provider.md +1 -1
  273. package/docs/examples/messaging/delete-provider.md +1 -1
  274. package/docs/examples/messaging/delete-subscriber.md +1 -1
  275. package/docs/examples/messaging/delete-topic.md +1 -1
  276. package/docs/examples/messaging/delete.md +1 -1
  277. package/docs/examples/messaging/get-message.md +1 -1
  278. package/docs/examples/messaging/get-provider.md +1 -1
  279. package/docs/examples/messaging/get-subscriber.md +1 -1
  280. package/docs/examples/messaging/get-topic.md +1 -1
  281. package/docs/examples/messaging/list-message-logs.md +1 -1
  282. package/docs/examples/messaging/list-messages.md +1 -1
  283. package/docs/examples/messaging/list-provider-logs.md +1 -1
  284. package/docs/examples/messaging/list-providers.md +1 -1
  285. package/docs/examples/messaging/list-subscriber-logs.md +1 -1
  286. package/docs/examples/messaging/list-subscribers.md +1 -1
  287. package/docs/examples/messaging/list-targets.md +1 -1
  288. package/docs/examples/messaging/list-topic-logs.md +1 -1
  289. package/docs/examples/messaging/list-topics.md +1 -1
  290. package/docs/examples/messaging/update-apns-provider.md +1 -1
  291. package/docs/examples/messaging/update-email.md +1 -1
  292. package/docs/examples/messaging/update-fcm-provider.md +1 -1
  293. package/docs/examples/messaging/update-mailgun-provider.md +1 -1
  294. package/docs/examples/messaging/update-msg91provider.md +1 -1
  295. package/docs/examples/messaging/update-push.md +1 -1
  296. package/docs/examples/messaging/update-sendgrid-provider.md +1 -1
  297. package/docs/examples/messaging/update-sms.md +1 -1
  298. package/docs/examples/messaging/update-smtp-provider.md +1 -1
  299. package/docs/examples/messaging/update-telesign-provider.md +1 -1
  300. package/docs/examples/messaging/update-textmagic-provider.md +1 -1
  301. package/docs/examples/messaging/update-topic.md +1 -1
  302. package/docs/examples/messaging/update-twilio-provider.md +1 -1
  303. package/docs/examples/messaging/update-vonage-provider.md +1 -1
  304. package/docs/examples/migrations/create-appwrite-migration.md +1 -1
  305. package/docs/examples/migrations/create-csv-migration.md +15 -0
  306. package/docs/examples/migrations/create-firebase-migration.md +1 -1
  307. package/docs/examples/migrations/create-n-host-migration.md +1 -1
  308. package/docs/examples/migrations/create-supabase-migration.md +1 -1
  309. package/docs/examples/migrations/delete.md +1 -1
  310. package/docs/examples/migrations/get-appwrite-report.md +1 -1
  311. package/docs/examples/migrations/get-firebase-report.md +1 -1
  312. package/docs/examples/migrations/get-n-host-report.md +1 -1
  313. package/docs/examples/migrations/get-supabase-report.md +1 -1
  314. package/docs/examples/migrations/get.md +1 -1
  315. package/docs/examples/migrations/list.md +1 -1
  316. package/docs/examples/migrations/retry.md +1 -1
  317. package/docs/examples/organizations/add-credit.md +1 -1
  318. package/docs/examples/organizations/create-invoice-payment.md +1 -1
  319. package/docs/examples/organizations/create.md +1 -1
  320. package/docs/examples/organizations/delete-backup-payment-method.md +1 -1
  321. package/docs/examples/organizations/delete-billing-address.md +1 -1
  322. package/docs/examples/organizations/delete-default-payment-method.md +1 -1
  323. package/docs/examples/organizations/delete.md +1 -1
  324. package/docs/examples/organizations/get-aggregation.md +1 -1
  325. package/docs/examples/organizations/get-billing-address.md +1 -1
  326. package/docs/examples/organizations/get-credit.md +1 -1
  327. package/docs/examples/organizations/get-invoice-download.md +1 -1
  328. package/docs/examples/organizations/get-invoice-view.md +1 -1
  329. package/docs/examples/organizations/get-invoice.md +1 -1
  330. package/docs/examples/organizations/get-payment-method.md +1 -1
  331. package/docs/examples/organizations/get-plan.md +1 -1
  332. package/docs/examples/organizations/get-scopes.md +1 -1
  333. package/docs/examples/organizations/list-aggregations.md +1 -1
  334. package/docs/examples/organizations/list-credits.md +1 -1
  335. package/docs/examples/organizations/list-invoices.md +1 -1
  336. package/docs/examples/organizations/list.md +1 -1
  337. package/docs/examples/organizations/set-backup-payment-method.md +1 -1
  338. package/docs/examples/organizations/set-billing-address.md +1 -1
  339. package/docs/examples/organizations/set-billing-email.md +1 -1
  340. package/docs/examples/organizations/set-billing-tax-id.md +1 -1
  341. package/docs/examples/organizations/set-default-payment-method.md +1 -1
  342. package/docs/examples/organizations/update-budget.md +1 -1
  343. package/docs/examples/organizations/update-plan.md +1 -1
  344. package/docs/examples/organizations/validate-invoice.md +14 -0
  345. package/docs/examples/project/create-variable.md +3 -2
  346. package/docs/examples/project/delete-variable.md +1 -1
  347. package/docs/examples/project/get-usage.md +1 -1
  348. package/docs/examples/project/get-variable.md +1 -1
  349. package/docs/examples/project/list-variables.md +1 -1
  350. package/docs/examples/project/update-variable.md +3 -2
  351. package/docs/examples/projects/create-dev-key.md +15 -0
  352. package/docs/examples/projects/create-j-w-t.md +1 -1
  353. package/docs/examples/projects/create-key.md +1 -1
  354. package/docs/examples/projects/create-platform.md +1 -1
  355. package/docs/examples/projects/create-smtp-test.md +1 -1
  356. package/docs/examples/projects/create-webhook.md +1 -1
  357. package/docs/examples/projects/create.md +2 -2
  358. package/docs/examples/projects/delete-dev-key.md +14 -0
  359. package/docs/examples/projects/delete-email-template.md +1 -1
  360. package/docs/examples/projects/delete-key.md +1 -1
  361. package/docs/examples/projects/delete-platform.md +1 -1
  362. package/docs/examples/projects/delete-sms-template.md +1 -1
  363. package/docs/examples/projects/delete-webhook.md +1 -1
  364. package/docs/examples/projects/delete.md +1 -1
  365. package/docs/examples/projects/get-dev-key.md +14 -0
  366. package/docs/examples/projects/get-email-template.md +1 -1
  367. package/docs/examples/projects/get-key.md +1 -1
  368. package/docs/examples/projects/get-platform.md +1 -1
  369. package/docs/examples/projects/get-sms-template.md +1 -1
  370. package/docs/examples/projects/get-webhook.md +1 -1
  371. package/docs/examples/projects/get.md +1 -1
  372. package/docs/examples/projects/list-dev-keys.md +14 -0
  373. package/docs/examples/projects/list-keys.md +1 -1
  374. package/docs/examples/projects/list-platforms.md +1 -1
  375. package/docs/examples/projects/list-webhooks.md +1 -1
  376. package/docs/examples/projects/list.md +1 -1
  377. package/docs/examples/projects/update-api-status-all.md +1 -1
  378. package/docs/examples/projects/update-api-status.md +1 -1
  379. package/docs/examples/projects/update-auth-duration.md +1 -1
  380. package/docs/examples/projects/update-auth-limit.md +1 -1
  381. package/docs/examples/projects/update-auth-password-dictionary.md +1 -1
  382. package/docs/examples/projects/update-auth-password-history.md +1 -1
  383. package/docs/examples/projects/update-auth-sessions-limit.md +1 -1
  384. package/docs/examples/projects/update-auth-status.md +1 -1
  385. package/docs/examples/projects/update-dev-key.md +16 -0
  386. package/docs/examples/projects/update-email-template.md +1 -1
  387. package/docs/examples/projects/update-key.md +1 -1
  388. package/docs/examples/projects/update-memberships-privacy.md +1 -1
  389. package/docs/examples/projects/update-mock-numbers.md +1 -1
  390. package/docs/examples/projects/update-o-auth2.md +1 -1
  391. package/docs/examples/projects/update-personal-data-check.md +1 -1
  392. package/docs/examples/projects/update-platform.md +1 -1
  393. package/docs/examples/projects/update-service-status-all.md +1 -1
  394. package/docs/examples/projects/update-service-status.md +1 -1
  395. package/docs/examples/projects/update-session-alerts.md +1 -1
  396. package/docs/examples/projects/update-sms-template.md +1 -1
  397. package/docs/examples/projects/update-smtp.md +1 -1
  398. package/docs/examples/projects/update-team.md +1 -1
  399. package/docs/examples/projects/update-webhook-signature.md +1 -1
  400. package/docs/examples/projects/update-webhook.md +1 -1
  401. package/docs/examples/projects/update.md +1 -1
  402. package/docs/examples/proxy/create-a-p-i-rule.md +13 -0
  403. package/docs/examples/proxy/create-function-rule.md +15 -0
  404. package/docs/examples/proxy/create-redirect-rule.md +15 -0
  405. package/docs/examples/proxy/create-site-rule.md +15 -0
  406. package/docs/examples/proxy/delete-rule.md +1 -1
  407. package/docs/examples/proxy/get-rule.md +1 -1
  408. package/docs/examples/proxy/list-rules.md +1 -1
  409. package/docs/examples/proxy/update-rule-verification.md +1 -1
  410. package/docs/examples/sites/create-deployment.md +18 -0
  411. package/docs/examples/sites/create-duplicate-deployment.md +14 -0
  412. package/docs/examples/sites/create-template-deployment.md +18 -0
  413. package/docs/examples/sites/create-variable.md +16 -0
  414. package/docs/examples/sites/create-vcs-deployment.md +16 -0
  415. package/docs/examples/sites/create.md +30 -0
  416. package/docs/examples/sites/delete-deployment.md +14 -0
  417. package/docs/examples/sites/delete-log.md +14 -0
  418. package/docs/examples/sites/delete-variable.md +14 -0
  419. package/docs/examples/sites/delete.md +13 -0
  420. package/docs/examples/sites/get-deployment-download.md +15 -0
  421. package/docs/examples/sites/get-deployment.md +14 -0
  422. package/docs/examples/sites/get-log.md +14 -0
  423. package/docs/examples/sites/get-template.md +13 -0
  424. package/docs/examples/sites/get-usage.md +14 -0
  425. package/docs/examples/sites/get-variable.md +14 -0
  426. package/docs/examples/sites/get.md +13 -0
  427. package/docs/examples/sites/list-deployments.md +15 -0
  428. package/docs/examples/sites/list-frameworks.md +11 -0
  429. package/docs/examples/sites/list-logs.md +14 -0
  430. package/docs/examples/sites/list-specifications.md +11 -0
  431. package/docs/examples/sites/list-templates.md +16 -0
  432. package/docs/examples/sites/list-usage.md +13 -0
  433. package/docs/examples/sites/list-variables.md +13 -0
  434. package/docs/examples/sites/list.md +14 -0
  435. package/docs/examples/sites/update-deployment-status.md +14 -0
  436. package/docs/examples/sites/update-site-deployment.md +14 -0
  437. package/docs/examples/sites/update-variable.md +17 -0
  438. package/docs/examples/sites/update.md +30 -0
  439. package/docs/examples/storage/create-bucket.md +1 -1
  440. package/docs/examples/storage/create-file.md +1 -1
  441. package/docs/examples/storage/delete-bucket.md +1 -1
  442. package/docs/examples/storage/delete-file.md +1 -1
  443. package/docs/examples/storage/get-bucket-usage.md +1 -1
  444. package/docs/examples/storage/get-bucket.md +1 -1
  445. package/docs/examples/storage/get-file-download.md +3 -2
  446. package/docs/examples/storage/get-file-preview.md +4 -3
  447. package/docs/examples/storage/get-file-view.md +3 -2
  448. package/docs/examples/storage/get-file.md +1 -1
  449. package/docs/examples/storage/get-usage.md +1 -1
  450. package/docs/examples/storage/list-buckets.md +1 -1
  451. package/docs/examples/storage/list-files.md +1 -1
  452. package/docs/examples/storage/update-bucket.md +1 -1
  453. package/docs/examples/storage/update-file.md +1 -1
  454. package/docs/examples/teams/create-membership.md +1 -1
  455. package/docs/examples/teams/create.md +1 -1
  456. package/docs/examples/teams/delete-membership.md +1 -1
  457. package/docs/examples/teams/delete.md +1 -1
  458. package/docs/examples/teams/get-membership.md +1 -1
  459. package/docs/examples/teams/get-prefs.md +1 -1
  460. package/docs/examples/teams/get.md +1 -1
  461. package/docs/examples/teams/list-logs.md +1 -1
  462. package/docs/examples/teams/list-memberships.md +1 -1
  463. package/docs/examples/teams/list.md +1 -1
  464. package/docs/examples/teams/update-membership-status.md +1 -1
  465. package/docs/examples/teams/update-membership.md +1 -1
  466. package/docs/examples/teams/update-name.md +1 -1
  467. package/docs/examples/teams/update-prefs.md +1 -1
  468. package/docs/examples/tokens/create-file-token.md +15 -0
  469. package/docs/examples/tokens/delete.md +13 -0
  470. package/docs/examples/tokens/get.md +13 -0
  471. package/docs/examples/tokens/list.md +15 -0
  472. package/docs/examples/tokens/update.md +14 -0
  473. package/docs/examples/users/create-argon2user.md +1 -1
  474. package/docs/examples/users/create-bcrypt-user.md +1 -1
  475. package/docs/examples/users/create-j-w-t.md +1 -1
  476. package/docs/examples/users/create-m-d5user.md +1 -1
  477. package/docs/examples/users/create-mfa-recovery-codes.md +1 -1
  478. package/docs/examples/users/create-p-h-pass-user.md +1 -1
  479. package/docs/examples/users/create-s-h-a-user.md +1 -1
  480. package/docs/examples/users/create-scrypt-modified-user.md +1 -1
  481. package/docs/examples/users/create-scrypt-user.md +1 -1
  482. package/docs/examples/users/create-session.md +1 -1
  483. package/docs/examples/users/create-target.md +1 -1
  484. package/docs/examples/users/create-token.md +1 -1
  485. package/docs/examples/users/create.md +1 -1
  486. package/docs/examples/users/delete-identity.md +1 -1
  487. package/docs/examples/users/delete-mfa-authenticator.md +1 -1
  488. package/docs/examples/users/delete-session.md +1 -1
  489. package/docs/examples/users/delete-sessions.md +1 -1
  490. package/docs/examples/users/delete-target.md +1 -1
  491. package/docs/examples/users/delete.md +1 -1
  492. package/docs/examples/users/get-mfa-recovery-codes.md +1 -1
  493. package/docs/examples/users/get-prefs.md +1 -1
  494. package/docs/examples/users/get-target.md +1 -1
  495. package/docs/examples/users/get-usage.md +1 -1
  496. package/docs/examples/users/get.md +1 -1
  497. package/docs/examples/users/list-identities.md +1 -1
  498. package/docs/examples/users/list-logs.md +1 -1
  499. package/docs/examples/users/list-memberships.md +4 -2
  500. package/docs/examples/users/list-mfa-factors.md +1 -1
  501. package/docs/examples/users/list-sessions.md +1 -1
  502. package/docs/examples/users/list-targets.md +1 -1
  503. package/docs/examples/users/list.md +1 -1
  504. package/docs/examples/users/update-email-verification.md +1 -1
  505. package/docs/examples/users/update-email.md +1 -1
  506. package/docs/examples/users/update-labels.md +1 -1
  507. package/docs/examples/users/update-mfa-recovery-codes.md +1 -1
  508. package/docs/examples/users/update-mfa.md +1 -1
  509. package/docs/examples/users/update-name.md +1 -1
  510. package/docs/examples/users/update-password.md +1 -1
  511. package/docs/examples/users/update-phone-verification.md +1 -1
  512. package/docs/examples/users/update-phone.md +1 -1
  513. package/docs/examples/users/update-prefs.md +1 -1
  514. package/docs/examples/users/update-status.md +1 -1
  515. package/docs/examples/users/update-target.md +1 -1
  516. package/docs/examples/vcs/create-repository-detection.md +3 -2
  517. package/docs/examples/vcs/create-repository.md +1 -1
  518. package/docs/examples/vcs/delete-installation.md +1 -1
  519. package/docs/examples/vcs/get-installation.md +1 -1
  520. package/docs/examples/vcs/get-repository-contents.md +1 -1
  521. package/docs/examples/vcs/get-repository.md +1 -1
  522. package/docs/examples/vcs/list-installations.md +1 -1
  523. package/docs/examples/vcs/list-repositories.md +3 -2
  524. package/docs/examples/vcs/list-repository-branches.md +1 -1
  525. package/docs/examples/vcs/update-external-deployments.md +1 -1
  526. package/package.json +1 -1
  527. package/src/client.ts +32 -5
  528. package/src/enums/adapter.ts +4 -0
  529. package/src/enums/api-service.ts +1 -0
  530. package/src/enums/build-runtime.ts +62 -0
  531. package/src/enums/console-resource-type.ts +3 -0
  532. package/src/enums/deployment-download-type.ts +4 -0
  533. package/src/enums/framework.ts +16 -0
  534. package/src/enums/image-format.ts +0 -1
  535. package/src/enums/name.ts +0 -1
  536. package/src/enums/o-auth-provider.ts +1 -0
  537. package/src/enums/region.ts +2 -1
  538. package/src/enums/runtime.ts +4 -3
  539. package/src/enums/site-usage-range.ts +5 -0
  540. package/src/enums/status-code.ts +6 -0
  541. package/src/enums/v-c-s-deployment-type.ts +5 -0
  542. package/src/enums/v-c-s-detection-type.ts +4 -0
  543. package/src/index.ts +13 -2
  544. package/src/models.ts +1171 -188
  545. package/src/services/account.ts +126 -446
  546. package/src/services/assistant.ts +2 -7
  547. package/src/services/avatars.ts +7 -28
  548. package/src/services/backups.ts +24 -90
  549. package/src/services/console.ts +48 -52
  550. package/src/services/databases.ts +241 -350
  551. package/src/services/domains.ts +1821 -0
  552. package/src/services/functions.ts +216 -248
  553. package/src/services/graphql.ts +4 -14
  554. package/src/services/health.ts +56 -206
  555. package/src/services/locale.ts +16 -64
  556. package/src/services/messaging.ts +92 -335
  557. package/src/services/migrations.ts +66 -89
  558. package/src/services/organizations.ts +84 -241
  559. package/src/services/project.ts +20 -45
  560. package/src/services/projects.ts +262 -330
  561. package/src/services/proxy.ts +129 -44
  562. package/src/services/sites.ts +1104 -0
  563. package/src/services/storage.ts +42 -105
  564. package/src/services/teams.ts +28 -104
  565. package/src/services/tokens.ts +160 -0
  566. package/src/services/users.ts +94 -313
  567. package/src/services/vcs.ts +70 -108
  568. package/types/enums/adapter.d.ts +4 -0
  569. package/types/enums/api-service.d.ts +1 -0
  570. package/types/enums/build-runtime.d.ts +62 -0
  571. package/types/enums/console-resource-type.d.ts +3 -0
  572. package/types/enums/deployment-download-type.d.ts +4 -0
  573. package/types/enums/framework.d.ts +16 -0
  574. package/types/enums/image-format.d.ts +0 -1
  575. package/types/enums/name.d.ts +0 -1
  576. package/types/enums/o-auth-provider.d.ts +1 -0
  577. package/types/enums/region.d.ts +3 -2
  578. package/types/enums/runtime.d.ts +5 -4
  579. package/types/enums/site-usage-range.d.ts +5 -0
  580. package/types/enums/status-code.d.ts +6 -0
  581. package/types/enums/v-c-s-deployment-type.d.ts +5 -0
  582. package/types/enums/v-c-s-detection-type.d.ts +4 -0
  583. package/types/index.d.ts +13 -2
  584. package/types/models.d.ts +1171 -188
  585. package/types/services/account.d.ts +4 -128
  586. package/types/services/assistant.d.ts +0 -2
  587. package/types/services/avatars.d.ts +0 -14
  588. package/types/services/backups.d.ts +0 -24
  589. package/types/services/console.d.ts +9 -13
  590. package/types/services/databases.d.ts +43 -97
  591. package/types/services/domains.d.ts +524 -0
  592. package/types/services/functions.d.ts +58 -84
  593. package/types/services/graphql.d.ts +0 -4
  594. package/types/services/health.d.ts +6 -56
  595. package/types/services/locale.d.ts +0 -16
  596. package/types/services/messaging.d.ts +0 -92
  597. package/types/services/migrations.d.ts +9 -23
  598. package/types/services/organizations.d.ts +11 -68
  599. package/types/services/project.d.ts +4 -14
  600. package/types/services/projects.d.ts +47 -91
  601. package/types/services/proxy.d.ts +31 -13
  602. package/types/services/sites.d.ts +319 -0
  603. package/types/services/storage.d.ts +6 -33
  604. package/types/services/teams.d.ts +0 -28
  605. package/types/services/tokens.d.ts +51 -0
  606. package/types/services/users.d.ts +3 -87
  607. package/types/services/vcs.d.ts +14 -31
@@ -0,0 +1,319 @@
1
+ import { Client, UploadProgress } from '../client';
2
+ import type { Models } from '../models';
3
+ import { Framework } from '../enums/framework';
4
+ import { BuildRuntime } from '../enums/build-runtime';
5
+ import { Adapter } from '../enums/adapter';
6
+ import { SiteUsageRange } from '../enums/site-usage-range';
7
+ import { VCSDeploymentType } from '../enums/v-c-s-deployment-type';
8
+ import { DeploymentDownloadType } from '../enums/deployment-download-type';
9
+ export declare class Sites {
10
+ client: Client;
11
+ constructor(client: Client);
12
+ /**
13
+ * Get a list of all the project's sites. You can use the query params to filter your results.
14
+ *
15
+ * @param {string[]} queries
16
+ * @param {string} search
17
+ * @throws {AppwriteException}
18
+ * @returns {Promise<Models.SiteList>}
19
+ */
20
+ list(queries?: string[], search?: string): Promise<Models.SiteList>;
21
+ /**
22
+ * Create a new site.
23
+ *
24
+ * @param {string} siteId
25
+ * @param {string} name
26
+ * @param {Framework} framework
27
+ * @param {BuildRuntime} buildRuntime
28
+ * @param {boolean} enabled
29
+ * @param {boolean} logging
30
+ * @param {number} timeout
31
+ * @param {string} installCommand
32
+ * @param {string} buildCommand
33
+ * @param {string} outputDirectory
34
+ * @param {Adapter} adapter
35
+ * @param {string} installationId
36
+ * @param {string} fallbackFile
37
+ * @param {string} providerRepositoryId
38
+ * @param {string} providerBranch
39
+ * @param {boolean} providerSilentMode
40
+ * @param {string} providerRootDirectory
41
+ * @param {string} specification
42
+ * @throws {AppwriteException}
43
+ * @returns {Promise<Models.Site>}
44
+ */
45
+ create(siteId: string, name: string, framework: Framework, buildRuntime: BuildRuntime, enabled?: boolean, logging?: boolean, timeout?: number, installCommand?: string, buildCommand?: string, outputDirectory?: string, adapter?: Adapter, installationId?: string, fallbackFile?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string): Promise<Models.Site>;
46
+ /**
47
+ * Get a list of all frameworks that are currently available on the server instance.
48
+ *
49
+ * @throws {AppwriteException}
50
+ * @returns {Promise<Models.FrameworkList>}
51
+ */
52
+ listFrameworks(): Promise<Models.FrameworkList>;
53
+ /**
54
+ * List allowed site specifications for this instance.
55
+ *
56
+ * @throws {AppwriteException}
57
+ * @returns {Promise<Models.SpecificationList>}
58
+ */
59
+ listSpecifications(): Promise<Models.SpecificationList>;
60
+ /**
61
+ * List available site templates. You can use template details in [createSite](/docs/references/cloud/server-nodejs/sites#create) method.
62
+ *
63
+ * @param {string[]} frameworks
64
+ * @param {string[]} useCases
65
+ * @param {number} limit
66
+ * @param {number} offset
67
+ * @throws {AppwriteException}
68
+ * @returns {Promise<Models.TemplateSiteList>}
69
+ */
70
+ listTemplates(frameworks?: string[], useCases?: string[], limit?: number, offset?: number): Promise<Models.TemplateSiteList>;
71
+ /**
72
+ * Get a site template using ID. You can use template details in [createSite](/docs/references/cloud/server-nodejs/sites#create) method.
73
+ *
74
+ * @param {string} templateId
75
+ * @throws {AppwriteException}
76
+ * @returns {Promise<Models.TemplateSite>}
77
+ */
78
+ getTemplate(templateId: string): Promise<Models.TemplateSite>;
79
+ /**
80
+ * Get usage metrics and statistics for all sites in the project. View statistics including total deployments, builds, logs, storage usage, and compute time. The response includes both current totals and historical data for each metric. 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, defaults to 30 days.
81
+ *
82
+ * @param {SiteUsageRange} range
83
+ * @throws {AppwriteException}
84
+ * @returns {Promise<Models.UsageSites>}
85
+ */
86
+ listUsage(range?: SiteUsageRange): Promise<Models.UsageSites>;
87
+ /**
88
+ * Get a site by its unique ID.
89
+ *
90
+ * @param {string} siteId
91
+ * @throws {AppwriteException}
92
+ * @returns {Promise<Models.Site>}
93
+ */
94
+ get(siteId: string): Promise<Models.Site>;
95
+ /**
96
+ * Update site by its unique ID.
97
+ *
98
+ * @param {string} siteId
99
+ * @param {string} name
100
+ * @param {Framework} framework
101
+ * @param {boolean} enabled
102
+ * @param {boolean} logging
103
+ * @param {number} timeout
104
+ * @param {string} installCommand
105
+ * @param {string} buildCommand
106
+ * @param {string} outputDirectory
107
+ * @param {BuildRuntime} buildRuntime
108
+ * @param {Adapter} adapter
109
+ * @param {string} fallbackFile
110
+ * @param {string} installationId
111
+ * @param {string} providerRepositoryId
112
+ * @param {string} providerBranch
113
+ * @param {boolean} providerSilentMode
114
+ * @param {string} providerRootDirectory
115
+ * @param {string} specification
116
+ * @throws {AppwriteException}
117
+ * @returns {Promise<Models.Site>}
118
+ */
119
+ update(siteId: string, name: string, framework: Framework, enabled?: boolean, logging?: boolean, timeout?: number, installCommand?: string, buildCommand?: string, outputDirectory?: string, buildRuntime?: BuildRuntime, adapter?: Adapter, fallbackFile?: string, installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string): Promise<Models.Site>;
120
+ /**
121
+ * Delete a site by its unique ID.
122
+ *
123
+ * @param {string} siteId
124
+ * @throws {AppwriteException}
125
+ * @returns {Promise<{}>}
126
+ */
127
+ delete(siteId: string): Promise<{}>;
128
+ /**
129
+ * Update the site active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your site.
130
+ *
131
+ * @param {string} siteId
132
+ * @param {string} deploymentId
133
+ * @throws {AppwriteException}
134
+ * @returns {Promise<Models.Site>}
135
+ */
136
+ updateSiteDeployment(siteId: string, deploymentId: string): Promise<Models.Site>;
137
+ /**
138
+ * Get a list of all the site&#039;s code deployments. You can use the query params to filter your results.
139
+ *
140
+ * @param {string} siteId
141
+ * @param {string[]} queries
142
+ * @param {string} search
143
+ * @throws {AppwriteException}
144
+ * @returns {Promise<Models.DeploymentList>}
145
+ */
146
+ listDeployments(siteId: string, queries?: string[], search?: string): Promise<Models.DeploymentList>;
147
+ /**
148
+ * Create a new site code deployment. Use this endpoint to upload a new version of your site code. To activate your newly uploaded code, you&#039;ll need to update the function&#039;s deployment to use your new deployment ID.
149
+ *
150
+ * @param {string} siteId
151
+ * @param {File} code
152
+ * @param {boolean} activate
153
+ * @param {string} installCommand
154
+ * @param {string} buildCommand
155
+ * @param {string} outputDirectory
156
+ * @throws {AppwriteException}
157
+ * @returns {Promise<Models.Deployment>}
158
+ */
159
+ createDeployment(siteId: string, code: File, activate: boolean, installCommand?: string, buildCommand?: string, outputDirectory?: string, onProgress?: (progress: UploadProgress) => void): Promise<Models.Deployment>;
160
+ /**
161
+ * Create a new build for an existing site deployment. This endpoint allows you to rebuild a deployment with the updated site configuration, including its commands and output directory if they have been modified. The build process will be queued and executed asynchronously. The original deployment&#039;s code will be preserved and used for the new build.
162
+ *
163
+ * @param {string} siteId
164
+ * @param {string} deploymentId
165
+ * @throws {AppwriteException}
166
+ * @returns {Promise<Models.Deployment>}
167
+ */
168
+ createDuplicateDeployment(siteId: string, deploymentId: string): Promise<Models.Deployment>;
169
+ /**
170
+ * Create a deployment based on a template.
171
+
172
+ Use this endpoint with combination of [listTemplates](https://appwrite.io/docs/server/sites#listTemplates) to find the template details.
173
+ *
174
+ * @param {string} siteId
175
+ * @param {string} repository
176
+ * @param {string} owner
177
+ * @param {string} rootDirectory
178
+ * @param {string} version
179
+ * @param {boolean} activate
180
+ * @throws {AppwriteException}
181
+ * @returns {Promise<Models.Deployment>}
182
+ */
183
+ createTemplateDeployment(siteId: string, repository: string, owner: string, rootDirectory: string, version: string, activate?: boolean): Promise<Models.Deployment>;
184
+ /**
185
+ * Create a deployment when a site is connected to VCS.
186
+
187
+ This endpoint lets you create deployment from a branch, commit, or a tag.
188
+ *
189
+ * @param {string} siteId
190
+ * @param {VCSDeploymentType} type
191
+ * @param {string} reference
192
+ * @param {boolean} activate
193
+ * @throws {AppwriteException}
194
+ * @returns {Promise<Models.Deployment>}
195
+ */
196
+ createVcsDeployment(siteId: string, type: VCSDeploymentType, reference: string, activate?: boolean): Promise<Models.Deployment>;
197
+ /**
198
+ * Get a site deployment by its unique ID.
199
+ *
200
+ * @param {string} siteId
201
+ * @param {string} deploymentId
202
+ * @throws {AppwriteException}
203
+ * @returns {Promise<Models.Deployment>}
204
+ */
205
+ getDeployment(siteId: string, deploymentId: string): Promise<Models.Deployment>;
206
+ /**
207
+ * Delete a site deployment by its unique ID.
208
+ *
209
+ * @param {string} siteId
210
+ * @param {string} deploymentId
211
+ * @throws {AppwriteException}
212
+ * @returns {Promise<{}>}
213
+ */
214
+ deleteDeployment(siteId: string, deploymentId: string): Promise<{}>;
215
+ /**
216
+ * Get a site deployment content by its unique ID. The endpoint response return with a &#039;Content-Disposition: attachment&#039; header that tells the browser to start downloading the file to user downloads directory.
217
+ *
218
+ * @param {string} siteId
219
+ * @param {string} deploymentId
220
+ * @param {DeploymentDownloadType} type
221
+ * @throws {AppwriteException}
222
+ * @returns {string}
223
+ */
224
+ getDeploymentDownload(siteId: string, deploymentId: string, type?: DeploymentDownloadType): string;
225
+ /**
226
+ * Cancel an ongoing site deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn&#039;t started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status &#039;ready&#039;) or failed. The response includes the final build status and details.
227
+ *
228
+ * @param {string} siteId
229
+ * @param {string} deploymentId
230
+ * @throws {AppwriteException}
231
+ * @returns {Promise<Models.Deployment>}
232
+ */
233
+ updateDeploymentStatus(siteId: string, deploymentId: string): Promise<Models.Deployment>;
234
+ /**
235
+ * Get a list of all site logs. You can use the query params to filter your results.
236
+ *
237
+ * @param {string} siteId
238
+ * @param {string[]} queries
239
+ * @throws {AppwriteException}
240
+ * @returns {Promise<Models.ExecutionList>}
241
+ */
242
+ listLogs(siteId: string, queries?: string[]): Promise<Models.ExecutionList>;
243
+ /**
244
+ * Get a site request log by its unique ID.
245
+ *
246
+ * @param {string} siteId
247
+ * @param {string} logId
248
+ * @throws {AppwriteException}
249
+ * @returns {Promise<Models.Execution>}
250
+ */
251
+ getLog(siteId: string, logId: string): Promise<Models.Execution>;
252
+ /**
253
+ * Delete a site log by its unique ID.
254
+ *
255
+ * @param {string} siteId
256
+ * @param {string} logId
257
+ * @throws {AppwriteException}
258
+ * @returns {Promise<{}>}
259
+ */
260
+ deleteLog(siteId: string, logId: string): Promise<{}>;
261
+ /**
262
+ * Get usage metrics and statistics for a for a specific site. View statistics including total deployments, builds, executions, storage usage, and compute time. The response includes both current totals and historical data for each metric. 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, defaults to 30 days.
263
+ *
264
+ * @param {string} siteId
265
+ * @param {SiteUsageRange} range
266
+ * @throws {AppwriteException}
267
+ * @returns {Promise<Models.UsageSite>}
268
+ */
269
+ getUsage(siteId: string, range?: SiteUsageRange): Promise<Models.UsageSite>;
270
+ /**
271
+ * Get a list of all variables of a specific site.
272
+ *
273
+ * @param {string} siteId
274
+ * @throws {AppwriteException}
275
+ * @returns {Promise<Models.VariableList>}
276
+ */
277
+ listVariables(siteId: string): Promise<Models.VariableList>;
278
+ /**
279
+ * Create a new site variable. These variables can be accessed during build and runtime (server-side rendering) as environment variables.
280
+ *
281
+ * @param {string} siteId
282
+ * @param {string} key
283
+ * @param {string} value
284
+ * @param {boolean} secret
285
+ * @throws {AppwriteException}
286
+ * @returns {Promise<Models.Variable>}
287
+ */
288
+ createVariable(siteId: string, key: string, value: string, secret?: boolean): Promise<Models.Variable>;
289
+ /**
290
+ * Get a variable by its unique ID.
291
+ *
292
+ * @param {string} siteId
293
+ * @param {string} variableId
294
+ * @throws {AppwriteException}
295
+ * @returns {Promise<Models.Variable>}
296
+ */
297
+ getVariable(siteId: string, variableId: string): Promise<Models.Variable>;
298
+ /**
299
+ * Update variable by its unique ID.
300
+ *
301
+ * @param {string} siteId
302
+ * @param {string} variableId
303
+ * @param {string} key
304
+ * @param {string} value
305
+ * @param {boolean} secret
306
+ * @throws {AppwriteException}
307
+ * @returns {Promise<Models.Variable>}
308
+ */
309
+ updateVariable(siteId: string, variableId: string, key: string, value?: string, secret?: boolean): Promise<Models.Variable>;
310
+ /**
311
+ * Delete a variable by its unique ID.
312
+ *
313
+ * @param {string} siteId
314
+ * @param {string} variableId
315
+ * @throws {AppwriteException}
316
+ * @returns {Promise<{}>}
317
+ */
318
+ deleteVariable(siteId: string, variableId: string): Promise<{}>;
319
+ }
@@ -8,8 +8,6 @@ export declare class Storage {
8
8
  client: Client;
9
9
  constructor(client: Client);
10
10
  /**
11
- * List buckets
12
- *
13
11
  * Get a list of all the storage buckets. You can use the query params to filter your results.
14
12
  *
15
13
  * @param {string[]} queries
@@ -19,8 +17,6 @@ export declare class Storage {
19
17
  */
20
18
  listBuckets(queries?: string[], search?: string): Promise<Models.BucketList>;
21
19
  /**
22
- * Create bucket
23
- *
24
20
  * Create a new storage bucket.
25
21
  *
26
22
  * @param {string} bucketId
@@ -38,8 +34,6 @@ export declare class Storage {
38
34
  */
39
35
  createBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean): Promise<Models.Bucket>;
40
36
  /**
41
- * Get bucket
42
- *
43
37
  * Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.
44
38
  *
45
39
  * @param {string} bucketId
@@ -48,8 +42,6 @@ export declare class Storage {
48
42
  */
49
43
  getBucket(bucketId: string): Promise<Models.Bucket>;
50
44
  /**
51
- * Update bucket
52
- *
53
45
  * Update a storage bucket by its unique ID.
54
46
  *
55
47
  * @param {string} bucketId
@@ -67,8 +59,6 @@ export declare class Storage {
67
59
  */
68
60
  updateBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean): Promise<Models.Bucket>;
69
61
  /**
70
- * Delete bucket
71
- *
72
62
  * Delete a storage bucket by its unique ID.
73
63
  *
74
64
  * @param {string} bucketId
@@ -77,8 +67,6 @@ export declare class Storage {
77
67
  */
78
68
  deleteBucket(bucketId: string): Promise<{}>;
79
69
  /**
80
- * List files
81
- *
82
70
  * Get a list of all the user files. You can use the query params to filter your results.
83
71
  *
84
72
  * @param {string} bucketId
@@ -89,8 +77,6 @@ export declare class Storage {
89
77
  */
90
78
  listFiles(bucketId: string, queries?: string[], search?: string): Promise<Models.FileList>;
91
79
  /**
92
- * Create file
93
- *
94
80
  * 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.
95
81
 
96
82
  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.
@@ -109,8 +95,6 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
109
95
  */
110
96
  createFile(bucketId: string, fileId: string, file: File, permissions?: string[], onProgress?: (progress: UploadProgress) => void): Promise<Models.File>;
111
97
  /**
112
- * Get file
113
- *
114
98
  * Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.
115
99
  *
116
100
  * @param {string} bucketId
@@ -120,8 +104,6 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
120
104
  */
121
105
  getFile(bucketId: string, fileId: string): Promise<Models.File>;
122
106
  /**
123
- * Update file
124
- *
125
107
  * Update a file by its unique ID. Only users with write permissions have access to update this resource.
126
108
  *
127
109
  * @param {string} bucketId
@@ -133,8 +115,6 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
133
115
  */
134
116
  updateFile(bucketId: string, fileId: string, name?: string, permissions?: string[]): Promise<Models.File>;
135
117
  /**
136
- * Delete file
137
- *
138
118
  * Delete a file by its unique ID. Only users with write permissions have access to delete this resource.
139
119
  *
140
120
  * @param {string} bucketId
@@ -144,19 +124,16 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
144
124
  */
145
125
  deleteFile(bucketId: string, fileId: string): Promise<{}>;
146
126
  /**
147
- * Get file for download
148
- *
149
127
  * Get a file content by its unique ID. The endpoint response return with a &#039;Content-Disposition: attachment&#039; header that tells the browser to start downloading the file to user downloads directory.
150
128
  *
151
129
  * @param {string} bucketId
152
130
  * @param {string} fileId
131
+ * @param {string} token
153
132
  * @throws {AppwriteException}
154
133
  * @returns {string}
155
134
  */
156
- getFileDownload(bucketId: string, fileId: string): string;
135
+ getFileDownload(bucketId: string, fileId: string, token?: string): string;
157
136
  /**
158
- * Get file preview
159
- *
160
137
  * 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.
161
138
  *
162
139
  * @param {string} bucketId
@@ -172,24 +149,22 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
172
149
  * @param {number} rotation
173
150
  * @param {string} background
174
151
  * @param {ImageFormat} output
152
+ * @param {string} token
175
153
  * @throws {AppwriteException}
176
154
  * @returns {string}
177
155
  */
178
- 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): string;
156
+ 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;
179
157
  /**
180
- * Get file for view
181
- *
182
158
  * Get a file content by its unique ID. This endpoint is similar to the download method but returns with no &#039;Content-Disposition: attachment&#039; header.
183
159
  *
184
160
  * @param {string} bucketId
185
161
  * @param {string} fileId
162
+ * @param {string} token
186
163
  * @throws {AppwriteException}
187
164
  * @returns {string}
188
165
  */
189
- getFileView(bucketId: string, fileId: string): string;
166
+ getFileView(bucketId: string, fileId: string, token?: string): string;
190
167
  /**
191
- * Get storage usage stats
192
- *
193
168
  * 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.
194
169
 
195
170
  *
@@ -199,8 +174,6 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
199
174
  */
200
175
  getUsage(range?: StorageUsageRange): Promise<Models.UsageStorage>;
201
176
  /**
202
- * Get bucket usage stats
203
- *
204
177
  * 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.
205
178
 
206
179
  *
@@ -4,8 +4,6 @@ export declare class Teams {
4
4
  client: Client;
5
5
  constructor(client: Client);
6
6
  /**
7
- * List teams
8
- *
9
7
  * Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.
10
8
  *
11
9
  * @param {string[]} queries
@@ -15,8 +13,6 @@ export declare class Teams {
15
13
  */
16
14
  list<Preferences extends Models.Preferences>(queries?: string[], search?: string): Promise<Models.TeamList<Preferences>>;
17
15
  /**
18
- * Create team
19
- *
20
16
  * Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.
21
17
  *
22
18
  * @param {string} teamId
@@ -27,8 +23,6 @@ export declare class Teams {
27
23
  */
28
24
  create<Preferences extends Models.Preferences>(teamId: string, name: string, roles?: string[]): Promise<Models.Team<Preferences>>;
29
25
  /**
30
- * Get team
31
- *
32
26
  * Get a team by its ID. All team members have read access for this resource.
33
27
  *
34
28
  * @param {string} teamId
@@ -37,8 +31,6 @@ export declare class Teams {
37
31
  */
38
32
  get<Preferences extends Models.Preferences>(teamId: string): Promise<Models.Team<Preferences>>;
39
33
  /**
40
- * Update name
41
- *
42
34
  * Update the team&#039;s name by its unique ID.
43
35
  *
44
36
  * @param {string} teamId
@@ -48,8 +40,6 @@ export declare class Teams {
48
40
  */
49
41
  updateName<Preferences extends Models.Preferences>(teamId: string, name: string): Promise<Models.Team<Preferences>>;
50
42
  /**
51
- * Delete team
52
- *
53
43
  * Delete a team using its ID. Only team members with the owner role can delete the team.
54
44
  *
55
45
  * @param {string} teamId
@@ -58,8 +48,6 @@ export declare class Teams {
58
48
  */
59
49
  delete(teamId: string): Promise<{}>;
60
50
  /**
61
- * List team logs
62
- *
63
51
  * Get the team activity logs list by its unique ID.
64
52
  *
65
53
  * @param {string} teamId
@@ -69,8 +57,6 @@ export declare class Teams {
69
57
  */
70
58
  listLogs(teamId: string, queries?: string[]): Promise<Models.LogList>;
71
59
  /**
72
- * List team memberships
73
- *
74
60
  * Use this endpoint to list a team&#039;s members using the team&#039;s ID. All team members have read access to this endpoint. Hide sensitive attributes from the response by toggling membership privacy in the Console.
75
61
  *
76
62
  * @param {string} teamId
@@ -81,8 +67,6 @@ export declare class Teams {
81
67
  */
82
68
  listMemberships(teamId: string, queries?: string[], search?: string): Promise<Models.MembershipList>;
83
69
  /**
84
- * Create team membership
85
- *
86
70
  * Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn&#039;t exist. If initiated from a Server SDK, the new member will be added automatically to the team.
87
71
 
88
72
  You only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID &gt; email &gt; phone number if you provide more than one of these parameters.
@@ -104,8 +88,6 @@ Please note that to avoid a [Redirect Attack](https://github.com/OWASP/CheatShee
104
88
  */
105
89
  createMembership(teamId: string, roles: string[], email?: string, userId?: string, phone?: string, url?: string, name?: string): Promise<Models.Membership>;
106
90
  /**
107
- * Get team membership
108
- *
109
91
  * Get a team member by the membership unique id. All team members have read access for this resource. Hide sensitive attributes from the response by toggling membership privacy in the Console.
110
92
  *
111
93
  * @param {string} teamId
@@ -115,8 +97,6 @@ Please note that to avoid a [Redirect Attack](https://github.com/OWASP/CheatShee
115
97
  */
116
98
  getMembership(teamId: string, membershipId: string): Promise<Models.Membership>;
117
99
  /**
118
- * Update membership
119
- *
120
100
  * Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](https://appwrite.io/docs/permissions).
121
101
 
122
102
  *
@@ -128,8 +108,6 @@ Please note that to avoid a [Redirect Attack](https://github.com/OWASP/CheatShee
128
108
  */
129
109
  updateMembership(teamId: string, membershipId: string, roles: string[]): Promise<Models.Membership>;
130
110
  /**
131
- * Delete team membership
132
- *
133
111
  * This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.
134
112
  *
135
113
  * @param {string} teamId
@@ -139,8 +117,6 @@ Please note that to avoid a [Redirect Attack](https://github.com/OWASP/CheatShee
139
117
  */
140
118
  deleteMembership(teamId: string, membershipId: string): Promise<{}>;
141
119
  /**
142
- * Update team membership status
143
- *
144
120
  * Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.
145
121
 
146
122
  If the request is successful, a session for the user is automatically created.
@@ -155,8 +131,6 @@ If the request is successful, a session for the user is automatically created.
155
131
  */
156
132
  updateMembershipStatus(teamId: string, membershipId: string, userId: string, secret: string): Promise<Models.Membership>;
157
133
  /**
158
- * Get team preferences
159
- *
160
134
  * Get the team&#039;s shared preferences by its unique ID. If a preference doesn&#039;t need to be shared by all team members, prefer storing them in [user preferences](https://appwrite.io/docs/references/cloud/client-web/account#getPrefs).
161
135
  *
162
136
  * @param {string} teamId
@@ -165,8 +139,6 @@ If the request is successful, a session for the user is automatically created.
165
139
  */
166
140
  getPrefs<Preferences extends Models.Preferences>(teamId: string): Promise<Preferences>;
167
141
  /**
168
- * Update preferences
169
- *
170
142
  * Update the team&#039;s preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.
171
143
  *
172
144
  * @param {string} teamId
@@ -0,0 +1,51 @@
1
+ import { Client } from '../client';
2
+ import type { Models } from '../models';
3
+ export declare class Tokens {
4
+ client: Client;
5
+ constructor(client: Client);
6
+ /**
7
+ * List all the tokens created for a specific file or bucket. You can use the query params to filter your results.
8
+ *
9
+ * @param {string} bucketId
10
+ * @param {string} fileId
11
+ * @param {string[]} queries
12
+ * @throws {AppwriteException}
13
+ * @returns {Promise<Models.ResourceTokenList>}
14
+ */
15
+ list(bucketId: string, fileId: string, queries?: string[]): Promise<Models.ResourceTokenList>;
16
+ /**
17
+ * Create a new token. A token is linked to a file. Token can be passed as a header or request get parameter.
18
+ *
19
+ * @param {string} bucketId
20
+ * @param {string} fileId
21
+ * @param {string} expire
22
+ * @throws {AppwriteException}
23
+ * @returns {Promise<Models.ResourceToken>}
24
+ */
25
+ createFileToken(bucketId: string, fileId: string, expire?: string): Promise<Models.ResourceToken>;
26
+ /**
27
+ * Get a token by its unique ID.
28
+ *
29
+ * @param {string} tokenId
30
+ * @throws {AppwriteException}
31
+ * @returns {Promise<Models.ResourceToken>}
32
+ */
33
+ get(tokenId: string): Promise<Models.ResourceToken>;
34
+ /**
35
+ * Update a token by its unique ID. Use this endpoint to update a token&#039;s expiry date.
36
+ *
37
+ * @param {string} tokenId
38
+ * @param {string} expire
39
+ * @throws {AppwriteException}
40
+ * @returns {Promise<Models.ResourceToken>}
41
+ */
42
+ update(tokenId: string, expire?: string): Promise<Models.ResourceToken>;
43
+ /**
44
+ * Delete a token by its unique ID.
45
+ *
46
+ * @param {string} tokenId
47
+ * @throws {AppwriteException}
48
+ * @returns {Promise<{}>}
49
+ */
50
+ delete(tokenId: string): Promise<{}>;
51
+ }