@appconda/nextjs 1.0.115 → 1.0.116

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