@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
@@ -1,345 +1,883 @@
1
1
  import { Client } from '../client';
2
2
  import type { Models } from '../models';
3
- import { BillingPlan } from '../enums/billing-plan';
3
+ import { Platform } from '../enums/platform';
4
4
  export declare class Organizations {
5
5
  client: Client;
6
6
  constructor(client: Client);
7
7
  /**
8
8
  * Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.
9
9
  *
10
- * @param {string[]} queries
11
- * @param {string} search
10
+ * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, total, billingPlan, paymentMethodId, backupPaymentMethodId, platform
11
+ * @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
12
12
  * @throws {AppwriteException}
13
13
  * @returns {Promise<Models.OrganizationList<Preferences>>}
14
14
  */
15
+ list<Preferences extends Models.Preferences = Models.DefaultPreferences>(params?: {
16
+ queries?: string[];
17
+ search?: string;
18
+ }): Promise<Models.OrganizationList<Preferences>>;
19
+ /**
20
+ * Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.
21
+ *
22
+ * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, total, billingPlan, paymentMethodId, backupPaymentMethodId, platform
23
+ * @param {string} search - Search term to filter your list results. Max length: 256 chars.
24
+ * @throws {AppwriteException}
25
+ * @returns {Promise<Models.OrganizationList<Preferences>>}
26
+ * @deprecated Use the object parameter style method for a better developer experience.
27
+ */
15
28
  list<Preferences extends Models.Preferences = Models.DefaultPreferences>(queries?: string[], search?: string): Promise<Models.OrganizationList<Preferences>>;
16
29
  /**
17
30
  * Create a new organization.
18
31
  *
19
32
  *
20
- * @param {string} organizationId
21
- * @param {string} name
22
- * @param {BillingPlan} billingPlan
23
- * @param {string} paymentMethodId
24
- * @param {string} billingAddressId
25
- * @param {string[]} invites
26
- * @param {string} couponId
27
- * @param {string} taxId
28
- * @param {number} budget
33
+ * @param {string} params.organizationId - Organization ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
34
+ * @param {string} params.name - Organization name. Max length: 128 chars.
35
+ * @param {string} params.billingPlan - Organization billing plan chosen
36
+ * @param {string} params.paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
37
+ * @param {string} params.billingAddressId - Unique ID of billing address
38
+ * @param {string[]} params.invites - Additional member invites
39
+ * @param {string} params.couponId - Coupon id
40
+ * @param {string} params.taxId - Tax Id associated to billing.
41
+ * @param {number} params.budget - Budget limit for additional usage set for the organization
42
+ * @param {Platform} params.platform - Platform type
43
+ * @throws {AppwriteException}
44
+ * @returns {Promise<Models.Organization<Preferences> | Models.PaymentAuthentication>}
45
+ */
46
+ create<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
47
+ organizationId: string;
48
+ name: string;
49
+ billingPlan: string;
50
+ paymentMethodId?: string;
51
+ billingAddressId?: string;
52
+ invites?: string[];
53
+ couponId?: string;
54
+ taxId?: string;
55
+ budget?: number;
56
+ platform?: Platform;
57
+ }): Promise<Models.Organization<Preferences> | Models.PaymentAuthentication>;
58
+ /**
59
+ * Create a new organization.
60
+ *
61
+ *
62
+ * @param {string} organizationId - Organization ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
63
+ * @param {string} name - Organization name. Max length: 128 chars.
64
+ * @param {string} billingPlan - Organization billing plan chosen
65
+ * @param {string} paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
66
+ * @param {string} billingAddressId - Unique ID of billing address
67
+ * @param {string[]} invites - Additional member invites
68
+ * @param {string} couponId - Coupon id
69
+ * @param {string} taxId - Tax Id associated to billing.
70
+ * @param {number} budget - Budget limit for additional usage set for the organization
71
+ * @param {Platform} platform - Platform type
29
72
  * @throws {AppwriteException}
30
- * @returns {Promise<Models.Organization<Preferences>>}
73
+ * @returns {Promise<Models.Organization<Preferences> | Models.PaymentAuthentication>}
74
+ * @deprecated Use the object parameter style method for a better developer experience.
75
+ */
76
+ create<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, name: string, billingPlan: string, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number, platform?: Platform): Promise<Models.Organization<Preferences> | Models.PaymentAuthentication>;
77
+ /**
78
+ * Get estimation for creating an organization.
79
+ *
80
+ * @param {string} params.billingPlan - Organization billing plan chosen
81
+ * @param {string} params.paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
82
+ * @param {string[]} params.invites - Additional member invites
83
+ * @param {string} params.couponId - Coupon id
84
+ * @param {Platform} params.platform - Platform type
85
+ * @throws {AppwriteException}
86
+ * @returns {Promise<Models.Estimation>}
31
87
  */
32
- create<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, name: string, billingPlan: BillingPlan, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number): Promise<Models.Organization<Preferences>>;
88
+ estimationCreateOrganization(params: {
89
+ billingPlan: string;
90
+ paymentMethodId?: string;
91
+ invites?: string[];
92
+ couponId?: string;
93
+ platform?: Platform;
94
+ }): Promise<Models.Estimation>;
33
95
  /**
34
96
  * Get estimation for creating an organization.
35
97
  *
36
- * @param {BillingPlan} billingPlan
37
- * @param {string} paymentMethodId
38
- * @param {string[]} invites
39
- * @param {string} couponId
98
+ * @param {string} billingPlan - Organization billing plan chosen
99
+ * @param {string} paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
100
+ * @param {string[]} invites - Additional member invites
101
+ * @param {string} couponId - Coupon id
102
+ * @param {Platform} platform - Platform type
40
103
  * @throws {AppwriteException}
41
104
  * @returns {Promise<Models.Estimation>}
105
+ * @deprecated Use the object parameter style method for a better developer experience.
106
+ */
107
+ estimationCreateOrganization(billingPlan: string, paymentMethodId?: string, invites?: string[], couponId?: string, platform?: Platform): Promise<Models.Estimation>;
108
+ /**
109
+ * Delete an organization.
110
+ *
111
+ * @param {string} params.organizationId - Team ID.
112
+ * @throws {AppwriteException}
113
+ * @returns {Promise<{}>}
42
114
  */
