@appwrite.io/console 0.6.0-rc.12 → 0.6.0-rc.14

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 (328) hide show
  1. package/.travis.yml +32 -0
  2. package/README.md +3 -3
  3. package/dist/cjs/sdk.js +228 -109
  4. package/dist/cjs/sdk.js.map +1 -1
  5. package/dist/esm/sdk.js +229 -110
  6. package/dist/esm/sdk.js.map +1 -1
  7. package/dist/iife/sdk.js +228 -109
  8. package/docs/examples/account/{create2f-a-challenge.md → create-challenge.md} +1 -1
  9. package/docs/examples/account/create-email-token.md +1 -1
  10. package/docs/examples/account/create-magic-u-r-l-token.md +1 -1
  11. package/docs/examples/account/create-o-auth2session.md +0 -1
  12. package/docs/examples/account/create-o-auth2token.md +15 -0
  13. package/docs/examples/account/create-phone-token.md +1 -1
  14. package/docs/examples/account/create-push-target.md +3 -3
  15. package/docs/examples/account/create-session.md +2 -2
  16. package/docs/examples/account/create.md +2 -2
  17. package/docs/examples/account/delete-authenticator.md +1 -1
  18. package/docs/examples/account/delete-identity.md +1 -1
  19. package/docs/examples/account/delete-push-target.md +1 -1
  20. package/docs/examples/account/delete-session.md +1 -1
  21. package/docs/examples/account/get-session.md +1 -1
  22. package/docs/examples/account/update-challenge.md +2 -2
  23. package/docs/examples/account/update-magic-u-r-l-session.md +2 -2
  24. package/docs/examples/account/update-name.md +1 -1
  25. package/docs/examples/account/update-phone-session.md +14 -0
  26. package/docs/examples/account/update-phone-verification.md +2 -2
  27. package/docs/examples/account/update-push-target.md +2 -2
  28. package/docs/examples/account/update-recovery.md +2 -2
  29. package/docs/examples/account/update-session.md +1 -1
  30. package/docs/examples/account/update-verification.md +2 -2
  31. package/docs/examples/account/verify-authenticator.md +1 -1
  32. package/docs/examples/assistant/chat.md +1 -1
  33. package/docs/examples/avatars/get-initials.md +1 -1
  34. package/docs/examples/avatars/get-q-r.md +1 -1
  35. package/docs/examples/databases/create-boolean-attribute.md +2 -2
  36. package/docs/examples/databases/create-collection.md +3 -3
  37. package/docs/examples/databases/create-datetime-attribute.md +2 -2
  38. package/docs/examples/databases/create-document.md +3 -3
  39. package/docs/examples/databases/create-email-attribute.md +2 -2
  40. package/docs/examples/databases/create-enum-attribute.md +3 -3
  41. package/docs/examples/databases/create-float-attribute.md +2 -2
  42. package/docs/examples/databases/create-index.md +2 -2
  43. package/docs/examples/databases/create-integer-attribute.md +2 -2
  44. package/docs/examples/databases/create-ip-attribute.md +2 -2
  45. package/docs/examples/databases/create-relationship-attribute.md +3 -3
  46. package/docs/examples/databases/create-string-attribute.md +3 -3
  47. package/docs/examples/databases/create-url-attribute.md +2 -2
  48. package/docs/examples/databases/create.md +2 -2
  49. package/docs/examples/databases/delete-attribute.md +2 -2
  50. package/docs/examples/databases/delete-collection.md +2 -2
  51. package/docs/examples/databases/delete-document.md +3 -3
  52. package/docs/examples/databases/delete-index.md +2 -2
  53. package/docs/examples/databases/delete.md +1 -1
  54. package/docs/examples/databases/get-attribute.md +2 -2
  55. package/docs/examples/databases/get-collection-usage.md +2 -2
  56. package/docs/examples/databases/get-collection.md +2 -2
  57. package/docs/examples/databases/get-database-usage.md +1 -1
  58. package/docs/examples/databases/get-document.md +3 -3
  59. package/docs/examples/databases/get-index.md +2 -2
  60. package/docs/examples/databases/get.md +1 -1
  61. package/docs/examples/databases/list-attributes.md +2 -2
  62. package/docs/examples/databases/list-collection-logs.md +2 -2
  63. package/docs/examples/databases/list-collections.md +2 -2
  64. package/docs/examples/databases/list-document-logs.md +3 -3
  65. package/docs/examples/databases/list-documents.md +2 -2
  66. package/docs/examples/databases/list-indexes.md +2 -2
  67. package/docs/examples/databases/list-logs.md +1 -1
  68. package/docs/examples/databases/list.md +1 -1
  69. package/docs/examples/databases/update-boolean-attribute.md +2 -2
  70. package/docs/examples/databases/update-collection.md +3 -3
  71. package/docs/examples/databases/update-datetime-attribute.md +2 -2
  72. package/docs/examples/databases/update-document.md +3 -3
  73. package/docs/examples/databases/update-email-attribute.md +2 -2
  74. package/docs/examples/databases/update-enum-attribute.md +3 -3
  75. package/docs/examples/databases/update-float-attribute.md +2 -2
  76. package/docs/examples/databases/update-integer-attribute.md +2 -2
  77. package/docs/examples/databases/update-ip-attribute.md +2 -2
  78. package/docs/examples/databases/update-relationship-attribute.md +2 -2
  79. package/docs/examples/databases/update-string-attribute.md +3 -3
  80. package/docs/examples/databases/update-url-attribute.md +2 -2
  81. package/docs/examples/databases/update.md +2 -2
  82. package/docs/examples/functions/create-build.md +3 -3
  83. package/docs/examples/functions/create-deployment.md +3 -3
  84. package/docs/examples/functions/create-execution.md +3 -3
  85. package/docs/examples/functions/create-variable.md +3 -3
  86. package/docs/examples/functions/create.md +12 -12
  87. package/docs/examples/functions/delete-deployment.md +2 -2
  88. package/docs/examples/functions/delete-variable.md +2 -2
  89. package/docs/examples/functions/delete.md +1 -1
  90. package/docs/examples/functions/download-deployment.md +2 -2
  91. package/docs/examples/functions/get-deployment.md +2 -2
  92. package/docs/examples/functions/get-execution.md +2 -2
  93. package/docs/examples/functions/get-function-usage.md +1 -1
  94. package/docs/examples/functions/get-variable.md +2 -2
  95. package/docs/examples/functions/get.md +1 -1
  96. package/docs/examples/functions/list-deployments.md +2 -2
  97. package/docs/examples/functions/list-executions.md +2 -2
  98. package/docs/examples/functions/list-variables.md +1 -1
  99. package/docs/examples/functions/list.md +1 -1
  100. package/docs/examples/functions/update-deployment.md +2 -2
  101. package/docs/examples/functions/update-variable.md +4 -4
  102. package/docs/examples/functions/update.md +8 -8
  103. package/docs/examples/health/get-queue-databases.md +1 -1
  104. package/docs/examples/messaging/create-apns-provider.md +7 -6
  105. package/docs/examples/messaging/create-email.md +5 -5
  106. package/docs/examples/messaging/create-fcm-provider.md +2 -2
  107. package/docs/examples/messaging/create-mailgun-provider.md +6 -6
  108. package/docs/examples/messaging/create-msg91provider.md +4 -4
  109. package/docs/examples/messaging/create-push.md +11 -11
  110. package/docs/examples/messaging/create-sendgrid-provider.md +5 -5
  111. package/docs/examples/messaging/create-sms.md +4 -4
  112. package/docs/examples/messaging/create-smtp-provider.md +10 -10
  113. package/docs/examples/messaging/create-subscriber.md +3 -3
  114. package/docs/examples/messaging/create-telesign-provider.md +4 -4
  115. package/docs/examples/messaging/create-textmagic-provider.md +4 -4
  116. package/docs/examples/messaging/create-topic.md +2 -2
  117. package/docs/examples/messaging/create-twilio-provider.md +4 -4
  118. package/docs/examples/messaging/create-vonage-provider.md +4 -4
  119. package/docs/examples/messaging/delete-provider.md +1 -1
  120. package/docs/examples/messaging/delete-subscriber.md +2 -2
  121. package/docs/examples/messaging/delete-topic.md +1 -1
  122. package/docs/examples/messaging/delete.md +1 -1
  123. package/docs/examples/messaging/get-message.md +1 -1
  124. package/docs/examples/messaging/get-provider.md +1 -1
  125. package/docs/examples/messaging/get-subscriber.md +2 -2
  126. package/docs/examples/messaging/get-topic.md +1 -1
  127. package/docs/examples/messaging/list-message-logs.md +1 -1
  128. package/docs/examples/messaging/list-messages.md +1 -1
  129. package/docs/examples/messaging/list-provider-logs.md +1 -1
  130. package/docs/examples/messaging/list-providers.md +1 -1
  131. package/docs/examples/messaging/list-subscriber-logs.md +1 -1
  132. package/docs/examples/messaging/list-subscribers.md +2 -2
  133. package/docs/examples/messaging/list-targets.md +1 -1
  134. package/docs/examples/messaging/list-topic-logs.md +1 -1
  135. package/docs/examples/messaging/list-topics.md +1 -1
  136. package/docs/examples/messaging/update-apns-provider.md +20 -0
  137. package/docs/examples/messaging/update-email.md +5 -5
  138. package/docs/examples/messaging/{update-f-c-m-provider.md → update-fcm-provider.md} +3 -3
  139. package/docs/examples/messaging/update-mailgun-provider.md +7 -7
  140. package/docs/examples/messaging/update-msg91provider.md +5 -5
  141. package/docs/examples/messaging/update-push.md +10 -10
  142. package/docs/examples/messaging/update-sendgrid-provider.md +6 -6
  143. package/docs/examples/messaging/update-sms.md +4 -4
  144. package/docs/examples/messaging/update-smtp-provider.md +11 -11
  145. package/docs/examples/messaging/update-telesign-provider.md +5 -5
  146. package/docs/examples/messaging/update-textmagic-provider.md +5 -5
  147. package/docs/examples/messaging/update-topic.md +3 -2
  148. package/docs/examples/messaging/update-twilio-provider.md +5 -5
  149. package/docs/examples/messaging/update-vonage-provider.md +5 -5
  150. package/docs/examples/migrations/create-appwrite-migration.md +2 -2
  151. package/docs/examples/migrations/create-firebase-migration.md +1 -1
  152. package/docs/examples/migrations/create-firebase-o-auth-migration.md +1 -1
  153. package/docs/examples/migrations/create-n-host-migration.md +6 -6
  154. package/docs/examples/migrations/create-supabase-migration.md +4 -4
  155. package/docs/examples/migrations/delete.md +1 -1
  156. package/docs/examples/migrations/get-appwrite-report.md +2 -2
  157. package/docs/examples/migrations/get-firebase-report-o-auth.md +1 -1
  158. package/docs/examples/migrations/get-firebase-report.md +1 -1
  159. package/docs/examples/migrations/get-n-host-report.md +6 -6
  160. package/docs/examples/migrations/get-supabase-report.md +4 -4
  161. package/docs/examples/migrations/get.md +1 -1
  162. package/docs/examples/migrations/list.md +1 -1
  163. package/docs/examples/migrations/retry.md +1 -1
  164. package/docs/examples/project/create-variable.md +2 -2
  165. package/docs/examples/project/delete-variable.md +1 -1
  166. package/docs/examples/project/get-variable.md +1 -1
  167. package/docs/examples/project/update-variable.md +3 -3
  168. package/docs/examples/projects/create-key.md +2 -2
  169. package/docs/examples/projects/create-platform.md +4 -4
  170. package/docs/examples/projects/create-smtp-test.md +4 -4
  171. package/docs/examples/projects/create-webhook.md +4 -4
  172. package/docs/examples/projects/create.md +10 -10
  173. package/docs/examples/projects/delete-email-template.md +1 -1
  174. package/docs/examples/projects/delete-key.md +2 -2
  175. package/docs/examples/projects/delete-platform.md +2 -2
  176. package/docs/examples/projects/delete-sms-template.md +1 -1
  177. package/docs/examples/projects/delete-webhook.md +2 -2
  178. package/docs/examples/projects/delete.md +1 -1
  179. package/docs/examples/projects/get-email-template.md +1 -1
  180. package/docs/examples/projects/get-key.md +2 -2
  181. package/docs/examples/projects/get-platform.md +2 -2
  182. package/docs/examples/projects/get-sms-template.md +1 -1
  183. package/docs/examples/projects/get-webhook.md +2 -2
  184. package/docs/examples/projects/get.md +1 -1
  185. package/docs/examples/projects/list-keys.md +1 -1
  186. package/docs/examples/projects/list-platforms.md +1 -1
  187. package/docs/examples/projects/list-webhooks.md +1 -1
  188. package/docs/examples/projects/list.md +1 -1
  189. package/docs/examples/projects/update-auth-duration.md +1 -1
  190. package/docs/examples/projects/update-auth-limit.md +1 -1
  191. package/docs/examples/projects/update-auth-password-dictionary.md +1 -1
  192. package/docs/examples/projects/update-auth-password-history.md +1 -1
  193. package/docs/examples/projects/update-auth-sessions-limit.md +1 -1
  194. package/docs/examples/projects/update-auth-status.md +1 -1
  195. package/docs/examples/projects/update-email-template.md +4 -4
  196. package/docs/examples/projects/update-key.md +3 -3
  197. package/docs/examples/projects/update-o-auth2.md +3 -3
  198. package/docs/examples/projects/update-personal-data-check.md +1 -1
  199. package/docs/examples/projects/update-platform.md +5 -5
  200. package/docs/examples/projects/update-service-status-all.md +1 -1
  201. package/docs/examples/projects/update-service-status.md +1 -1
  202. package/docs/examples/projects/update-sms-template.md +2 -2
  203. package/docs/examples/projects/update-smtp.md +4 -4
  204. package/docs/examples/projects/update-team.md +2 -2
  205. package/docs/examples/projects/update-webhook-signature.md +2 -2
  206. package/docs/examples/projects/update-webhook.md +5 -5
  207. package/docs/examples/projects/update.md +10 -10
  208. package/docs/examples/proxy/create-rule.md +1 -1
  209. package/docs/examples/proxy/delete-rule.md +1 -1
  210. package/docs/examples/proxy/get-rule.md +1 -1
  211. package/docs/examples/proxy/list-rules.md +1 -1
  212. package/docs/examples/proxy/update-rule-verification.md +1 -1
  213. package/docs/examples/storage/create-bucket.md +2 -2
  214. package/docs/examples/storage/create-file.md +2 -2
  215. package/docs/examples/storage/delete-bucket.md +1 -1
  216. package/docs/examples/storage/delete-file.md +2 -2
  217. package/docs/examples/storage/get-bucket-usage.md +1 -1
  218. package/docs/examples/storage/get-bucket.md +1 -1
  219. package/docs/examples/storage/get-file-download.md +2 -2
  220. package/docs/examples/storage/get-file-preview.md +2 -2
  221. package/docs/examples/storage/get-file-view.md +2 -2
  222. package/docs/examples/storage/get-file.md +2 -2
  223. package/docs/examples/storage/list-buckets.md +1 -1
  224. package/docs/examples/storage/list-files.md +2 -2
  225. package/docs/examples/storage/update-bucket.md +2 -2
  226. package/docs/examples/storage/update-file.md +3 -3
  227. package/docs/examples/teams/create-membership.md +3 -3
  228. package/docs/examples/teams/create.md +2 -2
  229. package/docs/examples/teams/delete-membership.md +2 -2
  230. package/docs/examples/teams/delete.md +1 -1
  231. package/docs/examples/teams/get-membership.md +2 -2
  232. package/docs/examples/teams/get-prefs.md +1 -1
  233. package/docs/examples/teams/get.md +1 -1
  234. package/docs/examples/teams/list-logs.md +1 -1
  235. package/docs/examples/teams/list-memberships.md +2 -2
  236. package/docs/examples/teams/list.md +1 -1
  237. package/docs/examples/teams/update-membership-status.md +4 -4
  238. package/docs/examples/teams/update-membership.md +2 -2
  239. package/docs/examples/teams/update-name.md +2 -2
  240. package/docs/examples/teams/update-prefs.md +1 -1
  241. package/docs/examples/users/create-argon2user.md +2 -2
  242. package/docs/examples/users/create-bcrypt-user.md +2 -2
  243. package/docs/examples/users/create-m-d5user.md +2 -2
  244. package/docs/examples/users/create-p-h-pass-user.md +2 -2
  245. package/docs/examples/users/create-s-h-a-user.md +2 -2
  246. package/docs/examples/users/create-scrypt-modified-user.md +5 -5
  247. package/docs/examples/users/create-scrypt-user.md +3 -3
  248. package/docs/examples/users/create-session.md +1 -1
  249. package/docs/examples/users/create-target.md +5 -5
  250. package/docs/examples/users/create-token.md +1 -1
  251. package/docs/examples/users/create.md +2 -2
  252. package/docs/examples/users/delete-authenticator.md +2 -3
  253. package/docs/examples/users/delete-identity.md +1 -1
  254. package/docs/examples/users/delete-session.md +2 -2
  255. package/docs/examples/users/delete-sessions.md +1 -1
  256. package/docs/examples/users/delete-target.md +2 -2
  257. package/docs/examples/users/delete.md +1 -1
  258. package/docs/examples/users/get-prefs.md +1 -1
  259. package/docs/examples/users/get-target.md +2 -2
  260. package/docs/examples/users/get.md +1 -1
  261. package/docs/examples/users/list-factors.md +1 -1
  262. package/docs/examples/users/list-identities.md +1 -1
  263. package/docs/examples/users/list-logs.md +1 -1
  264. package/docs/examples/users/list-memberships.md +1 -1
  265. package/docs/examples/users/list-sessions.md +1 -1
  266. package/docs/examples/users/list-targets.md +1 -1
  267. package/docs/examples/users/list.md +1 -1
  268. package/docs/examples/users/update-email-verification.md +1 -1
  269. package/docs/examples/users/update-email.md +1 -1
  270. package/docs/examples/users/update-labels.md +1 -1
  271. package/docs/examples/users/update-mfa.md +1 -1
  272. package/docs/examples/users/update-name.md +2 -2
  273. package/docs/examples/users/update-password.md +1 -1
  274. package/docs/examples/users/update-phone-verification.md +1 -1
  275. package/docs/examples/users/update-phone.md +1 -1
  276. package/docs/examples/users/update-prefs.md +1 -1
  277. package/docs/examples/users/update-status.md +1 -1
  278. package/docs/examples/users/update-target.md +5 -5
  279. package/docs/examples/vcs/create-repository-detection.md +3 -3
  280. package/docs/examples/vcs/create-repository.md +2 -2
  281. package/docs/examples/vcs/delete-installation.md +1 -1
  282. package/docs/examples/vcs/get-installation.md +1 -1
  283. package/docs/examples/vcs/get-repository.md +2 -2
  284. package/docs/examples/vcs/list-installations.md +1 -1
  285. package/docs/examples/vcs/list-repositories.md +2 -2
  286. package/docs/examples/vcs/list-repository-branches.md +2 -2
  287. package/docs/examples/vcs/update-external-deployments.md +3 -3
  288. package/package.json +1 -1
  289. package/src/client.ts +1 -1
  290. package/src/enums/email-template-type.ts +1 -0
  291. package/src/enums/index-type.ts +0 -1
  292. package/src/enums/sms-template-type.ts +1 -0
  293. package/src/enums/{encryption.ts → smtp-encryption.ts} +1 -1
  294. package/src/index.ts +1 -2
  295. package/src/service.ts +0 -3
  296. package/src/services/account.ts +115 -13
  297. package/src/services/assistant.ts +0 -1
  298. package/src/services/avatars.ts +0 -1
  299. package/src/services/console.ts +0 -1
  300. package/src/services/databases.ts +20 -4
  301. package/src/services/functions.ts +0 -1
  302. package/src/services/graphql.ts +0 -1
  303. package/src/services/health.ts +2 -1
  304. package/src/services/locale.ts +0 -1
  305. package/src/services/messaging.ts +66 -50
  306. package/src/services/migrations.ts +0 -1
  307. package/src/services/project.ts +1 -2
  308. package/src/services/projects.ts +0 -1
  309. package/src/services/proxy.ts +0 -1
  310. package/src/services/storage.ts +2 -3
  311. package/src/services/teams.ts +0 -1
  312. package/src/services/users.ts +10 -12
  313. package/src/services/vcs.ts +0 -1
  314. package/types/enums/email-template-type.d.ts +2 -1
  315. package/types/enums/index-type.d.ts +1 -2
  316. package/types/enums/sms-template-type.d.ts +2 -1
  317. package/types/enums/{encryption.d.ts → smtp-encryption.d.ts} +1 -1
  318. package/types/index.d.ts +1 -2
  319. package/types/services/account.d.ts +57 -8
  320. package/types/services/databases.d.ts +20 -3
  321. package/types/services/health.d.ts +2 -0
  322. package/types/services/messaging.d.ts +42 -37
  323. package/types/services/project.d.ts +1 -1
  324. package/types/services/storage.d.ts +2 -2
  325. package/types/services/users.d.ts +10 -3
  326. package/docs/examples/messaging/update-a-p-n-s-provider.md +0 -19
  327. package/src/enums/message-status.ts +0 -5
  328. package/types/enums/message-status.d.ts +0 -5
