@appwrite.io/console 1.6.0 → 1.8.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 (596) hide show
  1. package/CHANGELOG.md +9 -1
  2. package/README.md +3 -3
  3. package/dist/cjs/sdk.js +6807 -3959
  4. package/dist/cjs/sdk.js.map +1 -1
  5. package/dist/esm/sdk.js +6805 -3960
  6. package/dist/esm/sdk.js.map +1 -1
  7. package/dist/iife/sdk.js +6807 -3959
  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-document.md +17 -0
  150. package/docs/examples/databases/upsert-documents.md +15 -0
  151. package/docs/examples/domains/create-preset-google-workspace.md +13 -0
  152. package/docs/examples/domains/create-preset-i-cloud.md +13 -0
  153. package/docs/examples/domains/create-preset-mailgun.md +13 -0
  154. package/docs/examples/domains/create-preset-outlook.md +13 -0
  155. package/docs/examples/domains/create-preset-proton-mail.md +13 -0
  156. package/docs/examples/domains/create-preset-zoho.md +13 -0
  157. package/docs/examples/domains/create-record-a-a-a-a.md +17 -0
  158. package/docs/examples/domains/create-record-a.md +17 -0
  159. package/docs/examples/domains/create-record-alias.md +17 -0
  160. package/docs/examples/domains/create-record-c-a-a.md +17 -0
  161. package/docs/examples/domains/create-record-c-n-a-m-e.md +17 -0
  162. package/docs/examples/domains/create-record-h-t-t-p-s.md +17 -0
  163. package/docs/examples/domains/create-record-m-x.md +18 -0
  164. package/docs/examples/domains/create-record-n-s.md +17 -0
  165. package/docs/examples/domains/create-record-s-r-v.md +20 -0
  166. package/docs/examples/domains/create-record-t-x-t.md +17 -0
  167. package/docs/examples/domains/create.md +14 -0
  168. package/docs/examples/domains/delete-record.md +14 -0
  169. package/docs/examples/domains/delete.md +13 -0
  170. package/docs/examples/domains/get-preset-google-workspace.md +13 -0
  171. package/docs/examples/domains/get-preset-i-cloud.md +13 -0
  172. package/docs/examples/domains/get-preset-mailgun.md +13 -0
  173. package/docs/examples/domains/get-preset-outlook.md +13 -0
  174. package/docs/examples/domains/get-preset-proton-mail.md +13 -0
  175. package/docs/examples/domains/get-preset-zoho.md +13 -0
  176. package/docs/examples/domains/get-record.md +14 -0
  177. package/docs/examples/domains/get-zone.md +13 -0
  178. package/docs/examples/domains/get.md +13 -0
  179. package/docs/examples/domains/list-records.md +14 -0
  180. package/docs/examples/domains/list.md +14 -0
  181. package/docs/examples/domains/update-nameservers.md +13 -0
  182. package/docs/examples/domains/update-record-a-a-a-a.md +18 -0
  183. package/docs/examples/domains/update-record-a.md +18 -0
  184. package/docs/examples/domains/update-record-alias.md +18 -0
  185. package/docs/examples/domains/update-record-c-a-a.md +18 -0
  186. package/docs/examples/domains/update-record-c-n-a-m-e.md +18 -0
  187. package/docs/examples/domains/update-record-h-t-t-p-s.md +18 -0
  188. package/docs/examples/domains/update-record-m-x.md +19 -0
  189. package/docs/examples/domains/update-record-n-s.md +18 -0
  190. package/docs/examples/domains/update-record-s-r-v.md +21 -0
  191. package/docs/examples/domains/update-record-t-x-t.md +18 -0
  192. package/docs/examples/domains/update-team.md +14 -0
  193. package/docs/examples/domains/update-zone.md +14 -0
  194. package/docs/examples/functions/create-deployment.md +1 -1
  195. package/docs/examples/functions/create-duplicate-deployment.md +15 -0
  196. package/docs/examples/functions/create-execution.md +1 -1
  197. package/docs/examples/functions/create-template-deployment.md +18 -0
  198. package/docs/examples/functions/create-variable.md +3 -2
  199. package/docs/examples/functions/create-vcs-deployment.md +16 -0
  200. package/docs/examples/functions/create.md +1 -5
  201. package/docs/examples/functions/delete-deployment.md +1 -1
  202. package/docs/examples/functions/delete-execution.md +1 -1
  203. package/docs/examples/functions/delete-variable.md +1 -1
  204. package/docs/examples/functions/delete.md +1 -1
  205. package/docs/examples/functions/get-deployment-download.md +4 -3
  206. package/docs/examples/functions/get-deployment.md +1 -1
  207. package/docs/examples/functions/get-execution.md +1 -1
  208. package/docs/examples/functions/get-template.md +1 -1
  209. package/docs/examples/functions/get-usage.md +2 -1
  210. package/docs/examples/functions/get-variable.md +1 -1
  211. package/docs/examples/functions/get.md +1 -1
  212. package/docs/examples/functions/list-deployments.md +1 -1
  213. package/docs/examples/functions/list-executions.md +2 -3
  214. package/docs/examples/functions/list-runtimes.md +1 -1
  215. package/docs/examples/functions/list-specifications.md +1 -1
  216. package/docs/examples/functions/list-templates.md +1 -1
  217. package/docs/examples/functions/list-usage.md +13 -0
  218. package/docs/examples/functions/list-variables.md +1 -1
  219. package/docs/examples/functions/list.md +1 -1
  220. package/docs/examples/functions/update-deployment-status.md +14 -0
  221. package/docs/examples/functions/update-function-deployment.md +14 -0
  222. package/docs/examples/functions/update-variable.md +3 -2
  223. package/docs/examples/functions/update.md +1 -1
  224. package/docs/examples/graphql/mutation.md +1 -1
  225. package/docs/examples/graphql/query.md +1 -1
  226. package/docs/examples/health/get-antivirus.md +1 -1
  227. package/docs/examples/health/get-cache.md +1 -1
  228. package/docs/examples/health/get-certificate.md +1 -1
  229. package/docs/examples/health/get-d-b.md +1 -1
  230. package/docs/examples/health/get-failed-jobs.md +1 -1
  231. package/docs/examples/health/get-pub-sub.md +1 -1
  232. package/docs/examples/health/get-queue-billing-aggregation.md +1 -1
  233. package/docs/examples/health/get-queue-builds.md +1 -1
  234. package/docs/examples/health/get-queue-certificates.md +1 -1
  235. package/docs/examples/health/get-queue-databases.md +1 -1
  236. package/docs/examples/health/get-queue-deletes.md +1 -1
  237. package/docs/examples/health/get-queue-functions.md +1 -1
  238. package/docs/examples/health/get-queue-logs.md +1 -1
  239. package/docs/examples/health/get-queue-mails.md +1 -1
  240. package/docs/examples/health/get-queue-messaging.md +1 -1
  241. package/docs/examples/health/get-queue-migrations.md +1 -1
  242. package/docs/examples/health/get-queue-priority-builds.md +1 -1
  243. package/docs/examples/health/get-queue-region-manager.md +13 -0
  244. package/docs/examples/health/get-queue-stats-resources.md +1 -1
  245. package/docs/examples/health/get-queue-usage.md +1 -1
  246. package/docs/examples/health/get-queue-webhooks.md +1 -1
  247. package/docs/examples/health/get-storage-local.md +1 -1
  248. package/docs/examples/health/get-storage.md +1 -1
  249. package/docs/examples/health/get-time.md +1 -1
  250. package/docs/examples/health/get.md +1 -1
  251. package/docs/examples/locale/get.md +1 -1
  252. package/docs/examples/locale/list-codes.md +1 -1
  253. package/docs/examples/locale/list-continents.md +1 -1
  254. package/docs/examples/locale/list-countries-e-u.md +1 -1
  255. package/docs/examples/locale/list-countries-phones.md +1 -1
  256. package/docs/examples/locale/list-countries.md +1 -1
  257. package/docs/examples/locale/list-currencies.md +1 -1
  258. package/docs/examples/locale/list-languages.md +1 -1
  259. package/docs/examples/messaging/create-apns-provider.md +1 -1
  260. package/docs/examples/messaging/create-email.md +1 -1
  261. package/docs/examples/messaging/create-fcm-provider.md +1 -1
  262. package/docs/examples/messaging/create-mailgun-provider.md +1 -1
  263. package/docs/examples/messaging/create-msg91provider.md +1 -1
  264. package/docs/examples/messaging/create-push.md +1 -1
  265. package/docs/examples/messaging/create-sendgrid-provider.md +1 -1
  266. package/docs/examples/messaging/create-sms.md +1 -1
  267. package/docs/examples/messaging/create-smtp-provider.md +1 -1
  268. package/docs/examples/messaging/create-subscriber.md +1 -1
  269. package/docs/examples/messaging/create-telesign-provider.md +1 -1
  270. package/docs/examples/messaging/create-textmagic-provider.md +1 -1
  271. package/docs/examples/messaging/create-topic.md +1 -1
  272. package/docs/examples/messaging/create-twilio-provider.md +1 -1
  273. package/docs/examples/messaging/create-vonage-provider.md +1 -1
  274. package/docs/examples/messaging/delete-provider.md +1 -1
  275. package/docs/examples/messaging/delete-subscriber.md +1 -1
  276. package/docs/examples/messaging/delete-topic.md +1 -1
  277. package/docs/examples/messaging/delete.md +1 -1
  278. package/docs/examples/messaging/get-message.md +1 -1
  279. package/docs/examples/messaging/get-provider.md +1 -1
  280. package/docs/examples/messaging/get-subscriber.md +1 -1
  281. package/docs/examples/messaging/get-topic.md +1 -1
  282. package/docs/examples/messaging/list-message-logs.md +1 -1
  283. package/docs/examples/messaging/list-messages.md +1 -1
  284. package/docs/examples/messaging/list-provider-logs.md +1 -1
  285. package/docs/examples/messaging/list-providers.md +1 -1
  286. package/docs/examples/messaging/list-subscriber-logs.md +1 -1
  287. package/docs/examples/messaging/list-subscribers.md +1 -1
  288. package/docs/examples/messaging/list-targets.md +1 -1
  289. package/docs/examples/messaging/list-topic-logs.md +1 -1
  290. package/docs/examples/messaging/list-topics.md +1 -1
  291. package/docs/examples/messaging/update-apns-provider.md +1 -1
  292. package/docs/examples/messaging/update-email.md +1 -1
  293. package/docs/examples/messaging/update-fcm-provider.md +1 -1
  294. package/docs/examples/messaging/update-mailgun-provider.md +1 -1
  295. package/docs/examples/messaging/update-msg91provider.md +1 -1
  296. package/docs/examples/messaging/update-push.md +1 -1
  297. package/docs/examples/messaging/update-sendgrid-provider.md +1 -1
  298. package/docs/examples/messaging/update-sms.md +1 -1
  299. package/docs/examples/messaging/update-smtp-provider.md +1 -1
  300. package/docs/examples/messaging/update-telesign-provider.md +1 -1
  301. package/docs/examples/messaging/update-textmagic-provider.md +1 -1
  302. package/docs/examples/messaging/update-topic.md +1 -1
  303. package/docs/examples/messaging/update-twilio-provider.md +1 -1
  304. package/docs/examples/messaging/update-vonage-provider.md +1 -1
  305. package/docs/examples/migrations/create-appwrite-migration.md +1 -1
  306. package/docs/examples/migrations/create-csv-migration.md +15 -0
  307. package/docs/examples/migrations/create-firebase-migration.md +1 -1
  308. package/docs/examples/migrations/create-n-host-migration.md +1 -1
  309. package/docs/examples/migrations/create-supabase-migration.md +1 -1
  310. package/docs/examples/migrations/delete.md +1 -1
  311. package/docs/examples/migrations/get-appwrite-report.md +1 -1
  312. package/docs/examples/migrations/get-firebase-report.md +1 -1
  313. package/docs/examples/migrations/get-n-host-report.md +1 -1
  314. package/docs/examples/migrations/get-supabase-report.md +1 -1
  315. package/docs/examples/migrations/get.md +1 -1
  316. package/docs/examples/migrations/list.md +1 -1
  317. package/docs/examples/migrations/retry.md +1 -1
  318. package/docs/examples/organizations/add-credit.md +1 -1
  319. package/docs/examples/organizations/create-invoice-payment.md +1 -1
  320. package/docs/examples/organizations/create.md +1 -1
  321. package/docs/examples/organizations/delete-backup-payment-method.md +1 -1
  322. package/docs/examples/organizations/delete-billing-address.md +1 -1
  323. package/docs/examples/organizations/delete-default-payment-method.md +1 -1
  324. package/docs/examples/organizations/delete.md +1 -1
  325. package/docs/examples/organizations/get-aggregation.md +1 -1
  326. package/docs/examples/organizations/get-billing-address.md +1 -1
  327. package/docs/examples/organizations/get-credit.md +1 -1
  328. package/docs/examples/organizations/get-invoice-download.md +1 -1
  329. package/docs/examples/organizations/get-invoice-view.md +1 -1
  330. package/docs/examples/organizations/get-invoice.md +1 -1
  331. package/docs/examples/organizations/get-payment-method.md +1 -1
  332. package/docs/examples/organizations/get-plan.md +1 -1
  333. package/docs/examples/organizations/get-scopes.md +1 -1
  334. package/docs/examples/organizations/list-aggregations.md +1 -1
  335. package/docs/examples/organizations/list-credits.md +1 -1
  336. package/docs/examples/organizations/list-invoices.md +1 -1
  337. package/docs/examples/organizations/list.md +1 -1
  338. package/docs/examples/organizations/set-backup-payment-method.md +1 -1
  339. package/docs/examples/organizations/set-billing-address.md +1 -1
  340. package/docs/examples/organizations/set-billing-email.md +1 -1
  341. package/docs/examples/organizations/set-billing-tax-id.md +1 -1
  342. package/docs/examples/organizations/set-default-payment-method.md +1 -1
  343. package/docs/examples/organizations/update-budget.md +1 -1
  344. package/docs/examples/organizations/update-plan.md +1 -1
  345. package/docs/examples/organizations/validate-invoice.md +1 -1
  346. package/docs/examples/project/create-variable.md +3 -2
  347. package/docs/examples/project/delete-variable.md +1 -1
  348. package/docs/examples/project/get-usage.md +1 -1
  349. package/docs/examples/project/get-variable.md +1 -1
  350. package/docs/examples/project/list-variables.md +1 -1
  351. package/docs/examples/project/update-variable.md +3 -2
  352. package/docs/examples/projects/create-dev-key.md +15 -0
  353. package/docs/examples/projects/create-j-w-t.md +1 -1
  354. package/docs/examples/projects/create-key.md +1 -1
  355. package/docs/examples/projects/create-platform.md +1 -1
  356. package/docs/examples/projects/create-smtp-test.md +1 -1
  357. package/docs/examples/projects/create-webhook.md +1 -1
  358. package/docs/examples/projects/create.md +2 -2
  359. package/docs/examples/projects/delete-dev-key.md +14 -0
  360. package/docs/examples/projects/delete-email-template.md +1 -1
  361. package/docs/examples/projects/delete-key.md +1 -1
  362. package/docs/examples/projects/delete-platform.md +1 -1
  363. package/docs/examples/projects/delete-sms-template.md +1 -1
  364. package/docs/examples/projects/delete-webhook.md +1 -1
  365. package/docs/examples/projects/delete.md +1 -1
  366. package/docs/examples/projects/get-dev-key.md +14 -0
  367. package/docs/examples/projects/get-email-template.md +1 -1
  368. package/docs/examples/projects/get-key.md +1 -1
  369. package/docs/examples/projects/get-platform.md +1 -1
  370. package/docs/examples/projects/get-sms-template.md +1 -1
  371. package/docs/examples/projects/get-webhook.md +1 -1
  372. package/docs/examples/projects/get.md +1 -1
  373. package/docs/examples/projects/list-dev-keys.md +14 -0
  374. package/docs/examples/projects/list-keys.md +1 -1
  375. package/docs/examples/projects/list-platforms.md +1 -1
  376. package/docs/examples/projects/list-webhooks.md +1 -1
  377. package/docs/examples/projects/list.md +1 -1
  378. package/docs/examples/projects/update-api-status-all.md +1 -1
  379. package/docs/examples/projects/update-api-status.md +1 -1
  380. package/docs/examples/projects/update-auth-duration.md +1 -1
  381. package/docs/examples/projects/update-auth-limit.md +1 -1
  382. package/docs/examples/projects/update-auth-password-dictionary.md +1 -1
  383. package/docs/examples/projects/update-auth-password-history.md +1 -1
  384. package/docs/examples/projects/update-auth-sessions-limit.md +1 -1
  385. package/docs/examples/projects/update-auth-status.md +1 -1
  386. package/docs/examples/projects/update-dev-key.md +16 -0
  387. package/docs/examples/projects/update-email-template.md +1 -1
  388. package/docs/examples/projects/update-key.md +1 -1
  389. package/docs/examples/projects/update-memberships-privacy.md +1 -1
  390. package/docs/examples/projects/update-mock-numbers.md +1 -1
  391. package/docs/examples/projects/update-o-auth2.md +1 -1
  392. package/docs/examples/projects/update-personal-data-check.md +1 -1
  393. package/docs/examples/projects/update-platform.md +1 -1
  394. package/docs/examples/projects/update-service-status-all.md +1 -1
  395. package/docs/examples/projects/update-service-status.md +1 -1
  396. package/docs/examples/projects/update-session-alerts.md +1 -1
  397. package/docs/examples/projects/update-sms-template.md +1 -1
  398. package/docs/examples/projects/update-smtp.md +1 -1
  399. package/docs/examples/projects/update-team.md +1 -1
  400. package/docs/examples/projects/update-webhook-signature.md +1 -1
  401. package/docs/examples/projects/update-webhook.md +1 -1
  402. package/docs/examples/projects/update.md +1 -1
  403. package/docs/examples/proxy/create-a-p-i-rule.md +13 -0
  404. package/docs/examples/proxy/create-function-rule.md +15 -0
  405. package/docs/examples/proxy/create-redirect-rule.md +15 -0
  406. package/docs/examples/proxy/create-site-rule.md +15 -0
  407. package/docs/examples/proxy/delete-rule.md +1 -1
  408. package/docs/examples/proxy/get-rule.md +1 -1
  409. package/docs/examples/proxy/list-rules.md +1 -1
  410. package/docs/examples/proxy/update-rule-verification.md +1 -1
  411. package/docs/examples/sites/create-deployment.md +18 -0
  412. package/docs/examples/sites/create-duplicate-deployment.md +14 -0
  413. package/docs/examples/sites/create-template-deployment.md +18 -0
  414. package/docs/examples/sites/create-variable.md +16 -0
  415. package/docs/examples/sites/create-vcs-deployment.md +16 -0
  416. package/docs/examples/sites/create.md +30 -0
  417. package/docs/examples/sites/delete-deployment.md +14 -0
  418. package/docs/examples/sites/delete-log.md +14 -0
  419. package/docs/examples/sites/delete-variable.md +14 -0
  420. package/docs/examples/sites/delete.md +13 -0
  421. package/docs/examples/sites/get-deployment-download.md +15 -0
  422. package/docs/examples/sites/get-deployment.md +14 -0
  423. package/docs/examples/sites/get-log.md +14 -0
  424. package/docs/examples/sites/get-template.md +13 -0
  425. package/docs/examples/sites/get-usage.md +14 -0
  426. package/docs/examples/sites/get-variable.md +14 -0
  427. package/docs/examples/sites/get.md +13 -0
  428. package/docs/examples/sites/list-deployments.md +15 -0
  429. package/docs/examples/sites/list-frameworks.md +11 -0
  430. package/docs/examples/sites/list-logs.md +14 -0
  431. package/docs/examples/sites/list-specifications.md +11 -0
  432. package/docs/examples/sites/list-templates.md +16 -0
  433. package/docs/examples/sites/list-usage.md +13 -0
  434. package/docs/examples/sites/list-variables.md +13 -0
  435. package/docs/examples/sites/list.md +14 -0
  436. package/docs/examples/sites/update-deployment-status.md +14 -0
  437. package/docs/examples/sites/update-site-deployment.md +14 -0
  438. package/docs/examples/sites/update-variable.md +17 -0
  439. package/docs/examples/sites/update.md +30 -0
  440. package/docs/examples/storage/create-bucket.md +1 -1
  441. package/docs/examples/storage/create-file.md +1 -1
  442. package/docs/examples/storage/delete-bucket.md +1 -1
  443. package/docs/examples/storage/delete-file.md +1 -1
  444. package/docs/examples/storage/get-bucket-usage.md +1 -1
  445. package/docs/examples/storage/get-bucket.md +1 -1
  446. package/docs/examples/storage/get-file-download.md +3 -2
  447. package/docs/examples/storage/get-file-preview.md +4 -3
  448. package/docs/examples/storage/get-file-view.md +3 -2
  449. package/docs/examples/storage/get-file.md +1 -1
  450. package/docs/examples/storage/get-usage.md +1 -1
  451. package/docs/examples/storage/list-buckets.md +1 -1
  452. package/docs/examples/storage/list-files.md +1 -1
  453. package/docs/examples/storage/update-bucket.md +1 -1
  454. package/docs/examples/storage/update-file.md +1 -1
  455. package/docs/examples/teams/create-membership.md +1 -1
  456. package/docs/examples/teams/create.md +1 -1
  457. package/docs/examples/teams/delete-membership.md +1 -1
  458. package/docs/examples/teams/delete.md +1 -1
  459. package/docs/examples/teams/get-membership.md +1 -1
  460. package/docs/examples/teams/get-prefs.md +1 -1
  461. package/docs/examples/teams/get.md +1 -1
  462. package/docs/examples/teams/list-logs.md +1 -1
  463. package/docs/examples/teams/list-memberships.md +1 -1
  464. package/docs/examples/teams/list.md +1 -1
  465. package/docs/examples/teams/update-membership-status.md +1 -1
  466. package/docs/examples/teams/update-membership.md +1 -1
  467. package/docs/examples/teams/update-name.md +1 -1
  468. package/docs/examples/teams/update-prefs.md +1 -1
  469. package/docs/examples/tokens/create-file-token.md +15 -0
  470. package/docs/examples/tokens/delete.md +13 -0
  471. package/docs/examples/tokens/get.md +13 -0
  472. package/docs/examples/tokens/list.md +15 -0
  473. package/docs/examples/tokens/update.md +14 -0
  474. package/docs/examples/users/create-argon2user.md +1 -1
  475. package/docs/examples/users/create-bcrypt-user.md +1 -1
  476. package/docs/examples/users/create-j-w-t.md +1 -1
  477. package/docs/examples/users/create-m-d5user.md +1 -1
  478. package/docs/examples/users/create-mfa-recovery-codes.md +1 -1
  479. package/docs/examples/users/create-p-h-pass-user.md +1 -1
  480. package/docs/examples/users/create-s-h-a-user.md +1 -1
  481. package/docs/examples/users/create-scrypt-modified-user.md +1 -1
  482. package/docs/examples/users/create-scrypt-user.md +1 -1
  483. package/docs/examples/users/create-session.md +1 -1
  484. package/docs/examples/users/create-target.md +1 -1
  485. package/docs/examples/users/create-token.md +1 -1
  486. package/docs/examples/users/create.md +1 -1
  487. package/docs/examples/users/delete-identity.md +1 -1
  488. package/docs/examples/users/delete-mfa-authenticator.md +1 -1
  489. package/docs/examples/users/delete-session.md +1 -1
  490. package/docs/examples/users/delete-sessions.md +1 -1
  491. package/docs/examples/users/delete-target.md +1 -1
  492. package/docs/examples/users/delete.md +1 -1
  493. package/docs/examples/users/get-mfa-recovery-codes.md +1 -1
  494. package/docs/examples/users/get-prefs.md +1 -1
  495. package/docs/examples/users/get-target.md +1 -1
  496. package/docs/examples/users/get-usage.md +1 -1
  497. package/docs/examples/users/get.md +1 -1
  498. package/docs/examples/users/list-identities.md +1 -1
  499. package/docs/examples/users/list-logs.md +1 -1
  500. package/docs/examples/users/list-memberships.md +4 -2
  501. package/docs/examples/users/list-mfa-factors.md +1 -1
  502. package/docs/examples/users/list-sessions.md +1 -1
  503. package/docs/examples/users/list-targets.md +1 -1
  504. package/docs/examples/users/list.md +1 -1
  505. package/docs/examples/users/update-email-verification.md +1 -1
  506. package/docs/examples/users/update-email.md +1 -1
  507. package/docs/examples/users/update-labels.md +1 -1
  508. package/docs/examples/users/update-mfa-recovery-codes.md +1 -1
  509. package/docs/examples/users/update-mfa.md +1 -1
  510. package/docs/examples/users/update-name.md +1 -1
  511. package/docs/examples/users/update-password.md +1 -1
  512. package/docs/examples/users/update-phone-verification.md +1 -1
  513. package/docs/examples/users/update-phone.md +1 -1
  514. package/docs/examples/users/update-prefs.md +1 -1
  515. package/docs/examples/users/update-status.md +1 -1
  516. package/docs/examples/users/update-target.md +1 -1
  517. package/docs/examples/vcs/create-repository-detection.md +3 -2
  518. package/docs/examples/vcs/create-repository.md +1 -1
  519. package/docs/examples/vcs/delete-installation.md +1 -1
  520. package/docs/examples/vcs/get-installation.md +1 -1
  521. package/docs/examples/vcs/get-repository-contents.md +1 -1
  522. package/docs/examples/vcs/get-repository.md +1 -1
  523. package/docs/examples/vcs/list-installations.md +1 -1
  524. package/docs/examples/vcs/list-repositories.md +3 -2
  525. package/docs/examples/vcs/list-repository-branches.md +1 -1
  526. package/docs/examples/vcs/update-external-deployments.md +1 -1
  527. package/package.json +1 -1
  528. package/src/client.ts +16 -3
  529. package/src/enums/adapter.ts +4 -0
  530. package/src/enums/api-service.ts +1 -0
  531. package/src/enums/build-runtime.ts +62 -0
  532. package/src/enums/console-resource-type.ts +3 -0
  533. package/src/enums/deployment-download-type.ts +4 -0
  534. package/src/enums/framework.ts +16 -0
  535. package/src/enums/image-format.ts +0 -1
  536. package/src/enums/name.ts +0 -1
  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 +1100 -217
  545. package/src/services/account.ts +0 -16
  546. package/src/services/avatars.ts +0 -7
  547. package/src/services/backups.ts +0 -6
  548. package/src/services/console.ts +36 -5
  549. package/src/services/databases.ts +194 -18
  550. package/src/services/domains.ts +1821 -0
  551. package/src/services/functions.ts +170 -81
  552. package/src/services/health.ts +9 -34
  553. package/src/services/locale.ts +0 -8
  554. package/src/services/messaging.ts +0 -13
  555. package/src/services/migrations.ts +43 -6
  556. package/src/services/organizations.ts +0 -47
  557. package/src/services/project.ts +10 -5
  558. package/src/services/projects.ts +172 -10
  559. package/src/services/proxy.ts +124 -14
  560. package/src/services/sites.ts +1104 -0
  561. package/src/services/storage.ts +15 -12
  562. package/src/services/teams.ts +0 -6
  563. package/src/services/tokens.ts +160 -0
  564. package/src/services/users.ts +9 -13
  565. package/src/services/vcs.ts +54 -42
  566. package/types/enums/adapter.d.ts +4 -0
  567. package/types/enums/api-service.d.ts +1 -0
  568. package/types/enums/build-runtime.d.ts +62 -0
  569. package/types/enums/console-resource-type.d.ts +3 -0
  570. package/types/enums/deployment-download-type.d.ts +4 -0
  571. package/types/enums/framework.d.ts +16 -0
  572. package/types/enums/image-format.d.ts +0 -1
  573. package/types/enums/name.d.ts +0 -1
  574. package/types/enums/region.d.ts +3 -2
  575. package/types/enums/runtime.d.ts +5 -4
  576. package/types/enums/site-usage-range.d.ts +5 -0
  577. package/types/enums/status-code.d.ts +6 -0
  578. package/types/enums/v-c-s-deployment-type.d.ts +5 -0
  579. package/types/enums/v-c-s-detection-type.d.ts +4 -0
  580. package/types/index.d.ts +13 -2
  581. package/types/models.d.ts +1100 -217
  582. package/types/services/console.d.ts +10 -0
  583. package/types/services/databases.d.ts +56 -2
  584. package/types/services/domains.d.ts +524 -0
  585. package/types/services/functions.d.ts +59 -33
  586. package/types/services/health.d.ts +6 -6
  587. package/types/services/migrations.d.ts +10 -0
  588. package/types/services/organizations.d.ts +0 -10
  589. package/types/services/project.d.ts +4 -2
  590. package/types/services/projects.d.ts +48 -0
  591. package/types/services/proxy.d.ts +33 -5
  592. package/types/services/sites.d.ts +319 -0
  593. package/types/services/storage.d.ts +6 -3
  594. package/types/services/tokens.d.ts +51 -0
  595. package/types/services/users.d.ts +3 -1
  596. package/types/services/vcs.d.ts +15 -12