43
- estimationCreateOrganization(billingPlan: BillingPlan, paymentMethodId?: string, invites?: string[], couponId?: string): Promise<Models.Estimation>;
115
+ delete(params: {
116
+ organizationId: string;
117
+ }): Promise<{}>;
44
118
  /**
45
119
  * Delete an organization.
46
120
  *
47
- * @param {string} organizationId
121
+ * @param {string} organizationId - Team ID.
48
122
  * @throws {AppwriteException}
49
123
  * @returns {Promise<{}>}
124
+ * @deprecated Use the object parameter style method for a better developer experience.
50
125
  */
51
126
  delete(organizationId: string): Promise<{}>;
52
127
  /**
53
128
  * Get a list of all aggregations for an organization.
54
129
  *
55
- * @param {string} organizationId
56
- * @param {string[]} queries
130
+ * @param {string} params.organizationId - Organization ID
131
+ * @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: teamId, aggregationId, from, to
57
132
  * @throws {AppwriteException}
58
133
  * @returns {Promise<Models.AggregationTeamList>}
59
134
  */
135
+ listAggregations(params: {
136
+ organizationId: string;
137
+ queries?: string[];
138
+ }): Promise<Models.AggregationTeamList>;
139
+ /**
140
+ * Get a list of all aggregations for an organization.
141
+ *
142
+ * @param {string} organizationId - Organization ID
143
+ * @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: teamId, aggregationId, from, to
144
+ * @throws {AppwriteException}
145
+ * @returns {Promise<Models.AggregationTeamList>}
146
+ * @deprecated Use the object parameter style method for a better developer experience.
147
+ */
60
148
  listAggregations(organizationId: string, queries?: string[]): Promise<Models.AggregationTeamList>;
61
149
  /**
62
- * Get a specific aggregation using it&#039;s aggregation ID.
150
+ * Get a specific aggregation using it's aggregation ID.
63
151
  *
64
- * @param {string} organizationId
65
- * @param {string} aggregationId
152
+ * @param {string} params.organizationId - Organization ID
153
+ * @param {string} params.aggregationId - Invoice unique ID
154
+ * @param {number} params.limit - Maximum number of project aggregations to return in response. By default will return maximum 5 results. Maximum of 10 results allowed per request.
155
+ * @param {number} params.offset - Offset value. The default value is 0. Use this param to manage pagination.
66
156
  * @throws {AppwriteException}
67
157
  * @returns {Promise<Models.AggregationTeam>}
68
158
  */
69
- getAggregation(organizationId: string, aggregationId: string): Promise<Models.AggregationTeam>;
159
+ getAggregation(params: {
160
+ organizationId: string;
161
+ aggregationId: string;
162
+ limit?: number;
163
+ offset?: number;
164
+ }): Promise<Models.AggregationTeam>;
165
+ /**
166
+ * Get a specific aggregation using it's aggregation ID.
167
+ *
168
+ * @param {string} organizationId - Organization ID
169
+ * @param {string} aggregationId - Invoice unique ID
170
+ * @param {number} limit - Maximum number of project aggregations to return in response. By default will return maximum 5 results. Maximum of 10 results allowed per request.
171
+ * @param {number} offset - Offset value. The default value is 0. Use this param to manage pagination.
172
+ * @throws {AppwriteException}
173
+ * @returns {Promise<Models.AggregationTeam>}
174
+ * @deprecated Use the object parameter style method for a better developer experience.
175
+ */
176
+ getAggregation(organizationId: string, aggregationId: string, limit?: number, offset?: number): Promise<Models.AggregationTeam>;
177
+ /**
178
+ * Set a billing address for an organization.
179
+ *
180
+ * @param {string} params.organizationId - Organization ID
181
+ * @param {string} params.billingAddressId - Unique ID of billing address
182
+ * @throws {AppwriteException}
183
+ * @returns {Promise<Models.Organization<Preferences>>}
184
+ */
185
+ setBillingAddress<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
186
+ organizationId: string;
187
+ billingAddressId: string;
188
+ }): Promise<Models.Organization<Preferences>>;
70
189
  /**
71
190
  * Set a billing address for an organization.
72
191
  *
73
- * @param {string} organizationId
74
- * @param {string} billingAddressId
192
+ * @param {string} organizationId - Organization ID
193
+ * @param {string} billingAddressId - Unique ID of billing address
75
194
  * @throws {AppwriteException}
76
195
  * @returns {Promise<Models.Organization<Preferences>>}
196
+ * @deprecated Use the object parameter style method for a better developer experience.
77
197
  */
78
198
  setBillingAddress<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, billingAddressId: string): Promise<Models.Organization<Preferences>>;
79
199
  /**
80
- * Delete a team&#039;s billing address.
200
+ * Delete a team's billing address.
81
201
  *
82
- * @param {string} organizationId
202
+ * @param {string} params.organizationId - Organization ID
83
203
  * @throws {AppwriteException}
84
204
  * @returns {Promise<{}>}
85
205
  */
