@appwrite.io/console 1.10.0 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (745) hide show
  1. package/.github/workflows/publish.yml +9 -8
  2. package/CHANGELOG.md +6 -0
  3. package/LICENSE +1 -1
  4. package/README.md +4 -4
  5. package/dist/cjs/sdk.js +15239 -6070
  6. package/dist/cjs/sdk.js.map +1 -1
  7. package/dist/esm/sdk.js +15237 -6071
  8. package/dist/esm/sdk.js.map +1 -1
  9. package/dist/iife/sdk.js +15239 -6070
  10. package/docs/examples/account/create-billing-address.md +8 -8
  11. package/docs/examples/account/create-email-password-session.md +4 -4
  12. package/docs/examples/account/create-email-token.md +5 -5
  13. package/docs/examples/account/{update-magic-u-r-l-session.md → create-email-verification.md} +3 -4
  14. package/docs/examples/account/{update-m-f-a.md → create-jwt.md} +3 -3
  15. package/docs/examples/account/{create-magic-u-r-l-token.md → create-magic-url-token.md} +6 -6
  16. package/docs/examples/account/create-mfa-authenticator.md +3 -3
  17. package/docs/examples/account/create-mfa-challenge.md +3 -3
  18. package/docs/examples/account/create-mfa-recovery-codes.md +1 -1
  19. package/docs/examples/account/{create-o-auth2token.md → create-o-auth-2-session.md} +6 -6
  20. package/docs/examples/account/{create-o-auth2session.md → create-o-auth-2-token.md} +6 -6
  21. package/docs/examples/account/create-phone-token.md +4 -4
  22. package/docs/examples/account/create-push-target.md +5 -5
  23. package/docs/examples/account/create-recovery.md +4 -4
  24. package/docs/examples/account/create-session.md +4 -4
  25. package/docs/examples/account/create-verification.md +3 -3
  26. package/docs/examples/account/create.md +6 -6
  27. package/docs/examples/account/delete-billing-address.md +3 -3
  28. package/docs/examples/account/delete-identity.md +3 -3
  29. package/docs/examples/account/delete-mfa-authenticator.md +3 -3
  30. package/docs/examples/account/delete-payment-method.md +3 -3
  31. package/docs/examples/account/delete-push-target.md +3 -3
  32. package/docs/examples/account/delete-session.md +3 -3
  33. package/docs/examples/account/get-billing-address.md +3 -3
  34. package/docs/examples/account/get-coupon.md +3 -3
  35. package/docs/examples/account/get-mfa-recovery-codes.md +1 -1
  36. package/docs/examples/account/get-payment-method.md +3 -3
  37. package/docs/examples/account/get-session.md +3 -3
  38. package/docs/examples/account/list-billing-addresses.md +3 -3
  39. package/docs/examples/account/list-identities.md +4 -3
  40. package/docs/examples/account/list-invoices.md +3 -3
  41. package/docs/examples/account/list-logs.md +4 -3
  42. package/docs/examples/account/list-mfa-factors.md +1 -1
  43. package/docs/examples/account/list-payment-methods.md +3 -3
  44. package/docs/examples/account/update-billing-address.md +9 -9
  45. package/docs/examples/account/update-email-verification.md +14 -0
  46. package/docs/examples/account/update-email.md +4 -4
  47. package/docs/examples/account/update-magic-url-session.md +14 -0
  48. package/docs/examples/account/update-mfa-authenticator.md +4 -4
  49. package/docs/examples/account/update-mfa-challenge.md +4 -4
  50. package/docs/examples/account/update-mfa-recovery-codes.md +1 -1
  51. package/docs/examples/account/{create-j-w-t.md → update-mfa.md} +3 -1
  52. package/docs/examples/account/update-name.md +3 -3
  53. package/docs/examples/account/update-password.md +4 -4
  54. package/docs/examples/account/update-payment-method-mandate-options.md +3 -3
  55. package/docs/examples/account/update-payment-method-provider.md +6 -5
  56. package/docs/examples/account/update-payment-method.md +6 -5
  57. package/docs/examples/account/update-phone-session.md +4 -4
  58. package/docs/examples/account/update-phone-verification.md +4 -4
  59. package/docs/examples/account/update-phone.md +4 -4
  60. package/docs/examples/account/update-prefs.md +7 -3
  61. package/docs/examples/account/update-push-target.md +4 -4
  62. package/docs/examples/account/update-recovery.md +5 -5
  63. package/docs/examples/account/update-session.md +3 -3
  64. package/docs/examples/account/update-verification.md +4 -4
  65. package/docs/examples/assistant/chat.md +3 -3
  66. package/docs/examples/avatars/get-browser.md +6 -6
  67. package/docs/examples/avatars/get-credit-card.md +6 -6
  68. package/docs/examples/avatars/get-favicon.md +3 -3
  69. package/docs/examples/avatars/get-flag.md +6 -6
  70. package/docs/examples/avatars/get-image.md +5 -5
  71. package/docs/examples/avatars/get-initials.md +6 -6
  72. package/docs/examples/avatars/{get-q-r.md → get-qr.md} +6 -6
  73. package/docs/examples/avatars/get-screenshot.md +35 -0
  74. package/docs/examples/backups/create-archive.md +4 -4
  75. package/docs/examples/backups/create-policy.md +9 -9
  76. package/docs/examples/backups/create-restoration.md +6 -6
  77. package/docs/examples/backups/delete-archive.md +3 -3
  78. package/docs/examples/backups/delete-policy.md +3 -3
  79. package/docs/examples/backups/get-archive.md +3 -3
  80. package/docs/examples/backups/get-policy.md +3 -3
  81. package/docs/examples/backups/get-restoration.md +3 -3
  82. package/docs/examples/backups/list-archives.md +3 -3
  83. package/docs/examples/backups/list-policies.md +3 -3
  84. package/docs/examples/backups/list-restorations.md +3 -3
  85. package/docs/examples/backups/update-policy.md +7 -7
  86. package/docs/examples/console/create-program-membership.md +3 -3
  87. package/docs/examples/console/create-source.md +7 -7
  88. package/docs/examples/console/get-campaign.md +3 -3
  89. package/docs/examples/console/get-coupon.md +3 -3
  90. package/docs/examples/console/{plans.md → get-plan.md} +3 -1
  91. package/docs/examples/console/get-plans.md +13 -0
  92. package/docs/examples/console/{regions.md → get-program.md} +3 -1
  93. package/docs/examples/console/get-regions.md +13 -0
  94. package/docs/examples/console/get-resource.md +4 -4
  95. package/docs/examples/console/suggest-columns.md +17 -0
  96. package/docs/examples/console/suggest-indexes.md +16 -0
  97. package/docs/examples/databases/create-boolean-attribute.md +8 -8
  98. package/docs/examples/databases/create-collection.md +11 -9
  99. package/docs/examples/databases/create-datetime-attribute.md +8 -8
  100. package/docs/examples/databases/create-document.md +15 -8
  101. package/docs/examples/databases/create-documents.md +6 -5
  102. package/docs/examples/databases/create-email-attribute.md +8 -8
  103. package/docs/examples/databases/create-enum-attribute.md +9 -9
  104. package/docs/examples/databases/create-float-attribute.md +10 -10
  105. package/docs/examples/databases/create-index.md +9 -9
  106. package/docs/examples/databases/create-integer-attribute.md +10 -10
  107. package/docs/examples/databases/create-ip-attribute.md +8 -8
  108. package/docs/examples/databases/create-line-attribute.md +17 -0
  109. package/docs/examples/databases/create-operations.md +24 -0
  110. package/docs/examples/databases/create-point-attribute.md +17 -0
  111. package/docs/examples/databases/create-polygon-attribute.md +17 -0
  112. package/docs/examples/databases/create-relationship-attribute.md +10 -10
  113. package/docs/examples/databases/create-string-attribute.md +10 -10
  114. package/docs/examples/databases/create-transaction.md +13 -0
  115. package/docs/examples/databases/create-url-attribute.md +8 -8
  116. package/docs/examples/databases/create.md +5 -5
  117. package/docs/examples/databases/decrement-document-attribute.md +9 -8
  118. package/docs/examples/databases/delete-attribute.md +5 -5
  119. package/docs/examples/databases/delete-collection.md +4 -4
  120. package/docs/examples/databases/delete-document.md +6 -5
  121. package/docs/examples/databases/delete-documents.md +6 -5
  122. package/docs/examples/databases/delete-index.md +5 -5
  123. package/docs/examples/databases/{get-database-usage.md → delete-transaction.md} +4 -5
  124. package/docs/examples/databases/delete.md +3 -3
  125. package/docs/examples/databases/get-attribute.md +5 -5
  126. package/docs/examples/databases/get-collection-usage.md +6 -6
  127. package/docs/examples/databases/get-collection.md +4 -4
  128. package/docs/examples/databases/get-document.md +7 -6
  129. package/docs/examples/databases/get-index.md +5 -5
  130. package/docs/examples/databases/get-transaction.md +13 -0
  131. package/docs/examples/databases/get-usage.md +5 -4
  132. package/docs/examples/databases/get.md +3 -3
  133. package/docs/examples/databases/increment-document-attribute.md +9 -8
  134. package/docs/examples/databases/list-attributes.md +6 -5
  135. package/docs/examples/databases/list-collection-logs.md +5 -5
  136. package/docs/examples/databases/list-collections.md +6 -5
  137. package/docs/examples/databases/list-document-logs.md +6 -6
  138. package/docs/examples/databases/list-documents.md +7 -5
  139. package/docs/examples/databases/list-indexes.md +6 -5
  140. package/docs/examples/databases/list-logs.md +4 -4
  141. package/docs/examples/databases/list-transactions.md +13 -0
  142. package/docs/examples/databases/list-usage.md +13 -0
  143. package/docs/examples/databases/list.md +5 -4
  144. package/docs/examples/databases/update-boolean-attribute.md +8 -8
  145. package/docs/examples/databases/update-collection.md +9 -9
  146. package/docs/examples/databases/update-datetime-attribute.md +8 -8
  147. package/docs/examples/databases/update-document.md +15 -8
  148. package/docs/examples/databases/update-documents.md +13 -6
  149. package/docs/examples/databases/update-email-attribute.md +8 -8
  150. package/docs/examples/databases/update-enum-attribute.md +9 -9
  151. package/docs/examples/databases/update-float-attribute.md +10 -10
  152. package/docs/examples/databases/update-integer-attribute.md +10 -10
  153. package/docs/examples/databases/update-ip-attribute.md +8 -8
  154. package/docs/examples/databases/update-line-attribute.md +18 -0
  155. package/docs/examples/databases/update-point-attribute.md +18 -0
  156. package/docs/examples/databases/update-polygon-attribute.md +18 -0
  157. package/docs/examples/databases/update-relationship-attribute.md +7 -7
  158. package/docs/examples/databases/update-string-attribute.md +9 -9
  159. package/docs/examples/databases/update-transaction.md +15 -0
  160. package/docs/examples/databases/update-url-attribute.md +8 -8
  161. package/docs/examples/databases/update.md +5 -5
  162. package/docs/examples/databases/upsert-document.md +15 -8
  163. package/docs/examples/databases/upsert-documents.md +6 -5
  164. package/docs/examples/domains/create-preset-google-workspace.md +3 -3
  165. package/docs/examples/domains/create-preset-i-cloud.md +3 -3
  166. package/docs/examples/domains/create-preset-mailgun.md +3 -3
  167. package/docs/examples/domains/create-preset-outlook.md +3 -3
  168. package/docs/examples/domains/create-preset-proton-mail.md +3 -3
  169. package/docs/examples/domains/create-preset-zoho.md +3 -3
  170. package/docs/examples/domains/create-record-a.md +7 -7
  171. package/docs/examples/domains/{create-record-a-a-a-a.md → create-record-aaaa.md} +7 -7
  172. package/docs/examples/domains/create-record-alias.md +7 -7
  173. package/docs/examples/domains/{create-record-n-s.md → create-record-caa.md} +7 -7
  174. package/docs/examples/domains/{create-record-c-a-a.md → create-record-cname.md} +7 -7
  175. package/docs/examples/domains/{create-record-h-t-t-p-s.md → create-record-https.md} +7 -7
  176. package/docs/examples/domains/create-record-mx.md +18 -0
  177. package/docs/examples/domains/create-record-ns.md +17 -0
  178. package/docs/examples/domains/create-record-srv.md +20 -0
  179. package/docs/examples/domains/{create-record-c-n-a-m-e.md → create-record-txt.md} +7 -7
  180. package/docs/examples/domains/create.md +4 -4
  181. package/docs/examples/domains/delete-record.md +4 -4
  182. package/docs/examples/domains/delete.md +3 -3
  183. package/docs/examples/domains/get-preset-google-workspace.md +3 -3
  184. package/docs/examples/domains/get-preset-i-cloud.md +3 -3
  185. package/docs/examples/domains/get-preset-mailgun.md +3 -3
  186. package/docs/examples/domains/get-preset-outlook.md +3 -3
  187. package/docs/examples/domains/get-preset-proton-mail.md +3 -3
  188. package/docs/examples/domains/get-preset-zoho.md +3 -3
  189. package/docs/examples/domains/get-record.md +4 -4
  190. package/docs/examples/domains/get-zone.md +3 -3
  191. package/docs/examples/domains/get.md +3 -3
  192. package/docs/examples/domains/list-records.md +4 -4
  193. package/docs/examples/domains/list.md +4 -4
  194. package/docs/examples/domains/update-nameservers.md +3 -3
  195. package/docs/examples/domains/update-record-a.md +8 -8
  196. package/docs/examples/domains/update-record-aaaa.md +18 -0
  197. package/docs/examples/domains/update-record-alias.md +8 -8
  198. package/docs/examples/domains/update-record-caa.md +18 -0
  199. package/docs/examples/domains/update-record-cname.md +18 -0
  200. package/docs/examples/domains/update-record-https.md +18 -0
  201. package/docs/examples/domains/update-record-mx.md +19 -0
  202. package/docs/examples/domains/update-record-ns.md +18 -0
  203. package/docs/examples/domains/update-record-srv.md +21 -0
  204. package/docs/examples/domains/update-record-txt.md +18 -0
  205. package/docs/examples/domains/update-team.md +4 -4
  206. package/docs/examples/domains/update-zone.md +4 -4
  207. package/docs/examples/functions/create-deployment.md +7 -7
  208. package/docs/examples/functions/create-duplicate-deployment.md +5 -5
  209. package/docs/examples/functions/create-execution.md +9 -9
  210. package/docs/examples/functions/create-template-deployment.md +10 -9
  211. package/docs/examples/functions/create-variable.md +6 -6
  212. package/docs/examples/functions/create-vcs-deployment.md +7 -7
  213. package/docs/examples/functions/create.md +21 -21
  214. package/docs/examples/functions/delete-deployment.md +4 -4
  215. package/docs/examples/functions/delete-execution.md +4 -4
  216. package/docs/examples/functions/delete-variable.md +4 -4
  217. package/docs/examples/functions/delete.md +3 -3
  218. package/docs/examples/functions/get-deployment-download.md +5 -5
  219. package/docs/examples/functions/get-deployment.md +4 -4
  220. package/docs/examples/functions/get-execution.md +4 -4
  221. package/docs/examples/functions/get-template.md +3 -3
  222. package/docs/examples/functions/get-usage.md +5 -5
  223. package/docs/examples/functions/get-variable.md +4 -4
  224. package/docs/examples/functions/get.md +3 -3
  225. package/docs/examples/functions/list-deployments.md +6 -5
  226. package/docs/examples/functions/list-executions.md +5 -4
  227. package/docs/examples/functions/list-templates.md +7 -6
  228. package/docs/examples/functions/list-usage.md +4 -4
  229. package/docs/examples/functions/list-variables.md +3 -3
  230. package/docs/examples/functions/list.md +5 -4
  231. package/docs/examples/functions/update-deployment-status.md +4 -4
  232. package/docs/examples/functions/update-function-deployment.md +4 -4
  233. package/docs/examples/functions/update-variable.md +7 -7
  234. package/docs/examples/functions/update.md +21 -21
  235. package/docs/examples/graphql/mutation.md +3 -3
  236. package/docs/examples/graphql/query.md +3 -3
  237. package/docs/examples/health/get-certificate.md +3 -3
  238. package/docs/examples/health/get-failed-jobs.md +5 -5
  239. package/docs/examples/health/get-queue-billing-project-aggregation.md +3 -3
  240. package/docs/examples/health/get-queue-billing-team-aggregation.md +3 -3
  241. package/docs/examples/health/get-queue-builds.md +3 -3
  242. package/docs/examples/health/get-queue-certificates.md +3 -3
  243. package/docs/examples/health/get-queue-databases.md +4 -4
  244. package/docs/examples/health/get-queue-deletes.md +3 -3
  245. package/docs/examples/health/get-queue-functions.md +3 -3
  246. package/docs/examples/health/get-queue-logs.md +3 -3
  247. package/docs/examples/health/get-queue-mails.md +3 -3
  248. package/docs/examples/health/get-queue-messaging.md +3 -3
  249. package/docs/examples/health/get-queue-migrations.md +3 -3
  250. package/docs/examples/health/get-queue-priority-builds.md +3 -3
  251. package/docs/examples/health/get-queue-region-manager.md +3 -3
  252. package/docs/examples/health/get-queue-stats-resources.md +3 -3
  253. package/docs/examples/health/get-queue-threats.md +13 -0
  254. package/docs/examples/health/get-queue-usage.md +3 -3
  255. package/docs/examples/health/get-queue-webhooks.md +3 -3
  256. package/docs/examples/messaging/create-apns-provider.md +10 -10
  257. package/docs/examples/messaging/create-email.md +14 -14
  258. package/docs/examples/messaging/create-fcm-provider.md +6 -6
  259. package/docs/examples/messaging/create-mailgun-provider.md +12 -12
  260. package/docs/examples/messaging/{create-msg91provider.md → create-msg-91-provider.md} +8 -8
  261. package/docs/examples/messaging/create-push.md +21 -21
  262. package/docs/examples/messaging/create-resend-provider.md +20 -0
  263. package/docs/examples/messaging/create-sendgrid-provider.md +10 -10
  264. package/docs/examples/messaging/create-sms.md +9 -9
  265. package/docs/examples/messaging/create-smtp-provider.md +16 -16
  266. package/docs/examples/messaging/create-subscriber.md +5 -5
  267. package/docs/examples/messaging/create-telesign-provider.md +8 -8
  268. package/docs/examples/messaging/create-textmagic-provider.md +8 -8
  269. package/docs/examples/messaging/create-topic.md +5 -5
  270. package/docs/examples/messaging/create-twilio-provider.md +8 -8
  271. package/docs/examples/messaging/create-vonage-provider.md +8 -8
  272. package/docs/examples/messaging/delete-provider.md +3 -3
  273. package/docs/examples/messaging/delete-subscriber.md +4 -4
  274. package/docs/examples/messaging/delete-topic.md +3 -3
  275. package/docs/examples/messaging/delete.md +3 -3
  276. package/docs/examples/messaging/get-message.md +3 -3
  277. package/docs/examples/messaging/get-provider.md +3 -3
  278. package/docs/examples/messaging/get-subscriber.md +4 -4
  279. package/docs/examples/messaging/get-topic.md +3 -3
  280. package/docs/examples/messaging/list-message-logs.md +5 -4
  281. package/docs/examples/messaging/list-messages.md +5 -4
  282. package/docs/examples/messaging/list-provider-logs.md +5 -4
  283. package/docs/examples/messaging/list-providers.md +5 -4
  284. package/docs/examples/messaging/list-subscriber-logs.md +5 -4
  285. package/docs/examples/messaging/list-subscribers.md +6 -5
  286. package/docs/examples/messaging/list-targets.md +5 -4
  287. package/docs/examples/messaging/list-topic-logs.md +5 -4
  288. package/docs/examples/messaging/list-topics.md +5 -4
  289. package/docs/examples/messaging/update-apns-provider.md +10 -10
  290. package/docs/examples/messaging/update-email.md +14 -14
  291. package/docs/examples/messaging/update-fcm-provider.md +6 -6
  292. package/docs/examples/messaging/update-mailgun-provider.md +12 -12
  293. package/docs/examples/messaging/{update-msg91provider.md → update-msg-91-provider.md} +8 -8
  294. package/docs/examples/messaging/update-push.md +21 -21
  295. package/docs/examples/messaging/update-resend-provider.md +20 -0
  296. package/docs/examples/messaging/update-sendgrid-provider.md +10 -10
  297. package/docs/examples/messaging/update-sms.md +9 -9
  298. package/docs/examples/messaging/update-smtp-provider.md +16 -16
  299. package/docs/examples/messaging/update-telesign-provider.md +8 -8
  300. package/docs/examples/messaging/update-textmagic-provider.md +8 -8
  301. package/docs/examples/messaging/update-topic.md +5 -5
  302. package/docs/examples/messaging/update-twilio-provider.md +8 -8
  303. package/docs/examples/messaging/update-vonage-provider.md +8 -8
  304. package/docs/examples/migrations/create-appwrite-migration.md +6 -6
  305. package/docs/examples/migrations/create-csv-export.md +21 -0
  306. package/docs/examples/migrations/{create-csv-migration.md → create-csv-import.md} +6 -5
  307. package/docs/examples/migrations/create-firebase-migration.md +4 -4
  308. package/docs/examples/migrations/create-n-host-migration.md +10 -10
  309. package/docs/examples/migrations/create-supabase-migration.md +9 -9
  310. package/docs/examples/migrations/delete.md +3 -3
  311. package/docs/examples/migrations/get-appwrite-report.md +6 -6
  312. package/docs/examples/migrations/get-firebase-report.md +4 -4
  313. package/docs/examples/migrations/get-n-host-report.md +10 -10
  314. package/docs/examples/migrations/get-supabase-report.md +9 -9
  315. package/docs/examples/migrations/get.md +3 -3
  316. package/docs/examples/migrations/list.md +5 -4
  317. package/docs/examples/migrations/retry.md +3 -3
  318. package/docs/examples/organizations/add-credit.md +4 -4
  319. package/docs/examples/organizations/cancel-downgrade.md +3 -3
  320. package/docs/examples/organizations/create-downgrade-feedback.md +17 -0
  321. package/docs/examples/organizations/create-invoice-payment.md +5 -5
  322. package/docs/examples/organizations/create.md +13 -12
  323. package/docs/examples/organizations/delete-backup-payment-method.md +3 -3
  324. package/docs/examples/organizations/delete-billing-address.md +3 -3
  325. package/docs/examples/organizations/delete-default-payment-method.md +3 -3
  326. package/docs/examples/organizations/delete.md +3 -3
  327. package/docs/examples/organizations/estimation-create-organization.md +8 -7
  328. package/docs/examples/organizations/estimation-delete-organization.md +3 -3
  329. package/docs/examples/organizations/estimation-update-plan.md +7 -7
  330. package/docs/examples/organizations/get-aggregation.md +6 -4
  331. package/docs/examples/organizations/get-available-credits.md +3 -3
  332. package/docs/examples/organizations/get-billing-address.md +4 -4
  333. package/docs/examples/organizations/get-credit.md +4 -4
  334. package/docs/examples/organizations/get-invoice-download.md +4 -4
  335. package/docs/examples/organizations/get-invoice-view.md +4 -4
  336. package/docs/examples/organizations/get-invoice.md +4 -4
  337. package/docs/examples/organizations/get-payment-method.md +4 -4
  338. package/docs/examples/organizations/get-plan.md +3 -3
  339. package/docs/examples/organizations/get-scopes.md +3 -3
  340. package/docs/examples/organizations/get-usage.md +5 -5
  341. package/docs/examples/organizations/list-aggregations.md +4 -4
  342. package/docs/examples/organizations/list-credits.md +4 -4
  343. package/docs/examples/organizations/list-invoices.md +4 -4
  344. package/docs/examples/organizations/list.md +4 -4
  345. package/docs/examples/organizations/set-backup-payment-method.md +4 -4
  346. package/docs/examples/organizations/set-billing-address.md +4 -4
  347. package/docs/examples/organizations/set-billing-email.md +4 -4
  348. package/docs/examples/organizations/set-billing-tax-id.md +4 -4
  349. package/docs/examples/organizations/set-default-payment-method.md +4 -4
  350. package/docs/examples/organizations/update-budget.md +5 -5
  351. package/docs/examples/organizations/update-plan.md +11 -11
  352. package/docs/examples/organizations/update-projects.md +4 -4
  353. package/docs/examples/organizations/validate-invoice.md +4 -4
  354. package/docs/examples/organizations/validate-payment.md +4 -4
  355. package/docs/examples/project/create-variable.md +5 -5
  356. package/docs/examples/project/delete-variable.md +3 -3
  357. package/docs/examples/project/get-usage.md +5 -5
  358. package/docs/examples/project/get-variable.md +3 -3
  359. package/docs/examples/project/update-variable.md +6 -6
  360. package/docs/examples/projects/create-dev-key.md +5 -5
  361. package/docs/examples/projects/{create-j-w-t.md → create-jwt.md} +5 -5
  362. package/docs/examples/projects/create-key.md +6 -6
  363. package/docs/examples/projects/create-platform.md +8 -8
  364. package/docs/examples/projects/create-smtp-test.md +12 -12
  365. package/docs/examples/projects/create-webhook.md +10 -10
  366. package/docs/examples/projects/create.md +16 -16
  367. package/docs/examples/projects/delete-dev-key.md +4 -4
  368. package/docs/examples/projects/delete-email-template.md +5 -5
  369. package/docs/examples/projects/delete-key.md +4 -4
  370. package/docs/examples/projects/delete-platform.md +4 -4
  371. package/docs/examples/projects/delete-sms-template.md +5 -5
  372. package/docs/examples/projects/delete-webhook.md +4 -4
  373. package/docs/examples/projects/delete.md +3 -3
  374. package/docs/examples/projects/get-dev-key.md +4 -4
  375. package/docs/examples/projects/get-email-template.md +5 -5
  376. package/docs/examples/projects/get-key.md +4 -4
  377. package/docs/examples/projects/get-platform.md +4 -4
  378. package/docs/examples/projects/get-sms-template.md +5 -5
  379. package/docs/examples/projects/get-webhook.md +4 -4
  380. package/docs/examples/projects/get.md +3 -3
  381. package/docs/examples/projects/list-dev-keys.md +4 -4
  382. package/docs/examples/projects/list-keys.md +4 -3
  383. package/docs/examples/projects/list-platforms.md +4 -3
  384. package/docs/examples/projects/list-webhooks.md +4 -3
  385. package/docs/examples/projects/list.md +5 -4
  386. package/docs/examples/projects/update-api-status-all.md +4 -4
  387. package/docs/examples/projects/update-api-status.md +6 -6
  388. package/docs/examples/projects/update-auth-duration.md +4 -4
  389. package/docs/examples/projects/update-auth-limit.md +4 -4
  390. package/docs/examples/projects/update-auth-password-dictionary.md +4 -4
  391. package/docs/examples/projects/update-auth-password-history.md +4 -4
  392. package/docs/examples/projects/update-auth-sessions-limit.md +4 -4
  393. package/docs/examples/projects/update-auth-status.md +5 -5
  394. package/docs/examples/projects/update-dev-key.md +6 -6
  395. package/docs/examples/projects/update-email-template.md +10 -10
  396. package/docs/examples/projects/update-key.md +7 -7
  397. package/docs/examples/projects/update-memberships-privacy.md +6 -6
  398. package/docs/examples/projects/update-mock-numbers.md +4 -4
  399. package/docs/examples/projects/{update-o-auth2.md → update-o-auth-2.md} +7 -7
  400. package/docs/examples/projects/update-personal-data-check.md +4 -4
  401. package/docs/examples/projects/update-platform.md +8 -8
  402. package/docs/examples/projects/update-service-status-all.md +4 -4
  403. package/docs/examples/projects/update-service-status.md +5 -5
  404. package/docs/examples/projects/update-session-alerts.md +4 -4
  405. package/docs/examples/projects/update-session-invalidation.md +14 -0
  406. package/docs/examples/projects/update-sms-template.md +6 -6
  407. package/docs/examples/projects/update-smtp.md +12 -12
  408. package/docs/examples/projects/update-status.md +14 -0
  409. package/docs/examples/projects/update-team.md +4 -4
  410. package/docs/examples/projects/update-webhook-signature.md +4 -4
  411. package/docs/examples/projects/update-webhook.md +11 -11
  412. package/docs/examples/projects/update.md +13 -13
  413. package/docs/examples/proxy/{create-a-p-i-rule.md → create-api-rule.md} +3 -3
  414. package/docs/examples/proxy/create-function-rule.md +5 -5
  415. package/docs/examples/proxy/create-redirect-rule.md +8 -8
  416. package/docs/examples/proxy/create-site-rule.md +5 -5
  417. package/docs/examples/proxy/delete-rule.md +3 -3
  418. package/docs/examples/proxy/get-rule.md +3 -3
  419. package/docs/examples/proxy/list-rules.md +5 -4
  420. package/docs/examples/proxy/update-rule-verification.md +3 -3
  421. package/docs/examples/sites/create-deployment.md +8 -8
  422. package/docs/examples/sites/create-duplicate-deployment.md +4 -4
  423. package/docs/examples/sites/create-template-deployment.md +10 -9
  424. package/docs/examples/sites/create-variable.md +6 -6
  425. package/docs/examples/sites/create-vcs-deployment.md +7 -7
  426. package/docs/examples/sites/create.md +21 -21
  427. package/docs/examples/sites/delete-deployment.md +4 -4
  428. package/docs/examples/sites/delete-log.md +4 -4
  429. package/docs/examples/sites/delete-variable.md +4 -4
  430. package/docs/examples/sites/delete.md +3 -3
  431. package/docs/examples/sites/get-deployment-download.md +5 -5
  432. package/docs/examples/sites/get-deployment.md +4 -4
  433. package/docs/examples/sites/get-log.md +4 -4
  434. package/docs/examples/sites/get-template.md +3 -3
  435. package/docs/examples/sites/get-usage.md +5 -5
  436. package/docs/examples/sites/get-variable.md +4 -4
  437. package/docs/examples/sites/get.md +3 -3
  438. package/docs/examples/sites/list-deployments.md +6 -5
  439. package/docs/examples/sites/list-logs.md +5 -4
  440. package/docs/examples/sites/list-templates.md +6 -6
  441. package/docs/examples/sites/list-usage.md +4 -4
  442. package/docs/examples/sites/list-variables.md +3 -3
  443. package/docs/examples/sites/list.md +5 -4
  444. package/docs/examples/sites/update-deployment-status.md +4 -4
  445. package/docs/examples/sites/update-site-deployment.md +4 -4
  446. package/docs/examples/sites/update-variable.md +7 -7
  447. package/docs/examples/sites/update.md +21 -21
  448. package/docs/examples/storage/create-bucket.md +14 -13
  449. package/docs/examples/storage/create-file.md +7 -7
  450. package/docs/examples/storage/delete-bucket.md +3 -3
  451. package/docs/examples/storage/delete-file.md +4 -4
  452. package/docs/examples/storage/get-bucket-usage.md +5 -5
  453. package/docs/examples/storage/get-bucket.md +3 -3
  454. package/docs/examples/storage/get-file-download.md +5 -5
  455. package/docs/examples/storage/get-file-preview.md +16 -16
  456. package/docs/examples/storage/get-file-view.md +5 -5
  457. package/docs/examples/storage/get-file.md +4 -4
  458. package/docs/examples/storage/get-usage.md +4 -4
  459. package/docs/examples/storage/list-buckets.md +5 -4
  460. package/docs/examples/storage/list-files.md +6 -5
  461. package/docs/examples/storage/update-bucket.md +14 -13
  462. package/docs/examples/storage/update-file.md +7 -7
  463. package/docs/examples/tablesdb/create-boolean-column.md +18 -0
  464. package/docs/examples/tablesdb/create-datetime-column.md +18 -0
  465. package/docs/examples/tablesdb/create-email-column.md +18 -0
  466. package/docs/examples/tablesdb/create-enum-column.md +19 -0
  467. package/docs/examples/tablesdb/create-float-column.md +20 -0
  468. package/docs/examples/tablesdb/create-index.md +19 -0
  469. package/docs/examples/tablesdb/create-integer-column.md +20 -0
  470. package/docs/examples/tablesdb/create-ip-column.md +18 -0
  471. package/docs/examples/tablesdb/create-line-column.md +17 -0
  472. package/docs/examples/tablesdb/create-operations.md +24 -0
  473. package/docs/examples/tablesdb/create-point-column.md +17 -0
  474. package/docs/examples/tablesdb/create-polygon-column.md +17 -0
  475. package/docs/examples/tablesdb/create-relationship-column.md +20 -0
  476. package/docs/examples/tablesdb/create-row.md +24 -0
  477. package/docs/examples/tablesdb/create-rows.md +16 -0
  478. package/docs/examples/tablesdb/create-string-column.md +20 -0
  479. package/docs/examples/tablesdb/create-table.md +20 -0
  480. package/docs/examples/tablesdb/create-transaction.md +13 -0
  481. package/docs/examples/tablesdb/create-url-column.md +18 -0
  482. package/docs/examples/tablesdb/create.md +15 -0
  483. package/docs/examples/tablesdb/decrement-row-column.md +19 -0
  484. package/docs/examples/tablesdb/delete-column.md +15 -0
  485. package/docs/examples/tablesdb/delete-index.md +15 -0
  486. package/docs/examples/tablesdb/delete-row.md +16 -0
  487. package/docs/examples/tablesdb/delete-rows.md +16 -0
  488. package/docs/examples/tablesdb/delete-table.md +14 -0
  489. package/docs/examples/tablesdb/delete-transaction.md +13 -0
  490. package/docs/examples/tablesdb/delete.md +13 -0
  491. package/docs/examples/tablesdb/get-column.md +15 -0
  492. package/docs/examples/tablesdb/get-index.md +15 -0
  493. package/docs/examples/tablesdb/get-row.md +17 -0
  494. package/docs/examples/tablesdb/get-table-usage.md +15 -0
  495. package/docs/examples/tablesdb/get-table.md +14 -0
  496. package/docs/examples/tablesdb/get-transaction.md +13 -0
  497. package/docs/examples/tablesdb/get-usage.md +14 -0
  498. package/docs/examples/tablesdb/get.md +13 -0
  499. package/docs/examples/tablesdb/increment-row-column.md +19 -0
  500. package/docs/examples/tablesdb/list-columns.md +16 -0
  501. package/docs/examples/tablesdb/list-indexes.md +16 -0
  502. package/docs/examples/tablesdb/list-row-logs.md +16 -0
  503. package/docs/examples/tablesdb/list-rows.md +17 -0
  504. package/docs/examples/tablesdb/list-table-logs.md +15 -0
  505. package/docs/examples/tablesdb/list-tables.md +16 -0
  506. package/docs/examples/tablesdb/list-transactions.md +13 -0
  507. package/docs/examples/tablesdb/list-usage.md +13 -0
  508. package/docs/examples/tablesdb/list.md +15 -0
  509. package/docs/examples/tablesdb/update-boolean-column.md +18 -0
  510. package/docs/examples/tablesdb/update-datetime-column.md +18 -0
  511. package/docs/examples/tablesdb/update-email-column.md +18 -0
  512. package/docs/examples/tablesdb/update-enum-column.md +19 -0
  513. package/docs/examples/tablesdb/update-float-column.md +20 -0
  514. package/docs/examples/tablesdb/update-integer-column.md +20 -0
  515. package/docs/examples/tablesdb/update-ip-column.md +18 -0
  516. package/docs/examples/tablesdb/update-line-column.md +18 -0
  517. package/docs/examples/tablesdb/update-point-column.md +18 -0
  518. package/docs/examples/tablesdb/update-polygon-column.md +18 -0
  519. package/docs/examples/tablesdb/update-relationship-column.md +17 -0
  520. package/docs/examples/tablesdb/update-row.md +24 -0
  521. package/docs/examples/tablesdb/update-rows.md +23 -0
  522. package/docs/examples/tablesdb/update-string-column.md +19 -0
  523. package/docs/examples/tablesdb/update-table.md +18 -0
  524. package/docs/examples/tablesdb/update-transaction.md +15 -0
  525. package/docs/examples/tablesdb/update-url-column.md +18 -0
  526. package/docs/examples/tablesdb/update.md +15 -0
  527. package/docs/examples/tablesdb/upsert-row.md +24 -0
  528. package/docs/examples/tablesdb/upsert-rows.md +16 -0
  529. package/docs/examples/teams/create-membership.md +9 -9
  530. package/docs/examples/teams/create.md +5 -5
  531. package/docs/examples/teams/delete-membership.md +4 -4
  532. package/docs/examples/teams/delete.md +3 -3
  533. package/docs/examples/teams/get-membership.md +4 -4
  534. package/docs/examples/teams/get-prefs.md +3 -3
  535. package/docs/examples/teams/get.md +3 -3
  536. package/docs/examples/teams/list-logs.md +5 -4
  537. package/docs/examples/teams/list-memberships.md +6 -5
  538. package/docs/examples/teams/list.md +5 -4
  539. package/docs/examples/teams/update-membership-status.md +6 -6
  540. package/docs/examples/teams/update-membership.md +5 -5
  541. package/docs/examples/teams/update-name.md +4 -4
  542. package/docs/examples/teams/update-prefs.md +4 -4
  543. package/docs/examples/tokens/create-file-token.md +5 -5
  544. package/docs/examples/tokens/delete.md +3 -3
  545. package/docs/examples/tokens/get.md +3 -3
  546. package/docs/examples/tokens/list.md +6 -5
  547. package/docs/examples/tokens/update.md +4 -4
  548. package/docs/examples/users/{create-m-d5user.md → create-argon-2-user.md} +6 -6
  549. package/docs/examples/users/create-bcrypt-user.md +6 -6
  550. package/docs/examples/users/{create-j-w-t.md → create-jwt.md} +5 -5
  551. package/docs/examples/users/{create-argon2user.md → create-md-5-user.md} +6 -6
  552. package/docs/examples/users/create-mfa-recovery-codes.md +3 -3
  553. package/docs/examples/users/{create-p-h-pass-user.md → create-ph-pass-user.md} +6 -6
  554. package/docs/examples/users/create-scrypt-modified-user.md +9 -9
  555. package/docs/examples/users/create-scrypt-user.md +11 -11
  556. package/docs/examples/users/create-session.md +3 -3
  557. package/docs/examples/users/{create-s-h-a-user.md → create-sha-user.md} +7 -7
  558. package/docs/examples/users/create-target.md +8 -8
  559. package/docs/examples/users/create-token.md +5 -5
  560. package/docs/examples/users/create.md +7 -7
  561. package/docs/examples/users/delete-identity.md +3 -3
  562. package/docs/examples/users/delete-mfa-authenticator.md +4 -4
  563. package/docs/examples/users/delete-session.md +4 -4
  564. package/docs/examples/users/delete-sessions.md +3 -3
  565. package/docs/examples/users/delete-target.md +4 -4
  566. package/docs/examples/users/delete.md +3 -3
  567. package/docs/examples/users/get-mfa-recovery-codes.md +3 -3
  568. package/docs/examples/users/get-prefs.md +3 -3
  569. package/docs/examples/users/get-target.md +4 -4
  570. package/docs/examples/users/get-usage.md +4 -4
  571. package/docs/examples/users/get.md +3 -3
  572. package/docs/examples/users/list-identities.md +5 -4
  573. package/docs/examples/users/list-logs.md +5 -4
  574. package/docs/examples/users/list-memberships.md +6 -5
  575. package/docs/examples/users/list-mfa-factors.md +3 -3
  576. package/docs/examples/users/list-sessions.md +4 -3
  577. package/docs/examples/users/list-targets.md +5 -4
  578. package/docs/examples/users/list.md +5 -4
  579. package/docs/examples/users/update-email-verification.md +4 -4
  580. package/docs/examples/users/update-email.md +4 -4
  581. package/docs/examples/users/update-labels.md +4 -4
  582. package/docs/examples/users/update-mfa-recovery-codes.md +3 -3
  583. package/docs/examples/users/update-mfa.md +4 -4
  584. package/docs/examples/users/update-name.md +4 -4
  585. package/docs/examples/users/update-password.md +4 -4
  586. package/docs/examples/users/update-phone-verification.md +4 -4
  587. package/docs/examples/users/update-phone.md +4 -4
  588. package/docs/examples/users/update-prefs.md +4 -4
  589. package/docs/examples/users/update-status.md +4 -4
  590. package/docs/examples/users/update-target.md +7 -7
  591. package/docs/examples/vcs/create-repository-detection.md +6 -6
  592. package/docs/examples/vcs/create-repository.md +5 -5
  593. package/docs/examples/vcs/delete-installation.md +3 -3
  594. package/docs/examples/vcs/get-installation.md +3 -3
  595. package/docs/examples/vcs/get-repository-contents.md +6 -6
  596. package/docs/examples/vcs/get-repository.md +4 -4
  597. package/docs/examples/vcs/list-installations.md +5 -4
  598. package/docs/examples/vcs/list-repositories.md +6 -5
  599. package/docs/examples/vcs/list-repository-branches.md +4 -4
  600. package/docs/examples/vcs/update-external-deployments.md +5 -5
  601. package/package.json +4 -4
  602. package/src/client.ts +42 -7
  603. package/src/enums/api-service.ts +1 -0
  604. package/src/enums/attribute-status.ts +7 -0
  605. package/src/enums/billing-plan-group.ts +5 -0
  606. package/src/enums/build-runtime.ts +2 -0
  607. package/src/enums/column-status.ts +7 -0
  608. package/src/enums/credit-card.ts +1 -1
  609. package/src/enums/database-type.ts +4 -0
  610. package/src/enums/deployment-status.ts +7 -0
  611. package/src/enums/execution-method.ts +1 -0
  612. package/src/enums/execution-status.ts +7 -0
  613. package/src/enums/execution-trigger.ts +5 -0
  614. package/src/enums/framework.ts +1 -0
  615. package/src/enums/health-antivirus-status.ts +5 -0
  616. package/src/enums/health-check-status.ts +4 -0
  617. package/src/enums/index-status.ts +7 -0
  618. package/src/enums/index-type.ts +1 -0
  619. package/src/enums/message-status.ts +7 -0
  620. package/src/enums/o-auth-provider.ts +3 -0
  621. package/src/enums/platform.ts +4 -0
  622. package/src/enums/proxy-rule-deployment-resource-type.ts +4 -0
  623. package/src/enums/proxy-rule-status.ts +6 -0
  624. package/src/enums/region.ts +3 -0
  625. package/src/enums/runtime.ts +2 -0
  626. package/src/enums/status.ts +4 -0
  627. package/src/enums/template-reference-type.ts +5 -0
  628. package/src/enums/theme.ts +4 -0
  629. package/src/enums/timezone.ts +421 -0
  630. package/src/enums/{user-usage-range.ts → usage-range.ts} +1 -1
  631. package/src/enums/{v-c-s-deployment-type.ts → vcs-reference-type.ts} +1 -1
  632. package/src/index.ts +27 -11
  633. package/src/models.ts +1692 -238
  634. package/src/operator.ts +308 -0
  635. package/src/query.ts +246 -2
  636. package/src/services/account.ts +2205 -223
  637. package/src/services/assistant.ts +29 -3
  638. package/src/services/avatars.ts +486 -33
  639. package/src/services/backups.ts +389 -42
  640. package/src/services/console.ts +492 -19
  641. package/src/services/databases.ts +3521 -431
  642. package/src/services/domains.ts +1684 -197
  643. package/src/services/functions.ts +1162 -149
  644. package/src/services/graphql.ts +55 -4
  645. package/src/services/health.ts +560 -41
  646. package/src/services/locale.ts +9 -0
  647. package/src/services/messaging.ts +3367 -380
  648. package/src/services/migrations.ts +641 -65
  649. package/src/services/organizations.ts +1323 -128
  650. package/src/services/project.ts +168 -17
  651. package/src/services/projects.ts +2742 -266
  652. package/src/services/proxy.ts +265 -26
  653. package/src/services/realtime.ts +437 -0
  654. package/src/services/sites.ts +1098 -140
  655. package/src/services/storage.ts +651 -82
  656. package/src/services/tables-db.ts +5439 -0
  657. package/src/services/teams.ts +512 -55
  658. package/src/services/tokens.ts +167 -16
  659. package/src/services/users.ts +1873 -181
  660. package/src/services/vcs.ts +359 -39
  661. package/types/client.d.ts +14 -5
  662. package/types/enums/api-service.d.ts +1 -0
  663. package/types/enums/attribute-status.d.ts +7 -0
  664. package/types/enums/billing-plan-group.d.ts +5 -0
  665. package/types/enums/build-runtime.d.ts +3 -1
  666. package/types/enums/column-status.d.ts +7 -0
  667. package/types/enums/credit-card.d.ts +1 -1
  668. package/types/enums/database-type.d.ts +4 -0
  669. package/types/enums/deployment-status.d.ts +7 -0
  670. package/types/enums/execution-method.d.ts +2 -1
  671. package/types/enums/execution-status.d.ts +7 -0
  672. package/types/enums/execution-trigger.d.ts +5 -0
  673. package/types/enums/framework.d.ts +1 -0
  674. package/types/enums/health-antivirus-status.d.ts +5 -0
  675. package/types/enums/health-check-status.d.ts +4 -0
  676. package/types/enums/index-status.d.ts +7 -0
  677. package/types/enums/index-type.d.ts +2 -1
  678. package/types/enums/message-status.d.ts +7 -0
  679. package/types/enums/o-auth-provider.d.ts +4 -1
  680. package/types/enums/platform.d.ts +4 -0
  681. package/types/enums/proxy-rule-deployment-resource-type.d.ts +4 -0
  682. package/types/enums/proxy-rule-status.d.ts +6 -0
  683. package/types/enums/region.d.ts +4 -1
  684. package/types/enums/runtime.d.ts +3 -1
  685. package/types/enums/status.d.ts +4 -0
  686. package/types/enums/template-reference-type.d.ts +5 -0
  687. package/types/enums/theme.d.ts +4 -0
  688. package/types/enums/timezone.d.ts +421 -0
  689. package/types/enums/{site-usage-range.d.ts → usage-range.d.ts} +1 -1
  690. package/types/enums/{v-c-s-deployment-type.d.ts → vcs-reference-type.d.ts} +1 -1
  691. package/types/index.d.ts +27 -11
  692. package/types/models.d.ts +1664 -245
  693. package/types/operator.d.ts +180 -0
  694. package/types/query.d.ts +198 -2
  695. package/types/services/account.d.ts +985 -123
  696. package/types/services/assistant.d.ts +13 -2
  697. package/types/services/avatars.d.ts +244 -26
  698. package/types/services/backups.d.ts +190 -30
  699. package/types/services/console.d.ts +201 -14
  700. package/types/services/databases.d.ts +1731 -284
  701. package/types/services/domains.d.ts +904 -152
  702. package/types/services/functions.d.ts +616 -125
  703. package/types/services/graphql.d.ts +24 -2
  704. package/types/services/health.d.ts +245 -23
  705. package/types/services/messaging.d.ts +1660 -271
  706. package/types/services/migrations.d.ts +319 -53
  707. package/types/services/organizations.d.ts +635 -97
  708. package/types/services/project.d.ts +81 -12
  709. package/types/services/projects.d.ts +1308 -202
  710. package/types/services/proxy.d.ts +128 -19
  711. package/types/services/realtime.d.ts +118 -0
  712. package/types/services/sites.d.ts +577 -116
  713. package/types/services/storage.d.ts +354 -73
  714. package/types/services/tables-db.d.ts +2040 -0
  715. package/types/services/teams.d.ts +260 -44
  716. package/types/services/tokens.d.ts +80 -12
  717. package/types/services/users.d.ts +881 -124
  718. package/types/services/vcs.d.ts +179 -31
  719. package/docs/examples/domains/create-record-m-x.md +0 -18
  720. package/docs/examples/domains/create-record-s-r-v.md +0 -20
  721. package/docs/examples/domains/create-record-t-x-t.md +0 -17
  722. package/docs/examples/domains/update-record-a-a-a-a.md +0 -18
  723. package/docs/examples/domains/update-record-c-a-a.md +0 -18
  724. package/docs/examples/domains/update-record-c-n-a-m-e.md +0 -18
  725. package/docs/examples/domains/update-record-h-t-t-p-s.md +0 -18
  726. package/docs/examples/domains/update-record-m-x.md +0 -19
  727. package/docs/examples/domains/update-record-n-s.md +0 -18
  728. package/docs/examples/domains/update-record-s-r-v.md +0 -21
  729. package/docs/examples/domains/update-record-t-x-t.md +0 -18
  730. package/src/enums/billing-plan.ts +0 -5
  731. package/src/enums/database-usage-range.ts +0 -5
  732. package/src/enums/function-usage-range.ts +0 -5
  733. package/src/enums/site-usage-range.ts +0 -5
  734. package/src/enums/storage-usage-range.ts +0 -5
  735. package/types/enums/billing-plan.d.ts +0 -5
  736. package/types/enums/database-usage-range.d.ts +0 -5
  737. package/types/enums/function-usage-range.d.ts +0 -5
  738. package/types/enums/storage-usage-range.d.ts +0 -5
  739. package/types/enums/user-usage-range.d.ts +0 -5
  740. /package/docs/examples/health/{get-d-b.md → get-db.md} +0 -0
  741. /package/docs/examples/locale/{list-countries-e-u.md → list-countries-eu.md} +0 -0
  742. /package/src/enums/{s-m-t-p-secure.ts → smtp-secure.ts} +0 -0
  743. /package/src/enums/{v-c-s-detection-type.ts → vcs-detection-type.ts} +0 -0
  744. /package/types/enums/{s-m-t-p-secure.d.ts → smtp-secure.d.ts} +0 -0
  745. /package/types/enums/{v-c-s-detection-type.d.ts → vcs-detection-type.d.ts} +0 -0
