@appwrite.io/console 1.10.0 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (745) hide show
  1. package/.github/workflows/publish.yml +9 -8
  2. package/CHANGELOG.md +6 -0
  3. package/LICENSE +1 -1
  4. package/README.md +4 -4
  5. package/dist/cjs/sdk.js +15239 -6070
  6. package/dist/cjs/sdk.js.map +1 -1
  7. package/dist/esm/sdk.js +15237 -6071
  8. package/dist/esm/sdk.js.map +1 -1
  9. package/dist/iife/sdk.js +15239 -6070
  10. package/docs/examples/account/create-billing-address.md +8 -8
  11. package/docs/examples/account/create-email-password-session.md +4 -4
  12. package/docs/examples/account/create-email-token.md +5 -5
  13. package/docs/examples/account/{update-magic-u-r-l-session.md → create-email-verification.md} +3 -4
  14. package/docs/examples/account/{update-m-f-a.md → create-jwt.md} +3 -3
  15. package/docs/examples/account/{create-magic-u-r-l-token.md → create-magic-url-token.md} +6 -6
  16. package/docs/examples/account/create-mfa-authenticator.md +3 -3
  17. package/docs/examples/account/create-mfa-challenge.md +3 -3
  18. package/docs/examples/account/create-mfa-recovery-codes.md +1 -1
  19. package/docs/examples/account/{create-o-auth2token.md → create-o-auth-2-session.md} +6 -6
  20. package/docs/examples/account/{create-o-auth2session.md → create-o-auth-2-token.md} +6 -6
  21. package/docs/examples/account/create-phone-token.md +4 -4
  22. package/docs/examples/account/create-push-target.md +5 -5
  23. package/docs/examples/account/create-recovery.md +4 -4
  24. package/docs/examples/account/create-session.md +4 -4
  25. package/docs/examples/account/create-verification.md +3 -3
  26. package/docs/examples/account/create.md +6 -6
  27. package/docs/examples/account/delete-billing-address.md +3 -3
  28. package/docs/examples/account/delete-identity.md +3 -3
  29. package/docs/examples/account/delete-mfa-authenticator.md +3 -3
  30. package/docs/examples/account/delete-payment-method.md +3 -3
  31. package/docs/examples/account/delete-push-target.md +3 -3
  32. package/docs/examples/account/delete-session.md +3 -3
  33. package/docs/examples/account/get-billing-address.md +3 -3
  34. package/docs/examples/account/get-coupon.md +3 -3
  35. package/docs/examples/account/get-mfa-recovery-codes.md +1 -1
  36. package/docs/examples/account/get-payment-method.md +3 -3
  37. package/docs/examples/account/get-session.md +3 -3
  38. package/docs/examples/account/list-billing-addresses.md +3 -3
  39. package/docs/examples/account/list-identities.md +4 -3
  40. package/docs/examples/account/list-invoices.md +3 -3
  41. package/docs/examples/account/list-logs.md +4 -3
  42. package/docs/examples/account/list-mfa-factors.md +1 -1
  43. package/docs/examples/account/list-payment-methods.md +3 -3
  44. package/docs/examples/account/update-billing-address.md +9 -9
  45. package/docs/examples/account/update-email-verification.md +14 -0
  46. package/docs/examples/account/update-email.md +4 -4
  47. package/docs/examples/account/update-magic-url-session.md +14 -0
  48. package/docs/examples/account/update-mfa-authenticator.md +4 -4
  49. package/docs/examples/account/update-mfa-challenge.md +4 -4
  50. package/docs/examples/account/update-mfa-recovery-codes.md +1 -1
  51. package/docs/examples/account/{create-j-w-t.md → update-mfa.md} +3 -1
  52. package/docs/examples/account/update-name.md +3 -3
  53. package/docs/examples/account/update-password.md +4 -4
  54. package/docs/examples/account/update-payment-method-mandate-options.md +3 -3
  55. package/docs/examples/account/update-payment-method-provider.md +6 -5
  56. package/docs/examples/account/update-payment-method.md +6 -5
  57. package/docs/examples/account/update-phone-session.md +4 -4
  58. package/docs/examples/account/update-phone-verification.md +4 -4
  59. package/docs/examples/account/update-phone.md +4 -4
  60. package/docs/examples/account/update-prefs.md +7 -3
  61. package/docs/examples/account/update-push-target.md +4 -4
  62. package/docs/examples/account/update-recovery.md +5 -5
  63. package/docs/examples/account/update-session.md +3 -3
  64. package/docs/examples/account/update-verification.md +4 -4
  65. package/docs/examples/assistant/chat.md +3 -3
  66. package/docs/examples/avatars/get-browser.md +6 -6
  67. package/docs/examples/avatars/get-credit-card.md +6 -6
  68. package/docs/examples/avatars/get-favicon.md +3 -3
  69. package/docs/examples/avatars/get-flag.md +6 -6
  70. package/docs/examples/avatars/get-image.md +5 -5
  71. package/docs/examples/avatars/get-initials.md +6 -6
  72. package/docs/examples/avatars/{get-q-r.md → get-qr.md} +6 -6
  73. package/docs/examples/avatars/get-screenshot.md +35 -0
  74. package/docs/examples/backups/create-archive.md +4 -4
  75. package/docs/examples/backups/create-policy.md +9 -9
  76. package/docs/examples/backups/create-restoration.md +6 -6
  77. package/docs/examples/backups/delete-archive.md +3 -3
  78. package/docs/examples/backups/delete-policy.md +3 -3
  79. package/docs/examples/backups/get-archive.md +3 -3
  80. package/docs/examples/backups/get-policy.md +3 -3
  81. package/docs/examples/backups/get-restoration.md +3 -3
  82. package/docs/examples/backups/list-archives.md +3 -3
  83. package/docs/examples/backups/list-policies.md +3 -3
  84. package/docs/examples/backups/list-restorations.md +3 -3
  85. package/docs/examples/backups/update-policy.md +7 -7
  86. package/docs/examples/console/create-program-membership.md +3 -3
  87. package/docs/examples/console/create-source.md +7 -7
  88. package/docs/examples/console/get-campaign.md +3 -3
  89. package/docs/examples/console/get-coupon.md +3 -3
  90. package/docs/examples/console/{plans.md → get-plan.md} +3 -1
  91. package/docs/examples/console/get-plans.md +13 -0
  92. package/docs/examples/console/{regions.md → get-program.md} +3 -1
  93. package/docs/examples/console/get-regions.md +13 -0
  94. package/docs/examples/console/get-resource.md +4 -4
  95. package/docs/examples/console/suggest-columns.md +17 -0
  96. package/docs/examples/console/suggest-indexes.md +16 -0
  97. package/docs/examples/databases/create-boolean-attribute.md +8 -8
  98. package/docs/examples/databases/create-collection.md +11 -9
  99. package/docs/examples/databases/create-datetime-attribute.md +8 -8
  100. package/docs/examples/databases/create-document.md +15 -8
  101. package/docs/examples/databases/create-documents.md +6 -5
  102. package/docs/examples/databases/create-email-attribute.md +8 -8
  103. package/docs/examples/databases/create-enum-attribute.md +9 -9
  104. package/docs/examples/databases/create-float-attribute.md +10 -10
  105. package/docs/examples/databases/create-index.md +9 -9
  106. package/docs/examples/databases/create-integer-attribute.md +10 -10
  107. package/docs/examples/databases/create-ip-attribute.md +8 -8
  108. package/docs/examples/databases/create-line-attribute.md +17 -0
  109. package/docs/examples/databases/create-operations.md +24 -0
  110. package/docs/examples/databases/create-point-attribute.md +17 -0
  111. package/docs/examples/databases/create-polygon-attribute.md +17 -0
  112. package/docs/examples/databases/create-relationship-attribute.md +10 -10
  113. package/docs/examples/databases/create-string-attribute.md +10 -10
  114. package/docs/examples/databases/create-transaction.md +13 -0
  115. package/docs/examples/databases/create-url-attribute.md +8 -8
  116. package/docs/examples/databases/create.md +5 -5
  117. package/docs/examples/databases/decrement-document-attribute.md +9 -8
  118. package/docs/examples/databases/delete-attribute.md +5 -5
  119. package/docs/examples/databases/delete-collection.md +4 -4
  120. package/docs/examples/databases/delete-document.md +6 -5
  121. package/docs/examples/databases/delete-documents.md +6 -5
  122. package/docs/examples/databases/delete-index.md +5 -5
  123. package/docs/examples/databases/{get-database-usage.md → delete-transaction.md} +4 -5
  124. package/docs/examples/databases/delete.md +3 -3
  125. package/docs/examples/databases/get-attribute.md +5 -5
  126. package/docs/examples/databases/get-collection-usage.md +6 -6
  127. package/docs/examples/databases/get-collection.md +4 -4
  128. package/docs/examples/databases/get-document.md +7 -6
  129. package/docs/examples/databases/get-index.md +5 -5
  130. package/docs/examples/databases/get-transaction.md +13 -0
  131. package/docs/examples/databases/get-usage.md +5 -4
  132. package/docs/examples/databases/get.md +3 -3
  133. package/docs/examples/databases/increment-document-attribute.md +9 -8
  134. package/docs/examples/databases/list-attributes.md +6 -5
  135. package/docs/examples/databases/list-collection-logs.md +5 -5
  136. package/docs/examples/databases/list-collections.md +6 -5
  137. package/docs/examples/databases/list-document-logs.md +6 -6
  138. package/docs/examples/databases/list-documents.md +7 -5
  139. package/docs/examples/databases/list-indexes.md +6 -5
  140. package/docs/examples/databases/list-logs.md +4 -4
  141. package/docs/examples/databases/list-transactions.md +13 -0
  142. package/docs/examples/databases/list-usage.md +13 -0
  143. package/docs/examples/databases/list.md +5 -4
  144. package/docs/examples/databases/update-boolean-attribute.md +8 -8
  145. package/docs/examples/databases/update-collection.md +9 -9
  146. package/docs/examples/databases/update-datetime-attribute.md +8 -8
  147. package/docs/examples/databases/update-document.md +15 -8
  148. package/docs/examples/databases/update-documents.md +13 -6
  149. package/docs/examples/databases/update-email-attribute.md +8 -8
  150. package/docs/examples/databases/update-enum-attribute.md +9 -9
  151. package/docs/examples/databases/update-float-attribute.md +10 -10
  152. package/docs/examples/databases/update-integer-attribute.md +10 -10
  153. package/docs/examples/databases/update-ip-attribute.md +8 -8
  154. package/docs/examples/databases/update-line-attribute.md +18 -0
  155. package/docs/examples/databases/update-point-attribute.md +18 -0
  156. package/docs/examples/databases/update-polygon-attribute.md +18 -0
  157. package/docs/examples/databases/update-relationship-attribute.md +7 -7
  158. package/docs/examples/databases/update-string-attribute.md +9 -9
  159. package/docs/examples/databases/update-transaction.md +15 -0
  160. package/docs/examples/databases/update-url-attribute.md +8 -8
  161. package/docs/examples/databases/update.md +5 -5
  162. package/docs/examples/databases/upsert-document.md +15 -8
  163. package/docs/examples/databases/upsert-documents.md +6 -5
  164. package/docs/examples/domains/create-preset-google-workspace.md +3 -3
  165. package/docs/examples/domains/create-preset-i-cloud.md +3 -3
  166. package/docs/examples/domains/create-preset-mailgun.md +3 -3
  167. package/docs/examples/domains/create-preset-outlook.md +3 -3
  168. package/docs/examples/domains/create-preset-proton-mail.md +3 -3
  169. package/docs/examples/domains/create-preset-zoho.md +3 -3
  170. package/docs/examples/domains/create-record-a.md +7 -7
  171. package/docs/examples/domains/{create-record-a-a-a-a.md → create-record-aaaa.md} +7 -7
  172. package/docs/examples/domains/create-record-alias.md +7 -7
  173. package/docs/examples/domains/{create-record-n-s.md → create-record-caa.md} +7 -7
  174. package/docs/examples/domains/{create-record-c-a-a.md → create-record-cname.md} +7 -7
  175. package/docs/examples/domains/{create-record-h-t-t-p-s.md → create-record-https.md} +7 -7
  176. package/docs/examples/domains/create-record-mx.md +18 -0
  177. package/docs/examples/domains/create-record-ns.md +17 -0
  178. package/docs/examples/domains/create-record-srv.md +20 -0
  179. package/docs/examples/domains/{create-record-c-n-a-m-e.md → create-record-txt.md} +7 -7
  180. package/docs/examples/domains/create.md +4 -4
  181. package/docs/examples/domains/delete-record.md +4 -4
  182. package/docs/examples/domains/delete.md +3 -3
  183. package/docs/examples/domains/get-preset-google-workspace.md +3 -3
  184. package/docs/examples/domains/get-preset-i-cloud.md +3 -3
  185. package/docs/examples/domains/get-preset-mailgun.md +3 -3
  186. package/docs/examples/domains/get-preset-outlook.md +3 -3
  187. package/docs/examples/domains/get-preset-proton-mail.md +3 -3
  188. package/docs/examples/domains/get-preset-zoho.md +3 -3
  189. package/docs/examples/domains/get-record.md +4 -4
  190. package/docs/examples/domains/get-zone.md +3 -3
  191. package/docs/examples/domains/get.md +3 -3
  192. package/docs/examples/domains/list-records.md +4 -4
  193. package/docs/examples/domains/list.md +4 -4
  194. package/docs/examples/domains/update-nameservers.md +3 -3
  195. package/docs/examples/domains/update-record-a.md +8 -8
  196. package/docs/examples/domains/update-record-aaaa.md +18 -0
  197. package/docs/examples/domains/update-record-alias.md +8 -8
  198. package/docs/examples/domains/update-record-caa.md +18 -0
  199. package/docs/examples/domains/update-record-cname.md +18 -0
  200. package/docs/examples/domains/update-record-https.md +18 -0
  201. package/docs/examples/domains/update-record-mx.md +19 -0
  202. package/docs/examples/domains/update-record-ns.md +18 -0
  203. package/docs/examples/domains/update-record-srv.md +21 -0
  204. package/docs/examples/domains/update-record-txt.md +18 -0
  205. package/docs/examples/domains/update-team.md +4 -4
  206. package/docs/examples/domains/update-zone.md +4 -4
  207. package/docs/examples/functions/create-deployment.md +7 -7
  208. package/docs/examples/functions/create-duplicate-deployment.md +5 -5
  209. package/docs/examples/functions/create-execution.md +9 -9
  210. package/docs/examples/functions/create-template-deployment.md +10 -9
  211. package/docs/examples/functions/create-variable.md +6 -6
  212. package/docs/examples/functions/create-vcs-deployment.md +7 -7
  213. package/docs/examples/functions/create.md +21 -21
  214. package/docs/examples/functions/delete-deployment.md +4 -4
  215. package/docs/examples/functions/delete-execution.md +4 -4
  216. package/docs/examples/functions/delete-variable.md +4 -4
  217. package/docs/examples/functions/delete.md +3 -3
  218. package/docs/examples/functions/get-deployment-download.md +5 -5
  219. package/docs/examples/functions/get-deployment.md +4 -4
  220. package/docs/examples/functions/get-execution.md +4 -4
  221. package/docs/examples/functions/get-template.md +3 -3
  222. package/docs/examples/functions/get-usage.md +5 -5
  223. package/docs/examples/functions/get-variable.md +4 -4
  224. package/docs/examples/functions/get.md +3 -3
  225. package/docs/examples/functions/list-deployments.md +6 -5
  226. package/docs/examples/functions/list-executions.md +5 -4
  227. package/docs/examples/functions/list-templates.md +7 -6
  228. package/docs/examples/functions/list-usage.md +4 -4
  229. package/docs/examples/functions/list-variables.md +3 -3
  230. package/docs/examples/functions/list.md +5 -4
  231. package/docs/examples/functions/update-deployment-status.md +4 -4
  232. package/docs/examples/functions/update-function-deployment.md +4 -4
  233. package/docs/examples/functions/update-variable.md +7 -7
  234. package/docs/examples/functions/update.md +21 -21
  235. package/docs/examples/graphql/mutation.md +3 -3
  236. package/docs/examples/graphql/query.md +3 -3
  237. package/docs/examples/health/get-certificate.md +3 -3
  238. package/docs/examples/health/get-failed-jobs.md +5 -5
  239. package/docs/examples/health/get-queue-billing-project-aggregation.md +3 -3
  240. package/docs/examples/health/get-queue-billing-team-aggregation.md +3 -3
  241. package/docs/examples/health/get-queue-builds.md +3 -3
  242. package/docs/examples/health/get-queue-certificates.md +3 -3
  243. package/docs/examples/health/get-queue-databases.md +4 -4
  244. package/docs/examples/health/get-queue-deletes.md +3 -3
  245. package/docs/examples/health/get-queue-functions.md +3 -3
  246. package/docs/examples/health/get-queue-logs.md +3 -3
  247. package/docs/examples/health/get-queue-mails.md +3 -3
  248. package/docs/examples/health/get-queue-messaging.md +3 -3
  249. package/docs/examples/health/get-queue-migrations.md +3 -3
  250. package/docs/examples/health/get-queue-priority-builds.md +3 -3
  251. package/docs/examples/health/get-queue-region-manager.md +3 -3
  252. package/docs/examples/health/get-queue-stats-resources.md +3 -3
  253. package/docs/examples/health/get-queue-threats.md +13 -0
  254. package/docs/examples/health/get-queue-usage.md +3 -3
  255. package/docs/examples/health/get-queue-webhooks.md +3 -3
  256. package/docs/examples/messaging/create-apns-provider.md +10 -10
  257. package/docs/examples/messaging/create-email.md +14 -14
  258. package/docs/examples/messaging/create-fcm-provider.md +6 -6
  259. package/docs/examples/messaging/create-mailgun-provider.md +12 -12
  260. package/docs/examples/messaging/{create-msg91provider.md → create-msg-91-provider.md} +8 -8
  261. package/docs/examples/messaging/create-push.md +21 -21
  262. package/docs/examples/messaging/create-resend-provider.md +20 -0
  263. package/docs/examples/messaging/create-sendgrid-provider.md +10 -10
  264. package/docs/examples/messaging/create-sms.md +9 -9
  265. package/docs/examples/messaging/create-smtp-provider.md +16 -16
  266. package/docs/examples/messaging/create-subscriber.md +5 -5
  267. package/docs/examples/messaging/create-telesign-provider.md +8 -8
  268. package/docs/examples/messaging/create-textmagic-provider.md +8 -8
  269. package/docs/examples/messaging/create-topic.md +5 -5
  270. package/docs/examples/messaging/create-twilio-provider.md +8 -8
  271. package/docs/examples/messaging/create-vonage-provider.md +8 -8
  272. package/docs/examples/messaging/delete-provider.md +3 -3
  273. package/docs/examples/messaging/delete-subscriber.md +4 -4
  274. package/docs/examples/messaging/delete-topic.md +3 -3
  275. package/docs/examples/messaging/delete.md +3 -3
  276. package/docs/examples/messaging/get-message.md +3 -3
  277. package/docs/examples/messaging/get-provider.md +3 -3
  278. package/docs/examples/messaging/get-subscriber.md +4 -4
  279. package/docs/examples/messaging/get-topic.md +3 -3
  280. package/docs/examples/messaging/list-message-logs.md +5 -4
  281. package/docs/examples/messaging/list-messages.md +5 -4
  282. package/docs/examples/messaging/list-provider-logs.md +5 -4
  283. package/docs/examples/messaging/list-providers.md +5 -4
  284. package/docs/examples/messaging/list-subscriber-logs.md +5 -4
  285. package/docs/examples/messaging/list-subscribers.md +6 -5
  286. package/docs/examples/messaging/list-targets.md +5 -4
  287. package/docs/examples/messaging/list-topic-logs.md +5 -4
  288. package/docs/examples/messaging/list-topics.md +5 -4
  289. package/docs/examples/messaging/update-apns-provider.md +10 -10
  290. package/docs/examples/messaging/update-email.md +14 -14
  291. package/docs/examples/messaging/update-fcm-provider.md +6 -6
  292. package/docs/examples/messaging/update-mailgun-provider.md +12 -12
  293. package/docs/examples/messaging/{update-msg91provider.md → update-msg-91-provider.md} +8 -8
  294. package/docs/examples/messaging/update-push.md +21 -21
  295. package/docs/examples/messaging/update-resend-provider.md +20 -0
  296. package/docs/examples/messaging/update-sendgrid-provider.md +10 -10
  297. package/docs/examples/messaging/update-sms.md +9 -9
  298. package/docs/examples/messaging/update-smtp-provider.md +16 -16
  299. package/docs/examples/messaging/update-telesign-provider.md +8 -8
  300. package/docs/examples/messaging/update-textmagic-provider.md +8 -8
  301. package/docs/examples/messaging/update-topic.md +5 -5
  302. package/docs/examples/messaging/update-twilio-provider.md +8 -8
  303. package/docs/examples/messaging/update-vonage-provider.md +8 -8
  304. package/docs/examples/migrations/create-appwrite-migration.md +6 -6
  305. package/docs/examples/migrations/create-csv-export.md +21 -0
  306. package/docs/examples/migrations/{create-csv-migration.md → create-csv-import.md} +6 -5
  307. package/docs/examples/migrations/create-firebase-migration.md +4 -4
  308. package/docs/examples/migrations/create-n-host-migration.md +10 -10
  309. package/docs/examples/migrations/create-supabase-migration.md +9 -9
  310. package/docs/examples/migrations/delete.md +3 -3
  311. package/docs/examples/migrations/get-appwrite-report.md +6 -6
  312. package/docs/examples/migrations/get-firebase-report.md +4 -4
  313. package/docs/examples/migrations/get-n-host-report.md +10 -10
  314. package/docs/examples/migrations/get-supabase-report.md +9 -9
  315. package/docs/examples/migrations/get.md +3 -3
  316. package/docs/examples/migrations/list.md +5 -4
  317. package/docs/examples/migrations/retry.md +3 -3
  318. package/docs/examples/organizations/add-credit.md +4 -4
  319. package/docs/examples/organizations/cancel-downgrade.md +3 -3
  320. package/docs/examples/organizations/create-downgrade-feedback.md +17 -0
  321. package/docs/examples/organizations/create-invoice-payment.md +5 -5
  322. package/docs/examples/organizations/create.md +13 -12
  323. package/docs/examples/organizations/delete-backup-payment-method.md +3 -3
  324. package/docs/examples/organizations/delete-billing-address.md +3 -3
  325. package/docs/examples/organizations/delete-default-payment-method.md +3 -3
  326. package/docs/examples/organizations/delete.md +3 -3
  327. package/docs/examples/organizations/estimation-create-organization.md +8 -7
  328. package/docs/examples/organizations/estimation-delete-organization.md +3 -3
  329. package/docs/examples/organizations/estimation-update-plan.md +7 -7
  330. package/docs/examples/organizations/get-aggregation.md +6 -4
  331. package/docs/examples/organizations/get-available-credits.md +3 -3
  332. package/docs/examples/organizations/get-billing-address.md +4 -4
  333. package/docs/examples/organizations/get-credit.md +4 -4
  334. package/docs/examples/organizations/get-invoice-download.md +4 -4
  335. package/docs/examples/organizations/get-invoice-view.md +4 -4
  336. package/docs/examples/organizations/get-invoice.md +4 -4
  337. package/docs/examples/organizations/get-payment-method.md +4 -4
  338. package/docs/examples/organizations/get-plan.md +3 -3
  339. package/docs/examples/organizations/get-scopes.md +3 -3
  340. package/docs/examples/organizations/get-usage.md +5 -5
  341. package/docs/examples/organizations/list-aggregations.md +4 -4
  342. package/docs/examples/organizations/list-credits.md +4 -4
  343. package/docs/examples/organizations/list-invoices.md +4 -4
  344. package/docs/examples/organizations/list.md +4 -4
  345. package/docs/examples/organizations/set-backup-payment-method.md +4 -4
  346. package/docs/examples/organizations/set-billing-address.md +4 -4
  347. package/docs/examples/organizations/set-billing-email.md +4 -4
  348. package/docs/examples/organizations/set-billing-tax-id.md +4 -4
  349. package/docs/examples/organizations/set-default-payment-method.md +4 -4
  350. package/docs/examples/organizations/update-budget.md +5 -5
  351. package/docs/examples/organizations/update-plan.md +11 -11
  352. package/docs/examples/organizations/update-projects.md +4 -4
  353. package/docs/examples/organizations/validate-invoice.md +4 -4
  354. package/docs/examples/organizations/validate-payment.md +4 -4
  355. package/docs/examples/project/create-variable.md +5 -5
  356. package/docs/examples/project/delete-variable.md +3 -3
  357. package/docs/examples/project/get-usage.md +5 -5
  358. package/docs/examples/project/get-variable.md +3 -3
  359. package/docs/examples/project/update-variable.md +6 -6
  360. package/docs/examples/projects/create-dev-key.md +5 -5
  361. package/docs/examples/projects/{create-j-w-t.md → create-jwt.md} +5 -5
  362. package/docs/examples/projects/create-key.md +6 -6
  363. package/docs/examples/projects/create-platform.md +8 -8
  364. package/docs/examples/projects/create-smtp-test.md +12 -12
  365. package/docs/examples/projects/create-webhook.md +10 -10
  366. package/docs/examples/projects/create.md +16 -16
  367. package/docs/examples/projects/delete-dev-key.md +4 -4
  368. package/docs/examples/projects/delete-email-template.md +5 -5
  369. package/docs/examples/projects/delete-key.md +4 -4
  370. package/docs/examples/projects/delete-platform.md +4 -4
  371. package/docs/examples/projects/delete-sms-template.md +5 -5
  372. package/docs/examples/projects/delete-webhook.md +4 -4
  373. package/docs/examples/projects/delete.md +3 -3
  374. package/docs/examples/projects/get-dev-key.md +4 -4
  375. package/docs/examples/projects/get-email-template.md +5 -5
  376. package/docs/examples/projects/get-key.md +4 -4
  377. package/docs/examples/projects/get-platform.md +4 -4
  378. package/docs/examples/projects/get-sms-template.md +5 -5
  379. package/docs/examples/projects/get-webhook.md +4 -4
  380. package/docs/examples/projects/get.md +3 -3
  381. package/docs/examples/projects/list-dev-keys.md +4 -4
  382. package/docs/examples/projects/list-keys.md +4 -3
  383. package/docs/examples/projects/list-platforms.md +4 -3
  384. package/docs/examples/projects/list-webhooks.md +4 -3
  385. package/docs/examples/projects/list.md +5 -4
  386. package/docs/examples/projects/update-api-status-all.md +4 -4
  387. package/docs/examples/projects/update-api-status.md +6 -6
  388. package/docs/examples/projects/update-auth-duration.md +4 -4
  389. package/docs/examples/projects/update-auth-limit.md +4 -4
  390. package/docs/examples/projects/update-auth-password-dictionary.md +4 -4
  391. package/docs/examples/projects/update-auth-password-history.md +4 -4
  392. package/docs/examples/projects/update-auth-sessions-limit.md +4 -4
  393. package/docs/examples/projects/update-auth-status.md +5 -5
  394. package/docs/examples/projects/update-dev-key.md +6 -6
  395. package/docs/examples/projects/update-email-template.md +10 -10
  396. package/docs/examples/projects/update-key.md +7 -7
  397. package/docs/examples/projects/update-memberships-privacy.md +6 -6
  398. package/docs/examples/projects/update-mock-numbers.md +4 -4
  399. package/docs/examples/projects/{update-o-auth2.md → update-o-auth-2.md} +7 -7
  400. package/docs/examples/projects/update-personal-data-check.md +4 -4
  401. package/docs/examples/projects/update-platform.md +8 -8
  402. package/docs/examples/projects/update-service-status-all.md +4 -4
  403. package/docs/examples/projects/update-service-status.md +5 -5
  404. package/docs/examples/projects/update-session-alerts.md +4 -4
  405. package/docs/examples/projects/update-session-invalidation.md +14 -0
  406. package/docs/examples/projects/update-sms-template.md +6 -6
  407. package/docs/examples/projects/update-smtp.md +12 -12
  408. package/docs/examples/projects/update-status.md +14 -0
  409. package/docs/examples/projects/update-team.md +4 -4
  410. package/docs/examples/projects/update-webhook-signature.md +4 -4
  411. package/docs/examples/projects/update-webhook.md +11 -11
  412. package/docs/examples/projects/update.md +13 -13
  413. package/docs/examples/proxy/{create-a-p-i-rule.md → create-api-rule.md} +3 -3
  414. package/docs/examples/proxy/create-function-rule.md +5 -5
  415. package/docs/examples/proxy/create-redirect-rule.md +8 -8
  416. package/docs/examples/proxy/create-site-rule.md +5 -5
  417. package/docs/examples/proxy/delete-rule.md +3 -3
  418. package/docs/examples/proxy/get-rule.md +3 -3
  419. package/docs/examples/proxy/list-rules.md +5 -4
  420. package/docs/examples/proxy/update-rule-verification.md +3 -3
  421. package/docs/examples/sites/create-deployment.md +8 -8
  422. package/docs/examples/sites/create-duplicate-deployment.md +4 -4
  423. package/docs/examples/sites/create-template-deployment.md +10 -9
  424. package/docs/examples/sites/create-variable.md +6 -6
  425. package/docs/examples/sites/create-vcs-deployment.md +7 -7
  426. package/docs/examples/sites/create.md +21 -21
  427. package/docs/examples/sites/delete-deployment.md +4 -4
  428. package/docs/examples/sites/delete-log.md +4 -4
  429. package/docs/examples/sites/delete-variable.md +4 -4
  430. package/docs/examples/sites/delete.md +3 -3
  431. package/docs/examples/sites/get-deployment-download.md +5 -5
  432. package/docs/examples/sites/get-deployment.md +4 -4
  433. package/docs/examples/sites/get-log.md +4 -4
  434. package/docs/examples/sites/get-template.md +3 -3
  435. package/docs/examples/sites/get-usage.md +5 -5
  436. package/docs/examples/sites/get-variable.md +4 -4
  437. package/docs/examples/sites/get.md +3 -3
  438. package/docs/examples/sites/list-deployments.md +6 -5
  439. package/docs/examples/sites/list-logs.md +5 -4
  440. package/docs/examples/sites/list-templates.md +6 -6
  441. package/docs/examples/sites/list-usage.md +4 -4
  442. package/docs/examples/sites/list-variables.md +3 -3
  443. package/docs/examples/sites/list.md +5 -4
  444. package/docs/examples/sites/update-deployment-status.md +4 -4
  445. package/docs/examples/sites/update-site-deployment.md +4 -4
  446. package/docs/examples/sites/update-variable.md +7 -7
  447. package/docs/examples/sites/update.md +21 -21
  448. package/docs/examples/storage/create-bucket.md +14 -13
  449. package/docs/examples/storage/create-file.md +7 -7
  450. package/docs/examples/storage/delete-bucket.md +3 -3
  451. package/docs/examples/storage/delete-file.md +4 -4
  452. package/docs/examples/storage/get-bucket-usage.md +5 -5
  453. package/docs/examples/storage/get-bucket.md +3 -3
  454. package/docs/examples/storage/get-file-download.md +5 -5
  455. package/docs/examples/storage/get-file-preview.md +16 -16
  456. package/docs/examples/storage/get-file-view.md +5 -5
  457. package/docs/examples/storage/get-file.md +4 -4
  458. package/docs/examples/storage/get-usage.md +4 -4
  459. package/docs/examples/storage/list-buckets.md +5 -4
  460. package/docs/examples/storage/list-files.md +6 -5
  461. package/docs/examples/storage/update-bucket.md +14 -13
  462. package/docs/examples/storage/update-file.md +7 -7
  463. package/docs/examples/tablesdb/create-boolean-column.md +18 -0
  464. package/docs/examples/tablesdb/create-datetime-column.md +18 -0
  465. package/docs/examples/tablesdb/create-email-column.md +18 -0
  466. package/docs/examples/tablesdb/create-enum-column.md +19 -0
  467. package/docs/examples/tablesdb/create-float-column.md +20 -0
  468. package/docs/examples/tablesdb/create-index.md +19 -0
  469. package/docs/examples/tablesdb/create-integer-column.md +20 -0
  470. package/docs/examples/tablesdb/create-ip-column.md +18 -0
  471. package/docs/examples/tablesdb/create-line-column.md +17 -0
  472. package/docs/examples/tablesdb/create-operations.md +24 -0
  473. package/docs/examples/tablesdb/create-point-column.md +17 -0
  474. package/docs/examples/tablesdb/create-polygon-column.md +17 -0
  475. package/docs/examples/tablesdb/create-relationship-column.md +20 -0
  476. package/docs/examples/tablesdb/create-row.md +24 -0
  477. package/docs/examples/tablesdb/create-rows.md +16 -0
  478. package/docs/examples/tablesdb/create-string-column.md +20 -0
  479. package/docs/examples/tablesdb/create-table.md +20 -0
  480. package/docs/examples/tablesdb/create-transaction.md +13 -0
  481. package/docs/examples/tablesdb/create-url-column.md +18 -0
  482. package/docs/examples/tablesdb/create.md +15 -0
  483. package/docs/examples/tablesdb/decrement-row-column.md +19 -0
  484. package/docs/examples/tablesdb/delete-column.md +15 -0
  485. package/docs/examples/tablesdb/delete-index.md +15 -0
  486. package/docs/examples/tablesdb/delete-row.md +16 -0
  487. package/docs/examples/tablesdb/delete-rows.md +16 -0
  488. package/docs/examples/tablesdb/delete-table.md +14 -0
  489. package/docs/examples/tablesdb/delete-transaction.md +13 -0
  490. package/docs/examples/tablesdb/delete.md +13 -0
  491. package/docs/examples/tablesdb/get-column.md +15 -0
  492. package/docs/examples/tablesdb/get-index.md +15 -0
  493. package/docs/examples/tablesdb/get-row.md +17 -0
  494. package/docs/examples/tablesdb/get-table-usage.md +15 -0
  495. package/docs/examples/tablesdb/get-table.md +14 -0
  496. package/docs/examples/tablesdb/get-transaction.md +13 -0
  497. package/docs/examples/tablesdb/get-usage.md +14 -0
  498. package/docs/examples/tablesdb/get.md +13 -0
  499. package/docs/examples/tablesdb/increment-row-column.md +19 -0
  500. package/docs/examples/tablesdb/list-columns.md +16 -0
  501. package/docs/examples/tablesdb/list-indexes.md +16 -0
  502. package/docs/examples/tablesdb/list-row-logs.md +16 -0
  503. package/docs/examples/tablesdb/list-rows.md +17 -0
  504. package/docs/examples/tablesdb/list-table-logs.md +15 -0
  505. package/docs/examples/tablesdb/list-tables.md +16 -0
  506. package/docs/examples/tablesdb/list-transactions.md +13 -0
  507. package/docs/examples/tablesdb/list-usage.md +13 -0
  508. package/docs/examples/tablesdb/list.md +15 -0
  509. package/docs/examples/tablesdb/update-boolean-column.md +18 -0
  510. package/docs/examples/tablesdb/update-datetime-column.md +18 -0
  511. package/docs/examples/tablesdb/update-email-column.md +18 -0
  512. package/docs/examples/tablesdb/update-enum-column.md +19 -0
  513. package/docs/examples/tablesdb/update-float-column.md +20 -0
  514. package/docs/examples/tablesdb/update-integer-column.md +20 -0
  515. package/docs/examples/tablesdb/update-ip-column.md +18 -0
  516. package/docs/examples/tablesdb/update-line-column.md +18 -0
  517. package/docs/examples/tablesdb/update-point-column.md +18 -0
  518. package/docs/examples/tablesdb/update-polygon-column.md +18 -0
  519. package/docs/examples/tablesdb/update-relationship-column.md +17 -0
  520. package/docs/examples/tablesdb/update-row.md +24 -0
  521. package/docs/examples/tablesdb/update-rows.md +23 -0
  522. package/docs/examples/tablesdb/update-string-column.md +19 -0
  523. package/docs/examples/tablesdb/update-table.md +18 -0
  524. package/docs/examples/tablesdb/update-transaction.md +15 -0
  525. package/docs/examples/tablesdb/update-url-column.md +18 -0
  526. package/docs/examples/tablesdb/update.md +15 -0
  527. package/docs/examples/tablesdb/upsert-row.md +24 -0
  528. package/docs/examples/tablesdb/upsert-rows.md +16 -0
  529. package/docs/examples/teams/create-membership.md +9 -9
  530. package/docs/examples/teams/create.md +5 -5
  531. package/docs/examples/teams/delete-membership.md +4 -4
  532. package/docs/examples/teams/delete.md +3 -3
  533. package/docs/examples/teams/get-membership.md +4 -4
  534. package/docs/examples/teams/get-prefs.md +3 -3
  535. package/docs/examples/teams/get.md +3 -3
  536. package/docs/examples/teams/list-logs.md +5 -4
  537. package/docs/examples/teams/list-memberships.md +6 -5
  538. package/docs/examples/teams/list.md +5 -4
  539. package/docs/examples/teams/update-membership-status.md +6 -6
  540. package/docs/examples/teams/update-membership.md +5 -5
  541. package/docs/examples/teams/update-name.md +4 -4
  542. package/docs/examples/teams/update-prefs.md +4 -4
  543. package/docs/examples/tokens/create-file-token.md +5 -5
  544. package/docs/examples/tokens/delete.md +3 -3
  545. package/docs/examples/tokens/get.md +3 -3
  546. package/docs/examples/tokens/list.md +6 -5
  547. package/docs/examples/tokens/update.md +4 -4
  548. package/docs/examples/users/{create-m-d5user.md → create-argon-2-user.md} +6 -6
  549. package/docs/examples/users/create-bcrypt-user.md +6 -6
  550. package/docs/examples/users/{create-j-w-t.md → create-jwt.md} +5 -5
  551. package/docs/examples/users/{create-argon2user.md → create-md-5-user.md} +6 -6
  552. package/docs/examples/users/create-mfa-recovery-codes.md +3 -3
  553. package/docs/examples/users/{create-p-h-pass-user.md → create-ph-pass-user.md} +6 -6
  554. package/docs/examples/users/create-scrypt-modified-user.md +9 -9
  555. package/docs/examples/users/create-scrypt-user.md +11 -11
  556. package/docs/examples/users/create-session.md +3 -3
  557. package/docs/examples/users/{create-s-h-a-user.md → create-sha-user.md} +7 -7
  558. package/docs/examples/users/create-target.md +8 -8
  559. package/docs/examples/users/create-token.md +5 -5
  560. package/docs/examples/users/create.md +7 -7
  561. package/docs/examples/users/delete-identity.md +3 -3
  562. package/docs/examples/users/delete-mfa-authenticator.md +4 -4
  563. package/docs/examples/users/delete-session.md +4 -4
  564. package/docs/examples/users/delete-sessions.md +3 -3
  565. package/docs/examples/users/delete-target.md +4 -4
  566. package/docs/examples/users/delete.md +3 -3
  567. package/docs/examples/users/get-mfa-recovery-codes.md +3 -3
  568. package/docs/examples/users/get-prefs.md +3 -3
  569. package/docs/examples/users/get-target.md +4 -4
  570. package/docs/examples/users/get-usage.md +4 -4
  571. package/docs/examples/users/get.md +3 -3
  572. package/docs/examples/users/list-identities.md +5 -4
  573. package/docs/examples/users/list-logs.md +5 -4
  574. package/docs/examples/users/list-memberships.md +6 -5
  575. package/docs/examples/users/list-mfa-factors.md +3 -3
  576. package/docs/examples/users/list-sessions.md +4 -3
  577. package/docs/examples/users/list-targets.md +5 -4
  578. package/docs/examples/users/list.md +5 -4
  579. package/docs/examples/users/update-email-verification.md +4 -4
  580. package/docs/examples/users/update-email.md +4 -4
  581. package/docs/examples/users/update-labels.md +4 -4
  582. package/docs/examples/users/update-mfa-recovery-codes.md +3 -3
  583. package/docs/examples/users/update-mfa.md +4 -4
  584. package/docs/examples/users/update-name.md +4 -4
  585. package/docs/examples/users/update-password.md +4 -4
  586. package/docs/examples/users/update-phone-verification.md +4 -4
  587. package/docs/examples/users/update-phone.md +4 -4
  588. package/docs/examples/users/update-prefs.md +4 -4
  589. package/docs/examples/users/update-status.md +4 -4
  590. package/docs/examples/users/update-target.md +7 -7
  591. package/docs/examples/vcs/create-repository-detection.md +6 -6
  592. package/docs/examples/vcs/create-repository.md +5 -5
  593. package/docs/examples/vcs/delete-installation.md +3 -3
  594. package/docs/examples/vcs/get-installation.md +3 -3
  595. package/docs/examples/vcs/get-repository-contents.md +6 -6
  596. package/docs/examples/vcs/get-repository.md +4 -4
  597. package/docs/examples/vcs/list-installations.md +5 -4
  598. package/docs/examples/vcs/list-repositories.md +6 -5
  599. package/docs/examples/vcs/list-repository-branches.md +4 -4
  600. package/docs/examples/vcs/update-external-deployments.md +5 -5
  601. package/package.json +4 -4
  602. package/src/client.ts +42 -7
  603. package/src/enums/api-service.ts +1 -0
  604. package/src/enums/attribute-status.ts +7 -0
  605. package/src/enums/billing-plan-group.ts +5 -0
  606. package/src/enums/build-runtime.ts +2 -0
  607. package/src/enums/column-status.ts +7 -0
  608. package/src/enums/credit-card.ts +1 -1
  609. package/src/enums/database-type.ts +4 -0
  610. package/src/enums/deployment-status.ts +7 -0
  611. package/src/enums/execution-method.ts +1 -0
  612. package/src/enums/execution-status.ts +7 -0
  613. package/src/enums/execution-trigger.ts +5 -0
  614. package/src/enums/framework.ts +1 -0
  615. package/src/enums/health-antivirus-status.ts +5 -0
  616. package/src/enums/health-check-status.ts +4 -0
  617. package/src/enums/index-status.ts +7 -0
  618. package/src/enums/index-type.ts +1 -0
  619. package/src/enums/message-status.ts +7 -0
  620. package/src/enums/o-auth-provider.ts +3 -0
  621. package/src/enums/platform.ts +4 -0
  622. package/src/enums/proxy-rule-deployment-resource-type.ts +4 -0
  623. package/src/enums/proxy-rule-status.ts +6 -0
  624. package/src/enums/region.ts +3 -0
  625. package/src/enums/runtime.ts +2 -0
  626. package/src/enums/status.ts +4 -0
  627. package/src/enums/template-reference-type.ts +5 -0
  628. package/src/enums/theme.ts +4 -0
  629. package/src/enums/timezone.ts +421 -0
  630. package/src/enums/{user-usage-range.ts → usage-range.ts} +1 -1
  631. package/src/enums/{v-c-s-deployment-type.ts → vcs-reference-type.ts} +1 -1
  632. package/src/index.ts +27 -11
  633. package/src/models.ts +1692 -238
  634. package/src/operator.ts +308 -0
  635. package/src/query.ts +246 -2
  636. package/src/services/account.ts +2205 -223
  637. package/src/services/assistant.ts +29 -3
  638. package/src/services/avatars.ts +486 -33
  639. package/src/services/backups.ts +389 -42
  640. package/src/services/console.ts +492 -19
  641. package/src/services/databases.ts +3521 -431
  642. package/src/services/domains.ts +1684 -197
  643. package/src/services/functions.ts +1162 -149
  644. package/src/services/graphql.ts +55 -4
  645. package/src/services/health.ts +560 -41
  646. package/src/services/locale.ts +9 -0
  647. package/src/services/messaging.ts +3367 -380
  648. package/src/services/migrations.ts +641 -65
  649. package/src/services/organizations.ts +1323 -128
  650. package/src/services/project.ts +168 -17
  651. package/src/services/projects.ts +2742 -266
  652. package/src/services/proxy.ts +265 -26
  653. package/src/services/realtime.ts +437 -0
  654. package/src/services/sites.ts +1098 -140
  655. package/src/services/storage.ts +651 -82
  656. package/src/services/tables-db.ts +5439 -0
  657. package/src/services/teams.ts +512 -55
  658. package/src/services/tokens.ts +167 -16
  659. package/src/services/users.ts +1873 -181
  660. package/src/services/vcs.ts +359 -39
  661. package/types/client.d.ts +14 -5
  662. package/types/enums/api-service.d.ts +1 -0
  663. package/types/enums/attribute-status.d.ts +7 -0
  664. package/types/enums/billing-plan-group.d.ts +5 -0
  665. package/types/enums/build-runtime.d.ts +3 -1
  666. package/types/enums/column-status.d.ts +7 -0
  667. package/types/enums/credit-card.d.ts +1 -1
  668. package/types/enums/database-type.d.ts +4 -0
  669. package/types/enums/deployment-status.d.ts +7 -0
  670. package/types/enums/execution-method.d.ts +2 -1
  671. package/types/enums/execution-status.d.ts +7 -0
  672. package/types/enums/execution-trigger.d.ts +5 -0
  673. package/types/enums/framework.d.ts +1 -0
  674. package/types/enums/health-antivirus-status.d.ts +5 -0
  675. package/types/enums/health-check-status.d.ts +4 -0
  676. package/types/enums/index-status.d.ts +7 -0
  677. package/types/enums/index-type.d.ts +2 -1
  678. package/types/enums/message-status.d.ts +7 -0
  679. package/types/enums/o-auth-provider.d.ts +4 -1
  680. package/types/enums/platform.d.ts +4 -0
  681. package/types/enums/proxy-rule-deployment-resource-type.d.ts +4 -0
  682. package/types/enums/proxy-rule-status.d.ts +6 -0
  683. package/types/enums/region.d.ts +4 -1
  684. package/types/enums/runtime.d.ts +3 -1
  685. package/types/enums/status.d.ts +4 -0
  686. package/types/enums/template-reference-type.d.ts +5 -0
  687. package/types/enums/theme.d.ts +4 -0
  688. package/types/enums/timezone.d.ts +421 -0
  689. package/types/enums/{site-usage-range.d.ts → usage-range.d.ts} +1 -1
  690. package/types/enums/{v-c-s-deployment-type.d.ts → vcs-reference-type.d.ts} +1 -1
  691. package/types/index.d.ts +27 -11
  692. package/types/models.d.ts +1664 -245
  693. package/types/operator.d.ts +180 -0
  694. package/types/query.d.ts +198 -2
  695. package/types/services/account.d.ts +985 -123
  696. package/types/services/assistant.d.ts +13 -2
  697. package/types/services/avatars.d.ts +244 -26
  698. package/types/services/backups.d.ts +190 -30
  699. package/types/services/console.d.ts +201 -14
  700. package/types/services/databases.d.ts +1731 -284
  701. package/types/services/domains.d.ts +904 -152
  702. package/types/services/functions.d.ts +616 -125
  703. package/types/services/graphql.d.ts +24 -2
  704. package/types/services/health.d.ts +245 -23
  705. package/types/services/messaging.d.ts +1660 -271
  706. package/types/services/migrations.d.ts +319 -53
  707. package/types/services/organizations.d.ts +635 -97
  708. package/types/services/project.d.ts +81 -12
  709. package/types/services/projects.d.ts +1308 -202
  710. package/types/services/proxy.d.ts +128 -19
  711. package/types/services/realtime.d.ts +118 -0
  712. package/types/services/sites.d.ts +577 -116
  713. package/types/services/storage.d.ts +354 -73
  714. package/types/services/tables-db.d.ts +2040 -0
  715. package/types/services/teams.d.ts +260 -44
  716. package/types/services/tokens.d.ts +80 -12
  717. package/types/services/users.d.ts +881 -124
  718. package/types/services/vcs.d.ts +179 -31
  719. package/docs/examples/domains/create-record-m-x.md +0 -18
  720. package/docs/examples/domains/create-record-s-r-v.md +0 -20
  721. package/docs/examples/domains/create-record-t-x-t.md +0 -17
  722. package/docs/examples/domains/update-record-a-a-a-a.md +0 -18
  723. package/docs/examples/domains/update-record-c-a-a.md +0 -18
  724. package/docs/examples/domains/update-record-c-n-a-m-e.md +0 -18
  725. package/docs/examples/domains/update-record-h-t-t-p-s.md +0 -18
  726. package/docs/examples/domains/update-record-m-x.md +0 -19
  727. package/docs/examples/domains/update-record-n-s.md +0 -18
  728. package/docs/examples/domains/update-record-s-r-v.md +0 -21
  729. package/docs/examples/domains/update-record-t-x-t.md +0 -18
  730. package/src/enums/billing-plan.ts +0 -5
  731. package/src/enums/database-usage-range.ts +0 -5
  732. package/src/enums/function-usage-range.ts +0 -5
  733. package/src/enums/site-usage-range.ts +0 -5
  734. package/src/enums/storage-usage-range.ts +0 -5
  735. package/types/enums/billing-plan.d.ts +0 -5
  736. package/types/enums/database-usage-range.d.ts +0 -5
  737. package/types/enums/function-usage-range.d.ts +0 -5
  738. package/types/enums/storage-usage-range.d.ts +0 -5
  739. package/types/enums/user-usage-range.d.ts +0 -5
  740. /package/docs/examples/health/{get-d-b.md → get-db.md} +0 -0
  741. /package/docs/examples/locale/{list-countries-e-u.md → list-countries-eu.md} +0 -0
  742. /package/src/enums/{s-m-t-p-secure.ts → smtp-secure.ts} +0 -0
  743. /package/src/enums/{v-c-s-detection-type.ts → vcs-detection-type.ts} +0 -0
  744. /package/types/enums/{s-m-t-p-secure.d.ts → smtp-secure.d.ts} +0 -0
  745. /package/types/enums/{v-c-s-detection-type.d.ts → vcs-detection-type.d.ts} +0 -0