206
+ deleteBillingAddress(params: {
207
+ organizationId: string;
208
+ }): Promise<{}>;
209
+ /**
210
+ * Delete a team's billing address.
211
+ *
212
+ * @param {string} organizationId - Organization ID
213
+ * @throws {AppwriteException}
214
+ * @returns {Promise<{}>}
215
+ * @deprecated Use the object parameter style method for a better developer experience.
216
+ */
86
217
  deleteBillingAddress(organizationId: string): Promise<{}>;
87
218
  /**
88
- * Get a billing address using it&#039;s ID.
219
+ * Get a billing address using it's ID.
89
220
  *
90
- * @param {string} organizationId
91
- * @param {string} billingAddressId
221
+ * @param {string} params.organizationId - Organization ID
222
+ * @param {string} params.billingAddressId - Unique ID of billing address
92
223
  * @throws {AppwriteException}
93
224
  * @returns {Promise<Models.BillingAddress>}
94
225
  */
226
+ getBillingAddress(params: {
227
+ organizationId: string;
228
+ billingAddressId: string;
229
+ }): Promise<Models.BillingAddress>;
230
+ /**
231
+ * Get a billing address using it's ID.
232
+ *
233
+ * @param {string} organizationId - Organization ID
234
+ * @param {string} billingAddressId - Unique ID of billing address
235
+ * @throws {AppwriteException}
236
+ * @returns {Promise<Models.BillingAddress>}
237
+ * @deprecated Use the object parameter style method for a better developer experience.
238
+ */
95
239
  getBillingAddress(organizationId: string, billingAddressId: string): Promise<Models.BillingAddress>;
96
240
  /**
97
241
  * Set the current billing email for the organization.
98
242
  *
99
- * @param {string} organizationId
100
- * @param {string} billingEmail
243
+ * @param {string} params.organizationId - Organization ID
244
+ * @param {string} params.billingEmail - Billing email for the organization.
245
+ * @throws {AppwriteException}
246
+ * @returns {Promise<Models.Organization<Preferences>>}
247
+ */
248
+ setBillingEmail<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
249
+ organizationId: string;
250
+ billingEmail: string;
251
+ }): Promise<Models.Organization<Preferences>>;
252
+ /**
253
+ * Set the current billing email for the organization.
254
+ *
255
+ * @param {string} organizationId - Organization ID
256
+ * @param {string} billingEmail - Billing email for the organization.
101
257
  * @throws {AppwriteException}
102
258
  * @returns {Promise<Models.Organization<Preferences>>}
259
+ * @deprecated Use the object parameter style method for a better developer experience.
103
260
  */
104
261
  setBillingEmail<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, billingEmail: string): Promise<Models.Organization<Preferences>>;
105
262
  /**
106
263
  * Update the budget limit for an organization.
107
264
  *
108
- * @param {string} organizationId
109
- * @param {number} budget
110
- * @param {number[]} alerts
265
+ * @param {string} params.organizationId - Organization Unique ID
266
+ * @param {number} params.budget - Budget limit for additional usage set for the organization
267
+ * @param {number[]} params.alerts - Budget alert limit percentage
268
+ * @throws {AppwriteException}
269
+ * @returns {Promise<Models.Organization<Preferences>>}
270
+ */
271
+ updateBudget<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
272
+ organizationId: string;
273
+ budget?: number;
274
+ alerts?: number[];
275
+ }): Promise<Models.Organization<Preferences>>;
276
+ /**
277
+ * Update the budget limit for an organization.
278
+ *
279
+ * @param {string} organizationId - Organization Unique ID
280
+ * @param {number} budget - Budget limit for additional usage set for the organization
281
+ * @param {number[]} alerts - Budget alert limit percentage
111
282
  * @throws {AppwriteException}
112
283
  * @returns {Promise<Models.Organization<Preferences>>}
284
+ * @deprecated Use the object parameter style method for a better developer experience.
113
285
  */
114
286
  updateBudget<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, budget?: number, alerts?: number[]): Promise<Models.Organization<Preferences>>;
115
287
  /**
116
288
  * List all credits for an organization.
117
289
  *
118
290
  *
119
- * @param {string} organizationId
120
- * @param {string[]} queries
291
+ * @param {string} params.organizationId - Organization ID
292
+ * @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: teamId, couponId, credits, expiration, status
293
+ * @throws {AppwriteException}
294
+ * @returns {Promise<Models.CreditList>}
295
+ */
296
+ listCredits(params: {
297
+ organizationId: string;
298
+ queries?: string[];
299
+ }): Promise<Models.CreditList>;
300
+ /**
301
+ * List all credits for an organization.
302
+ *
303
+ *
304
+ * @param {string} organizationId - Organization ID
305
+ * @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: teamId, couponId, credits, expiration, status
121
306
  * @throws {AppwriteException}
122
307
  * @returns {Promise<Models.CreditList>}
308
+ * @deprecated Use the object parameter style method for a better developer experience.
123
309
  */
124
310
  listCredits(organizationId: string, queries?: string[]): Promise<Models.CreditList>;
125
311
  /**
126
312
  * Add credit to an organization using a coupon.
127
313
  *
128
- * @param {string} organizationId
129
- * @param {string} couponId
314
+ * @param {string} params.organizationId - Organization ID
315
+ * @param {string} params.couponId - ID of the coupon
130
316
  * @throws {AppwriteException}
131
317
  * @returns {Promise<Models.Credit>}
132
318
  */
