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

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 (318) hide show
  1. package/.travis.yml +32 -0
  2. package/README.md +3 -3
  3. package/dist/cjs/sdk.js +101 -42
  4. package/dist/cjs/sdk.js.map +1 -1
  5. package/dist/esm/sdk.js +102 -43
  6. package/dist/esm/sdk.js.map +1 -1
  7. package/dist/iife/sdk.js +101 -42
  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-verification.md +2 -2
  26. package/docs/examples/account/update-push-target.md +2 -2
  27. package/docs/examples/account/update-recovery.md +2 -2
  28. package/docs/examples/account/update-session.md +1 -1
  29. package/docs/examples/account/update-verification.md +2 -2
  30. package/docs/examples/account/verify-authenticator.md +1 -1
  31. package/docs/examples/assistant/chat.md +1 -1
  32. package/docs/examples/avatars/get-initials.md +1 -1
  33. package/docs/examples/avatars/get-q-r.md +1 -1
  34. package/docs/examples/databases/create-boolean-attribute.md +2 -2
  35. package/docs/examples/databases/create-collection.md +3 -3
  36. package/docs/examples/databases/create-datetime-attribute.md +2 -2
  37. package/docs/examples/databases/create-document.md +3 -3
  38. package/docs/examples/databases/create-email-attribute.md +2 -2
  39. package/docs/examples/databases/create-enum-attribute.md +3 -3
  40. package/docs/examples/databases/create-float-attribute.md +2 -2
  41. package/docs/examples/databases/create-index.md +2 -2
  42. package/docs/examples/databases/create-integer-attribute.md +2 -2
  43. package/docs/examples/databases/create-ip-attribute.md +2 -2
  44. package/docs/examples/databases/create-relationship-attribute.md +3 -3
  45. package/docs/examples/databases/create-string-attribute.md +3 -3
  46. package/docs/examples/databases/create-url-attribute.md +2 -2
  47. package/docs/examples/databases/create.md +2 -2
  48. package/docs/examples/databases/delete-attribute.md +2 -2
  49. package/docs/examples/databases/delete-collection.md +2 -2
  50. package/docs/examples/databases/delete-document.md +3 -3
  51. package/docs/examples/databases/delete-index.md +2 -2
  52. package/docs/examples/databases/delete.md +1 -1
  53. package/docs/examples/databases/get-attribute.md +2 -2
  54. package/docs/examples/databases/get-collection-usage.md +2 -2
  55. package/docs/examples/databases/get-collection.md +2 -2
  56. package/docs/examples/databases/get-database-usage.md +1 -1
  57. package/docs/examples/databases/get-document.md +3 -3
  58. package/docs/examples/databases/get-index.md +2 -2
  59. package/docs/examples/databases/get.md +1 -1
  60. package/docs/examples/databases/list-attributes.md +2 -2
  61. package/docs/examples/databases/list-collection-logs.md +2 -2
  62. package/docs/examples/databases/list-collections.md +2 -2
  63. package/docs/examples/databases/list-document-logs.md +3 -3
  64. package/docs/examples/databases/list-documents.md +2 -2
  65. package/docs/examples/databases/list-indexes.md +2 -2
  66. package/docs/examples/databases/list-logs.md +1 -1
  67. package/docs/examples/databases/list.md +1 -1
  68. package/docs/examples/databases/update-boolean-attribute.md +2 -2
  69. package/docs/examples/databases/update-collection.md +3 -3
  70. package/docs/examples/databases/update-datetime-attribute.md +2 -2
  71. package/docs/examples/databases/update-document.md +3 -3
  72. package/docs/examples/databases/update-email-attribute.md +2 -2
  73. package/docs/examples/databases/update-enum-attribute.md +3 -3
  74. package/docs/examples/databases/update-float-attribute.md +2 -2
  75. package/docs/examples/databases/update-integer-attribute.md +2 -2
  76. package/docs/examples/databases/update-ip-attribute.md +2 -2
  77. package/docs/examples/databases/update-relationship-attribute.md +2 -2
  78. package/docs/examples/databases/update-string-attribute.md +3 -3
  79. package/docs/examples/databases/update-url-attribute.md +2 -2
  80. package/docs/examples/databases/update.md +2 -2
  81. package/docs/examples/functions/create-build.md +3 -3
  82. package/docs/examples/functions/create-deployment.md +3 -3
  83. package/docs/examples/functions/create-execution.md +3 -3
  84. package/docs/examples/functions/create-variable.md +3 -3
  85. package/docs/examples/functions/create.md +12 -12
  86. package/docs/examples/functions/delete-deployment.md +2 -2
  87. package/docs/examples/functions/delete-variable.md +2 -2
  88. package/docs/examples/functions/delete.md +1 -1
  89. package/docs/examples/functions/download-deployment.md +2 -2
  90. package/docs/examples/functions/get-deployment.md +2 -2
  91. package/docs/examples/functions/get-execution.md +2 -2
  92. package/docs/examples/functions/get-function-usage.md +1 -1
  93. package/docs/examples/functions/get-variable.md +2 -2
  94. package/docs/examples/functions/get.md +1 -1
  95. package/docs/examples/functions/list-deployments.md +2 -2
  96. package/docs/examples/functions/list-executions.md +2 -2
  97. package/docs/examples/functions/list-variables.md +1 -1
  98. package/docs/examples/functions/list.md +1 -1
  99. package/docs/examples/functions/update-deployment.md +2 -2
  100. package/docs/examples/functions/update-variable.md +4 -4
  101. package/docs/examples/functions/update.md +8 -8
  102. package/docs/examples/health/get-queue-databases.md +1 -1
  103. package/docs/examples/messaging/create-apns-provider.md +7 -6
  104. package/docs/examples/messaging/create-email.md +3 -3
  105. package/docs/examples/messaging/create-fcm-provider.md +2 -2
  106. package/docs/examples/messaging/create-mailgun-provider.md +6 -6
  107. package/docs/examples/messaging/create-msg91provider.md +4 -4
  108. package/docs/examples/messaging/create-push.md +9 -9
  109. package/docs/examples/messaging/create-sendgrid-provider.md +5 -5
  110. package/docs/examples/messaging/create-sms.md +2 -2
  111. package/docs/examples/messaging/create-smtp-provider.md +10 -10
  112. package/docs/examples/messaging/create-subscriber.md +3 -3
  113. package/docs/examples/messaging/create-telesign-provider.md +4 -4
  114. package/docs/examples/messaging/create-textmagic-provider.md +4 -4
  115. package/docs/examples/messaging/create-topic.md +2 -2
  116. package/docs/examples/messaging/create-twilio-provider.md +4 -4
  117. package/docs/examples/messaging/create-vonage-provider.md +4 -4
  118. package/docs/examples/messaging/delete-provider.md +1 -1
  119. package/docs/examples/messaging/delete-subscriber.md +2 -2
  120. package/docs/examples/messaging/delete-topic.md +1 -1
  121. package/docs/examples/messaging/delete.md +1 -1
  122. package/docs/examples/messaging/get-message.md +1 -1
  123. package/docs/examples/messaging/get-provider.md +1 -1
  124. package/docs/examples/messaging/get-subscriber.md +2 -2
  125. package/docs/examples/messaging/get-topic.md +1 -1
  126. package/docs/examples/messaging/list-message-logs.md +1 -1
  127. package/docs/examples/messaging/list-messages.md +1 -1
  128. package/docs/examples/messaging/list-provider-logs.md +1 -1
  129. package/docs/examples/messaging/list-providers.md +1 -1
  130. package/docs/examples/messaging/list-subscriber-logs.md +1 -1
  131. package/docs/examples/messaging/list-subscribers.md +2 -2
  132. package/docs/examples/messaging/list-targets.md +1 -1
  133. package/docs/examples/messaging/list-topic-logs.md +1 -1
  134. package/docs/examples/messaging/list-topics.md +1 -1
  135. package/docs/examples/messaging/update-apns-provider.md +20 -0
  136. package/docs/examples/messaging/update-email.md +3 -3
  137. package/docs/examples/messaging/{update-f-c-m-provider.md → update-fcm-provider.md} +3 -3
  138. package/docs/examples/messaging/update-mailgun-provider.md +7 -7
  139. package/docs/examples/messaging/update-msg91provider.md +5 -5
  140. package/docs/examples/messaging/update-push.md +8 -8
  141. package/docs/examples/messaging/update-sendgrid-provider.md +6 -6
  142. package/docs/examples/messaging/update-sms.md +2 -2
  143. package/docs/examples/messaging/update-smtp-provider.md +11 -11
  144. package/docs/examples/messaging/update-telesign-provider.md +5 -5
  145. package/docs/examples/messaging/update-textmagic-provider.md +5 -5
  146. package/docs/examples/messaging/update-topic.md +3 -2
  147. package/docs/examples/messaging/update-twilio-provider.md +5 -5
  148. package/docs/examples/messaging/update-vonage-provider.md +5 -5
  149. package/docs/examples/migrations/create-appwrite-migration.md +2 -2
  150. package/docs/examples/migrations/create-firebase-migration.md +1 -1
  151. package/docs/examples/migrations/create-firebase-o-auth-migration.md +1 -1
  152. package/docs/examples/migrations/create-n-host-migration.md +6 -6
  153. package/docs/examples/migrations/create-supabase-migration.md +4 -4
  154. package/docs/examples/migrations/delete.md +1 -1
  155. package/docs/examples/migrations/get-appwrite-report.md +2 -2
  156. package/docs/examples/migrations/get-firebase-report-o-auth.md +1 -1
  157. package/docs/examples/migrations/get-firebase-report.md +1 -1
  158. package/docs/examples/migrations/get-n-host-report.md +6 -6
  159. package/docs/examples/migrations/get-supabase-report.md +4 -4
  160. package/docs/examples/migrations/get.md +1 -1
  161. package/docs/examples/migrations/list.md +1 -1
  162. package/docs/examples/migrations/retry.md +1 -1
  163. package/docs/examples/project/create-variable.md +2 -2
  164. package/docs/examples/project/delete-variable.md +1 -1
  165. package/docs/examples/project/get-variable.md +1 -1
  166. package/docs/examples/project/update-variable.md +3 -3
  167. package/docs/examples/projects/create-key.md +2 -2
  168. package/docs/examples/projects/create-platform.md +4 -4
  169. package/docs/examples/projects/create-smtp-test.md +4 -4
  170. package/docs/examples/projects/create-webhook.md +4 -4
  171. package/docs/examples/projects/create.md +10 -10
  172. package/docs/examples/projects/delete-email-template.md +1 -1
  173. package/docs/examples/projects/delete-key.md +2 -2
  174. package/docs/examples/projects/delete-platform.md +2 -2
  175. package/docs/examples/projects/delete-sms-template.md +1 -1
  176. package/docs/examples/projects/delete-webhook.md +2 -2
  177. package/docs/examples/projects/delete.md +1 -1
  178. package/docs/examples/projects/get-email-template.md +1 -1
  179. package/docs/examples/projects/get-key.md +2 -2
  180. package/docs/examples/projects/get-platform.md +2 -2
  181. package/docs/examples/projects/get-sms-template.md +1 -1
  182. package/docs/examples/projects/get-webhook.md +2 -2
  183. package/docs/examples/projects/get.md +1 -1
  184. package/docs/examples/projects/list-keys.md +1 -1
  185. package/docs/examples/projects/list-platforms.md +1 -1
  186. package/docs/examples/projects/list-webhooks.md +1 -1
  187. package/docs/examples/projects/list.md +1 -1
  188. package/docs/examples/projects/update-auth-duration.md +1 -1
  189. package/docs/examples/projects/update-auth-limit.md +1 -1
  190. package/docs/examples/projects/update-auth-password-dictionary.md +1 -1
  191. package/docs/examples/projects/update-auth-password-history.md +1 -1
  192. package/docs/examples/projects/update-auth-sessions-limit.md +1 -1
  193. package/docs/examples/projects/update-auth-status.md +1 -1
  194. package/docs/examples/projects/update-email-template.md +4 -4
  195. package/docs/examples/projects/update-key.md +3 -3
  196. package/docs/examples/projects/update-o-auth2.md +3 -3
  197. package/docs/examples/projects/update-personal-data-check.md +1 -1
  198. package/docs/examples/projects/update-platform.md +5 -5
  199. package/docs/examples/projects/update-service-status-all.md +1 -1
  200. package/docs/examples/projects/update-service-status.md +1 -1
  201. package/docs/examples/projects/update-sms-template.md +2 -2
  202. package/docs/examples/projects/update-smtp.md +4 -4
  203. package/docs/examples/projects/update-team.md +2 -2
  204. package/docs/examples/projects/update-webhook-signature.md +2 -2
  205. package/docs/examples/projects/update-webhook.md +5 -5
  206. package/docs/examples/projects/update.md +10 -10
  207. package/docs/examples/proxy/create-rule.md +1 -1
  208. package/docs/examples/proxy/delete-rule.md +1 -1
  209. package/docs/examples/proxy/get-rule.md +1 -1
  210. package/docs/examples/proxy/list-rules.md +1 -1
  211. package/docs/examples/proxy/update-rule-verification.md +1 -1
  212. package/docs/examples/storage/create-bucket.md +2 -2
  213. package/docs/examples/storage/create-file.md +2 -2
  214. package/docs/examples/storage/delete-bucket.md +1 -1
  215. package/docs/examples/storage/delete-file.md +2 -2
  216. package/docs/examples/storage/get-bucket-usage.md +1 -1
  217. package/docs/examples/storage/get-bucket.md +1 -1
  218. package/docs/examples/storage/get-file-download.md +2 -2
  219. package/docs/examples/storage/get-file-preview.md +2 -2
  220. package/docs/examples/storage/get-file-view.md +2 -2
  221. package/docs/examples/storage/get-file.md +2 -2
  222. package/docs/examples/storage/list-buckets.md +1 -1
  223. package/docs/examples/storage/list-files.md +2 -2
  224. package/docs/examples/storage/update-bucket.md +2 -2
  225. package/docs/examples/storage/update-file.md +3 -3
  226. package/docs/examples/teams/create-membership.md +3 -3
  227. package/docs/examples/teams/create.md +2 -2
  228. package/docs/examples/teams/delete-membership.md +2 -2
  229. package/docs/examples/teams/delete.md +1 -1
  230. package/docs/examples/teams/get-membership.md +2 -2
  231. package/docs/examples/teams/get-prefs.md +1 -1
  232. package/docs/examples/teams/get.md +1 -1
  233. package/docs/examples/teams/list-logs.md +1 -1
  234. package/docs/examples/teams/list-memberships.md +2 -2
  235. package/docs/examples/teams/list.md +1 -1
  236. package/docs/examples/teams/update-membership-status.md +4 -4
  237. package/docs/examples/teams/update-membership.md +2 -2
  238. package/docs/examples/teams/update-name.md +2 -2
  239. package/docs/examples/teams/update-prefs.md +1 -1
  240. package/docs/examples/users/create-argon2user.md +2 -2
  241. package/docs/examples/users/create-bcrypt-user.md +2 -2
  242. package/docs/examples/users/create-m-d5user.md +2 -2
  243. package/docs/examples/users/create-p-h-pass-user.md +2 -2
  244. package/docs/examples/users/create-s-h-a-user.md +2 -2
  245. package/docs/examples/users/create-scrypt-modified-user.md +5 -5
  246. package/docs/examples/users/create-scrypt-user.md +3 -3
  247. package/docs/examples/users/create-session.md +1 -1
  248. package/docs/examples/users/create-target.md +5 -5
  249. package/docs/examples/users/create-token.md +1 -1
  250. package/docs/examples/users/create.md +2 -2
  251. package/docs/examples/users/delete-authenticator.md +2 -2
  252. package/docs/examples/users/delete-identity.md +1 -1
  253. package/docs/examples/users/delete-session.md +2 -2
  254. package/docs/examples/users/delete-sessions.md +1 -1
  255. package/docs/examples/users/delete-target.md +2 -2
  256. package/docs/examples/users/delete.md +1 -1
  257. package/docs/examples/users/get-prefs.md +1 -1
  258. package/docs/examples/users/get-target.md +2 -2
  259. package/docs/examples/users/get.md +1 -1
  260. package/docs/examples/users/list-factors.md +1 -1
  261. package/docs/examples/users/list-identities.md +1 -1
  262. package/docs/examples/users/list-logs.md +1 -1
  263. package/docs/examples/users/list-memberships.md +1 -1
  264. package/docs/examples/users/list-sessions.md +1 -1
  265. package/docs/examples/users/list-targets.md +1 -1
  266. package/docs/examples/users/list.md +1 -1
  267. package/docs/examples/users/update-email-verification.md +1 -1
  268. package/docs/examples/users/update-email.md +1 -1
  269. package/docs/examples/users/update-labels.md +1 -1
  270. package/docs/examples/users/update-mfa.md +1 -1
  271. package/docs/examples/users/update-name.md +2 -2
  272. package/docs/examples/users/update-password.md +1 -1
  273. package/docs/examples/users/update-phone-verification.md +1 -1
  274. package/docs/examples/users/update-phone.md +1 -1
  275. package/docs/examples/users/update-prefs.md +1 -1
  276. package/docs/examples/users/update-status.md +1 -1
  277. package/docs/examples/users/update-target.md +5 -5
  278. package/docs/examples/vcs/create-repository-detection.md +3 -3
  279. package/docs/examples/vcs/create-repository.md +2 -2
  280. package/docs/examples/vcs/delete-installation.md +1 -1
  281. package/docs/examples/vcs/get-installation.md +1 -1
  282. package/docs/examples/vcs/get-repository.md +2 -2
  283. package/docs/examples/vcs/list-installations.md +1 -1
  284. package/docs/examples/vcs/list-repositories.md +2 -2
  285. package/docs/examples/vcs/list-repository-branches.md +2 -2
  286. package/docs/examples/vcs/update-external-deployments.md +3 -3
  287. package/package.json +1 -1
  288. package/src/client.ts +1 -1
  289. package/src/enums/email-template-type.ts +1 -0
  290. package/src/enums/sms-template-type.ts +1 -0
  291. package/src/enums/{encryption.ts → smtp-encryption.ts} +1 -1
  292. package/src/index.ts +1 -1
  293. package/src/service.ts +0 -3
  294. package/src/services/account.ts +61 -8
  295. package/src/services/assistant.ts +0 -1
  296. package/src/services/avatars.ts +0 -1
  297. package/src/services/console.ts +0 -1
  298. package/src/services/databases.ts +0 -1
  299. package/src/services/functions.ts +0 -1
  300. package/src/services/graphql.ts +0 -1
  301. package/src/services/health.ts +0 -1
  302. package/src/services/locale.ts +0 -1
  303. package/src/services/messaging.ts +24 -10
  304. package/src/services/migrations.ts +0 -1
  305. package/src/services/project.ts +0 -1
  306. package/src/services/projects.ts +0 -1
  307. package/src/services/proxy.ts +0 -1
  308. package/src/services/storage.ts +0 -1
  309. package/src/services/teams.ts +0 -1
  310. package/src/services/users.ts +0 -1
  311. package/src/services/vcs.ts +0 -1
  312. package/types/enums/email-template-type.d.ts +2 -1
  313. package/types/enums/sms-template-type.d.ts +2 -1
  314. package/types/enums/{encryption.d.ts → smtp-encryption.d.ts} +1 -1
  315. package/types/index.d.ts +1 -1
  316. package/types/services/account.d.ts +28 -3
  317. package/types/services/messaging.d.ts +12 -9
  318. package/docs/examples/messaging/update-a-p-n-s-provider.md +0 -19
