@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
@@ -8,7 +8,7 @@ const teams = new Teams(client);
8
8
 
9
9
  const result = await teams.list(
10
10
  [], // queries (optional)
11
- '[SEARCH]' // search (optional)
11
+ '<SEARCH>' // search (optional)
12
12
  );
13
13
 
14
14
  console.log(response);
@@ -7,10 +7,10 @@ const client = new Client()
7
7
  const teams = new Teams(client);
8
8
 
9
9
  const result = await teams.updateMembershipStatus(
10
- '[TEAM_ID]', // teamId
11
- '[MEMBERSHIP_ID]', // membershipId
12
- '[USER_ID]', // userId
13
- '[SECRET]' // secret
10
+ '<TEAM_ID>', // teamId
11
+ '<MEMBERSHIP_ID>', // membershipId
12
+ '<USER_ID>', // userId
13
+ '<SECRET>' // secret
14
14
  );
15
15
 
16
16
  console.log(response);
@@ -7,8 +7,8 @@ const client = new Client()
7
7
  const teams = new Teams(client);
8
8
 
9
9
  const result = await teams.updateMembership(
10
- '[TEAM_ID]', // teamId
11
- '[MEMBERSHIP_ID]', // membershipId
10
+ '<TEAM_ID>', // teamId
11
+ '<MEMBERSHIP_ID>', // membershipId
12
12
  [] // roles
13
13
  );
14
14
 
@@ -7,8 +7,8 @@ const client = new Client()
7
7
  const teams = new Teams(client);
8
8
 
9
9
  const result = await teams.updateName(
10
- '[TEAM_ID]', // teamId
11
- '[NAME]' // name
10
+ '<TEAM_ID>', // teamId
11
+ '<NAME>' // name
12
12
  );
13
13
 
14
14
  console.log(response);
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const teams = new Teams(client);
8
8
 
9
9
  const result = await teams.updatePrefs(
10
- '[TEAM_ID]', // teamId
10
+ '<TEAM_ID>', // teamId
11
11
  {} // prefs
12
12
  );
13
13
 
@@ -7,10 +7,10 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.createArgon2User(
10
- '[USER_ID]', // userId
10
+ '<USER_ID>', // userId
11
11
  'email@example.com', // email
12
12
  'password', // password
13
- '[NAME]' // name (optional)
13
+ '<NAME>' // name (optional)
14
14
  );
15
15
 
16
16
  console.log(response);
@@ -7,10 +7,10 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.createBcryptUser(
10
- '[USER_ID]', // userId
10
+ '<USER_ID>', // userId
11
11
  'email@example.com', // email
12
12
  'password', // password
13
- '[NAME]' // name (optional)
13
+ '<NAME>' // name (optional)
14
14
  );
15
15
 
16
16
  console.log(response);
@@ -7,10 +7,10 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.createMD5User(
10
- '[USER_ID]', // userId
10
+ '<USER_ID>', // userId
11
11
  'email@example.com', // email
12
12
  'password', // password
13
- '[NAME]' // name (optional)
13
+ '<NAME>' // name (optional)
14
14
  );
15
15
 
16
16
  console.log(response);
@@ -7,10 +7,10 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.createPHPassUser(
10
- '[USER_ID]', // userId
10
+ '<USER_ID>', // userId
11
11
  'email@example.com', // email
12
12
  'password', // password
13
- '[NAME]' // name (optional)
13
+ '<NAME>' // name (optional)
14
14
  );
15
15
 
16
16
  console.log(response);
@@ -7,11 +7,11 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.createSHAUser(
10
- '[USER_ID]', // userId
10
+ '<USER_ID>', // userId
11
11
  'email@example.com', // email
12
12
  'password', // password
13
13
  PasswordHash.Sha1, // passwordVersion (optional)
14
- '[NAME]' // name (optional)
14
+ '<NAME>' // name (optional)
15
15
  );
16
16
 
17
17
  console.log(response);
