@appwrite.io/console 8.1.0 → 8.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (898) hide show
  1. package/README.md +1 -1
  2. package/dist/cjs/sdk.js +1 -1
  3. package/dist/cjs/sdk.js.map +1 -0
  4. package/dist/esm/sdk.js +29705 -0
  5. package/dist/esm/sdk.js.map +1 -0
  6. package/dist/iife/sdk.js +33515 -0
  7. package/package.json +5 -1
  8. package/types/channel.d.ts +74 -0
  9. package/types/client.d.ts +302 -0
  10. package/types/enums/adapter.d.ts +4 -0
  11. package/types/enums/api-service.d.ts +15 -0
  12. package/types/enums/api.d.ts +5 -0
  13. package/types/enums/appwrite-migration-resource.d.ts +27 -0
  14. package/types/enums/attribute-status.d.ts +7 -0
  15. package/types/enums/auth-method.d.ts +9 -0
  16. package/types/enums/authentication-factor.d.ts +6 -0
  17. package/types/enums/authenticator-type.d.ts +3 -0
  18. package/types/enums/backup-services.d.ts +8 -0
  19. package/types/enums/billing-plan-group.d.ts +5 -0
  20. package/types/enums/browser-permission.d.ts +22 -0
  21. package/types/enums/browser.d.ts +16 -0
  22. package/types/enums/build-runtime.d.ts +88 -0
  23. package/types/enums/column-status.d.ts +7 -0
  24. package/types/enums/compression.d.ts +5 -0
  25. package/types/enums/console-resource-type.d.ts +3 -0
  26. package/types/enums/credit-card.d.ts +19 -0
  27. package/types/enums/database-type.d.ts +6 -0
  28. package/types/enums/databases-index-type.d.ts +6 -0
  29. package/types/enums/deployment-download-type.d.ts +4 -0
  30. package/types/enums/deployment-status.d.ts +8 -0
  31. package/types/enums/domain-purchase-status.d.ts +6 -0
  32. package/types/enums/domain-transfer-status-enum.d.ts +10 -0
  33. package/types/enums/email-template-locale.d.ts +133 -0
  34. package/types/enums/email-template-type.d.ts +9 -0
  35. package/types/enums/execution-method.d.ts +9 -0
  36. package/types/enums/execution-status.d.ts +7 -0
  37. package/types/enums/execution-trigger.d.ts +5 -0
  38. package/types/enums/filter-type.d.ts +4 -0
  39. package/types/enums/firebase-migration-resource.d.ts +12 -0
  40. package/types/enums/flag.d.ts +197 -0
  41. package/types/enums/framework.d.ts +17 -0
  42. package/types/enums/frameworks.d.ts +17 -0
  43. package/types/enums/health-antivirus-status.d.ts +5 -0
  44. package/types/enums/health-check-status.d.ts +4 -0
  45. package/types/enums/image-format.d.ts +9 -0
  46. package/types/enums/image-gravity.d.ts +11 -0
  47. package/types/enums/index-status.d.ts +7 -0
  48. package/types/enums/message-priority.d.ts +4 -0
  49. package/types/enums/message-status.d.ts +7 -0
  50. package/types/enums/messaging-provider-type.d.ts +5 -0
  51. package/types/enums/n-host-migration-resource.d.ts +13 -0
  52. package/types/enums/name.d.ts +15 -0
  53. package/types/enums/o-auth-provider.d.ts +41 -0
  54. package/types/enums/order-by.d.ts +4 -0
  55. package/types/enums/password-hash.d.ts +13 -0
  56. package/types/enums/platform-type.d.ts +17 -0
  57. package/types/enums/platform.d.ts +4 -0
  58. package/types/enums/project-usage-range.d.ts +4 -0
  59. package/types/enums/proxy-resource-type.d.ts +4 -0
  60. package/types/enums/proxy-rule-deployment-resource-type.d.ts +4 -0
  61. package/types/enums/proxy-rule-status.d.ts +6 -0
  62. package/types/enums/region.d.ts +8 -0
  63. package/types/enums/registration-type.d.ts +6 -0
  64. package/types/enums/relation-mutate.d.ts +5 -0
  65. package/types/enums/relationship-type.d.ts +6 -0
  66. package/types/enums/resource-type.d.ts +6 -0
  67. package/types/enums/runtime.d.ts +88 -0
  68. package/types/enums/runtimes.d.ts +88 -0
  69. package/types/enums/scopes.d.ts +81 -0
  70. package/types/enums/sms-template-locale.d.ts +133 -0
  71. package/types/enums/sms-template-type.d.ts +6 -0
  72. package/types/enums/smtp-encryption.d.ts +5 -0
  73. package/types/enums/smtp-secure.d.ts +4 -0
  74. package/types/enums/status-code.d.ts +6 -0
  75. package/types/enums/status.d.ts +3 -0
  76. package/types/enums/supabase-migration-resource.d.ts +13 -0
  77. package/types/enums/tables-db-index-type.d.ts +6 -0
  78. package/types/enums/template-reference-type.d.ts +5 -0
  79. package/types/enums/theme.d.ts +4 -0
  80. package/types/enums/timezone.d.ts +421 -0
  81. package/types/enums/usage-range.d.ts +5 -0
  82. package/types/enums/use-cases.d.ts +16 -0
  83. package/types/enums/vcs-detection-type.d.ts +4 -0
  84. package/types/enums/vcs-reference-type.d.ts +5 -0
  85. package/types/id.d.ts +20 -0
  86. package/{src/index.ts → types/index.d.ts} +1 -1
  87. package/{src/models.ts → types/models.d.ts} +268 -518
  88. package/types/operator.d.ts +180 -0
  89. package/{src/permission.ts → types/permission.d.ts} +6 -20
  90. package/types/query.d.ts +442 -0
  91. package/{src/role.ts → types/role.d.ts} +28 -58
  92. package/types/service.d.ts +11 -0
  93. package/types/services/account.d.ts +1536 -0
  94. package/types/services/activities.d.ts +46 -0
  95. package/types/services/assistant.d.ts +24 -0
  96. package/{src/services/avatars.ts → types/services/avatars.d.ts} +91 -525
  97. package/types/services/backups.d.ts +277 -0
  98. package/types/services/console.d.ts +248 -0
  99. package/types/services/databases.d.ts +2435 -0
  100. package/types/services/domains.d.ts +1527 -0
  101. package/types/services/functions.d.ts +842 -0
  102. package/types/services/graphql.d.ts +43 -0
  103. package/types/services/health.d.ts +475 -0
  104. package/types/services/locale.d.ts +64 -0
  105. package/types/services/messaging.d.ts +1989 -0
  106. package/types/services/migrations.d.ts +417 -0
  107. package/types/services/organizations.d.ts +1009 -0
  108. package/types/services/project.d.ts +148 -0
  109. package/types/services/projects.d.ts +1626 -0
  110. package/types/services/proxy.d.ts +190 -0
  111. package/types/services/realtime.d.ts +134 -0
  112. package/types/services/sites.d.ts +800 -0
  113. package/types/services/storage.d.ts +467 -0
  114. package/types/services/tables-db.d.ts +2352 -0
  115. package/types/services/teams.d.ts +366 -0
  116. package/types/services/tokens.d.ts +119 -0
  117. package/types/services/users.d.ts +1208 -0
  118. package/types/services/vcs.d.ts +252 -0
  119. package/types/services/webhooks.d.ts +165 -0
  120. package/.github/workflows/autoclose.yml +0 -11
  121. package/.github/workflows/publish.yml +0 -43
  122. package/CHANGELOG.md +0 -169
  123. package/docs/examples/account/create-anonymous-session.md +0 -13
  124. package/docs/examples/account/create-billing-address.md +0 -20
  125. package/docs/examples/account/create-email-password-session.md +0 -16
  126. package/docs/examples/account/create-email-token.md +0 -17
  127. package/docs/examples/account/create-email-verification.md +0 -15
  128. package/docs/examples/account/create-jwt.md +0 -15
  129. package/docs/examples/account/create-key.md +0 -17
  130. package/docs/examples/account/create-magic-url-token.md +0 -18
  131. package/docs/examples/account/create-mfa-authenticator.md +0 -15
  132. package/docs/examples/account/create-mfa-challenge.md +0 -15
  133. package/docs/examples/account/create-mfa-recovery-codes.md +0 -13
  134. package/docs/examples/account/create-o-auth-2-session.md +0 -17
  135. package/docs/examples/account/create-o-auth-2-token.md +0 -17
  136. package/docs/examples/account/create-payment-method.md +0 -13
  137. package/docs/examples/account/create-phone-token.md +0 -16
  138. package/docs/examples/account/create-phone-verification.md +0 -13
  139. package/docs/examples/account/create-push-target.md +0 -17
  140. package/docs/examples/account/create-recovery.md +0 -16
  141. package/docs/examples/account/create-session.md +0 -16
  142. package/docs/examples/account/create-verification.md +0 -15
  143. package/docs/examples/account/create.md +0 -18
  144. package/docs/examples/account/delete-billing-address.md +0 -15
  145. package/docs/examples/account/delete-identity.md +0 -15
  146. package/docs/examples/account/delete-key.md +0 -15
  147. package/docs/examples/account/delete-mfa-authenticator.md +0 -15
  148. package/docs/examples/account/delete-payment-method.md +0 -15
  149. package/docs/examples/account/delete-push-target.md +0 -15
  150. package/docs/examples/account/delete-session.md +0 -15
  151. package/docs/examples/account/delete-sessions.md +0 -13
  152. package/docs/examples/account/delete.md +0 -13
  153. package/docs/examples/account/get-billing-address.md +0 -15
  154. package/docs/examples/account/get-coupon.md +0 -15
  155. package/docs/examples/account/get-key.md +0 -15
  156. package/docs/examples/account/get-mfa-recovery-codes.md +0 -13
  157. package/docs/examples/account/get-payment-method.md +0 -15
  158. package/docs/examples/account/get-prefs.md +0 -13
  159. package/docs/examples/account/get-session.md +0 -15
  160. package/docs/examples/account/get.md +0 -13
  161. package/docs/examples/account/list-billing-addresses.md +0 -15
  162. package/docs/examples/account/list-identities.md +0 -16
  163. package/docs/examples/account/list-invoices.md +0 -15
  164. package/docs/examples/account/list-keys.md +0 -15
  165. package/docs/examples/account/list-logs.md +0 -16
  166. package/docs/examples/account/list-mfa-factors.md +0 -13
  167. package/docs/examples/account/list-payment-methods.md +0 -15
  168. package/docs/examples/account/list-sessions.md +0 -13
  169. package/docs/examples/account/update-billing-address.md +0 -21
  170. package/docs/examples/account/update-email-verification.md +0 -16
  171. package/docs/examples/account/update-email.md +0 -16
  172. package/docs/examples/account/update-key.md +0 -18
  173. package/docs/examples/account/update-magic-url-session.md +0 -16
  174. package/docs/examples/account/update-mfa-authenticator.md +0 -16
  175. package/docs/examples/account/update-mfa-challenge.md +0 -16
  176. package/docs/examples/account/update-mfa-recovery-codes.md +0 -13
  177. package/docs/examples/account/update-mfa.md +0 -15
  178. package/docs/examples/account/update-name.md +0 -15
  179. package/docs/examples/account/update-password.md +0 -16
  180. package/docs/examples/account/update-payment-method-mandate-options.md +0 -15
  181. package/docs/examples/account/update-payment-method-provider.md +0 -18
  182. package/docs/examples/account/update-payment-method.md +0 -18
  183. package/docs/examples/account/update-phone-session.md +0 -16
  184. package/docs/examples/account/update-phone-verification.md +0 -16
  185. package/docs/examples/account/update-phone.md +0 -16
  186. package/docs/examples/account/update-prefs.md +0 -19
  187. package/docs/examples/account/update-push-target.md +0 -16
  188. package/docs/examples/account/update-recovery.md +0 -17
  189. package/docs/examples/account/update-session.md +0 -15
  190. package/docs/examples/account/update-status.md +0 -13
  191. package/docs/examples/account/update-verification.md +0 -16
  192. package/docs/examples/activities/get-event.md +0 -15
  193. package/docs/examples/activities/list-events.md +0 -15
  194. package/docs/examples/assistant/chat.md +0 -15
  195. package/docs/examples/avatars/get-browser.md +0 -18
  196. package/docs/examples/avatars/get-credit-card.md +0 -18
  197. package/docs/examples/avatars/get-favicon.md +0 -15
  198. package/docs/examples/avatars/get-flag.md +0 -18
  199. package/docs/examples/avatars/get-image.md +0 -17
  200. package/docs/examples/avatars/get-initials.md +0 -18
  201. package/docs/examples/avatars/get-qr.md +0 -18
  202. package/docs/examples/avatars/get-screenshot.md +0 -37
  203. package/docs/examples/backups/create-archive.md +0 -16
  204. package/docs/examples/backups/create-policy.md +0 -21
  205. package/docs/examples/backups/create-restoration.md +0 -18
  206. package/docs/examples/backups/delete-archive.md +0 -15
  207. package/docs/examples/backups/delete-policy.md +0 -15
  208. package/docs/examples/backups/get-archive.md +0 -15
  209. package/docs/examples/backups/get-policy.md +0 -15
  210. package/docs/examples/backups/get-restoration.md +0 -15
  211. package/docs/examples/backups/list-archives.md +0 -15
  212. package/docs/examples/backups/list-policies.md +0 -15
  213. package/docs/examples/backups/list-restorations.md +0 -15
  214. package/docs/examples/backups/update-policy.md +0 -19
  215. package/docs/examples/console/create-program-membership.md +0 -15
  216. package/docs/examples/console/create-source.md +0 -19
  217. package/docs/examples/console/get-campaign.md +0 -15
  218. package/docs/examples/console/get-coupon.md +0 -15
  219. package/docs/examples/console/get-plan.md +0 -15
  220. package/docs/examples/console/get-plans.md +0 -15
  221. package/docs/examples/console/get-program.md +0 -15
  222. package/docs/examples/console/get-resource.md +0 -16
  223. package/docs/examples/console/list-regions.md +0 -13
  224. package/docs/examples/console/suggest-columns.md +0 -19
  225. package/docs/examples/console/suggest-indexes.md +0 -18
  226. package/docs/examples/console/variables.md +0 -13
  227. package/docs/examples/databases/create-boolean-attribute.md +0 -20
  228. package/docs/examples/databases/create-collection.md +0 -22
  229. package/docs/examples/databases/create-datetime-attribute.md +0 -20
  230. package/docs/examples/databases/create-document.md +0 -26
  231. package/docs/examples/databases/create-documents.md +0 -18
  232. package/docs/examples/databases/create-email-attribute.md +0 -20
  233. package/docs/examples/databases/create-enum-attribute.md +0 -21
  234. package/docs/examples/databases/create-float-attribute.md +0 -22
  235. package/docs/examples/databases/create-index.md +0 -21
  236. package/docs/examples/databases/create-integer-attribute.md +0 -22
  237. package/docs/examples/databases/create-ip-attribute.md +0 -20
  238. package/docs/examples/databases/create-line-attribute.md +0 -19
  239. package/docs/examples/databases/create-longtext-attribute.md +0 -21
  240. package/docs/examples/databases/create-mediumtext-attribute.md +0 -21
  241. package/docs/examples/databases/create-operations.md +0 -26
  242. package/docs/examples/databases/create-point-attribute.md +0 -19
  243. package/docs/examples/databases/create-polygon-attribute.md +0 -19
  244. package/docs/examples/databases/create-relationship-attribute.md +0 -22
  245. package/docs/examples/databases/create-string-attribute.md +0 -22
  246. package/docs/examples/databases/create-text-attribute.md +0 -21
  247. package/docs/examples/databases/create-transaction.md +0 -15
  248. package/docs/examples/databases/create-url-attribute.md +0 -20
  249. package/docs/examples/databases/create-varchar-attribute.md +0 -22
  250. package/docs/examples/databases/create.md +0 -17
  251. package/docs/examples/databases/decrement-document-attribute.md +0 -21
  252. package/docs/examples/databases/delete-attribute.md +0 -17
  253. package/docs/examples/databases/delete-collection.md +0 -16
  254. package/docs/examples/databases/delete-document.md +0 -18
  255. package/docs/examples/databases/delete-documents.md +0 -18
  256. package/docs/examples/databases/delete-index.md +0 -17
  257. package/docs/examples/databases/delete-transaction.md +0 -15
  258. package/docs/examples/databases/delete.md +0 -15
  259. package/docs/examples/databases/get-attribute.md +0 -17
  260. package/docs/examples/databases/get-collection-usage.md +0 -17
  261. package/docs/examples/databases/get-collection.md +0 -16
  262. package/docs/examples/databases/get-document.md +0 -19
  263. package/docs/examples/databases/get-index.md +0 -17
  264. package/docs/examples/databases/get-transaction.md +0 -15
  265. package/docs/examples/databases/get-usage.md +0 -16
  266. package/docs/examples/databases/get.md +0 -15
  267. package/docs/examples/databases/increment-document-attribute.md +0 -21
  268. package/docs/examples/databases/list-attributes.md +0 -18
  269. package/docs/examples/databases/list-collection-logs.md +0 -17
  270. package/docs/examples/databases/list-collections.md +0 -18
  271. package/docs/examples/databases/list-document-logs.md +0 -18
  272. package/docs/examples/databases/list-documents.md +0 -20
  273. package/docs/examples/databases/list-indexes.md +0 -18
  274. package/docs/examples/databases/list-logs.md +0 -16
  275. package/docs/examples/databases/list-transactions.md +0 -15
  276. package/docs/examples/databases/list-usage.md +0 -15
  277. package/docs/examples/databases/list.md +0 -17
  278. package/docs/examples/databases/update-boolean-attribute.md +0 -20
  279. package/docs/examples/databases/update-collection.md +0 -20
  280. package/docs/examples/databases/update-datetime-attribute.md +0 -20
  281. package/docs/examples/databases/update-document.md +0 -26
  282. package/docs/examples/databases/update-documents.md +0 -25
  283. package/docs/examples/databases/update-email-attribute.md +0 -20
  284. package/docs/examples/databases/update-enum-attribute.md +0 -21
  285. package/docs/examples/databases/update-float-attribute.md +0 -22
  286. package/docs/examples/databases/update-integer-attribute.md +0 -22
  287. package/docs/examples/databases/update-ip-attribute.md +0 -20
  288. package/docs/examples/databases/update-line-attribute.md +0 -20
  289. package/docs/examples/databases/update-longtext-attribute.md +0 -20
  290. package/docs/examples/databases/update-mediumtext-attribute.md +0 -20
  291. package/docs/examples/databases/update-point-attribute.md +0 -20
  292. package/docs/examples/databases/update-polygon-attribute.md +0 -20
  293. package/docs/examples/databases/update-relationship-attribute.md +0 -19
  294. package/docs/examples/databases/update-string-attribute.md +0 -21
  295. package/docs/examples/databases/update-text-attribute.md +0 -20
  296. package/docs/examples/databases/update-transaction.md +0 -17
  297. package/docs/examples/databases/update-url-attribute.md +0 -20
  298. package/docs/examples/databases/update-varchar-attribute.md +0 -21
  299. package/docs/examples/databases/update.md +0 -17
  300. package/docs/examples/databases/upsert-document.md +0 -26
  301. package/docs/examples/databases/upsert-documents.md +0 -18
  302. package/docs/examples/domains/create-preset-google-workspace.md +0 -15
  303. package/docs/examples/domains/create-preset-i-cloud.md +0 -15
  304. package/docs/examples/domains/create-preset-mailgun.md +0 -15
  305. package/docs/examples/domains/create-preset-outlook.md +0 -15
  306. package/docs/examples/domains/create-preset-proton-mail.md +0 -15
  307. package/docs/examples/domains/create-preset-zoho.md +0 -15
  308. package/docs/examples/domains/create-purchase.md +0 -26
  309. package/docs/examples/domains/create-record-a.md +0 -19
  310. package/docs/examples/domains/create-record-aaaa.md +0 -19
  311. package/docs/examples/domains/create-record-alias.md +0 -19
  312. package/docs/examples/domains/create-record-caa.md +0 -19
  313. package/docs/examples/domains/create-record-cname.md +0 -19
  314. package/docs/examples/domains/create-record-https.md +0 -19
  315. package/docs/examples/domains/create-record-mx.md +0 -20
  316. package/docs/examples/domains/create-record-ns.md +0 -19
  317. package/docs/examples/domains/create-record-srv.md +0 -22
  318. package/docs/examples/domains/create-record-txt.md +0 -19
  319. package/docs/examples/domains/create-transfer-in.md +0 -19
  320. package/docs/examples/domains/create-transfer-out.md +0 -16
  321. package/docs/examples/domains/create.md +0 -16
  322. package/docs/examples/domains/delete-record.md +0 -16
  323. package/docs/examples/domains/delete.md +0 -15
  324. package/docs/examples/domains/get-preset-google-workspace.md +0 -15
  325. package/docs/examples/domains/get-preset-i-cloud.md +0 -15
  326. package/docs/examples/domains/get-preset-mailgun.md +0 -15
  327. package/docs/examples/domains/get-preset-outlook.md +0 -15
  328. package/docs/examples/domains/get-preset-proton-mail.md +0 -15
  329. package/docs/examples/domains/get-preset-zoho.md +0 -15
  330. package/docs/examples/domains/get-price.md +0 -17
  331. package/docs/examples/domains/get-record.md +0 -16
  332. package/docs/examples/domains/get-transfer-status.md +0 -15
  333. package/docs/examples/domains/get-zone.md +0 -15
  334. package/docs/examples/domains/get.md +0 -15
  335. package/docs/examples/domains/list-records.md +0 -16
  336. package/docs/examples/domains/list-suggestions.md +0 -20
  337. package/docs/examples/domains/list.md +0 -16
  338. package/docs/examples/domains/update-auto-renewal.md +0 -16
  339. package/docs/examples/domains/update-nameservers.md +0 -15
  340. package/docs/examples/domains/update-purchase.md +0 -16
  341. package/docs/examples/domains/update-record-a.md +0 -20
  342. package/docs/examples/domains/update-record-aaaa.md +0 -20
  343. package/docs/examples/domains/update-record-alias.md +0 -20
  344. package/docs/examples/domains/update-record-caa.md +0 -20
  345. package/docs/examples/domains/update-record-cname.md +0 -20
  346. package/docs/examples/domains/update-record-https.md +0 -20
  347. package/docs/examples/domains/update-record-mx.md +0 -21
  348. package/docs/examples/domains/update-record-ns.md +0 -20
  349. package/docs/examples/domains/update-record-srv.md +0 -23
  350. package/docs/examples/domains/update-record-txt.md +0 -20
  351. package/docs/examples/domains/update-team.md +0 -16
  352. package/docs/examples/domains/update-transfer-in.md +0 -16
  353. package/docs/examples/domains/update-zone.md +0 -16
  354. package/docs/examples/functions/create-deployment.md +0 -19
  355. package/docs/examples/functions/create-duplicate-deployment.md +0 -17
  356. package/docs/examples/functions/create-execution.md +0 -21
  357. package/docs/examples/functions/create-template-deployment.md +0 -21
  358. package/docs/examples/functions/create-variable.md +0 -18
  359. package/docs/examples/functions/create-vcs-deployment.md +0 -18
  360. package/docs/examples/functions/create.md +0 -34
  361. package/docs/examples/functions/delete-deployment.md +0 -16
  362. package/docs/examples/functions/delete-execution.md +0 -16
  363. package/docs/examples/functions/delete-variable.md +0 -16
  364. package/docs/examples/functions/delete.md +0 -15
  365. package/docs/examples/functions/get-deployment-download.md +0 -17
  366. package/docs/examples/functions/get-deployment.md +0 -16
  367. package/docs/examples/functions/get-execution.md +0 -16
  368. package/docs/examples/functions/get-template.md +0 -15
  369. package/docs/examples/functions/get-usage.md +0 -16
  370. package/docs/examples/functions/get-variable.md +0 -16
  371. package/docs/examples/functions/get.md +0 -15
  372. package/docs/examples/functions/list-deployments.md +0 -18
  373. package/docs/examples/functions/list-executions.md +0 -17
  374. package/docs/examples/functions/list-runtimes.md +0 -13
  375. package/docs/examples/functions/list-specifications.md +0 -13
  376. package/docs/examples/functions/list-templates.md +0 -19
  377. package/docs/examples/functions/list-usage.md +0 -15
  378. package/docs/examples/functions/list-variables.md +0 -15
  379. package/docs/examples/functions/list.md +0 -17
  380. package/docs/examples/functions/update-deployment-status.md +0 -16
  381. package/docs/examples/functions/update-function-deployment.md +0 -16
  382. package/docs/examples/functions/update-variable.md +0 -19
  383. package/docs/examples/functions/update.md +0 -34
  384. package/docs/examples/graphql/mutation.md +0 -15
  385. package/docs/examples/graphql/query.md +0 -15
  386. package/docs/examples/health/get-antivirus.md +0 -13
  387. package/docs/examples/health/get-cache.md +0 -13
  388. package/docs/examples/health/get-certificate.md +0 -15
  389. package/docs/examples/health/get-console-pausing.md +0 -16
  390. package/docs/examples/health/get-db.md +0 -13
  391. package/docs/examples/health/get-failed-jobs.md +0 -16
  392. package/docs/examples/health/get-pub-sub.md +0 -13
  393. package/docs/examples/health/get-queue-audits.md +0 -15
  394. package/docs/examples/health/get-queue-billing-project-aggregation.md +0 -15
  395. package/docs/examples/health/get-queue-billing-team-aggregation.md +0 -15
  396. package/docs/examples/health/get-queue-builds.md +0 -15
  397. package/docs/examples/health/get-queue-certificates.md +0 -15
  398. package/docs/examples/health/get-queue-databases.md +0 -16
  399. package/docs/examples/health/get-queue-deletes.md +0 -15
  400. package/docs/examples/health/get-queue-functions.md +0 -15
  401. package/docs/examples/health/get-queue-logs.md +0 -15
  402. package/docs/examples/health/get-queue-mails.md +0 -15
  403. package/docs/examples/health/get-queue-messaging.md +0 -15
  404. package/docs/examples/health/get-queue-migrations.md +0 -15
  405. package/docs/examples/health/get-queue-priority-builds.md +0 -15
  406. package/docs/examples/health/get-queue-region-manager.md +0 -15
  407. package/docs/examples/health/get-queue-stats-resources.md +0 -15
  408. package/docs/examples/health/get-queue-threats.md +0 -15
  409. package/docs/examples/health/get-queue-usage.md +0 -15
  410. package/docs/examples/health/get-queue-webhooks.md +0 -15
  411. package/docs/examples/health/get-storage-local.md +0 -13
  412. package/docs/examples/health/get-storage.md +0 -13
  413. package/docs/examples/health/get-time.md +0 -13
  414. package/docs/examples/health/get.md +0 -13
  415. package/docs/examples/locale/get.md +0 -13
  416. package/docs/examples/locale/list-codes.md +0 -13
  417. package/docs/examples/locale/list-continents.md +0 -13
  418. package/docs/examples/locale/list-countries-eu.md +0 -13
  419. package/docs/examples/locale/list-countries-phones.md +0 -13
  420. package/docs/examples/locale/list-countries.md +0 -13
  421. package/docs/examples/locale/list-currencies.md +0 -13
  422. package/docs/examples/locale/list-languages.md +0 -13
  423. package/docs/examples/messaging/create-apns-provider.md +0 -22
  424. package/docs/examples/messaging/create-email.md +0 -26
  425. package/docs/examples/messaging/create-fcm-provider.md +0 -18
  426. package/docs/examples/messaging/create-mailgun-provider.md +0 -24
  427. package/docs/examples/messaging/create-msg-91-provider.md +0 -20
  428. package/docs/examples/messaging/create-push.md +0 -33
  429. package/docs/examples/messaging/create-resend-provider.md +0 -22
  430. package/docs/examples/messaging/create-sendgrid-provider.md +0 -22
  431. package/docs/examples/messaging/create-sms.md +0 -21
  432. package/docs/examples/messaging/create-smtp-provider.md +0 -28
  433. package/docs/examples/messaging/create-subscriber.md +0 -17
  434. package/docs/examples/messaging/create-telesign-provider.md +0 -20
  435. package/docs/examples/messaging/create-textmagic-provider.md +0 -20
  436. package/docs/examples/messaging/create-topic.md +0 -17
  437. package/docs/examples/messaging/create-twilio-provider.md +0 -20
  438. package/docs/examples/messaging/create-vonage-provider.md +0 -20
  439. package/docs/examples/messaging/delete-provider.md +0 -15
  440. package/docs/examples/messaging/delete-subscriber.md +0 -16
  441. package/docs/examples/messaging/delete-topic.md +0 -15
  442. package/docs/examples/messaging/delete.md +0 -15
  443. package/docs/examples/messaging/get-message.md +0 -15
  444. package/docs/examples/messaging/get-provider.md +0 -15
  445. package/docs/examples/messaging/get-subscriber.md +0 -16
  446. package/docs/examples/messaging/get-topic.md +0 -15
  447. package/docs/examples/messaging/list-message-logs.md +0 -17
  448. package/docs/examples/messaging/list-messages.md +0 -17
  449. package/docs/examples/messaging/list-provider-logs.md +0 -17
  450. package/docs/examples/messaging/list-providers.md +0 -17
  451. package/docs/examples/messaging/list-subscriber-logs.md +0 -17
  452. package/docs/examples/messaging/list-subscribers.md +0 -18
  453. package/docs/examples/messaging/list-targets.md +0 -17
  454. package/docs/examples/messaging/list-topic-logs.md +0 -17
  455. package/docs/examples/messaging/list-topics.md +0 -17
  456. package/docs/examples/messaging/update-apns-provider.md +0 -22
  457. package/docs/examples/messaging/update-email.md +0 -26
  458. package/docs/examples/messaging/update-fcm-provider.md +0 -18
  459. package/docs/examples/messaging/update-mailgun-provider.md +0 -24
  460. package/docs/examples/messaging/update-msg-91-provider.md +0 -20
  461. package/docs/examples/messaging/update-push.md +0 -33
  462. package/docs/examples/messaging/update-resend-provider.md +0 -22
  463. package/docs/examples/messaging/update-sendgrid-provider.md +0 -22
  464. package/docs/examples/messaging/update-sms.md +0 -21
  465. package/docs/examples/messaging/update-smtp-provider.md +0 -28
  466. package/docs/examples/messaging/update-telesign-provider.md +0 -20
  467. package/docs/examples/messaging/update-textmagic-provider.md +0 -20
  468. package/docs/examples/messaging/update-topic.md +0 -17
  469. package/docs/examples/messaging/update-twilio-provider.md +0 -20
  470. package/docs/examples/messaging/update-vonage-provider.md +0 -20
  471. package/docs/examples/migrations/create-appwrite-migration.md +0 -18
  472. package/docs/examples/migrations/create-csv-export.md +0 -23
  473. package/docs/examples/migrations/create-csv-import.md +0 -18
  474. package/docs/examples/migrations/create-firebase-migration.md +0 -16
  475. package/docs/examples/migrations/create-n-host-migration.md +0 -22
  476. package/docs/examples/migrations/create-supabase-migration.md +0 -21
  477. package/docs/examples/migrations/delete.md +0 -15
  478. package/docs/examples/migrations/get-appwrite-report.md +0 -18
  479. package/docs/examples/migrations/get-firebase-report.md +0 -16
  480. package/docs/examples/migrations/get-n-host-report.md +0 -22
  481. package/docs/examples/migrations/get-supabase-report.md +0 -21
  482. package/docs/examples/migrations/get.md +0 -15
  483. package/docs/examples/migrations/list.md +0 -17
  484. package/docs/examples/migrations/retry.md +0 -15
  485. package/docs/examples/organizations/add-credit.md +0 -16
  486. package/docs/examples/organizations/cancel-downgrade.md +0 -15
  487. package/docs/examples/organizations/create-downgrade-feedback.md +0 -19
  488. package/docs/examples/organizations/create-invoice-payment.md +0 -17
  489. package/docs/examples/organizations/create-key.md +0 -18
  490. package/docs/examples/organizations/create.md +0 -24
  491. package/docs/examples/organizations/delete-backup-payment-method.md +0 -15
  492. package/docs/examples/organizations/delete-billing-address.md +0 -15
  493. package/docs/examples/organizations/delete-default-payment-method.md +0 -15
  494. package/docs/examples/organizations/delete-key.md +0 -16
  495. package/docs/examples/organizations/delete.md +0 -15
  496. package/docs/examples/organizations/estimation-create-organization.md +0 -19
  497. package/docs/examples/organizations/estimation-delete-organization.md +0 -15
  498. package/docs/examples/organizations/estimation-update-plan.md +0 -18
  499. package/docs/examples/organizations/get-aggregation.md +0 -18
  500. package/docs/examples/organizations/get-available-credits.md +0 -15
  501. package/docs/examples/organizations/get-billing-address.md +0 -16
  502. package/docs/examples/organizations/get-credit.md +0 -16
  503. package/docs/examples/organizations/get-invoice-download.md +0 -16
  504. package/docs/examples/organizations/get-invoice-view.md +0 -16
  505. package/docs/examples/organizations/get-invoice.md +0 -16
  506. package/docs/examples/organizations/get-key.md +0 -16
  507. package/docs/examples/organizations/get-payment-method.md +0 -16
  508. package/docs/examples/organizations/get-plan.md +0 -15
  509. package/docs/examples/organizations/get-scopes.md +0 -16
  510. package/docs/examples/organizations/get-usage.md +0 -17
  511. package/docs/examples/organizations/list-aggregations.md +0 -16
  512. package/docs/examples/organizations/list-credits.md +0 -16
  513. package/docs/examples/organizations/list-invoices.md +0 -16
  514. package/docs/examples/organizations/list-keys.md +0 -16
  515. package/docs/examples/organizations/list-regions.md +0 -15
  516. package/docs/examples/organizations/list.md +0 -16
  517. package/docs/examples/organizations/set-backup-payment-method.md +0 -16
  518. package/docs/examples/organizations/set-billing-address.md +0 -16
  519. package/docs/examples/organizations/set-billing-email.md +0 -16
  520. package/docs/examples/organizations/set-billing-tax-id.md +0 -16
  521. package/docs/examples/organizations/set-default-payment-method.md +0 -16
  522. package/docs/examples/organizations/update-budget.md +0 -17
  523. package/docs/examples/organizations/update-key.md +0 -19
  524. package/docs/examples/organizations/update-plan.md +0 -22
  525. package/docs/examples/organizations/validate-invoice.md +0 -16
  526. package/docs/examples/organizations/validate-payment.md +0 -16
  527. package/docs/examples/project/create-variable.md +0 -18
  528. package/docs/examples/project/delete-variable.md +0 -15
  529. package/docs/examples/project/get-usage.md +0 -17
  530. package/docs/examples/project/get-variable.md +0 -15
  531. package/docs/examples/project/list-variables.md +0 -16
  532. package/docs/examples/project/update-variable.md +0 -18
  533. package/docs/examples/projects/create-dev-key.md +0 -17
  534. package/docs/examples/projects/create-jwt.md +0 -17
  535. package/docs/examples/projects/create-key.md +0 -19
  536. package/docs/examples/projects/create-platform.md +0 -20
  537. package/docs/examples/projects/create-schedule.md +0 -20
  538. package/docs/examples/projects/create-smtp-test.md +0 -24
  539. package/docs/examples/projects/create.md +0 -27
  540. package/docs/examples/projects/delete-dev-key.md +0 -16
  541. package/docs/examples/projects/delete-email-template.md +0 -17
  542. package/docs/examples/projects/delete-key.md +0 -16
  543. package/docs/examples/projects/delete-platform.md +0 -16
  544. package/docs/examples/projects/delete-sms-template.md +0 -17
  545. package/docs/examples/projects/delete.md +0 -15
  546. package/docs/examples/projects/get-dev-key.md +0 -16
  547. package/docs/examples/projects/get-email-template.md +0 -17
  548. package/docs/examples/projects/get-key.md +0 -16
  549. package/docs/examples/projects/get-platform.md +0 -16
  550. package/docs/examples/projects/get-schedule.md +0 -16
  551. package/docs/examples/projects/get-sms-template.md +0 -17
  552. package/docs/examples/projects/get.md +0 -15
  553. package/docs/examples/projects/list-dev-keys.md +0 -16
  554. package/docs/examples/projects/list-keys.md +0 -17
  555. package/docs/examples/projects/list-platforms.md +0 -16
  556. package/docs/examples/projects/list-schedules.md +0 -17
  557. package/docs/examples/projects/list.md +0 -17
  558. package/docs/examples/projects/update-api-status-all.md +0 -16
  559. package/docs/examples/projects/update-api-status.md +0 -17
  560. package/docs/examples/projects/update-auth-duration.md +0 -16
  561. package/docs/examples/projects/update-auth-limit.md +0 -16
  562. package/docs/examples/projects/update-auth-password-dictionary.md +0 -16
  563. package/docs/examples/projects/update-auth-password-history.md +0 -16
  564. package/docs/examples/projects/update-auth-sessions-limit.md +0 -16
  565. package/docs/examples/projects/update-auth-status.md +0 -17
  566. package/docs/examples/projects/update-console-access.md +0 -15
  567. package/docs/examples/projects/update-dev-key.md +0 -18
  568. package/docs/examples/projects/update-email-template.md +0 -22
  569. package/docs/examples/projects/update-key.md +0 -19
  570. package/docs/examples/projects/update-labels.md +0 -16
  571. package/docs/examples/projects/update-memberships-privacy.md +0 -18
  572. package/docs/examples/projects/update-mock-numbers.md +0 -16
  573. package/docs/examples/projects/update-o-auth-2.md +0 -19
  574. package/docs/examples/projects/update-personal-data-check.md +0 -16
  575. package/docs/examples/projects/update-platform.md +0 -20
  576. package/docs/examples/projects/update-service-status-all.md +0 -16
  577. package/docs/examples/projects/update-service-status.md +0 -17
  578. package/docs/examples/projects/update-session-alerts.md +0 -16
  579. package/docs/examples/projects/update-session-invalidation.md +0 -16
  580. package/docs/examples/projects/update-sms-template.md +0 -18
  581. package/docs/examples/projects/update-smtp.md +0 -24
  582. package/docs/examples/projects/update-status.md +0 -16
  583. package/docs/examples/projects/update-team.md +0 -16
  584. package/docs/examples/projects/update.md +0 -25
  585. package/docs/examples/proxy/create-api-rule.md +0 -15
  586. package/docs/examples/proxy/create-function-rule.md +0 -17
  587. package/docs/examples/proxy/create-redirect-rule.md +0 -19
  588. package/docs/examples/proxy/create-site-rule.md +0 -17
  589. package/docs/examples/proxy/delete-rule.md +0 -15
  590. package/docs/examples/proxy/get-rule.md +0 -15
  591. package/docs/examples/proxy/list-rules.md +0 -17
  592. package/docs/examples/proxy/update-rule-verification.md +0 -15
  593. package/docs/examples/sites/create-deployment.md +0 -20
  594. package/docs/examples/sites/create-duplicate-deployment.md +0 -16
  595. package/docs/examples/sites/create-template-deployment.md +0 -21
  596. package/docs/examples/sites/create-variable.md +0 -18
  597. package/docs/examples/sites/create-vcs-deployment.md +0 -18
  598. package/docs/examples/sites/create.md +0 -35
  599. package/docs/examples/sites/delete-deployment.md +0 -16
  600. package/docs/examples/sites/delete-log.md +0 -16
  601. package/docs/examples/sites/delete-variable.md +0 -16
  602. package/docs/examples/sites/delete.md +0 -15
  603. package/docs/examples/sites/get-deployment-download.md +0 -17
  604. package/docs/examples/sites/get-deployment.md +0 -16
  605. package/docs/examples/sites/get-log.md +0 -16
  606. package/docs/examples/sites/get-template.md +0 -15
  607. package/docs/examples/sites/get-usage.md +0 -16
  608. package/docs/examples/sites/get-variable.md +0 -16
  609. package/docs/examples/sites/get.md +0 -15
  610. package/docs/examples/sites/list-deployments.md +0 -18
  611. package/docs/examples/sites/list-frameworks.md +0 -13
  612. package/docs/examples/sites/list-logs.md +0 -17
  613. package/docs/examples/sites/list-specifications.md +0 -13
  614. package/docs/examples/sites/list-templates.md +0 -18
  615. package/docs/examples/sites/list-usage.md +0 -15
  616. package/docs/examples/sites/list-variables.md +0 -15
  617. package/docs/examples/sites/list.md +0 -17
  618. package/docs/examples/sites/update-deployment-status.md +0 -16
  619. package/docs/examples/sites/update-site-deployment.md +0 -16
  620. package/docs/examples/sites/update-variable.md +0 -19
  621. package/docs/examples/sites/update.md +0 -35
  622. package/docs/examples/storage/create-bucket.md +0 -25
  623. package/docs/examples/storage/create-file.md +0 -18
  624. package/docs/examples/storage/delete-bucket.md +0 -15
  625. package/docs/examples/storage/delete-file.md +0 -16
  626. package/docs/examples/storage/get-bucket-usage.md +0 -16
  627. package/docs/examples/storage/get-bucket.md +0 -15
  628. package/docs/examples/storage/get-file-download.md +0 -17
  629. package/docs/examples/storage/get-file-preview.md +0 -28
  630. package/docs/examples/storage/get-file-view.md +0 -17
  631. package/docs/examples/storage/get-file.md +0 -16
  632. package/docs/examples/storage/get-usage.md +0 -15
  633. package/docs/examples/storage/list-buckets.md +0 -17
  634. package/docs/examples/storage/list-files.md +0 -18
  635. package/docs/examples/storage/update-bucket.md +0 -25
  636. package/docs/examples/storage/update-file.md +0 -18
  637. package/docs/examples/tablesdb/create-boolean-column.md +0 -20
  638. package/docs/examples/tablesdb/create-datetime-column.md +0 -20
  639. package/docs/examples/tablesdb/create-email-column.md +0 -20
  640. package/docs/examples/tablesdb/create-enum-column.md +0 -21
  641. package/docs/examples/tablesdb/create-float-column.md +0 -22
  642. package/docs/examples/tablesdb/create-index.md +0 -21
  643. package/docs/examples/tablesdb/create-integer-column.md +0 -22
  644. package/docs/examples/tablesdb/create-ip-column.md +0 -20
  645. package/docs/examples/tablesdb/create-line-column.md +0 -19
  646. package/docs/examples/tablesdb/create-longtext-column.md +0 -21
  647. package/docs/examples/tablesdb/create-mediumtext-column.md +0 -21
  648. package/docs/examples/tablesdb/create-operations.md +0 -26
  649. package/docs/examples/tablesdb/create-point-column.md +0 -19
  650. package/docs/examples/tablesdb/create-polygon-column.md +0 -19
  651. package/docs/examples/tablesdb/create-relationship-column.md +0 -22
  652. package/docs/examples/tablesdb/create-row.md +0 -26
  653. package/docs/examples/tablesdb/create-rows.md +0 -18
  654. package/docs/examples/tablesdb/create-string-column.md +0 -22
  655. package/docs/examples/tablesdb/create-table.md +0 -22
  656. package/docs/examples/tablesdb/create-text-column.md +0 -21
  657. package/docs/examples/tablesdb/create-transaction.md +0 -15
  658. package/docs/examples/tablesdb/create-url-column.md +0 -20
  659. package/docs/examples/tablesdb/create-varchar-column.md +0 -22
  660. package/docs/examples/tablesdb/create.md +0 -17
  661. package/docs/examples/tablesdb/decrement-row-column.md +0 -21
  662. package/docs/examples/tablesdb/delete-column.md +0 -17
  663. package/docs/examples/tablesdb/delete-index.md +0 -17
  664. package/docs/examples/tablesdb/delete-row.md +0 -18
  665. package/docs/examples/tablesdb/delete-rows.md +0 -18
  666. package/docs/examples/tablesdb/delete-table.md +0 -16
  667. package/docs/examples/tablesdb/delete-transaction.md +0 -15
  668. package/docs/examples/tablesdb/delete.md +0 -15
  669. package/docs/examples/tablesdb/get-column.md +0 -17
  670. package/docs/examples/tablesdb/get-index.md +0 -17
  671. package/docs/examples/tablesdb/get-row.md +0 -19
  672. package/docs/examples/tablesdb/get-table-usage.md +0 -17
  673. package/docs/examples/tablesdb/get-table.md +0 -16
  674. package/docs/examples/tablesdb/get-transaction.md +0 -15
  675. package/docs/examples/tablesdb/get-usage.md +0 -16
  676. package/docs/examples/tablesdb/get.md +0 -15
  677. package/docs/examples/tablesdb/increment-row-column.md +0 -21
  678. package/docs/examples/tablesdb/list-columns.md +0 -18
  679. package/docs/examples/tablesdb/list-indexes.md +0 -18
  680. package/docs/examples/tablesdb/list-row-logs.md +0 -18
  681. package/docs/examples/tablesdb/list-rows.md +0 -20
  682. package/docs/examples/tablesdb/list-table-logs.md +0 -17
  683. package/docs/examples/tablesdb/list-tables.md +0 -18
  684. package/docs/examples/tablesdb/list-transactions.md +0 -15
  685. package/docs/examples/tablesdb/list-usage.md +0 -15
  686. package/docs/examples/tablesdb/list.md +0 -17
  687. package/docs/examples/tablesdb/update-boolean-column.md +0 -20
  688. package/docs/examples/tablesdb/update-datetime-column.md +0 -20
  689. package/docs/examples/tablesdb/update-email-column.md +0 -20
  690. package/docs/examples/tablesdb/update-enum-column.md +0 -21
  691. package/docs/examples/tablesdb/update-float-column.md +0 -22
  692. package/docs/examples/tablesdb/update-integer-column.md +0 -22
  693. package/docs/examples/tablesdb/update-ip-column.md +0 -20
  694. package/docs/examples/tablesdb/update-line-column.md +0 -20
  695. package/docs/examples/tablesdb/update-longtext-column.md +0 -20
  696. package/docs/examples/tablesdb/update-mediumtext-column.md +0 -20
  697. package/docs/examples/tablesdb/update-point-column.md +0 -20
  698. package/docs/examples/tablesdb/update-polygon-column.md +0 -20
  699. package/docs/examples/tablesdb/update-relationship-column.md +0 -19
  700. package/docs/examples/tablesdb/update-row.md +0 -26
  701. package/docs/examples/tablesdb/update-rows.md +0 -25
  702. package/docs/examples/tablesdb/update-string-column.md +0 -21
  703. package/docs/examples/tablesdb/update-table.md +0 -20
  704. package/docs/examples/tablesdb/update-text-column.md +0 -20
  705. package/docs/examples/tablesdb/update-transaction.md +0 -17
  706. package/docs/examples/tablesdb/update-url-column.md +0 -20
  707. package/docs/examples/tablesdb/update-varchar-column.md +0 -21
  708. package/docs/examples/tablesdb/update.md +0 -17
  709. package/docs/examples/tablesdb/upsert-row.md +0 -26
  710. package/docs/examples/tablesdb/upsert-rows.md +0 -18
  711. package/docs/examples/teams/create-membership.md +0 -21
  712. package/docs/examples/teams/create.md +0 -17
  713. package/docs/examples/teams/delete-membership.md +0 -16
  714. package/docs/examples/teams/delete.md +0 -15
  715. package/docs/examples/teams/get-membership.md +0 -16
  716. package/docs/examples/teams/get-prefs.md +0 -15
  717. package/docs/examples/teams/get.md +0 -15
  718. package/docs/examples/teams/list-logs.md +0 -17
  719. package/docs/examples/teams/list-memberships.md +0 -18
  720. package/docs/examples/teams/list.md +0 -17
  721. package/docs/examples/teams/update-membership-status.md +0 -18
  722. package/docs/examples/teams/update-membership.md +0 -17
  723. package/docs/examples/teams/update-name.md +0 -16
  724. package/docs/examples/teams/update-prefs.md +0 -16
  725. package/docs/examples/tokens/create-file-token.md +0 -17
  726. package/docs/examples/tokens/delete.md +0 -15
  727. package/docs/examples/tokens/get.md +0 -15
  728. package/docs/examples/tokens/list.md +0 -18
  729. package/docs/examples/tokens/update.md +0 -16
  730. package/docs/examples/users/create-argon-2-user.md +0 -18
  731. package/docs/examples/users/create-bcrypt-user.md +0 -18
  732. package/docs/examples/users/create-jwt.md +0 -17
  733. package/docs/examples/users/create-md-5-user.md +0 -18
  734. package/docs/examples/users/create-mfa-recovery-codes.md +0 -15
  735. package/docs/examples/users/create-ph-pass-user.md +0 -18
  736. package/docs/examples/users/create-scrypt-modified-user.md +0 -21
  737. package/docs/examples/users/create-scrypt-user.md +0 -23
  738. package/docs/examples/users/create-session.md +0 -15
  739. package/docs/examples/users/create-sha-user.md +0 -19
  740. package/docs/examples/users/create-target.md +0 -20
  741. package/docs/examples/users/create-token.md +0 -17
  742. package/docs/examples/users/create.md +0 -19
  743. package/docs/examples/users/delete-identity.md +0 -15
  744. package/docs/examples/users/delete-mfa-authenticator.md +0 -16
  745. package/docs/examples/users/delete-session.md +0 -16
  746. package/docs/examples/users/delete-sessions.md +0 -15
  747. package/docs/examples/users/delete-target.md +0 -16
  748. package/docs/examples/users/delete.md +0 -15
  749. package/docs/examples/users/get-mfa-recovery-codes.md +0 -15
  750. package/docs/examples/users/get-prefs.md +0 -15
  751. package/docs/examples/users/get-target.md +0 -16
  752. package/docs/examples/users/get-usage.md +0 -15
  753. package/docs/examples/users/get.md +0 -15
  754. package/docs/examples/users/list-identities.md +0 -17
  755. package/docs/examples/users/list-logs.md +0 -17
  756. package/docs/examples/users/list-memberships.md +0 -18
  757. package/docs/examples/users/list-mfa-factors.md +0 -15
  758. package/docs/examples/users/list-sessions.md +0 -16
  759. package/docs/examples/users/list-targets.md +0 -17
  760. package/docs/examples/users/list.md +0 -17
  761. package/docs/examples/users/update-email-verification.md +0 -16
  762. package/docs/examples/users/update-email.md +0 -16
  763. package/docs/examples/users/update-impersonator.md +0 -16
  764. package/docs/examples/users/update-labels.md +0 -16
  765. package/docs/examples/users/update-mfa-recovery-codes.md +0 -15
  766. package/docs/examples/users/update-mfa.md +0 -16
  767. package/docs/examples/users/update-name.md +0 -16
  768. package/docs/examples/users/update-password.md +0 -16
  769. package/docs/examples/users/update-phone-verification.md +0 -16
  770. package/docs/examples/users/update-phone.md +0 -16
  771. package/docs/examples/users/update-prefs.md +0 -16
  772. package/docs/examples/users/update-status.md +0 -16
  773. package/docs/examples/users/update-target.md +0 -19
  774. package/docs/examples/vcs/create-repository-detection.md +0 -18
  775. package/docs/examples/vcs/create-repository.md +0 -17
  776. package/docs/examples/vcs/delete-installation.md +0 -15
  777. package/docs/examples/vcs/get-installation.md +0 -15
  778. package/docs/examples/vcs/get-repository-contents.md +0 -18
  779. package/docs/examples/vcs/get-repository.md +0 -16
  780. package/docs/examples/vcs/list-installations.md +0 -17
  781. package/docs/examples/vcs/list-repositories.md +0 -18
  782. package/docs/examples/vcs/list-repository-branches.md +0 -16
  783. package/docs/examples/vcs/update-external-deployments.md +0 -17
  784. package/docs/examples/webhooks/create.md +0 -22
  785. package/docs/examples/webhooks/delete.md +0 -15
  786. package/docs/examples/webhooks/get.md +0 -15
  787. package/docs/examples/webhooks/list.md +0 -16
  788. package/docs/examples/webhooks/update-signature.md +0 -15
  789. package/docs/examples/webhooks/update.md +0 -22
  790. package/rollup.config.js +0 -44
  791. package/src/channel.ts +0 -158
  792. package/src/client.ts +0 -1085
  793. package/src/enums/adapter.ts +0 -4
  794. package/src/enums/api-service.ts +0 -15
  795. package/src/enums/api.ts +0 -5
  796. package/src/enums/appwrite-migration-resource.ts +0 -27
  797. package/src/enums/attribute-status.ts +0 -7
  798. package/src/enums/auth-method.ts +0 -9
  799. package/src/enums/authentication-factor.ts +0 -6
  800. package/src/enums/authenticator-type.ts +0 -3
  801. package/src/enums/backup-services.ts +0 -8
  802. package/src/enums/billing-plan-group.ts +0 -5
  803. package/src/enums/browser-permission.ts +0 -22
  804. package/src/enums/browser.ts +0 -16
  805. package/src/enums/build-runtime.ts +0 -88
  806. package/src/enums/column-status.ts +0 -7
  807. package/src/enums/compression.ts +0 -5
  808. package/src/enums/console-resource-type.ts +0 -3
  809. package/src/enums/credit-card.ts +0 -19
  810. package/src/enums/database-type.ts +0 -6
  811. package/src/enums/databases-index-type.ts +0 -6
  812. package/src/enums/deployment-download-type.ts +0 -4
  813. package/src/enums/deployment-status.ts +0 -8
  814. package/src/enums/domain-purchase-status.ts +0 -6
  815. package/src/enums/domain-transfer-status-enum.ts +0 -10
  816. package/src/enums/email-template-locale.ts +0 -133
  817. package/src/enums/email-template-type.ts +0 -9
  818. package/src/enums/execution-method.ts +0 -9
  819. package/src/enums/execution-status.ts +0 -7
  820. package/src/enums/execution-trigger.ts +0 -5
  821. package/src/enums/filter-type.ts +0 -4
  822. package/src/enums/firebase-migration-resource.ts +0 -12
  823. package/src/enums/flag.ts +0 -197
  824. package/src/enums/framework.ts +0 -17
  825. package/src/enums/frameworks.ts +0 -17
  826. package/src/enums/health-antivirus-status.ts +0 -5
  827. package/src/enums/health-check-status.ts +0 -4
  828. package/src/enums/image-format.ts +0 -9
  829. package/src/enums/image-gravity.ts +0 -11
  830. package/src/enums/index-status.ts +0 -7
  831. package/src/enums/message-priority.ts +0 -4
  832. package/src/enums/message-status.ts +0 -7
  833. package/src/enums/messaging-provider-type.ts +0 -5
  834. package/src/enums/n-host-migration-resource.ts +0 -13
  835. package/src/enums/name.ts +0 -15
  836. package/src/enums/o-auth-provider.ts +0 -41
  837. package/src/enums/order-by.ts +0 -4
  838. package/src/enums/password-hash.ts +0 -13
  839. package/src/enums/platform-type.ts +0 -17
  840. package/src/enums/platform.ts +0 -4
  841. package/src/enums/project-usage-range.ts +0 -4
  842. package/src/enums/proxy-resource-type.ts +0 -4
  843. package/src/enums/proxy-rule-deployment-resource-type.ts +0 -4
  844. package/src/enums/proxy-rule-status.ts +0 -6
  845. package/src/enums/region.ts +0 -8
  846. package/src/enums/registration-type.ts +0 -6
  847. package/src/enums/relation-mutate.ts +0 -5
  848. package/src/enums/relationship-type.ts +0 -6
  849. package/src/enums/resource-type.ts +0 -6
  850. package/src/enums/runtime.ts +0 -88
  851. package/src/enums/runtimes.ts +0 -88
  852. package/src/enums/scopes.ts +0 -81
  853. package/src/enums/sms-template-locale.ts +0 -133
  854. package/src/enums/sms-template-type.ts +0 -6
  855. package/src/enums/smtp-encryption.ts +0 -5
  856. package/src/enums/smtp-secure.ts +0 -4
  857. package/src/enums/status-code.ts +0 -6
  858. package/src/enums/status.ts +0 -3
  859. package/src/enums/supabase-migration-resource.ts +0 -13
  860. package/src/enums/tables-db-index-type.ts +0 -6
  861. package/src/enums/template-reference-type.ts +0 -5
  862. package/src/enums/theme.ts +0 -4
  863. package/src/enums/timezone.ts +0 -421
  864. package/src/enums/usage-range.ts +0 -5
  865. package/src/enums/use-cases.ts +0 -16
  866. package/src/enums/vcs-detection-type.ts +0 -4
  867. package/src/enums/vcs-reference-type.ts +0 -5
  868. package/src/id.ts +0 -47
  869. package/src/operator.ts +0 -308
  870. package/src/query.ts +0 -576
  871. package/src/service.ts +0 -30
  872. package/src/services/account.ts +0 -4293
  873. package/src/services/activities.ts +0 -116
  874. package/src/services/assistant.ts +0 -67
  875. package/src/services/backups.ts +0 -754
  876. package/src/services/console.ts +0 -678
  877. package/src/services/databases.ts +0 -6376
  878. package/src/services/domains.ts +0 -4064
  879. package/src/services/functions.ts +0 -2224
  880. package/src/services/graphql.ts +0 -124
  881. package/src/services/health.ts +0 -1296
  882. package/src/services/locale.ts +0 -198
  883. package/src/services/messaging.ts +0 -5194
  884. package/src/services/migrations.ts +0 -1207
  885. package/src/services/organizations.ts +0 -2742
  886. package/src/services/project.ts +0 -404
  887. package/src/services/projects.ts +0 -4431
  888. package/src/services/proxy.ts +0 -532
  889. package/src/services/realtime.ts +0 -537
  890. package/src/services/sites.ts +0 -2131
  891. package/src/services/storage.ts +0 -1196
  892. package/src/services/tables-db.ts +0 -6256
  893. package/src/services/teams.ts +0 -959
  894. package/src/services/tokens.ts +0 -315
  895. package/src/services/users.ts +0 -3324
  896. package/src/services/vcs.ts +0 -676
  897. package/src/services/webhooks.ts +0 -451
  898. package/tsconfig.json +0 -24