package/docs/examples/projects/create-platform.md CHANGED
@@ -7,11 +7,11 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.createPlatform(
10
- '[PROJECT_ID]', // projectId
10
+ '<PROJECT_ID>', // projectId
11
11
  PlatformType.Web, // type
12
- '[NAME]', // name
13
- '[KEY]', // key (optional)
14
- '[STORE]', // store (optional)
12
+ '<NAME>', // name
13
+ '<KEY>', // key (optional)
14
+ '<STORE>', // store (optional)
15
15
  '' // hostname (optional)
16
16
  );
17
17
 
package/docs/examples/projects/create-smtp-test.md CHANGED
@@ -7,15 +7,15 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.createSmtpTest(
10
- '[PROJECT_ID]', // projectId
10
+ '<PROJECT_ID>', // projectId
11
11
  [], // emails
12
- '[SENDER_NAME]', // senderName
12
+ '<SENDER_NAME>', // senderName
13
13
  'email@example.com', // senderEmail
14
14
  '', // host
15
15
  'email@example.com', // replyTo (optional)
16
16
  null, // port (optional)
17
- '[USERNAME]', // username (optional)
18
- '[PASSWORD]', // password (optional)
17
+ '<USERNAME>', // username (optional)
18
+ '<PASSWORD>', // password (optional)
19
19
  SMTPSecure.Tls // secure (optional)
20
20
  );