319
+ addCredit(params: {
320
+ organizationId: string;
321
+ couponId: string;
322
+ }): Promise<Models.Credit>;
323
+ /**
324
+ * Add credit to an organization using a coupon.
325
+ *
326
+ * @param {string} organizationId - Organization ID
327
+ * @param {string} couponId - ID of the coupon
328
+ * @throws {AppwriteException}
329
+ * @returns {Promise<Models.Credit>}
330
+ * @deprecated Use the object parameter style method for a better developer experience.
331
+ */
133
332
  addCredit(organizationId: string, couponId: string): Promise<Models.Credit>;
134
333
  /**
135
334
  * Get total available valid credits for an organization.
136
335
  *
137
- * @param {string} organizationId
336
+ * @param {string} params.organizationId - Organization ID
337
+ * @throws {AppwriteException}
338
+ * @returns {Promise<Models.CreditAvailable>}
339
+ */
340
+ getAvailableCredits(params: {
341
+ organizationId: string;
342
+ }): Promise<Models.CreditAvailable>;
343
+ /**
344
+ * Get total available valid credits for an organization.
345
+ *
346
+ * @param {string} organizationId - Organization ID
138
347
  * @throws {AppwriteException}
139
348
  * @returns {Promise<Models.CreditAvailable>}
349
+ * @deprecated Use the object parameter style method for a better developer experience.
140
350
  */
141
351
  getAvailableCredits(organizationId: string): Promise<Models.CreditAvailable>;
142
352
  /**
143
353
  * Get credit details.
144
354
  *
145
- * @param {string} organizationId
146
- * @param {string} creditId
355
+ * @param {string} params.organizationId - Organization ID
356
+ * @param {string} params.creditId - Credit Unique ID
147
357
  * @throws {AppwriteException}
148
358
  * @returns {Promise<Models.Credit>}
149
359
  */
360
+ getCredit(params: {
361
+ organizationId: string;
362
+ creditId: string;
363
+ }): Promise<Models.Credit>;
364
+ /**
365
+ * Get credit details.
366
+ *
367
+ * @param {string} organizationId - Organization ID
368
+ * @param {string} creditId - Credit Unique ID
369
+ * @throws {AppwriteException}
370
+ * @returns {Promise<Models.Credit>}
371
+ * @deprecated Use the object parameter style method for a better developer experience.
372
+ */
150
373
  getCredit(organizationId: string, creditId: string): Promise<Models.Credit>;
151
374
  /**
152
375
  * Get estimation for deleting an organization.
153
376
  *
154
- * @param {string} organizationId
377
+ * @param {string} params.organizationId - Team ID.
378
+ * @throws {AppwriteException}
379
+ * @returns {Promise<Models.EstimationDeleteOrganization>}
380
+ */
381
+ estimationDeleteOrganization(params: {
382
+ organizationId: string;
383
+ }): Promise<Models.EstimationDeleteOrganization>;
384
+ /**
385
+ * Get estimation for deleting an organization.
386
+ *
387
+ * @param {string} organizationId - Team ID.
155
388
  * @throws {AppwriteException}
156
389
  * @returns {Promise<Models.EstimationDeleteOrganization>}
390
+ * @deprecated Use the object parameter style method for a better developer experience.
157
391
  */
158
392
  estimationDeleteOrganization(organizationId: string): Promise<Models.EstimationDeleteOrganization>;
159
393
  /**
160
394
  * Get estimation for updating the organization plan.
161
395
  *
162
- * @param {string} organizationId
163
- * @param {BillingPlan} billingPlan
164
- * @param {string[]} invites
165
- * @param {string} couponId
396
+ * @param {string} params.organizationId - Organization ID
397
+ * @param {string} params.billingPlan - Organization billing plan chosen
398
+ * @param {string[]} params.invites - Additional member invites
399
+ * @param {string} params.couponId - Coupon id
166
400
  * @throws {AppwriteException}
167
401
  * @returns {Promise<Models.EstimationUpdatePlan>}
168
402
  */