@@ -7,13 +7,13 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.createScryptModifiedUser(
10
- '[USER_ID]', // userId
10
+ '<USER_ID>', // userId
11
11
  'email@example.com', // email
12
12
  'password', // password
13
- '[PASSWORD_SALT]', // passwordSalt
14
- '[PASSWORD_SALT_SEPARATOR]', // passwordSaltSeparator
15
- '[PASSWORD_SIGNER_KEY]', // passwordSignerKey
16
- '[NAME]' // name (optional)
13
+ '<PASSWORD_SALT>', // passwordSalt
14
+ '<PASSWORD_SALT_SEPARATOR>', // passwordSaltSeparator
15
+ '<PASSWORD_SIGNER_KEY>', // passwordSignerKey
16
+ '<NAME>' // name (optional)
17
17
  );
18
18
 
19
19
  console.log(response);
@@ -7,15 +7,15 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.createScryptUser(
10
- '[USER_ID]', // userId
10
+ '<USER_ID>', // userId
11
11
  'email@example.com', // email
12
12
  'password', // password
13
- '[PASSWORD_SALT]', // passwordSalt
13
+ '<PASSWORD_SALT>', // passwordSalt
14
14
  null, // passwordCpu
15
15
  null, // passwordMemory
16
16
  null, // passwordParallel
17
17
  null, // passwordLength
18
- '[NAME]' // name (optional)
18
+ '<NAME>' // name (optional)
19
19
  );
20
20
 
21
21
  console.log(response);
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.createSession(
10
- '[USER_ID]' // userId
10
+ '<USER_ID>' // userId
11
11
  );
12
12
 
13
13
  console.log(response);
@@ -7,12 +7,12 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.createTarget(
10
- '[USER_ID]', // userId
11
- '[TARGET_ID]', // targetId
10
+ '<USER_ID>', // userId
11
+ '<TARGET_ID>', // targetId
12
12
  MessagingProviderType.Email, // providerType
13
- '[IDENTIFIER]', // identifier
14
- '[PROVIDER_ID]', // providerId (optional)
15
- '[NAME]' // name (optional)
13
+ '<IDENTIFIER>', // identifier
14
+ '<PROVIDER_ID>', // providerId (optional)
15
+ '<NAME>' // name (optional)
16
16
  );
17
17
 
18
18
  console.log(response);
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.createToken(
10
- '[USER_ID]', // userId
10
+ '<USER_ID>', // userId
11
11
  4, // length (optional)
12
12
  60 // expire (optional)
13
13
  );
@@ -7,11 +7,11 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.create(
10
- '[USER_ID]', // userId
10
+ '<USER_ID>', // userId
11
11
  'email@example.com', // email (optional)
12
12
  '+12065550100', // phone (optional)
13
13
  '', // password (optional)
14
- '[NAME]' // name (optional)
14
+ '<NAME>' // name (optional)
15
15
  );
16
16
 
17
17
  console.log(response);
@@ -7,9 +7,8 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.deleteAuthenticator(
10
- '[USER_ID]', // userId
11
- AuthenticatorType.Totp, // type
12
- '[OTP]' // otp
10
+ '<USER_ID>', // userId
11
+ AuthenticatorType.Totp // type
13
12
  );
14
13
 
15
14
  console.log(response);
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.deleteIdentity(
10
- '[IDENTITY_ID]' // identityId
10
+ '<IDENTITY_ID>' // identityId
11
11
  );
12
12
 
13
13
  console.log(response);
@@ -7,8 +7,8 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.deleteSession(
10
- '[USER_ID]', // userId
11
- '[SESSION_ID]' // sessionId
10
+ '<USER_ID>', // userId
11
+ '<SESSION_ID>' // sessionId
12
12
  );
13
13
 
14
14
  console.log(response);
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.deleteSessions(
10
- '[USER_ID]' // userId
10
+ '<USER_ID>' // userId
11
11
  );
12
12
 
13
13
  console.log(response);
@@ -7,8 +7,8 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.deleteTarget(
10
- '[USER_ID]', // userId
11
- '[TARGET_ID]' // targetId
10
+ '<USER_ID>', // userId
11
+ '<TARGET_ID>' // targetId
12
12
  );
13
13
 
14
14
  console.log(response);
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.delete(
10
- '[USER_ID]' // userId
10
+ '<USER_ID>' // userId
11
11
  );
12
12
 
13
13
  console.log(response);
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.getPrefs(
10
- '[USER_ID]' // userId
10
+ '<USER_ID>' // userId
11
11
  );
12
12
 
13
13
  console.log(response);
@@ -7,8 +7,8 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.getTarget(
10
- '[USER_ID]', // userId
11
- '[TARGET_ID]' // targetId
10
+ '<USER_ID>', // userId
11
+ '<TARGET_ID>' // targetId
12
12
  );