@@ -2,6 +2,7 @@ import { Service } from '../service';
2
2
  import { AppwriteException, Client, type Payload, UploadProgress } from '../client';
3
3
  import type { Models } from '../models';
4
4
 
5
+
5
6
  export class Teams {
6
7
  client: Client;
7
8
 
@@ -12,12 +13,45 @@ export class Teams {
12
13
  /**
13
14
  * Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.
14
15
  *
15
- * @param {string[]} queries
16
- * @param {string} search
16
+ * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, total, billingPlan
17
+ * @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
18
+ * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
19
+ * @throws {AppwriteException}
20
+ * @returns {Promise<Models.TeamList<Preferences>>}
21
+ */
22
+ list<Preferences extends Models.Preferences = Models.DefaultPreferences>(params?: { queries?: string[], search?: string, total?: boolean }): Promise<Models.TeamList<Preferences>>;
23
+ /**
24
+ * Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.
25
+ *
26
+ * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, total, billingPlan
27
+ * @param {string} search - Search term to filter your list results. Max length: 256 chars.
28
+ * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
17
29
  * @throws {AppwriteException}
18
30
  * @returns {Promise<Models.TeamList<Preferences>>}
31
+ * @deprecated Use the object parameter style method for a better developer experience.
19
32
  */
20
- list<Preferences extends Models.Preferences = Models.DefaultPreferences>(queries?: string[], search?: string): Promise<Models.TeamList<Preferences>> {
33
+ list<Preferences extends Models.Preferences = Models.DefaultPreferences>(queries?: string[], search?: string, total?: boolean): Promise<Models.TeamList<Preferences>>;
34
+ list<Preferences extends Models.Preferences = Models.DefaultPreferences>(
35
+ paramsOrFirst?: { queries?: string[], search?: string, total?: boolean } | string[],
36
+ ...rest: [(string)?, (boolean)?]
37
+ ): Promise<Models.TeamList<Preferences>> {
38
+ let params: { queries?: string[], search?: string, total?: boolean };
39
+
40
+ if (!paramsOrFirst || (paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
41
+ params = (paramsOrFirst || {}) as { queries?: string[], search?: string, total?: boolean };
42
+ } else {
43
+ params = {
44
+ queries: paramsOrFirst as string[],
45
+ search: rest[0] as string,
46
+ total: rest[1] as boolean
47
+ };
48
+ }
49
+
50
+ const queries = params.queries;
51
+ const search = params.search;
52
+ const total = params.total;
53
+
54
+
21
55
  const apiPath = '/teams';
22
56
  const payload: Payload = {};
23
57
  if (typeof queries !== 'undefined') {
@@ -26,6 +60,9 @@ export class Teams {
26
60
  if (typeof search !== 'undefined') {
27
61
  payload['search'] = search;
28
62
  }
63
+ if (typeof total !== 'undefined') {
64
+ payload['total'] = total;
65
+ }
29
66
  const uri = new URL(this.client.config.endpoint + apiPath);
30
67
 
31
68
  const apiHeaders: { [header: string]: string } = {
@@ -42,19 +79,51 @@ export class Teams {
42
79
  /**
43
80
  * Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.
44
81
  *
45
- * @param {string} teamId
46
- * @param {string} name
47
- * @param {string[]} roles
82
+ * @param {string} params.teamId - Team 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.
83
+ * @param {string} params.name - Team name. Max length: 128 chars.
84
+ * @param {string[]} params.roles - Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
85
+ * @throws {AppwriteException}
86
+ * @returns {Promise<Models.Team<Preferences>>}
87
+ */
88
+ create<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: { teamId: string, name: string, roles?: string[] }): Promise<Models.Team<Preferences>>;
89
+ /**
90
+ * Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.
91
+ *
92
+ * @param {string} teamId - Team 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.
93
+ * @param {string} name - Team name. Max length: 128 chars.
94
+ * @param {string[]} roles - Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
48
95
  * @throws {AppwriteException}
49
96
  * @returns {Promise<Models.Team<Preferences>>}
97
+ * @deprecated Use the object parameter style method for a better developer experience.
50
98
  */
51
- create<Preferences extends Models.Preferences = Models.DefaultPreferences>(teamId: string, name: string, roles?: string[]): Promise<Models.Team<Preferences>> {
99
+ create<Preferences extends Models.Preferences = Models.DefaultPreferences>(teamId: string, name: string, roles?: string[]): Promise<Models.Team<Preferences>>;
100
+ create<Preferences extends Models.Preferences = Models.DefaultPreferences>(
101
+ paramsOrFirst: { teamId: string, name: string, roles?: string[] } | string,
102
+ ...rest: [(string)?, (string[])?]
103
+ ): Promise<Models.Team<Preferences>> {
104
+ let params: { teamId: string, name: string, roles?: string[] };
105
+
106
+ if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
107
+ params = (paramsOrFirst || {}) as { teamId: string, name: string, roles?: string[] };
108
+ } else {
109
+ params = {
110
+ teamId: paramsOrFirst as string,
111
+ name: rest[0] as string,
112
+ roles: rest[1] as string[]
113
+ };
114
+ }
115
+
116
+ const teamId = params.teamId;
117
+ const name = params.name;
118
+ const roles = params.roles;
119
+
52
120
  if (typeof teamId === 'undefined') {
53
121
  throw new AppwriteException('Missing required parameter: "teamId"');
54
122
  }
55
123
  if (typeof name === 'undefined') {
56
124
  throw new AppwriteException('Missing required parameter: "name"');
57
125
  }
126
+
58
127
  const apiPath = '/teams';
59
128
  const payload: Payload = {};
60
129
  if (typeof teamId !== 'undefined') {
@@ -83,14 +152,39 @@ export class Teams {
83
152
  /**
84
153
  * Get a team by its ID. All team members have read access for this resource.
85
154
  *
86
- * @param {string} teamId
155
+ * @param {string} params.teamId - Team ID.
156
+ * @throws {AppwriteException}
157
+ * @returns {Promise<Models.Team<Preferences>>}
158
+ */
159
+ get<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: { teamId: string }): Promise<Models.Team<Preferences>>;
160
+ /**
161
+ * Get a team by its ID. All team members have read access for this resource.
162
+ *
163
+ * @param {string} teamId - Team ID.
87
164
  * @throws {AppwriteException}
88
165
  * @returns {Promise<Models.Team<Preferences>>}
166
+ * @deprecated Use the object parameter style method for a better developer experience.
89
167
  */
90
- get<Preferences extends Models.Preferences = Models.DefaultPreferences>(teamId: string): Promise<Models.Team<Preferences>> {
168
+ get<Preferences extends Models.Preferences = Models.DefaultPreferences>(teamId: string): Promise<Models.Team<Preferences>>;
169
+ get<Preferences extends Models.Preferences = Models.DefaultPreferences>(
170
+ paramsOrFirst: { teamId: string } | string
171
+ ): Promise<Models.Team<Preferences>> {
172
+ let params: { teamId: string };
173
+
174
+ if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
175
+ params = (paramsOrFirst || {}) as { teamId: string };
176
+ } else {
177
+ params = {
178
+ teamId: paramsOrFirst as string
179
+ };
180
+ }
181
+
182
+ const teamId = params.teamId;
183
+
91
184
  if (typeof teamId === 'undefined') {
92
185
  throw new AppwriteException('Missing required parameter: "teamId"');
93
186
  }
187
+
94
188
  const apiPath = '/teams/{teamId}'.replace('{teamId}', teamId);
95
189
  const payload: Payload = {};
96
190
  const uri = new URL(this.client.config.endpoint + apiPath);
@@ -107,20 +201,49 @@ export class Teams {
107
201
  }
108
202
 
109
203
  /**
110
- * Update the team&#039;s name by its unique ID.
204
+ * Update the team's name by its unique ID.
205
+ *
206
+ * @param {string} params.teamId - Team ID.
207
+ * @param {string} params.name - New team name. Max length: 128 chars.
208
+ * @throws {AppwriteException}
209
+ * @returns {Promise<Models.Team<Preferences>>}
210
+ */
211
+ updateName<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: { teamId: string, name: string }): Promise<Models.Team<Preferences>>;
212
+ /**
213
+ * Update the team's name by its unique ID.
111
214
  *
112
- * @param {string} teamId
113
- * @param {string} name
215
+ * @param {string} teamId - Team ID.
216
+ * @param {string} name - New team name. Max length: 128 chars.
114
217
  * @throws {AppwriteException}
115
218
  * @returns {Promise<Models.Team<Preferences>>}
219
+ * @deprecated Use the object parameter style method for a better developer experience.
116
220
  */
117
- updateName<Preferences extends Models.Preferences = Models.DefaultPreferences>(teamId: string, name: string): Promise<Models.Team<Preferences>> {
221
+ updateName<Preferences extends Models.Preferences = Models.DefaultPreferences>(teamId: string, name: string): Promise<Models.Team<Preferences>>;
222
+ updateName<Preferences extends Models.Preferences = Models.DefaultPreferences>(
223
+ paramsOrFirst: { teamId: string, name: string } | string,
224
+ ...rest: [(string)?]
225
+ ): Promise<Models.Team<Preferences>> {
226
+ let params: { teamId: string, name: string };
227
+
228
+ if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
229
+ params = (paramsOrFirst || {}) as { teamId: string, name: string };
230
+ } else {
231
+ params = {
232
+ teamId: paramsOrFirst as string,
233
+ name: rest[0] as string
234
+ };
235
+ }
236
+
237
+ const teamId = params.teamId;
238
+ const name = params.name;
239
+
118
240
  if (typeof teamId === 'undefined') {
119
241
  throw new AppwriteException('Missing required parameter: "teamId"');
120
242
  }
121
243
  if (typeof name === 'undefined') {
122
244
  throw new AppwriteException('Missing required parameter: "name"');
123
245
  }
246
+
124
247
  const apiPath = '/teams/{teamId}'.replace('{teamId}', teamId);
125
248
  const payload: Payload = {};
126
249
  if (typeof name !== 'undefined') {
@@ -143,14 +266,39 @@ export class Teams {
143
266
  /**
144
267
  * Delete a team using its ID. Only team members with the owner role can delete the team.
145
268
  *
146
- * @param {string} teamId
269
+ * @param {string} params.teamId - Team ID.
270
+ * @throws {AppwriteException}
271
+ * @returns {Promise<{}>}
272
+ */
273
+ delete(params: { teamId: string }): Promise<{}>;
274
+ /**
275
+ * Delete a team using its ID. Only team members with the owner role can delete the team.
276
+ *
277
+ * @param {string} teamId - Team ID.
147
278
  * @throws {AppwriteException}
148
279
  * @returns {Promise<{}>}
280
+ * @deprecated Use the object parameter style method for a better developer experience.
149
281
  */
150
- delete(teamId: string): Promise<{}> {
282
+ delete(teamId: string): Promise<{}>;
283
+ delete(
284
+ paramsOrFirst: { teamId: string } | string
285
+ ): Promise<{}> {
286
+ let params: { teamId: string };
287
+
288
+ if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
289
+ params = (paramsOrFirst || {}) as { teamId: string };
290
+ } else {
291
+ params = {
292
+ teamId: paramsOrFirst as string
293
+ };
294
+ }
295
+
296
+ const teamId = params.teamId;
297
+
151
298
  if (typeof teamId === 'undefined') {
152
299
  throw new AppwriteException('Missing required parameter: "teamId"');
153
300
  }
301
+
154
302
  const apiPath = '/teams/{teamId}'.replace('{teamId}', teamId);
155
303
  const payload: Payload = {};
156
304
  const uri = new URL(this.client.config.endpoint + apiPath);
@@ -170,20 +318,56 @@ export class Teams {
170
318
  /**
171
319
  * Get the team activity logs list by its unique ID.
172
320
  *
173
- * @param {string} teamId
174
- * @param {string[]} queries
321
+ * @param {string} params.teamId - Team ID.
322
+ * @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). Only supported methods are limit and offset
323
+ * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
324
+ * @throws {AppwriteException}
325
+ * @returns {Promise<Models.LogList>}
326
+ */
327
+ listLogs(params: { teamId: string, queries?: string[], total?: boolean }): Promise<Models.LogList>;
328
+ /**
329
+ * Get the team activity logs list by its unique ID.
330
+ *
331
+ * @param {string} teamId - Team ID.
332
+ * @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). Only supported methods are limit and offset
333
+ * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
175
334
  * @throws {AppwriteException}
176
335
  * @returns {Promise<Models.LogList>}
336
+ * @deprecated Use the object parameter style method for a better developer experience.
177
337
  */
178
- listLogs(teamId: string, queries?: string[]): Promise<Models.LogList> {
338
+ listLogs(teamId: string, queries?: string[], total?: boolean): Promise<Models.LogList>;
339
+ listLogs(
340
+ paramsOrFirst: { teamId: string, queries?: string[], total?: boolean } | string,
341
+ ...rest: [(string[])?, (boolean)?]
342
+ ): Promise<Models.LogList> {
343
+ let params: { teamId: string, queries?: string[], total?: boolean };
344
+
345
+ if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
346
+ params = (paramsOrFirst || {}) as { teamId: string, queries?: string[], total?: boolean };
347
+ } else {
348
+ params = {
349
+ teamId: paramsOrFirst as string,
350
+ queries: rest[0] as string[],
351
+ total: rest[1] as boolean
352
+ };
353
+ }
354
+
355
+ const teamId = params.teamId;
356
+ const queries = params.queries;
357
+ const total = params.total;
358
+
179
359
  if (typeof teamId === 'undefined') {
180
360
  throw new AppwriteException('Missing required parameter: "teamId"');
181
361
  }
362
+
182
363
  const apiPath = '/teams/{teamId}/logs'.replace('{teamId}', teamId);
183
364
  const payload: Payload = {};
184
365
  if (typeof queries !== 'undefined') {
185
366
  payload['queries'] = queries;
186
367
  }
368
+ if (typeof total !== 'undefined') {
369
+ payload['total'] = total;
370
+ }
187
371
  const uri = new URL(this.client.config.endpoint + apiPath);
188
372
 
189
373
  const apiHeaders: { [header: string]: string } = {
@@ -198,18 +382,54 @@ export class Teams {
198
382
  }
199
383
 
200
384
  /**
201
- * Use this endpoint to list a team&#039;s members using the team&#039;s ID. All team members have read access to this endpoint. Hide sensitive attributes from the response by toggling membership privacy in the Console.
385
+ * Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint. Hide sensitive attributes from the response by toggling membership privacy in the Console.
202
386
  *
203
- * @param {string} teamId
204
- * @param {string[]} queries
205
- * @param {string} search
387
+ * @param {string} params.teamId - Team ID.
388
+ * @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: userId, teamId, invited, joined, confirm, roles
389
+ * @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
390
+ * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
206
391
  * @throws {AppwriteException}
207
392
  * @returns {Promise<Models.MembershipList>}
208
393
  */
209
- listMemberships(teamId: string, queries?: string[], search?: string): Promise<Models.MembershipList> {
394
+ listMemberships(params: { teamId: string, queries?: string[], search?: string, total?: boolean }): Promise<Models.MembershipList>;
395
+ /**
396
+ * Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint. Hide sensitive attributes from the response by toggling membership privacy in the Console.
397
+ *
398
+ * @param {string} teamId - Team ID.
399
+ * @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: userId, teamId, invited, joined, confirm, roles
400
+ * @param {string} search - Search term to filter your list results. Max length: 256 chars.
401
+ * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
402
+ * @throws {AppwriteException}
403
+ * @returns {Promise<Models.MembershipList>}
404
+ * @deprecated Use the object parameter style method for a better developer experience.
405
+ */
406
+ listMemberships(teamId: string, queries?: string[], search?: string, total?: boolean): Promise<Models.MembershipList>;
407
+ listMemberships(
408
+ paramsOrFirst: { teamId: string, queries?: string[], search?: string, total?: boolean } | string,
409
+ ...rest: [(string[])?, (string)?, (boolean)?]
410
+ ): Promise<Models.MembershipList> {
411
+ let params: { teamId: string, queries?: string[], search?: string, total?: boolean };
412
+
413
+ if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
414
+ params = (paramsOrFirst || {}) as { teamId: string, queries?: string[], search?: string, total?: boolean };
415
+ } else {
416
+ params = {
417
+ teamId: paramsOrFirst as string,
418
+ queries: rest[0] as string[],
419
+ search: rest[1] as string,
420
+ total: rest[2] as boolean
421
+ };
422
+ }
423
+
424
+ const teamId = params.teamId;
425
+ const queries = params.queries;
426
+ const search = params.search;
427
+ const total = params.total;
428
+
210
429
  if (typeof teamId === 'undefined') {
211
430
  throw new AppwriteException('Missing required parameter: "teamId"');
212
431
  }
432
+
213
433
  const apiPath = '/teams/{teamId}/memberships'.replace('{teamId}', teamId);
214
434
  const payload: Payload = {};
215
435
  if (typeof queries !== 'undefined') {
@@ -218,6 +438,9 @@ export class Teams {
218
438
  if (typeof search !== 'undefined') {
219
439
  payload['search'] = search;
220
440
  }
441
+ if (typeof total !== 'undefined') {
442
+ payload['total'] = total;
443
+ }
221
444
  const uri = new URL(this.client.config.endpoint + apiPath);
222
445
 
223
446
  const apiHeaders: { [header: string]: string } = {
@@ -232,32 +455,83 @@ export class Teams {
232
455
  }
233
456
 
234
457
  /**
235
- * Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn&#039;t exist. If initiated from a Server SDK, the new member will be added automatically to the team.
458
+ * Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.
236
459
  *
237
- * You only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID &gt; email &gt; phone number if you provide more than one of these parameters.
460
+ * You only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.
238
461
  *
239
462
  * Use the `url` parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](https://appwrite.io/docs/references/cloud/client-web/teams#updateMembershipStatus) endpoint to allow the user to accept the invitation to the team.
240
463
  *
241
464
  * Please note that to avoid a [Redirect Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console.
242
465
  *
243
466
  *
244
- * @param {string} teamId
245
- * @param {string[]} roles
246
- * @param {string} email
247
- * @param {string} userId
248
- * @param {string} phone
249
- * @param {string} url
250
- * @param {string} name
467
+ * @param {string} params.teamId - Team ID.
468
+ * @param {string[]} params.roles - Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
469
+ * @param {string} params.email - Email of the new team member.
470
+ * @param {string} params.userId - ID of the user to be added to a team.
471
+ * @param {string} params.phone - Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
472
+ * @param {string} params.url - URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
473
+ * @param {string} params.name - Name of the new team member. Max length: 128 chars.
251
474
  * @throws {AppwriteException}
252
475
  * @returns {Promise<Models.Membership>}
253
476
  */
254
- createMembership(teamId: string, roles: string[], email?: string, userId?: string, phone?: string, url?: string, name?: string): Promise<Models.Membership> {
477
+ createMembership(params: { teamId: string, roles: string[], email?: string, userId?: string, phone?: string, url?: string, name?: string }): Promise<Models.Membership>;
478
+ /**
479
+ * Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.
480
+ *
481
+ * You only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.
482
+ *
483
+ * Use the `url` parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](https://appwrite.io/docs/references/cloud/client-web/teams#updateMembershipStatus) endpoint to allow the user to accept the invitation to the team.
484
+ *
485
+ * Please note that to avoid a [Redirect Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console.
486
+ *
487
+ *
488
+ * @param {string} teamId - Team ID.
489
+ * @param {string[]} roles - Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
490
+ * @param {string} email - Email of the new team member.
491
+ * @param {string} userId - ID of the user to be added to a team.
492
+ * @param {string} phone - Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
493
+ * @param {string} url - URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
494
+ * @param {string} name - Name of the new team member. Max length: 128 chars.
495
+ * @throws {AppwriteException}
496
+ * @returns {Promise<Models.Membership>}
497
+ * @deprecated Use the object parameter style method for a better developer experience.
498
+ */
499
+ createMembership(teamId: string, roles: string[], email?: string, userId?: string, phone?: string, url?: string, name?: string): Promise<Models.Membership>;
500
+ createMembership(
501
+ paramsOrFirst: { teamId: string, roles: string[], email?: string, userId?: string, phone?: string, url?: string, name?: string } | string,
502
+ ...rest: [(string[])?, (string)?, (string)?, (string)?, (string)?, (string)?]
503
+ ): Promise<Models.Membership> {
504
+ let params: { teamId: string, roles: string[], email?: string, userId?: string, phone?: string, url?: string, name?: string };
505
+
506
+ if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
507
+ params = (paramsOrFirst || {}) as { teamId: string, roles: string[], email?: string, userId?: string, phone?: string, url?: string, name?: string };
508
+ } else {
509
+ params = {
510
+ teamId: paramsOrFirst as string,
511
+ roles: rest[0] as string[],
512
+ email: rest[1] as string,
513
+ userId: rest[2] as string,
514
+ phone: rest[3] as string,
515
+ url: rest[4] as string,
516
+ name: rest[5] as string
517
+ };
518
+ }
519
+
520
+ const teamId = params.teamId;
521
+ const roles = params.roles;
522
+ const email = params.email;
523
+ const userId = params.userId;
524
+ const phone = params.phone;
525
+ const url = params.url;
526
+ const name = params.name;
527
+
255
528
  if (typeof teamId === 'undefined') {
256
529
  throw new AppwriteException('Missing required parameter: "teamId"');
257
530
  }
258
531
  if (typeof roles === 'undefined') {
259
532
  throw new AppwriteException('Missing required parameter: "roles"');
260
533
  }
534
+
261
535
  const apiPath = '/teams/{teamId}/memberships'.replace('{teamId}', teamId);
262
536
  const payload: Payload = {};
263
537
  if (typeof email !== 'undefined') {
@@ -295,18 +569,47 @@ export class Teams {
295
569
  /**
296
570
  * Get a team member by the membership unique id. All team members have read access for this resource. Hide sensitive attributes from the response by toggling membership privacy in the Console.
297
571
  *
298
- * @param {string} teamId
299
- * @param {string} membershipId
572
+ * @param {string} params.teamId - Team ID.
573
+ * @param {string} params.membershipId - Membership ID.
574
+ * @throws {AppwriteException}
575
+ * @returns {Promise<Models.Membership>}
576
+ */
577
+ getMembership(params: { teamId: string, membershipId: string }): Promise<Models.Membership>;
578
+ /**
579
+ * Get a team member by the membership unique id. All team members have read access for this resource. Hide sensitive attributes from the response by toggling membership privacy in the Console.
580
+ *
581
+ * @param {string} teamId - Team ID.
582
+ * @param {string} membershipId - Membership ID.
300
583
  * @throws {AppwriteException}
301
584
  * @returns {Promise<Models.Membership>}
585
+ * @deprecated Use the object parameter style method for a better developer experience.
302
586
  */
303
- getMembership(teamId: string, membershipId: string): Promise<Models.Membership> {
587
+ getMembership(teamId: string, membershipId: string): Promise<Models.Membership>;
588
+ getMembership(
589
+ paramsOrFirst: { teamId: string, membershipId: string } | string,
590
+ ...rest: [(string)?]
591
+ ): Promise<Models.Membership> {
592
+ let params: { teamId: string, membershipId: string };
593
+
594
+ if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
595
+ params = (paramsOrFirst || {}) as { teamId: string, membershipId: string };
596
+ } else {
597
+ params = {
598
+ teamId: paramsOrFirst as string,
599
+ membershipId: rest[0] as string
600
+ };
601
+ }
602
+
603
+ const teamId = params.teamId;
604
+ const membershipId = params.membershipId;
605
+
304
606
  if (typeof teamId === 'undefined') {
305
607
  throw new AppwriteException('Missing required parameter: "teamId"');
306
608
  }
307
609
  if (typeof membershipId === 'undefined') {
308
610
  throw new AppwriteException('Missing required parameter: "membershipId"');
309
611
  }
612
+
310
613
  const apiPath = '/teams/{teamId}/memberships/{membershipId}'.replace('{teamId}', teamId).replace('{membershipId}', membershipId);
311
614
  const payload: Payload = {};
312
615
  const uri = new URL(this.client.config.endpoint + apiPath);
@@ -326,13 +629,45 @@ export class Teams {
326
629
  * Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](https://appwrite.io/docs/permissions).
327
630
  *
328
631
  *
329
- * @param {string} teamId
330
- * @param {string} membershipId
331
- * @param {string[]} roles
632
+ * @param {string} params.teamId - Team ID.
633
+ * @param {string} params.membershipId - Membership ID.
634
+ * @param {string[]} params.roles - An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
332
635
  * @throws {AppwriteException}
333
636
  * @returns {Promise<Models.Membership>}
334
637
  */
335
- updateMembership(teamId: string, membershipId: string, roles: string[]): Promise<Models.Membership> {
638
+ updateMembership(params: { teamId: string, membershipId: string, roles: string[] }): Promise<Models.Membership>;
639
+ /**
640
+ * Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](https://appwrite.io/docs/permissions).
641
+ *
642
+ *
643
+ * @param {string} teamId - Team ID.
644
+ * @param {string} membershipId - Membership ID.
645
+ * @param {string[]} roles - An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
646
+ * @throws {AppwriteException}
647
+ * @returns {Promise<Models.Membership>}
648
+ * @deprecated Use the object parameter style method for a better developer experience.
649
+ */
650
+ updateMembership(teamId: string, membershipId: string, roles: string[]): Promise<Models.Membership>;
651
+ updateMembership(
652
+ paramsOrFirst: { teamId: string, membershipId: string, roles: string[] } | string,
653
+ ...rest: [(string)?, (string[])?]
654
+ ): Promise<Models.Membership> {
655
+ let params: { teamId: string, membershipId: string, roles: string[] };
656
+
657
+ if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
658
+ params = (paramsOrFirst || {}) as { teamId: string, membershipId: string, roles: string[] };
659
+ } else {
660
+ params = {
661
+ teamId: paramsOrFirst as string,
662
+ membershipId: rest[0] as string,
663
+ roles: rest[1] as string[]
664
+ };
665
+ }
666
+
667
+ const teamId = params.teamId;
668
+ const membershipId = params.membershipId;
669
+ const roles = params.roles;
670
+
336
671
  if (typeof teamId === 'undefined') {
337
672
  throw new AppwriteException('Missing required parameter: "teamId"');
338
673
  }
@@ -342,6 +677,7 @@ export class Teams {
342
677
  if (typeof roles === 'undefined') {
343
678
  throw new AppwriteException('Missing required parameter: "roles"');
344
679
  }
680
+
345
681
  const apiPath = '/teams/{teamId}/memberships/{membershipId}'.replace('{teamId}', teamId).replace('{membershipId}', membershipId);
346
682
  const payload: Payload = {};
347
683
  if (typeof roles !== 'undefined') {
@@ -364,18 +700,47 @@ export class Teams {
364
700
  /**
365
701
  * This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.
366
702
  *
367
- * @param {string} teamId
368
- * @param {string} membershipId
703
+ * @param {string} params.teamId - Team ID.
704
+ * @param {string} params.membershipId - Membership ID.
705
+ * @throws {AppwriteException}
706
+ * @returns {Promise<{}>}
707
+ */
708
+ deleteMembership(params: { teamId: string, membershipId: string }): Promise<{}>;
709
+ /**
710
+ * This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.
711
+ *
712
+ * @param {string} teamId - Team ID.
713
+ * @param {string} membershipId - Membership ID.
369
714
  * @throws {AppwriteException}
370
715
  * @returns {Promise<{}>}
716
+ * @deprecated Use the object parameter style method for a better developer experience.
371
717
  */
372
- deleteMembership(teamId: string, membershipId: string): Promise<{}> {
718
+ deleteMembership(teamId: string, membershipId: string): Promise<{}>;
719
+ deleteMembership(
720
+ paramsOrFirst: { teamId: string, membershipId: string } | string,
721
+ ...rest: [(string)?]
722
+ ): Promise<{}> {
723
+ let params: { teamId: string, membershipId: string };
724
+
725
+ if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
726
+ params = (paramsOrFirst || {}) as { teamId: string, membershipId: string };
727
+ } else {
728
+ params = {
729
+ teamId: paramsOrFirst as string,
730
+ membershipId: rest[0] as string
731
+ };
732
+ }
733
+
734
+ const teamId = params.teamId;
735
+ const membershipId = params.membershipId;
736
+
373
737
  if (typeof teamId === 'undefined') {
374
738
  throw new AppwriteException('Missing required parameter: "teamId"');
375
739
  }
376
740
  if (typeof membershipId === 'undefined') {
377
741
  throw new AppwriteException('Missing required parameter: "membershipId"');
378
742
  }
743
+
379
744
  const apiPath = '/teams/{teamId}/memberships/{membershipId}'.replace('{teamId}', teamId).replace('{membershipId}', membershipId);
380
745
  const payload: Payload = {};
381
746
  const uri = new URL(this.client.config.endpoint + apiPath);
@@ -398,14 +763,51 @@ export class Teams {
398
763
  * If the request is successful, a session for the user is automatically created.
399
764
  *
400
765
  *
401
- * @param {string} teamId
402
- * @param {string} membershipId
403
- * @param {string} userId
404
- * @param {string} secret
766
+ * @param {string} params.teamId - Team ID.
767
+ * @param {string} params.membershipId - Membership ID.
768
+ * @param {string} params.userId - User ID.
769
+ * @param {string} params.secret - Secret key.
405
770
  * @throws {AppwriteException}
406
771
  * @returns {Promise<Models.Membership>}
407
772
  */
408
- updateMembershipStatus(teamId: string, membershipId: string, userId: string, secret: string): Promise<Models.Membership> {
773
+ updateMembershipStatus(params: { teamId: string, membershipId: string, userId: string, secret: string }): Promise<Models.Membership>;
774
+ /**
775
+ * Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.
776
+ *
777
+ * If the request is successful, a session for the user is automatically created.
778
+ *
779
+ *
780
+ * @param {string} teamId - Team ID.
781
+ * @param {string} membershipId - Membership ID.
782
+ * @param {string} userId - User ID.
783
+ * @param {string} secret - Secret key.
784
+ * @throws {AppwriteException}
785
+ * @returns {Promise<Models.Membership>}
786
+ * @deprecated Use the object parameter style method for a better developer experience.
787
+ */
788
+ updateMembershipStatus(teamId: string, membershipId: string, userId: string, secret: string): Promise<Models.Membership>;
789
+ updateMembershipStatus(
790
+ paramsOrFirst: { teamId: string, membershipId: string, userId: string, secret: string } | string,
791
+ ...rest: [(string)?, (string)?, (string)?]
792
+ ): Promise<Models.Membership> {
793
+ let params: { teamId: string, membershipId: string, userId: string, secret: string };
794
+
795
+ if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
796
+ params = (paramsOrFirst || {}) as { teamId: string, membershipId: string, userId: string, secret: string };
797
+ } else {
798
+ params = {
799
+ teamId: paramsOrFirst as string,
800
+ membershipId: rest[0] as string,
801
+ userId: rest[1] as string,
802
+ secret: rest[2] as string
803
+ };
804
+ }
805
+
806
+ const teamId = params.teamId;
807
+ const membershipId = params.membershipId;
808
+ const userId = params.userId;
809
+ const secret = params.secret;
810
+
409
811
  if (typeof teamId === 'undefined') {
410
812
  throw new AppwriteException('Missing required parameter: "teamId"');
411
813
  }
@@ -418,6 +820,7 @@ export class Teams {
418
820
  if (typeof secret === 'undefined') {
419
821
  throw new AppwriteException('Missing required parameter: "secret"');
420
822
  }
823
+
421
824
  const apiPath = '/teams/{teamId}/memberships/{membershipId}/status'.replace('{teamId}', teamId).replace('{membershipId}', membershipId);
422
825
  const payload: Payload = {};
423
826
  if (typeof userId !== 'undefined') {
@@ -441,16 +844,41 @@ export class Teams {
441
844
  }
442
845
 
443
846
  /**
444
- * Get the team&#039;s shared preferences by its unique ID. If a preference doesn&#039;t need to be shared by all team members, prefer storing them in [user preferences](https://appwrite.io/docs/references/cloud/client-web/account#getPrefs).
847
+ * Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in [user preferences](https://appwrite.io/docs/references/cloud/client-web/account#getPrefs).
848
+ *
849
+ * @param {string} params.teamId - Team ID.
850
+ * @throws {AppwriteException}
851
+ * @returns {Promise<Preferences>}
852
+ */
853
+ getPrefs<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: { teamId: string }): Promise<Preferences>;
854
+ /**
855
+ * Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in [user preferences](https://appwrite.io/docs/references/cloud/client-web/account#getPrefs).
445
856
  *
446
- * @param {string} teamId
857
+ * @param {string} teamId - Team ID.
447
858
  * @throws {AppwriteException}
448
859
  * @returns {Promise<Preferences>}
860
+ * @deprecated Use the object parameter style method for a better developer experience.
449
861
  */
450
- getPrefs<Preferences extends Models.Preferences = Models.DefaultPreferences>(teamId: string): Promise<Preferences> {
862
+ getPrefs<Preferences extends Models.Preferences = Models.DefaultPreferences>(teamId: string): Promise<Preferences>;
863
+ getPrefs<Preferences extends Models.Preferences = Models.DefaultPreferences>(
864
+ paramsOrFirst: { teamId: string } | string
865
+ ): Promise<Preferences> {
866
+ let params: { teamId: string };
867
+
868
+ if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
869
+ params = (paramsOrFirst || {}) as { teamId: string };
870
+ } else {
871
+ params = {
872
+ teamId: paramsOrFirst as string
873
+ };
874
+ }
875
+
876
+ const teamId = params.teamId;
877
+
451
878
  if (typeof teamId === 'undefined') {
452
879
  throw new AppwriteException('Missing required parameter: "teamId"');
453
880
  }
881
+
454
882
  const apiPath = '/teams/{teamId}/prefs'.replace('{teamId}', teamId);
455
883
  const payload: Payload = {};
456
884
  const uri = new URL(this.client.config.endpoint + apiPath);
@@ -467,20 +895,49 @@ export class Teams {
467
895
  }
468
896
 
469
897
  /**
470
- * Update the team&#039;s preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.
898
+ * Update the team's preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.
471
899
  *
472
- * @param {string} teamId
473
- * @param {object} prefs
900
+ * @param {string} params.teamId - Team ID.
901
+ * @param {object} params.prefs - Prefs key-value JSON object.
474
902
  * @throws {AppwriteException}
475
903
  * @returns {Promise<Preferences>}
476
904
  */
477
- updatePrefs<Preferences extends Models.Preferences = Models.DefaultPreferences>(teamId: string, prefs: object): Promise<Preferences> {
905
+ updatePrefs<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: { teamId: string, prefs: object }): Promise<Preferences>;
906
+ /**
907
+ * Update the team's preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.
908
+ *
909
+ * @param {string} teamId - Team ID.
910
+ * @param {object} prefs - Prefs key-value JSON object.
911
+ * @throws {AppwriteException}
912
+ * @returns {Promise<Preferences>}
913
+ * @deprecated Use the object parameter style method for a better developer experience.
914
+ */
915
+ updatePrefs<Preferences extends Models.Preferences = Models.DefaultPreferences>(teamId: string, prefs: object): Promise<Preferences>;
916
+ updatePrefs<Preferences extends Models.Preferences = Models.DefaultPreferences>(
917
+ paramsOrFirst: { teamId: string, prefs: object } | string,
918
+ ...rest: [(object)?]
919
+ ): Promise<Preferences> {
920
+ let params: { teamId: string, prefs: object };
921
+
922
+ if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
923
+ params = (paramsOrFirst || {}) as { teamId: string, prefs: object };
924
+ } else {
925
+ params = {
926
+ teamId: paramsOrFirst as string,
927
+ prefs: rest[0] as object
928
+ };
929
+ }
930
+
931
+ const teamId = params.teamId;
932
+ const prefs = params.prefs;
933
+
478
934
  if (typeof teamId === 'undefined') {
479
935
  throw new AppwriteException('Missing required parameter: "teamId"');
480
936
  }
481
937
  if (typeof prefs === 'undefined') {
482
938
  throw new AppwriteException('Missing required parameter: "prefs"');
483
939
  }
940
+
484
941
  const apiPath = '/teams/{teamId}/prefs'.replace('{teamId}', teamId);
485
942
  const payload: Payload = {};
486
943
  if (typeof prefs !== 'undefined') {