@appconda/nextjs 1.0.12

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 (597) hide show
  1. package/.github/workflows/autoclose.yml +11 -0
  2. package/.github/workflows/publish.yml +42 -0
  3. package/.travis.yml +32 -0
  4. package/CHANGELOG.md +1 -0
  5. package/LICENSE +12 -0
  6. package/README.md +0 -0
  7. package/dist/cjs/sdk.js +10608 -0
  8. package/dist/cjs/sdk.js.map +1 -0
  9. package/dist/esm/sdk.js +10589 -0
  10. package/dist/esm/sdk.js.map +1 -0
  11. package/dist/iife/sdk.js +10609 -0
  12. package/docs/examples/account/create-anonymous-session.md +11 -0
  13. package/docs/examples/account/create-email-password-session.md +14 -0
  14. package/docs/examples/account/create-email-token.md +15 -0
  15. package/docs/examples/account/create-j-w-t.md +11 -0
  16. package/docs/examples/account/create-magic-u-r-l-token.md +16 -0
  17. package/docs/examples/account/create-mfa-authenticator.md +13 -0
  18. package/docs/examples/account/create-mfa-challenge.md +13 -0
  19. package/docs/examples/account/create-mfa-recovery-codes.md +11 -0
  20. package/docs/examples/account/create-o-auth2session.md +15 -0
  21. package/docs/examples/account/create-o-auth2token.md +15 -0
  22. package/docs/examples/account/create-phone-token.md +14 -0
  23. package/docs/examples/account/create-phone-verification.md +11 -0
  24. package/docs/examples/account/create-push-target.md +15 -0
  25. package/docs/examples/account/create-recovery.md +14 -0
  26. package/docs/examples/account/create-session.md +14 -0
  27. package/docs/examples/account/create-verification.md +13 -0
  28. package/docs/examples/account/create.md +16 -0
  29. package/docs/examples/account/delete-identity.md +13 -0
  30. package/docs/examples/account/delete-mfa-authenticator.md +13 -0
  31. package/docs/examples/account/delete-push-target.md +13 -0
  32. package/docs/examples/account/delete-session.md +13 -0
  33. package/docs/examples/account/delete-sessions.md +11 -0
  34. package/docs/examples/account/delete.md +11 -0
  35. package/docs/examples/account/get-mfa-recovery-codes.md +11 -0
  36. package/docs/examples/account/get-prefs.md +11 -0
  37. package/docs/examples/account/get-session.md +13 -0
  38. package/docs/examples/account/get.md +11 -0
  39. package/docs/examples/account/list-identities.md +13 -0
  40. package/docs/examples/account/list-logs.md +13 -0
  41. package/docs/examples/account/list-mfa-factors.md +11 -0
  42. package/docs/examples/account/list-sessions.md +11 -0
  43. package/docs/examples/account/update-email.md +14 -0
  44. package/docs/examples/account/update-m-f-a.md +13 -0
  45. package/docs/examples/account/update-magic-u-r-l-session.md +14 -0
  46. package/docs/examples/account/update-mfa-authenticator.md +14 -0
  47. package/docs/examples/account/update-mfa-challenge.md +14 -0
  48. package/docs/examples/account/update-mfa-recovery-codes.md +11 -0
  49. package/docs/examples/account/update-name.md +13 -0
  50. package/docs/examples/account/update-password.md +14 -0
  51. package/docs/examples/account/update-phone-session.md +14 -0
  52. package/docs/examples/account/update-phone-verification.md +14 -0
  53. package/docs/examples/account/update-phone.md +14 -0
  54. package/docs/examples/account/update-prefs.md +13 -0
  55. package/docs/examples/account/update-push-target.md +14 -0
  56. package/docs/examples/account/update-recovery.md +15 -0
  57. package/docs/examples/account/update-session.md +13 -0
  58. package/docs/examples/account/update-status.md +11 -0
  59. package/docs/examples/account/update-verification.md +14 -0
  60. package/docs/examples/assistant/chat.md +13 -0
  61. package/docs/examples/avatars/get-browser.md +16 -0
  62. package/docs/examples/avatars/get-credit-card.md +16 -0
  63. package/docs/examples/avatars/get-favicon.md +13 -0
  64. package/docs/examples/avatars/get-flag.md +16 -0
  65. package/docs/examples/avatars/get-image.md +15 -0
  66. package/docs/examples/avatars/get-initials.md +16 -0
  67. package/docs/examples/avatars/get-q-r.md +16 -0
  68. package/docs/examples/console/variables.md +11 -0
  69. package/docs/examples/databases/create-boolean-attribute.md +18 -0
  70. package/docs/examples/databases/create-collection.md +18 -0
  71. package/docs/examples/databases/create-datetime-attribute.md +18 -0
  72. package/docs/examples/databases/create-document.md +17 -0
  73. package/docs/examples/databases/create-email-attribute.md +18 -0
  74. package/docs/examples/databases/create-enum-attribute.md +19 -0
  75. package/docs/examples/databases/create-float-attribute.md +20 -0
  76. package/docs/examples/databases/create-index.md +18 -0
  77. package/docs/examples/databases/create-integer-attribute.md +20 -0
  78. package/docs/examples/databases/create-ip-attribute.md +18 -0
  79. package/docs/examples/databases/create-relationship-attribute.md +20 -0
  80. package/docs/examples/databases/create-string-attribute.md +20 -0
  81. package/docs/examples/databases/create-url-attribute.md +18 -0
  82. package/docs/examples/databases/create.md +15 -0
  83. package/docs/examples/databases/delete-attribute.md +15 -0
  84. package/docs/examples/databases/delete-collection.md +14 -0
  85. package/docs/examples/databases/delete-document.md +15 -0
  86. package/docs/examples/databases/delete-index.md +15 -0
  87. package/docs/examples/databases/delete.md +13 -0
  88. package/docs/examples/databases/get-attribute.md +15 -0
  89. package/docs/examples/databases/get-collection-usage.md +15 -0
  90. package/docs/examples/databases/get-collection.md +14 -0
  91. package/docs/examples/databases/get-database-usage.md +14 -0
  92. package/docs/examples/databases/get-document.md +16 -0
  93. package/docs/examples/databases/get-index.md +15 -0
  94. package/docs/examples/databases/get-usage.md +13 -0
  95. package/docs/examples/databases/get.md +13 -0
  96. package/docs/examples/databases/list-attributes.md +15 -0
  97. package/docs/examples/databases/list-collection-logs.md +15 -0
  98. package/docs/examples/databases/list-collections.md +15 -0
  99. package/docs/examples/databases/list-document-logs.md +16 -0
  100. package/docs/examples/databases/list-documents.md +15 -0
  101. package/docs/examples/databases/list-indexes.md +15 -0
  102. package/docs/examples/databases/list-logs.md +14 -0
  103. package/docs/examples/databases/list.md +14 -0
  104. package/docs/examples/databases/update-boolean-attribute.md +17 -0
  105. package/docs/examples/databases/update-collection.md +18 -0
  106. package/docs/examples/databases/update-datetime-attribute.md +17 -0
  107. package/docs/examples/databases/update-document.md +17 -0
  108. package/docs/examples/databases/update-email-attribute.md +17 -0
  109. package/docs/examples/databases/update-enum-attribute.md +18 -0
  110. package/docs/examples/databases/update-float-attribute.md +19 -0
  111. package/docs/examples/databases/update-integer-attribute.md +19 -0
  112. package/docs/examples/databases/update-ip-attribute.md +17 -0
  113. package/docs/examples/databases/update-relationship-attribute.md +16 -0
  114. package/docs/examples/databases/update-string-attribute.md +17 -0
  115. package/docs/examples/databases/update-url-attribute.md +17 -0
  116. package/docs/examples/databases/update.md +15 -0
  117. package/docs/examples/functions/create-build.md +15 -0
  118. package/docs/examples/functions/create-deployment.md +17 -0
  119. package/docs/examples/functions/create-execution.md +19 -0
  120. package/docs/examples/functions/create-variable.md +15 -0
  121. package/docs/examples/functions/create.md +34 -0
  122. package/docs/examples/functions/delete-deployment.md +14 -0
  123. package/docs/examples/functions/delete-execution.md +14 -0
  124. package/docs/examples/functions/delete-variable.md +14 -0
  125. package/docs/examples/functions/delete.md +13 -0
  126. package/docs/examples/functions/get-deployment-download.md +14 -0
  127. package/docs/examples/functions/get-deployment.md +14 -0
  128. package/docs/examples/functions/get-execution.md +14 -0
  129. package/docs/examples/functions/get-function-usage.md +14 -0
  130. package/docs/examples/functions/get-template.md +13 -0
  131. package/docs/examples/functions/get-usage.md +13 -0
  132. package/docs/examples/functions/get-variable.md +14 -0
  133. package/docs/examples/functions/get.md +13 -0
  134. package/docs/examples/functions/list-deployments.md +15 -0
  135. package/docs/examples/functions/list-executions.md +15 -0
  136. package/docs/examples/functions/list-runtimes.md +11 -0
  137. package/docs/examples/functions/list-specifications.md +11 -0
  138. package/docs/examples/functions/list-templates.md +16 -0
  139. package/docs/examples/functions/list-variables.md +13 -0
  140. package/docs/examples/functions/list.md +14 -0
  141. package/docs/examples/functions/update-deployment-build.md +14 -0
  142. package/docs/examples/functions/update-deployment.md +14 -0
  143. package/docs/examples/functions/update-variable.md +16 -0
  144. package/docs/examples/functions/update.md +30 -0
  145. package/docs/examples/graphql/mutation.md +13 -0
  146. package/docs/examples/graphql/query.md +13 -0
  147. package/docs/examples/health/get-antivirus.md +11 -0
  148. package/docs/examples/health/get-cache.md +11 -0
  149. package/docs/examples/health/get-certificate.md +13 -0
  150. package/docs/examples/health/get-d-b.md +11 -0
  151. package/docs/examples/health/get-failed-jobs.md +14 -0
  152. package/docs/examples/health/get-pub-sub.md +11 -0
  153. package/docs/examples/health/get-queue-builds.md +13 -0
  154. package/docs/examples/health/get-queue-certificates.md +13 -0
  155. package/docs/examples/health/get-queue-databases.md +14 -0
  156. package/docs/examples/health/get-queue-deletes.md +13 -0
  157. package/docs/examples/health/get-queue-functions.md +13 -0
  158. package/docs/examples/health/get-queue-logs.md +13 -0
  159. package/docs/examples/health/get-queue-mails.md +13 -0
  160. package/docs/examples/health/get-queue-messaging.md +13 -0
  161. package/docs/examples/health/get-queue-migrations.md +13 -0
  162. package/docs/examples/health/get-queue-usage-dump.md +13 -0
  163. package/docs/examples/health/get-queue-usage.md +13 -0
  164. package/docs/examples/health/get-queue-webhooks.md +13 -0
  165. package/docs/examples/health/get-queue.md +11 -0
  166. package/docs/examples/health/get-storage-local.md +11 -0
  167. package/docs/examples/health/get-storage.md +11 -0
  168. package/docs/examples/health/get-time.md +11 -0
  169. package/docs/examples/health/get.md +11 -0
  170. package/docs/examples/locale/get.md +11 -0
  171. package/docs/examples/locale/list-codes.md +11 -0
  172. package/docs/examples/locale/list-continents.md +11 -0
  173. package/docs/examples/locale/list-countries-e-u.md +11 -0
  174. package/docs/examples/locale/list-countries-phones.md +11 -0
  175. package/docs/examples/locale/list-countries.md +11 -0
  176. package/docs/examples/locale/list-currencies.md +11 -0
  177. package/docs/examples/locale/list-languages.md +11 -0
  178. package/docs/examples/messaging/create-apns-provider.md +20 -0
  179. package/docs/examples/messaging/create-email.md +24 -0
  180. package/docs/examples/messaging/create-fcm-provider.md +16 -0
  181. package/docs/examples/messaging/create-mailgun-provider.md +22 -0
  182. package/docs/examples/messaging/create-msg91provider.md +18 -0
  183. package/docs/examples/messaging/create-push.md +28 -0
  184. package/docs/examples/messaging/create-sendgrid-provider.md +20 -0
  185. package/docs/examples/messaging/create-sms.md +19 -0
  186. package/docs/examples/messaging/create-smtp-provider.md +26 -0
  187. package/docs/examples/messaging/create-subscriber.md +15 -0
  188. package/docs/examples/messaging/create-telesign-provider.md +18 -0
  189. package/docs/examples/messaging/create-textmagic-provider.md +18 -0
  190. package/docs/examples/messaging/create-topic.md +15 -0
  191. package/docs/examples/messaging/create-twilio-provider.md +18 -0
  192. package/docs/examples/messaging/create-vonage-provider.md +18 -0
  193. package/docs/examples/messaging/delete-provider.md +13 -0
  194. package/docs/examples/messaging/delete-subscriber.md +14 -0
  195. package/docs/examples/messaging/delete-topic.md +13 -0
  196. package/docs/examples/messaging/delete.md +13 -0
  197. package/docs/examples/messaging/get-message.md +13 -0
  198. package/docs/examples/messaging/get-provider.md +13 -0
  199. package/docs/examples/messaging/get-subscriber.md +14 -0
  200. package/docs/examples/messaging/get-topic.md +13 -0
  201. package/docs/examples/messaging/list-message-logs.md +14 -0
  202. package/docs/examples/messaging/list-messages.md +14 -0
  203. package/docs/examples/messaging/list-provider-logs.md +14 -0
  204. package/docs/examples/messaging/list-providers.md +14 -0
  205. package/docs/examples/messaging/list-subscriber-logs.md +14 -0
  206. package/docs/examples/messaging/list-subscribers.md +15 -0
  207. package/docs/examples/messaging/list-targets.md +14 -0
  208. package/docs/examples/messaging/list-topic-logs.md +14 -0
  209. package/docs/examples/messaging/list-topics.md +14 -0
  210. package/docs/examples/messaging/update-apns-provider.md +20 -0
  211. package/docs/examples/messaging/update-email.md +24 -0
  212. package/docs/examples/messaging/update-fcm-provider.md +16 -0
  213. package/docs/examples/messaging/update-mailgun-provider.md +22 -0
  214. package/docs/examples/messaging/update-msg91provider.md +18 -0
  215. package/docs/examples/messaging/update-push.md +28 -0
  216. package/docs/examples/messaging/update-sendgrid-provider.md +20 -0
  217. package/docs/examples/messaging/update-sms.md +19 -0
  218. package/docs/examples/messaging/update-smtp-provider.md +26 -0
  219. package/docs/examples/messaging/update-telesign-provider.md +18 -0
  220. package/docs/examples/messaging/update-textmagic-provider.md +18 -0
  221. package/docs/examples/messaging/update-topic.md +15 -0
  222. package/docs/examples/messaging/update-twilio-provider.md +18 -0
  223. package/docs/examples/messaging/update-vonage-provider.md +18 -0
  224. package/docs/examples/migrations/create-appwrite-migration.md +16 -0
  225. package/docs/examples/migrations/create-firebase-migration.md +14 -0
  226. package/docs/examples/migrations/create-firebase-o-auth-migration.md +14 -0
  227. package/docs/examples/migrations/create-n-host-migration.md +20 -0
  228. package/docs/examples/migrations/create-supabase-migration.md +19 -0
  229. package/docs/examples/migrations/delete-firebase-auth.md +11 -0
  230. package/docs/examples/migrations/delete.md +13 -0
  231. package/docs/examples/migrations/get-appwrite-report.md +16 -0
  232. package/docs/examples/migrations/get-firebase-report-o-auth.md +14 -0
  233. package/docs/examples/migrations/get-firebase-report.md +14 -0
  234. package/docs/examples/migrations/get-n-host-report.md +20 -0
  235. package/docs/examples/migrations/get-supabase-report.md +19 -0
  236. package/docs/examples/migrations/get.md +13 -0
  237. package/docs/examples/migrations/list-firebase-projects.md +11 -0
  238. package/docs/examples/migrations/list.md +14 -0
  239. package/docs/examples/migrations/retry.md +13 -0
  240. package/docs/examples/project/create-variable.md +14 -0
  241. package/docs/examples/project/delete-variable.md +13 -0
  242. package/docs/examples/project/get-usage.md +15 -0
  243. package/docs/examples/project/get-variable.md +13 -0
  244. package/docs/examples/project/list-variables.md +11 -0
  245. package/docs/examples/project/update-variable.md +15 -0
  246. package/docs/examples/projects/create-j-w-t.md +15 -0
  247. package/docs/examples/projects/create-key.md +16 -0
  248. package/docs/examples/projects/create-platform.md +18 -0
  249. package/docs/examples/projects/create-smtp-test.md +22 -0
  250. package/docs/examples/projects/create-webhook.md +20 -0
  251. package/docs/examples/projects/create.md +25 -0
  252. package/docs/examples/projects/delete-email-template.md +15 -0
  253. package/docs/examples/projects/delete-key.md +14 -0
  254. package/docs/examples/projects/delete-platform.md +14 -0
  255. package/docs/examples/projects/delete-sms-template.md +15 -0
  256. package/docs/examples/projects/delete-webhook.md +14 -0
  257. package/docs/examples/projects/delete.md +13 -0
  258. package/docs/examples/projects/get-email-template.md +15 -0
  259. package/docs/examples/projects/get-key.md +14 -0
  260. package/docs/examples/projects/get-platform.md +14 -0
  261. package/docs/examples/projects/get-sms-template.md +15 -0
  262. package/docs/examples/projects/get-webhook.md +14 -0
  263. package/docs/examples/projects/get.md +13 -0
  264. package/docs/examples/projects/list-keys.md +13 -0
  265. package/docs/examples/projects/list-platforms.md +13 -0
  266. package/docs/examples/projects/list-webhooks.md +13 -0
  267. package/docs/examples/projects/list.md +14 -0
  268. package/docs/examples/projects/update-api-status-all.md +14 -0
  269. package/docs/examples/projects/update-api-status.md +15 -0
  270. package/docs/examples/projects/update-auth-duration.md +14 -0
  271. package/docs/examples/projects/update-auth-limit.md +14 -0
  272. package/docs/examples/projects/update-auth-password-dictionary.md +14 -0
  273. package/docs/examples/projects/update-auth-password-history.md +14 -0
  274. package/docs/examples/projects/update-auth-sessions-limit.md +14 -0
  275. package/docs/examples/projects/update-auth-status.md +15 -0
  276. package/docs/examples/projects/update-email-template.md +20 -0
  277. package/docs/examples/projects/update-key.md +17 -0
  278. package/docs/examples/projects/update-mock-numbers.md +14 -0
  279. package/docs/examples/projects/update-o-auth2.md +17 -0
  280. package/docs/examples/projects/update-personal-data-check.md +14 -0
  281. package/docs/examples/projects/update-platform.md +18 -0
  282. package/docs/examples/projects/update-service-status-all.md +14 -0
  283. package/docs/examples/projects/update-service-status.md +15 -0
  284. package/docs/examples/projects/update-session-alerts.md +14 -0
  285. package/docs/examples/projects/update-sms-template.md +16 -0
  286. package/docs/examples/projects/update-smtp.md +22 -0
  287. package/docs/examples/projects/update-team.md +14 -0
  288. package/docs/examples/projects/update-webhook-signature.md +14 -0
  289. package/docs/examples/projects/update-webhook.md +21 -0
  290. package/docs/examples/projects/update.md +23 -0
  291. package/docs/examples/proxy/create-rule.md +15 -0
  292. package/docs/examples/proxy/delete-rule.md +13 -0
  293. package/docs/examples/proxy/get-rule.md +13 -0
  294. package/docs/examples/proxy/list-rules.md +14 -0
  295. package/docs/examples/proxy/update-rule-verification.md +13 -0
  296. package/docs/examples/storage/create-bucket.md +22 -0
  297. package/docs/examples/storage/create-file.md +16 -0
  298. package/docs/examples/storage/delete-bucket.md +13 -0
  299. package/docs/examples/storage/delete-file.md +14 -0
  300. package/docs/examples/storage/get-bucket-usage.md +14 -0
  301. package/docs/examples/storage/get-bucket.md +13 -0
  302. package/docs/examples/storage/get-file-download.md +14 -0
  303. package/docs/examples/storage/get-file-preview.md +25 -0
  304. package/docs/examples/storage/get-file-view.md +14 -0
  305. package/docs/examples/storage/get-file.md +14 -0
  306. package/docs/examples/storage/get-usage.md +13 -0
  307. package/docs/examples/storage/list-buckets.md +14 -0
  308. package/docs/examples/storage/list-files.md +15 -0
  309. package/docs/examples/storage/update-bucket.md +22 -0
  310. package/docs/examples/storage/update-file.md +16 -0
  311. package/docs/examples/teams/create-membership.md +19 -0
  312. package/docs/examples/teams/create.md +15 -0
  313. package/docs/examples/teams/delete-membership.md +14 -0
  314. package/docs/examples/teams/delete.md +13 -0
  315. package/docs/examples/teams/get-membership.md +14 -0
  316. package/docs/examples/teams/get-prefs.md +13 -0
  317. package/docs/examples/teams/get.md +13 -0
  318. package/docs/examples/teams/list-logs.md +14 -0
  319. package/docs/examples/teams/list-memberships.md +15 -0
  320. package/docs/examples/teams/list.md +14 -0
  321. package/docs/examples/teams/update-membership-status.md +16 -0
  322. package/docs/examples/teams/update-membership.md +15 -0
  323. package/docs/examples/teams/update-name.md +14 -0
  324. package/docs/examples/teams/update-prefs.md +14 -0
  325. package/docs/examples/users/create-argon2user.md +16 -0
  326. package/docs/examples/users/create-bcrypt-user.md +16 -0
  327. package/docs/examples/users/create-j-w-t.md +15 -0
  328. package/docs/examples/users/create-m-d5user.md +16 -0
  329. package/docs/examples/users/create-mfa-recovery-codes.md +13 -0
  330. package/docs/examples/users/create-p-h-pass-user.md +16 -0
  331. package/docs/examples/users/create-s-h-a-user.md +17 -0
  332. package/docs/examples/users/create-scrypt-modified-user.md +19 -0
  333. package/docs/examples/users/create-scrypt-user.md +21 -0
  334. package/docs/examples/users/create-session.md +13 -0
  335. package/docs/examples/users/create-target.md +18 -0
  336. package/docs/examples/users/create-token.md +15 -0
  337. package/docs/examples/users/create.md +17 -0
  338. package/docs/examples/users/delete-identity.md +13 -0
  339. package/docs/examples/users/delete-mfa-authenticator.md +14 -0
  340. package/docs/examples/users/delete-session.md +14 -0
  341. package/docs/examples/users/delete-sessions.md +13 -0
  342. package/docs/examples/users/delete-target.md +14 -0
  343. package/docs/examples/users/delete.md +13 -0
  344. package/docs/examples/users/get-mfa-recovery-codes.md +13 -0
  345. package/docs/examples/users/get-prefs.md +13 -0
  346. package/docs/examples/users/get-target.md +14 -0
  347. package/docs/examples/users/get-usage.md +13 -0
  348. package/docs/examples/users/get.md +13 -0
  349. package/docs/examples/users/list-identities.md +14 -0
  350. package/docs/examples/users/list-logs.md +14 -0
  351. package/docs/examples/users/list-memberships.md +13 -0
  352. package/docs/examples/users/list-mfa-factors.md +13 -0
  353. package/docs/examples/users/list-sessions.md +13 -0
  354. package/docs/examples/users/list-targets.md +14 -0
  355. package/docs/examples/users/list.md +14 -0
  356. package/docs/examples/users/update-email-verification.md +14 -0
  357. package/docs/examples/users/update-email.md +14 -0
  358. package/docs/examples/users/update-labels.md +14 -0
  359. package/docs/examples/users/update-mfa-recovery-codes.md +13 -0
  360. package/docs/examples/users/update-mfa.md +14 -0
  361. package/docs/examples/users/update-name.md +14 -0
  362. package/docs/examples/users/update-password.md +14 -0
  363. package/docs/examples/users/update-phone-verification.md +14 -0
  364. package/docs/examples/users/update-phone.md +14 -0
  365. package/docs/examples/users/update-prefs.md +14 -0
  366. package/docs/examples/users/update-status.md +14 -0
  367. package/docs/examples/users/update-target.md +17 -0
  368. package/docs/examples/vcs/create-repository-detection.md +15 -0
  369. package/docs/examples/vcs/create-repository.md +15 -0
  370. package/docs/examples/vcs/delete-installation.md +13 -0
  371. package/docs/examples/vcs/get-installation.md +13 -0
  372. package/docs/examples/vcs/get-repository-contents.md +15 -0
  373. package/docs/examples/vcs/get-repository.md +14 -0
  374. package/docs/examples/vcs/list-installations.md +14 -0
  375. package/docs/examples/vcs/list-repositories.md +14 -0
  376. package/docs/examples/vcs/list-repository-branches.md +14 -0
  377. package/docs/examples/vcs/update-external-deployments.md +15 -0
  378. package/package.json +42 -0
  379. package/publish.sh +4 -0
  380. package/rollup.config.js +27 -0
  381. package/src/Cache/Adapter.ts +11 -0
  382. package/src/Cache/Adapters/Filesystem.ts +126 -0
  383. package/src/Cache/Adapters/Memory.ts +57 -0
  384. package/src/Cache/Adapters/None.ts +36 -0
  385. package/src/Cache/Adapters/Redis.ts +106 -0
  386. package/src/Cache/Adapters/Sharding.ts +87 -0
  387. package/src/Cache/Cache.ts +75 -0
  388. package/src/Cache/index.ts +5 -0
  389. package/src/Cache/test.ts +0 -0
  390. package/src/Services.ts +41 -0
  391. package/src/client.ts +397 -0
  392. package/src/decorators/Cache.ts +102 -0
  393. package/src/decorators/CacheKey.ts +9 -0
  394. package/src/decorators/Invalidate.ts +68 -0
  395. package/src/enums/api-service.ts +13 -0
  396. package/src/enums/api.ts +5 -0
  397. package/src/enums/auth-method.ts +9 -0
  398. package/src/enums/authentication-factor.ts +6 -0
  399. package/src/enums/authenticator-type.ts +3 -0
  400. package/src/enums/browser.ts +16 -0
  401. package/src/enums/compression.ts +5 -0
  402. package/src/enums/credit-card.ts +18 -0
  403. package/src/enums/database-usage-range.ts +5 -0
  404. package/src/enums/email-template-locale.ts +133 -0
  405. package/src/enums/email-template-type.ts +9 -0
  406. package/src/enums/entities/EntityLimitType.ts +4 -0
  407. package/src/enums/entities/PropertyAttributeName.ts +27 -0
  408. package/src/enums/entities/PropertyCondition.ts +8 -0
  409. package/src/enums/entities/PropertyType.ts +16 -0
  410. package/src/enums/entities/PropertyValueType.ts +6 -0
  411. package/src/enums/entities/RowAccess.ts +2 -0
  412. package/src/enums/entities/ViewFilterCondition.ts +12 -0
  413. package/src/enums/execution-method.ts +8 -0
  414. package/src/enums/flag.ts +197 -0
  415. package/src/enums/function-usage-range.ts +5 -0
  416. package/src/enums/image-format.ts +7 -0
  417. package/src/enums/image-gravity.ts +11 -0
  418. package/src/enums/index-type.ts +5 -0
  419. package/src/enums/messaging-provider-type.ts +5 -0
  420. package/src/enums/name.ts +14 -0
  421. package/src/enums/o-auth-provider copy.ts +41 -0
  422. package/src/enums/o-auth-provider.ts +41 -0
  423. package/src/enums/password-hash.ts +13 -0
  424. package/src/enums/platform-type.ts +17 -0
  425. package/src/enums/project-usage-range.ts +4 -0
  426. package/src/enums/region.ts +4 -0
  427. package/src/enums/relation-mutate.ts +5 -0
  428. package/src/enums/relationship-type.ts +6 -0
  429. package/src/enums/resource-type.ts +4 -0
  430. package/src/enums/runtime.ts +48 -0
  431. package/src/enums/s-m-t-p-secure.ts +3 -0
  432. package/src/enums/shared/ApplicationLayout.ts +4 -0
  433. package/src/enums/shared/Colors.ts +24 -0
  434. package/src/enums/shared/InputType.ts +6 -0
  435. package/src/enums/shared/Periodicity.ts +7 -0
  436. package/src/enums/shared/SvgIcon.ts +37 -0
  437. package/src/enums/shared/Theme.ts +4 -0
  438. package/src/enums/sms-template-locale.ts +133 -0
  439. package/src/enums/sms-template-type.ts +6 -0
  440. package/src/enums/smtp-encryption.ts +5 -0
  441. package/src/enums/storage-usage-range.ts +5 -0
  442. package/src/enums/subscriptions/PricingModel.ts +14 -0
  443. package/src/enums/subscriptions/SubscriptionBillingPeriod.ts +15 -0
  444. package/src/enums/subscriptions/SubscriptionFeatureLimitType.ts +16 -0
  445. package/src/enums/subscriptions/SubscriptionPriceType.ts +10 -0
  446. package/src/enums/tenants/LinkedAccountStatus.ts +5 -0
  447. package/src/enums/tenants/TenantUserJoined.ts +6 -0
  448. package/src/enums/tenants/TenantUserStatus.ts +6 -0
  449. package/src/enums/tenants/TenantUserType.ts +5 -0
  450. package/src/enums/user-usage-range.ts +5 -0
  451. package/src/id.ts +47 -0
  452. package/src/index.ts +36 -0
  453. package/src/inputFile.ts +23 -0
  454. package/src/lib/Registry/Registry.ts +66 -0
  455. package/src/lib/Registry/index.ts +1 -0
  456. package/src/models.ts +3339 -0
  457. package/src/permission.ts +57 -0
  458. package/src/query.ts +261 -0
  459. package/src/role.ts +100 -0
  460. package/src/service-client.ts +29 -0
  461. package/src/service.ts +30 -0
  462. package/src/services/account.ts +1643 -0
  463. package/src/services/applets.ts +75 -0
  464. package/src/services/avatars.ts +314 -0
  465. package/src/services/community.ts +102 -0
  466. package/src/services/configuration.ts +15 -0
  467. package/src/services/databases.ts +2037 -0
  468. package/src/services/functions.ts +986 -0
  469. package/src/services/graphql.ts +75 -0
  470. package/src/services/health.ts +629 -0
  471. package/src/services/locale.ts +205 -0
  472. package/src/services/messaging.ts +2247 -0
  473. package/src/services/node.ts +15 -0
  474. package/src/services/permissions.ts +131 -0
  475. package/src/services/pricing.ts +30 -0
  476. package/src/services/projects.ts +1901 -0
  477. package/src/services/roles.ts +101 -0
  478. package/src/services/schema.ts +65 -0
  479. package/src/services/storage.ts +576 -0
  480. package/src/services/subscription.ts +40 -0
  481. package/src/services/teams.ts +490 -0
  482. package/src/services/tenant-subscription.ts +93 -0
  483. package/src/services/tenant.ts +194 -0
  484. package/src/services/users.ts +1584 -0
  485. package/tsconfig.json +29 -0
  486. package/types/Cache/Adapter.d.ts +10 -0
  487. package/types/Cache/Adapters/Filesystem.d.ts +16 -0
  488. package/types/Cache/Adapters/Memory.d.ts +18 -0
  489. package/types/Cache/Adapters/None.d.ts +12 -0
  490. package/types/Cache/Adapters/Redis.d.ts +14 -0
  491. package/types/Cache/Adapters/Sharding.d.ts +17 -0
  492. package/types/Cache/Cache.d.ts +16 -0
  493. package/types/Cache/index.d.ts +5 -0
  494. package/types/Cache/test.d.ts +0 -0
  495. package/types/Services.d.ts +6 -0
  496. package/types/client.d.ts +141 -0
  497. package/types/decorators/Cache.d.ts +1 -0
  498. package/types/decorators/CacheKey.d.ts +1 -0
  499. package/types/decorators/Invalidate.d.ts +1 -0
  500. package/types/enums/api-service.d.ts +13 -0
  501. package/types/enums/api.d.ts +5 -0
  502. package/types/enums/auth-method.d.ts +9 -0
  503. package/types/enums/authentication-factor.d.ts +6 -0
  504. package/types/enums/authenticator-type.d.ts +3 -0
  505. package/types/enums/browser.d.ts +16 -0
  506. package/types/enums/compression.d.ts +5 -0
  507. package/types/enums/credit-card.d.ts +18 -0
  508. package/types/enums/database-usage-range.d.ts +5 -0
  509. package/types/enums/email-template-locale.d.ts +133 -0
  510. package/types/enums/email-template-type.d.ts +9 -0
  511. package/types/enums/entities/EntityLimitType.d.ts +4 -0
  512. package/types/enums/entities/PropertyAttributeName.d.ts +27 -0
  513. package/types/enums/entities/PropertyCondition.d.ts +7 -0
  514. package/types/enums/entities/PropertyType.d.ts +12 -0
  515. package/types/enums/entities/PropertyValueType.d.ts +6 -0
  516. package/types/enums/entities/RowAccess.d.ts +2 -0
  517. package/types/enums/entities/ViewFilterCondition.d.ts +12 -0
  518. package/types/enums/execution-method.d.ts +8 -0
  519. package/types/enums/flag.d.ts +197 -0
  520. package/types/enums/function-usage-range.d.ts +5 -0
  521. package/types/enums/image-format.d.ts +7 -0
  522. package/types/enums/image-gravity.d.ts +11 -0
  523. package/types/enums/index-type.d.ts +5 -0
  524. package/types/enums/messaging-provider-type.d.ts +5 -0
  525. package/types/enums/name.d.ts +14 -0
  526. package/types/enums/o-auth-provider copy.d.ts +41 -0
  527. package/types/enums/o-auth-provider.d.ts +41 -0
  528. package/types/enums/password-hash.d.ts +13 -0
  529. package/types/enums/platform-type.d.ts +17 -0
  530. package/types/enums/project-usage-range.d.ts +4 -0
  531. package/types/enums/region.d.ts +4 -0
  532. package/types/enums/relation-mutate.d.ts +5 -0
  533. package/types/enums/relationship-type.d.ts +6 -0
  534. package/types/enums/resource-type.d.ts +4 -0
  535. package/types/enums/runtime.d.ts +48 -0
  536. package/types/enums/s-m-t-p-secure.d.ts +3 -0
  537. package/types/enums/shared/ApplicationLayout.d.ts +4 -0
  538. package/types/enums/shared/Colors.d.ts +24 -0
  539. package/types/enums/shared/InputType.d.ts +6 -0
  540. package/types/enums/shared/Periodicity.d.ts +7 -0
  541. package/types/enums/shared/SvgIcon.d.ts +37 -0
  542. package/types/enums/shared/Theme.d.ts +4 -0
  543. package/types/enums/sms-template-locale.d.ts +133 -0
  544. package/types/enums/sms-template-type.d.ts +6 -0
  545. package/types/enums/smtp-encryption.d.ts +5 -0
  546. package/types/enums/storage-usage-range.d.ts +5 -0
  547. package/types/enums/subscriptions/PricingModel.d.ts +11 -0
  548. package/types/enums/subscriptions/SubscriptionBillingPeriod.d.ts +10 -0
  549. package/types/enums/subscriptions/SubscriptionFeatureLimitType.d.ts +10 -0
  550. package/types/enums/subscriptions/SubscriptionPriceType.d.ts +7 -0
  551. package/types/enums/tenants/LinkedAccountStatus.d.ts +5 -0
  552. package/types/enums/tenants/TenantUserJoined.d.ts +6 -0
  553. package/types/enums/tenants/TenantUserStatus.d.ts +6 -0
  554. package/types/enums/tenants/TenantUserType.d.ts +5 -0
  555. package/types/enums/user-usage-range.d.ts +5 -0
  556. package/types/id.d.ts +20 -0
  557. package/types/index.d.ts +36 -0
  558. package/types/inputFile.d.ts +6 -0
  559. package/types/lib/Registry/Registry.d.ts +38 -0
  560. package/types/lib/Registry/index.d.ts +1 -0
  561. package/types/models.d.ts +3272 -0
  562. package/types/permission.d.ts +43 -0
  563. package/types/query.d.ts +194 -0
  564. package/types/role.d.ts +70 -0
  565. package/types/service-client.d.ts +7 -0
  566. package/types/service.d.ts +11 -0
  567. package/types/services/account.d.ts +530 -0
  568. package/types/services/acl.d.ts +28 -0
  569. package/types/services/applets.d.ts +9 -0
  570. package/types/services/assistant.d.ts +14 -0
  571. package/types/services/avatars.d.ts +115 -0
  572. package/types/services/community.d.ts +19 -0
  573. package/types/services/configuration.d.ts +5 -0
  574. package/types/services/console.d.ts +15 -0
  575. package/types/services/databases.d.ts +613 -0
  576. package/types/services/functions.d.ts +319 -0
  577. package/types/services/graphql.d.ts +25 -0
  578. package/types/services/health.d.ts +231 -0
  579. package/types/services/locale.d.ts +80 -0
  580. package/types/services/messaging.d.ts +685 -0
  581. package/types/services/migrations.d.ts +185 -0
  582. package/types/services/node.d.ts +5 -0
  583. package/types/services/permissions.d.ts +20 -0
  584. package/types/services/pricing.d.ts +15 -0
  585. package/types/services/project.d.ts +70 -0
  586. package/types/services/projects.d.ts +542 -0
  587. package/types/services/proxy.d.ts +59 -0
  588. package/types/services/roles.d.ts +19 -0
  589. package/types/services/schema.d.ts +17 -0
  590. package/types/services/storage.d.ts +189 -0
  591. package/types/services/subscription-product.d.ts +77 -0
  592. package/types/services/subscription.d.ts +15 -0
  593. package/types/services/teams.d.ts +167 -0
  594. package/types/services/tenant-subscription.d.ts +12 -0
  595. package/types/services/tenant.d.ts +32 -0
  596. package/types/services/users.d.ts +499 -0
  597. package/types/services/vcs.d.ts +108 -0