13
13
 
14
14
  console.log(response);
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.get(
10
- '[USER_ID]' // userId
10
+ '<USER_ID>' // userId
11
11
  );
12
12
 
13
13
  console.log(response);
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.listFactors(
10
- '[USER_ID]' // userId
10
+ '<USER_ID>' // userId
11
11
  );
12
12
 
13
13
  console.log(response);
@@ -8,7 +8,7 @@ const users = new Users(client);
8
8
 
9
9
  const result = await users.listIdentities(
10
10
  [], // queries (optional)
11
- '[SEARCH]' // search (optional)
11
+ '<SEARCH>' // search (optional)
12
12
  );
13
13
 
14
14
  console.log(response);
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.listLogs(
10
- '[USER_ID]', // userId
10
+ '<USER_ID>', // userId
11
11
  [] // queries (optional)
12
12
  );
13
13
 
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.listMemberships(
10
- '[USER_ID]' // userId
10
+ '<USER_ID>' // userId
11
11
  );
12
12
 
13
13
  console.log(response);
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.listSessions(
10
- '[USER_ID]' // userId
10
+ '<USER_ID>' // userId
11
11
  );
12
12
 
13
13
  console.log(response);
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.listTargets(
10
- '[USER_ID]', // userId
10
+ '<USER_ID>', // userId
11
11
  [] // queries (optional)
12
12
  );
13
13
 
@@ -8,7 +8,7 @@ const users = new Users(client);
8
8
 
9
9
  const result = await users.list(
10
10
  [], // queries (optional)
11
- '[SEARCH]' // search (optional)
11
+ '<SEARCH>' // search (optional)
12
12
  );
13
13
 
14
14
  console.log(response);
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.updateEmailVerification(
10
- '[USER_ID]', // userId
10
+ '<USER_ID>', // userId
11
11
  false // emailVerification
12
12
  );
13
13
 
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.updateEmail(
10
- '[USER_ID]', // userId
10
+ '<USER_ID>', // userId
11
11
  'email@example.com' // email
12
12
  );
13
13
 
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.updateLabels(
10
- '[USER_ID]', // userId
10
+ '<USER_ID>', // userId
11
11
  [] // labels
12
12
  );
13
13
 
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.updateMfa(
10
- '[USER_ID]', // userId
10
+ '<USER_ID>', // userId
11
11
  false // mfa
12
12
  );
13
13
 
@@ -7,8 +7,8 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.updateName(
10
- '[USER_ID]', // userId
11
- '[NAME]' // name
10
+ '<USER_ID>', // userId
11
+ '<NAME>' // name
12
12
  );
13
13
 
14
14
  console.log(response);
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.updatePassword(
10
- '[USER_ID]', // userId
10
+ '<USER_ID>', // userId
11
11
  '' // password
12
12
  );
13
13
 
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.updatePhoneVerification(
10
- '[USER_ID]', // userId
10
+ '<USER_ID>', // userId
11
11
  false // phoneVerification
12
12
  );
13
13
 
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.updatePhone(
10
- '[USER_ID]', // userId
10
+ '<USER_ID>', // userId
11
11
  '+12065550100' // number
12
12
  );
13
13
 
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.updatePrefs(
10
- '[USER_ID]', // userId
10
+ '<USER_ID>', // userId
11
11
  {} // prefs
12
12
  );
13
13
 
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.updateStatus(
10
- '[USER_ID]', // userId
10
+ '<USER_ID>', // userId
11
11
  false // status
12
12
  );
13
13
 
@@ -7,11 +7,11 @@ const client = new Client()
7
7
  const users = new Users(client);
8
8
 
9
9
  const result = await users.updateTarget(
10
- '[USER_ID]', // userId
11
- '[TARGET_ID]', // targetId
12
- '[IDENTIFIER]', // identifier (optional)
13
- '[PROVIDER_ID]', // providerId (optional)
14
- '[NAME]' // name (optional)
10
+ '<USER_ID>', // userId
11
+ '<TARGET_ID>', // targetId
12
+ '<IDENTIFIER>', // identifier (optional)
13
+ '<PROVIDER_ID>', // providerId (optional)
14
+ '<NAME>' // name (optional)
15
15
  );
16
16
 