169
- estimationUpdatePlan(organizationId: string, billingPlan: BillingPlan, invites?: string[], couponId?: string): Promise<Models.EstimationUpdatePlan>;
403
+ estimationUpdatePlan(params: {
404
+ organizationId: string;
405
+ billingPlan: string;
406
+ invites?: string[];
407
+ couponId?: string;
408
+ }): Promise<Models.EstimationUpdatePlan>;
409
+ /**
410
+ * Get estimation for updating the organization plan.
411
+ *
412
+ * @param {string} organizationId - Organization ID
413
+ * @param {string} billingPlan - Organization billing plan chosen
414
+ * @param {string[]} invites - Additional member invites
415
+ * @param {string} couponId - Coupon id
416
+ * @throws {AppwriteException}
417
+ * @returns {Promise<Models.EstimationUpdatePlan>}
418
+ * @deprecated Use the object parameter style method for a better developer experience.
419
+ */
420
+ estimationUpdatePlan(organizationId: string, billingPlan: string, invites?: string[], couponId?: string): Promise<Models.EstimationUpdatePlan>;
421
+ /**
422
+ * Submit feedback about downgrading from a paid plan to a lower tier. This helps the team understand user experience and improve the platform.
423
+ *
424
+ *
425
+ * @param {string} params.organizationId - Organization Unique ID
426
+ * @param {string} params.reason - Feedback reason
427
+ * @param {string} params.message - Feedback message
428
+ * @param {string} params.fromPlanId - Plan downgrading from
429
+ * @param {string} params.toPlanId - Plan downgrading to
430
+ * @throws {AppwriteException}
431
+ * @returns {Promise<Models.DowngradeFeedback>}
432
+ */
433
+ createDowngradeFeedback(params: {
434
+ organizationId: string;
435
+ reason: string;
436
+ message: string;
437
+ fromPlanId: string;
438
+ toPlanId: string;
439
+ }): Promise<Models.DowngradeFeedback>;
440
+ /**
441
+ * Submit feedback about downgrading from a paid plan to a lower tier. This helps the team understand user experience and improve the platform.
442
+ *
443
+ *
444
+ * @param {string} organizationId - Organization Unique ID
445
+ * @param {string} reason - Feedback reason
446
+ * @param {string} message - Feedback message
447
+ * @param {string} fromPlanId - Plan downgrading from
448
+ * @param {string} toPlanId - Plan downgrading to
449
+ * @throws {AppwriteException}
450
+ * @returns {Promise<Models.DowngradeFeedback>}
451
+ * @deprecated Use the object parameter style method for a better developer experience.
452
+ */
453
+ createDowngradeFeedback(organizationId: string, reason: string, message: string, fromPlanId: string, toPlanId: string): Promise<Models.DowngradeFeedback>;
454
+ /**
455
+ * List all invoices for an organization.
456
+ *
457
+ * @param {string} params.organizationId - Organization ID
458
+ * @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: teamId, aggregationId, amount, currency, from, to, dueAt, attempts, status, grossAmount
459
+ * @throws {AppwriteException}
460
+ * @returns {Promise<Models.InvoiceList>}
461
+ */
462
+ listInvoices(params: {
463
+ organizationId: string;
464
+ queries?: string[];
465
+ }): Promise<Models.InvoiceList>;
170
466
  /**
171
467
  * List all invoices for an organization.
172
468
  *
173
- * @param {string} organizationId
174
- * @param {string[]} queries
469
+ * @param {string} organizationId - Organization ID
470
+ * @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: teamId, aggregationId, amount, currency, from, to, dueAt, attempts, status, grossAmount
175
471
  * @throws {AppwriteException}
176
472
  * @returns {Promise<Models.InvoiceList>}
473
+ * @deprecated Use the object parameter style method for a better developer experience.
177
474
  */
178
475
  listInvoices(organizationId: string, queries?: string[]): Promise<Models.InvoiceList>;
179
476
  /**
180
477
  * Get an invoice by its unique ID.
181
478
  *
182
- * @param {string} organizationId
183
- * @param {string} invoiceId
479
+ * @param {string} params.organizationId - Organization ID
480
+ * @param {string} params.invoiceId - Invoice unique ID
481
+ * @throws {AppwriteException}
482
+ * @returns {Promise<Models.Invoice>}
483
+ */
484
+ getInvoice(params: {
485
+ organizationId: string;
486
+ invoiceId: string;
487
+ }): Promise<Models.Invoice>;
488
+ /**
489
+ * Get an invoice by its unique ID.
490
+ *
491
+ * @param {string} organizationId - Organization ID
492
+ * @param {string} invoiceId - Invoice unique ID
184
493
  * @throws {AppwriteException}
185
494
  * @returns {Promise<Models.Invoice>}
495
+ * @deprecated Use the object parameter style method for a better developer experience.
186
496
  */
187
497
  getInvoice(organizationId: string, invoiceId: string): Promise<Models.Invoice>;
188
498
  /**
189
499
  * Download invoice in PDF
190
500
  *
191
- * @param {string} organizationId
192
- * @param {string} invoiceId
501
+ * @param {string} params.organizationId - Organization ID
502
+ * @param {string} params.invoiceId - Invoice unique ID
503
+ * @throws {AppwriteException}
504
+ * @returns {Promise<Models.PaymentMethod>}
505
+ */
506
+ getInvoiceDownload(params: {
507
+ organizationId: string;
508
+ invoiceId: string;
509
+ }): Promise<Models.PaymentMethod>;
510
+ /**
511
+ * Download invoice in PDF
512
+ *
513
+ * @param {string} organizationId - Organization ID
514
+ * @param {string} invoiceId - Invoice unique ID
193
515
  * @throws {AppwriteException}
194
516
  * @returns {Promise<Models.PaymentMethod>}
517
+ * @deprecated Use the object parameter style method for a better developer experience.
195
518
  */
196
519
  getInvoiceDownload(organizationId: string, invoiceId: string): Promise<Models.PaymentMethod>;
197
520
  /**
198
521
  * Initiate payment for failed invoice to pay live from console
199
522
  *
200
- * @param {string} organizationId
201
- * @param {string} invoiceId
202
- * @param {string} paymentMethodId
523
+ * @param {string} params.organizationId - Organization ID
524
+ * @param {string} params.invoiceId - Invoice unique ID
525
+ * @param {string} params.paymentMethodId - Payment method ID
526
+ * @throws {AppwriteException}
527
+ * @returns {Promise<Models.Invoice>}
528
+ */
529
+ createInvoicePayment(params: {
530
+ organizationId: string;
531
+ invoiceId: string;
532
+ paymentMethodId: string;
533
+ }): Promise<Models.Invoice>;
534
+ /**
535
+ * Initiate payment for failed invoice to pay live from console
536
+ *
537
+ * @param {string} organizationId - Organization ID
538
+ * @param {string} invoiceId - Invoice unique ID
539
+ * @param {string} paymentMethodId - Payment method ID
203
540
  * @throws {AppwriteException}
204
541
  * @returns {Promise<Models.Invoice>}
542
+ * @deprecated Use the object parameter style method for a better developer experience.
205
543
  */
206
544
  createInvoicePayment(organizationId: string, invoiceId: string, paymentMethodId: string): Promise<Models.Invoice>;