21
21
 
package/docs/examples/projects/create-webhook.md CHANGED
@@ -7,14 +7,14 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.createWebhook(
10
- '[PROJECT_ID]', // projectId
11
- '[NAME]', // name
10
+ '<PROJECT_ID>', // projectId
11
+ '<NAME>', // name
12
12
  [], // events
13
13
  '', // url
14
14
  false, // security
15
15
  false, // enabled (optional)
16
- '[HTTP_USER]', // httpUser (optional)
17
- '[HTTP_PASS]' // httpPass (optional)
16
+ '<HTTP_USER>', // httpUser (optional)
17
+ '<HTTP_PASS>' // httpPass (optional)
18
18
  );
19
19
 
20
20
  console.log(response);
package/docs/examples/projects/create.md CHANGED
@@ -8,18 +8,18 @@ const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.create(
10
10
  '', // projectId
11
- '[NAME]', // name
12
- '[TEAM_ID]', // teamId
11
+ '<NAME>', // name
12
+ '<TEAM_ID>', // teamId
13
13
  .Default, // region (optional)
14
- '[DESCRIPTION]', // description (optional)
15
- '[LOGO]', // logo (optional)
14
+ '<DESCRIPTION>', // description (optional)
15
+ '<LOGO>', // logo (optional)
16
16
  'https://example.com', // url (optional)
17
- '[LEGAL_NAME]', // legalName (optional)
18
- '[LEGAL_COUNTRY]', // legalCountry (optional)
19
- '[LEGAL_STATE]', // legalState (optional)
20
- '[LEGAL_CITY]', // legalCity (optional)
21
- '[LEGAL_ADDRESS]', // legalAddress (optional)
22
- '[LEGAL_TAX_ID]' // legalTaxId (optional)
17
+ '<LEGAL_NAME>', // legalName (optional)
18
+ '<LEGAL_COUNTRY>', // legalCountry (optional)
19
+ '<LEGAL_STATE>', // legalState (optional)
20
+ '<LEGAL_CITY>', // legalCity (optional)
21
+ '<LEGAL_ADDRESS>', // legalAddress (optional)
22
+ '<LEGAL_TAX_ID>' // legalTaxId (optional)
23
23
  );