@@ -108,6 +108,7 @@ export declare class Account extends Service {
108
108
  /**
109
109
  * Update MFA
110
110
  *
111
+ * Enable or disable MFA on an account.
111
112
  *
112
113
  * @param {boolean} mfa
113
114
  * @throws {AppwriteException}
@@ -122,10 +123,11 @@ export declare class Account extends Service {
122
123
  * @throws {AppwriteException}
123
124
  * @returns {Promise}
124
125
  */
125
- create2FAChallenge(factor: AuthenticationFactor): Promise<Models.MfaChallenge>;
126
+ createChallenge(factor: AuthenticationFactor): Promise<Models.MfaChallenge>;
126
127
  /**
127
128
  * Create MFA Challenge (confirmation)
128
129
  *
130
+ * Complete the MFA challenge by providing the one-time password.
129
131
  *
130
132
  * @param {string} challengeId
131
133
  * @param {string} otp
@@ -136,6 +138,7 @@ export declare class Account extends Service {
136
138
  /**
137
139
  * List Factors
138
140
  *
141
+ * List the factors available on the account to be used as a MFA challange.
139
142
  *
140
143
  * @throws {AppwriteException}
141
144
  * @returns {Promise}
@@ -144,6 +147,10 @@ export declare class Account extends Service {
144
147
  /**
145
148
  * Add Authenticator
146
149
  *
150
+ * Add an authenticator app to be used as an MFA factor. Verify the
151
+ * authenticator using the [verify
152
+ * authenticator](/docs/references/cloud/client-web/account#verifyAuthenticator)
153
+ * method.
147
154
  *
148
155
  * @param {AuthenticatorType} type
149
156
  * @throws {AppwriteException}
@@ -153,6 +160,9 @@ export declare class Account extends Service {
153
160
  /**
154
161
  * Verify Authenticator
155
162
  *
163
+ * Verify an authenticator app after adding it using the [add
164
+ * authenticator](/docs/references/cloud/client-web/account#addAuthenticator)
165
+ * method.
156
166
  *
157
167
  * @param {AuthenticatorType} type
158
168
  * @param {string} otp
@@ -163,6 +173,7 @@ export declare class Account extends Service {
163
173
  /**
164
174
  * Delete Authenticator
165
175
  *
176
+ * Delete an authenticator for a user by ID.
166
177
  *
167
178
  * @param {AuthenticatorType} type
168
179
  * @param {string} otp
@@ -320,7 +331,7 @@ export declare class Account extends Service {
320
331
  */
321
332
  createEmailPasswordSession(email: string, password: string): Promise<Models.Session>;
322
333
  /**
323
- * Create session (deprecated)
334
+ * Update magic URL session
324
335
  *
325
336
  * Use this endpoint to create a session from token. Provide the **userId**
326
337
  * and **secret** parameters from the successful response of authentication
@@ -355,12 +366,24 @@ export declare class Account extends Service {
355
366
  * @param {OAuthProvider} provider
356
367
  * @param {string} success
357
368
  * @param {string} failure
358
- * @param {boolean} token
359
369
  * @param {string[]} scopes
360
370
  * @throws {AppwriteException}
361
371
  * @returns {void|string}
362
372
  */
363
- createOAuth2Session(provider: OAuthProvider, success?: string, failure?: string, token?: boolean, scopes?: string[]): void | URL;
373
+ createOAuth2Session(provider: OAuthProvider, success?: string, failure?: string, scopes?: string[]): void | URL;
374
+ /**
375
+ * Update phone session
376
+ *
377
+ * Use this endpoint to create a session from token. Provide the **userId**
378
+ * and **secret** parameters from the successful response of authentication
379
+ * flows initiated by token creation. For example, magic URL and phone login.
380
+ *
381
+ * @param {string} userId
382
+ * @param {string} secret
383
+ * @throws {AppwriteException}
384
+ * @returns {Promise}
385
+ */
386
+ updatePhoneSession(userId: string, secret: string): Promise<Models.Session>;
364
387
  /**
365
388
  * Create session
366
389
  *
@@ -386,7 +409,7 @@ export declare class Account extends Service {
386
409
  */
387
410
  getSession(sessionId: string): Promise<Models.Session>;
388
411
  /**
389
- * Update (or renew) a session
412
+ * Update (or renew) session
390
413
  *
391
414
  * Extend session's expiry to increase it's lifespan. Extending a session is
392
415
  * useful when session length is short such as 5 minutes.
@@ -422,7 +445,7 @@ export declare class Account extends Service {
422
445
  */
423
446
  updateStatus<Preferences extends Models.Preferences>(): Promise<Models.User<Preferences>>;
424
447
  /**
425
- * Create a push target
448
+ * Create push target
426
449
  *
427
450
  *
428
451
  * @param {string} targetId
@@ -433,7 +456,7 @@ export declare class Account extends Service {
433
456
  */
434
457
  createPushTarget(targetId: string, identifier: string, providerId?: string): Promise<Models.Target>;
435
458
  /**
436
- * Update a push target
459
+ * Update push target
437
460
  *
438
461
  *
439
462
  * @param {string} targetId
@@ -443,7 +466,7 @@ export declare class Account extends Service {
443
466
  */
444
467
  updatePushTarget(targetId: string, identifier: string): Promise<Models.Target>;
445
468
  /**
446
- * Delete a push target
469
+ * Delete push target
447
470
  *
448
471
  *
449
472
  * @param {string} targetId
@@ -500,6 +523,32 @@ export declare class Account extends Service {
500
523
  * @returns {Promise}
501
524
  */
502
525
  createMagicURLToken(userId: string, email: string, url?: string, phrase?: boolean): Promise<Models.Token>;
526
+ /**
527
+ * Create OAuth2 token
528
+ *
529
+ * Allow the user to login to their account using the OAuth2 provider of their
530
+ * choice. Each OAuth2 provider should be enabled from the Appwrite console
531
+ * first. Use the success and failure arguments to provide a redirect URL's
532
+ * back to your app when login is completed.
533
+ *
534
+ * If authentication succeeds, `userId` and `secret` of a token will be
535
+ * appended to the success URL as query parameters. These can be used to
536
+ * create a new session using the [Create
537
+ * session](https://appwrite.io/docs/references/cloud/client-web/account#createSession)
538
+ * endpoint.
539
+ *
540
+ * A user is limited to 10 active sessions at a time by default. [Learn more
541
+ * about session
542
+ * limits](https://appwrite.io/docs/authentication-security#limits).
543
+ *
544
+ * @param {OAuthProvider} provider
545
+ * @param {string} success
546
+ * @param {string} failure
547
+ * @param {string[]} scopes
548
+ * @throws {AppwriteException}
549
+ * @returns {void|string}
550
+ */
551
+ createOAuth2Token(provider: OAuthProvider, success?: string, failure?: string, scopes?: string[]): void | URL;
503
552
  /**
504
553
  * Create phone token
505
554
  *
@@ -33,7 +33,7 @@ export declare class Databases extends Service {
33
33
  */
34
34
  create(databaseId: string, name: string, enabled?: boolean): Promise<Models.Database>;
35
35
  /**
36
- * Get usage stats for the database
36
+ * Get databases usage stats
37
37
  *
38
38
  *
39
39
  * @param {DatabaseUsageRange} range
@@ -148,6 +148,7 @@ export declare class Databases extends Service {
148
148
  /**
149
149
  * List attributes
150
150
  *
151
+ * List attributes in the collection.
151
152
  *
152
153
  * @param {string} databaseId
153
154
  * @param {string} collectionId
@@ -175,6 +176,8 @@ export declare class Databases extends Service {
175
176
  /**
176
177
  * Update boolean attribute
177
178
  *
179
+ * Update a boolean attribute. Changing the `default` value will not update
180
+ * already existing documents.
178
181
  *
179
182
  * @param {string} databaseId
180
183
  * @param {string} collectionId
@@ -188,6 +191,7 @@ export declare class Databases extends Service {
188
191
  /**
189
192
  * Create datetime attribute
190
193
  *
194
+ * Create a date time attribute according to the ISO 8601 standard.
191
195
  *
192
196
  * @param {string} databaseId
193
197
  * @param {string} collectionId
@@ -202,6 +206,8 @@ export declare class Databases extends Service {
202
206
  /**
203
207
  * Update dateTime attribute
204
208
  *
209
+ * Update a date time attribute. Changing the `default` value will not update
210
+ * already existing documents.
205
211
  *
206
212
  * @param {string} databaseId
207
213
  * @param {string} collectionId
@@ -247,6 +253,9 @@ export declare class Databases extends Service {
247
253
  /**
248
254
  * Create enum attribute
249
255
  *
256
+ * Create an enumeration attribute. The `elements` param acts as a white-list
257
+ * of accepted values for this attribute.
258
+ *
250
259
  *
251
260
  * @param {string} databaseId
252
261
  * @param {string} collectionId
@@ -470,6 +479,7 @@ export declare class Databases extends Service {
470
479
  /**
471
480
  * Get attribute
472
481
  *
482
+ * Get attribute by ID.
473
483
  *
474
484
  * @param {string} databaseId
475
485
  * @param {string} collectionId
@@ -481,6 +491,7 @@ export declare class Databases extends Service {
481
491
  /**
482
492
  * Delete attribute
483
493
  *
494
+ * Deletes an attribute.
484
495
  *
485
496
  * @param {string} databaseId
486
497
  * @param {string} collectionId
@@ -591,6 +602,7 @@ export declare class Databases extends Service {
591
602
  /**
592
603
  * List indexes
593
604
  *
605
+ * List indexes in the collection.
594
606
  *
595
607
  * @param {string} databaseId
596
608
  * @param {string} collectionId
@@ -602,6 +614,9 @@ export declare class Databases extends Service {
602
614
  /**
603
615
  * Create index
604
616
  *
617
+ * Creates an index on the attributes listed. Your index should include all
618
+ * the attributes you will query in a single request.
619
+ * Attributes can be `key`, `fulltext`, and `unique`.
605
620
  *
606
621
  * @param {string} databaseId
607
622
  * @param {string} collectionId
@@ -616,6 +631,7 @@ export declare class Databases extends Service {
616
631
  /**
617
632
  * Get index
618
633
  *
634
+ * Get index by ID.
619
635
  *
620
636
  * @param {string} databaseId
621
637
  * @param {string} collectionId
@@ -627,6 +643,7 @@ export declare class Databases extends Service {
627
643
  /**
628
644
  * Delete index
629
645
  *
646
+ * Delete an index.
630
647
  *
631
648
  * @param {string} databaseId
632
649
  * @param {string} collectionId
@@ -648,7 +665,7 @@ export declare class Databases extends Service {
648
665
  */
649
666
  listCollectionLogs(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.LogList>;
650
667
  /**
651
- * Get usage stats for a collection
668
+ * Get collection usage stats
652
669
  *
653
670
  *
654
671
  * @param {string} databaseId
@@ -670,7 +687,7 @@ export declare class Databases extends Service {
670
687
  */
671
688
  listLogs(databaseId: string, queries?: string[]): Promise<Models.LogList>;
672
689
  /**
673
- * Get usage stats for the database
690
+ * Get database usage stats
674
691
  *
675
692
  *
676
693
  * @param {string} databaseId
@@ -131,6 +131,8 @@ export declare class Health extends Service {
131
131
  /**
132
132
  * Get functions queue
133
133
  *
134
+ * Get the number of function executions that are waiting to be processed in
135
+ * the Appwrite internal queue server.
134
136
  *
135
137
  * @param {number} threshold
136
138
  * @throws {AppwriteException}
@@ -1,8 +1,7 @@
1
1
  import { Service } from '../service';
2
2
  import { Client } from '../client';
3
3
  import type { Models } from '../models';
4
- import { MessageStatus } from '../enums/message-status';
5
- import { Encryption } from '../enums/encryption';
4
+ import { SmtpEncryption } from '../enums/smtp-encryption';
6
5
  export declare class Messaging extends Service {
7
6
  constructor(client: Client);
8
7
  /**
@@ -17,7 +16,7 @@ export declare class Messaging extends Service {
17
16
  */
18
17
  listMessages(queries?: string[], search?: string): Promise<Models.MessageList>;
19
18
  /**
20
- * Create an email
19
+ * Create email
21
20
  *
22
21
  * Create a new email message.
23
22
  *
@@ -30,15 +29,15 @@ export declare class Messaging extends Service {
30
29
  * @param {string[]} cc
31
30
  * @param {string[]} bcc
32
31
  * @param {string[]} attachments
33
- * @param {MessageStatus} status
32
+ * @param {boolean} draft
34
33
  * @param {boolean} html
35
34
  * @param {string} scheduledAt
36
35
  * @throws {AppwriteException}
37
36
  * @returns {Promise}
38
37
  */
39
- createEmail(messageId: string, subject: string, content: string, topics?: string[], users?: string[], targets?: string[], cc?: string[], bcc?: string[], attachments?: string[], status?: MessageStatus, html?: boolean, scheduledAt?: string): Promise<Models.Message>;
38
+ createEmail(messageId: string, subject: string, content: string, topics?: string[], users?: string[], targets?: string[], cc?: string[], bcc?: string[], attachments?: string[], draft?: boolean, html?: boolean, scheduledAt?: string): Promise<Models.Message>;
40
39
  /**
41
- * Update an email
40
+ * Update email
42
41
  *
43
42
  * Update an email message by its unique ID.
44
43
  *
@@ -49,7 +48,7 @@ export declare class Messaging extends Service {
49
48
  * @param {string[]} targets
50
49
  * @param {string} subject
51
50
  * @param {string} content
52
- * @param {MessageStatus} status
51
+ * @param {boolean} draft
53
52
  * @param {boolean} html
54
53
  * @param {string[]} cc
55
54
  * @param {string[]} bcc
@@ -57,9 +56,9 @@ export declare class Messaging extends Service {
57
56
  * @throws {AppwriteException}
58
57
  * @returns {Promise}
59
58
  */
60
- updateEmail(messageId: string, topics?: string[], users?: string[], targets?: string[], subject?: string, content?: string, status?: MessageStatus, html?: boolean, cc?: string[], bcc?: string[], scheduledAt?: string): Promise<Models.Message>;
59
+ updateEmail(messageId: string, topics?: string[], users?: string[], targets?: string[], subject?: string, content?: string, draft?: boolean, html?: boolean, cc?: string[], bcc?: string[], scheduledAt?: string): Promise<Models.Message>;
61
60
  /**
62
- * Create a push notification
61
+ * Create push notification
63
62
  *
64
63
  * Create a new push notification.
65
64
  *
@@ -77,14 +76,14 @@ export declare class Messaging extends Service {
77
76
  * @param {string} color
78
77
  * @param {string} tag
79
78
  * @param {string} badge
80
- * @param {MessageStatus} status
79
+ * @param {boolean} draft
81
80
  * @param {string} scheduledAt
82
81
  * @throws {AppwriteException}
83
82
  * @returns {Promise}
84
83
  */
85
- createPush(messageId: string, title: string, body: string, topics?: string[], users?: string[], targets?: string[], data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: string, status?: MessageStatus, scheduledAt?: string): Promise<Models.Message>;
84
+ createPush(messageId: string, title: string, body: string, topics?: string[], users?: string[], targets?: string[], data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: string, draft?: boolean, scheduledAt?: string): Promise<Models.Message>;
86
85
  /**
87
- * Update a push notification
86
+ * Update push notification
88
87
  *
89
88
  * Update a push notification by its unique ID.
90
89
  *
@@ -103,14 +102,14 @@ export declare class Messaging extends Service {
103
102
  * @param {string} color
104
103
  * @param {string} tag
105
104
  * @param {number} badge
106
- * @param {MessageStatus} status
105
+ * @param {boolean} draft
107
106
  * @param {string} scheduledAt
108
107
  * @throws {AppwriteException}
109
108
  * @returns {Promise}
110
109
  */
111
- updatePush(messageId: string, topics?: string[], users?: string[], targets?: string[], title?: string, body?: string, data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number, status?: MessageStatus, scheduledAt?: string): Promise<Models.Message>;
110
+ updatePush(messageId: string, topics?: string[], users?: string[], targets?: string[], title?: string, body?: string, data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number, draft?: boolean, scheduledAt?: string): Promise<Models.Message>;
112
111
  /**
113
- * Create an SMS
112
+ * Create SMS
114
113
  *
115
114
  * Create a new SMS message.
116
115
  *
@@ -119,14 +118,14 @@ export declare class Messaging extends Service {
119
118
  * @param {string[]} topics
120
119
  * @param {string[]} users
121
120
  * @param {string[]} targets
122
- * @param {MessageStatus} status
121
+ * @param {boolean} draft
123
122
  * @param {string} scheduledAt
124
123
  * @throws {AppwriteException}
125
124
  * @returns {Promise}
126
125
  */
127
- createSms(messageId: string, content: string, topics?: string[], users?: string[], targets?: string[], status?: MessageStatus, scheduledAt?: string): Promise<Models.Message>;
126
+ createSms(messageId: string, content: string, topics?: string[], users?: string[], targets?: string[], draft?: boolean, scheduledAt?: string): Promise<Models.Message>;
128
127
  /**
129
- * Update an SMS
128
+ * Update SMS
130
129
  *
131
130
  * Update an email message by its unique ID.
132
131
  *
@@ -136,14 +135,14 @@ export declare class Messaging extends Service {
136
135
  * @param {string[]} users
137
136
  * @param {string[]} targets
138
137
  * @param {string} content
139
- * @param {MessageStatus} status
138
+ * @param {boolean} draft
140
139
  * @param {string} scheduledAt
141
140
  * @throws {AppwriteException}
142
141
  * @returns {Promise}
143
142
  */
144
- updateSms(messageId: string, topics?: string[], users?: string[], targets?: string[], content?: string, status?: MessageStatus, scheduledAt?: string): Promise<Models.Message>;
143
+ updateSms(messageId: string, topics?: string[], users?: string[], targets?: string[], content?: string, draft?: boolean, scheduledAt?: string): Promise<Models.Message>;
145
144
  /**
146
- * Get a message
145
+ * Get message
147
146
  *
148
147
  * Get a message by its unique ID.
149
148
  *
@@ -154,8 +153,10 @@ export declare class Messaging extends Service {
154
153
  */
155
154
  getMessage(messageId: string): Promise<Models.Message>;
156
155
  /**
157
- * Delete a message
156
+ * Delete message
158
157
  *
158
+ * Delete a message. If the message is not a draft or scheduled, but has been
159
+ * sent, this will not recall the message.
159
160
  *
160
161
  * @param {string} messageId
161
162
  * @throws {AppwriteException}
@@ -206,11 +207,12 @@ export declare class Messaging extends Service {
206
207
  * @param {string} authKeyId
207
208
  * @param {string} teamId
208
209
  * @param {string} bundleId
210
+ * @param {boolean} sandbox
209
211
  * @param {boolean} enabled
210
212
  * @throws {AppwriteException}
211
213
  * @returns {Promise}
212
214
  */
213
- createApnsProvider(providerId: string, name: string, authKey?: string, authKeyId?: string, teamId?: string, bundleId?: string, enabled?: boolean): Promise<Models.Provider>;
215
+ createApnsProvider(providerId: string, name: string, authKey?: string, authKeyId?: string, teamId?: string, bundleId?: string, sandbox?: boolean, enabled?: boolean): Promise<Models.Provider>;
214
216
  /**
215
217
  * Update APNS provider
216
218
  *
@@ -223,10 +225,11 @@ export declare class Messaging extends Service {
223
225
  * @param {string} authKeyId
224
226
  * @param {string} teamId
225
227
  * @param {string} bundleId
228
+ * @param {boolean} sandbox
226
229
  * @throws {AppwriteException}
227
230
  * @returns {Promise}
228
231
  */
229
- updateAPNSProvider(providerId: string, name?: string, enabled?: boolean, authKey?: string, authKeyId?: string, teamId?: string, bundleId?: string): Promise<Models.Provider>;
232
+ updateApnsProvider(providerId: string, name?: string, enabled?: boolean, authKey?: string, authKeyId?: string, teamId?: string, bundleId?: string, sandbox?: boolean): Promise<Models.Provider>;
230
233
  /**
231
234
  * Create FCM provider
232
235
  *
@@ -252,7 +255,7 @@ export declare class Messaging extends Service {
252
255
  * @throws {AppwriteException}
253
256
  * @returns {Promise}
254
257
  */
255
- updateFCMProvider(providerId: string, name?: string, enabled?: boolean, serviceAccountJSON?: object): Promise<Models.Provider>;
258
+ updateFcmProvider(providerId: string, name?: string, enabled?: boolean, serviceAccountJSON?: object): Promise<Models.Provider>;
256
259
  /**
257
260
  * Create Mailgun provider
258
261
  *
@@ -324,6 +327,7 @@ export declare class Messaging extends Service {
324
327
  /**
325
328
  * Create Sendgrid provider
326
329
  *
330
+ * Create a new Sendgrid provider.
327
331
  *
328
332
  * @param {string} providerId
329
333
  * @param {string} name
@@ -365,7 +369,7 @@ export declare class Messaging extends Service {
365
369
  * @param {number} port
366
370
  * @param {string} username
367
371
  * @param {string} password
368
- * @param {Encryption} encryption
372
+ * @param {SmtpEncryption} encryption
369
373
  * @param {boolean} autoTLS
370
374
  * @param {string} mailer
371
375
  * @param {string} fromName
@@ -376,7 +380,7 @@ export declare class Messaging extends Service {
376
380
  * @throws {AppwriteException}
377
381
  * @returns {Promise}
378
382
  */
379
- createSmtpProvider(providerId: string, name: string, host: string, port?: number, username?: string, password?: string, encryption?: Encryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider>;
383
+ createSmtpProvider(providerId: string, name: string, host: string, port?: number, username?: string, password?: string, encryption?: SmtpEncryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider>;
380
384
  /**
381
385
  * Update SMTP provider
382
386
  *
@@ -388,7 +392,7 @@ export declare class Messaging extends Service {
388
392
  * @param {number} port
389
393
  * @param {string} username
390
394
  * @param {string} password
391
- * @param {Encryption} encryption
395
+ * @param {SmtpEncryption} encryption
392
396
  * @param {boolean} autoTLS
393
397
  * @param {string} mailer
394
398
  * @param {string} fromName
@@ -399,7 +403,7 @@ export declare class Messaging extends Service {
399
403
  * @throws {AppwriteException}
400
404
  * @returns {Promise}
401
405
  */
402
- updateSmtpProvider(providerId: string, name?: string, host?: string, port?: number, username?: string, password?: string, encryption?: Encryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider>;
406
+ updateSmtpProvider(providerId: string, name?: string, host?: string, port?: number, username?: string, password?: string, encryption?: SmtpEncryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider>;
403
407
  /**
404
408
  * Create Telesign provider
405
409
  *
@@ -575,7 +579,7 @@ export declare class Messaging extends Service {
575
579
  */
576
580
  listTopics(queries?: string[], search?: string): Promise<Models.TopicList>;
577
581
  /**
578
- * Create a topic
582
+ * Create topic
579
583
  *
580
584
  * Create a new topic.
581
585
  *
@@ -587,7 +591,7 @@ export declare class Messaging extends Service {
587
591
  */
588
592
  createTopic(topicId: string, name: string, subscribe?: string[]): Promise<Models.Topic>;
589
593
  /**
590
- * Get a topic
594
+ * Get topic
591
595
  *
592
596
  * Get a topic by its unique ID.
593
597
  *
@@ -598,19 +602,20 @@ export declare class Messaging extends Service {
598
602
  */
599
603
  getTopic(topicId: string): Promise<Models.Topic>;
600
604
  /**
601
- * Update a topic
605
+ * Update topic
602
606
  *
603
607
  * Update a topic by its unique ID.
604
608
  *
605
609
  *
606
610
  * @param {string} topicId
607
611
  * @param {string} name
612
+ * @param {string[]} subscribe
608
613
  * @throws {AppwriteException}
609
614
  * @returns {Promise}
610
615
  */
611
- updateTopic(topicId: string, name?: string): Promise<Models.Topic>;
616
+ updateTopic(topicId: string, name?: string, subscribe?: string[]): Promise<Models.Topic>;
612
617
  /**
613
- * Delete a topic
618
+ * Delete topic
614
619
  *
615
620
  * Delete a topic by its unique ID.
616
621
  *
@@ -643,7 +648,7 @@ export declare class Messaging extends Service {
643
648
  */
644
649
  listSubscribers(topicId: string, queries?: string[], search?: string): Promise<Models.SubscriberList>;
645
650
  /**
646
- * Create a subscriber
651
+ * Create subscriber
647
652
  *
648
653
  * Create a new subscriber.
649
654
  *
@@ -655,7 +660,7 @@ export declare class Messaging extends Service {
655
660
  */
656
661
  createSubscriber(topicId: string, subscriberId: string, targetId: string): Promise<Models.Subscriber>;
657
662
  /**
658
- * Get a subscriber
663
+ * Get subscriber
659
664
  *
660
665
  * Get a subscriber by its unique ID.
661
666
  *
@@ -667,7 +672,7 @@ export declare class Messaging extends Service {
667
672
  */
668
673
  getSubscriber(topicId: string, subscriberId: string): Promise<Models.Subscriber>;
669
674
  /**
670
- * Delete a subscriber
675
+ * Delete subscriber
671
676
  *
672
677
  * Delete a subscriber by its unique ID.
673
678
  *
@@ -5,7 +5,7 @@ import { ProjectUsageRange } from '../enums/project-usage-range';
5
5
  export declare class Project extends Service {
6
6
  constructor(client: Client);
7
7
  /**
8
- * Get usage stats for a project
8
+ * Get project usage stats
9
9
  *
10
10
  *
11
11
  * @param {string} startDate
@@ -213,7 +213,7 @@ export declare class Storage extends Service {
213
213
  */
214
214
  getFileView(bucketId: string, fileId: string): URL;
215
215
  /**
216
- * Get usage stats for storage
216
+ * Get storage usage stats
217
217
  *
218
218
  *
219
219
  * @param {StorageUsageRange} range
@@ -222,7 +222,7 @@ export declare class Storage extends Service {
222
222
  */
223
223
  getUsage(range?: StorageUsageRange): Promise<Models.UsageStorage>;
224
224
  /**
225
- * Get usage stats for storage bucket
225
+ * Get bucket usage stats
226
226
  *
227
227
  *
228
228
  * @param {string} bucketId
@@ -177,7 +177,7 @@ export declare class Users extends Service {
177
177
  */
178
178
  createSHAUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, passwordVersion?: PasswordHash, name?: string): Promise<Models.User<Preferences>>;
179
179
  /**
180
- * Get usage stats for the users API
180
+ * Get users usage stats
181
181
  *
182
182
  *
183
183
  * @param {UserUsageRange} range
@@ -261,6 +261,7 @@ export declare class Users extends Service {
261
261
  /**
262
262
  * Update MFA
263
263
  *
264
+ * Enable or disable MFA on a user account.
264
265
  *
265
266
  * @param {string} userId
266
267
  * @param {boolean} mfa
@@ -271,6 +272,7 @@ export declare class Users extends Service {
271
272
  /**
272
273
  * List Factors
273
274
  *
275
+ * List the factors available on the account to be used as a MFA challange.
274
276
  *
275
277
  * @param {string} userId
276
278
  * @throws {AppwriteException}
@@ -280,14 +282,14 @@ export declare class Users extends Service {
280
282
  /**
281
283
  * Delete Authenticator
282
284
  *
285
+ * Delete an authenticator app.
283
286
  *
284
287
  * @param {string} userId
285
288
  * @param {AuthenticatorType} type
286
- * @param {string} otp
287
289
  * @throws {AppwriteException}
288
290
  * @returns {Promise}
289
291
  */
290
- deleteAuthenticator<Preferences extends Models.Preferences>(userId: string, type: AuthenticatorType, otp: string): Promise<Models.User<Preferences>>;
292
+ deleteAuthenticator<Preferences extends Models.Preferences>(userId: string, type: AuthenticatorType): Promise<Models.User<Preferences>>;
291
293
  /**
292
294
  * Update name
293
295
  *
@@ -405,6 +407,7 @@ export declare class Users extends Service {
405
407
  /**
406
408
  * List User Targets
407
409
  *
410
+ * List the messaging targets that are associated with a user.
408
411
  *
409
412
  * @param {string} userId
410
413
  * @param {string[]} queries
@@ -415,6 +418,7 @@ export declare class Users extends Service {
415
418
  /**
416
419
  * Create User Target
417
420
  *
421
+ * Create a messaging target.
418
422
  *
419
423
  * @param {string} userId
420
424
  * @param {string} targetId
@@ -429,6 +433,7 @@ export declare class Users extends Service {
429
433
  /**
430
434
  * Get User Target
431
435
  *
436
+ * Get a user's push notification target by ID.
432
437
  *
433
438
  * @param {string} userId
434
439
  * @param {string} targetId
@@ -439,6 +444,7 @@ export declare class Users extends Service {
439
444
  /**
440
445
  * Update User target
441
446
  *
447
+ * Update a messaging target.
442
448
  *
443
449
  * @param {string} userId
444
450
  * @param {string} targetId
@@ -452,6 +458,7 @@ export declare class Users extends Service {
452
458
  /**
453
459
  * Delete user target
454
460
  *
461
+ * Delete a messaging target.
455
462
  *
456
463
  * @param {string} userId
457
464
  * @param {string} targetId