207
545
  /**
208
546
  * Validates the payment linked with the invoice and updates the invoice status if the payment status is changed.
209
547
  *
210
- * @param {string} organizationId
211
- * @param {string} invoiceId
548
+ * @param {string} params.organizationId - Organization ID
549
+ * @param {string} params.invoiceId - Invoice unique ID
212
550
  * @throws {AppwriteException}
213
551
  * @returns {Promise<Models.Invoice>}
214
552
  */
553
+ validateInvoice(params: {
554
+ organizationId: string;
555
+ invoiceId: string;
556
+ }): Promise<Models.Invoice>;
557
+ /**
558
+ * Validates the payment linked with the invoice and updates the invoice status if the payment status is changed.
559
+ *
560
+ * @param {string} organizationId - Organization ID
561
+ * @param {string} invoiceId - Invoice unique ID
562
+ * @throws {AppwriteException}
563
+ * @returns {Promise<Models.Invoice>}
564
+ * @deprecated Use the object parameter style method for a better developer experience.
565
+ */
215
566
  validateInvoice(organizationId: string, invoiceId: string): Promise<Models.Invoice>;
216
567
  /**
217
568
  * View invoice in PDF
218
569
  *
219
- * @param {string} organizationId
220
- * @param {string} invoiceId
570
+ * @param {string} params.organizationId - Organization ID
571
+ * @param {string} params.invoiceId - Invoice unique ID
572
+ * @throws {AppwriteException}
573
+ * @returns {Promise<Models.PaymentMethod>}
574
+ */
575
+ getInvoiceView(params: {
576
+ organizationId: string;
577
+ invoiceId: string;
578
+ }): Promise<Models.PaymentMethod>;
579
+ /**
580
+ * View invoice in PDF
581
+ *
582
+ * @param {string} organizationId - Organization ID
583
+ * @param {string} invoiceId - Invoice unique ID
221
584
  * @throws {AppwriteException}
222
585
  * @returns {Promise<Models.PaymentMethod>}
586
+ * @deprecated Use the object parameter style method for a better developer experience.
223
587
  */
224
588
  getInvoiceView(organizationId: string, invoiceId: string): Promise<Models.PaymentMethod>;
225
589
  /**
226
- * Set a organization&#039;s default payment method.
590
+ * Set a organization's default payment method.
227
591
  *
228
- * @param {string} organizationId
229
- * @param {string} paymentMethodId
592
+ * @param {string} params.organizationId - Organization ID
593
+ * @param {string} params.paymentMethodId - Unique ID of payment method
230
594
  * @throws {AppwriteException}
231
595
  * @returns {Promise<Models.Organization<Preferences>>}
232
596
  */
597
+ setDefaultPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
598
+ organizationId: string;
599
+ paymentMethodId: string;
600
+ }): Promise<Models.Organization<Preferences>>;
601
+ /**
602
+ * Set a organization's default payment method.
603
+ *
604
+ * @param {string} organizationId - Organization ID
605
+ * @param {string} paymentMethodId - Unique ID of payment method
606
+ * @throws {AppwriteException}
607
+ * @returns {Promise<Models.Organization<Preferences>>}
608
+ * @deprecated Use the object parameter style method for a better developer experience.
609
+ */
233
610
  setDefaultPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, paymentMethodId: string): Promise<Models.Organization<Preferences>>;
234
611
  /**
235
612
  * Delete the default payment method for an organization.
236
613
  *
237
- * @param {string} organizationId
614
+ * @param {string} params.organizationId - Organization ID
238
615
  * @throws {AppwriteException}
239
616
  * @returns {Promise<Models.Organization<Preferences>>}
240
617
  */
618
+ deleteDefaultPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
619
+ organizationId: string;
620
+ }): Promise<Models.Organization<Preferences>>;
621
+ /**
622
+ * Delete the default payment method for an organization.
623
+ *
624
+ * @param {string} organizationId - Organization ID
625
+ * @throws {AppwriteException}
626
+ * @returns {Promise<Models.Organization<Preferences>>}
627
+ * @deprecated Use the object parameter style method for a better developer experience.
628
+ */
241
629
  deleteDefaultPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string): Promise<Models.Organization<Preferences>>;
242
630
  /**
243
- * Set an organization&#039;s backup payment method.
631
+ * Set an organization's backup payment method.
244
632
  *
245
633
  *
246
- * @param {string} organizationId
247
- * @param {string} paymentMethodId
634
+ * @param {string} params.organizationId - Organization ID
635
+ * @param {string} params.paymentMethodId - Unique ID of payment method
248
636
  * @throws {AppwriteException}
249
637
  * @returns {Promise<Models.Organization<Preferences>>}
250
638
  */
639
+ setBackupPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
640
+ organizationId: string;
641
+ paymentMethodId: string;
642
+ }): Promise<Models.Organization<Preferences>>;
643
+ /**
644
+ * Set an organization's backup payment method.
645
+ *
646
+ *
647
+ * @param {string} organizationId - Organization ID
648
+ * @param {string} paymentMethodId - Unique ID of payment method
649
+ * @throws {AppwriteException}
650
+ * @returns {Promise<Models.Organization<Preferences>>}
651
+ * @deprecated Use the object parameter style method for a better developer experience.
652
+ */
251
653
  setBackupPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, paymentMethodId: string): Promise<Models.Organization<Preferences>>;