24
24
 
25
25
  console.log(response);
package/docs/examples/projects/delete-email-template.md CHANGED
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.deleteEmailTemplate(
10
- '[PROJECT_ID]', // projectId
10
+ '<PROJECT_ID>', // projectId
11
11
  EmailTemplateType.Verification, // type
12
12
  EmailTemplateLocale.Af // locale
13
13
  );
package/docs/examples/projects/delete-key.md CHANGED
@@ -7,8 +7,8 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.deleteKey(
10
- '[PROJECT_ID]', // projectId
11
- '[KEY_ID]' // keyId
10
+ '<PROJECT_ID>', // projectId
11
+ '<KEY_ID>' // keyId
12
12
  );
13
13
 
14
14
  console.log(response);
package/docs/examples/projects/delete-platform.md CHANGED
@@ -7,8 +7,8 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.deletePlatform(
10
- '[PROJECT_ID]', // projectId
11
- '[PLATFORM_ID]' // platformId
10
+ '<PROJECT_ID>', // projectId
11
+ '<PLATFORM_ID>' // platformId
12
12
  );
13
13
 
14
14
  console.log(response);
package/docs/examples/projects/delete-sms-template.md CHANGED
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.deleteSmsTemplate(
10
- '[PROJECT_ID]', // projectId
10
+ '<PROJECT_ID>', // projectId
11
11
  SmsTemplateType.Verification, // type
12
12
  SmsTemplateLocale.Af // locale
13
13
  );