@@ -2,6 +2,7 @@ import { Service } from '../service';
2
2
  import { AppwriteException, Client, type Payload, UploadProgress } from '../client';
3
3
  import type { Models } from '../models';
4
4
 
5
+
5
6
  export class Migrations {
6
7
  client: Client;
7
8
 
@@ -12,12 +13,45 @@ export class Migrations {
12
13
  /**
13
14
  * List all migrations in the current project. This endpoint returns a list of all migrations including their status, progress, and any errors that occurred during the migration process.
14
15
  *
15
- * @param {string[]} queries
16
- * @param {string} search
16
+ * @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 the following attributes: status, stage, source, destination, resources, statusCounters, resourceData, errors
17
+ * @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
18
+ * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
19
+ * @throws {AppwriteException}
20
+ * @returns {Promise<Models.MigrationList>}
21
+ */
22
+ list(params?: { queries?: string[], search?: string, total?: boolean }): Promise<Models.MigrationList>;
23
+ /**
24
+ * List all migrations in the current project. This endpoint returns a list of all migrations including their status, progress, and any errors that occurred during the migration process.
25
+ *
26
+ * @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 the following attributes: status, stage, source, destination, resources, statusCounters, resourceData, errors
27
+ * @param {string} search - Search term to filter your list results. Max length: 256 chars.
28
+ * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
17
29
  * @throws {AppwriteException}
18
30
  * @returns {Promise<Models.MigrationList>}
31
+ * @deprecated Use the object parameter style method for a better developer experience.
19
32
  */
20
- list(queries?: string[], search?: string): Promise<Models.MigrationList> {
33
+ list(queries?: string[], search?: string, total?: boolean): Promise<Models.MigrationList>;
34
+ list(
35
+ paramsOrFirst?: { queries?: string[], search?: string, total?: boolean } | string[],
36
+ ...rest: [(string)?, (boolean)?]
37
+ ): Promise<Models.MigrationList> {
38
+ let params: { queries?: string[], search?: string, total?: boolean };
39
+
40
+ if (!paramsOrFirst || (paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
41
+ params = (paramsOrFirst || {}) as { queries?: string[], search?: string, total?: boolean };
42
+ } else {
43
+ params = {
44
+ queries: paramsOrFirst as string[],
45
+ search: rest[0] as string,
46
+ total: rest[1] as boolean
47
+ };
48
+ }
49
+
50
+ const queries = params.queries;
51
+ const search = params.search;
52
+ const total = params.total;
53
+
54
+
21
55
  const apiPath = '/migrations';
22
56
  const payload: Payload = {};
23
57
  if (typeof queries !== 'undefined') {
@@ -26,6 +60,9 @@ export class Migrations {
26
60
  if (typeof search !== 'undefined') {
27
61
  payload['search'] = search;
28
62
  }
63
+ if (typeof total !== 'undefined') {
64
+ payload['total'] = total;
65
+ }
29
66
  const uri = new URL(this.client.config.endpoint + apiPath);
30
67
 
31
68
  const apiHeaders: { [header: string]: string } = {
@@ -42,14 +79,48 @@ export class Migrations {
42
79
  /**
43
80
  * Migrate data from another Appwrite project to your current project. This endpoint allows you to migrate resources like databases, collections, documents, users, and files from an existing Appwrite project.
44
81
  *
45
- * @param {string[]} resources
46
- * @param {string} endpoint
47
- * @param {string} projectId
48
- * @param {string} apiKey
82
+ * @param {string[]} params.resources - List of resources to migrate
83
+ * @param {string} params.endpoint - Source Appwrite endpoint
84
+ * @param {string} params.projectId - Source Project ID
85
+ * @param {string} params.apiKey - Source API Key
49
86
  * @throws {AppwriteException}
50
87
  * @returns {Promise<Models.Migration>}
51
88
  */
52
- createAppwriteMigration(resources: string[], endpoint: string, projectId: string, apiKey: string): Promise<Models.Migration> {
89
+ createAppwriteMigration(params: { resources: string[], endpoint: string, projectId: string, apiKey: string }): Promise<Models.Migration>;
90
+ /**
91
+ * Migrate data from another Appwrite project to your current project. This endpoint allows you to migrate resources like databases, collections, documents, users, and files from an existing Appwrite project.
92
+ *
93
+ * @param {string[]} resources - List of resources to migrate
94
+ * @param {string} endpoint - Source Appwrite endpoint
95
+ * @param {string} projectId - Source Project ID
96
+ * @param {string} apiKey - Source API Key
97
+ * @throws {AppwriteException}
98
+ * @returns {Promise<Models.Migration>}
99
+ * @deprecated Use the object parameter style method for a better developer experience.
100
+ */
101
+ createAppwriteMigration(resources: string[], endpoint: string, projectId: string, apiKey: string): Promise<Models.Migration>;
102
+ createAppwriteMigration(
103
+ paramsOrFirst: { resources: string[], endpoint: string, projectId: string, apiKey: string } | string[],
104
+ ...rest: [(string)?, (string)?, (string)?]
105
+ ): Promise<Models.Migration> {
106
+ let params: { resources: string[], endpoint: string, projectId: string, apiKey: string };
107
+
108
+ if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
109
+ params = (paramsOrFirst || {}) as { resources: string[], endpoint: string, projectId: string, apiKey: string };
110
+ } else {
111
+ params = {
112
+ resources: paramsOrFirst as string[],
113
+ endpoint: rest[0] as string,
114
+ projectId: rest[1] as string,
115
+ apiKey: rest[2] as string
116
+ };
117
+ }
118
+
119
+ const resources = params.resources;
120
+ const endpoint = params.endpoint;
121
+ const projectId = params.projectId;
122
+ const apiKey = params.apiKey;
123
+
53
124
  if (typeof resources === 'undefined') {
54
125
  throw new AppwriteException('Missing required parameter: "resources"');
55
126
  }
@@ -62,6 +133,7 @@ export class Migrations {
62
133
  if (typeof apiKey === 'undefined') {
63
134
  throw new AppwriteException('Missing required parameter: "apiKey"');
64
135
  }
136
+
65
137
  const apiPath = '/migrations/appwrite';
66
138
  const payload: Payload = {};
67
139
  if (typeof resources !== 'undefined') {
@@ -93,14 +165,48 @@ export class Migrations {
93
165
  /**
94
166
  * Generate a report of the data in an Appwrite project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
95
167
  *
96
- * @param {string[]} resources
97
- * @param {string} endpoint
98
- * @param {string} projectID
99
- * @param {string} key
168
+ * @param {string[]} params.resources - List of resources to migrate
169
+ * @param {string} params.endpoint - Source's Appwrite Endpoint
170
+ * @param {string} params.projectID - Source's Project ID
171
+ * @param {string} params.key - Source's API Key
172
+ * @throws {AppwriteException}
173
+ * @returns {Promise<Models.MigrationReport>}
174
+ */
175
+ getAppwriteReport(params: { resources: string[], endpoint: string, projectID: string, key: string }): Promise<Models.MigrationReport>;
176
+ /**
177
+ * Generate a report of the data in an Appwrite project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
178
+ *
179
+ * @param {string[]} resources - List of resources to migrate
180
+ * @param {string} endpoint - Source's Appwrite Endpoint
181
+ * @param {string} projectID - Source's Project ID
182
+ * @param {string} key - Source's API Key
100
183
  * @throws {AppwriteException}
101
184
  * @returns {Promise<Models.MigrationReport>}
185
+ * @deprecated Use the object parameter style method for a better developer experience.
102
186
  */
103
- getAppwriteReport(resources: string[], endpoint: string, projectID: string, key: string): Promise<Models.MigrationReport> {
187
+ getAppwriteReport(resources: string[], endpoint: string, projectID: string, key: string): Promise<Models.MigrationReport>;
188
+ getAppwriteReport(
189
+ paramsOrFirst: { resources: string[], endpoint: string, projectID: string, key: string } | string[],
190
+ ...rest: [(string)?, (string)?, (string)?]
191
+ ): Promise<Models.MigrationReport> {
192
+ let params: { resources: string[], endpoint: string, projectID: string, key: string };
193
+
194
+ if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
195
+ params = (paramsOrFirst || {}) as { resources: string[], endpoint: string, projectID: string, key: string };
196
+ } else {
197
+ params = {
198
+ resources: paramsOrFirst as string[],
199
+ endpoint: rest[0] as string,
200
+ projectID: rest[1] as string,
201
+ key: rest[2] as string
202
+ };
203
+ }
204
+
205
+ const resources = params.resources;
206
+ const endpoint = params.endpoint;
207
+ const projectID = params.projectID;
208
+ const key = params.key;
209
+
104
210
  if (typeof resources === 'undefined') {
105
211
  throw new AppwriteException('Missing required parameter: "resources"');
106
212
  }
@@ -113,6 +219,7 @@ export class Migrations {
113
219
  if (typeof key === 'undefined') {
114
220
  throw new AppwriteException('Missing required parameter: "key"');
115
221
  }
222
+
116
223
  const apiPath = '/migrations/appwrite/report';
117
224
  const payload: Payload = {};
118
225
  if (typeof resources !== 'undefined') {
@@ -140,16 +247,166 @@ export class Migrations {
140
247
  );
141
248
  }
142
249
 
250
+ /**
251
+ * Export documents to a CSV file from your Appwrite database. This endpoint allows you to export documents to a CSV file stored in a secure internal bucket. You'll receive an email with a download link when the export is complete.
252
+ *
253
+ * @param {string} params.resourceId - Composite ID in the format {databaseId:collectionId}, identifying a collection within a database to export.
254
+ * @param {string} params.filename - The name of the file to be created for the export, excluding the .csv extension.
255
+ * @param {string[]} params.columns - List of attributes to export. If empty, all attributes will be exported. You can use the `*` wildcard to export all attributes from the collection.
256
+ * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK to filter documents to export. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long.
257
+ * @param {string} params.delimiter - The character that separates each column value. Default is comma.
258
+ * @param {string} params.enclosure - The character that encloses each column value. Default is double quotes.
259
+ * @param {string} params.escape - The escape character for the enclosure character. Default is double quotes.
260
+ * @param {boolean} params.header - Whether to include the header row with column names. Default is true.
261
+ * @param {boolean} params.notify - Set to true to receive an email when the export is complete. Default is true.
262
+ * @throws {AppwriteException}
263
+ * @returns {Promise<Models.Migration>}
264
+ */
265
+ createCSVExport(params: { resourceId: string, filename: string, columns?: string[], queries?: string[], delimiter?: string, enclosure?: string, escape?: string, header?: boolean, notify?: boolean }): Promise<Models.Migration>;
266
+ /**
267
+ * Export documents to a CSV file from your Appwrite database. This endpoint allows you to export documents to a CSV file stored in a secure internal bucket. You'll receive an email with a download link when the export is complete.
268
+ *
269
+ * @param {string} resourceId - Composite ID in the format {databaseId:collectionId}, identifying a collection within a database to export.
270
+ * @param {string} filename - The name of the file to be created for the export, excluding the .csv extension.
271
+ * @param {string[]} columns - List of attributes to export. If empty, all attributes will be exported. You can use the `*` wildcard to export all attributes from the collection.
272
+ * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK to filter documents to export. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long.
273
+ * @param {string} delimiter - The character that separates each column value. Default is comma.
274
+ * @param {string} enclosure - The character that encloses each column value. Default is double quotes.
275
+ * @param {string} escape - The escape character for the enclosure character. Default is double quotes.
276
+ * @param {boolean} header - Whether to include the header row with column names. Default is true.
277
+ * @param {boolean} notify - Set to true to receive an email when the export is complete. Default is true.
278
+ * @throws {AppwriteException}
279
+ * @returns {Promise<Models.Migration>}
280
+ * @deprecated Use the object parameter style method for a better developer experience.
281
+ */
282
+ createCSVExport(resourceId: string, filename: string, columns?: string[], queries?: string[], delimiter?: string, enclosure?: string, escape?: string, header?: boolean, notify?: boolean): Promise<Models.Migration>;
283
+ createCSVExport(
284
+ paramsOrFirst: { resourceId: string, filename: string, columns?: string[], queries?: string[], delimiter?: string, enclosure?: string, escape?: string, header?: boolean, notify?: boolean } | string,
285
+ ...rest: [(string)?, (string[])?, (string[])?, (string)?, (string)?, (string)?, (boolean)?, (boolean)?]
286
+ ): Promise<Models.Migration> {
287
+ let params: { resourceId: string, filename: string, columns?: string[], queries?: string[], delimiter?: string, enclosure?: string, escape?: string, header?: boolean, notify?: boolean };
288
+
289
+ if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
290
+ params = (paramsOrFirst || {}) as { resourceId: string, filename: string, columns?: string[], queries?: string[], delimiter?: string, enclosure?: string, escape?: string, header?: boolean, notify?: boolean };
291
+ } else {
292
+ params = {
293
+ resourceId: paramsOrFirst as string,
294
+ filename: rest[0] as string,
295
+ columns: rest[1] as string[],
296
+ queries: rest[2] as string[],
297
+ delimiter: rest[3] as string,
298
+ enclosure: rest[4] as string,
299
+ escape: rest[5] as string,
300
+ header: rest[6] as boolean,
301
+ notify: rest[7] as boolean
302
+ };
303
+ }
304
+
305
+ const resourceId = params.resourceId;
306
+ const filename = params.filename;
307
+ const columns = params.columns;
308
+ const queries = params.queries;
309
+ const delimiter = params.delimiter;
310
+ const enclosure = params.enclosure;
311
+ const escape = params.escape;
312
+ const header = params.header;
313
+ const notify = params.notify;
314
+
315
+ if (typeof resourceId === 'undefined') {
316
+ throw new AppwriteException('Missing required parameter: "resourceId"');
317
+ }
318
+ if (typeof filename === 'undefined') {
319
+ throw new AppwriteException('Missing required parameter: "filename"');
320
+ }
321
+
322
+ const apiPath = '/migrations/csv/exports';
323
+ const payload: Payload = {};
324
+ if (typeof resourceId !== 'undefined') {
325
+ payload['resourceId'] = resourceId;
326
+ }
327
+ if (typeof filename !== 'undefined') {
328
+ payload['filename'] = filename;
329
+ }
330
+ if (typeof columns !== 'undefined') {
331
+ payload['columns'] = columns;
332
+ }
333
+ if (typeof queries !== 'undefined') {
334
+ payload['queries'] = queries;
335
+ }
336
+ if (typeof delimiter !== 'undefined') {
337
+ payload['delimiter'] = delimiter;
338
+ }
339
+ if (typeof enclosure !== 'undefined') {
340
+ payload['enclosure'] = enclosure;
341
+ }
342
+ if (typeof escape !== 'undefined') {
343
+ payload['escape'] = escape;
344
+ }
345
+ if (typeof header !== 'undefined') {
346
+ payload['header'] = header;
347
+ }
348
+ if (typeof notify !== 'undefined') {
349
+ payload['notify'] = notify;
350
+ }
351
+ const uri = new URL(this.client.config.endpoint + apiPath);
352
+
353
+ const apiHeaders: { [header: string]: string } = {
354
+ 'content-type': 'application/json',
355
+ }
356
+
357
+ return this.client.call(
358
+ 'post',
359
+ uri,
360
+ apiHeaders,
361
+ payload
362
+ );
363
+ }
364
+
365
+ /**
366
+ * Import documents from a CSV file into your Appwrite database. This endpoint allows you to import documents from a CSV file uploaded to Appwrite Storage bucket.
367
+ *
368
+ * @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
369
+ * @param {string} params.fileId - File ID.
370
+ * @param {string} params.resourceId - Composite ID in the format {databaseId:collectionId}, identifying a collection within a database.
371
+ * @param {boolean} params.internalFile - Is the file stored in an internal bucket?
372
+ * @throws {AppwriteException}
373
+ * @returns {Promise<Models.Migration>}
374
+ */
375
+ createCSVImport(params: { bucketId: string, fileId: string, resourceId: string, internalFile?: boolean }): Promise<Models.Migration>;
143
376
  /**
144
377
  * Import documents from a CSV file into your Appwrite database. This endpoint allows you to import documents from a CSV file uploaded to Appwrite Storage bucket.
145
378
  *
146
- * @param {string} bucketId
147
- * @param {string} fileId
148
- * @param {string} resourceId
379
+ * @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
380
+ * @param {string} fileId - File ID.
381
+ * @param {string} resourceId - Composite ID in the format {databaseId:collectionId}, identifying a collection within a database.
382
+ * @param {boolean} internalFile - Is the file stored in an internal bucket?
149
383
  * @throws {AppwriteException}
150
384
  * @returns {Promise<Models.Migration>}
385
+ * @deprecated Use the object parameter style method for a better developer experience.
151
386
  */
152
- createCsvMigration(bucketId: string, fileId: string, resourceId: string): Promise<Models.Migration> {
387
+ createCSVImport(bucketId: string, fileId: string, resourceId: string, internalFile?: boolean): Promise<Models.Migration>;
388
+ createCSVImport(
389
+ paramsOrFirst: { bucketId: string, fileId: string, resourceId: string, internalFile?: boolean } | string,
390
+ ...rest: [(string)?, (string)?, (boolean)?]
391
+ ): Promise<Models.Migration> {
392
+ let params: { bucketId: string, fileId: string, resourceId: string, internalFile?: boolean };
393
+
394
+ if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
395
+ params = (paramsOrFirst || {}) as { bucketId: string, fileId: string, resourceId: string, internalFile?: boolean };
396
+ } else {
397
+ params = {
398
+ bucketId: paramsOrFirst as string,
399
+ fileId: rest[0] as string,
400
+ resourceId: rest[1] as string,
401
+ internalFile: rest[2] as boolean
402
+ };
403
+ }
404
+
405
+ const bucketId = params.bucketId;
406
+ const fileId = params.fileId;
407
+ const resourceId = params.resourceId;
408
+ const internalFile = params.internalFile;
409
+
153
410
  if (typeof bucketId === 'undefined') {
154
411
  throw new AppwriteException('Missing required parameter: "bucketId"');
155
412
  }
@@ -159,7 +416,8 @@ export class Migrations {
159
416
  if (typeof resourceId === 'undefined') {
160
417
  throw new AppwriteException('Missing required parameter: "resourceId"');
161
418
  }
162
- const apiPath = '/migrations/csv';
419
+
420
+ const apiPath = '/migrations/csv/imports';
163
421
  const payload: Payload = {};
164
422
  if (typeof bucketId !== 'undefined') {
165
423
  payload['bucketId'] = bucketId;
@@ -170,6 +428,9 @@ export class Migrations {
170
428
  if (typeof resourceId !== 'undefined') {
171
429
  payload['resourceId'] = resourceId;
172
430
  }
431
+ if (typeof internalFile !== 'undefined') {
432
+ payload['internalFile'] = internalFile;
433
+ }
173
434
  const uri = new URL(this.client.config.endpoint + apiPath);
174
435
 
175
436
  const apiHeaders: { [header: string]: string } = {
@@ -187,18 +448,47 @@ export class Migrations {
187
448
  /**
188
449
  * Migrate data from a Firebase project to your Appwrite project. This endpoint allows you to migrate resources like authentication and other supported services from a Firebase project.
189
450
  *
190
- * @param {string[]} resources
191
- * @param {string} serviceAccount
451
+ * @param {string[]} params.resources - List of resources to migrate
452
+ * @param {string} params.serviceAccount - JSON of the Firebase service account credentials
453
+ * @throws {AppwriteException}
454
+ * @returns {Promise<Models.Migration>}
455
+ */
456
+ createFirebaseMigration(params: { resources: string[], serviceAccount: string }): Promise<Models.Migration>;
457
+ /**
458
+ * Migrate data from a Firebase project to your Appwrite project. This endpoint allows you to migrate resources like authentication and other supported services from a Firebase project.
459
+ *
460
+ * @param {string[]} resources - List of resources to migrate
461
+ * @param {string} serviceAccount - JSON of the Firebase service account credentials
192
462
  * @throws {AppwriteException}
193
463
  * @returns {Promise<Models.Migration>}
464
+ * @deprecated Use the object parameter style method for a better developer experience.
194
465
  */
195
- createFirebaseMigration(resources: string[], serviceAccount: string): Promise<Models.Migration> {
466
+ createFirebaseMigration(resources: string[], serviceAccount: string): Promise<Models.Migration>;
467
+ createFirebaseMigration(
468
+ paramsOrFirst: { resources: string[], serviceAccount: string } | string[],
469
+ ...rest: [(string)?]
470
+ ): Promise<Models.Migration> {
471
+ let params: { resources: string[], serviceAccount: string };
472
+
473
+ if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
474
+ params = (paramsOrFirst || {}) as { resources: string[], serviceAccount: string };
475
+ } else {
476
+ params = {
477
+ resources: paramsOrFirst as string[],
478
+ serviceAccount: rest[0] as string
479
+ };
480
+ }
481
+
482
+ const resources = params.resources;
483
+ const serviceAccount = params.serviceAccount;
484
+
196
485
  if (typeof resources === 'undefined') {
197
486
  throw new AppwriteException('Missing required parameter: "resources"');
198
487
  }
199
488
  if (typeof serviceAccount === 'undefined') {
200
489
  throw new AppwriteException('Missing required parameter: "serviceAccount"');
201
490
  }
491
+
202
492
  const apiPath = '/migrations/firebase';
203
493
  const payload: Payload = {};
204
494
  if (typeof resources !== 'undefined') {
@@ -224,18 +514,47 @@ export class Migrations {
224
514
  /**
225
515
  * Generate a report of the data in a Firebase project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
226
516
  *
227
- * @param {string[]} resources
228
- * @param {string} serviceAccount
517
+ * @param {string[]} params.resources - List of resources to migrate
518
+ * @param {string} params.serviceAccount - JSON of the Firebase service account credentials
229
519
  * @throws {AppwriteException}
230
520
  * @returns {Promise<Models.MigrationReport>}
231
521
  */
232
- getFirebaseReport(resources: string[], serviceAccount: string): Promise<Models.MigrationReport> {
522
+ getFirebaseReport(params: { resources: string[], serviceAccount: string }): Promise<Models.MigrationReport>;
523
+ /**
524
+ * Generate a report of the data in a Firebase project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
525
+ *
526
+ * @param {string[]} resources - List of resources to migrate
527
+ * @param {string} serviceAccount - JSON of the Firebase service account credentials
528
+ * @throws {AppwriteException}
529
+ * @returns {Promise<Models.MigrationReport>}
530
+ * @deprecated Use the object parameter style method for a better developer experience.
531
+ */
532
+ getFirebaseReport(resources: string[], serviceAccount: string): Promise<Models.MigrationReport>;
533
+ getFirebaseReport(
534
+ paramsOrFirst: { resources: string[], serviceAccount: string } | string[],
535
+ ...rest: [(string)?]
536
+ ): Promise<Models.MigrationReport> {
537
+ let params: { resources: string[], serviceAccount: string };
538
+
539
+ if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
540
+ params = (paramsOrFirst || {}) as { resources: string[], serviceAccount: string };
541
+ } else {
542
+ params = {
543
+ resources: paramsOrFirst as string[],
544
+ serviceAccount: rest[0] as string
545
+ };
546
+ }
547
+
548
+ const resources = params.resources;
549
+ const serviceAccount = params.serviceAccount;
550
+
233
551
  if (typeof resources === 'undefined') {
234
552
  throw new AppwriteException('Missing required parameter: "resources"');
235
553
  }
236
554
  if (typeof serviceAccount === 'undefined') {
237
555
  throw new AppwriteException('Missing required parameter: "serviceAccount"');
238
556
  }
557
+
239
558
  const apiPath = '/migrations/firebase/report';
240
559
  const payload: Payload = {};
241
560
  if (typeof resources !== 'undefined') {
@@ -260,18 +579,64 @@ export class Migrations {
260
579
  /**
261
580
  * Migrate data from an NHost project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from an NHost project.
262
581
  *
263
- * @param {string[]} resources
264
- * @param {string} subdomain
265
- * @param {string} region
266
- * @param {string} adminSecret
267
- * @param {string} database
268
- * @param {string} username
269
- * @param {string} password
270
- * @param {number} port
582
+ * @param {string[]} params.resources - List of resources to migrate
583
+ * @param {string} params.subdomain - Source's Subdomain
584
+ * @param {string} params.region - Source's Region
585
+ * @param {string} params.adminSecret - Source's Admin Secret
586
+ * @param {string} params.database - Source's Database Name
587
+ * @param {string} params.username - Source's Database Username
588
+ * @param {string} params.password - Source's Database Password
589
+ * @param {number} params.port - Source's Database Port
590
+ * @throws {AppwriteException}
591
+ * @returns {Promise<Models.Migration>}
592
+ */
593
+ createNHostMigration(params: { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number }): Promise<Models.Migration>;
594
+ /**
595
+ * Migrate data from an NHost project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from an NHost project.
596
+ *
597
+ * @param {string[]} resources - List of resources to migrate
598
+ * @param {string} subdomain - Source's Subdomain
599
+ * @param {string} region - Source's Region
600
+ * @param {string} adminSecret - Source's Admin Secret
601
+ * @param {string} database - Source's Database Name
602
+ * @param {string} username - Source's Database Username
603
+ * @param {string} password - Source's Database Password
604
+ * @param {number} port - Source's Database Port
271
605
  * @throws {AppwriteException}
272
606
  * @returns {Promise<Models.Migration>}
607
+ * @deprecated Use the object parameter style method for a better developer experience.
273
608
  */
274
- createNHostMigration(resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number): Promise<Models.Migration> {
609
+ createNHostMigration(resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number): Promise<Models.Migration>;
610
+ createNHostMigration(
611
+ paramsOrFirst: { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number } | string[],
612
+ ...rest: [(string)?, (string)?, (string)?, (string)?, (string)?, (string)?, (number)?]
613
+ ): Promise<Models.Migration> {
614
+ let params: { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number };
615
+
616
+ if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
617
+ params = (paramsOrFirst || {}) as { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number };
618
+ } else {
619
+ params = {
620
+ resources: paramsOrFirst as string[],
621
+ subdomain: rest[0] as string,
622
+ region: rest[1] as string,
623
+ adminSecret: rest[2] as string,
624
+ database: rest[3] as string,
625
+ username: rest[4] as string,
626
+ password: rest[5] as string,
627
+ port: rest[6] as number
628
+ };
629
+ }
630
+
631
+ const resources = params.resources;
632
+ const subdomain = params.subdomain;
633
+ const region = params.region;
634
+ const adminSecret = params.adminSecret;
635
+ const database = params.database;
636
+ const username = params.username;
637
+ const password = params.password;
638
+ const port = params.port;
639
+
275
640
  if (typeof resources === 'undefined') {
276
641
  throw new AppwriteException('Missing required parameter: "resources"');
277
642
  }
@@ -293,6 +658,7 @@ export class Migrations {
293
658
  if (typeof password === 'undefined') {
294
659
  throw new AppwriteException('Missing required parameter: "password"');
295
660
  }
661
+
296
662
  const apiPath = '/migrations/nhost';
297
663
  const payload: Payload = {};
298
664
  if (typeof resources !== 'undefined') {
@@ -336,18 +702,64 @@ export class Migrations {
336
702
  /**
337
703
  * Generate a detailed report of the data in an NHost project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
338
704
  *
339
- * @param {string[]} resources
340
- * @param {string} subdomain
341
- * @param {string} region
342
- * @param {string} adminSecret
343
- * @param {string} database
344
- * @param {string} username
345
- * @param {string} password
346
- * @param {number} port
705
+ * @param {string[]} params.resources - List of resources to migrate.
706
+ * @param {string} params.subdomain - Source's Subdomain.
707
+ * @param {string} params.region - Source's Region.
708
+ * @param {string} params.adminSecret - Source's Admin Secret.
709
+ * @param {string} params.database - Source's Database Name.
710
+ * @param {string} params.username - Source's Database Username.
711
+ * @param {string} params.password - Source's Database Password.
712
+ * @param {number} params.port - Source's Database Port.
347
713
  * @throws {AppwriteException}
348
714
  * @returns {Promise<Models.MigrationReport>}
349
715
  */
350
- getNHostReport(resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number): Promise<Models.MigrationReport> {
716
+ getNHostReport(params: { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number }): Promise<Models.MigrationReport>;
717
+ /**
718
+ * Generate a detailed report of the data in an NHost project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
719
+ *
720
+ * @param {string[]} resources - List of resources to migrate.
721
+ * @param {string} subdomain - Source's Subdomain.
722
+ * @param {string} region - Source's Region.
723
+ * @param {string} adminSecret - Source's Admin Secret.
724
+ * @param {string} database - Source's Database Name.
725
+ * @param {string} username - Source's Database Username.
726
+ * @param {string} password - Source's Database Password.
727
+ * @param {number} port - Source's Database Port.
728
+ * @throws {AppwriteException}
729
+ * @returns {Promise<Models.MigrationReport>}
730
+ * @deprecated Use the object parameter style method for a better developer experience.
731
+ */
732
+ getNHostReport(resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number): Promise<Models.MigrationReport>;
733
+ getNHostReport(
734
+ paramsOrFirst: { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number } | string[],
735
+ ...rest: [(string)?, (string)?, (string)?, (string)?, (string)?, (string)?, (number)?]
736
+ ): Promise<Models.MigrationReport> {
737
+ let params: { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number };
738
+
739
+ if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
740
+ params = (paramsOrFirst || {}) as { resources: string[], subdomain: string, region: string, adminSecret: string, database: string, username: string, password: string, port?: number };
741
+ } else {
742
+ params = {
743
+ resources: paramsOrFirst as string[],
744
+ subdomain: rest[0] as string,
745
+ region: rest[1] as string,
746
+ adminSecret: rest[2] as string,
747
+ database: rest[3] as string,
748
+ username: rest[4] as string,
749
+ password: rest[5] as string,
750
+ port: rest[6] as number
751
+ };
752
+ }
753
+
754
+ const resources = params.resources;
755
+ const subdomain = params.subdomain;
756
+ const region = params.region;
757
+ const adminSecret = params.adminSecret;
758
+ const database = params.database;
759
+ const username = params.username;
760
+ const password = params.password;
761
+ const port = params.port;
762
+
351
763
  if (typeof resources === 'undefined') {
352
764
  throw new AppwriteException('Missing required parameter: "resources"');
353
765
  }
@@ -369,6 +781,7 @@ export class Migrations {
369
781
  if (typeof password === 'undefined') {
370
782
  throw new AppwriteException('Missing required parameter: "password"');
371
783
  }
784
+
372
785
  const apiPath = '/migrations/nhost/report';
373
786
  const payload: Payload = {};
374
787
  if (typeof resources !== 'undefined') {
@@ -411,17 +824,60 @@ export class Migrations {
411
824
  /**
412
825
  * Migrate data from a Supabase project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from a Supabase project.
413
826
  *
414
- * @param {string[]} resources
415
- * @param {string} endpoint
416
- * @param {string} apiKey
417
- * @param {string} databaseHost
418
- * @param {string} username
419
- * @param {string} password
420
- * @param {number} port
827
+ * @param {string[]} params.resources - List of resources to migrate
828
+ * @param {string} params.endpoint - Source's Supabase Endpoint
829
+ * @param {string} params.apiKey - Source's API Key
830
+ * @param {string} params.databaseHost - Source's Database Host
831
+ * @param {string} params.username - Source's Database Username
832
+ * @param {string} params.password - Source's Database Password
833
+ * @param {number} params.port - Source's Database Port
421
834
  * @throws {AppwriteException}
422
835
  * @returns {Promise<Models.Migration>}
423
836
  */
424
- createSupabaseMigration(resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number): Promise<Models.Migration> {
837
+ createSupabaseMigration(params: { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number }): Promise<Models.Migration>;
838
+ /**
839
+ * Migrate data from a Supabase project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from a Supabase project.
840
+ *
841
+ * @param {string[]} resources - List of resources to migrate
842
+ * @param {string} endpoint - Source's Supabase Endpoint
843
+ * @param {string} apiKey - Source's API Key
844
+ * @param {string} databaseHost - Source's Database Host
845
+ * @param {string} username - Source's Database Username
846
+ * @param {string} password - Source's Database Password
847
+ * @param {number} port - Source's Database Port
848
+ * @throws {AppwriteException}
849
+ * @returns {Promise<Models.Migration>}
850
+ * @deprecated Use the object parameter style method for a better developer experience.
851
+ */
852
+ createSupabaseMigration(resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number): Promise<Models.Migration>;
853
+ createSupabaseMigration(
854
+ paramsOrFirst: { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number } | string[],
855
+ ...rest: [(string)?, (string)?, (string)?, (string)?, (string)?, (number)?]
856
+ ): Promise<Models.Migration> {
857
+ let params: { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number };
858
+
859
+ if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
860
+ params = (paramsOrFirst || {}) as { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number };
861
+ } else {
862
+ params = {
863
+ resources: paramsOrFirst as string[],
864
+ endpoint: rest[0] as string,
865
+ apiKey: rest[1] as string,
866
+ databaseHost: rest[2] as string,
867
+ username: rest[3] as string,
868
+ password: rest[4] as string,
869
+ port: rest[5] as number
870
+ };
871
+ }
872
+
873
+ const resources = params.resources;
874
+ const endpoint = params.endpoint;
875
+ const apiKey = params.apiKey;
876
+ const databaseHost = params.databaseHost;
877
+ const username = params.username;
878
+ const password = params.password;
879
+ const port = params.port;
880
+
425
881
  if (typeof resources === 'undefined') {
426
882
  throw new AppwriteException('Missing required parameter: "resources"');
427
883
  }
@@ -440,6 +896,7 @@ export class Migrations {
440
896
  if (typeof password === 'undefined') {
441
897
  throw new AppwriteException('Missing required parameter: "password"');
442
898
  }
899
+
443
900
  const apiPath = '/migrations/supabase';
444
901
  const payload: Payload = {};
445
902
  if (typeof resources !== 'undefined') {
@@ -480,17 +937,60 @@ export class Migrations {
480
937
  /**
481
938
  * Generate a report of the data in a Supabase project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
482
939
  *
483
- * @param {string[]} resources
484
- * @param {string} endpoint
485
- * @param {string} apiKey
486
- * @param {string} databaseHost
487
- * @param {string} username
488
- * @param {string} password
489
- * @param {number} port
940
+ * @param {string[]} params.resources - List of resources to migrate
941
+ * @param {string} params.endpoint - Source's Supabase Endpoint.
942
+ * @param {string} params.apiKey - Source's API Key.
943
+ * @param {string} params.databaseHost - Source's Database Host.
944
+ * @param {string} params.username - Source's Database Username.
945
+ * @param {string} params.password - Source's Database Password.
946
+ * @param {number} params.port - Source's Database Port.
490
947
  * @throws {AppwriteException}
491
948
  * @returns {Promise<Models.MigrationReport>}
492
949
  */
493
- getSupabaseReport(resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number): Promise<Models.MigrationReport> {
950
+ getSupabaseReport(params: { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number }): Promise<Models.MigrationReport>;
951
+ /**
952
+ * Generate a report of the data in a Supabase project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
953
+ *
954
+ * @param {string[]} resources - List of resources to migrate
955
+ * @param {string} endpoint - Source's Supabase Endpoint.
956
+ * @param {string} apiKey - Source's API Key.
957
+ * @param {string} databaseHost - Source's Database Host.
958
+ * @param {string} username - Source's Database Username.
959
+ * @param {string} password - Source's Database Password.
960
+ * @param {number} port - Source's Database Port.
961
+ * @throws {AppwriteException}
962
+ * @returns {Promise<Models.MigrationReport>}
963
+ * @deprecated Use the object parameter style method for a better developer experience.
964
+ */
965
+ getSupabaseReport(resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number): Promise<Models.MigrationReport>;
966
+ getSupabaseReport(
967
+ paramsOrFirst: { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number } | string[],
968
+ ...rest: [(string)?, (string)?, (string)?, (string)?, (string)?, (number)?]
969
+ ): Promise<Models.MigrationReport> {
970
+ let params: { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number };
971
+
972
+ if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
973
+ params = (paramsOrFirst || {}) as { resources: string[], endpoint: string, apiKey: string, databaseHost: string, username: string, password: string, port?: number };
974
+ } else {
975
+ params = {
976
+ resources: paramsOrFirst as string[],
977
+ endpoint: rest[0] as string,
978
+ apiKey: rest[1] as string,
979
+ databaseHost: rest[2] as string,
980
+ username: rest[3] as string,
981
+ password: rest[4] as string,
982
+ port: rest[5] as number
983
+ };
984
+ }
985
+
986
+ const resources = params.resources;
987
+ const endpoint = params.endpoint;
988
+ const apiKey = params.apiKey;
989
+ const databaseHost = params.databaseHost;
990
+ const username = params.username;
991
+ const password = params.password;
992
+ const port = params.port;
993
+
494
994
  if (typeof resources === 'undefined') {
495
995
  throw new AppwriteException('Missing required parameter: "resources"');
496
996
  }
@@ -509,6 +1009,7 @@ export class Migrations {
509
1009
  if (typeof password === 'undefined') {
510
1010
  throw new AppwriteException('Missing required parameter: "password"');
511
1011
  }
1012
+
512
1013
  const apiPath = '/migrations/supabase/report';
513
1014
  const payload: Payload = {};
514
1015
  if (typeof resources !== 'undefined') {
@@ -548,14 +1049,39 @@ export class Migrations {
548
1049
  /**
549
1050
  * Get a migration by its unique ID. This endpoint returns detailed information about a specific migration including its current status, progress, and any errors that occurred during the migration process.
550
1051
  *
551
- * @param {string} migrationId
1052
+ * @param {string} params.migrationId - Migration unique ID.
552
1053
  * @throws {AppwriteException}
553
1054
  * @returns {Promise<Models.Migration>}
554
1055
  */
555
- get(migrationId: string): Promise<Models.Migration> {
1056
+ get(params: { migrationId: string }): Promise<Models.Migration>;
1057
+ /**
1058
+ * Get a migration by its unique ID. This endpoint returns detailed information about a specific migration including its current status, progress, and any errors that occurred during the migration process.
1059
+ *
1060
+ * @param {string} migrationId - Migration unique ID.
1061
+ * @throws {AppwriteException}
1062
+ * @returns {Promise<Models.Migration>}
1063
+ * @deprecated Use the object parameter style method for a better developer experience.
1064
+ */
1065
+ get(migrationId: string): Promise<Models.Migration>;
1066
+ get(
1067
+ paramsOrFirst: { migrationId: string } | string
1068
+ ): Promise<Models.Migration> {
1069
+ let params: { migrationId: string };
1070
+
1071
+ if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
1072
+ params = (paramsOrFirst || {}) as { migrationId: string };
1073
+ } else {
1074
+ params = {
1075
+ migrationId: paramsOrFirst as string
1076
+ };
1077
+ }
1078
+
1079
+ const migrationId = params.migrationId;
1080
+
556
1081
  if (typeof migrationId === 'undefined') {
557
1082
  throw new AppwriteException('Missing required parameter: "migrationId"');
558
1083
  }
1084
+
559
1085
  const apiPath = '/migrations/{migrationId}'.replace('{migrationId}', migrationId);
560
1086
  const payload: Payload = {};
561
1087
  const uri = new URL(this.client.config.endpoint + apiPath);
@@ -574,14 +1100,39 @@ export class Migrations {
574
1100
  /**
575
1101
  * Retry a failed migration. This endpoint allows you to retry a migration that has previously failed.
576
1102
  *
577
- * @param {string} migrationId
1103
+ * @param {string} params.migrationId - Migration unique ID.
1104
+ * @throws {AppwriteException}
1105
+ * @returns {Promise<Models.Migration>}
1106
+ */
1107
+ retry(params: { migrationId: string }): Promise<Models.Migration>;
1108
+ /**
1109
+ * Retry a failed migration. This endpoint allows you to retry a migration that has previously failed.
1110
+ *
1111
+ * @param {string} migrationId - Migration unique ID.
578
1112
  * @throws {AppwriteException}
579
1113
  * @returns {Promise<Models.Migration>}
1114
+ * @deprecated Use the object parameter style method for a better developer experience.
580
1115
  */
581
- retry(migrationId: string): Promise<Models.Migration> {
1116
+ retry(migrationId: string): Promise<Models.Migration>;
1117
+ retry(
1118
+ paramsOrFirst: { migrationId: string } | string
1119
+ ): Promise<Models.Migration> {
1120
+ let params: { migrationId: string };
1121
+
1122
+ if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
1123
+ params = (paramsOrFirst || {}) as { migrationId: string };
1124
+ } else {
1125
+ params = {
1126
+ migrationId: paramsOrFirst as string
1127
+ };
1128
+ }
1129
+
1130
+ const migrationId = params.migrationId;
1131
+
582
1132
  if (typeof migrationId === 'undefined') {
583
1133
  throw new AppwriteException('Missing required parameter: "migrationId"');
584
1134
  }
1135
+
585
1136
  const apiPath = '/migrations/{migrationId}'.replace('{migrationId}', migrationId);
586
1137
  const payload: Payload = {};
587
1138
  const uri = new URL(this.client.config.endpoint + apiPath);
@@ -599,16 +1150,41 @@ export class Migrations {
599
1150
  }
600
1151
 
601
1152
  /**
602
- * Delete a migration by its unique ID. This endpoint allows you to remove a migration from your project&#039;s migration history.
1153
+ * Delete a migration by its unique ID. This endpoint allows you to remove a migration from your project's migration history.
603
1154
  *
604
- * @param {string} migrationId
1155
+ * @param {string} params.migrationId - Migration ID.
605
1156
  * @throws {AppwriteException}
606
1157
  * @returns {Promise<{}>}
607
1158
  */
608
- delete(migrationId: string): Promise<{}> {
1159
+ delete(params: { migrationId: string }): Promise<{}>;
1160
+ /**
1161
+ * Delete a migration by its unique ID. This endpoint allows you to remove a migration from your project's migration history.
1162
+ *
1163
+ * @param {string} migrationId - Migration ID.
1164
+ * @throws {AppwriteException}
1165
+ * @returns {Promise<{}>}
1166
+ * @deprecated Use the object parameter style method for a better developer experience.
1167
+ */
1168
+ delete(migrationId: string): Promise<{}>;
1169
+ delete(
1170
+ paramsOrFirst: { migrationId: string } | string
1171
+ ): Promise<{}> {
1172
+ let params: { migrationId: string };
1173
+
1174
+ if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
1175
+ params = (paramsOrFirst || {}) as { migrationId: string };
1176
+ } else {
1177
+ params = {
1178
+ migrationId: paramsOrFirst as string
1179
+ };
1180
+ }
1181
+
1182
+ const migrationId = params.migrationId;
1183
+
609
1184
  if (typeof migrationId === 'undefined') {
610
1185
  throw new AppwriteException('Missing required parameter: "migrationId"');
611
1186
  }
1187
+
612
1188
  const apiPath = '/migrations/{migrationId}'.replace('{migrationId}', migrationId);
613
1189
  const payload: Payload = {};
614
1190
  const uri = new URL(this.client.config.endpoint + apiPath);