@@ -1,5 +1,6 @@
1
1
  import { Client } from '../client';
2
2
  import type { Models } from '../models';
3
+ import { ConsoleResourceType } from '../enums/console-resource-type';
3
4
  export declare class Console {
4
5
  client: Client;
5
6
  constructor(client: Client);
@@ -41,6 +42,15 @@ export declare class Console {
41
42
  * @returns {Promise<Models.ConsoleRegionList>}
42
43
  */
43
44
  regions(): Promise<Models.ConsoleRegionList>;
45
+ /**
46
+ * Check if a resource ID is available.
47
+ *
48
+ * @param {string} value
49
+ * @param {ConsoleResourceType} type
50
+ * @throws {AppwriteException}
51
+ * @returns {Promise<{}>}
52
+ */
53
+ getResource(value: string, type: ConsoleResourceType): Promise<{}>;
44
54
  /**
45
55
  * Create a new source.
46
56
  *
@@ -448,7 +448,6 @@ export declare class Databases {
448
448
  listDocuments<Document extends Models.Document>(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.DocumentList<Document>>;
449
449
  /**
450
450
  * Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
451
-
452
451
  *
453
452
  * @param {string} databaseId
454
453
  * @param {string} collectionId
@@ -459,6 +458,48 @@ export declare class Databases {
459
458
  * @returns {Promise<Document>}
460
459
  */
461
460
  createDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, data: Omit<Document, keyof Models.Document>, permissions?: string[]): Promise<Document>;
461
+ /**
462
+ * Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
463
+ *
464
+ * @param {string} databaseId
465
+ * @param {string} collectionId
466
+ * @param {object[]} documents
467
+ * @throws {AppwriteException}
468
+ * @returns {Promise<Models.DocumentList<Document>>}
469
+ */
470
+ createDocuments<Document extends Models.Document>(databaseId: string, collectionId: string, documents: object[]): Promise<Models.DocumentList<Document>>;
471
+ /**
472
+ * Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
473
+
474
+ *
475
+ * @param {string} databaseId
476
+ * @param {string} collectionId
477
+ * @param {object[]} documents
478
+ * @throws {AppwriteException}
479
+ * @returns {Promise<Models.DocumentList<Document>>}
480
+ */
481
+ upsertDocuments<Document extends Models.Document>(databaseId: string, collectionId: string, documents?: object[]): Promise<Models.DocumentList<Document>>;
482
+ /**
483
+ * Update all documents that match your queries, if no queries are submitted then all documents are updated. You can pass only specific fields to be updated.
484
+ *
485
+ * @param {string} databaseId
486
+ * @param {string} collectionId
487
+ * @param {object} data
488
+ * @param {string[]} queries
489
+ * @throws {AppwriteException}
490
+ * @returns {Promise<Models.DocumentList<Document>>}
491
+ */
492
+ updateDocuments<Document extends Models.Document>(databaseId: string, collectionId: string, data?: object, queries?: string[]): Promise<Models.DocumentList<Document>>;
493
+ /**
494
+ * Bulk delete documents using queries, if no queries are passed then all documents are deleted.
495
+ *
496
+ * @param {string} databaseId
497
+ * @param {string} collectionId
498
+ * @param {string[]} queries
499
+ * @throws {AppwriteException}
500
+ * @returns {Promise<Models.DocumentList<Document>>}
501
+ */
502
+ deleteDocuments<Document extends Models.Document>(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.DocumentList<Document>>;
462
503
  /**
463
504
  * Get a document by its unique ID. This endpoint response returns a JSON object with the document data.
464
505
  *
@@ -470,6 +511,18 @@ export declare class Databases {
470
511
  * @returns {Promise<Document>}
471
512
  */
472
513
  getDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, queries?: string[]): Promise<Document>;
514
+ /**
515
+ * Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
516
+ *
517
+ * @param {string} databaseId
518
+ * @param {string} collectionId
519
+ * @param {string} documentId
520
+ * @param {object} data
521
+ * @param {string[]} permissions
522
+ * @throws {AppwriteException}
523
+ * @returns {Promise<Document>}
524
+ */
525
+ upsertDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, data: object, permissions?: string[]): Promise<Document>;
473
526
  /**
474
527
  * Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.
475
528
  *
@@ -523,10 +576,11 @@ Attributes can be `key`, `fulltext`, and `unique`.
523
576
  * @param {IndexType} type
524
577
  * @param {string[]} attributes
525
578
  * @param {string[]} orders
579
+ * @param {number[]} lengths
526
580
  * @throws {AppwriteException}
527
581
  * @returns {Promise<Models.Index>}
528
582
  */