package/docs/examples/projects/delete-webhook.md CHANGED
@@ -7,8 +7,8 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.deleteWebhook(
10
- '[PROJECT_ID]', // projectId
11
- '[WEBHOOK_ID]' // webhookId
10
+ '<PROJECT_ID>', // projectId
11
+ '<WEBHOOK_ID>' // webhookId
12
12
  );
13
13
 
14
14
  console.log(response);
package/docs/examples/projects/delete.md CHANGED
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.delete(
10
- '[PROJECT_ID]' // projectId
10
+ '<PROJECT_ID>' // projectId
11
11
  );
12
12
 
13
13
  console.log(response);
package/docs/examples/projects/get-email-template.md CHANGED
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.getEmailTemplate(
10
- '[PROJECT_ID]', // projectId
10
+ '<PROJECT_ID>', // projectId
11
11
  EmailTemplateType.Verification, // type
12
12
  EmailTemplateLocale.Af // locale
13
13
  );
package/docs/examples/projects/get-key.md CHANGED
@@ -7,8 +7,8 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.getKey(
10
- '[PROJECT_ID]', // projectId
11
- '[KEY_ID]' // keyId
10
+ '<PROJECT_ID>', // projectId
11
+ '<KEY_ID>' // keyId
12
12
  );
13
13
 