252
654
  /**
253
655
  * Delete a backup payment method for an organization.
254
656
  *
255
- * @param {string} organizationId
657
+ * @param {string} params.organizationId - Organization ID
658
+ * @throws {AppwriteException}
659
+ * @returns {Promise<Models.Organization<Preferences>>}
660
+ */
661
+ deleteBackupPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
662
+ organizationId: string;
663
+ }): Promise<Models.Organization<Preferences>>;
664
+ /**
665
+ * Delete a backup payment method for an organization.
666
+ *
667
+ * @param {string} organizationId - Organization ID
256
668
  * @throws {AppwriteException}
257
669
  * @returns {Promise<Models.Organization<Preferences>>}
670
+ * @deprecated Use the object parameter style method for a better developer experience.
258
671
  */
259
672
  deleteBackupPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string): Promise<Models.Organization<Preferences>>;
260
673
  /**
261
- * Get an organization&#039;s payment method using it&#039;s payment method ID.
674
+ * Get an organization's payment method using it's payment method ID.
675
+ *
676
+ * @param {string} params.organizationId - Organization ID
677
+ * @param {string} params.paymentMethodId - Unique ID of payment method
678
+ * @throws {AppwriteException}
679
+ * @returns {Promise<Models.PaymentMethod>}
680
+ */
681
+ getPaymentMethod(params: {
682
+ organizationId: string;
683
+ paymentMethodId: string;
684
+ }): Promise<Models.PaymentMethod>;
685
+ /**
686
+ * Get an organization's payment method using it's payment method ID.
262
687
  *
263
- * @param {string} organizationId
264
- * @param {string} paymentMethodId
688
+ * @param {string} organizationId - Organization ID
689
+ * @param {string} paymentMethodId - Unique ID of payment method
265
690
  * @throws {AppwriteException}
266
691
  * @returns {Promise<Models.PaymentMethod>}
692
+ * @deprecated Use the object parameter style method for a better developer experience.
267
693
  */
268
694
  getPaymentMethod(organizationId: string, paymentMethodId: string): Promise<Models.PaymentMethod>;
269
695
  /**
270
696
  * Get the details of the current billing plan for an organization.
271
697
  *
272
- * @param {string} organizationId
698
+ * @param {string} params.organizationId - Organization Unique ID
699
+ * @throws {AppwriteException}
700
+ * @returns {Promise<Models.BillingPlan>}
701
+ */
702
+ getPlan(params: {
703
+ organizationId: string;
704
+ }): Promise<Models.BillingPlan>;
705
+ /**
706
+ * Get the details of the current billing plan for an organization.
707
+ *
708
+ * @param {string} organizationId - Organization Unique ID
273
709
  * @throws {AppwriteException}
274
710
  * @returns {Promise<Models.BillingPlan>}
711
+ * @deprecated Use the object parameter style method for a better developer experience.
275
712
  */
276
713
  getPlan(organizationId: string): Promise<Models.BillingPlan>;
277
714
  /**
278
715
  * Update the billing plan for an organization.
279
716
  *
280
- * @param {string} organizationId
281
- * @param {BillingPlan} billingPlan
282
- * @param {string} paymentMethodId
283
- * @param {string} billingAddressId
284
- * @param {string[]} invites
285
- * @param {string} couponId
286
- * @param {string} taxId
287
- * @param {number} budget
717
+ * @param {string} params.organizationId - Organization Unique ID
718
+ * @param {string} params.billingPlan - Organization billing plan chosen
719
+ * @param {string} params.paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
720
+ * @param {string} params.billingAddressId - Unique ID of billing address
721
+ * @param {string[]} params.invites - Additional member invites
722
+ * @param {string} params.couponId - Coupon id
723
+ * @param {string} params.taxId - Tax Id associated to billing.
724
+ * @param {number} params.budget - Budget limit for additional usage set for the organization
288
725
  * @throws {AppwriteException}
289
726
  * @returns {Promise<Models.Organization<Preferences>>}
290
727
  */
291
- updatePlan<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, billingPlan: BillingPlan, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number): Promise<Models.Organization<Preferences>>;
728
+ updatePlan<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
729
+ organizationId: string;
730
+ billingPlan: string;
731
+ paymentMethodId?: string;
732
+ billingAddressId?: string;
733
+ invites?: string[];
734
+ couponId?: string;
735
+ taxId?: string;
736
+ budget?: number;
737
+ }): Promise<Models.Organization<Preferences>>;
738
+ /**
739
+ * Update the billing plan for an organization.
740
+ *
741
+ * @param {string} organizationId - Organization Unique ID
742
+ * @param {string} billingPlan - Organization billing plan chosen
743
+ * @param {string} paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
744
+ * @param {string} billingAddressId - Unique ID of billing address
745
+ * @param {string[]} invites - Additional member invites
746
+ * @param {string} couponId - Coupon id
747
+ * @param {string} taxId - Tax Id associated to billing.
748
+ * @param {number} budget - Budget limit for additional usage set for the organization
749
+ * @throws {AppwriteException}
750
+ * @returns {Promise<Models.Organization<Preferences>>}
751
+ * @deprecated Use the object parameter style method for a better developer experience.
752
+ */
753
+ updatePlan<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, billingPlan: string, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number): Promise<Models.Organization<Preferences>>;
754
+ /**
755
+ * Cancel the downgrade initiated for an organization.
756
+ *
757
+ * @param {string} params.organizationId - Organization Unique ID
758
+ * @throws {AppwriteException}
759
+ * @returns {Promise<Models.Organization<Preferences>>}
760
+ */
761
+ cancelDowngrade<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
762
+ organizationId: string;
763
+ }): Promise<Models.Organization<Preferences>>;
292
764
  /**
293
765
  * Cancel the downgrade initiated for an organization.
294
766
  *
295
- * @param {string} organizationId
767
+ * @param {string} organizationId - Organization Unique ID
296
768
  * @throws {AppwriteException}
297
769
  * @returns {Promise<Models.Organization<Preferences>>}
770
+ * @deprecated Use the object parameter style method for a better developer experience.
298
771
  */