17
17
  console.log(response);
@@ -7,9 +7,9 @@ const client = new Client()
7
7
  const vcs = new Vcs(client);
8
8
 
9
9
  const result = await vcs.createRepositoryDetection(
10
- '[INSTALLATION_ID]', // installationId
11
- '[PROVIDER_REPOSITORY_ID]', // providerRepositoryId
12
- '[PROVIDER_ROOT_DIRECTORY]' // providerRootDirectory (optional)
10
+ '<INSTALLATION_ID>', // installationId
11
+ '<PROVIDER_REPOSITORY_ID>', // providerRepositoryId
12
+ '<PROVIDER_ROOT_DIRECTORY>' // providerRootDirectory (optional)
13
13
  );
14
14
 
15
15
  console.log(response);
@@ -7,8 +7,8 @@ const client = new Client()
7
7
  const vcs = new Vcs(client);
8
8
 
9
9
  const result = await vcs.createRepository(
10
- '[INSTALLATION_ID]', // installationId
11
- '[NAME]', // name
10
+ '<INSTALLATION_ID>', // installationId
11
+ '<NAME>', // name
12
12
  false // private
13
13
  );
14
14
 
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const vcs = new Vcs(client);
8
8
 
9
9
  const result = await vcs.deleteInstallation(
10
- '[INSTALLATION_ID]' // installationId
10
+ '<INSTALLATION_ID>' // installationId
11
11
  );
12
12
 
13
13
  console.log(response);
@@ -7,7 +7,7 @@ const client = new Client()
7
7
  const vcs = new Vcs(client);
8
8
 
9
9
  const result = await vcs.getInstallation(
10
- '[INSTALLATION_ID]' // installationId
10
+ '<INSTALLATION_ID>' // installationId
11
11
  );
12
12
 
13
13
  console.log(response);
@@ -7,8 +7,8 @@ const client = new Client()
7
7
  const vcs = new Vcs(client);
8
8
 
9
9
  const result = await vcs.getRepository(
10
- '[INSTALLATION_ID]', // installationId
11
- '[PROVIDER_REPOSITORY_ID]' // providerRepositoryId
10
+ '<INSTALLATION_ID>', // installationId
11
+ '<PROVIDER_REPOSITORY_ID>' // providerRepositoryId
12
12
  );
13
13
 
14
14
  console.log(response);
@@ -8,7 +8,7 @@ const vcs = new Vcs(client);
8
8
 
9
9
  const result = await vcs.listInstallations(
10
10
  [], // queries (optional)
11
- '[SEARCH]' // search (optional)
11
+ '<SEARCH>' // search (optional)
12
12
  );
13
13
 
14
14
  console.log(response);
@@ -7,8 +7,8 @@ const client = new Client()
7
7
  const vcs = new Vcs(client);
8
8
 
9
9
  const result = await vcs.listRepositories(
10
- '[INSTALLATION_ID]', // installationId
11
- '[SEARCH]' // search (optional)
10
+ '<INSTALLATION_ID>', // installationId
11
+ '<SEARCH>' // search (optional)
12
12
  );
13
13
 
14
14
  console.log(response);
@@ -7,8 +7,8 @@ const client = new Client()
7
7
  const vcs = new Vcs(client);
8
8
 
9
9
  const result = await vcs.listRepositoryBranches(
10
- '[INSTALLATION_ID]', // installationId
11
- '[PROVIDER_REPOSITORY_ID]' // providerRepositoryId
10
+ '<INSTALLATION_ID>', // installationId
11
+ '<PROVIDER_REPOSITORY_ID>' // providerRepositoryId
12
12
  );
13
13
 
14
14
  console.log(response);
@@ -7,9 +7,9 @@ const client = new Client()
7
7
  const vcs = new Vcs(client);
8
8
 
9
9
  const result = await vcs.updateExternalDeployments(
10
- '[INSTALLATION_ID]', // installationId
11
- '[REPOSITORY_ID]', // repositoryId
12
- '[PROVIDER_PULL_REQUEST_ID]' // providerPullRequestId
10
+ '<INSTALLATION_ID>', // installationId
11
+ '<REPOSITORY_ID>', // repositoryId
12
+ '<PROVIDER_PULL_REQUEST_ID>' // providerPullRequestId
13
13
  );
14
14
 
15
15
  console.log(response);