14
14
  console.log(response);
package/docs/examples/projects/get-platform.md CHANGED
@@ -7,8 +7,8 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.getPlatform(
10
- '[PROJECT_ID]', // projectId
11
- '[PLATFORM_ID]' // platformId
10
+ '<PROJECT_ID>', // projectId
11
+ '<PLATFORM_ID>' // platformId
12
12
  );
13
13
 
14
14
  console.log(response);
package/docs/examples/projects/get-sms-template.md CHANGED
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.getSmsTemplate(
10
- '[PROJECT_ID]', // projectId
10
+ '<PROJECT_ID>', // projectId
11
11
  SmsTemplateType.Verification, // type
12
12
  SmsTemplateLocale.Af // locale
13
13
  );
package/docs/examples/projects/get-webhook.md CHANGED
@@ -7,8 +7,8 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.getWebhook(
10
- '[PROJECT_ID]', // projectId
11
- '[WEBHOOK_ID]' // webhookId
10
+ '<PROJECT_ID>', // projectId
11
+ '<WEBHOOK_ID>' // webhookId
12
12
  );
13
13
 
14
14
  console.log(response);
package/docs/examples/projects/get.md CHANGED
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.get(
10
- '[PROJECT_ID]' // projectId
10
+ '<PROJECT_ID>' // projectId
11
11
  );
12
12
 
13
13
  console.log(response);
package/docs/examples/projects/list-keys.md CHANGED
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.listKeys(
10
- '[PROJECT_ID]' // projectId
10
+ '<PROJECT_ID>' // projectId
11
11
  );
12
12
 
13
13
  console.log(response);
package/docs/examples/projects/list-platforms.md CHANGED
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.listPlatforms(
10
- '[PROJECT_ID]' // projectId
10
+ '<PROJECT_ID>' // projectId
11
11
  );
12
12
 
13
13
  console.log(response);
package/docs/examples/projects/list-webhooks.md CHANGED
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.listWebhooks(
10
- '[PROJECT_ID]' // projectId
10
+ '<PROJECT_ID>' // projectId
11
11
  );
12
12
 
13
13
  console.log(response);
package/docs/examples/projects/list.md CHANGED
@@ -8,7 +8,7 @@ const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.list(
10
10
  [], // queries (optional)
11
- '[SEARCH]' // search (optional)
11
+ '<SEARCH>' // search (optional)
12
12
  );
13
13
 
14
14
  console.log(response);
package/docs/examples/projects/update-auth-duration.md CHANGED
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.updateAuthDuration(
10
- '[PROJECT_ID]', // projectId
10
+ '<PROJECT_ID>', // projectId
11
11
  0 // duration
12
12
  );
13
13
 
package/docs/examples/projects/update-auth-limit.md CHANGED
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.updateAuthLimit(
10
- '[PROJECT_ID]', // projectId
10
+ '<PROJECT_ID>', // projectId
11
11
  0 // limit
12
12
  );
13
13
 
package/docs/examples/projects/update-auth-password-dictionary.md CHANGED
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.updateAuthPasswordDictionary(
10
- '[PROJECT_ID]', // projectId
10
+ '<PROJECT_ID>', // projectId
11
11
  false // enabled
12
12
  );
13
13
 
package/docs/examples/projects/update-auth-password-history.md CHANGED
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.updateAuthPasswordHistory(
10
- '[PROJECT_ID]', // projectId
10
+ '<PROJECT_ID>', // projectId
11
11
  0 // limit
12
12
  );
13
13
 
package/docs/examples/projects/update-auth-sessions-limit.md CHANGED
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.updateAuthSessionsLimit(
10
- '[PROJECT_ID]', // projectId
10
+ '<PROJECT_ID>', // projectId
11
11
  1 // limit
12
12
  );
13
13
 
package/docs/examples/projects/update-auth-status.md CHANGED
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.updateAuthStatus(
10
- '[PROJECT_ID]', // projectId
10
+ '<PROJECT_ID>', // projectId
11
11
  AuthMethod.EmailPassword, // method
12
12
  false // status
13
13
  );
package/docs/examples/projects/update-email-template.md CHANGED
@@ -7,12 +7,12 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.updateEmailTemplate(
10
- '[PROJECT_ID]', // projectId
10
+ '<PROJECT_ID>', // projectId
11
11
  EmailTemplateType.Verification, // type
12
12
  EmailTemplateLocale.Af, // locale
13
- '[SUBJECT]', // subject
14
- '[MESSAGE]', // message
15
- '[SENDER_NAME]', // senderName (optional)
13
+ '<SUBJECT>', // subject
14
+ '<MESSAGE>', // message
15
+ '<SENDER_NAME>', // senderName (optional)
16
16
  'email@example.com', // senderEmail (optional)
17
17
  'email@example.com' // replyTo (optional)
18
18
  );