299
772
  cancelDowngrade<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string): Promise<Models.Organization<Preferences>>;
300
773
  /**
301
774
  * Update selected projects to keep in the organization.
302
775
  *
303
- * @param {string} organizationId
304
- * @param {string[]} projects
776
+ * @param {string} params.organizationId - Organization Unique ID
777
+ * @param {string[]} params.projects - List of project IDs to be selected for the organization
305
778
  * @throws {AppwriteException}
306
779
  * @returns {Promise<Models.Organization<Preferences>>}
307
780
  */
781
+ updateProjects<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
782
+ organizationId: string;
783
+ projects?: string[];
784
+ }): Promise<Models.Organization<Preferences>>;
785
+ /**
786
+ * Update selected projects to keep in the organization.
787
+ *
788
+ * @param {string} organizationId - Organization Unique ID
789
+ * @param {string[]} projects - List of project IDs to be selected for the organization
790
+ * @throws {AppwriteException}
791
+ * @returns {Promise<Models.Organization<Preferences>>}
792
+ * @deprecated Use the object parameter style method for a better developer experience.
793
+ */
308
794
  updateProjects<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, projects?: string[]): Promise<Models.Organization<Preferences>>;
309
795
  /**
310
796
  * Get Scopes
311
797
  *
312
- * @param {string} organizationId
798
+ * @param {string} params.organizationId - Organization id
799
+ * @throws {AppwriteException}
800
+ * @returns {Promise<Models.Roles>}
801
+ */
802
+ getScopes(params: {
803
+ organizationId: string;
804
+ }): Promise<Models.Roles>;
805
+ /**
806
+ * Get Scopes
807
+ *
808
+ * @param {string} organizationId - Organization id
313
809
  * @throws {AppwriteException}
314
810
  * @returns {Promise<Models.Roles>}
811
+ * @deprecated Use the object parameter style method for a better developer experience.
315
812
  */
316
813
  getScopes(organizationId: string): Promise<Models.Roles>;
317
814
  /**
318
- * Set an organization&#039;s billing tax ID.
815
+ * Set an organization's billing tax ID.
319
816
  *
320
- * @param {string} organizationId
321
- * @param {string} taxId
817
+ * @param {string} params.organizationId - Organization ID
818
+ * @param {string} params.taxId - Tax Id associated to billing.
322
819
  * @throws {AppwriteException}
323
820
  * @returns {Promise<Models.Organization<Preferences>>}
324
821
  */
822
+ setBillingTaxId<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
823
+ organizationId: string;
824
+ taxId: string;
825
+ }): Promise<Models.Organization<Preferences>>;
826
+ /**
827
+ * Set an organization's billing tax ID.
828
+ *
829
+ * @param {string} organizationId - Organization ID
830
+ * @param {string} taxId - Tax Id associated to billing.
831
+ * @throws {AppwriteException}
832
+ * @returns {Promise<Models.Organization<Preferences>>}
833
+ * @deprecated Use the object parameter style method for a better developer experience.
834
+ */
325
835
  setBillingTaxId<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, taxId: string): Promise<Models.Organization<Preferences>>;
326
836
  /**
327
837
  * Get the usage data for an organization.
328
838
  *
329
- * @param {string} organizationId
330
- * @param {string} startDate
331
- * @param {string} endDate
839
+ * @param {string} params.organizationId - Organization ID
840
+ * @param {string} params.startDate - Starting date for the usage
841
+ * @param {string} params.endDate - End date for the usage
842
+ * @throws {AppwriteException}
843
+ * @returns {Promise<Models.UsageOrganization>}
844
+ */
845
+ getUsage(params: {
846
+ organizationId: string;
847
+ startDate?: string;
848
+ endDate?: string;
849
+ }): Promise<Models.UsageOrganization>;
850
+ /**
851
+ * Get the usage data for an organization.
852
+ *
853
+ * @param {string} organizationId - Organization ID
854
+ * @param {string} startDate - Starting date for the usage
855
+ * @param {string} endDate - End date for the usage
332
856
  * @throws {AppwriteException}
333
857
  * @returns {Promise<Models.UsageOrganization>}
858
+ * @deprecated Use the object parameter style method for a better developer experience.
334
859
  */
335
860
  getUsage(organizationId: string, startDate?: string, endDate?: string): Promise<Models.UsageOrganization>;
336
861
  /**
337
862
  * Validate payment for team after creation or upgrade.
338
863
  *
339
- * @param {string} organizationId
340
- * @param {string[]} invites
864
+ * @param {string} params.organizationId - Organization ID
865
+ * @param {string[]} params.invites - Additional member invites
866
+ * @throws {AppwriteException}
867
+ * @returns {Promise<Models.Organization<Preferences>>}
868
+ */
869
+ validatePayment<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
870
+ organizationId: string;
871
+ invites?: string[];
872
+ }): Promise<Models.Organization<Preferences>>;
873
+ /**
874
+ * Validate payment for team after creation or upgrade.
875
+ *
876
+ * @param {string} organizationId - Organization ID
877
+ * @param {string[]} invites - Additional member invites
341
878
  * @throws {AppwriteException}
342
879
  * @returns {Promise<Models.Organization<Preferences>>}
880
+ * @deprecated Use the object parameter style method for a better developer experience.
343
881
  */
344
882
  validatePayment<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, invites?: string[]): Promise<Models.Organization<Preferences>>;
345
883
  }