package/src/models.ts ADDED
@@ -0,0 +1,3339 @@
1
+ /**
2
+ * Appconda Models
3
+ */
4
+ export namespace Models {
5
+ /**
6
+ * Documents List
7
+ */
8
+ export type DocumentList<Document extends Models.Document> = {
9
+ /**
10
+ * Total number of documents documents that matched your query.
11
+ */
12
+ total: number;
13
+ /**
14
+ * List of documents.
15
+ */
16
+ documents: Document[];
17
+ }
18
+ /**
19
+ * Collections List
20
+ */
21
+ export type CollectionList = {
22
+ /**
23
+ * Total number of collections documents that matched your query.
24
+ */
25
+ total: number;
26
+ /**
27
+ * List of collections.
28
+ */
29
+ collections: Collection[];
30
+ }
31
+
32
+ export type SmsTemplate = {
33
+ /**
34
+ * Template type
35
+ */
36
+ type: string;
37
+ /**
38
+ * Template locale
39
+ */
40
+ locale: string;
41
+ /**
42
+ * Template message
43
+ */
44
+ message: string;
45
+ }
46
+
47
+ /**
48
+ * Databases List
49
+ */
50
+ export type DatabaseList = {
51
+ /**
52
+ * Total number of databases documents that matched your query.
53
+ */
54
+ total: number;
55
+ /**
56
+ * List of databases.
57
+ */
58
+ databases: Database[];
59
+ }
60
+ /**
61
+ * Indexes List
62
+ */
63
+ export type IndexList = {
64
+ /**
65
+ * Total number of indexes documents that matched your query.
66
+ */
67
+ total: number;
68
+ /**
69
+ * List of indexes.
70
+ */
71
+ indexes: Index[];
72
+ }
73
+ /**
74
+ * Users List
75
+ */
76
+ export type UserList<Preferences extends Models.Preferences> = {
77
+ /**
78
+ * Total number of users documents that matched your query.
79
+ */
80
+ total: number;
81
+ /**
82
+ * List of users.
83
+ */
84
+ users: User<Preferences>[];
85
+ }
86
+ /**
87
+ * Sessions List
88
+ */
89
+ export type SessionList = {
90
+ /**
91
+ * Total number of sessions documents that matched your query.
92
+ */
93
+ total: number;
94
+ /**
95
+ * List of sessions.
96
+ */
97
+ sessions: Session[];
98
+ }
99
+ /**
100
+ * Identities List
101
+ */
102
+ export type IdentityList = {
103
+ /**
104
+ * Total number of identities documents that matched your query.
105
+ */
106
+ total: number;
107
+ /**
108
+ * List of identities.
109
+ */
110
+ identities: Identity[];
111
+ }
112
+ /**
113
+ * Logs List
114
+ */
115
+ export type LogList = {
116
+ /**
117
+ * Total number of logs documents that matched your query.
118
+ */
119
+ total: number;
120
+ /**
121
+ * List of logs.
122
+ */
123
+ logs: Log[];
124
+ }
125
+ /**
126
+ * Files List
127
+ */
128
+ export type FileList = {
129
+ /**
130
+ * Total number of files documents that matched your query.
131
+ */
132
+ total: number;
133
+ /**
134
+ * List of files.
135
+ */
136
+ files: File[];
137
+ }
138
+ /**
139
+ * Buckets List
140
+ */
141
+ export type BucketList = {
142
+ /**
143
+ * Total number of buckets documents that matched your query.
144
+ */
145
+ total: number;
146
+ /**
147
+ * List of buckets.
148
+ */
149
+ buckets: Bucket[];
150
+ }
151
+ /**
152
+ * Teams List
153
+ */
154
+ export type TeamList<Preferences extends Models.Preferences> = {
155
+ /**
156
+ * Total number of teams documents that matched your query.
157
+ */
158
+ total: number;
159
+ /**
160
+ * List of teams.
161
+ */
162
+ teams: Team<Preferences>[];
163
+ }
164
+ /**
165
+ * Memberships List
166
+ */
167
+ export type MembershipList = {
168
+ /**
169
+ * Total number of memberships documents that matched your query.
170
+ */
171
+ total: number;
172
+ /**
173
+ * List of memberships.
174
+ */
175
+ memberships: Membership[];
176
+ }
177
+ /**
178
+ * Functions List
179
+ */
180
+ export type FunctionList = {
181
+ /**
182
+ * Total number of functions documents that matched your query.
183
+ */
184
+ total: number;
185
+ /**
186
+ * List of functions.
187
+ */
188
+ functions: Function[];
189
+ }
190
+ /**
191
+ * Runtimes List
192
+ */
193
+ export type RuntimeList = {
194
+ /**
195
+ * Total number of runtimes documents that matched your query.
196
+ */
197
+ total: number;
198
+ /**
199
+ * List of runtimes.
200
+ */
201
+ runtimes: Runtime[];
202
+ }
203
+ /**
204
+ * Deployments List
205
+ */
206
+ export type DeploymentList = {
207
+ /**
208
+ * Total number of deployments documents that matched your query.
209
+ */
210
+ total: number;
211
+ /**
212
+ * List of deployments.
213
+ */
214
+ deployments: Deployment[];
215
+ }
216
+ /**
217
+ * Executions List
218
+ */
219
+ export type ExecutionList = {
220
+ /**
221
+ * Total number of executions documents that matched your query.
222
+ */
223
+ total: number;
224
+ /**
225
+ * List of executions.
226
+ */
227
+ executions: Execution[];
228
+ }
229
+ /**
230
+ * Countries List
231
+ */
232
+ export type CountryList = {
233
+ /**
234
+ * Total number of countries documents that matched your query.
235
+ */
236
+ total: number;
237
+ /**
238
+ * List of countries.
239
+ */
240
+ countries: Country[];
241
+ }
242
+ /**
243
+ * Continents List
244
+ */
245
+ export type ContinentList = {
246
+ /**
247
+ * Total number of continents documents that matched your query.
248
+ */
249
+ total: number;
250
+ /**
251
+ * List of continents.
252
+ */
253
+ continents: Continent[];
254
+ }
255
+ /**
256
+ * Languages List
257
+ */
258
+ export type LanguageList = {
259
+ /**
260
+ * Total number of languages documents that matched your query.
261
+ */
262
+ total: number;
263
+ /**
264
+ * List of languages.
265
+ */
266
+ languages: Language[];
267
+ }
268
+ /**
269
+ * Currencies List
270
+ */
271
+ export type CurrencyList = {
272
+ /**
273
+ * Total number of currencies documents that matched your query.
274
+ */
275
+ total: number;
276
+ /**
277
+ * List of currencies.
278
+ */
279
+ currencies: Currency[];
280
+ }
281
+ /**
282
+ * Phones List
283
+ */
284
+ export type PhoneList = {
285
+ /**
286
+ * Total number of phones documents that matched your query.
287
+ */
288
+ total: number;
289
+ /**
290
+ * List of phones.
291
+ */
292
+ phones: Phone[];
293
+ }
294
+ /**
295
+ * Variables List
296
+ */
297
+ export type VariableList = {
298
+ /**
299
+ * Total number of variables documents that matched your query.
300
+ */
301
+ total: number;
302
+ /**
303
+ * List of variables.
304
+ */
305
+ variables: Variable[];
306
+ }
307
+ /**
308
+ * Locale codes list
309
+ */
310
+ export type LocaleCodeList = {
311
+ /**
312
+ * Total number of localeCodes documents that matched your query.
313
+ */
314
+ total: number;
315
+ /**
316
+ * List of localeCodes.
317
+ */
318
+ localeCodes: LocaleCode[];
319
+ }
320
+ /**
321
+ * Provider list
322
+ */
323
+ export type ProviderList = {
324
+ /**
325
+ * Total number of providers documents that matched your query.
326
+ */
327
+ total: number;
328
+ /**
329
+ * List of providers.
330
+ */
331
+ providers: Provider[];
332
+ }
333
+ /**
334
+ * Message list
335
+ */
336
+ export type MessageList = {
337
+ /**
338
+ * Total number of messages documents that matched your query.
339
+ */
340
+ total: number;
341
+ /**
342
+ * List of messages.
343
+ */
344
+ messages: Message[];
345
+ }
346
+ /**
347
+ * Topic list
348
+ */
349
+ export type TopicList = {
350
+ /**
351
+ * Total number of topics documents that matched your query.
352
+ */
353
+ total: number;
354
+ /**
355
+ * List of topics.
356
+ */
357
+ topics: Topic[];
358
+ }
359
+ /**
360
+ * Subscriber list
361
+ */
362
+ export type SubscriberList = {
363
+ /**
364
+ * Total number of subscribers documents that matched your query.
365
+ */
366
+ total: number;
367
+ /**
368
+ * List of subscribers.
369
+ */
370
+ subscribers: Subscriber[];
371
+ }
372
+ /**
373
+ * Target list
374
+ */
375
+ export type TargetList = {
376
+ /**
377
+ * Total number of targets documents that matched your query.
378
+ */
379
+ total: number;
380
+ /**
381
+ * List of targets.
382
+ */
383
+ targets: Target[];
384
+ }
385
+ /**
386
+ * Specifications List
387
+ */
388
+ export type SpecificationList = {
389
+ /**
390
+ * Total number of specifications documents that matched your query.
391
+ */
392
+ total: number;
393
+ /**
394
+ * List of specifications.
395
+ */
396
+ specifications: Specification[];
397
+ }
398
+ /**
399
+ * Database
400
+ */
401
+ export type Database = {
402
+ /**
403
+ * Database ID.
404
+ */
405
+ $id: string;
406
+ /**
407
+ * Database name.
408
+ */
409
+ name: string;
410
+ /**
411
+ * Database creation date in ISO 8601 format.
412
+ */
413
+ $createdAt: string;
414
+ /**
415
+ * Database update date in ISO 8601 format.
416
+ */
417
+ $updatedAt: string;
418
+ /**
419
+ * If database is enabled. Can be &#039;enabled&#039; or &#039;disabled&#039;. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys.
420
+ */
421
+ enabled: boolean;
422
+ }
423
+ /**
424
+ * Collection
425
+ */
426
+ export type Collection = {
427
+ /**
428
+ * Collection ID.
429
+ */
430
+ $id: string;
431
+ /**
432
+ * Collection creation date in ISO 8601 format.
433
+ */
434
+ $createdAt: string;
435
+ /**
436
+ * Collection update date in ISO 8601 format.
437
+ */
438
+ $updatedAt: string;
439
+ /**
440
+ * Collection permissions. [Learn more about permissions](https://appconda.io/docs/permissions).
441
+ */
442
+ $permissions: string[];
443
+ /**
444
+ * Database ID.
445
+ */
446
+ databaseId: string;
447
+ /**
448
+ * Collection name.
449
+ */
450
+ name: string;
451
+ /**
452
+ * Collection enabled. Can be &#039;enabled&#039; or &#039;disabled&#039;. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.
453
+ */
454
+ enabled: boolean;
455
+ /**
456
+ * Whether document-level permissions are enabled. [Learn more about permissions](https://appconda.io/docs/permissions).
457
+ */
458
+ documentSecurity: boolean;
459
+ /**
460
+ * Collection attributes.
461
+ */
462
+ attributes: string[];
463
+ /**
464
+ * Collection indexes.
465
+ */
466
+ indexes: Index[];
467
+ }
468
+ /**
469
+ * Attributes List
470
+ */
471
+ export type AttributeList = {
472
+ /**
473
+ * Total number of attributes in the given collection.
474
+ */
475
+ total: number;
476
+ /**
477
+ * List of attributes.
478
+ */
479
+ attributes: string[];
480
+ }
481
+ /**
482
+ * AttributeString
483
+ */
484
+ export type AttributeString = {
485
+ /**
486
+ * Attribute Key.
487
+ */
488
+ key: string;
489
+ /**
490
+ * Attribute type.
491
+ */
492
+ type: string;
493
+ /**
494
+ * Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
495
+ */
496
+ status: string;
497
+ /**
498
+ * Error message. Displays error generated on failure of creating or deleting an attribute.
499
+ */
500
+ error: string;
501
+ /**
502
+ * Is attribute required?
503
+ */
504
+ required: boolean;
505
+ /**
506
+ * Is attribute an array?
507
+ */
508
+ array?: boolean;
509
+ /**
510
+ * Attribute size.
511
+ */
512
+ size: number;
513
+ /**
514
+ * Default value for attribute when not provided. Cannot be set when attribute is required.
515
+ */
516
+ default?: string;
517
+ }
518
+ /**
519
+ * AttributeInteger
520
+ */
521
+ export type AttributeInteger = {
522
+ /**
523
+ * Attribute Key.
524
+ */
525
+ key: string;
526
+ /**
527
+ * Attribute type.
528
+ */
529
+ type: string;
530
+ /**
531
+ * Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
532
+ */
533
+ status: string;
534
+ /**
535
+ * Error message. Displays error generated on failure of creating or deleting an attribute.
536
+ */
537
+ error: string;
538
+ /**
539
+ * Is attribute required?
540
+ */
541
+ required: boolean;
542
+ /**
543
+ * Is attribute an array?
544
+ */
545
+ array?: boolean;
546
+ /**
547
+ * Minimum value to enforce for new documents.
548
+ */
549
+ min?: number;
550
+ /**
551
+ * Maximum value to enforce for new documents.
552
+ */
553
+ max?: number;
554
+ /**
555
+ * Default value for attribute when not provided. Cannot be set when attribute is required.
556
+ */
557
+ default?: number;
558
+ }
559
+ /**
560
+ * AttributeFloat
561
+ */
562
+ export type AttributeFloat = {
563
+ /**
564
+ * Attribute Key.
565
+ */
566
+ key: string;
567
+ /**
568
+ * Attribute type.
569
+ */
570
+ type: string;
571
+ /**
572
+ * Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
573
+ */
574
+ status: string;
575
+ /**
576
+ * Error message. Displays error generated on failure of creating or deleting an attribute.
577
+ */
578
+ error: string;
579
+ /**
580
+ * Is attribute required?
581
+ */
582
+ required: boolean;
583
+ /**
584
+ * Is attribute an array?
585
+ */
586
+ array?: boolean;
587
+ /**
588
+ * Minimum value to enforce for new documents.
589
+ */
590
+ min?: number;
591
+ /**
592
+ * Maximum value to enforce for new documents.
593
+ */
594
+ max?: number;
595
+ /**
596
+ * Default value for attribute when not provided. Cannot be set when attribute is required.
597
+ */
598
+ default?: number;
599
+ }
600
+ /**
601
+ * AttributeBoolean
602
+ */
603
+ export type AttributeBoolean = {
604
+ /**
605
+ * Attribute Key.
606
+ */
607
+ key: string;
608
+ /**
609
+ * Attribute type.
610
+ */
611
+ type: string;
612
+ /**
613
+ * Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
614
+ */
615
+ status: string;
616
+ /**
617
+ * Error message. Displays error generated on failure of creating or deleting an attribute.
618
+ */
619
+ error: string;
620
+ /**
621
+ * Is attribute required?
622
+ */
623
+ required: boolean;
624
+ /**
625
+ * Is attribute an array?
626
+ */
627
+ array?: boolean;
628
+ /**
629
+ * Default value for attribute when not provided. Cannot be set when attribute is required.
630
+ */
631
+ default?: boolean;
632
+ }
633
+ /**
634
+ * AttributeEmail
635
+ */
636
+ export type AttributeEmail = {
637
+ /**
638
+ * Attribute Key.
639
+ */
640
+ key: string;
641
+ /**
642
+ * Attribute type.
643
+ */
644
+ type: string;
645
+ /**
646
+ * Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
647
+ */
648
+ status: string;
649
+ /**
650
+ * Error message. Displays error generated on failure of creating or deleting an attribute.
651
+ */
652
+ error: string;
653
+ /**
654
+ * Is attribute required?
655
+ */
656
+ required: boolean;
657
+ /**
658
+ * Is attribute an array?
659
+ */
660
+ array?: boolean;
661
+ /**
662
+ * String format.
663
+ */
664
+ format: string;
665
+ /**
666
+ * Default value for attribute when not provided. Cannot be set when attribute is required.
667
+ */
668
+ default?: string;
669
+ }
670
+ /**
671
+ * AttributeEnum
672
+ */
673
+ export type AttributeEnum = {
674
+ /**
675
+ * Attribute Key.
676
+ */
677
+ key: string;
678
+ /**
679
+ * Attribute type.
680
+ */
681
+ type: string;
682
+ /**
683
+ * Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
684
+ */
685
+ status: string;
686
+ /**
687
+ * Error message. Displays error generated on failure of creating or deleting an attribute.
688
+ */
689
+ error: string;
690
+ /**
691
+ * Is attribute required?
692
+ */
693
+ required: boolean;
694
+ /**
695
+ * Is attribute an array?
696
+ */
697
+ array?: boolean;
698
+ /**
699
+ * Array of elements in enumerated type.
700
+ */
701
+ elements: string[];
702
+ /**
703
+ * String format.
704
+ */
705
+ format: string;
706
+ /**
707
+ * Default value for attribute when not provided. Cannot be set when attribute is required.
708
+ */
709
+ default?: string;
710
+ }
711
+ /**
712
+ * AttributeIP
713
+ */
714
+ export type AttributeIp = {
715
+ /**
716
+ * Attribute Key.
717
+ */
718
+ key: string;
719
+ /**
720
+ * Attribute type.
721
+ */
722
+ type: string;
723
+ /**
724
+ * Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
725
+ */
726
+ status: string;
727
+ /**
728
+ * Error message. Displays error generated on failure of creating or deleting an attribute.
729
+ */
730
+ error: string;
731
+ /**
732
+ * Is attribute required?
733
+ */
734
+ required: boolean;
735
+ /**
736
+ * Is attribute an array?
737
+ */
738
+ array?: boolean;
739
+ /**
740
+ * String format.
741
+ */
742
+ format: string;
743
+ /**
744
+ * Default value for attribute when not provided. Cannot be set when attribute is required.
745
+ */
746
+ default?: string;
747
+ }
748
+ /**
749
+ * AttributeURL
750
+ */
751
+ export type AttributeUrl = {
752
+ /**
753
+ * Attribute Key.
754
+ */
755
+ key: string;
756
+ /**
757
+ * Attribute type.
758
+ */
759
+ type: string;
760
+ /**
761
+ * Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
762
+ */
763
+ status: string;
764
+ /**
765
+ * Error message. Displays error generated on failure of creating or deleting an attribute.
766
+ */
767
+ error: string;
768
+ /**
769
+ * Is attribute required?
770
+ */
771
+ required: boolean;
772
+ /**
773
+ * Is attribute an array?
774
+ */
775
+ array?: boolean;
776
+ /**
777
+ * String format.
778
+ */
779
+ format: string;
780
+ /**
781
+ * Default value for attribute when not provided. Cannot be set when attribute is required.
782
+ */
783
+ default?: string;
784
+ }
785
+ /**
786
+ * AttributeDatetime
787
+ */
788
+ export type AttributeDatetime = {
789
+ /**
790
+ * Attribute Key.
791
+ */
792
+ key: string;
793
+ /**
794
+ * Attribute type.
795
+ */
796
+ type: string;
797
+ /**
798
+ * Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
799
+ */
800
+ status: string;
801
+ /**
802
+ * Error message. Displays error generated on failure of creating or deleting an attribute.
803
+ */
804
+ error: string;
805
+ /**
806
+ * Is attribute required?
807
+ */
808
+ required: boolean;
809
+ /**
810
+ * Is attribute an array?
811
+ */
812
+ array?: boolean;
813
+ /**
814
+ * ISO 8601 format.
815
+ */
816
+ format: string;
817
+ /**
818
+ * Default value for attribute when not provided. Only null is optional
819
+ */
820
+ default?: string;
821
+ }
822
+ /**
823
+ * AttributeRelationship
824
+ */
825
+ export type AttributeRelationship = {
826
+ /**
827
+ * Attribute Key.
828
+ */
829
+ key: string;
830
+ /**
831
+ * Attribute type.
832
+ */
833
+ type: string;
834
+ /**
835
+ * Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
836
+ */
837
+ status: string;
838
+ /**
839
+ * Error message. Displays error generated on failure of creating or deleting an attribute.
840
+ */
841
+ error: string;
842
+ /**
843
+ * Is attribute required?
844
+ */
845
+ required: boolean;
846
+ /**
847
+ * Is attribute an array?
848
+ */
849
+ array?: boolean;
850
+ /**
851
+ * The ID of the related collection.
852
+ */
853
+ relatedCollection: string;
854
+ /**
855
+ * The type of the relationship.
856
+ */
857
+ relationType: string;
858
+ /**
859
+ * Is the relationship two-way?
860
+ */
861
+ twoWay: boolean;
862
+ /**
863
+ * The key of the two-way relationship.
864
+ */
865
+ twoWayKey: string;
866
+ /**
867
+ * How deleting the parent document will propagate to child documents.
868
+ */
869
+ onDelete: string;
870
+ /**
871
+ * Whether this is the parent or child side of the relationship
872
+ */
873
+ side: string;
874
+ }
875
+ /**
876
+ * Index
877
+ */
878
+ export type Index = {
879
+ /**
880
+ * Index Key.
881
+ */
882
+ key: string;
883
+ /**
884
+ * Index type.
885
+ */
886
+ type: string;
887
+ /**
888
+ * Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
889
+ */
890
+ status: string;
891
+ /**
892
+ * Error message. Displays error generated on failure of creating or deleting an index.
893
+ */
894
+ error: string;
895
+ /**
896
+ * Index attributes.
897
+ */
898
+ attributes: string[];
899
+ /**
900
+ * Index orders.
901
+ */
902
+ orders?: string[];
903
+ }
904
+ /**
905
+ * Document
906
+ */
907
+ export type Document = {
908
+ /**
909
+ * Document ID.
910
+ */
911
+ $id: string;
912
+ /**
913
+ * Collection ID.
914
+ */
915
+ $collectionId: string;
916
+ /**
917
+ * Database ID.
918
+ */
919
+ $databaseId: string;
920
+ /**
921
+ * Document creation date in ISO 8601 format.
922
+ */
923
+ $createdAt: string;
924
+ /**
925
+ * Document update date in ISO 8601 format.
926
+ */
927
+ $updatedAt: string;
928
+ /**
929
+ * Document permissions. [Learn more about permissions](https://appconda.io/docs/permissions).
930
+ */
931
+ $permissions: string[];
932
+ [key: string]: any;
933
+ }
934
+ /**
935
+ * Log
936
+ */
937
+ export type _Log = {
938
+ /**
939
+ * Event name.
940
+ */
941
+ event: string;
942
+ /**
943
+ * User ID.
944
+ */
945
+ userId: string;
946
+ /**
947
+ * User Email.
948
+ */
949
+ userEmail: string;
950
+ /**
951
+ * User Name.
952
+ */
953
+ userName: string;
954
+ /**
955
+ * API mode when event triggered.
956
+ */
957
+ mode: string;
958
+ /**
959
+ * IP session in use when the session was created.
960
+ */
961
+ ip: string;
962
+ /**
963
+ * Log creation date in ISO 8601 format.
964
+ */
965
+ time: string;
966
+ /**
967
+ * Operating system code name. View list of [available options](https://github.com/appconda/appconda/blob/master/docs/lists/os.json).
968
+ */
969
+ osCode: string;
970
+ /**
971
+ * Operating system name.
972
+ */
973
+ osName: string;
974
+ /**
975
+ * Operating system version.
976
+ */
977
+ osVersion: string;
978
+ /**
979
+ * Client type.
980
+ */
981
+ clientType: string;
982
+ /**
983
+ * Client code name. View list of [available options](https://github.com/appconda/appconda/blob/master/docs/lists/clients.json).
984
+ */
985
+ clientCode: string;
986
+ /**
987
+ * Client name.
988
+ */
989
+ clientName: string;
990
+ /**
991
+ * Client version.
992
+ */
993
+ clientVersion: string;
994
+ /**
995
+ * Client engine name.
996
+ */
997
+ clientEngine: string;
998
+ /**
999
+ * Client engine name.
1000
+ */
1001
+ clientEngineVersion: string;
1002
+ /**
1003
+ * Device name.
1004
+ */
1005
+ deviceName: string;
1006
+ /**
1007
+ * Device brand name.
1008
+ */
1009
+ deviceBrand: string;
1010
+ /**
1011
+ * Device model name.
1012
+ */
1013
+ deviceModel: string;
1014
+ /**
1015
+ * Country two-character ISO 3166-1 alpha code.
1016
+ */
1017
+ countryCode: string;
1018
+ /**
1019
+ * Country name.
1020
+ */
1021
+ countryName: string;
1022
+ }
1023
+ /**
1024
+ * User
1025
+ */
1026
+ export type User<Preferences extends Models.Preferences> = {
1027
+ /**
1028
+ * User ID.
1029
+ */
1030
+ $id: string;
1031
+ /**
1032
+ * User creation date in ISO 8601 format.
1033
+ */
1034
+ $createdAt: string;
1035
+ /**
1036
+ * User update date in ISO 8601 format.
1037
+ */
1038
+ $updatedAt: string;
1039
+ /**
1040
+ * User name.
1041
+ */
1042
+ name: string;
1043
+ /**
1044
+ * Hashed user password.
1045
+ */
1046
+ password?: string;
1047
+ /**
1048
+ * Password hashing algorithm.
1049
+ */
1050
+ hash?: string;
1051
+ /**
1052
+ * Password hashing algorithm configuration.
1053
+ */
1054
+ hashOptions?: object;
1055
+ /**
1056
+ * User registration date in ISO 8601 format.
1057
+ */
1058
+ registration: string;
1059
+ /**
1060
+ * User status. Pass `true` for enabled and `false` for disabled.
1061
+ */
1062
+ status: boolean;
1063
+ /**
1064
+ * Labels for the user.
1065
+ */
1066
+ labels: string[];
1067
+ /**
1068
+ * Password update time in ISO 8601 format.
1069
+ */
1070
+ passwordUpdate: string;
1071
+ /**
1072
+ * User email address.
1073
+ */
1074
+ email: string;
1075
+ /**
1076
+ * User phone number in E.164 format.
1077
+ */
1078
+ phone: string;
1079
+ /**
1080
+ * Email verification status.
1081
+ */
1082
+ emailVerification: boolean;
1083
+ /**
1084
+ * Phone verification status.
1085
+ */
1086
+ phoneVerification: boolean;
1087
+ /**
1088
+ * Multi factor authentication status.
1089
+ */
1090
+ mfa: boolean;
1091
+ /**
1092
+ * User preferences as a key-value object
1093
+ */
1094
+ prefs: Preferences;
1095
+ /**
1096
+ * A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.
1097
+ */
1098
+ targets: Target[];
1099
+ /**
1100
+ * Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.
1101
+ */
1102
+ accessedAt: string;
1103
+ }
1104
+ /**
1105
+ * AlgoMD5
1106
+ */
1107
+ export type AlgoMd5 = {
1108
+ /**
1109
+ * Algo type.
1110
+ */
1111
+ type: string;
1112
+ }
1113
+ /**
1114
+ * AlgoSHA
1115
+ */
1116
+ export type AlgoSha = {
1117
+ /**
1118
+ * Algo type.
1119
+ */
1120
+ type: string;
1121
+ }
1122
+ /**
1123
+ * AlgoPHPass
1124
+ */
1125
+ export type AlgoPhpass = {
1126
+ /**
1127
+ * Algo type.
1128
+ */
1129
+ type: string;
1130
+ }
1131
+ /**
1132
+ * AlgoBcrypt
1133
+ */
1134
+ export type AlgoBcrypt = {
1135
+ /**
1136
+ * Algo type.
1137
+ */
1138
+ type: string;
1139
+ }
1140
+ /**
1141
+ * AlgoScrypt
1142
+ */
1143
+ export type AlgoScrypt = {
1144
+ /**
1145
+ * Algo type.
1146
+ */
1147
+ type: string;
1148
+ /**
1149
+ * CPU complexity of computed hash.
1150
+ */
1151
+ costCpu: number;
1152
+ /**
1153
+ * Memory complexity of computed hash.
1154
+ */
1155
+ costMemory: number;
1156
+ /**
1157
+ * Parallelization of computed hash.
1158
+ */
1159
+ costParallel: number;
1160
+ /**
1161
+ * Length used to compute hash.
1162
+ */
1163
+ length: number;
1164
+ }
1165
+ /**
1166
+ * AlgoScryptModified
1167
+ */
1168
+ export type AlgoScryptModified = {
1169
+ /**
1170
+ * Algo type.
1171
+ */
1172
+ type: string;
1173
+ /**
1174
+ * Salt used to compute hash.
1175
+ */
1176
+ salt: string;
1177
+ /**
1178
+ * Separator used to compute hash.
1179
+ */
1180
+ saltSeparator: string;
1181
+ /**
1182
+ * Key used to compute hash.
1183
+ */
1184
+ signerKey: string;
1185
+ }
1186
+ /**
1187
+ * AlgoArgon2
1188
+ */
1189
+ export type AlgoArgon2 = {
1190
+ /**
1191
+ * Algo type.
1192
+ */
1193
+ type: string;
1194
+ /**
1195
+ * Memory used to compute hash.
1196
+ */
1197
+ memoryCost: number;
1198
+ /**
1199
+ * Amount of time consumed to compute hash
1200
+ */
1201
+ timeCost: number;
1202
+ /**
1203
+ * Number of threads used to compute hash.
1204
+ */
1205
+ threads: number;
1206
+ }
1207
+ /**
1208
+ * Preferences
1209
+ */
1210
+ export type Preferences = {
1211
+ [key: string]: any;
1212
+ }
1213
+ /**
1214
+ * Session
1215
+ */
1216
+ export type Session = {
1217
+ /**
1218
+ * Session ID.
1219
+ */
1220
+ $id: string;
1221
+ /**
1222
+ * Session creation date in ISO 8601 format.
1223
+ */
1224
+ $createdAt: string;
1225
+ /**
1226
+ * Session update date in ISO 8601 format.
1227
+ */
1228
+ $updatedAt: string;
1229
+ /**
1230
+ * User ID.
1231
+ */
1232
+ userId: string;
1233
+ /**
1234
+ * Session expiration date in ISO 8601 format.
1235
+ */
1236
+ expire: string;
1237
+ /**
1238
+ * Session Provider.
1239
+ */
1240
+ provider: string;
1241
+ /**
1242
+ * Session Provider User ID.
1243
+ */
1244
+ providerUid: string;
1245
+ /**
1246
+ * Session Provider Access Token.
1247
+ */
1248
+ providerAccessToken: string;
1249
+ /**
1250
+ * The date of when the access token expires in ISO 8601 format.
1251
+ */
1252
+ providerAccessTokenExpiry: string;
1253
+ /**
1254
+ * Session Provider Refresh Token.
1255
+ */
1256
+ providerRefreshToken: string;
1257
+ /**
1258
+ * IP in use when the session was created.
1259
+ */
1260
+ ip: string;
1261
+ /**
1262
+ * Operating system code name. View list of [available options](https://github.com/appconda/appconda/blob/master/docs/lists/os.json).
1263
+ */
1264
+ osCode: string;
1265
+ /**
1266
+ * Operating system name.
1267
+ */
1268
+ osName: string;
1269
+ /**
1270
+ * Operating system version.
1271
+ */
1272
+ osVersion: string;
1273
+ /**
1274
+ * Client type.
1275
+ */
1276
+ clientType: string;
1277
+ /**
1278
+ * Client code name. View list of [available options](https://github.com/appconda/appconda/blob/master/docs/lists/clients.json).
1279
+ */
1280
+ clientCode: string;
1281
+ /**
1282
+ * Client name.
1283
+ */
1284
+ clientName: string;
1285
+ /**
1286
+ * Client version.
1287
+ */
1288
+ clientVersion: string;
1289
+ /**
1290
+ * Client engine name.
1291
+ */
1292
+ clientEngine: string;
1293
+ /**
1294
+ * Client engine name.
1295
+ */
1296
+ clientEngineVersion: string;
1297
+ /**
1298
+ * Device name.
1299
+ */
1300
+ deviceName: string;
1301
+ /**
1302
+ * Device brand name.
1303
+ */
1304
+ deviceBrand: string;
1305
+ /**
1306
+ * Device model name.
1307
+ */
1308
+ deviceModel: string;
1309
+ /**
1310
+ * Country two-character ISO 3166-1 alpha code.
1311
+ */
1312
+ countryCode: string;
1313
+ /**
1314
+ * Country name.
1315
+ */
1316
+ countryName: string;
1317
+ /**
1318
+ * Returns true if this the current user session.
1319
+ */
1320
+ current: boolean;
1321
+ /**
1322
+ * Returns a list of active session factors.
1323
+ */
1324
+ factors: string[];
1325
+ /**
1326
+ * Secret used to authenticate the user. Only included if the request was made with an API key
1327
+ */
1328
+ secret: string;
1329
+ /**
1330
+ * Most recent date in ISO 8601 format when the session successfully passed MFA challenge.
1331
+ */
1332
+ mfaUpdatedAt: string;
1333
+ }
1334
+ /**
1335
+ * Identity
1336
+ */
1337
+ export type Identity = {
1338
+ /**
1339
+ * Identity ID.
1340
+ */
1341
+ $id: string;
1342
+ /**
1343
+ * Identity creation date in ISO 8601 format.
1344
+ */
1345
+ $createdAt: string;
1346
+ /**
1347
+ * Identity update date in ISO 8601 format.
1348
+ */
1349
+ $updatedAt: string;
1350
+ /**
1351
+ * User ID.
1352
+ */
1353
+ userId: string;
1354
+ /**
1355
+ * Identity Provider.
1356
+ */
1357
+ provider: string;
1358
+ /**
1359
+ * ID of the User in the Identity Provider.
1360
+ */
1361
+ providerUid: string;
1362
+ /**
1363
+ * Email of the User in the Identity Provider.
1364
+ */
1365
+ providerEmail: string;
1366
+ /**
1367
+ * Identity Provider Access Token.
1368
+ */
1369
+ providerAccessToken: string;
1370
+ /**
1371
+ * The date of when the access token expires in ISO 8601 format.
1372
+ */
1373
+ providerAccessTokenExpiry: string;
1374
+ /**
1375
+ * Identity Provider Refresh Token.
1376
+ */
1377
+ providerRefreshToken: string;
1378
+ }
1379
+ /**
1380
+ * Token
1381
+ */
1382
+ export type Token = {
1383
+ /**
1384
+ * Token ID.
1385
+ */
1386
+ $id: string;
1387
+ /**
1388
+ * Token creation date in ISO 8601 format.
1389
+ */
1390
+ $createdAt: string;
1391
+ /**
1392
+ * User ID.
1393
+ */
1394
+ userId: string;
1395
+ /**
1396
+ * Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.
1397
+ */
1398
+ secret: string;
1399
+ /**
1400
+ * Token expiration date in ISO 8601 format.
1401
+ */
1402
+ expire: string;
1403
+ /**
1404
+ * Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email.
1405
+ */
1406
+ phrase: string;
1407
+ }
1408
+ /**
1409
+ * JWT
1410
+ */
1411
+ export type Jwt = {
1412
+ /**
1413
+ * JWT encoded string.
1414
+ */
1415
+ jwt: string;
1416
+ }
1417
+ /**
1418
+ * Locale
1419
+ */
1420
+ export type Locale = {
1421
+ /**
1422
+ * User IP address.
1423
+ */
1424
+ ip: string;
1425
+ /**
1426
+ * Country code in [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) two-character format
1427
+ */
1428
+ countryCode: string;
1429
+ /**
1430
+ * Country name. This field support localization.
1431
+ */
1432
+ country: string;
1433
+ /**
1434
+ * Continent code. A two character continent code &quot;AF&quot; for Africa, &quot;AN&quot; for Antarctica, &quot;AS&quot; for Asia, &quot;EU&quot; for Europe, &quot;NA&quot; for North America, &quot;OC&quot; for Oceania, and &quot;SA&quot; for South America.
1435
+ */
1436
+ continentCode: string;
1437
+ /**
1438
+ * Continent name. This field support localization.
1439
+ */
1440
+ continent: string;
1441
+ /**
1442
+ * True if country is part of the European Union.
1443
+ */
1444
+ eu: boolean;
1445
+ /**
1446
+ * Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format
1447
+ */
1448
+ currency: string;
1449
+ }
1450
+ /**
1451
+ * LocaleCode
1452
+ */
1453
+ export type LocaleCode = {
1454
+ /**
1455
+ * Locale codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
1456
+ */
1457
+ code: string;
1458
+ /**
1459
+ * Locale name
1460
+ */
1461
+ name: string;
1462
+ }
1463
+ /**
1464
+ * File
1465
+ */
1466
+ export type File = {
1467
+ /**
1468
+ * File ID.
1469
+ */
1470
+ $id: string;
1471
+ /**
1472
+ * Bucket ID.
1473
+ */
1474
+ bucketId: string;
1475
+ /**
1476
+ * File creation date in ISO 8601 format.
1477
+ */
1478
+ $createdAt: string;
1479
+ /**
1480
+ * File update date in ISO 8601 format.
1481
+ */
1482
+ $updatedAt: string;
1483
+ /**
1484
+ * File permissions. [Learn more about permissions](https://appconda.io/docs/permissions).
1485
+ */
1486
+ $permissions: string[];
1487
+ /**
1488
+ * File name.
1489
+ */
1490
+ name: string;
1491
+ /**
1492
+ * File MD5 signature.
1493
+ */
1494
+ signature: string;
1495
+ /**
1496
+ * File mime type.
1497
+ */
1498
+ mimeType: string;
1499
+ /**
1500
+ * File original size in bytes.
1501
+ */
1502
+ sizeOriginal: number;
1503
+ /**
1504
+ * Total number of chunks available
1505
+ */
1506
+ chunksTotal: number;
1507
+ /**
1508
+ * Total number of chunks uploaded
1509
+ */
1510
+ chunksUploaded: number;
1511
+ }
1512
+ /**
1513
+ * Bucket
1514
+ */
1515
+ export type Bucket = {
1516
+ /**
1517
+ * Bucket ID.
1518
+ */
1519
+ $id: string;
1520
+ /**
1521
+ * Bucket creation time in ISO 8601 format.
1522
+ */
1523
+ $createdAt: string;
1524
+ /**
1525
+ * Bucket update date in ISO 8601 format.
1526
+ */
1527
+ $updatedAt: string;
1528
+ /**
1529
+ * Bucket permissions. [Learn more about permissions](https://appconda.io/docs/permissions).
1530
+ */
1531
+ $permissions: string[];
1532
+ /**
1533
+ * Whether file-level security is enabled. [Learn more about permissions](https://appconda.io/docs/permissions).
1534
+ */
1535
+ fileSecurity: boolean;
1536
+ /**
1537
+ * Bucket name.
1538
+ */
1539
+ name: string;
1540
+ /**
1541
+ * Bucket enabled.
1542
+ */
1543
+ enabled: boolean;
1544
+ /**
1545
+ * Maximum file size supported.
1546
+ */
1547
+ maximumFileSize: number;
1548
+ /**
1549
+ * Allowed file extensions.
1550
+ */
1551
+ allowedFileExtensions: string[];
1552
+ /**
1553
+ * Compression algorithm choosen for compression. Will be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd).
1554
+ */
1555
+ compression: string;
1556
+ /**
1557
+ * Bucket is encrypted.
1558
+ */
1559
+ encryption: boolean;
1560
+ /**
1561
+ * Virus scanning is enabled.
1562
+ */
1563
+ antivirus: boolean;
1564
+ }
1565
+ /**
1566
+ * Team
1567
+ */
1568
+ export type Team<Preferences extends Models.Preferences> = {
1569
+ /**
1570
+ * Team ID.
1571
+ */
1572
+ $id: string;
1573
+ /**
1574
+ * Team creation date in ISO 8601 format.
1575
+ */
1576
+ $createdAt: string;
1577
+ /**
1578
+ * Team update date in ISO 8601 format.
1579
+ */
1580
+ $updatedAt: string;
1581
+ /**
1582
+ * Team name.
1583
+ */
1584
+ name: string;
1585
+ /**
1586
+ * Total number of team members.
1587
+ */
1588
+ total: number;
1589
+ /**
1590
+ * Team preferences as a key-value object
1591
+ */
1592
+ prefs: Preferences;
1593
+ }
1594
+ /**
1595
+ * Membership
1596
+ */
1597
+ export type Membership = {
1598
+ /**
1599
+ * Membership ID.
1600
+ */
1601
+ $id: string;
1602
+ /**
1603
+ * Membership creation date in ISO 8601 format.
1604
+ */
1605
+ $createdAt: string;
1606
+ /**
1607
+ * Membership update date in ISO 8601 format.
1608
+ */
1609
+ $updatedAt: string;
1610
+ /**
1611
+ * User ID.
1612
+ */
1613
+ userId: string;
1614
+ /**
1615
+ * User name.
1616
+ */
1617
+ userName: string;
1618
+ /**
1619
+ * User email address.
1620
+ */
1621
+ userEmail: string;
1622
+ /**
1623
+ * Team ID.
1624
+ */
1625
+ teamId: string;
1626
+ /**
1627
+ * Team name.
1628
+ */
1629
+ teamName: string;
1630
+ /**
1631
+ * Date, the user has been invited to join the team in ISO 8601 format.
1632
+ */
1633
+ invited: string;
1634
+ /**
1635
+ * Date, the user has accepted the invitation to join the team in ISO 8601 format.
1636
+ */
1637
+ joined: string;
1638
+ /**
1639
+ * User confirmation status, true if the user has joined the team or false otherwise.
1640
+ */
1641
+ confirm: boolean;
1642
+ /**
1643
+ * Multi factor authentication status, true if the user has MFA enabled or false otherwise.
1644
+ */
1645
+ mfa: boolean;
1646
+ /**
1647
+ * User list of roles
1648
+ */
1649
+ roles: string[];
1650
+ }
1651
+ /**
1652
+ * Function
1653
+ */
1654
+ export type Function = {
1655
+ /**
1656
+ * Function ID.
1657
+ */
1658
+ $id: string;
1659
+ /**
1660
+ * Function creation date in ISO 8601 format.
1661
+ */
1662
+ $createdAt: string;
1663
+ /**
1664
+ * Function update date in ISO 8601 format.
1665
+ */
1666
+ $updatedAt: string;
1667
+ /**
1668
+ * Execution permissions.
1669
+ */
1670
+ execute: string[];
1671
+ /**
1672
+ * Function name.
1673
+ */
1674
+ name: string;
1675
+ /**
1676
+ * Function enabled.
1677
+ */
1678
+ enabled: boolean;
1679
+ /**
1680
+ * Is the function deployed with the latest configuration? This is set to false if you&#039;ve changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration.
1681
+ */
1682
+ live: boolean;
1683
+ /**
1684
+ * Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appconda project.
1685
+ */
1686
+ logging: boolean;
1687
+ /**
1688
+ * Function execution runtime.
1689
+ */
1690
+ runtime: string;
1691
+ /**
1692
+ * Function&#039;s active deployment ID.
1693
+ */
1694
+ deployment: string;
1695
+ /**
1696
+ * Allowed permission scopes.
1697
+ */
1698
+ scopes: string[];
1699
+ /**
1700
+ * Function variables.
1701
+ */
1702
+ vars: Variable[];
1703
+ /**
1704
+ * Function trigger events.
1705
+ */
1706
+ events: string[];
1707
+ /**
1708
+ * Function execution schedult in CRON format.
1709
+ */
1710
+ schedule: string;
1711
+ /**
1712
+ * Function execution timeout in seconds.
1713
+ */
1714
+ timeout: number;
1715
+ /**
1716
+ * The entrypoint file used to execute the deployment.
1717
+ */
1718
+ entrypoint: string;
1719
+ /**
1720
+ * The build command used to build the deployment.
1721
+ */
1722
+ commands: string;
1723
+ /**
1724
+ * Version of Open Runtimes used for the function.
1725
+ */
1726
+ version: string;
1727
+ /**
1728
+ * Function VCS (Version Control System) installation id.
1729
+ */
1730
+ installationId: string;
1731
+ /**
1732
+ * VCS (Version Control System) Repository ID
1733
+ */
1734
+ providerRepositoryId: string;
1735
+ /**
1736
+ * VCS (Version Control System) branch name
1737
+ */
1738
+ providerBranch: string;
1739
+ /**
1740
+ * Path to function in VCS (Version Control System) repository
1741
+ */
1742
+ providerRootDirectory: string;
1743
+ /**
1744
+ * Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests
1745
+ */
1746
+ providerSilentMode: boolean;
1747
+ /**
1748
+ * Machine specification for builds and executions.
1749
+ */
1750
+ specification: string;
1751
+ }
1752
+ /**
1753
+ * Runtime
1754
+ */
1755
+ export type Runtime = {
1756
+ /**
1757
+ * Runtime ID.
1758
+ */
1759
+ $id: string;
1760
+ /**
1761
+ * Parent runtime key.
1762
+ */
1763
+ key: string;
1764
+ /**
1765
+ * Runtime Name.
1766
+ */
1767
+ name: string;
1768
+ /**
1769
+ * Runtime version.
1770
+ */
1771
+ version: string;
1772
+ /**
1773
+ * Base Docker image used to build the runtime.
1774
+ */
1775
+ base: string;
1776
+ /**
1777
+ * Image name of Docker Hub.
1778
+ */
1779
+ image: string;
1780
+ /**
1781
+ * Name of the logo image.
1782
+ */
1783
+ logo: string;
1784
+ /**
1785
+ * List of supported architectures.
1786
+ */
1787
+ supports: string[];
1788
+ }
1789
+ /**
1790
+ * Deployment
1791
+ */
1792
+ export type Deployment = {
1793
+ /**
1794
+ * Deployment ID.
1795
+ */
1796
+ $id: string;
1797
+ /**
1798
+ * Deployment creation date in ISO 8601 format.
1799
+ */
1800
+ $createdAt: string;
1801
+ /**
1802
+ * Deployment update date in ISO 8601 format.
1803
+ */
1804
+ $updatedAt: string;
1805
+ /**
1806
+ * Type of deployment.
1807
+ */
1808
+ type: string;
1809
+ /**
1810
+ * Resource ID.
1811
+ */
1812
+ resourceId: string;
1813
+ /**
1814
+ * Resource type.
1815
+ */
1816
+ resourceType: string;
1817
+ /**
1818
+ * The entrypoint file to use to execute the deployment code.
1819
+ */
1820
+ entrypoint: string;
1821
+ /**
1822
+ * The code size in bytes.
1823
+ */
1824
+ size: number;
1825
+ /**
1826
+ * The build output size in bytes.
1827
+ */
1828
+ buildSize: number;
1829
+ /**
1830
+ * The current build ID.
1831
+ */
1832
+ buildId: string;
1833
+ /**
1834
+ * Whether the deployment should be automatically activated.
1835
+ */
1836
+ activate: boolean;
1837
+ /**
1838
+ * The deployment status. Possible values are &quot;processing&quot;, &quot;building&quot;, &quot;waiting&quot;, &quot;ready&quot;, and &quot;failed&quot;.
1839
+ */
1840
+ status: string;
1841
+ /**
1842
+ * The build logs.
1843
+ */
1844
+ buildLogs: string;
1845
+ /**
1846
+ * The current build time in seconds.
1847
+ */
1848
+ buildTime: number;
1849
+ /**
1850
+ * The name of the vcs provider repository
1851
+ */
1852
+ providerRepositoryName: string;
1853
+ /**
1854
+ * The name of the vcs provider repository owner
1855
+ */
1856
+ providerRepositoryOwner: string;
1857
+ /**
1858
+ * The url of the vcs provider repository
1859
+ */
1860
+ providerRepositoryUrl: string;
1861
+ /**
1862
+ * The branch of the vcs repository
1863
+ */
1864
+ providerBranch: string;
1865
+ /**
1866
+ * The commit hash of the vcs commit
1867
+ */
1868
+ providerCommitHash: string;
1869
+ /**
1870
+ * The url of vcs commit author
1871
+ */
1872
+ providerCommitAuthorUrl: string;
1873
+ /**
1874
+ * The name of vcs commit author
1875
+ */
1876
+ providerCommitAuthor: string;
1877
+ /**
1878
+ * The commit message
1879
+ */
1880
+ providerCommitMessage: string;
1881
+ /**
1882
+ * The url of the vcs commit
1883
+ */
1884
+ providerCommitUrl: string;
1885
+ /**
1886
+ * The branch of the vcs repository
1887
+ */
1888
+ providerBranchUrl: string;
1889
+ }
1890
+ /**
1891
+ * Execution
1892
+ */
1893
+ export type Execution = {
1894
+ /**
1895
+ * Execution ID.
1896
+ */
1897
+ $id: string;
1898
+ /**
1899
+ * Execution creation date in ISO 8601 format.
1900
+ */
1901
+ $createdAt: string;
1902
+ /**
1903
+ * Execution upate date in ISO 8601 format.
1904
+ */
1905
+ $updatedAt: string;
1906
+ /**
1907
+ * Execution roles.
1908
+ */
1909
+ $permissions: string[];
1910
+ /**
1911
+ * Function ID.
1912
+ */
1913
+ functionId: string;
1914
+ /**
1915
+ * The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.
1916
+ */
1917
+ trigger: string;
1918
+ /**
1919
+ * The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`.
1920
+ */
1921
+ status: string;
1922
+ /**
1923
+ * HTTP request method type.
1924
+ */
1925
+ requestMethod: string;
1926
+ /**
1927
+ * HTTP request path and query.
1928
+ */
1929
+ requestPath: string;
1930
+ /**
1931
+ * HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.
1932
+ */
1933
+ requestHeaders: Headers[];
1934
+ /**
1935
+ * HTTP response status code.
1936
+ */
1937
+ responseStatusCode: number;
1938
+ /**
1939
+ * HTTP response body. This will return empty unless execution is created as synchronous.
1940
+ */
1941
+ responseBody: string;
1942
+ /**
1943
+ * HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.
1944
+ */
1945
+ responseHeaders: Headers[];
1946
+ /**
1947
+ * Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.
1948
+ */
1949
+ logs: string;
1950
+ /**
1951
+ * Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.
1952
+ */
1953
+ errors: string;
1954
+ /**
1955
+ * Function execution duration in seconds.
1956
+ */
1957
+ duration: number;
1958
+ /**
1959
+ * The scheduled time for execution. If left empty, execution will be queued immediately.
1960
+ */
1961
+ scheduledAt?: string;
1962
+ }
1963
+ /**
1964
+ * Build
1965
+ */
1966
+ export type Build = {
1967
+ /**
1968
+ * Build ID.
1969
+ */
1970
+ $id: string;
1971
+ /**
1972
+ * The deployment that created this build.
1973
+ */
1974
+ deploymentId: string;
1975
+ /**
1976
+ * The build status. There are a few different types and each one means something different. \nFailed - The deployment build has failed. More details can usually be found in buildStderr\nReady - The deployment build was successful and the deployment is ready to be deployed\nProcessing - The deployment is currently waiting to have a build triggered\nBuilding - The deployment is currently being built
1977
+ */
1978
+ status: string;
1979
+ /**
1980
+ * The stdout of the build.
1981
+ */
1982
+ stdout: string;
1983
+ /**
1984
+ * The stderr of the build.
1985
+ */
1986
+ stderr: string;
1987
+ /**
1988
+ * The deployment creation date in ISO 8601 format.
1989
+ */
1990
+ startTime: string;
1991
+ /**
1992
+ * The time the build was finished in ISO 8601 format.
1993
+ */
1994
+ endTime: string;
1995
+ /**
1996
+ * The build duration in seconds.
1997
+ */
1998
+ duration: number;
1999
+ /**
2000
+ * The code size in bytes.
2001
+ */
2002
+ size: number;
2003
+ }
2004
+ /**
2005
+ * Variable
2006
+ */
2007
+ export type Variable = {
2008
+ /**
2009
+ * Variable ID.
2010
+ */
2011
+ $id: string;
2012
+ /**
2013
+ * Variable creation date in ISO 8601 format.
2014
+ */
2015
+ $createdAt: string;
2016
+ /**
2017
+ * Variable creation date in ISO 8601 format.
2018
+ */
2019
+ $updatedAt: string;
2020
+ /**
2021
+ * Variable key.
2022
+ */
2023
+ key: string;
2024
+ /**
2025
+ * Variable value.
2026
+ */
2027
+ value: string;
2028
+ /**
2029
+ * Service to which the variable belongs. Possible values are &quot;project&quot;, &quot;function&quot;
2030
+ */
2031
+ resourceType: string;
2032
+ /**
2033
+ * ID of resource to which the variable belongs. If resourceType is &quot;project&quot;, it is empty. If resourceType is &quot;function&quot;, it is ID of the function.
2034
+ */
2035
+ resourceId: string;
2036
+ }
2037
+ /**
2038
+ * Country
2039
+ */
2040
+ export type Country = {
2041
+ /**
2042
+ * Country name.
2043
+ */
2044
+ name: string;
2045
+ /**
2046
+ * Country two-character ISO 3166-1 alpha code.
2047
+ */
2048
+ code: string;
2049
+ }
2050
+ /**
2051
+ * Continent
2052
+ */
2053
+ export type Continent = {
2054
+ /**
2055
+ * Continent name.
2056
+ */
2057
+ name: string;
2058
+ /**
2059
+ * Continent two letter code.
2060
+ */
2061
+ code: string;
2062
+ }
2063
+ /**
2064
+ * Language
2065
+ */
2066
+ export type Language = {
2067
+ /**
2068
+ * Language name.
2069
+ */
2070
+ name: string;
2071
+ /**
2072
+ * Language two-character ISO 639-1 codes.
2073
+ */
2074
+ code: string;
2075
+ /**
2076
+ * Language native name.
2077
+ */
2078
+ nativeName: string;
2079
+ }
2080
+ /**
2081
+ * Currency
2082
+ */
2083
+ export type Currency = {
2084
+ /**
2085
+ * Currency symbol.
2086
+ */
2087
+ symbol: string;
2088
+ /**
2089
+ * Currency name.
2090
+ */
2091
+ name: string;
2092
+ /**
2093
+ * Currency native symbol.
2094
+ */
2095
+ symbolNative: string;
2096
+ /**
2097
+ * Number of decimal digits.
2098
+ */
2099
+ decimalDigits: number;
2100
+ /**
2101
+ * Currency digit rounding.
2102
+ */
2103
+ rounding: number;
2104
+ /**
2105
+ * Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format.
2106
+ */
2107
+ code: string;
2108
+ /**
2109
+ * Currency plural name
2110
+ */
2111
+ namePlural: string;
2112
+ }
2113
+ /**
2114
+ * Phone
2115
+ */
2116
+ export type Phone = {
2117
+ /**
2118
+ * Phone code.
2119
+ */
2120
+ code: string;
2121
+ /**
2122
+ * Country two-character ISO 3166-1 alpha code.
2123
+ */
2124
+ countryCode: string;
2125
+ /**
2126
+ * Country name.
2127
+ */
2128
+ countryName: string;
2129
+ }
2130
+ /**
2131
+ * Health Antivirus
2132
+ */
2133
+ export type HealthAntivirus = {
2134
+ /**
2135
+ * Antivirus version.
2136
+ */
2137
+ version: string;
2138
+ /**
2139
+ * Antivirus status. Possible values can are: `disabled`, `offline`, `online`
2140
+ */
2141
+ status: string;
2142
+ }
2143
+ /**
2144
+ * Health Queue
2145
+ */
2146
+ export type HealthQueue = {
2147
+ /**
2148
+ * Amount of actions in the queue.
2149
+ */
2150
+ size: number;
2151
+ }
2152
+ /**
2153
+ * Health Status
2154
+ */
2155
+ export type HealthStatus = {
2156
+ /**
2157
+ * Name of the service.
2158
+ */
2159
+ name: string;
2160
+ /**
2161
+ * Duration in milliseconds how long the health check took.
2162
+ */
2163
+ ping: number;
2164
+ /**
2165
+ * Service status. Possible values can are: `pass`, `fail`
2166
+ */
2167
+ status: string;
2168
+ }
2169
+ /**
2170
+ * Health Certificate
2171
+ */
2172
+ export type HealthCertificate = {
2173
+ /**
2174
+ * Certificate name
2175
+ */
2176
+ name: string;
2177
+ /**
2178
+ * Subject SN
2179
+ */
2180
+ subjectSN: string;
2181
+ /**
2182
+ * Issuer organisation
2183
+ */
2184
+ issuerOrganisation: string;
2185
+ /**
2186
+ * Valid from
2187
+ */
2188
+ validFrom: string;
2189
+ /**
2190
+ * Valid to
2191
+ */
2192
+ validTo: string;
2193
+ /**
2194
+ * Signature type SN
2195
+ */
2196
+ signatureTypeSN: string;
2197
+ }
2198
+ /**
2199
+ * Health Time
2200
+ */
2201
+ export type HealthTime = {
2202
+ /**
2203
+ * Current unix timestamp on trustful remote server.
2204
+ */
2205
+ remoteTime: number;
2206
+ /**
2207
+ * Current unix timestamp of local server where Appconda runs.
2208
+ */
2209
+ localTime: number;
2210
+ /**
2211
+ * Difference of unix remote and local timestamps in milliseconds.
2212
+ */
2213
+ diff: number;
2214
+ }
2215
+ /**
2216
+ * Headers
2217
+ */
2218
+ export type Headers = {
2219
+ /**
2220
+ * Header name.
2221
+ */
2222
+ name: string;
2223
+ /**
2224
+ * Header value.
2225
+ */
2226
+ value: string;
2227
+ }
2228
+ /**
2229
+ * Specification
2230
+ */
2231
+ export type Specification = {
2232
+ /**
2233
+ * Memory size in MB.
2234
+ */
2235
+ memory: number;
2236
+ /**
2237
+ * Number of CPUs.
2238
+ */
2239
+ cpus: number;
2240
+ /**
2241
+ * Is size enabled.
2242
+ */
2243
+ enabled: boolean;
2244
+ /**
2245
+ * Size slug.
2246
+ */
2247
+ slug: string;
2248
+ }
2249
+ /**
2250
+ * MFA Challenge
2251
+ */
2252
+ export type MfaChallenge = {
2253
+ /**
2254
+ * Token ID.
2255
+ */
2256
+ $id: string;
2257
+ /**
2258
+ * Token creation date in ISO 8601 format.
2259
+ */
2260
+ $createdAt: string;
2261
+ /**
2262
+ * User ID.
2263
+ */
2264
+ userId: string;
2265
+ /**
2266
+ * Token expiration date in ISO 8601 format.
2267
+ */
2268
+ expire: string;
2269
+ }
2270
+ /**
2271
+ * MFA Recovery Codes
2272
+ */
2273
+ export type MfaRecoveryCodes = {
2274
+ /**
2275
+ * Recovery codes.
2276
+ */
2277
+ recoveryCodes: string[];
2278
+ }
2279
+ /**
2280
+ * MFAType
2281
+ */
2282
+ export type MfaType = {
2283
+ /**
2284
+ * Secret token used for TOTP factor.
2285
+ */
2286
+ secret: string;
2287
+ /**
2288
+ * URI for authenticator apps.
2289
+ */
2290
+ uri: string;
2291
+ }
2292
+ /**
2293
+ * MFAFactors
2294
+ */
2295
+ export type MfaFactors = {
2296
+ /**
2297
+ * Can TOTP be used for MFA challenge for this account.
2298
+ */
2299
+ totp: boolean;
2300
+ /**
2301
+ * Can phone (SMS) be used for MFA challenge for this account.
2302
+ */
2303
+ phone: boolean;
2304
+ /**
2305
+ * Can email be used for MFA challenge for this account.
2306
+ */
2307
+ email: boolean;
2308
+ /**
2309
+ * Can recovery code be used for MFA challenge for this account.
2310
+ */
2311
+ recoveryCode: boolean;
2312
+ }
2313
+ /**
2314
+ * Provider
2315
+ */
2316
+ export type Provider = {
2317
+ /**
2318
+ * Provider ID.
2319
+ */
2320
+ $id: string;
2321
+ /**
2322
+ * Provider creation time in ISO 8601 format.
2323
+ */
2324
+ $createdAt: string;
2325
+ /**
2326
+ * Provider update date in ISO 8601 format.
2327
+ */
2328
+ $updatedAt: string;
2329
+ /**
2330
+ * The name for the provider instance.
2331
+ */
2332
+ name: string;
2333
+ /**
2334
+ * The name of the provider service.
2335
+ */
2336
+ provider: string;
2337
+ /**
2338
+ * Is provider enabled?
2339
+ */
2340
+ enabled: boolean;
2341
+ /**
2342
+ * Type of provider.
2343
+ */
2344
+ type: string;
2345
+ /**
2346
+ * Provider credentials.
2347
+ */
2348
+ credentials: object;
2349
+ /**
2350
+ * Provider options.
2351
+ */
2352
+ options?: object;
2353
+ }
2354
+ /**
2355
+ * Message
2356
+ */
2357
+ export type Message = {
2358
+ /**
2359
+ * Message ID.
2360
+ */
2361
+ $id: string;
2362
+ /**
2363
+ * Message creation time in ISO 8601 format.
2364
+ */
2365
+ $createdAt: string;
2366
+ /**
2367
+ * Message update date in ISO 8601 format.
2368
+ */
2369
+ $updatedAt: string;
2370
+ /**
2371
+ * Message provider type.
2372
+ */
2373
+ providerType: string;
2374
+ /**
2375
+ * Topic IDs set as recipients.
2376
+ */
2377
+ topics: string[];
2378
+ /**
2379
+ * User IDs set as recipients.
2380
+ */
2381
+ users: string[];
2382
+ /**
2383
+ * Target IDs set as recipients.
2384
+ */
2385
+ targets: string[];
2386
+ /**
2387
+ * The scheduled time for message.
2388
+ */
2389
+ scheduledAt?: string;
2390
+ /**
2391
+ * The time when the message was delivered.
2392
+ */
2393
+ deliveredAt?: string;
2394
+ /**
2395
+ * Delivery errors if any.
2396
+ */
2397
+ deliveryErrors?: string[];
2398
+ /**
2399
+ * Number of recipients the message was delivered to.
2400
+ */
2401
+ deliveredTotal: number;
2402
+ /**
2403
+ * Data of the message.
2404
+ */
2405
+ data: object;
2406
+ /**
2407
+ * Status of delivery.
2408
+ */
2409
+ status: string;
2410
+ }
2411
+ /**
2412
+ * Topic
2413
+ */
2414
+ export type Topic = {
2415
+ /**
2416
+ * Topic ID.
2417
+ */
2418
+ $id: string;
2419
+ /**
2420
+ * Topic creation time in ISO 8601 format.
2421
+ */
2422
+ $createdAt: string;
2423
+ /**
2424
+ * Topic update date in ISO 8601 format.
2425
+ */
2426
+ $updatedAt: string;
2427
+ /**
2428
+ * The name of the topic.
2429
+ */
2430
+ name: string;
2431
+ /**
2432
+ * Total count of email subscribers subscribed to the topic.
2433
+ */
2434
+ emailTotal: number;
2435
+ /**
2436
+ * Total count of SMS subscribers subscribed to the topic.
2437
+ */
2438
+ smsTotal: number;
2439
+ /**
2440
+ * Total count of push subscribers subscribed to the topic.
2441
+ */
2442
+ pushTotal: number;
2443
+ /**
2444
+ * Subscribe permissions.
2445
+ */
2446
+ subscribe: string[];
2447
+ }
2448
+ /**
2449
+ * Subscriber
2450
+ */
2451
+ export type Subscriber = {
2452
+ /**
2453
+ * Subscriber ID.
2454
+ */
2455
+ $id: string;
2456
+ /**
2457
+ * Subscriber creation time in ISO 8601 format.
2458
+ */
2459
+ $createdAt: string;
2460
+ /**
2461
+ * Subscriber update date in ISO 8601 format.
2462
+ */
2463
+ $updatedAt: string;
2464
+ /**
2465
+ * Target ID.
2466
+ */
2467
+ targetId: string;
2468
+ /**
2469
+ * Target.
2470
+ */
2471
+ target: Target;
2472
+ /**
2473
+ * Topic ID.
2474
+ */
2475
+ userId: string;
2476
+ /**
2477
+ * User Name.
2478
+ */
2479
+ userName: string;
2480
+ /**
2481
+ * Topic ID.
2482
+ */
2483
+ topicId: string;
2484
+ /**
2485
+ * The target provider type. Can be one of the following: `email`, `sms` or `push`.
2486
+ */
2487
+ providerType: string;
2488
+ }
2489
+ /**
2490
+ * Target
2491
+ */
2492
+ export type Target = {
2493
+ /**
2494
+ * Target ID.
2495
+ */
2496
+ $id: string;
2497
+ /**
2498
+ * Target creation time in ISO 8601 format.
2499
+ */
2500
+ $createdAt: string;
2501
+ /**
2502
+ * Target update date in ISO 8601 format.
2503
+ */
2504
+ $updatedAt: string;
2505
+ /**
2506
+ * Target Name.
2507
+ */
2508
+ name: string;
2509
+ /**
2510
+ * User ID.
2511
+ */
2512
+ userId: string;
2513
+ /**
2514
+ * Provider ID.
2515
+ */
2516
+ providerId?: string;
2517
+ /**
2518
+ * The target provider type. Can be one of the following: `email`, `sms` or `push`.
2519
+ */
2520
+ providerType: string;
2521
+ /**
2522
+ * The target identifier.
2523
+ */
2524
+ identifier: string;
2525
+ }
2526
+ export type Applet = {
2527
+ id: string;
2528
+ name: string;
2529
+
2530
+ }
2531
+
2532
+ export type AppletList = {
2533
+ applets: Applet[];
2534
+
2535
+ }
2536
+
2537
+ export type Tenant = {
2538
+ /**
2539
+ * Target ID.
2540
+ */
2541
+ $id: string;
2542
+ /**
2543
+ * Target creation time in ISO 8601 format.
2544
+ */
2545
+ $createdAt?: string;
2546
+ /**
2547
+ * Target update date in ISO 8601 format.
2548
+ */
2549
+ $updatedAt?: string;
2550
+
2551
+ name: string;
2552
+
2553
+ slug: string;
2554
+
2555
+ users: User<any>[];
2556
+ }
2557
+ export type TenantList = {
2558
+ tenants: Tenant[];
2559
+ total: number;
2560
+
2561
+ }
2562
+
2563
+ export type TenantUser = {
2564
+ /**
2565
+ * Target ID.
2566
+ */
2567
+ $id?: string;
2568
+ /**
2569
+ * Target creation time in ISO 8601 format.
2570
+ */
2571
+ $createdAt?: string;
2572
+ /**
2573
+ * Target update date in ISO 8601 format.
2574
+ */
2575
+ $updatedAt?: string;
2576
+
2577
+ tenantId: string;
2578
+
2579
+ userId: string;
2580
+
2581
+ user?: User<any>;
2582
+ }
2583
+ export type TenantUserList = {
2584
+ tenantUsers: TenantUser[];
2585
+ total: number;
2586
+
2587
+ }
2588
+
2589
+ export type _Role = {
2590
+ /**
2591
+ * Target ID.
2592
+ */
2593
+ $id: string;
2594
+ /**
2595
+ * Target creation time in ISO 8601 format.
2596
+ */
2597
+ $createdAt: string;
2598
+ /**
2599
+ * Target update date in ISO 8601 format.
2600
+ */
2601
+ $updatedAt: string;
2602
+
2603
+ name: string;
2604
+
2605
+ description: string;
2606
+ }
2607
+ export type RoleList = {
2608
+ roles: Role[];
2609
+ total: number;
2610
+
2611
+ }
2612
+
2613
+ /**
2614
+ * Webhook
2615
+ */
2616
+ export type Webhook = {
2617
+ /**
2618
+ * Webhook ID.
2619
+ */
2620
+ $id: string;
2621
+ /**
2622
+ * Webhook creation date in ISO 8601 format.
2623
+ */
2624
+ $createdAt: string;
2625
+ /**
2626
+ * Webhook update date in ISO 8601 format.
2627
+ */
2628
+ $updatedAt: string;
2629
+ /**
2630
+ * Webhook name.
2631
+ */
2632
+ name: string;
2633
+ /**
2634
+ * Webhook URL endpoint.
2635
+ */
2636
+ url: string;
2637
+ /**
2638
+ * Webhook trigger events.
2639
+ */
2640
+ events: string[];
2641
+ /**
2642
+ * Indicated if SSL / TLS Certificate verification is enabled.
2643
+ */
2644
+ security: boolean;
2645
+ /**
2646
+ * HTTP basic authentication username.
2647
+ */
2648
+ httpUser: string;
2649
+ /**
2650
+ * HTTP basic authentication password.
2651
+ */
2652
+ httpPass: string;
2653
+ /**
2654
+ * Signature key which can be used to validated incoming
2655
+ */
2656
+ signatureKey: string;
2657
+ /**
2658
+ * Indicates if this webhook is enabled.
2659
+ */
2660
+ enabled: boolean;
2661
+ /**
2662
+ * Webhook error logs from the most recent failure.
2663
+ */
2664
+ logs: string;
2665
+ /**
2666
+ * Number of consecutive failed webhook attempts.
2667
+ */
2668
+ attempts: number;
2669
+ }
2670
+
2671
+ export type WebhookList = {
2672
+ /**
2673
+ * Total number of webhooks documents that matched your query.
2674
+ */
2675
+ total: number;
2676
+ /**
2677
+ * List of webhooks.
2678
+ */
2679
+ webhooks: Webhook[];
2680
+ }
2681
+
2682
+ export type Permission = {
2683
+ /**
2684
+ * Target ID.
2685
+ */
2686
+ $id: string;
2687
+ /**
2688
+ * Target creation time in ISO 8601 format.
2689
+ */
2690
+ $createdAt: string;
2691
+ /**
2692
+ * Target update date in ISO 8601 format.
2693
+ */
2694
+ $updatedAt: string;
2695
+
2696
+ name: string;
2697
+
2698
+ description: string;
2699
+
2700
+ type: string;
2701
+ isDefault: boolean;
2702
+ }
2703
+ export type PermissionList = {
2704
+ permissions: Permission[];
2705
+ total: number;
2706
+ }
2707
+
2708
+
2709
+ export type PermissionInRole = {
2710
+ /**
2711
+ * Target ID.
2712
+ */
2713
+ $id: string;
2714
+ /**
2715
+ * Target creation time in ISO 8601 format.
2716
+ */
2717
+ $createdAt: string;
2718
+ /**
2719
+ * Target update date in ISO 8601 format.
2720
+ */
2721
+ $updatedAt: string;
2722
+
2723
+ roleId: string;
2724
+
2725
+ permissionId: string;
2726
+
2727
+
2728
+ }
2729
+ export type PermissionInRoleList = {
2730
+ inRoles: Role[];
2731
+ total: number;
2732
+ }
2733
+
2734
+ export type MockNumber = {
2735
+ /**
2736
+ * Mock phone number for testing phone authentication. Useful for testing phone authentication without sending an SMS.
2737
+ */
2738
+ phone: string;
2739
+ /**
2740
+ * Mock OTP for the number.
2741
+ */
2742
+ otp: string;
2743
+ }
2744
+ /**
2745
+ * AuthProvider
2746
+ */
2747
+ export type AuthProvider = {
2748
+ /**
2749
+ * Auth Provider.
2750
+ */
2751
+ key: string;
2752
+ /**
2753
+ * Auth Provider name.
2754
+ */
2755
+ name: string;
2756
+ /**
2757
+ * OAuth 2.0 application ID.
2758
+ */
2759
+ appId: string;
2760
+ /**
2761
+ * OAuth 2.0 application secret. Might be JSON string if provider requires extra configuration.
2762
+ */
2763
+ secret: string;
2764
+ /**
2765
+ * Auth Provider is active and can be used to create session.
2766
+ */
2767
+ enabled: boolean;
2768
+ }
2769
+
2770
+
2771
+ export type Project = {
2772
+ /**
2773
+ * Project ID.
2774
+ */
2775
+ $id: string;
2776
+ /**
2777
+ * Project creation date in ISO 8601 format.
2778
+ */
2779
+ $createdAt: string;
2780
+ /**
2781
+ * Project update date in ISO 8601 format.
2782
+ */
2783
+ $updatedAt: string;
2784
+ /**
2785
+ * Project name.
2786
+ */
2787
+ name: string;
2788
+ /**
2789
+ * Project description.
2790
+ */
2791
+ description: string;
2792
+ /**
2793
+ * Project team ID.
2794
+ */
2795
+ teamId: string;
2796
+ /**
2797
+ * Project logo file ID.
2798
+ */
2799
+ logo: string;
2800
+ /**
2801
+ * Project website URL.
2802
+ */
2803
+ url: string;
2804
+ /**
2805
+ * Company legal name.
2806
+ */
2807
+ legalName: string;
2808
+ /**
2809
+ * Country code in [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) two-character format.
2810
+ */
2811
+ legalCountry: string;
2812
+ /**
2813
+ * State name.
2814
+ */
2815
+ legalState: string;
2816
+ /**
2817
+ * City name.
2818
+ */
2819
+ legalCity: string;
2820
+ /**
2821
+ * Company Address.
2822
+ */
2823
+ legalAddress: string;
2824
+ /**
2825
+ * Company Tax ID.
2826
+ */
2827
+ legalTaxId: string;
2828
+ /**
2829
+ * Session duration in seconds.
2830
+ */
2831
+ authDuration: number;
2832
+ /**
2833
+ * Max users allowed. 0 is unlimited.
2834
+ */
2835
+ authLimit: number;
2836
+ /**
2837
+ * Max sessions allowed per user. 100 maximum.
2838
+ */
2839
+ authSessionsLimit: number;
2840
+ /**
2841
+ * Max allowed passwords in the history list per user. Max passwords limit allowed in history is 20. Use 0 for disabling password history.
2842
+ */
2843
+ authPasswordHistory: number;
2844
+ /**
2845
+ * Whether or not to check user&#039;s password against most commonly used passwords.
2846
+ */
2847
+ authPasswordDictionary: boolean;
2848
+ /**
2849
+ * Whether or not to check the user password for similarity with their personal data.
2850
+ */
2851
+ authPersonalDataCheck: boolean;
2852
+ /**
2853
+ * An array of mock numbers and their corresponding verification codes (OTPs).
2854
+ */
2855
+ authMockNumbers: MockNumber[];
2856
+ /**
2857
+ * Whether or not to send session alert emails to users.
2858
+ */
2859
+ authSessionAlerts: boolean;
2860
+ /**
2861
+ * List of Auth Providers.
2862
+ */
2863
+ oAuthProviders: AuthProvider[];
2864
+ /**
2865
+ * List of Platforms.
2866
+ */
2867
+ platforms: Platform[];
2868
+ /**
2869
+ * List of Webhooks.
2870
+ */
2871
+ webhooks: Webhook[];
2872
+ /**
2873
+ * List of API Keys.
2874
+ */
2875
+ keys: Key[];
2876
+ /**
2877
+ * Status for custom SMTP
2878
+ */
2879
+ smtpEnabled: boolean;
2880
+ /**
2881
+ * SMTP sender name
2882
+ */
2883
+ smtpSenderName: string;
2884
+ /**
2885
+ * SMTP sender email
2886
+ */
2887
+ smtpSenderEmail: string;
2888
+ /**
2889
+ * SMTP reply to email
2890
+ */
2891
+ smtpReplyTo: string;
2892
+ /**
2893
+ * SMTP server host name
2894
+ */
2895
+ smtpHost: string;
2896
+ /**
2897
+ * SMTP server port
2898
+ */
2899
+ smtpPort: number;
2900
+ /**
2901
+ * SMTP server username
2902
+ */
2903
+ smtpUsername: string;
2904
+ /**
2905
+ * SMTP server password
2906
+ */
2907
+ smtpPassword: string;
2908
+ /**
2909
+ * SMTP server secure protocol
2910
+ */
2911
+ smtpSecure: string;
2912
+ /**
2913
+ * Email/Password auth method status
2914
+ */
2915
+ authEmailPassword: boolean;
2916
+ /**
2917
+ * Magic URL auth method status
2918
+ */
2919
+ authUsersAuthMagicURL: boolean;
2920
+ /**
2921
+ * Email (OTP) auth method status
2922
+ */
2923
+ authEmailOtp: boolean;
2924
+ /**
2925
+ * Anonymous auth method status
2926
+ */
2927
+ authAnonymous: boolean;
2928
+ /**
2929
+ * Invites auth method status
2930
+ */
2931
+ authInvites: boolean;
2932
+ /**
2933
+ * JWT auth method status
2934
+ */
2935
+ authJWT: boolean;
2936
+ /**
2937
+ * Phone auth method status
2938
+ */
2939
+ authPhone: boolean;
2940
+ /**
2941
+ * Account service status
2942
+ */
2943
+ serviceStatusForAccount: boolean;
2944
+ /**
2945
+ * Avatars service status
2946
+ */
2947
+ serviceStatusForAvatars: boolean;
2948
+ /**
2949
+ * Databases service status
2950
+ */
2951
+ serviceStatusForDatabases: boolean;
2952
+ /**
2953
+ * Locale service status
2954
+ */
2955
+ serviceStatusForLocale: boolean;
2956
+ /**
2957
+ * Health service status
2958
+ */
2959
+ serviceStatusForHealth: boolean;
2960
+ /**
2961
+ * Storage service status
2962
+ */
2963
+ serviceStatusForStorage: boolean;
2964
+ /**
2965
+ * Teams service status
2966
+ */
2967
+ serviceStatusForTeams: boolean;
2968
+ /**
2969
+ * Users service status
2970
+ */
2971
+ serviceStatusForUsers: boolean;
2972
+ /**
2973
+ * Functions service status
2974
+ */
2975
+ serviceStatusForFunctions: boolean;
2976
+ /**
2977
+ * GraphQL service status
2978
+ */
2979
+ serviceStatusForGraphql: boolean;
2980
+ /**
2981
+ * Messaging service status
2982
+ */
2983
+ serviceStatusForMessaging: boolean;
2984
+ }
2985
+
2986
+ export type ProjectList = {
2987
+ /**
2988
+ * Total number of projects documents that matched your query.
2989
+ */
2990
+ total: number;
2991
+ /**
2992
+ * List of projects.
2993
+ */
2994
+ projects: Project[];
2995
+ }
2996
+
2997
+ export type KeyList = {
2998
+ /**
2999
+ * Total number of keys documents that matched your query.
3000
+ */
3001
+ total: number;
3002
+ /**
3003
+ * List of keys.
3004
+ */
3005
+ keys: Key[];
3006
+ }
3007
+
3008
+ /**
3009
+ * Key
3010
+ */
3011
+ export type Key = {
3012
+ /**
3013
+ * Key ID.
3014
+ */
3015
+ $id: string;
3016
+ /**
3017
+ * Key creation date in ISO 8601 format.
3018
+ */
3019
+ $createdAt: string;
3020
+ /**
3021
+ * Key update date in ISO 8601 format.
3022
+ */
3023
+ $updatedAt: string;
3024
+ /**
3025
+ * Key name.
3026
+ */
3027
+ name: string;
3028
+ /**
3029
+ * Key expiration date in ISO 8601 format.
3030
+ */
3031
+ expire: string;
3032
+ /**
3033
+ * Allowed permission scopes.
3034
+ */
3035
+ scopes: string[];
3036
+ /**
3037
+ * Secret key.
3038
+ */
3039
+ secret: string;
3040
+ /**
3041
+ * Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.
3042
+ */
3043
+ accessedAt: string;
3044
+ /**
3045
+ * List of SDK user agents that used this key.
3046
+ */
3047
+ sdks: string[];
3048
+ }
3049
+
3050
+ export type PlatformList = {
3051
+ /**
3052
+ * Total number of platforms documents that matched your query.
3053
+ */
3054
+ total: number;
3055
+ /**
3056
+ * List of platforms.
3057
+ */
3058
+ platforms: Platform[];
3059
+ }
3060
+
3061
+ /**
3062
+ * Platform
3063
+ */
3064
+ export type Platform = {
3065
+ /**
3066
+ * Platform ID.
3067
+ */
3068
+ $id: string;
3069
+ /**
3070
+ * Platform creation date in ISO 8601 format.
3071
+ */
3072
+ $createdAt: string;
3073
+ /**
3074
+ * Platform update date in ISO 8601 format.
3075
+ */
3076
+ $updatedAt: string;
3077
+ /**
3078
+ * Platform name.
3079
+ */
3080
+ name: string;
3081
+ /**
3082
+ * Platform type. Possible values are: web, flutter-web, flutter-ios, flutter-android, ios, android, and unity.
3083
+ */
3084
+ type: string;
3085
+ /**
3086
+ * Platform Key. iOS bundle ID or Android package name. Empty string for other platforms.
3087
+ */
3088
+ key: string;
3089
+ /**
3090
+ * App store or Google Play store ID.
3091
+ */
3092
+ store: string;
3093
+ /**
3094
+ * Web app hostname. Empty string for other platforms.
3095
+ */
3096
+ hostname: string;
3097
+ /**
3098
+ * HTTP basic authentication username.
3099
+ */
3100
+ httpUser: string;
3101
+ /**
3102
+ * HTTP basic authentication password.
3103
+ */
3104
+ httpPass: string;
3105
+ }
3106
+
3107
+ export type EmailTemplate = {
3108
+ /**
3109
+ * Template type
3110
+ */
3111
+ type: string;
3112
+ /**
3113
+ * Template locale
3114
+ */
3115
+ locale: string;
3116
+ /**
3117
+ * Template message
3118
+ */
3119
+ message: string;
3120
+ /**
3121
+ * Name of the sender
3122
+ */
3123
+ senderName: string;
3124
+ /**
3125
+ * Email of the sender
3126
+ */
3127
+ senderEmail: string;
3128
+ /**
3129
+ * Reply to email address
3130
+ */
3131
+ replyTo: string;
3132
+ /**
3133
+ * Email subject
3134
+ */
3135
+ subject: string;
3136
+ }
3137
+
3138
+ export type SpaceGroup = {
3139
+ /**
3140
+ * Target ID.
3141
+ */
3142
+ $id: string;
3143
+ /**
3144
+ * Target creation time in ISO 8601 format.
3145
+ */
3146
+ $createdAt?: string;
3147
+ /**
3148
+ * Target update date in ISO 8601 format.
3149
+ */
3150
+ $updatedAt?: string;
3151
+
3152
+ name: string;
3153
+
3154
+ description?: string;
3155
+ }
3156
+ export type SpaceGroupList = {
3157
+ spaceGroups: SpaceGroup[];
3158
+ total: number;
3159
+
3160
+ }
3161
+
3162
+ export type Log = {
3163
+ $id: string;
3164
+ /**
3165
+ * Target creation time in ISO 8601 format.
3166
+ */
3167
+ $createdAt?: string;
3168
+ /**
3169
+ * Target update date in ISO 8601 format.
3170
+ */
3171
+ $updatedAt?: string;
3172
+
3173
+ tenantId: string;
3174
+ userId: string;
3175
+ apiKeyId: string;
3176
+ rowId: string;
3177
+ url: string;
3178
+ action: string;
3179
+ details: string | null;
3180
+ commentId: string | null;
3181
+ }
3182
+
3183
+ export type Role = {
3184
+ $id: string;
3185
+ /**
3186
+ * Target creation time in ISO 8601 format.
3187
+ */
3188
+ $createdAt?: string;
3189
+ /**
3190
+ * Target update date in ISO 8601 format.
3191
+ */
3192
+ $updatedAt?: string;
3193
+
3194
+ name: string
3195
+ description: string
3196
+ type: string
3197
+ assignToNewUsers: boolean
3198
+ isDefault: boolean
3199
+ order: number
3200
+
3201
+ }
3202
+
3203
+ export type AdminUser = {
3204
+ $id: string;
3205
+ /**
3206
+ * Target creation time in ISO 8601 format.
3207
+ */
3208
+ $createdAt?: string;
3209
+ /**
3210
+ * Target update date in ISO 8601 format.
3211
+ */
3212
+ $updatedAt?: string;
3213
+
3214
+ userId: string;
3215
+
3216
+ }
3217
+
3218
+ export type AdminUserList = {
3219
+ adminUsers: AdminUser[];
3220
+ total: number;
3221
+
3222
+ }
3223
+
3224
+ export type UserRole = {
3225
+ $id: string;
3226
+ /**
3227
+ * Target creation time in ISO 8601 format.
3228
+ */
3229
+ $createdAt?: string;
3230
+ /**
3231
+ * Target update date in ISO 8601 format.
3232
+ */
3233
+ $updatedAt?: string;
3234
+
3235
+ userId: string;
3236
+ roleId: string;
3237
+ tenantId: string | null;
3238
+
3239
+ }
3240
+
3241
+ export type UserRoleList = {
3242
+ userRoles: UserRole[];
3243
+ total: number;
3244
+
3245
+ }
3246
+
3247
+ export type TenantType = {
3248
+ $id: string;
3249
+ /**
3250
+ * Target creation time in ISO 8601 format.
3251
+ */
3252
+ $createdAt?: string;
3253
+ /**
3254
+ * Target update date in ISO 8601 format.
3255
+ */
3256
+ $updatedAt?: string;
3257
+
3258
+ title: string;
3259
+ titlePlural: string;
3260
+ description: string;
3261
+ isDefault: string;
3262
+
3263
+ }
3264
+
3265
+ export type Group = {
3266
+ $id: string;
3267
+ /**
3268
+ * Target creation time in ISO 8601 format.
3269
+ */
3270
+ $createdAt?: string;
3271
+ /**
3272
+ * Target update date in ISO 8601 format.
3273
+ */
3274
+ $updatedAt?: string;
3275
+
3276
+ tenantId: string | null;
3277
+ name: string;
3278
+ description: string;
3279
+ color: string;
3280
+
3281
+ }
3282
+
3283
+ export type GroupUser = {
3284
+ $id: string;
3285
+ /**
3286
+ * Target creation time in ISO 8601 format.
3287
+ */
3288
+ $createdAt?: string;
3289
+ /**
3290
+ * Target update date in ISO 8601 format.
3291
+ */
3292
+ $updatedAt?: string;
3293
+
3294
+ groupId: string;
3295
+ userId: string;
3296
+
3297
+ }
3298
+
3299
+ export type GroupWithDetails = Group & {
3300
+ users: (GroupUser & { user: User<any> })[];
3301
+ };
3302
+
3303
+ export type TenantUserWithUser = TenantUser & {
3304
+ user: UserWithRoles;
3305
+ };
3306
+
3307
+ export type UserWithRoles = User<any> & {
3308
+ admin?: AdminUser | null;
3309
+ roles: (UserRole & { role: Role })[];
3310
+ }
3311
+
3312
+ export type RoleWithPermissions = Role & {
3313
+ permissions: (RolePermission & { permission: Permission })[];
3314
+ };
3315
+
3316
+ export type RolePermission = {
3317
+ $id: string;
3318
+ /**
3319
+ * Target creation time in ISO 8601 format.
3320
+ */
3321
+ $createdAt?: string;
3322
+ /**
3323
+ * Target update date in ISO 8601 format.
3324
+ */
3325
+ $updatedAt?: string;
3326
+
3327
+ roleId: string
3328
+ permissionId: string
3329
+ }
3330
+
3331
+ export type PermissionWithRoles = Permission & {
3332
+ inRoles: (RolePermission & { role: Role })[];
3333
+ };
3334
+
3335
+ export type RoleWithPermissionsAndUsers = RoleWithPermissions & {
3336
+ users: (UserRole & { user: User<any> })[];
3337
+ };
3338
+
3339
+ }