package/docs/examples/projects/update-key.md CHANGED
@@ -7,9 +7,9 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.updateKey(
10
- '[PROJECT_ID]', // projectId
11
- '[KEY_ID]', // keyId
12
- '[NAME]', // name
10
+ '<PROJECT_ID>', // projectId
11
+ '<KEY_ID>', // keyId
12
+ '<NAME>', // name
13
13
  [], // scopes
14
14
  '' // expire (optional)
15
15
  );
package/docs/examples/projects/update-o-auth2.md CHANGED
@@ -7,10 +7,10 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.updateOAuth2(
10
- '[PROJECT_ID]', // projectId
10
+ '<PROJECT_ID>', // projectId
11
11
  OAuthProvider.Amazon, // provider
12
- '[APP_ID]', // appId (optional)
13
- '[SECRET]', // secret (optional)
12
+ '<APP_ID>', // appId (optional)
13
+ '<SECRET>', // secret (optional)
14
14
  false // enabled (optional)
15
15
  );
16
16
 
package/docs/examples/projects/update-personal-data-check.md CHANGED
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.updatePersonalDataCheck(
10
- '[PROJECT_ID]', // projectId
10
+ '<PROJECT_ID>', // projectId
11
11
  false // enabled
12
12
  );
13
13
 
package/docs/examples/projects/update-platform.md CHANGED
@@ -7,11 +7,11 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.updatePlatform(
10
- '[PROJECT_ID]', // projectId
11
- '[PLATFORM_ID]', // platformId
12
- '[NAME]', // name
13
- '[KEY]', // key (optional)
14
- '[STORE]', // store (optional)
10
+ '<PROJECT_ID>', // projectId
11
+ '<PLATFORM_ID>', // platformId
12
+ '<NAME>', // name
13
+ '<KEY>', // key (optional)
14
+ '<STORE>', // store (optional)
15
15
  '' // hostname (optional)
16
16
  );
17
17
 
package/docs/examples/projects/update-service-status-all.md CHANGED
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.updateServiceStatusAll(
10
- '[PROJECT_ID]', // projectId
10
+ '<PROJECT_ID>', // projectId
11
11
  false // status
12
12
  );
13
13
 
package/docs/examples/projects/update-service-status.md CHANGED
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.updateServiceStatus(
10
- '[PROJECT_ID]', // projectId
10
+ '<PROJECT_ID>', // projectId
11
11
  ApiService.Account, // service
12
12
  false // status
13
13
  );
package/docs/examples/projects/update-sms-template.md CHANGED
@@ -7,10 +7,10 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.updateSmsTemplate(
10
- '[PROJECT_ID]', // projectId
10
+ '<PROJECT_ID>', // projectId
11
11
  SmsTemplateType.Verification, // type
12
12
  SmsTemplateLocale.Af, // locale
13
- '[MESSAGE]' // message
13
+ '<MESSAGE>' // message
14
14
  );
15
15
 
16
16
  console.log(response);
package/docs/examples/projects/update-smtp.md CHANGED
@@ -7,15 +7,15 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.updateSmtp(
10
- '[PROJECT_ID]', // projectId
10
+ '<PROJECT_ID>', // projectId
11
11
  false, // enabled
12
- '[SENDER_NAME]', // senderName (optional)
12
+ '<SENDER_NAME>', // senderName (optional)
13
13
  'email@example.com', // senderEmail (optional)
14
14
  'email@example.com', // replyTo (optional)
15
15
  '', // host (optional)
16
16
  null, // port (optional)
17
- '[USERNAME]', // username (optional)
18
- '[PASSWORD]', // password (optional)
17
+ '<USERNAME>', // username (optional)
18
+ '<PASSWORD>', // password (optional)
19
19
  SMTPSecure.Tls // secure (optional)
20
20
  );
21
21
 
package/docs/examples/projects/update-team.md CHANGED
@@ -7,8 +7,8 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.updateTeam(
10
- '[PROJECT_ID]', // projectId
11
- '[TEAM_ID]' // teamId
10
+ '<PROJECT_ID>', // projectId
11
+ '<TEAM_ID>' // teamId
12
12
  );
13
13
 
14
14
  console.log(response);
package/docs/examples/projects/update-webhook-signature.md CHANGED
@@ -7,8 +7,8 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.updateWebhookSignature(
10
- '[PROJECT_ID]', // projectId
11
- '[WEBHOOK_ID]' // webhookId
10
+ '<PROJECT_ID>', // projectId
11
+ '<WEBHOOK_ID>' // webhookId
12
12
  );
13
13
 
14
14
  console.log(response);
package/docs/examples/projects/update-webhook.md CHANGED
@@ -7,15 +7,15 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.updateWebhook(
10
- '[PROJECT_ID]', // projectId
11
- '[WEBHOOK_ID]', // webhookId
12
- '[NAME]', // name
10
+ '<PROJECT_ID>', // projectId
11
+ '<WEBHOOK_ID>', // webhookId
12
+ '<NAME>', // name
13
13
  [], // events
14
14
  '', // url
15
15
  false, // security
16
16
  false, // enabled (optional)
17
- '[HTTP_USER]', // httpUser (optional)
18
- '[HTTP_PASS]' // httpPass (optional)
17
+ '<HTTP_USER>', // httpUser (optional)
18
+ '<HTTP_PASS>' // httpPass (optional)
19
19
  );
20
20
 
21
21
  console.log(response);