@@ -0,0 +1,1527 @@
1
+ import { Client } from '../client';
2
+ import type { Models } from '../models';
3
+ import { RegistrationType } from '../enums/registration-type';
4
+ import { FilterType } from '../enums/filter-type';
5
+ export declare class Domains {
6
+ client: Client;
7
+ constructor(client: Client);
8
+ /**
9
+ * List all domains registered for this project. This endpoint supports pagination.
10
+ *
11
+ * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on attributes such as domain name, teamInternalId, expiration, etc.
12
+ * @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
13
+ * @throws {AppwriteException}
14
+ * @returns {Promise<Models.DomainsList>}
15
+ */
16
+ list(params?: {
17
+ queries?: string[];
18
+ search?: string;
19
+ }): Promise<Models.DomainsList>;
20
+ /**
21
+ * List all domains registered for this project. This endpoint supports pagination.
22
+ *
23
+ * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on attributes such as domain name, teamInternalId, expiration, etc.
24
+ * @param {string} search - Search term to filter your list results. Max length: 256 chars.
25
+ * @throws {AppwriteException}
26
+ * @returns {Promise<Models.DomainsList>}
27
+ * @deprecated Use the object parameter style method for a better developer experience.
28
+ */
29
+ list(queries?: string[], search?: string): Promise<Models.DomainsList>;
30
+ /**
31
+ * 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.
32
+ *
33
+ * @param {string} params.teamId - Team unique ID.
34
+ * @param {string} params.domain - Domain name (e.g. "example.com").
35
+ * @throws {AppwriteException}
36
+ * @returns {Promise<Models.Domain>}
37
+ */
38
+ create(params: {
39
+ teamId: string;
40
+ domain: string;
41
+ }): Promise<Models.Domain>;
42
+ /**
43
+ * 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.
44
+ *
45
+ * @param {string} teamId - Team unique ID.
46
+ * @param {string} domain - Domain name (e.g. "example.com").
47
+ * @throws {AppwriteException}
48
+ * @returns {Promise<Models.Domain>}
49
+ * @deprecated Use the object parameter style method for a better developer experience.
50
+ */
51
+ create(teamId: string, domain: string): Promise<Models.Domain>;
52
+ /**
53
+ * Get the registration price for a domain name.
54
+ *
55
+ * @param {string} params.domain - Domain name to get price for.
56
+ * @param {number} params.periodYears - Number of years to calculate the domain price for. Must be at least 1.
57
+ * @param {RegistrationType} params.registrationType - Type of registration pricing to fetch. Allowed values: new, transfer, renewal, trade.
58
+ * @throws {AppwriteException}
59
+ * @returns {Promise<Models.DomainPrice>}
60
+ */
61
+ getPrice(params: {
62
+ domain: string;
63
+ periodYears?: number;
64
+ registrationType?: RegistrationType;
65
+ }): Promise<Models.DomainPrice>;
66
+ /**
67
+ * Get the registration price for a domain name.
68
+ *
69
+ * @param {string} domain - Domain name to get price for.
70
+ * @param {number} periodYears - Number of years to calculate the domain price for. Must be at least 1.
71
+ * @param {RegistrationType} registrationType - Type of registration pricing to fetch. Allowed values: new, transfer, renewal, trade.
72
+ * @throws {AppwriteException}
73
+ * @returns {Promise<Models.DomainPrice>}
74
+ * @deprecated Use the object parameter style method for a better developer experience.
75
+ */
76
+ getPrice(domain: string, periodYears?: number, registrationType?: RegistrationType): Promise<Models.DomainPrice>;
77
+ /**
78
+ * Initiate a domain purchase by providing registrant details and a payment method. Authorizes the payment and returns a `clientSecret`. If 3D Secure is required, use the `clientSecret` on the client to complete the authentication challenge. Once authentication is complete (or if none is needed), call the Update Purchase endpoint to capture the payment and finalize the purchase.
79
+ *
80
+ * @param {string} params.domain - Fully qualified domain name to purchase (for example, example.com).
81
+ * @param {string} params.organizationId - Team ID that will own the domain.
82
+ * @param {string} params.firstName - Registrant first name used for domain registration.
83
+ * @param {string} params.lastName - Registrant last name used for domain registration.
84
+ * @param {string} params.email - Registrant email address for registration and notices.
85
+ * @param {string} params.phone - Registrant phone number in E.164 format (for example, +15555551234).
86
+ * @param {string} params.billingAddressId - Billing address ID used for registration contact details.
87
+ * @param {string} params.paymentMethodId - Payment method ID to authorize and capture the purchase.
88
+ * @param {string} params.addressLine3 - Additional address line for the registrant (line 3).
89
+ * @param {string} params.companyName - Company or organization name for the registrant.
90
+ * @param {number} params.periodYears - Registration term in years (1-10).
91
+ * @param {boolean} params.autoRenewal - Whether the domain should renew automatically after purchase.
92
+ * @throws {AppwriteException}
93
+ * @returns {Promise<Models.DomainPurchase>}
94
+ */
95
+ createPurchase(params: {
96
+ domain: string;
97
+ organizationId: string;
98
+ firstName: string;
99
+ lastName: string;
100
+ email: string;
101
+ phone: string;
102
+ billingAddressId: string;
103
+ paymentMethodId: string;
104
+ addressLine3?: string;
105
+ companyName?: string;
106
+ periodYears?: number;
107
+ autoRenewal?: boolean;
108
+ }): Promise<Models.DomainPurchase>;
109
+ /**
110
+ * Initiate a domain purchase by providing registrant details and a payment method. Authorizes the payment and returns a `clientSecret`. If 3D Secure is required, use the `clientSecret` on the client to complete the authentication challenge. Once authentication is complete (or if none is needed), call the Update Purchase endpoint to capture the payment and finalize the purchase.
111
+ *
112
+ * @param {string} domain - Fully qualified domain name to purchase (for example, example.com).
113
+ * @param {string} organizationId - Team ID that will own the domain.
114
+ * @param {string} firstName - Registrant first name used for domain registration.
115
+ * @param {string} lastName - Registrant last name used for domain registration.
116
+ * @param {string} email - Registrant email address for registration and notices.
117
+ * @param {string} phone - Registrant phone number in E.164 format (for example, +15555551234).
118
+ * @param {string} billingAddressId - Billing address ID used for registration contact details.
119
+ * @param {string} paymentMethodId - Payment method ID to authorize and capture the purchase.
120
+ * @param {string} addressLine3 - Additional address line for the registrant (line 3).
121
+ * @param {string} companyName - Company or organization name for the registrant.
122
+ * @param {number} periodYears - Registration term in years (1-10).
123
+ * @param {boolean} autoRenewal - Whether the domain should renew automatically after purchase.
124
+ * @throws {AppwriteException}
125
+ * @returns {Promise<Models.DomainPurchase>}
126
+ * @deprecated Use the object parameter style method for a better developer experience.
127
+ */
128
+ createPurchase(domain: string, organizationId: string, firstName: string, lastName: string, email: string, phone: string, billingAddressId: string, paymentMethodId: string, addressLine3?: string, companyName?: string, periodYears?: number, autoRenewal?: boolean): Promise<Models.DomainPurchase>;
129
+ /**
130
+ * Finalize a domain purchase initiated with Create Purchase. Verifies that any required 3D Secure authentication is complete, registers the domain, captures the payment, and provisions default DNS records. Returns a 402 error if authentication is still pending.
131
+ *
132
+ * @param {string} params.domainId - Domain ID to confirm purchase for.
133
+ * @param {string} params.organizationId - Team ID that owns the domain.
134
+ * @throws {AppwriteException}
135
+ * @returns {Promise<Models.DomainPurchase>}
136
+ */
137
+ updatePurchase(params: {
138
+ domainId: string;
139
+ organizationId: string;
140
+ }): Promise<Models.DomainPurchase>;
141
+ /**
142
+ * Finalize a domain purchase initiated with Create Purchase. Verifies that any required 3D Secure authentication is complete, registers the domain, captures the payment, and provisions default DNS records. Returns a 402 error if authentication is still pending.
143
+ *
144
+ * @param {string} domainId - Domain ID to confirm purchase for.
145
+ * @param {string} organizationId - Team ID that owns the domain.
146
+ * @throws {AppwriteException}
147
+ * @returns {Promise<Models.DomainPurchase>}
148
+ * @deprecated Use the object parameter style method for a better developer experience.
149
+ */
150
+ updatePurchase(domainId: string, organizationId: string): Promise<Models.DomainPurchase>;
151
+ /**
152
+ * List domain suggestions.
153
+ *
154
+ * @param {string} params.query - Query to find available domains and suggestions. Max length: 256 chars.
155
+ * @param {string[]} params.tlds - TLDs to suggest.
156
+ * @param {number} params.limit - Maximum number of suggestions to return.
157
+ * @param {FilterType} params.filterType - Filter type: premium, suggestion.
158
+ * @param {number} params.priceMax - Filter premium domains by maximum price. Only premium domains at or below this price will be returned. Does not affect regular domain suggestions.
159
+ * @param {number} params.priceMin - Filter premium domains by minimum price. Only premium domains at or above this price will be returned. Does not affect regular domain suggestions.
160
+ * @throws {AppwriteException}
161
+ * @returns {Promise<Models.DomainSuggestionsList>}
162
+ */
163
+ listSuggestions(params: {
164
+ query: string;
165
+ tlds?: string[];
166
+ limit?: number;
167
+ filterType?: FilterType;
168
+ priceMax?: number;
169
+ priceMin?: number;
170
+ }): Promise<Models.DomainSuggestionsList>;
171
+ /**
172
+ * List domain suggestions.
173
+ *
174
+ * @param {string} query - Query to find available domains and suggestions. Max length: 256 chars.
175
+ * @param {string[]} tlds - TLDs to suggest.
176
+ * @param {number} limit - Maximum number of suggestions to return.
177
+ * @param {FilterType} filterType - Filter type: premium, suggestion.
178
+ * @param {number} priceMax - Filter premium domains by maximum price. Only premium domains at or below this price will be returned. Does not affect regular domain suggestions.
179
+ * @param {number} priceMin - Filter premium domains by minimum price. Only premium domains at or above this price will be returned. Does not affect regular domain suggestions.
180
+ * @throws {AppwriteException}
181
+ * @returns {Promise<Models.DomainSuggestionsList>}
182
+ * @deprecated Use the object parameter style method for a better developer experience.
183
+ */
184
+ listSuggestions(query: string, tlds?: string[], limit?: number, filterType?: FilterType, priceMax?: number, priceMin?: number): Promise<Models.DomainSuggestionsList>;
185
+ /**
186
+ * Initiate a domain transfer-in by providing an authorization code, registrant details, and a payment method. Authorizes the payment and returns a `clientSecret`. If 3D Secure is required, use the `clientSecret` on the client to complete the authentication challenge. Once authentication is complete (or if none is needed), call the Update Transfer In endpoint to capture the payment and submit the transfer.
187
+ *
188
+ * @param {string} params.domain - Domain name to transfer in.
189
+ * @param {string} params.organizationId - Organization ID that this domain will belong to.
190
+ * @param {string} params.authCode - Authorization code for the domain transfer.
191
+ * @param {string} params.paymentMethodId - Payment method ID to authorize and capture the transfer.
192
+ * @param {boolean} params.autoRenewal - Whether the domain should renew automatically after transfer.
193
+ * @throws {AppwriteException}
194
+ * @returns {Promise<Models.DomainPurchase>}
195
+ */
196
+ createTransferIn(params: {
197
+ domain: string;
198
+ organizationId: string;
199
+ authCode: string;
200
+ paymentMethodId: string;
201
+ autoRenewal?: boolean;
202
+ }): Promise<Models.DomainPurchase>;
203
+ /**
204
+ * Initiate a domain transfer-in by providing an authorization code, registrant details, and a payment method. Authorizes the payment and returns a `clientSecret`. If 3D Secure is required, use the `clientSecret` on the client to complete the authentication challenge. Once authentication is complete (or if none is needed), call the Update Transfer In endpoint to capture the payment and submit the transfer.
205
+ *
206
+ * @param {string} domain - Domain name to transfer in.
207
+ * @param {string} organizationId - Organization ID that this domain will belong to.
208
+ * @param {string} authCode - Authorization code for the domain transfer.
209
+ * @param {string} paymentMethodId - Payment method ID to authorize and capture the transfer.
210
+ * @param {boolean} autoRenewal - Whether the domain should renew automatically after transfer.
211
+ * @throws {AppwriteException}
212
+ * @returns {Promise<Models.DomainPurchase>}
213
+ * @deprecated Use the object parameter style method for a better developer experience.
214
+ */
215
+ createTransferIn(domain: string, organizationId: string, authCode: string, paymentMethodId: string, autoRenewal?: boolean): Promise<Models.DomainPurchase>;
216
+ /**
217
+ * Finalize a domain transfer-in initiated with Create Transfer In. Verifies that any required 3D Secure authentication is complete, submits the transfer with the authorization code, captures the payment, and sends a confirmation email. Returns a 402 error if authentication is still pending.
218
+ *
219
+ * @param {string} params.domainId - Domain ID to confirm transfer for.
220
+ * @param {string} params.organizationId - Team ID that owns the domain.
221
+ * @throws {AppwriteException}
222
+ * @returns {Promise<Models.DomainPurchase>}
223
+ */
224
+ updateTransferIn(params: {
225
+ domainId: string;
226
+ organizationId: string;
227
+ }): Promise<Models.DomainPurchase>;
228
+ /**
229
+ * Finalize a domain transfer-in initiated with Create Transfer In. Verifies that any required 3D Secure authentication is complete, submits the transfer with the authorization code, captures the payment, and sends a confirmation email. Returns a 402 error if authentication is still pending.
230
+ *
231
+ * @param {string} domainId - Domain ID to confirm transfer for.
232
+ * @param {string} organizationId - Team ID that owns the domain.
233
+ * @throws {AppwriteException}
234
+ * @returns {Promise<Models.DomainPurchase>}
235
+ * @deprecated Use the object parameter style method for a better developer experience.
236
+ */
237
+ updateTransferIn(domainId: string, organizationId: string): Promise<Models.DomainPurchase>;
238
+ /**
239
+ * Initiate a domain transfer-out by generating an authorization code for the specified domain. The returned `authCode` should be provided to the gaining provider to complete the transfer. If the domain has auto-renewal enabled, it will be automatically disabled as part of this operation.
240
+ *
241
+ * @param {string} params.domainId - Domain unique ID.
242
+ * @param {string} params.organizationId - Organization ID that this domain belongs to.
243
+ * @throws {AppwriteException}
244
+ * @returns {Promise<Models.DomainTransferOut>}
245
+ */
246
+ createTransferOut(params: {
247
+ domainId: string;
248
+ organizationId: string;
249
+ }): Promise<Models.DomainTransferOut>;
250
+ /**
251
+ * Initiate a domain transfer-out by generating an authorization code for the specified domain. The returned `authCode` should be provided to the gaining provider to complete the transfer. If the domain has auto-renewal enabled, it will be automatically disabled as part of this operation.
252
+ *
253
+ * @param {string} domainId - Domain unique ID.
254
+ * @param {string} organizationId - Organization ID that this domain belongs to.
255
+ * @throws {AppwriteException}
256
+ * @returns {Promise<Models.DomainTransferOut>}
257
+ * @deprecated Use the object parameter style method for a better developer experience.
258
+ */
259
+ createTransferOut(domainId: string, organizationId: string): Promise<Models.DomainTransferOut>;
260
+ /**
261
+ * Get a domain by its unique ID.
262
+ *
263
+ * @param {string} params.domainId - Domain unique ID.
264
+ * @throws {AppwriteException}
265
+ * @returns {Promise<Models.Domain>}
266
+ */
267
+ get(params: {
268
+ domainId: string;
269
+ }): Promise<Models.Domain>;
270
+ /**
271
+ * Get a domain by its unique ID.
272
+ *
273
+ * @param {string} domainId - Domain unique ID.
274
+ * @throws {AppwriteException}
275
+ * @returns {Promise<Models.Domain>}
276
+ * @deprecated Use the object parameter style method for a better developer experience.
277
+ */
278
+ get(domainId: string): Promise<Models.Domain>;
279
+ /**
280
+ * Delete a domain by its unique ID. This endpoint can be used to delete a domain from your project.
281
+ * Once deleted, the domain will no longer be available for use and all associated resources will be removed.
282
+ *
283
+ * @param {string} params.domainId - Domain unique ID.
284
+ * @throws {AppwriteException}
285
+ * @returns {Promise<{}>}
286
+ */
287
+ delete(params: {
288
+ domainId: string;
289
+ }): Promise<{}>;
290
+ /**
291
+ * Delete a domain by its unique ID. This endpoint can be used to delete a domain from your project.
292
+ * Once deleted, the domain will no longer be available for use and all associated resources will be removed.
293
+ *
294
+ * @param {string} domainId - Domain unique ID.
295
+ * @throws {AppwriteException}
296
+ * @returns {Promise<{}>}
297
+ * @deprecated Use the object parameter style method for a better developer experience.
298
+ */
299
+ delete(domainId: string): Promise<{}>;
300
+ /**
301
+ * Enable or disable auto-renewal for a domain.
302
+ *
303
+ * @param {string} params.domainId - Domain unique ID.
304
+ * @param {boolean} params.autoRenewal - Whether the domain should renew automatically.
305
+ * @throws {AppwriteException}
306
+ * @returns {Promise<Models.Domain>}
307
+ */
308
+ updateAutoRenewal(params: {
309
+ domainId: string;
310
+ autoRenewal: boolean;
311
+ }): Promise<Models.Domain>;
312
+ /**
313
+ * Enable or disable auto-renewal for a domain.
314
+ *
315
+ * @param {string} domainId - Domain unique ID.
316
+ * @param {boolean} autoRenewal - Whether the domain should renew automatically.
317
+ * @throws {AppwriteException}
318
+ * @returns {Promise<Models.Domain>}
319
+ * @deprecated Use the object parameter style method for a better developer experience.
320
+ */
321
+ updateAutoRenewal(domainId: string, autoRenewal: boolean): Promise<Models.Domain>;
322
+ /**
323
+ * Verify which NS records are used and update the domain accordingly. This will check the domain's
324
+ * nameservers and update the domain's status based on whether the nameservers match the expected
325
+ * Appwrite nameservers.
326
+ *
327
+ * @param {string} params.domainId - Domain unique ID.
328
+ * @throws {AppwriteException}
329
+ * @returns {Promise<Models.Domain>}
330
+ */
331
+ updateNameservers(params: {
332
+ domainId: string;
333
+ }): Promise<Models.Domain>;
334
+ /**
335
+ * Verify which NS records are used and update the domain accordingly. This will check the domain's
336
+ * nameservers and update the domain's status based on whether the nameservers match the expected
337
+ * Appwrite nameservers.
338
+ *
339
+ * @param {string} domainId - Domain unique ID.
340
+ * @throws {AppwriteException}
341
+ * @returns {Promise<Models.Domain>}
342
+ * @deprecated Use the object parameter style method for a better developer experience.
343
+ */
344
+ updateNameservers(domainId: string): Promise<Models.Domain>;
345
+ /**
346
+ * List Google Workspace DNS records.
347
+ *
348
+ * @param {string} params.domainId - Domain unique ID.
349
+ * @throws {AppwriteException}
350
+ * @returns {Promise<Models.DnsRecordsList>}
351
+ */
352
+ getPresetGoogleWorkspace(params: {
353
+ domainId: string;
354
+ }): Promise<Models.DnsRecordsList>;
355
+ /**
356
+ * List Google Workspace DNS records.
357
+ *
358
+ * @param {string} domainId - Domain unique ID.
359
+ * @throws {AppwriteException}
360
+ * @returns {Promise<Models.DnsRecordsList>}
361
+ * @deprecated Use the object parameter style method for a better developer experience.
362
+ */
363
+ getPresetGoogleWorkspace(domainId: string): Promise<Models.DnsRecordsList>;
364
+ /**
365
+ * Add Google Workspace DNS records to the domain. This will create the required MX records
366
+ * for Google Workspace email hosting.
367
+ *
368
+ * @param {string} params.domainId - Domain unique ID.
369
+ * @throws {AppwriteException}
370
+ * @returns {Promise<Models.DnsRecordsList>}
371
+ */
372
+ createPresetGoogleWorkspace(params: {
373
+ domainId: string;
374
+ }): Promise<Models.DnsRecordsList>;
375
+ /**
376
+ * Add Google Workspace DNS records to the domain. This will create the required MX records
377
+ * for Google Workspace email hosting.
378
+ *
379
+ * @param {string} domainId - Domain unique ID.
380
+ * @throws {AppwriteException}
381
+ * @returns {Promise<Models.DnsRecordsList>}
382
+ * @deprecated Use the object parameter style method for a better developer experience.
383
+ */
384
+ createPresetGoogleWorkspace(domainId: string): Promise<Models.DnsRecordsList>;
385
+ /**
386
+ * List iCloud DNS records.
387
+ *
388
+ * @param {string} params.domainId - Domain unique ID.
389
+ * @throws {AppwriteException}
390
+ * @returns {Promise<Models.DnsRecordsList>}
391
+ */
392
+ getPresetICloud(params: {
393
+ domainId: string;
394
+ }): Promise<Models.DnsRecordsList>;
395
+ /**
396
+ * List iCloud DNS records.
397
+ *
398
+ * @param {string} domainId - Domain unique ID.
399
+ * @throws {AppwriteException}
400
+ * @returns {Promise<Models.DnsRecordsList>}
401
+ * @deprecated Use the object parameter style method for a better developer experience.
402
+ */
403
+ getPresetICloud(domainId: string): Promise<Models.DnsRecordsList>;
404
+ /**
405
+ * Add iCloud DNS records to the domain. This will create the required MX and SPF records
406
+ * for using iCloud email services with your domain.
407
+ *
408
+ * @param {string} params.domainId - Domain unique ID.
409
+ * @throws {AppwriteException}
410
+ * @returns {Promise<Models.DnsRecordsList>}
411
+ */
412
+ createPresetICloud(params: {
413
+ domainId: string;
414
+ }): Promise<Models.DnsRecordsList>;
415
+ /**
416
+ * Add iCloud DNS records to the domain. This will create the required MX and SPF records
417
+ * for using iCloud email services with your domain.
418
+ *
419
+ * @param {string} domainId - Domain unique ID.
420
+ * @throws {AppwriteException}
421
+ * @returns {Promise<Models.DnsRecordsList>}
422
+ * @deprecated Use the object parameter style method for a better developer experience.
423
+ */
424
+ createPresetICloud(domainId: string): Promise<Models.DnsRecordsList>;
425
+ /**
426
+ * List Mailgun DNS records.
427
+ *
428
+ * @param {string} params.domainId - Domain unique ID.
429
+ * @throws {AppwriteException}
430
+ * @returns {Promise<Models.DnsRecordsList>}
431
+ */
432
+ getPresetMailgun(params: {
433
+ domainId: string;
434
+ }): Promise<Models.DnsRecordsList>;
435
+ /**
436
+ * List Mailgun DNS records.
437
+ *
438
+ * @param {string} domainId - Domain unique ID.
439
+ * @throws {AppwriteException}
440
+ * @returns {Promise<Models.DnsRecordsList>}
441
+ * @deprecated Use the object parameter style method for a better developer experience.
442
+ */
443
+ getPresetMailgun(domainId: string): Promise<Models.DnsRecordsList>;
444
+ /**
445
+ * Add Mailgun DNS records to the domain. This endpoint will create the required DNS records
446
+ * for Mailgun in the specified domain.
447
+ *
448
+ * @param {string} params.domainId - Domain unique ID.
449
+ * @throws {AppwriteException}
450
+ * @returns {Promise<Models.DnsRecordsList>}
451
+ */
452
+ createPresetMailgun(params: {
453
+ domainId: string;
454
+ }): Promise<Models.DnsRecordsList>;
455
+ /**
456
+ * Add Mailgun DNS records to the domain. This endpoint will create the required DNS records
457
+ * for Mailgun in the specified domain.
458
+ *
459
+ * @param {string} domainId - Domain unique ID.
460
+ * @throws {AppwriteException}
461
+ * @returns {Promise<Models.DnsRecordsList>}
462
+ * @deprecated Use the object parameter style method for a better developer experience.
463
+ */
464
+ createPresetMailgun(domainId: string): Promise<Models.DnsRecordsList>;
465
+ /**
466
+ * List Outlook DNS records.
467
+ *
468
+ * @param {string} params.domainId - Domain unique ID.
469
+ * @throws {AppwriteException}
470
+ * @returns {Promise<Models.DnsRecordsList>}
471
+ */
472
+ getPresetOutlook(params: {
473
+ domainId: string;
474
+ }): Promise<Models.DnsRecordsList>;
475
+ /**
476
+ * List Outlook DNS records.
477
+ *
478
+ * @param {string} domainId - Domain unique ID.
479
+ * @throws {AppwriteException}
480
+ * @returns {Promise<Models.DnsRecordsList>}
481
+ * @deprecated Use the object parameter style method for a better developer experience.
482
+ */
483
+ getPresetOutlook(domainId: string): Promise<Models.DnsRecordsList>;
484
+ /**
485
+ * Add Outlook DNS records to the domain. This will create the required MX records
486
+ * for setting up Outlook email hosting for your domain.
487
+ *
488
+ * @param {string} params.domainId - Domain unique ID.
489
+ * @throws {AppwriteException}
490
+ * @returns {Promise<Models.DnsRecordsList>}
491
+ */
492
+ createPresetOutlook(params: {
493
+ domainId: string;
494
+ }): Promise<Models.DnsRecordsList>;
495
+ /**
496
+ * Add Outlook DNS records to the domain. This will create the required MX records
497
+ * for setting up Outlook email hosting for your domain.
498
+ *
499
+ * @param {string} domainId - Domain unique ID.
500
+ * @throws {AppwriteException}
501
+ * @returns {Promise<Models.DnsRecordsList>}
502
+ * @deprecated Use the object parameter style method for a better developer experience.
503
+ */
504
+ createPresetOutlook(domainId: string): Promise<Models.DnsRecordsList>;
505
+ /**
506
+ * List ProtonMail DNS records.
507
+ *
508
+ * @param {string} params.domainId - Domain unique ID.
509
+ * @throws {AppwriteException}
510
+ * @returns {Promise<Models.DnsRecordsList>}
511
+ */
512
+ getPresetProtonMail(params: {
513
+ domainId: string;
514
+ }): Promise<Models.DnsRecordsList>;
515
+ /**
516
+ * List ProtonMail DNS records.
517
+ *
518
+ * @param {string} domainId - Domain unique ID.
519
+ * @throws {AppwriteException}
520
+ * @returns {Promise<Models.DnsRecordsList>}
521
+ * @deprecated Use the object parameter style method for a better developer experience.
522
+ */
523
+ getPresetProtonMail(domainId: string): Promise<Models.DnsRecordsList>;
524
+ /**
525
+ * Add ProtonMail DNS records to the domain. This will create the required MX records
526
+ * for using ProtonMail with your custom domain.
527
+ *
528
+ * @param {string} params.domainId - Domain unique ID.
529
+ * @throws {AppwriteException}
530
+ * @returns {Promise<Models.DnsRecordsList>}
531
+ */
532
+ createPresetProtonMail(params: {
533
+ domainId: string;
534
+ }): Promise<Models.DnsRecordsList>;
535
+ /**
536
+ * Add ProtonMail DNS records to the domain. This will create the required MX records
537
+ * for using ProtonMail with your custom domain.
538
+ *
539
+ * @param {string} domainId - Domain unique ID.
540
+ * @throws {AppwriteException}
541
+ * @returns {Promise<Models.DnsRecordsList>}
542
+ * @deprecated Use the object parameter style method for a better developer experience.
543
+ */
544
+ createPresetProtonMail(domainId: string): Promise<Models.DnsRecordsList>;
545
+ /**
546
+ * List Zoho DNS records.
547
+ *
548
+ * @param {string} params.domainId - Domain unique ID.
549
+ * @throws {AppwriteException}
550
+ * @returns {Promise<Models.DnsRecordsList>}
551
+ */
552
+ getPresetZoho(params: {
553
+ domainId: string;
554
+ }): Promise<Models.DnsRecordsList>;
555
+ /**
556
+ * List Zoho DNS records.
557
+ *
558
+ * @param {string} domainId - Domain unique ID.
559
+ * @throws {AppwriteException}
560
+ * @returns {Promise<Models.DnsRecordsList>}
561
+ * @deprecated Use the object parameter style method for a better developer experience.
562
+ */
563
+ getPresetZoho(domainId: string): Promise<Models.DnsRecordsList>;
564
+ /**
565
+ * Add Zoho Mail DNS records to the domain. This will create the required MX records
566
+ * for setting up Zoho Mail on your domain.
567
+ *
568
+ * @param {string} params.domainId - Domain unique ID.
569
+ * @throws {AppwriteException}
570
+ * @returns {Promise<Models.DnsRecordsList>}
571
+ */
572
+ createPresetZoho(params: {
573
+ domainId: string;
574
+ }): Promise<Models.DnsRecordsList>;
575
+ /**
576
+ * Add Zoho Mail DNS records to the domain. This will create the required MX records
577
+ * for setting up Zoho Mail on your domain.
578
+ *
579
+ * @param {string} domainId - Domain unique ID.
580
+ * @throws {AppwriteException}
581
+ * @returns {Promise<Models.DnsRecordsList>}
582
+ * @deprecated Use the object parameter style method for a better developer experience.
583
+ */
584
+ createPresetZoho(domainId: string): Promise<Models.DnsRecordsList>;
585
+ /**
586
+ * List DNS records for a given domain. You can use this endpoint to list all the DNS records
587
+ * associated with your domain.
588
+ *
589
+ * @param {string} params.domainId - Domain unique ID.
590
+ * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. You may filter on attributes such as type, name, value, etc. Maximum of 100 queries are allowed, each 4096 characters long.
591
+ * @throws {AppwriteException}
592
+ * @returns {Promise<Models.DnsRecordsList>}
593
+ */
594
+ listRecords(params: {
595
+ domainId: string;
596
+ queries?: string[];
597
+ }): Promise<Models.DnsRecordsList>;
598
+ /**
599
+ * List DNS records for a given domain. You can use this endpoint to list all the DNS records
600
+ * associated with your domain.
601
+ *
602
+ * @param {string} domainId - Domain unique ID.
603
+ * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. You may filter on attributes such as type, name, value, etc. Maximum of 100 queries are allowed, each 4096 characters long.
604
+ * @throws {AppwriteException}
605
+ * @returns {Promise<Models.DnsRecordsList>}
606
+ * @deprecated Use the object parameter style method for a better developer experience.
607
+ */
608
+ listRecords(domainId: string, queries?: string[]): Promise<Models.DnsRecordsList>;
609
+ /**
610
+ * Create a new A record for the given domain. A records are used to point a domain name
611
+ * to an IPv4 address. The record value should be a valid IPv4 address.
612
+ *
613
+ * @param {string} params.domainId - Domain unique ID.
614
+ * @param {string} params.name - Record name (subdomain).
615
+ * @param {string} params.value - IPv4 address for this A record.
616
+ * @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
617
+ * @param {string} params.comment - A comment explaining what this record is for.
618
+ * @throws {AppwriteException}
619
+ * @returns {Promise<Models.DnsRecord>}
620
+ */
621
+ createRecordA(params: {
622
+ domainId: string;
623
+ name: string;
624
+ value: string;
625
+ ttl: number;
626
+ comment?: string;
627
+ }): Promise<Models.DnsRecord>;
628
+ /**
629
+ * Create a new A record for the given domain. A records are used to point a domain name
630
+ * to an IPv4 address. The record value should be a valid IPv4 address.
631
+ *
632
+ * @param {string} domainId - Domain unique ID.
633
+ * @param {string} name - Record name (subdomain).
634
+ * @param {string} value - IPv4 address for this A record.
635
+ * @param {number} ttl - Time to live, in seconds. Must be greater than 0.
636
+ * @param {string} comment - A comment explaining what this record is for.
637
+ * @throws {AppwriteException}
638
+ * @returns {Promise<Models.DnsRecord>}
639
+ * @deprecated Use the object parameter style method for a better developer experience.
640
+ */
641
+ createRecordA(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
642
+ /**
643
+ * Update an existing A record for the given domain. This endpoint allows you to modify
644
+ * the properties of an A record including its name (subdomain), IPv4 address, TTL,
645
+ * and optional comment.
646
+ *
647
+ * @param {string} params.domainId - Domain unique ID.
648
+ * @param {string} params.recordId - DNS record unique ID.
649
+ * @param {string} params.name - Record name (subdomain).
650
+ * @param {string} params.value - IPv4 address for this A record.
651
+ * @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
652
+ * @param {string} params.comment - A comment explaining what this record is for.
653
+ * @throws {AppwriteException}
654
+ * @returns {Promise<Models.DnsRecord>}
655
+ */
656
+ updateRecordA(params: {
657
+ domainId: string;
658
+ recordId: string;
659
+ name: string;
660
+ value: string;
661
+ ttl: number;
662
+ comment?: string;
663
+ }): Promise<Models.DnsRecord>;
664
+ /**
665
+ * Update an existing A record for the given domain. This endpoint allows you to modify
666
+ * the properties of an A record including its name (subdomain), IPv4 address, TTL,
667
+ * and optional comment.
668
+ *
669
+ * @param {string} domainId - Domain unique ID.
670
+ * @param {string} recordId - DNS record unique ID.
671
+ * @param {string} name - Record name (subdomain).
672
+ * @param {string} value - IPv4 address for this A record.
673
+ * @param {number} ttl - Time to live, in seconds. Must be greater than 0.
674
+ * @param {string} comment - A comment explaining what this record is for.
675
+ * @throws {AppwriteException}
676
+ * @returns {Promise<Models.DnsRecord>}
677
+ * @deprecated Use the object parameter style method for a better developer experience.
678
+ */
679
+ updateRecordA(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
680
+ /**
681
+ * Create a new AAAA record for the given domain. This endpoint allows you to add a new IPv6 DNS record
682
+ * to your domain. The record will be used to point a hostname to an IPv6 address.
683
+ *
684
+ * @param {string} params.domainId - Domain unique ID.
685
+ * @param {string} params.name - Record name (subdomain).
686
+ * @param {string} params.value - IPv6 address for this AAAA record.
687
+ * @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
688
+ * @param {string} params.comment - A comment explaining what this record is for.
689
+ * @throws {AppwriteException}
690
+ * @returns {Promise<Models.DnsRecord>}
691
+ */
692
+ createRecordAAAA(params: {
693
+ domainId: string;
694
+ name: string;
695
+ value: string;
696
+ ttl: number;
697
+ comment?: string;
698
+ }): Promise<Models.DnsRecord>;
699
+ /**
700
+ * Create a new AAAA record for the given domain. This endpoint allows you to add a new IPv6 DNS record
701
+ * to your domain. The record will be used to point a hostname to an IPv6 address.
702
+ *
703
+ * @param {string} domainId - Domain unique ID.
704
+ * @param {string} name - Record name (subdomain).
705
+ * @param {string} value - IPv6 address for this AAAA record.
706
+ * @param {number} ttl - Time to live, in seconds. Must be greater than 0.
707
+ * @param {string} comment - A comment explaining what this record is for.
708
+ * @throws {AppwriteException}
709
+ * @returns {Promise<Models.DnsRecord>}
710
+ * @deprecated Use the object parameter style method for a better developer experience.
711
+ */
712
+ createRecordAAAA(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
713
+ /**
714
+ * Update an existing AAAA record for the given domain. This endpoint allows you to modify
715
+ * the properties of an existing AAAA record, including its name (subdomain), IPv6 address,
716
+ * TTL, and optional comment.
717
+ *
718
+ * @param {string} params.domainId - Domain unique ID.
719
+ * @param {string} params.recordId - DNS record unique ID.
720
+ * @param {string} params.name - Record name (subdomain).
721
+ * @param {string} params.value - IPv6 address for this AAAA record.
722
+ * @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
723
+ * @param {string} params.comment - A comment for this record.
724
+ * @throws {AppwriteException}
725
+ * @returns {Promise<Models.DnsRecord>}
726
+ */
727
+ updateRecordAAAA(params: {
728
+ domainId: string;
729
+ recordId: string;
730
+ name: string;
731
+ value: string;
732
+ ttl: number;
733
+ comment?: string;
734
+ }): Promise<Models.DnsRecord>;
735
+ /**
736
+ * Update an existing AAAA record for the given domain. This endpoint allows you to modify
737
+ * the properties of an existing AAAA record, including its name (subdomain), IPv6 address,
738
+ * TTL, and optional comment.
739
+ *
740
+ * @param {string} domainId - Domain unique ID.
741
+ * @param {string} recordId - DNS record unique ID.
742
+ * @param {string} name - Record name (subdomain).
743
+ * @param {string} value - IPv6 address for this AAAA record.
744
+ * @param {number} ttl - Time to live, in seconds. Must be greater than 0.
745
+ * @param {string} comment - A comment for this record.
746
+ * @throws {AppwriteException}
747
+ * @returns {Promise<Models.DnsRecord>}
748
+ * @deprecated Use the object parameter style method for a better developer experience.
749
+ */
750
+ updateRecordAAAA(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
751
+ /**
752
+ * Create a new ALIAS record for the given domain. This record type can be used to point your domain
753
+ * to another domain name that will serve as an alias. This is particularly useful when you want to
754
+ * map your domain to a target domain that may change its IP address.
755
+ *
756
+ * @param {string} params.domainId - Domain unique ID.
757
+ * @param {string} params.name - Record name.
758
+ * @param {string} params.value - Target domain for this ALIAS record.
759
+ * @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
760
+ * @param {string} params.comment - A comment for this record.
761
+ * @throws {AppwriteException}
762
+ * @returns {Promise<Models.DnsRecord>}
763
+ */
764
+ createRecordAlias(params: {
765
+ domainId: string;
766
+ name: string;
767
+ value: string;
768
+ ttl: number;
769
+ comment?: string;
770
+ }): Promise<Models.DnsRecord>;
771
+ /**
772
+ * Create a new ALIAS record for the given domain. This record type can be used to point your domain
773
+ * to another domain name that will serve as an alias. This is particularly useful when you want to
774
+ * map your domain to a target domain that may change its IP address.
775
+ *
776
+ * @param {string} domainId - Domain unique ID.
777
+ * @param {string} name - Record name.
778
+ * @param {string} value - Target domain for this ALIAS record.
779
+ * @param {number} ttl - Time to live, in seconds. Must be greater than 0.
780
+ * @param {string} comment - A comment for this record.
781
+ * @throws {AppwriteException}
782
+ * @returns {Promise<Models.DnsRecord>}
783
+ * @deprecated Use the object parameter style method for a better developer experience.
784
+ */
785
+ createRecordAlias(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
786
+ /**
787
+ * Update an existing ALIAS record for the specified domain. This endpoint allows you to modify
788
+ * the properties of an existing ALIAS record including its name, target domain, TTL, and comment.
789
+ *
790
+ * The ALIAS record type is similar to a CNAME record but can be used at the zone apex (root domain).
791
+ * It provides a way to map one domain name to another.
792
+ *
793
+ * @param {string} params.domainId - Domain unique ID.
794
+ * @param {string} params.recordId - DNS record unique ID.
795
+ * @param {string} params.name - Record name.
796
+ * @param {string} params.value - Target domain for this ALIAS record.
797
+ * @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
798
+ * @param {string} params.comment - A comment for this record.
799
+ * @throws {AppwriteException}
800
+ * @returns {Promise<Models.DnsRecord>}
801
+ */
802
+ updateRecordAlias(params: {
803
+ domainId: string;
804
+ recordId: string;
805
+ name: string;
806
+ value: string;
807
+ ttl: number;
808
+ comment?: string;
809
+ }): Promise<Models.DnsRecord>;
810
+ /**
811
+ * Update an existing ALIAS record for the specified domain. This endpoint allows you to modify
812
+ * the properties of an existing ALIAS record including its name, target domain, TTL, and comment.
813
+ *
814
+ * The ALIAS record type is similar to a CNAME record but can be used at the zone apex (root domain).
815
+ * It provides a way to map one domain name to another.
816
+ *
817
+ * @param {string} domainId - Domain unique ID.
818
+ * @param {string} recordId - DNS record unique ID.
819
+ * @param {string} name - Record name.
820
+ * @param {string} value - Target domain for this ALIAS record.
821
+ * @param {number} ttl - Time to live, in seconds. Must be greater than 0.
822
+ * @param {string} comment - A comment for this record.
823
+ * @throws {AppwriteException}
824
+ * @returns {Promise<Models.DnsRecord>}
825
+ * @deprecated Use the object parameter style method for a better developer experience.
826
+ */
827
+ updateRecordAlias(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
828
+ /**
829
+ * Create a new CAA record for the given domain. CAA records are used to specify which
830
+ * Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your domain.
831
+ *
832
+ * @param {string} params.domainId - Domain unique ID.
833
+ * @param {string} params.name - Record name.
834
+ * @param {string} params.value - CAA value (e.g. issuer domain).
835
+ * @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
836
+ * @param {string} params.comment - A comment for this record.
837
+ * @throws {AppwriteException}
838
+ * @returns {Promise<Models.DnsRecord>}
839
+ */
840
+ createRecordCAA(params: {
841
+ domainId: string;
842
+ name: string;
843
+ value: string;
844
+ ttl: number;
845
+ comment?: string;
846
+ }): Promise<Models.DnsRecord>;
847
+ /**
848
+ * Create a new CAA record for the given domain. CAA records are used to specify which
849
+ * Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your domain.
850
+ *
851
+ * @param {string} domainId - Domain unique ID.
852
+ * @param {string} name - Record name.
853
+ * @param {string} value - CAA value (e.g. issuer domain).
854
+ * @param {number} ttl - Time to live, in seconds. Must be greater than 0.
855
+ * @param {string} comment - A comment for this record.
856
+ * @throws {AppwriteException}
857
+ * @returns {Promise<Models.DnsRecord>}
858
+ * @deprecated Use the object parameter style method for a better developer experience.
859
+ */
860
+ createRecordCAA(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
861
+ /**
862
+ * Update an existing CAA record for the given domain. A CAA (Certification Authority Authorization)
863
+ * record is used to specify which certificate authorities (CAs) are authorized to issue certificates
864
+ * for a domain.
865
+ *
866
+ * @param {string} params.domainId - Domain unique ID.
867
+ * @param {string} params.recordId - DNS record unique ID.
868
+ * @param {string} params.name - Record name.
869
+ * @param {string} params.value - CAA value (e.g. issuer domain).
870
+ * @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
871
+ * @param {string} params.comment - A comment for this record.
872
+ * @throws {AppwriteException}
873
+ * @returns {Promise<Models.DnsRecord>}
874
+ */
875
+ updateRecordCAA(params: {
876
+ domainId: string;
877
+ recordId: string;
878
+ name: string;
879
+ value: string;
880
+ ttl: number;
881
+ comment?: string;
882
+ }): Promise<Models.DnsRecord>;
883
+ /**
884
+ * Update an existing CAA record for the given domain. A CAA (Certification Authority Authorization)
885
+ * record is used to specify which certificate authorities (CAs) are authorized to issue certificates
886
+ * for a domain.
887
+ *
888
+ * @param {string} domainId - Domain unique ID.
889
+ * @param {string} recordId - DNS record unique ID.
890
+ * @param {string} name - Record name.
891
+ * @param {string} value - CAA value (e.g. issuer domain).
892
+ * @param {number} ttl - Time to live, in seconds. Must be greater than 0.
893
+ * @param {string} comment - A comment for this record.
894
+ * @throws {AppwriteException}
895
+ * @returns {Promise<Models.DnsRecord>}
896
+ * @deprecated Use the object parameter style method for a better developer experience.
897
+ */
898
+ updateRecordCAA(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
899
+ /**
900
+ * Create a new CNAME record for the given domain.
901
+ *
902
+ * A CNAME record maps a subdomain to another domain name, allowing you to create aliases
903
+ * for your domain. For example, you can create a CNAME record to point 'blog.example.com'
904
+ * to 'example.wordpress.com'.
905
+ *
906
+ * @param {string} params.domainId - Domain unique ID.
907
+ * @param {string} params.name - Record name (subdomain).
908
+ * @param {string} params.value - Canonical target for this CNAME record.
909
+ * @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
910
+ * @param {string} params.comment - A comment for this record.
911
+ * @throws {AppwriteException}
912
+ * @returns {Promise<Models.DnsRecord>}
913
+ */
914
+ createRecordCNAME(params: {
915
+ domainId: string;
916
+ name: string;
917
+ value: string;
918
+ ttl: number;
919
+ comment?: string;
920
+ }): Promise<Models.DnsRecord>;
921
+ /**
922
+ * Create a new CNAME record for the given domain.
923
+ *
924
+ * A CNAME record maps a subdomain to another domain name, allowing you to create aliases
925
+ * for your domain. For example, you can create a CNAME record to point 'blog.example.com'
926
+ * to 'example.wordpress.com'.
927
+ *
928
+ * @param {string} domainId - Domain unique ID.
929
+ * @param {string} name - Record name (subdomain).
930
+ * @param {string} value - Canonical target for this CNAME record.
931
+ * @param {number} ttl - Time to live, in seconds. Must be greater than 0.
932
+ * @param {string} comment - A comment for this record.
933
+ * @throws {AppwriteException}
934
+ * @returns {Promise<Models.DnsRecord>}
935
+ * @deprecated Use the object parameter style method for a better developer experience.
936
+ */
937
+ createRecordCNAME(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
938
+ /**
939
+ * Update an existing CNAME record for the given domain.
940
+ *
941
+ * @param {string} params.domainId - Domain unique ID.
942
+ * @param {string} params.recordId - DNS record unique ID.
943
+ * @param {string} params.name - Record name (subdomain).
944
+ * @param {string} params.value - Canonical target for this CNAME record.
945
+ * @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
946
+ * @param {string} params.comment - A comment for this record.
947
+ * @throws {AppwriteException}
948
+ * @returns {Promise<Models.DnsRecord>}
949
+ */
950
+ updateRecordCNAME(params: {
951
+ domainId: string;
952
+ recordId: string;
953
+ name: string;
954
+ value: string;
955
+ ttl: number;
956
+ comment?: string;
957
+ }): Promise<Models.DnsRecord>;
958
+ /**
959
+ * Update an existing CNAME record for the given domain.
960
+ *
961
+ * @param {string} domainId - Domain unique ID.
962
+ * @param {string} recordId - DNS record unique ID.
963
+ * @param {string} name - Record name (subdomain).
964
+ * @param {string} value - Canonical target for this CNAME record.
965
+ * @param {number} ttl - Time to live, in seconds. Must be greater than 0.
966
+ * @param {string} comment - A comment for this record.
967
+ * @throws {AppwriteException}
968
+ * @returns {Promise<Models.DnsRecord>}
969
+ * @deprecated Use the object parameter style method for a better developer experience.
970
+ */
971
+ updateRecordCNAME(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
972
+ /**
973
+ * Create a new HTTPS record for the given domain. This record is used to configure HTTPS
974
+ * settings for your domain, enabling secure communication over SSL/TLS.
975
+ *
976
+ * @param {string} params.domainId - Domain unique ID.
977
+ * @param {string} params.name - Record name (subdomain).
978
+ * @param {string} params.value - Target for the HTTPS record.
979
+ * @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
980
+ * @param {string} params.comment - A comment for this record.
981
+ * @throws {AppwriteException}
982
+ * @returns {Promise<Models.DnsRecord>}
983
+ */
984
+ createRecordHTTPS(params: {
985
+ domainId: string;
986
+ name: string;
987
+ value: string;
988
+ ttl: number;
989
+ comment?: string;
990
+ }): Promise<Models.DnsRecord>;
991
+ /**
992
+ * Create a new HTTPS record for the given domain. This record is used to configure HTTPS
993
+ * settings for your domain, enabling secure communication over SSL/TLS.
994
+ *
995
+ * @param {string} domainId - Domain unique ID.
996
+ * @param {string} name - Record name (subdomain).
997
+ * @param {string} value - Target for the HTTPS record.
998
+ * @param {number} ttl - Time to live, in seconds. Must be greater than 0.
999
+ * @param {string} comment - A comment for this record.
1000
+ * @throws {AppwriteException}
1001
+ * @returns {Promise<Models.DnsRecord>}
1002
+ * @deprecated Use the object parameter style method for a better developer experience.
1003
+ */
1004
+ createRecordHTTPS(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
1005
+ /**
1006
+ * Update an existing HTTPS record for the given domain. This endpoint allows you to modify
1007
+ * the properties of an HTTPS record associated with your domain, including the name (subdomain),
1008
+ * target value, TTL, and optional comment.
1009
+ *
1010
+ * @param {string} params.domainId - Domain unique ID.
1011
+ * @param {string} params.recordId - DNS record unique ID.
1012
+ * @param {string} params.name - Record name (subdomain).
1013
+ * @param {string} params.value - Target for the HTTPS record.
1014
+ * @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
1015
+ * @param {string} params.comment - A comment for this record.
1016
+ * @throws {AppwriteException}
1017
+ * @returns {Promise<Models.DnsRecord>}
1018
+ */
1019
+ updateRecordHTTPS(params: {
1020
+ domainId: string;
1021
+ recordId: string;
1022
+ name: string;
1023
+ value: string;
1024
+ ttl: number;
1025
+ comment?: string;
1026
+ }): Promise<Models.DnsRecord>;
1027
+ /**
1028
+ * Update an existing HTTPS record for the given domain. This endpoint allows you to modify
1029
+ * the properties of an HTTPS record associated with your domain, including the name (subdomain),
1030
+ * target value, TTL, and optional comment.
1031
+ *
1032
+ * @param {string} domainId - Domain unique ID.
1033
+ * @param {string} recordId - DNS record unique ID.
1034
+ * @param {string} name - Record name (subdomain).
1035
+ * @param {string} value - Target for the HTTPS record.
1036
+ * @param {number} ttl - Time to live, in seconds. Must be greater than 0.
1037
+ * @param {string} comment - A comment for this record.
1038
+ * @throws {AppwriteException}
1039
+ * @returns {Promise<Models.DnsRecord>}
1040
+ * @deprecated Use the object parameter style method for a better developer experience.
1041
+ */
1042
+ updateRecordHTTPS(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
1043
+ /**
1044
+ * Create a new MX record for the given domain. MX records are used to define the mail servers responsible
1045
+ * for accepting email messages for the domain. Multiple MX records can be created with different priorities.
1046
+ * The priority parameter determines the order in which mail servers are used, with lower values indicating
1047
+ * higher priority.
1048
+ *
1049
+ * @param {string} params.domainId - Domain unique ID.
1050
+ * @param {string} params.name - Record name (subdomain).
1051
+ * @param {string} params.value - Mail server domain for this MX record.
1052
+ * @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
1053
+ * @param {number} params.priority - MX priority.
1054
+ * @param {string} params.comment - A comment for this record.
1055
+ * @throws {AppwriteException}
1056
+ * @returns {Promise<Models.DnsRecord>}
1057
+ */
1058
+ createRecordMX(params: {
1059
+ domainId: string;
1060
+ name: string;
1061
+ value: string;
1062
+ ttl: number;
1063
+ priority: number;
1064
+ comment?: string;
1065
+ }): Promise<Models.DnsRecord>;
1066
+ /**
1067
+ * Create a new MX record for the given domain. MX records are used to define the mail servers responsible
1068
+ * for accepting email messages for the domain. Multiple MX records can be created with different priorities.
1069
+ * The priority parameter determines the order in which mail servers are used, with lower values indicating
1070
+ * higher priority.
1071
+ *
1072
+ * @param {string} domainId - Domain unique ID.
1073
+ * @param {string} name - Record name (subdomain).
1074
+ * @param {string} value - Mail server domain for this MX record.
1075
+ * @param {number} ttl - Time to live, in seconds. Must be greater than 0.
1076
+ * @param {number} priority - MX priority.
1077
+ * @param {string} comment - A comment for this record.
1078
+ * @throws {AppwriteException}
1079
+ * @returns {Promise<Models.DnsRecord>}
1080
+ * @deprecated Use the object parameter style method for a better developer experience.
1081
+ */
1082
+ createRecordMX(domainId: string, name: string, value: string, ttl: number, priority: number, comment?: string): Promise<Models.DnsRecord>;
1083
+ /**
1084
+ * Update an existing MX record for the given domain.
1085
+ *
1086
+ * @param {string} params.domainId - Domain unique ID.
1087
+ * @param {string} params.recordId - DNS record unique ID.
1088
+ * @param {string} params.name - Record name (subdomain).
1089
+ * @param {string} params.value - Mail server domain for this MX record.
1090
+ * @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
1091
+ * @param {number} params.priority - MX priority.
1092
+ * @param {string} params.comment - A comment for this record.
1093
+ * @throws {AppwriteException}
1094
+ * @returns {Promise<Models.DnsRecord>}
1095
+ */
1096
+ updateRecordMX(params: {
1097
+ domainId: string;
1098
+ recordId: string;
1099
+ name: string;
1100
+ value: string;
1101
+ ttl: number;
1102
+ priority: number;
1103
+ comment?: string;
1104
+ }): Promise<Models.DnsRecord>;
1105
+ /**
1106
+ * Update an existing MX record for the given domain.
1107
+ *
1108
+ * @param {string} domainId - Domain unique ID.
1109
+ * @param {string} recordId - DNS record unique ID.
1110
+ * @param {string} name - Record name (subdomain).
1111
+ * @param {string} value - Mail server domain for this MX record.
1112
+ * @param {number} ttl - Time to live, in seconds. Must be greater than 0.
1113
+ * @param {number} priority - MX priority.
1114
+ * @param {string} comment - A comment for this record.
1115
+ * @throws {AppwriteException}
1116
+ * @returns {Promise<Models.DnsRecord>}
1117
+ * @deprecated Use the object parameter style method for a better developer experience.
1118
+ */
1119
+ updateRecordMX(domainId: string, recordId: string, name: string, value: string, ttl: number, priority: number, comment?: string): Promise<Models.DnsRecord>;
1120
+ /**
1121
+ * Create a new NS record for the given domain. NS records specify the nameservers that are used
1122
+ * to resolve the domain name to IP addresses. Each domain can have multiple NS records.
1123
+ *
1124
+ * @param {string} params.domainId - Domain unique ID.
1125
+ * @param {string} params.name - Record name (subdomain).
1126
+ * @param {string} params.value - Nameserver target for this NS record.
1127
+ * @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
1128
+ * @param {string} params.comment - A comment for this record.
1129
+ * @throws {AppwriteException}
1130
+ * @returns {Promise<Models.DnsRecord>}
1131
+ */
1132
+ createRecordNS(params: {
1133
+ domainId: string;
1134
+ name: string;
1135
+ value: string;
1136
+ ttl: number;
1137
+ comment?: string;
1138
+ }): Promise<Models.DnsRecord>;
1139
+ /**
1140
+ * Create a new NS record for the given domain. NS records specify the nameservers that are used
1141
+ * to resolve the domain name to IP addresses. Each domain can have multiple NS records.
1142
+ *
1143
+ * @param {string} domainId - Domain unique ID.
1144
+ * @param {string} name - Record name (subdomain).
1145
+ * @param {string} value - Nameserver target for this NS record.
1146
+ * @param {number} ttl - Time to live, in seconds. Must be greater than 0.
1147
+ * @param {string} comment - A comment for this record.
1148
+ * @throws {AppwriteException}
1149
+ * @returns {Promise<Models.DnsRecord>}
1150
+ * @deprecated Use the object parameter style method for a better developer experience.
1151
+ */
1152
+ createRecordNS(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
1153
+ /**
1154
+ * Update an existing NS record for the given domain. This endpoint allows you to modify
1155
+ * the properties of an NS (nameserver) record associated with your domain. You can update
1156
+ * the record name (subdomain), target nameserver value, TTL, and add or modify comments
1157
+ * for better record management.
1158
+ *
1159
+ * @param {string} params.domainId - Domain unique ID.
1160
+ * @param {string} params.recordId - DNS record unique ID.
1161
+ * @param {string} params.name - Record name (subdomain).
1162
+ * @param {string} params.value - Nameserver target for this NS record.
1163
+ * @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
1164
+ * @param {string} params.comment - A comment for this record.
1165
+ * @throws {AppwriteException}
1166
+ * @returns {Promise<Models.DnsRecord>}
1167
+ */
1168
+ updateRecordNS(params: {
1169
+ domainId: string;
1170
+ recordId: string;
1171
+ name: string;
1172
+ value: string;
1173
+ ttl: number;
1174
+ comment?: string;
1175
+ }): Promise<Models.DnsRecord>;
1176
+ /**
1177
+ * Update an existing NS record for the given domain. This endpoint allows you to modify
1178
+ * the properties of an NS (nameserver) record associated with your domain. You can update
1179
+ * the record name (subdomain), target nameserver value, TTL, and add or modify comments
1180
+ * for better record management.
1181
+ *
1182
+ * @param {string} domainId - Domain unique ID.
1183
+ * @param {string} recordId - DNS record unique ID.
1184
+ * @param {string} name - Record name (subdomain).
1185
+ * @param {string} value - Nameserver target for this NS record.
1186
+ * @param {number} ttl - Time to live, in seconds. Must be greater than 0.
1187
+ * @param {string} comment - A comment for this record.
1188
+ * @throws {AppwriteException}
1189
+ * @returns {Promise<Models.DnsRecord>}
1190
+ * @deprecated Use the object parameter style method for a better developer experience.
1191
+ */
1192
+ updateRecordNS(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
1193
+ /**
1194
+ * Create a new SRV record for the given domain. SRV records are used to define the location
1195
+ * of servers for specific services. For example, they can be used to specify which server
1196
+ * handles a specific service like SIP or XMPP for the domain.
1197
+ *
1198
+ * @param {string} params.domainId - Domain unique ID.
1199
+ * @param {string} params.name - Record name (service name).
1200
+ * @param {string} params.value - Target hostname for this SRV record.
1201
+ * @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
1202
+ * @param {number} params.priority - Record priority.
1203
+ * @param {number} params.weight - Record weight.
1204
+ * @param {number} params.port - Port number for the service.
1205
+ * @param {string} params.comment - A comment for this record.
1206
+ * @throws {AppwriteException}
1207
+ * @returns {Promise<Models.DnsRecord>}
1208
+ */
1209
+ createRecordSRV(params: {
1210
+ domainId: string;
1211
+ name: string;
1212
+ value: string;
1213
+ ttl: number;
1214
+ priority: number;
1215
+ weight: number;
1216
+ port: number;
1217
+ comment?: string;
1218
+ }): Promise<Models.DnsRecord>;
1219
+ /**
1220
+ * Create a new SRV record for the given domain. SRV records are used to define the location
1221
+ * of servers for specific services. For example, they can be used to specify which server
1222
+ * handles a specific service like SIP or XMPP for the domain.
1223
+ *
1224
+ * @param {string} domainId - Domain unique ID.
1225
+ * @param {string} name - Record name (service name).
1226
+ * @param {string} value - Target hostname for this SRV record.
1227
+ * @param {number} ttl - Time to live, in seconds. Must be greater than 0.
1228
+ * @param {number} priority - Record priority.
1229
+ * @param {number} weight - Record weight.
1230
+ * @param {number} port - Port number for the service.
1231
+ * @param {string} comment - A comment for this record.
1232
+ * @throws {AppwriteException}
1233
+ * @returns {Promise<Models.DnsRecord>}
1234
+ * @deprecated Use the object parameter style method for a better developer experience.
1235
+ */
1236
+ createRecordSRV(domainId: string, name: string, value: string, ttl: number, priority: number, weight: number, port: number, comment?: string): Promise<Models.DnsRecord>;
1237
+ /**
1238
+ * Update an existing SRV record for the given domain.
1239
+ *
1240
+ * Required parameters:
1241
+ * - domainId: Domain unique ID
1242
+ * - recordId: DNS record unique ID
1243
+ * - name: Record name (service name)
1244
+ * - value: Target hostname for this SRV record
1245
+ * - ttl: Time to live, in seconds
1246
+ * - priority: Record priority
1247
+ * - weight: Record weight
1248
+ * - port: Port number for the service
1249
+ *
1250
+ * Optional parameters:
1251
+ * - comment: A comment for this record
1252
+ *
1253
+ * @param {string} params.domainId - Domain unique ID.
1254
+ * @param {string} params.recordId - DNS record unique ID.
1255
+ * @param {string} params.name - Record name (service name).
1256
+ * @param {string} params.value - Target hostname for this SRV record.
1257
+ * @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
1258
+ * @param {number} params.priority - Record priority.
1259
+ * @param {number} params.weight - Record weight.
1260
+ * @param {number} params.port - Port number for the service.
1261
+ * @param {string} params.comment - A comment for this record.
1262
+ * @throws {AppwriteException}
1263
+ * @returns {Promise<Models.DnsRecord>}
1264
+ */
1265
+ updateRecordSRV(params: {
1266
+ domainId: string;
1267
+ recordId: string;
1268
+ name: string;
1269
+ value: string;
1270
+ ttl: number;
1271
+ priority: number;
1272
+ weight: number;
1273
+ port: number;
1274
+ comment?: string;
1275
+ }): Promise<Models.DnsRecord>;
1276
+ /**
1277
+ * Update an existing SRV record for the given domain.
1278
+ *
1279
+ * Required parameters:
1280
+ * - domainId: Domain unique ID
1281
+ * - recordId: DNS record unique ID
1282
+ * - name: Record name (service name)
1283
+ * - value: Target hostname for this SRV record
1284
+ * - ttl: Time to live, in seconds
1285
+ * - priority: Record priority
1286
+ * - weight: Record weight
1287
+ * - port: Port number for the service
1288
+ *
1289
+ * Optional parameters:
1290
+ * - comment: A comment for this record
1291
+ *
1292
+ * @param {string} domainId - Domain unique ID.
1293
+ * @param {string} recordId - DNS record unique ID.
1294
+ * @param {string} name - Record name (service name).
1295
+ * @param {string} value - Target hostname for this SRV record.
1296
+ * @param {number} ttl - Time to live, in seconds. Must be greater than 0.
1297
+ * @param {number} priority - Record priority.
1298
+ * @param {number} weight - Record weight.
1299
+ * @param {number} port - Port number for the service.
1300
+ * @param {string} comment - A comment for this record.
1301
+ * @throws {AppwriteException}
1302
+ * @returns {Promise<Models.DnsRecord>}
1303
+ * @deprecated Use the object parameter style method for a better developer experience.
1304
+ */
1305
+ updateRecordSRV(domainId: string, recordId: string, name: string, value: string, ttl: number, priority: number, weight: number, port: number, comment?: string): Promise<Models.DnsRecord>;
1306
+ /**
1307
+ * Create a new TXT record for the given domain. TXT records can be used
1308
+ * to provide additional information about your domain, such as domain
1309
+ * verification records, SPF records, or DKIM records.
1310
+ *
1311
+ * @param {string} params.domainId - Domain unique ID.
1312
+ * @param {string} params.name - Record name (subdomain) for the TXT record.
1313
+ * @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
1314
+ * @param {string} params.value - TXT record value.
1315
+ * @param {string} params.comment - A comment for this record.
1316
+ * @throws {AppwriteException}
1317
+ * @returns {Promise<Models.DnsRecord>}
1318
+ */
1319
+ createRecordTXT(params: {
1320
+ domainId: string;
1321
+ name: string;
1322
+ ttl: number;
1323
+ value?: string;
1324
+ comment?: string;
1325
+ }): Promise<Models.DnsRecord>;
1326
+ /**
1327
+ * Create a new TXT record for the given domain. TXT records can be used
1328
+ * to provide additional information about your domain, such as domain
1329
+ * verification records, SPF records, or DKIM records.
1330
+ *
1331
+ * @param {string} domainId - Domain unique ID.
1332
+ * @param {string} name - Record name (subdomain) for the TXT record.
1333
+ * @param {number} ttl - Time to live, in seconds. Must be greater than 0.
1334
+ * @param {string} value - TXT record value.
1335
+ * @param {string} comment - A comment for this record.
1336
+ * @throws {AppwriteException}
1337
+ * @returns {Promise<Models.DnsRecord>}
1338
+ * @deprecated Use the object parameter style method for a better developer experience.
1339
+ */
1340
+ createRecordTXT(domainId: string, name: string, ttl: number, value?: string, comment?: string): Promise<Models.DnsRecord>;
1341
+ /**
1342
+ * Update an existing TXT record for the given domain.
1343
+ *
1344
+ * Update the TXT record details for a specific domain by providing the domain ID,
1345
+ * record ID, and the new record configuration including name, value, TTL, and an optional comment.
1346
+ *
1347
+ * @param {string} params.domainId - Domain unique ID.
1348
+ * @param {string} params.recordId - DNS record unique ID.
1349
+ * @param {string} params.name - Record name (subdomain) for the TXT record.
1350
+ * @param {string} params.value - TXT record value.
1351
+ * @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
1352
+ * @param {string} params.comment - A comment for this record.
1353
+ * @throws {AppwriteException}
1354
+ * @returns {Promise<Models.DnsRecord>}
1355
+ */
1356
+ updateRecordTXT(params: {
1357
+ domainId: string;
1358
+ recordId: string;
1359
+ name: string;
1360
+ value: string;
1361
+ ttl: number;
1362
+ comment?: string;
1363
+ }): Promise<Models.DnsRecord>;
1364
+ /**
1365
+ * Update an existing TXT record for the given domain.
1366
+ *
1367
+ * Update the TXT record details for a specific domain by providing the domain ID,
1368
+ * record ID, and the new record configuration including name, value, TTL, and an optional comment.
1369
+ *
1370
+ * @param {string} domainId - Domain unique ID.
1371
+ * @param {string} recordId - DNS record unique ID.
1372
+ * @param {string} name - Record name (subdomain) for the TXT record.
1373
+ * @param {string} value - TXT record value.
1374
+ * @param {number} ttl - Time to live, in seconds. Must be greater than 0.
1375
+ * @param {string} comment - A comment for this record.
1376
+ * @throws {AppwriteException}
1377
+ * @returns {Promise<Models.DnsRecord>}
1378
+ * @deprecated Use the object parameter style method for a better developer experience.
1379
+ */
1380
+ updateRecordTXT(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
1381
+ /**
1382
+ * Get a single DNS record for a given domain by record ID.
1383
+ *
1384
+ * This endpoint allows you to retrieve a specific DNS record associated with a domain
1385
+ * using its unique identifier. The record contains information about the DNS configuration
1386
+ * such as type, value, and TTL settings.
1387
+ *
1388
+ * @param {string} params.domainId - Domain unique ID.
1389
+ * @param {string} params.recordId - DNS record unique ID.
1390
+ * @throws {AppwriteException}
1391
+ * @returns {Promise<Models.DnsRecord>}
1392
+ */
1393
+ getRecord(params: {
1394
+ domainId: string;
1395
+ recordId: string;
1396
+ }): Promise<Models.DnsRecord>;
1397
+ /**
1398
+ * Get a single DNS record for a given domain by record ID.
1399
+ *
1400
+ * This endpoint allows you to retrieve a specific DNS record associated with a domain
1401
+ * using its unique identifier. The record contains information about the DNS configuration
1402
+ * such as type, value, and TTL settings.
1403
+ *
1404
+ * @param {string} domainId - Domain unique ID.
1405
+ * @param {string} recordId - DNS record unique ID.
1406
+ * @throws {AppwriteException}
1407
+ * @returns {Promise<Models.DnsRecord>}
1408
+ * @deprecated Use the object parameter style method for a better developer experience.
1409
+ */
1410
+ getRecord(domainId: string, recordId: string): Promise<Models.DnsRecord>;
1411
+ /**
1412
+ * Delete a DNS record for the given domain. This endpoint allows you to delete an existing DNS record
1413
+ * from a specific domain.
1414
+ *
1415
+ * @param {string} params.domainId - Domain unique ID.
1416
+ * @param {string} params.recordId - DNS record unique ID.
1417
+ * @throws {AppwriteException}
1418
+ * @returns {Promise<{}>}
1419
+ */
1420
+ deleteRecord(params: {
1421
+ domainId: string;
1422
+ recordId: string;
1423
+ }): Promise<{}>;
1424
+ /**
1425
+ * Delete a DNS record for the given domain. This endpoint allows you to delete an existing DNS record
1426
+ * from a specific domain.
1427
+ *
1428
+ * @param {string} domainId - Domain unique ID.
1429
+ * @param {string} recordId - DNS record unique ID.
1430
+ * @throws {AppwriteException}
1431
+ * @returns {Promise<{}>}
1432
+ * @deprecated Use the object parameter style method for a better developer experience.
1433
+ */
1434
+ deleteRecord(domainId: string, recordId: string): Promise<{}>;
1435
+ /**
1436
+ * Update the team ID for a specific domain. This endpoint requires admin access.
1437
+ *
1438
+ * Updating the team ID will transfer ownership and access control of the domain
1439
+ * and all its DNS records to the new team.
1440
+ *
1441
+ * @param {string} params.domainId - Domain unique ID.
1442
+ * @param {string} params.teamId - New team unique ID.
1443
+ * @throws {AppwriteException}
1444
+ * @returns {Promise<Models.Domain>}
1445
+ */
1446
+ updateTeam(params: {
1447
+ domainId: string;
1448
+ teamId: string;
1449
+ }): Promise<Models.Domain>;
1450
+ /**
1451
+ * Update the team ID for a specific domain. This endpoint requires admin access.
1452
+ *
1453
+ * Updating the team ID will transfer ownership and access control of the domain
1454
+ * and all its DNS records to the new team.
1455
+ *
1456
+ * @param {string} domainId - Domain unique ID.
1457
+ * @param {string} teamId - New team unique ID.
1458
+ * @throws {AppwriteException}
1459
+ * @returns {Promise<Models.Domain>}
1460
+ * @deprecated Use the object parameter style method for a better developer experience.
1461
+ */
1462
+ updateTeam(domainId: string, teamId: string): Promise<Models.Domain>;
1463
+ /**
1464
+ * Retrieve the current transfer status for a domain. Returns the status, an optional reason, and a timestamp of the last status change.
1465
+ *
1466
+ * @param {string} params.domainId - Domain unique ID.
1467
+ * @throws {AppwriteException}
1468
+ * @returns {Promise<Models.DomainTransferStatus>}
1469
+ */
1470
+ getTransferStatus(params: {
1471
+ domainId: string;
1472
+ }): Promise<Models.DomainTransferStatus>;
1473
+ /**
1474
+ * Retrieve the current transfer status for a domain. Returns the status, an optional reason, and a timestamp of the last status change.
1475
+ *
1476
+ * @param {string} domainId - Domain unique ID.
1477
+ * @throws {AppwriteException}
1478
+ * @returns {Promise<Models.DomainTransferStatus>}
1479
+ * @deprecated Use the object parameter style method for a better developer experience.
1480
+ */
1481
+ getTransferStatus(domainId: string): Promise<Models.DomainTransferStatus>;
1482
+ /**
1483
+ * Retrieve the DNS zone file for the given domain. This endpoint will return the DNS
1484
+ * zone file in a standardized format that can be used to configure DNS servers.
1485
+ *
1486
+ * @param {string} params.domainId - Domain unique ID.
1487
+ * @throws {AppwriteException}
1488
+ * @returns {Promise<{}>}
1489
+ */
1490
+ getZone(params: {
1491
+ domainId: string;
1492
+ }): Promise<{}>;
1493
+ /**
1494
+ * Retrieve the DNS zone file for the given domain. This endpoint will return the DNS
1495
+ * zone file in a standardized format that can be used to configure DNS servers.
1496
+ *
1497
+ * @param {string} domainId - Domain unique ID.
1498
+ * @throws {AppwriteException}
1499
+ * @returns {Promise<{}>}
1500
+ * @deprecated Use the object parameter style method for a better developer experience.
1501
+ */
1502
+ getZone(domainId: string): Promise<{}>;
1503
+ /**
1504
+ * Update the DNS zone for the given domain using the provided zone file content.
1505
+ * All parsed records are imported and then the main domain document is returned.
1506
+ *
1507
+ * @param {string} params.domainId - Domain unique ID.
1508
+ * @param {string} params.content - DNS zone file content as a string.
1509
+ * @throws {AppwriteException}
1510
+ * @returns {Promise<Models.Domain>}
1511
+ */
1512
+ updateZone(params: {
1513
+ domainId: string;
1514
+ content: string;
1515
+ }): Promise<Models.Domain>;
1516
+ /**
1517
+ * Update the DNS zone for the given domain using the provided zone file content.
1518
+ * All parsed records are imported and then the main domain document is returned.
1519
+ *
1520
+ * @param {string} domainId - Domain unique ID.
1521
+ * @param {string} content - DNS zone file content as a string.
1522
+ * @throws {AppwriteException}
1523
+ * @returns {Promise<Models.Domain>}
1524
+ * @deprecated Use the object parameter style method for a better developer experience.
1525
+ */
1526
+ updateZone(domainId: string, content: string): Promise<Models.Domain>;
1527
+ }