529
- createIndex(databaseId: string, collectionId: string, key: string, type: IndexType, attributes: string[], orders?: string[]): Promise<Models.Index>;
583
+ createIndex(databaseId: string, collectionId: string, key: string, type: IndexType, attributes: string[], orders?: string[], lengths?: number[]): Promise<Models.Index>;
530
584
  /**
531
585
  * Get index by ID.
532
586
  *
@@ -0,0 +1,524 @@
1
+ import { Client } from '../client';
2
+ import type { Models } from '../models';
3
+ export declare class Domains {
4
+ client: Client;
5
+ constructor(client: Client);
6
+ /**
7
+ * List all domains registered for this project. This endpoint supports pagination.
8
+ *
9
+ * @param {string[]} queries
10
+ * @param {string} search
11
+ * @throws {AppwriteException}
12
+ * @returns {Promise<Models.DomainsList>}
13
+ */
14
+ list(queries?: string[], search?: string): Promise<Models.DomainsList>;
15
+ /**
16
+ * Create a new domain. Before creating a domain, you need to ensure that your DNS provider is properly configured. After creating the domain, you can use the verification endpoint to check if the domain is ready to be used.
17
+ *
18
+ * @param {string} teamId
19
+ * @param {string} domain
20
+ * @throws {AppwriteException}
21
+ * @returns {Promise<Models.Domain>}
22
+ */
23
+ create(teamId: string, domain: string): Promise<Models.Domain>;
24
+ /**
25
+ * Get a domain by its unique ID.
26
+ *
27
+ * @param {string} domainId
28
+ * @throws {AppwriteException}
29
+ * @returns {Promise<Models.Domain>}
30
+ */
31
+ get(domainId: string): Promise<Models.Domain>;
32
+ /**
33
+ * Delete a domain by its unique ID. This endpoint can be used to delete a domain from your project.
34
+ Once deleted, the domain will no longer be available for use and all associated resources will be removed.
35
+ *
36
+ * @param {string} domainId
37
+ * @throws {AppwriteException}
38
+ * @returns {Promise<{}>}
39
+ */
40
+ delete(domainId: string): Promise<{}>;
41
+ /**
42
+ * Verify which NS records are used and update the domain accordingly. This will check the domain&#039;s
43
+ nameservers and update the domain&#039;s status based on whether the nameservers match the expected
44
+ Appwrite nameservers.
45
+ *
46
+ * @param {string} domainId
47
+ * @throws {AppwriteException}
48
+ * @returns {Promise<Models.Domain>}
49
+ */
50
+ updateNameservers(domainId: string): Promise<Models.Domain>;
51
+ /**
52
+ * List Google Workspace DNS records.
53
+ *
54
+ * @param {string} domainId
55
+ * @throws {AppwriteException}
56
+ * @returns {Promise<Models.DnsRecordsList>}
57
+ */
58
+ getPresetGoogleWorkspace(domainId: string): Promise<Models.DnsRecordsList>;
59
+ /**
60
+ * Add Google Workspace DNS records to the domain. This will create the required MX records
61
+ for Google Workspace email hosting.
62
+ *
63
+ * @param {string} domainId
64
+ * @throws {AppwriteException}
65
+ * @returns {Promise<Models.DnsRecordsList>}
66
+ */
67
+ createPresetGoogleWorkspace(domainId: string): Promise<Models.DnsRecordsList>;
68
+ /**
69
+ * List iCloud DNS records.
70
+ *
71
+ * @param {string} domainId
72
+ * @throws {AppwriteException}
73
+ * @returns {Promise<Models.DnsRecordsList>}
74
+ */
75
+ getPresetICloud(domainId: string): Promise<Models.DnsRecordsList>;
76
+ /**
77
+ * Add iCloud DNS records to the domain. This will create the required MX and SPF records
78
+ for using iCloud email services with your domain.
79
+ *
80
+ * @param {string} domainId
81
+ * @throws {AppwriteException}
82
+ * @returns {Promise<Models.DnsRecordsList>}
83
+ */
84
+ createPresetICloud(domainId: string): Promise<Models.DnsRecordsList>;
85
+ /**
86
+ * List Mailgun DNS records.
87
+ *
88
+ * @param {string} domainId
89
+ * @throws {AppwriteException}
90
+ * @returns {Promise<Models.DnsRecordsList>}
91
+ */
92
+ getPresetMailgun(domainId: string): Promise<Models.DnsRecordsList>;
93
+ /**
94
+ * Add Mailgun DNS records to the domain. This endpoint will create the required DNS records
95
+ for Mailgun in the specified domain.
96
+ *
97
+ * @param {string} domainId
98
+ * @throws {AppwriteException}
99
+ * @returns {Promise<Models.DnsRecordsList>}
100
+ */
101
+ createPresetMailgun(domainId: string): Promise<Models.DnsRecordsList>;
102
+ /**
103
+ * List Outlook DNS records.
104
+ *
105
+ * @param {string} domainId
106
+ * @throws {AppwriteException}
107
+ * @returns {Promise<Models.DnsRecordsList>}
108
+ */
109
+ getPresetOutlook(domainId: string): Promise<Models.DnsRecordsList>;
110
+ /**
111
+ * Add Outlook DNS records to the domain. This will create the required MX records
112
+ for setting up Outlook email hosting for your domain.
113
+ *
114
+ * @param {string} domainId
115
+ * @throws {AppwriteException}
116
+ * @returns {Promise<Models.DnsRecordsList>}
117
+ */
118
+ createPresetOutlook(domainId: string): Promise<Models.DnsRecordsList>;
119
+ /**
120
+ * List ProtonMail DNS records.
121
+ *
122
+ * @param {string} domainId
123
+ * @throws {AppwriteException}
124
+ * @returns {Promise<Models.DnsRecordsList>}
125
+ */
126
+ getPresetProtonMail(domainId: string): Promise<Models.DnsRecordsList>;
127
+ /**
128
+ * Add ProtonMail DNS records to the domain. This will create the required MX records
129
+ for using ProtonMail with your custom domain.
130
+ *
131
+ * @param {string} domainId
132
+ * @throws {AppwriteException}
133
+ * @returns {Promise<Models.DnsRecordsList>}
134
+ */
135
+ createPresetProtonMail(domainId: string): Promise<Models.DnsRecordsList>;
136
+ /**
137
+ * List Zoho DNS records.
138
+ *
139
+ * @param {string} domainId
140
+ * @throws {AppwriteException}
141
+ * @returns {Promise<Models.DnsRecordsList>}
142
+ */
143
+ getPresetZoho(domainId: string): Promise<Models.DnsRecordsList>;
144
+ /**
145
+ * Add Zoho Mail DNS records to the domain. This will create the required MX records
146
+ for setting up Zoho Mail on your domain.
147
+ *
148
+ * @param {string} domainId
149
+ * @throws {AppwriteException}
150
+ * @returns {Promise<Models.DnsRecordsList>}
151
+ */
152
+ createPresetZoho(domainId: string): Promise<Models.DnsRecordsList>;
153
+ /**
154
+ * List DNS records for a given domain. You can use this endpoint to list all the DNS records
155
+ associated with your domain.
156
+ *
157
+ * @param {string} domainId
158
+ * @param {string[]} queries
159
+ * @throws {AppwriteException}
160
+ * @returns {Promise<Models.DnsRecordsList>}
161
+ */
162
+ listRecords(domainId: string, queries?: string[]): Promise<Models.DnsRecordsList>;
163
+ /**
164
+ * Create a new A record for the given domain. A records are used to point a domain name
165
+ to an IPv4 address. The record value should be a valid IPv4 address.
166
+ *
167
+ * @param {string} domainId
168
+ * @param {string} name
169
+ * @param {string} value
170
+ * @param {number} ttl
171
+ * @param {string} comment
172
+ * @throws {AppwriteException}
173
+ * @returns {Promise<Models.DnsRecord>}
174
+ */
175
+ createRecordA(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
176
+ /**
177
+ * Update an existing A record for the given domain. This endpoint allows you to modify
178
+ the properties of an A record including its name (subdomain), IPv4 address, TTL,
179
+ and optional comment.
180
+ *
181
+ * @param {string} domainId
182
+ * @param {string} recordId
183
+ * @param {string} name
184
+ * @param {string} value
185
+ * @param {number} ttl
186
+ * @param {string} comment
187
+ * @throws {AppwriteException}
188
+ * @returns {Promise<Models.DnsRecord>}
189
+ */
190
+ updateRecordA(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
191
+ /**
192
+ * Create a new AAAA record for the given domain. This endpoint allows you to add a new IPv6 DNS record
193
+ to your domain. The record will be used to point a hostname to an IPv6 address.
194
+ *
195
+ * @param {string} domainId
196
+ * @param {string} name
197
+ * @param {string} value
198
+ * @param {number} ttl
199
+ * @param {string} comment
200
+ * @throws {AppwriteException}
201
+ * @returns {Promise<Models.DnsRecord>}
202
+ */
203
+ createRecordAAAA(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
204
+ /**
205
+ * Update an existing AAAA record for the given domain. This endpoint allows you to modify
206
+ the properties of an existing AAAA record, including its name (subdomain), IPv6 address,
207
+ TTL, and optional comment.
208
+ *
209
+ * @param {string} domainId
210
+ * @param {string} recordId
211
+ * @param {string} name
212
+ * @param {string} value
213
+ * @param {number} ttl
214
+ * @param {string} comment
215
+ * @throws {AppwriteException}
216
+ * @returns {Promise<Models.DnsRecord>}
217
+ */
218
+ updateRecordAAAA(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
219
+ /**
220
+ * Create a new ALIAS record for the given domain. This record type can be used to point your domain
221
+ to another domain name that will serve as an alias. This is particularly useful when you want to
222
+ map your domain to a target domain that may change its IP address.
223
+ *
224
+ * @param {string} domainId
225
+ * @param {string} name
226
+ * @param {string} value
227
+ * @param {number} ttl
228
+ * @param {string} comment
229
+ * @throws {AppwriteException}
230
+ * @returns {Promise<Models.DnsRecord>}
231
+ */
232
+ createRecordAlias(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
233
+ /**
234
+ * Update an existing ALIAS record for the specified domain. This endpoint allows you to modify
235
+ the properties of an existing ALIAS record including its name, target domain, TTL, and comment.
236
+
237
+ The ALIAS record type is similar to a CNAME record but can be used at the zone apex (root domain).
238
+ It provides a way to map one domain name to another.
239
+ *
240
+ * @param {string} domainId
241
+ * @param {string} recordId
242
+ * @param {string} name
243
+ * @param {string} value
244
+ * @param {number} ttl
245
+ * @param {string} comment
246
+ * @throws {AppwriteException}
247
+ * @returns {Promise<Models.DnsRecord>}
248
+ */
249
+ updateRecordAlias(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
250
+ /**
251
+ * Create a new CAA record for the given domain. CAA records are used to specify which
252
+ Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your domain.
253
+ *
254
+ * @param {string} domainId
255
+ * @param {string} name
256
+ * @param {string} value
257
+ * @param {number} ttl
258
+ * @param {string} comment
259
+ * @throws {AppwriteException}
260
+ * @returns {Promise<Models.DnsRecord>}
261
+ */
262
+ createRecordCAA(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
263
+ /**
264
+ * Update an existing CAA record for the given domain. A CAA (Certification Authority Authorization)
265
+ record is used to specify which certificate authorities (CAs) are authorized to issue certificates
266
+ for a domain.
267
+ *
268
+ * @param {string} domainId
269
+ * @param {string} recordId
270
+ * @param {string} name
271
+ * @param {string} value
272
+ * @param {number} ttl
273
+ * @param {string} comment
274
+ * @throws {AppwriteException}
275
+ * @returns {Promise<Models.DnsRecord>}
276
+ */
277
+ updateRecordCAA(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
278
+ /**
279
+ * Create a new CNAME record for the given domain.
280
+
281
+ A CNAME record maps a subdomain to another domain name, allowing you to create aliases
282
+ for your domain. For example, you can create a CNAME record to point &#039;blog.example.com&#039;
283
+ to &#039;example.wordpress.com&#039;.
284
+ *
285
+ * @param {string} domainId
286
+ * @param {string} name
287
+ * @param {string} value
288
+ * @param {number} ttl
289
+ * @param {string} comment
290
+ * @throws {AppwriteException}
291
+ * @returns {Promise<Models.DnsRecord>}
292
+ */
293
+ createRecordCNAME(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
294
+ /**
295
+ * Update an existing CNAME record for the given domain.
296
+ *
297
+ * @param {string} domainId
298
+ * @param {string} recordId
299
+ * @param {string} name
300
+ * @param {string} value
301
+ * @param {number} ttl
302
+ * @param {string} comment
303
+ * @throws {AppwriteException}
304
+ * @returns {Promise<Models.DnsRecord>}
305
+ */
306
+ updateRecordCNAME(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
307
+ /**
308
+ * Create a new HTTPS record for the given domain. This record is used to configure HTTPS
309
+ settings for your domain, enabling secure communication over SSL/TLS.
310
+ *
311
+ * @param {string} domainId
312
+ * @param {string} name
313
+ * @param {string} value
314
+ * @param {number} ttl
315
+ * @param {string} comment
316
+ * @throws {AppwriteException}
317
+ * @returns {Promise<Models.DnsRecord>}
318
+ */
319
+ createRecordHTTPS(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
320
+ /**
321
+ * Update an existing HTTPS record for the given domain. This endpoint allows you to modify
322
+ the properties of an HTTPS record associated with your domain, including the name (subdomain),
323
+ target value, TTL, and optional comment.
324
+ *
325
+ * @param {string} domainId
326
+ * @param {string} recordId
327
+ * @param {string} name
328
+ * @param {string} value
329
+ * @param {number} ttl
330
+ * @param {string} comment
331
+ * @throws {AppwriteException}
332
+ * @returns {Promise<Models.DnsRecord>}
333
+ */
334
+ updateRecordHTTPS(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
335
+ /**
336
+ * Create a new MX record for the given domain. MX records are used to define the mail servers responsible
337
+ for accepting email messages for the domain. Multiple MX records can be created with different priorities.
338
+ The priority parameter determines the order in which mail servers are used, with lower values indicating
339
+ higher priority.
340
+ *
341
+ * @param {string} domainId
342
+ * @param {string} name
343
+ * @param {string} value
344
+ * @param {number} ttl
345
+ * @param {number} priority
346
+ * @param {string} comment
347
+ * @throws {AppwriteException}
348
+ * @returns {Promise<Models.DnsRecord>}
349
+ */
350
+ createRecordMX(domainId: string, name: string, value: string, ttl: number, priority: number, comment?: string): Promise<Models.DnsRecord>;
351
+ /**
352
+ * Update an existing MX record for the given domain.
353
+ *
354
+ * @param {string} domainId
355
+ * @param {string} recordId
356
+ * @param {string} name
357
+ * @param {string} value
358
+ * @param {number} ttl
359
+ * @param {number} priority
360
+ * @param {string} comment
361
+ * @throws {AppwriteException}
362
+ * @returns {Promise<Models.DnsRecord>}
363
+ */
364
+ updateRecordMX(domainId: string, recordId: string, name: string, value: string, ttl: number, priority: number, comment?: string): Promise<Models.DnsRecord>;
365
+ /**
366
+ * Create a new NS record for the given domain. NS records specify the nameservers that are used
367
+ to resolve the domain name to IP addresses. Each domain can have multiple NS records.
368
+ *
369
+ * @param {string} domainId
370
+ * @param {string} name
371
+ * @param {string} value
372
+ * @param {number} ttl
373
+ * @param {string} comment
374
+ * @throws {AppwriteException}
375
+ * @returns {Promise<Models.DnsRecord>}
376
+ */
377
+ createRecordNS(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
378
+ /**
379
+ * Update an existing NS record for the given domain. This endpoint allows you to modify
380
+ the properties of an NS (nameserver) record associated with your domain. You can update
381
+ the record name (subdomain), target nameserver value, TTL, and add or modify comments
382
+ for better record management.
383
+ *
384
+ * @param {string} domainId
385
+ * @param {string} recordId
386
+ * @param {string} name
387
+ * @param {string} value
388
+ * @param {number} ttl
389
+ * @param {string} comment
390
+ * @throws {AppwriteException}
391
+ * @returns {Promise<Models.DnsRecord>}
392
+ */
393
+ updateRecordNS(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
394
+ /**
395
+ * Create a new SRV record for the given domain. SRV records are used to define the location
396
+ of servers for specific services. For example, they can be used to specify which server
397
+ handles a specific service like SIP or XMPP for the domain.
398
+ *
399
+ * @param {string} domainId
400
+ * @param {string} name
401
+ * @param {string} value
402
+ * @param {number} ttl
403
+ * @param {number} priority
404
+ * @param {number} weight
405
+ * @param {number} port
406
+ * @param {string} comment
407
+ * @throws {AppwriteException}
408
+ * @returns {Promise<Models.DnsRecord>}
409
+ */
410
+ createRecordSRV(domainId: string, name: string, value: string, ttl: number, priority: number, weight: number, port: number, comment?: string): Promise<Models.DnsRecord>;
411
+ /**
412
+ * Update an existing SRV record for the given domain.
413
+
414
+ Required parameters:
415
+ - domainId: Domain unique ID
416
+ - recordId: DNS record unique ID
417
+ - name: Record name (service name)
418
+ - value: Target hostname for this SRV record
419
+ - ttl: Time to live, in seconds
420
+ - priority: Record priority
421
+ - weight: Record weight
422
+ - port: Port number for the service
423
+
424
+ Optional parameters:
425
+ - comment: A comment for this record
426
+ *
427
+ * @param {string} domainId
428
+ * @param {string} recordId
429
+ * @param {string} name
430
+ * @param {string} value
431
+ * @param {number} ttl
432
+ * @param {number} priority
433
+ * @param {number} weight
434
+ * @param {number} port
435
+ * @param {string} comment
436
+ * @throws {AppwriteException}
437
+ * @returns {Promise<Models.DnsRecord>}
438
+ */
439
+ updateRecordSRV(domainId: string, recordId: string, name: string, value: string, ttl: number, priority: number, weight: number, port: number, comment?: string): Promise<Models.DnsRecord>;
440
+ /**
441
+ * Create a new TXT record for the given domain. TXT records can be used
442
+ to provide additional information about your domain, such as domain
443
+ verification records, SPF records, or DKIM records.
444
+ *
445
+ * @param {string} domainId
446
+ * @param {string} name
447
+ * @param {number} ttl
448
+ * @param {string} value
449
+ * @param {string} comment
450
+ * @throws {AppwriteException}
451
+ * @returns {Promise<Models.DnsRecord>}
452
+ */
453
+ createRecordTXT(domainId: string, name: string, ttl: number, value?: string, comment?: string): Promise<Models.DnsRecord>;
454
+ /**
455
+ * Update an existing TXT record for the given domain.
456
+
457
+ Update the TXT record details for a specific domain by providing the domain ID,
458
+ record ID, and the new record configuration including name, value, TTL, and an optional comment.
459
+ *
460
+ * @param {string} domainId
461
+ * @param {string} recordId
462
+ * @param {string} name
463
+ * @param {string} value
464
+ * @param {number} ttl
465
+ * @param {string} comment
466
+ * @throws {AppwriteException}
467
+ * @returns {Promise<Models.DnsRecord>}
468
+ */
469
+ updateRecordTXT(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
470
+ /**
471
+ * Get a single DNS record for a given domain by record ID.
472
+
473
+ This endpoint allows you to retrieve a specific DNS record associated with a domain
474
+ using its unique identifier. The record contains information about the DNS configuration
475
+ such as type, value, and TTL settings.
476
+ *
477
+ * @param {string} domainId
478
+ * @param {string} recordId
479
+ * @throws {AppwriteException}
480
+ * @returns {Promise<Models.DnsRecord>}
481
+ */
482
+ getRecord(domainId: string, recordId: string): Promise<Models.DnsRecord>;
483
+ /**
484
+ * Delete a DNS record for the given domain. This endpoint allows you to delete an existing DNS record
485
+ from a specific domain.
486
+ *
487
+ * @param {string} domainId
488
+ * @param {string} recordId
489
+ * @throws {AppwriteException}
490
+ * @returns {Promise<{}>}
491
+ */
492
+ deleteRecord(domainId: string, recordId: string): Promise<{}>;
493
+ /**
494
+ * Update the team ID for a specific domain. This endpoint requires admin access.
495
+
496
+ Updating the team ID will transfer ownership and access control of the domain
497
+ and all its DNS records to the new team.
498
+ *
499
+ * @param {string} domainId
500
+ * @param {string} teamId
501
+ * @throws {AppwriteException}
502
+ * @returns {Promise<Models.Domain>}
503
+ */
504
+ updateTeam(domainId: string, teamId: string): Promise<Models.Domain>;
505
+ /**
506
+ * Retrieve the DNS zone file for the given domain. This endpoint will return the DNS
507
+ zone file in a standardized format that can be used to configure DNS servers.
508
+ *
509
+ * @param {string} domainId
510
+ * @throws {AppwriteException}
511
+ * @returns {Promise<{}>}
512
+ */
513
+ getZone(domainId: string): Promise<{}>;
514
+ /**
515
+ * Update the DNS zone for the given domain using the provided zone file content.
516
+ All parsed records are imported and then the main domain document is returned.
517
+ *
518
+ * @param {string} domainId
519
+ * @param {string} content
520
+ * @throws {AppwriteException}
521
+ * @returns {Promise<Models.Domain>}
522
+ */
523
+ updateZone(domainId: string, content: string): Promise<Models.Domain>;
524
+ }