package/docs/examples/projects/update.md CHANGED
@@ -7,17 +7,17 @@ const client = new Client()
7
7
  const projects = new Projects(client);
8
8
 
9
9
  const result = await projects.update(
10
- '[PROJECT_ID]', // projectId
11
- '[NAME]', // name
12
- '[DESCRIPTION]', // description (optional)
13
- '[LOGO]', // logo (optional)
10
+ '<PROJECT_ID>', // projectId
11
+ '<NAME>', // name
12
+ '<DESCRIPTION>', // description (optional)
13
+ '<LOGO>', // logo (optional)
14
14
  'https://example.com', // url (optional)
15
- '[LEGAL_NAME]', // legalName (optional)
16
- '[LEGAL_COUNTRY]', // legalCountry (optional)
17
- '[LEGAL_STATE]', // legalState (optional)
18
- '[LEGAL_CITY]', // legalCity (optional)
19
- '[LEGAL_ADDRESS]', // legalAddress (optional)
20
- '[LEGAL_TAX_ID]' // legalTaxId (optional)
15
+ '<LEGAL_NAME>', // legalName (optional)
16
+ '<LEGAL_COUNTRY>', // legalCountry (optional)
17
+ '<LEGAL_STATE>', // legalState (optional)
18
+ '<LEGAL_CITY>', // legalCity (optional)
19
+ '<LEGAL_ADDRESS>', // legalAddress (optional)
20
+ '<LEGAL_TAX_ID>' // legalTaxId (optional)
21
21
  );
22
22
 
23
23
  console.log(response);
package/docs/examples/proxy/create-rule.md CHANGED
@@ -9,7 +9,7 @@ const proxy = new Proxy(client);
9
9
  const result = await proxy.createRule(
10
10
  '', // domain
11
11
  .Api, // resourceType
12
- '[RESOURCE_ID]' // resourceId (optional)
12
+ '<RESOURCE_ID>' // resourceId (optional)
13
13
  );
14
14
 
15
15
  console.log(response);
package/docs/examples/proxy/delete-rule.md CHANGED
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const proxy = new Proxy(client);
8
8
 
9
9
  const result = await proxy.deleteRule(
10
- '[RULE_ID]' // ruleId
10
+ '<RULE_ID>' // ruleId
11
11
  );
12
12
 
13
13
  console.log(response);
package/docs/examples/proxy/get-rule.md CHANGED
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const proxy = new Proxy(client);
8
8
 
9
9
  const result = await proxy.getRule(
10
- '[RULE_ID]' // ruleId
10
+ '<RULE_ID>' // ruleId
11
11
  );
12
12
 
13
13
  console.log(response);
package/docs/examples/proxy/list-rules.md CHANGED
@@ -8,7 +8,7 @@ const proxy = new Proxy(client);
8
8
 
9
9
  const result = await proxy.listRules(
10
10
  [], // queries (optional)
11
- '[SEARCH]' // search (optional)
11
+ '<SEARCH>' // search (optional)
12
12
  );
13
13
 
14
14
  console.log(response);
package/docs/examples/proxy/update-rule-verification.md CHANGED
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const proxy = new Proxy(client);
8
8
 
9
9
  const result = await proxy.updateRuleVerification(
10
- '[RULE_ID]' // ruleId
10
+ '<RULE_ID>' // ruleId
11
11
  );
12
12
 
13
13
  console.log(response);
package/docs/examples/storage/create-bucket.md CHANGED
@@ -7,8 +7,8 @@ const client = new Client()
7
7
  const storage = new Storage(client);
8
8
 
9
9
  const result = await storage.createBucket(
10
- '[BUCKET_ID]', // bucketId
11
- '[NAME]', // name
10
+ '<BUCKET_ID>', // bucketId
11
+ '<NAME>', // name
12
12
  ["read("any")"], // permissions (optional)
13
13
  false, // fileSecurity (optional)
14
14
  false, // enabled (optional)
package/docs/examples/storage/create-file.md CHANGED
@@ -7,8 +7,8 @@ const client = new Client()
7
7
  const storage = new Storage(client);
8
8
 
9
9
  const result = await storage.createFile(
10
- '[BUCKET_ID]', // bucketId
11
- '[FILE_ID]', // fileId
10
+ '<BUCKET_ID>', // bucketId
11
+ '<FILE_ID>', // fileId
12
12
  document.getElementById('uploader').files[0], // file
13
13
  ["read("any")"] // permissions (optional)
14
14
  );
package/docs/examples/storage/delete-bucket.md CHANGED
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const storage = new Storage(client);
8
8
 
9
9
  const result = await storage.deleteBucket(
10
- '[BUCKET_ID]' // bucketId
10
+ '<BUCKET_ID>' // bucketId
11
11
  );
12
12
 
13
13
  console.log(response);
package/docs/examples/storage/delete-file.md CHANGED
@@ -7,8 +7,8 @@ const client = new Client()
7
7
  const storage = new Storage(client);
8
8
 
9
9
  const result = await storage.deleteFile(
10
- '[BUCKET_ID]', // bucketId
11
- '[FILE_ID]' // fileId
10
+ '<BUCKET_ID>', // bucketId
11
+ '<FILE_ID>' // fileId
12
12
  );
13
13
 
14
14
  console.log(response);