@appconda/sdk 1.0.194 → 1.0.410

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 (984) 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/actions/_authOptions.d.ts +5 -0
  8. package/dist/actions/_authOptions.js +235 -0
  9. package/dist/actions/actionClient.d.ts +10 -0
  10. package/dist/actions/actionClient.js +41 -0
  11. package/dist/actions/auth.d.ts +1 -0
  12. package/dist/actions/auth.js +7 -0
  13. package/dist/actions/authOptions.d.ts +5 -0
  14. package/dist/actions/authOptions.js +133 -0
  15. package/dist/actions/index.d.ts +3 -0
  16. package/dist/actions/index.js +4 -0
  17. package/dist/actions/nextAuthHandler.d.ts +1 -0
  18. package/dist/actions/nextAuthHandler.js +6 -0
  19. package/dist/client.d.ts +141 -0
  20. package/dist/client.js +335 -0
  21. package/dist/decorators/Cache.d.ts +1 -0
  22. package/dist/decorators/Cache.js +79 -0
  23. package/dist/decorators/CacheKey.d.ts +1 -0
  24. package/dist/decorators/CacheKey.js +9 -0
  25. package/dist/decorators/Invalidate.d.ts +1 -0
  26. package/dist/decorators/Invalidate.js +47 -0
  27. package/dist/enums/api-service.d.ts +13 -0
  28. package/dist/enums/api-service.js +15 -0
  29. package/dist/enums/api.d.ts +5 -0
  30. package/dist/enums/api.js +7 -0
  31. package/dist/enums/auth-method.d.ts +9 -0
  32. package/dist/enums/auth-method.js +11 -0
  33. package/dist/enums/browser.d.ts +16 -0
  34. package/dist/enums/browser.js +18 -0
  35. package/dist/enums/compression.d.ts +5 -0
  36. package/dist/enums/compression.js +7 -0
  37. package/dist/enums/credit-card.d.ts +18 -0
  38. package/dist/enums/credit-card.js +20 -0
  39. package/dist/enums/database-usage-range.d.ts +5 -0
  40. package/dist/enums/database-usage-range.js +7 -0
  41. package/dist/enums/email-template-locale.d.ts +133 -0
  42. package/dist/enums/email-template-locale.js +135 -0
  43. package/dist/enums/email-template-type.d.ts +9 -0
  44. package/dist/enums/email-template-type.js +11 -0
  45. package/dist/enums/entities/EntityLimitType.d.ts +4 -0
  46. package/dist/enums/entities/EntityLimitType.js +6 -0
  47. package/dist/enums/entities/PropertyAttributeName.d.ts +27 -0
  48. package/dist/enums/entities/PropertyAttributeName.js +29 -0
  49. package/dist/enums/entities/PropertyCondition.d.ts +7 -0
  50. package/dist/enums/entities/PropertyCondition.js +10 -0
  51. package/dist/enums/entities/PropertyType.d.ts +12 -0
  52. package/dist/enums/entities/PropertyType.js +18 -0
  53. package/dist/enums/entities/PropertyValueType.d.ts +6 -0
  54. package/dist/enums/entities/PropertyValueType.js +8 -0
  55. package/dist/enums/entities/RowAccess.d.ts +2 -0
  56. package/dist/enums/entities/RowAccess.js +2 -0
  57. package/dist/enums/entities/ViewFilterCondition.d.ts +12 -0
  58. package/dist/enums/entities/ViewFilterCondition.js +14 -0
  59. package/dist/enums/execution-method.d.ts +8 -0
  60. package/dist/enums/execution-method.js +10 -0
  61. package/dist/enums/flag.d.ts +197 -0
  62. package/dist/enums/flag.js +199 -0
  63. package/dist/enums/function-usage-range.d.ts +5 -0
  64. package/dist/enums/function-usage-range.js +7 -0
  65. package/dist/enums/image-format.d.ts +7 -0
  66. package/dist/enums/image-format.js +9 -0
  67. package/dist/enums/image-gravity.d.ts +11 -0
  68. package/dist/enums/image-gravity.js +13 -0
  69. package/dist/enums/index-type.d.ts +5 -0
  70. package/dist/enums/index-type.js +7 -0
  71. package/dist/enums/messaging-provider-type.d.ts +5 -0
  72. package/dist/enums/messaging-provider-type.js +7 -0
  73. package/dist/enums/name.d.ts +14 -0
  74. package/dist/enums/name.js +16 -0
  75. package/dist/enums/o-auth-provider copy.d.ts +41 -0
  76. package/dist/enums/o-auth-provider copy.js +43 -0
  77. package/dist/enums/password-hash.d.ts +13 -0
  78. package/dist/enums/password-hash.js +15 -0
  79. package/dist/enums/platform-type.d.ts +17 -0
  80. package/dist/enums/platform-type.js +19 -0
  81. package/dist/enums/project-usage-range.d.ts +4 -0
  82. package/dist/enums/project-usage-range.js +6 -0
  83. package/dist/enums/region.d.ts +4 -0
  84. package/dist/enums/region.js +6 -0
  85. package/dist/enums/relation-mutate.d.ts +5 -0
  86. package/dist/enums/relation-mutate.js +7 -0
  87. package/dist/enums/relationship-type.d.ts +6 -0
  88. package/dist/enums/relationship-type.js +8 -0
  89. package/dist/enums/resource-type.d.ts +4 -0
  90. package/dist/enums/resource-type.js +6 -0
  91. package/dist/enums/runtime.d.ts +48 -0
  92. package/dist/enums/runtime.js +50 -0
  93. package/dist/enums/s-m-t-p-secure.d.ts +3 -0
  94. package/dist/enums/s-m-t-p-secure.js +5 -0
  95. package/dist/enums/shared/ApplicationLayout.d.ts +4 -0
  96. package/dist/enums/shared/ApplicationLayout.js +6 -0
  97. package/dist/enums/shared/Colors.d.ts +24 -0
  98. package/dist/enums/shared/Colors.js +26 -0
  99. package/dist/enums/shared/InputType.d.ts +6 -0
  100. package/dist/enums/shared/InputType.js +8 -0
  101. package/dist/enums/shared/Periodicity.d.ts +7 -0
  102. package/dist/enums/shared/Periodicity.js +9 -0
  103. package/dist/enums/shared/SvgIcon.d.ts +37 -0
  104. package/dist/enums/shared/SvgIcon.js +39 -0
  105. package/dist/enums/shared/Theme.d.ts +4 -0
  106. package/dist/enums/shared/Theme.js +6 -0
  107. package/dist/enums/sms-template-locale.d.ts +133 -0
  108. package/dist/enums/sms-template-locale.js +135 -0
  109. package/dist/enums/sms-template-type.d.ts +6 -0
  110. package/dist/enums/sms-template-type.js +8 -0
  111. package/dist/enums/smtp-encryption.d.ts +5 -0
  112. package/dist/enums/smtp-encryption.js +7 -0
  113. package/dist/enums/storage-usage-range.d.ts +5 -0
  114. package/dist/enums/storage-usage-range.js +7 -0
  115. package/dist/enums/subscriptions/PricingModel.d.ts +11 -0
  116. package/dist/enums/subscriptions/PricingModel.js +12 -0
  117. package/dist/enums/subscriptions/SubscriptionBillingPeriod.d.ts +10 -0
  118. package/dist/enums/subscriptions/SubscriptionBillingPeriod.js +11 -0
  119. package/dist/enums/subscriptions/SubscriptionFeatureLimitType.d.ts +10 -0
  120. package/dist/enums/subscriptions/SubscriptionFeatureLimitType.js +13 -0
  121. package/dist/enums/subscriptions/SubscriptionPriceType.d.ts +7 -0
  122. package/dist/enums/subscriptions/SubscriptionPriceType.js +8 -0
  123. package/dist/enums/tenants/LinkedAccountStatus.d.ts +5 -0
  124. package/dist/enums/tenants/LinkedAccountStatus.js +7 -0
  125. package/dist/enums/tenants/TenantUserJoined.d.ts +6 -0
  126. package/dist/enums/tenants/TenantUserJoined.js +8 -0
  127. package/dist/enums/tenants/TenantUserStatus.d.ts +6 -0
  128. package/dist/enums/tenants/TenantUserStatus.js +8 -0
  129. package/dist/enums/tenants/TenantUserType.d.ts +5 -0
  130. package/dist/enums/tenants/TenantUserType.js +7 -0
  131. package/dist/enums/user-usage-range.d.ts +5 -0
  132. package/dist/enums/user-usage-range.js +7 -0
  133. package/dist/getAppcondaClient.d.ts +3 -0
  134. package/dist/getAppcondaClient.js +71 -0
  135. package/dist/getSDKForCurrentUser.d.ts +59 -0
  136. package/dist/getSDKForCurrentUser.js +100 -0
  137. package/dist/getSDKForService.d.ts +18 -0
  138. package/dist/getSDKForService.js +67 -0
  139. package/dist/getSDKForTenant.d.ts +20 -0
  140. package/dist/getSDKForTenant.js +44 -0
  141. package/dist/id.d.ts +20 -0
  142. package/dist/id.js +45 -0
  143. package/dist/index.d.ts +1 -0
  144. package/dist/index.js +2 -0
  145. package/dist/inputFile.d.ts +7 -0
  146. package/dist/inputFile.js +17 -0
  147. package/dist/lib/Cache/Adapter.d.ts +10 -0
  148. package/dist/lib/Cache/Adapter.js +2 -0
  149. package/dist/lib/Cache/Adapters/Filesystem.d.ts +16 -0
  150. package/dist/lib/Cache/Adapters/Filesystem.js +103 -0
  151. package/dist/lib/Cache/Adapters/Memory.d.ts +18 -0
  152. package/dist/lib/Cache/Adapters/Memory.js +47 -0
  153. package/dist/lib/Cache/Adapters/None.d.ts +12 -0
  154. package/dist/lib/Cache/Adapters/None.js +28 -0
  155. package/dist/lib/Cache/Adapters/Sharding.d.ts +17 -0
  156. package/dist/lib/Cache/Adapters/Sharding.js +73 -0
  157. package/dist/lib/Cache/Cache.d.ts +16 -0
  158. package/dist/lib/Cache/Cache.js +52 -0
  159. package/dist/lib/Cache/index.d.ts +4 -0
  160. package/dist/lib/Cache/index.js +5 -0
  161. package/dist/lib/Cache/test.d.ts +0 -0
  162. package/dist/lib/Cache/test.js +1 -0
  163. package/dist/lib/Registry/Registry.d.ts +38 -0
  164. package/dist/lib/Registry/Registry.js +56 -0
  165. package/dist/lib/Registry/index.d.ts +1 -0
  166. package/dist/lib/Registry/index.js +2 -0
  167. package/dist/lib/Services.d.ts +6 -0
  168. package/dist/lib/Services.js +14 -0
  169. package/dist/lib/crypto.d.ts +23 -0
  170. package/dist/lib/crypto.js +78 -0
  171. package/dist/lib/env.d.ts +1 -0
  172. package/dist/lib/env.js +137 -0
  173. package/dist/lib/errors.d.ts +70 -0
  174. package/dist/lib/errors.js +79 -0
  175. package/dist/lib/index.d.ts +0 -0
  176. package/dist/lib/index.js +1 -0
  177. package/dist/lib/jwt.d.ts +12 -0
  178. package/dist/lib/jwt.js +103 -0
  179. package/dist/lib/types.d.ts +5 -0
  180. package/dist/lib/types.js +2 -0
  181. package/dist/models.d.ts +3272 -0
  182. package/dist/models.js +2 -0
  183. package/dist/modules/account/actions.d.ts +11 -0
  184. package/dist/modules/account/actions.js +49 -0
  185. package/dist/modules/account/enums/authentication-factor.d.ts +6 -0
  186. package/dist/modules/account/enums/authentication-factor.js +8 -0
  187. package/dist/modules/account/enums/authenticator-type.d.ts +3 -0
  188. package/dist/modules/account/enums/authenticator-type.js +5 -0
  189. package/dist/modules/account/enums/o-auth-provider.d.ts +41 -0
  190. package/dist/modules/account/enums/o-auth-provider.js +43 -0
  191. package/dist/modules/account/index.d.ts +2 -0
  192. package/dist/modules/account/index.js +3 -0
  193. package/dist/modules/account/schema.d.ts +7 -0
  194. package/dist/modules/account/schema.js +8 -0
  195. package/dist/modules/account/service.d.ts +530 -0
  196. package/dist/modules/account/service.js +1263 -0
  197. package/dist/modules/account/types.d.ts +411 -0
  198. package/dist/modules/account/types.js +2 -0
  199. package/dist/modules/accounv1/action.d.ts +9 -0
  200. package/dist/modules/accounv1/action.js +88 -0
  201. package/dist/modules/accounv1/index.d.ts +3 -0
  202. package/dist/modules/accounv1/index.js +4 -0
  203. package/dist/modules/accounv1/schema.d.ts +43 -0
  204. package/dist/modules/accounv1/schema.js +44 -0
  205. package/dist/modules/accounv1/service.d.ts +14 -0
  206. package/dist/modules/accounv1/service.js +28 -0
  207. package/dist/modules/accounv1/types.d.ts +14 -0
  208. package/dist/modules/accounv1/types.js +2 -0
  209. package/dist/modules/acl/service.d.ts +26 -0
  210. package/dist/modules/acl/service.js +27 -0
  211. package/dist/modules/agent/action.d.ts +29 -0
  212. package/dist/modules/agent/action.js +53 -0
  213. package/dist/modules/agent/index.d.ts +4 -0
  214. package/dist/modules/agent/index.js +5 -0
  215. package/dist/modules/agent/schema.d.ts +20 -0
  216. package/dist/modules/agent/schema.js +21 -0
  217. package/dist/modules/agent/service.d.ts +12 -0
  218. package/dist/modules/agent/service.js +22 -0
  219. package/dist/modules/agent/types.d.ts +11 -0
  220. package/dist/modules/agent/types.js +2 -0
  221. package/dist/modules/ai/index.d.ts +1 -0
  222. package/dist/modules/ai/index.js +2 -0
  223. package/dist/modules/ai/node/actions.d.ts +4 -0
  224. package/dist/modules/ai/node/actions.js +14 -0
  225. package/dist/modules/ai/node/index.d.ts +2 -0
  226. package/dist/modules/ai/node/index.js +3 -0
  227. package/dist/modules/ai/node/service.d.ts +5 -0
  228. package/dist/modules/ai/node/service.js +12 -0
  229. package/dist/modules/bpm/action.d.ts +7 -0
  230. package/dist/modules/bpm/action.js +60 -0
  231. package/dist/modules/bpm/index.d.ts +3 -0
  232. package/dist/modules/bpm/index.js +4 -0
  233. package/dist/modules/bpm/schema.d.ts +18 -0
  234. package/dist/modules/bpm/schema.js +19 -0
  235. package/dist/modules/bpm/service.d.ts +11 -0
  236. package/dist/modules/bpm/service.js +19 -0
  237. package/dist/modules/bpm/types.d.ts +9 -0
  238. package/dist/modules/bpm/types.js +2 -0
  239. package/dist/modules/builder/action.d.ts +18 -0
  240. package/dist/modules/builder/action.js +214 -0
  241. package/dist/modules/builder/index.d.ts +4 -0
  242. package/dist/modules/builder/index.js +5 -0
  243. package/dist/modules/builder/schema.d.ts +80 -0
  244. package/dist/modules/builder/schema.js +81 -0
  245. package/dist/modules/builder/service.d.ts +22 -0
  246. package/dist/modules/builder/service.js +52 -0
  247. package/dist/modules/builder/types.d.ts +62 -0
  248. package/dist/modules/builder/types.js +2 -0
  249. package/dist/modules/datasource/action.d.ts +14 -0
  250. package/dist/modules/datasource/action.js +172 -0
  251. package/dist/modules/datasource/index.d.ts +4 -0
  252. package/dist/modules/datasource/index.js +5 -0
  253. package/dist/modules/datasource/schema.d.ts +55 -0
  254. package/dist/modules/datasource/schema.js +56 -0
  255. package/dist/modules/datasource/service.d.ts +19 -0
  256. package/dist/modules/datasource/service.js +43 -0
  257. package/dist/modules/datasource/types.d.ts +28 -0
  258. package/dist/modules/datasource/types.js +2 -0
  259. package/dist/modules/emploid/action.d.ts +73 -0
  260. package/dist/modules/emploid/action.js +984 -0
  261. package/dist/modules/emploid/index.d.ts +4 -0
  262. package/dist/modules/emploid/index.js +5 -0
  263. package/dist/modules/emploid/schema.d.ts +386 -0
  264. package/dist/modules/emploid/schema.js +331 -0
  265. package/dist/modules/emploid/service.d.ts +77 -0
  266. package/dist/modules/emploid/service.js +217 -0
  267. package/dist/modules/emploid/types.d.ts +114 -0
  268. package/dist/modules/emploid/types.js +2 -0
  269. package/dist/modules/google/action.d.ts +5 -0
  270. package/dist/modules/google/action.js +46 -0
  271. package/dist/modules/google/index.d.ts +4 -0
  272. package/dist/modules/google/index.js +5 -0
  273. package/dist/modules/google/schema.d.ts +13 -0
  274. package/dist/modules/google/schema.js +14 -0
  275. package/dist/modules/google/service.d.ts +10 -0
  276. package/dist/modules/google/service.js +16 -0
  277. package/dist/modules/google/types.d.ts +12 -0
  278. package/dist/modules/google/types.js +2 -0
  279. package/dist/modules/hooks/index.d.ts +3 -0
  280. package/dist/modules/hooks/index.js +4 -0
  281. package/dist/modules/hooks/lib/Hooks.d.ts +32 -0
  282. package/dist/modules/hooks/lib/Hooks.js +64 -0
  283. package/dist/modules/hooks/lib/handler.d.ts +3 -0
  284. package/dist/modules/hooks/lib/handler.js +23 -0
  285. package/dist/modules/hooks/lib/jobs/index.d.ts +2 -0
  286. package/dist/modules/hooks/lib/jobs/index.js +3 -0
  287. package/dist/modules/hooks/lib/jobs/job1.d.ts +1 -0
  288. package/dist/modules/hooks/lib/jobs/job1.js +16 -0
  289. package/dist/modules/hooks/lib/jobs/log-job.d.ts +1 -0
  290. package/dist/modules/hooks/lib/jobs/log-job.js +9 -0
  291. package/dist/modules/hooks/lib/wait.d.ts +8 -0
  292. package/dist/modules/hooks/lib/wait.js +13 -0
  293. package/dist/modules/index.d.ts +17 -0
  294. package/dist/modules/index.js +18 -0
  295. package/dist/modules/mail/action.d.ts +3 -0
  296. package/dist/modules/mail/action.js +18 -0
  297. package/dist/modules/mail/index.d.ts +4 -0
  298. package/dist/modules/mail/index.js +5 -0
  299. package/dist/modules/mail/schema.d.ts +6 -0
  300. package/dist/modules/mail/schema.js +7 -0
  301. package/dist/modules/mail/service.d.ts +8 -0
  302. package/dist/modules/mail/service.js +10 -0
  303. package/dist/modules/mail/types.d.ts +6 -0
  304. package/dist/modules/mail/types.js +2 -0
  305. package/dist/modules/notion/action.d.ts +5 -0
  306. package/dist/modules/notion/action.js +46 -0
  307. package/dist/modules/notion/index.d.ts +4 -0
  308. package/dist/modules/notion/index.js +5 -0
  309. package/dist/modules/notion/schema.d.ts +13 -0
  310. package/dist/modules/notion/schema.js +14 -0
  311. package/dist/modules/notion/service.d.ts +10 -0
  312. package/dist/modules/notion/service.js +19 -0
  313. package/dist/modules/notion/types.d.ts +11 -0
  314. package/dist/modules/notion/types.js +2 -0
  315. package/dist/modules/organization/action.d.ts +7 -0
  316. package/dist/modules/organization/action.js +60 -0
  317. package/dist/modules/organization/index.d.ts +4 -0
  318. package/dist/modules/organization/index.js +5 -0
  319. package/dist/modules/organization/schema.d.ts +24 -0
  320. package/dist/modules/organization/schema.js +20 -0
  321. package/dist/modules/organization/service.d.ts +11 -0
  322. package/dist/modules/organization/service.js +19 -0
  323. package/dist/modules/organization/types.d.ts +11 -0
  324. package/dist/modules/organization/types.js +2 -0
  325. package/dist/modules/scheduled-job/action.d.ts +70 -0
  326. package/dist/modules/scheduled-job/action.js +173 -0
  327. package/dist/modules/scheduled-job/index.d.ts +7 -0
  328. package/dist/modules/scheduled-job/index.js +8 -0
  329. package/dist/modules/scheduled-job/lib/Schedules.d.ts +34 -0
  330. package/dist/modules/scheduled-job/lib/Schedules.js +65 -0
  331. package/dist/modules/scheduled-job/lib/handler.d.ts +3 -0
  332. package/dist/modules/scheduled-job/lib/handler.js +23 -0
  333. package/dist/modules/scheduled-job/lib/jobs/index.d.ts +1 -0
  334. package/dist/modules/scheduled-job/lib/jobs/index.js +2 -0
  335. package/dist/modules/scheduled-job/lib/jobs/job1.d.ts +1 -0
  336. package/dist/modules/scheduled-job/lib/jobs/job1.js +10 -0
  337. package/dist/modules/scheduled-job/lib/wait.d.ts +8 -0
  338. package/dist/modules/scheduled-job/lib/wait.js +13 -0
  339. package/dist/modules/scheduled-job/schema.d.ts +39 -0
  340. package/dist/modules/scheduled-job/schema.js +40 -0
  341. package/dist/modules/scheduled-job/service.d.ts +20 -0
  342. package/dist/modules/scheduled-job/service.js +46 -0
  343. package/dist/modules/scheduled-job/types.d.ts +66 -0
  344. package/dist/modules/scheduled-job/types.js +2 -0
  345. package/dist/modules/task/action.d.ts +64 -0
  346. package/dist/modules/task/action.js +758 -0
  347. package/dist/modules/task/index.d.ts +4 -0
  348. package/dist/modules/task/index.js +5 -0
  349. package/dist/modules/task/schema.d.ts +355 -0
  350. package/dist/modules/task/schema.js +371 -0
  351. package/dist/modules/task/service.d.ts +69 -0
  352. package/dist/modules/task/service.js +193 -0
  353. package/dist/modules/task/types.d.ts +293 -0
  354. package/dist/modules/task/types.js +37 -0
  355. package/dist/modules/tenant/actions.d.ts +10 -0
  356. package/dist/modules/tenant/actions.js +160 -0
  357. package/dist/modules/tenant/index.d.ts +3 -0
  358. package/dist/modules/tenant/index.js +4 -0
  359. package/dist/modules/tenant/schema.d.ts +26 -0
  360. package/dist/modules/tenant/schema.js +28 -0
  361. package/dist/modules/tenant/service.d.ts +14 -0
  362. package/dist/modules/tenant/service.js +28 -0
  363. package/dist/modules/tenant/tenant.d.ts +32 -0
  364. package/dist/modules/tenant/tenant.js +125 -0
  365. package/dist/modules/tenant/types.d.ts +20 -0
  366. package/dist/modules/tenant/types.js +2 -0
  367. package/dist/modules/waitlist/action.d.ts +6 -0
  368. package/dist/modules/waitlist/action.js +78 -0
  369. package/dist/modules/waitlist/index.d.ts +4 -0
  370. package/dist/modules/waitlist/index.js +5 -0
  371. package/dist/modules/waitlist/schema.d.ts +17 -0
  372. package/dist/modules/waitlist/schema.js +18 -0
  373. package/dist/modules/waitlist/service.d.ts +13 -0
  374. package/dist/modules/waitlist/service.js +28 -0
  375. package/dist/modules/waitlist/types.d.ts +14 -0
  376. package/dist/modules/waitlist/types.js +2 -0
  377. package/dist/permission.d.ts +43 -0
  378. package/dist/permission.js +54 -0
  379. package/dist/query.d.ts +194 -0
  380. package/dist/query.js +204 -0
  381. package/dist/role.d.ts +70 -0
  382. package/dist/role.js +94 -0
  383. package/dist/schemas/nodes.d.ts +0 -0
  384. package/dist/schemas/nodes.js +1 -0
  385. package/dist/service-client.d.ts +8 -0
  386. package/dist/service-client.js +22 -0
  387. package/dist/service.d.ts +11 -0
  388. package/dist/service.js +23 -0
  389. package/dist/services/applets.d.ts +9 -0
  390. package/dist/services/applets.js +40 -0
  391. package/dist/services/avatars.d.ts +115 -0
  392. package/dist/services/avatars.js +251 -0
  393. package/dist/services/chat-flow.d.ts +7 -0
  394. package/dist/services/chat-flow.js +26 -0
  395. package/dist/services/community.d.ts +19 -0
  396. package/dist/services/community.js +69 -0
  397. package/dist/services/configuration.d.ts +5 -0
  398. package/dist/services/configuration.js +11 -0
  399. package/dist/services/databases.d.ts +613 -0
  400. package/dist/services/databases.js +1736 -0
  401. package/dist/services/functions.d.ts +319 -0
  402. package/dist/services/functions.js +810 -0
  403. package/dist/services/graphql.d.ts +25 -0
  404. package/dist/services/graphql.js +57 -0
  405. package/dist/services/health.d.ts +231 -0
  406. package/dist/services/health.js +463 -0
  407. package/dist/services/locale.d.ts +80 -0
  408. package/dist/services/locale.js +144 -0
  409. package/dist/services/messaging.d.ts +685 -0
  410. package/dist/services/messaging.js +1920 -0
  411. package/dist/services/permissions.d.ts +20 -0
  412. package/dist/services/permissions.js +90 -0
  413. package/dist/services/pricing.d.ts +15 -0
  414. package/dist/services/pricing.js +21 -0
  415. package/dist/services/projects.d.ts +542 -0
  416. package/dist/services/projects.js +1526 -0
  417. package/dist/services/roles.d.ts +19 -0
  418. package/dist/services/roles.js +72 -0
  419. package/dist/services/schema.d.ts +17 -0
  420. package/dist/services/schema.js +48 -0
  421. package/dist/services/storage.d.ts +189 -0
  422. package/dist/services/storage.js +474 -0
  423. package/dist/services/subscription.d.ts +15 -0
  424. package/dist/services/subscription.js +30 -0
  425. package/dist/services/teams.d.ts +167 -0
  426. package/dist/services/teams.js +395 -0
  427. package/dist/services/tenant-subscription.d.ts +12 -0
  428. package/dist/services/tenant-subscription.js +52 -0
  429. package/dist/services/users.d.ts +499 -0
  430. package/dist/services/users.js +1283 -0
  431. package/docs/examples/account/create-anonymous-session.md +11 -0
  432. package/docs/examples/account/create-email-password-session.md +14 -0
  433. package/docs/examples/account/create-email-token.md +15 -0
  434. package/docs/examples/account/create-j-w-t.md +11 -0
  435. package/docs/examples/account/create-magic-u-r-l-token.md +16 -0
  436. package/docs/examples/account/create-mfa-authenticator.md +13 -0
  437. package/docs/examples/account/create-mfa-challenge.md +13 -0
  438. package/docs/examples/account/create-mfa-recovery-codes.md +11 -0
  439. package/docs/examples/account/create-o-auth2session.md +15 -0
  440. package/docs/examples/account/create-o-auth2token.md +15 -0
  441. package/docs/examples/account/create-phone-token.md +14 -0
  442. package/docs/examples/account/create-phone-verification.md +11 -0
  443. package/docs/examples/account/create-push-target.md +15 -0
  444. package/docs/examples/account/create-recovery.md +14 -0
  445. package/docs/examples/account/create-session.md +14 -0
  446. package/docs/examples/account/create-verification.md +13 -0
  447. package/docs/examples/account/create.md +16 -0
  448. package/docs/examples/account/delete-identity.md +13 -0
  449. package/docs/examples/account/delete-mfa-authenticator.md +13 -0
  450. package/docs/examples/account/delete-push-target.md +13 -0
  451. package/docs/examples/account/delete-session.md +13 -0
  452. package/docs/examples/account/delete-sessions.md +11 -0
  453. package/docs/examples/account/delete.md +11 -0
  454. package/docs/examples/account/get-mfa-recovery-codes.md +11 -0
  455. package/docs/examples/account/get-prefs.md +11 -0
  456. package/docs/examples/account/get-session.md +13 -0
  457. package/docs/examples/account/get.md +11 -0
  458. package/docs/examples/account/list-identities.md +13 -0
  459. package/docs/examples/account/list-logs.md +13 -0
  460. package/docs/examples/account/list-mfa-factors.md +11 -0
  461. package/docs/examples/account/list-sessions.md +11 -0
  462. package/docs/examples/account/update-email.md +14 -0
  463. package/docs/examples/account/update-m-f-a.md +13 -0
  464. package/docs/examples/account/update-magic-u-r-l-session.md +14 -0
  465. package/docs/examples/account/update-mfa-authenticator.md +14 -0
  466. package/docs/examples/account/update-mfa-challenge.md +14 -0
  467. package/docs/examples/account/update-mfa-recovery-codes.md +11 -0
  468. package/docs/examples/account/update-name.md +13 -0
  469. package/docs/examples/account/update-password.md +14 -0
  470. package/docs/examples/account/update-phone-session.md +14 -0
  471. package/docs/examples/account/update-phone-verification.md +14 -0
  472. package/docs/examples/account/update-phone.md +14 -0
  473. package/docs/examples/account/update-prefs.md +13 -0
  474. package/docs/examples/account/update-push-target.md +14 -0
  475. package/docs/examples/account/update-recovery.md +15 -0
  476. package/docs/examples/account/update-session.md +13 -0
  477. package/docs/examples/account/update-status.md +11 -0
  478. package/docs/examples/account/update-verification.md +14 -0
  479. package/docs/examples/assistant/chat.md +13 -0
  480. package/docs/examples/avatars/get-browser.md +16 -0
  481. package/docs/examples/avatars/get-credit-card.md +16 -0
  482. package/docs/examples/avatars/get-favicon.md +13 -0
  483. package/docs/examples/avatars/get-flag.md +16 -0
  484. package/docs/examples/avatars/get-image.md +15 -0
  485. package/docs/examples/avatars/get-initials.md +16 -0
  486. package/docs/examples/avatars/get-q-r.md +16 -0
  487. package/docs/examples/console/variables.md +11 -0
  488. package/docs/examples/databases/create-boolean-attribute.md +18 -0
  489. package/docs/examples/databases/create-collection.md +18 -0
  490. package/docs/examples/databases/create-datetime-attribute.md +18 -0
  491. package/docs/examples/databases/create-document.md +17 -0
  492. package/docs/examples/databases/create-email-attribute.md +18 -0
  493. package/docs/examples/databases/create-enum-attribute.md +19 -0
  494. package/docs/examples/databases/create-float-attribute.md +20 -0
  495. package/docs/examples/databases/create-index.md +18 -0
  496. package/docs/examples/databases/create-integer-attribute.md +20 -0
  497. package/docs/examples/databases/create-ip-attribute.md +18 -0
  498. package/docs/examples/databases/create-relationship-attribute.md +20 -0
  499. package/docs/examples/databases/create-string-attribute.md +20 -0
  500. package/docs/examples/databases/create-url-attribute.md +18 -0
  501. package/docs/examples/databases/create.md +15 -0
  502. package/docs/examples/databases/delete-attribute.md +15 -0
  503. package/docs/examples/databases/delete-collection.md +14 -0
  504. package/docs/examples/databases/delete-document.md +15 -0
  505. package/docs/examples/databases/delete-index.md +15 -0
  506. package/docs/examples/databases/delete.md +13 -0
  507. package/docs/examples/databases/get-attribute.md +15 -0
  508. package/docs/examples/databases/get-collection-usage.md +15 -0
  509. package/docs/examples/databases/get-collection.md +14 -0
  510. package/docs/examples/databases/get-database-usage.md +14 -0
  511. package/docs/examples/databases/get-document.md +16 -0
  512. package/docs/examples/databases/get-index.md +15 -0
  513. package/docs/examples/databases/get-usage.md +13 -0
  514. package/docs/examples/databases/get.md +13 -0
  515. package/docs/examples/databases/list-attributes.md +15 -0
  516. package/docs/examples/databases/list-collection-logs.md +15 -0
  517. package/docs/examples/databases/list-collections.md +15 -0
  518. package/docs/examples/databases/list-document-logs.md +16 -0
  519. package/docs/examples/databases/list-documents.md +15 -0
  520. package/docs/examples/databases/list-indexes.md +15 -0
  521. package/docs/examples/databases/list-logs.md +14 -0
  522. package/docs/examples/databases/list.md +14 -0
  523. package/docs/examples/databases/update-boolean-attribute.md +17 -0
  524. package/docs/examples/databases/update-collection.md +18 -0
  525. package/docs/examples/databases/update-datetime-attribute.md +17 -0
  526. package/docs/examples/databases/update-document.md +17 -0
  527. package/docs/examples/databases/update-email-attribute.md +17 -0
  528. package/docs/examples/databases/update-enum-attribute.md +18 -0
  529. package/docs/examples/databases/update-float-attribute.md +19 -0
  530. package/docs/examples/databases/update-integer-attribute.md +19 -0
  531. package/docs/examples/databases/update-ip-attribute.md +17 -0
  532. package/docs/examples/databases/update-relationship-attribute.md +16 -0
  533. package/docs/examples/databases/update-string-attribute.md +17 -0
  534. package/docs/examples/databases/update-url-attribute.md +17 -0
  535. package/docs/examples/databases/update.md +15 -0
  536. package/docs/examples/functions/create-build.md +15 -0
  537. package/docs/examples/functions/create-deployment.md +17 -0
  538. package/docs/examples/functions/create-execution.md +19 -0
  539. package/docs/examples/functions/create-variable.md +15 -0
  540. package/docs/examples/functions/create.md +34 -0
  541. package/docs/examples/functions/delete-deployment.md +14 -0
  542. package/docs/examples/functions/delete-execution.md +14 -0
  543. package/docs/examples/functions/delete-variable.md +14 -0
  544. package/docs/examples/functions/delete.md +13 -0
  545. package/docs/examples/functions/get-deployment-download.md +14 -0
  546. package/docs/examples/functions/get-deployment.md +14 -0
  547. package/docs/examples/functions/get-execution.md +14 -0
  548. package/docs/examples/functions/get-function-usage.md +14 -0
  549. package/docs/examples/functions/get-template.md +13 -0
  550. package/docs/examples/functions/get-usage.md +13 -0
  551. package/docs/examples/functions/get-variable.md +14 -0
  552. package/docs/examples/functions/get.md +13 -0
  553. package/docs/examples/functions/list-deployments.md +15 -0
  554. package/docs/examples/functions/list-executions.md +15 -0
  555. package/docs/examples/functions/list-runtimes.md +11 -0
  556. package/docs/examples/functions/list-specifications.md +11 -0
  557. package/docs/examples/functions/list-templates.md +16 -0
  558. package/docs/examples/functions/list-variables.md +13 -0
  559. package/docs/examples/functions/list.md +14 -0
  560. package/docs/examples/functions/update-deployment-build.md +14 -0
  561. package/docs/examples/functions/update-deployment.md +14 -0
  562. package/docs/examples/functions/update-variable.md +16 -0
  563. package/docs/examples/functions/update.md +30 -0
  564. package/docs/examples/graphql/mutation.md +13 -0
  565. package/docs/examples/graphql/query.md +13 -0
  566. package/docs/examples/health/get-antivirus.md +11 -0
  567. package/docs/examples/health/get-cache.md +11 -0
  568. package/docs/examples/health/get-certificate.md +13 -0
  569. package/docs/examples/health/get-d-b.md +11 -0
  570. package/docs/examples/health/get-failed-jobs.md +14 -0
  571. package/docs/examples/health/get-pub-sub.md +11 -0
  572. package/docs/examples/health/get-queue-builds.md +13 -0
  573. package/docs/examples/health/get-queue-certificates.md +13 -0
  574. package/docs/examples/health/get-queue-databases.md +14 -0
  575. package/docs/examples/health/get-queue-deletes.md +13 -0
  576. package/docs/examples/health/get-queue-functions.md +13 -0
  577. package/docs/examples/health/get-queue-logs.md +13 -0
  578. package/docs/examples/health/get-queue-mails.md +13 -0
  579. package/docs/examples/health/get-queue-messaging.md +13 -0
  580. package/docs/examples/health/get-queue-migrations.md +13 -0
  581. package/docs/examples/health/get-queue-usage-dump.md +13 -0
  582. package/docs/examples/health/get-queue-usage.md +13 -0
  583. package/docs/examples/health/get-queue-webhooks.md +13 -0
  584. package/docs/examples/health/get-queue.md +11 -0
  585. package/docs/examples/health/get-storage-local.md +11 -0
  586. package/docs/examples/health/get-storage.md +11 -0
  587. package/docs/examples/health/get-time.md +11 -0
  588. package/docs/examples/health/get.md +11 -0
  589. package/docs/examples/locale/get.md +11 -0
  590. package/docs/examples/locale/list-codes.md +11 -0
  591. package/docs/examples/locale/list-continents.md +11 -0
  592. package/docs/examples/locale/list-countries-e-u.md +11 -0
  593. package/docs/examples/locale/list-countries-phones.md +11 -0
  594. package/docs/examples/locale/list-countries.md +11 -0
  595. package/docs/examples/locale/list-currencies.md +11 -0
  596. package/docs/examples/locale/list-languages.md +11 -0
  597. package/docs/examples/messaging/create-apns-provider.md +20 -0
  598. package/docs/examples/messaging/create-email.md +24 -0
  599. package/docs/examples/messaging/create-fcm-provider.md +16 -0
  600. package/docs/examples/messaging/create-mailgun-provider.md +22 -0
  601. package/docs/examples/messaging/create-msg91provider.md +18 -0
  602. package/docs/examples/messaging/create-push.md +28 -0
  603. package/docs/examples/messaging/create-sendgrid-provider.md +20 -0
  604. package/docs/examples/messaging/create-sms.md +19 -0
  605. package/docs/examples/messaging/create-smtp-provider.md +26 -0
  606. package/docs/examples/messaging/create-subscriber.md +15 -0
  607. package/docs/examples/messaging/create-telesign-provider.md +18 -0
  608. package/docs/examples/messaging/create-textmagic-provider.md +18 -0
  609. package/docs/examples/messaging/create-topic.md +15 -0
  610. package/docs/examples/messaging/create-twilio-provider.md +18 -0
  611. package/docs/examples/messaging/create-vonage-provider.md +18 -0
  612. package/docs/examples/messaging/delete-provider.md +13 -0
  613. package/docs/examples/messaging/delete-subscriber.md +14 -0
  614. package/docs/examples/messaging/delete-topic.md +13 -0
  615. package/docs/examples/messaging/delete.md +13 -0
  616. package/docs/examples/messaging/get-message.md +13 -0
  617. package/docs/examples/messaging/get-provider.md +13 -0
  618. package/docs/examples/messaging/get-subscriber.md +14 -0
  619. package/docs/examples/messaging/get-topic.md +13 -0
  620. package/docs/examples/messaging/list-message-logs.md +14 -0
  621. package/docs/examples/messaging/list-messages.md +14 -0
  622. package/docs/examples/messaging/list-provider-logs.md +14 -0
  623. package/docs/examples/messaging/list-providers.md +14 -0
  624. package/docs/examples/messaging/list-subscriber-logs.md +14 -0
  625. package/docs/examples/messaging/list-subscribers.md +15 -0
  626. package/docs/examples/messaging/list-targets.md +14 -0
  627. package/docs/examples/messaging/list-topic-logs.md +14 -0
  628. package/docs/examples/messaging/list-topics.md +14 -0
  629. package/docs/examples/messaging/update-apns-provider.md +20 -0
  630. package/docs/examples/messaging/update-email.md +24 -0
  631. package/docs/examples/messaging/update-fcm-provider.md +16 -0
  632. package/docs/examples/messaging/update-mailgun-provider.md +22 -0
  633. package/docs/examples/messaging/update-msg91provider.md +18 -0
  634. package/docs/examples/messaging/update-push.md +28 -0
  635. package/docs/examples/messaging/update-sendgrid-provider.md +20 -0
  636. package/docs/examples/messaging/update-sms.md +19 -0
  637. package/docs/examples/messaging/update-smtp-provider.md +26 -0
  638. package/docs/examples/messaging/update-telesign-provider.md +18 -0
  639. package/docs/examples/messaging/update-textmagic-provider.md +18 -0
  640. package/docs/examples/messaging/update-topic.md +15 -0
  641. package/docs/examples/messaging/update-twilio-provider.md +18 -0
  642. package/docs/examples/messaging/update-vonage-provider.md +18 -0
  643. package/docs/examples/migrations/create-appwrite-migration.md +16 -0
  644. package/docs/examples/migrations/create-firebase-migration.md +14 -0
  645. package/docs/examples/migrations/create-firebase-o-auth-migration.md +14 -0
  646. package/docs/examples/migrations/create-n-host-migration.md +20 -0
  647. package/docs/examples/migrations/create-supabase-migration.md +19 -0
  648. package/docs/examples/migrations/delete-firebase-auth.md +11 -0
  649. package/docs/examples/migrations/delete.md +13 -0
  650. package/docs/examples/migrations/get-appwrite-report.md +16 -0
  651. package/docs/examples/migrations/get-firebase-report-o-auth.md +14 -0
  652. package/docs/examples/migrations/get-firebase-report.md +14 -0
  653. package/docs/examples/migrations/get-n-host-report.md +20 -0
  654. package/docs/examples/migrations/get-supabase-report.md +19 -0
  655. package/docs/examples/migrations/get.md +13 -0
  656. package/docs/examples/migrations/list-firebase-projects.md +11 -0
  657. package/docs/examples/migrations/list.md +14 -0
  658. package/docs/examples/migrations/retry.md +13 -0
  659. package/docs/examples/project/create-variable.md +14 -0
  660. package/docs/examples/project/delete-variable.md +13 -0
  661. package/docs/examples/project/get-usage.md +15 -0
  662. package/docs/examples/project/get-variable.md +13 -0
  663. package/docs/examples/project/list-variables.md +11 -0
  664. package/docs/examples/project/update-variable.md +15 -0
  665. package/docs/examples/projects/create-j-w-t.md +15 -0
  666. package/docs/examples/projects/create-key.md +16 -0
  667. package/docs/examples/projects/create-platform.md +18 -0
  668. package/docs/examples/projects/create-smtp-test.md +22 -0
  669. package/docs/examples/projects/create-webhook.md +20 -0
  670. package/docs/examples/projects/create.md +25 -0
  671. package/docs/examples/projects/delete-email-template.md +15 -0
  672. package/docs/examples/projects/delete-key.md +14 -0
  673. package/docs/examples/projects/delete-platform.md +14 -0
  674. package/docs/examples/projects/delete-sms-template.md +15 -0
  675. package/docs/examples/projects/delete-webhook.md +14 -0
  676. package/docs/examples/projects/delete.md +13 -0
  677. package/docs/examples/projects/get-email-template.md +15 -0
  678. package/docs/examples/projects/get-key.md +14 -0
  679. package/docs/examples/projects/get-platform.md +14 -0
  680. package/docs/examples/projects/get-sms-template.md +15 -0
  681. package/docs/examples/projects/get-webhook.md +14 -0
  682. package/docs/examples/projects/get.md +13 -0
  683. package/docs/examples/projects/list-keys.md +13 -0
  684. package/docs/examples/projects/list-platforms.md +13 -0
  685. package/docs/examples/projects/list-webhooks.md +13 -0
  686. package/docs/examples/projects/list.md +14 -0
  687. package/docs/examples/projects/update-api-status-all.md +14 -0
  688. package/docs/examples/projects/update-api-status.md +15 -0
  689. package/docs/examples/projects/update-auth-duration.md +14 -0
  690. package/docs/examples/projects/update-auth-limit.md +14 -0
  691. package/docs/examples/projects/update-auth-password-dictionary.md +14 -0
  692. package/docs/examples/projects/update-auth-password-history.md +14 -0
  693. package/docs/examples/projects/update-auth-sessions-limit.md +14 -0
  694. package/docs/examples/projects/update-auth-status.md +15 -0
  695. package/docs/examples/projects/update-email-template.md +20 -0
  696. package/docs/examples/projects/update-key.md +17 -0
  697. package/docs/examples/projects/update-mock-numbers.md +14 -0
  698. package/docs/examples/projects/update-o-auth2.md +17 -0
  699. package/docs/examples/projects/update-personal-data-check.md +14 -0
  700. package/docs/examples/projects/update-platform.md +18 -0
  701. package/docs/examples/projects/update-service-status-all.md +14 -0
  702. package/docs/examples/projects/update-service-status.md +15 -0
  703. package/docs/examples/projects/update-session-alerts.md +14 -0
  704. package/docs/examples/projects/update-sms-template.md +16 -0
  705. package/docs/examples/projects/update-smtp.md +22 -0
  706. package/docs/examples/projects/update-team.md +14 -0
  707. package/docs/examples/projects/update-webhook-signature.md +14 -0
  708. package/docs/examples/projects/update-webhook.md +21 -0
  709. package/docs/examples/projects/update.md +23 -0
  710. package/docs/examples/proxy/create-rule.md +15 -0
  711. package/docs/examples/proxy/delete-rule.md +13 -0
  712. package/docs/examples/proxy/get-rule.md +13 -0
  713. package/docs/examples/proxy/list-rules.md +14 -0
  714. package/docs/examples/proxy/update-rule-verification.md +13 -0
  715. package/docs/examples/storage/create-bucket.md +22 -0
  716. package/docs/examples/storage/create-file.md +16 -0
  717. package/docs/examples/storage/delete-bucket.md +13 -0
  718. package/docs/examples/storage/delete-file.md +14 -0
  719. package/docs/examples/storage/get-bucket-usage.md +14 -0
  720. package/docs/examples/storage/get-bucket.md +13 -0
  721. package/docs/examples/storage/get-file-download.md +14 -0
  722. package/docs/examples/storage/get-file-preview.md +25 -0
  723. package/docs/examples/storage/get-file-view.md +14 -0
  724. package/docs/examples/storage/get-file.md +14 -0
  725. package/docs/examples/storage/get-usage.md +13 -0
  726. package/docs/examples/storage/list-buckets.md +14 -0
  727. package/docs/examples/storage/list-files.md +15 -0
  728. package/docs/examples/storage/update-bucket.md +22 -0
  729. package/docs/examples/storage/update-file.md +16 -0
  730. package/docs/examples/teams/create-membership.md +19 -0
  731. package/docs/examples/teams/create.md +15 -0
  732. package/docs/examples/teams/delete-membership.md +14 -0
  733. package/docs/examples/teams/delete.md +13 -0
  734. package/docs/examples/teams/get-membership.md +14 -0
  735. package/docs/examples/teams/get-prefs.md +13 -0
  736. package/docs/examples/teams/get.md +13 -0
  737. package/docs/examples/teams/list-logs.md +14 -0
  738. package/docs/examples/teams/list-memberships.md +15 -0
  739. package/docs/examples/teams/list.md +14 -0
  740. package/docs/examples/teams/update-membership-status.md +16 -0
  741. package/docs/examples/teams/update-membership.md +15 -0
  742. package/docs/examples/teams/update-name.md +14 -0
  743. package/docs/examples/teams/update-prefs.md +14 -0
  744. package/docs/examples/users/create-argon2user.md +16 -0
  745. package/docs/examples/users/create-bcrypt-user.md +16 -0
  746. package/docs/examples/users/create-j-w-t.md +15 -0
  747. package/docs/examples/users/create-m-d5user.md +16 -0
  748. package/docs/examples/users/create-mfa-recovery-codes.md +13 -0
  749. package/docs/examples/users/create-p-h-pass-user.md +16 -0
  750. package/docs/examples/users/create-s-h-a-user.md +17 -0
  751. package/docs/examples/users/create-scrypt-modified-user.md +19 -0
  752. package/docs/examples/users/create-scrypt-user.md +21 -0
  753. package/docs/examples/users/create-session.md +13 -0
  754. package/docs/examples/users/create-target.md +18 -0
  755. package/docs/examples/users/create-token.md +15 -0
  756. package/docs/examples/users/create.md +17 -0
  757. package/docs/examples/users/delete-identity.md +13 -0
  758. package/docs/examples/users/delete-mfa-authenticator.md +14 -0
  759. package/docs/examples/users/delete-session.md +14 -0
  760. package/docs/examples/users/delete-sessions.md +13 -0
  761. package/docs/examples/users/delete-target.md +14 -0
  762. package/docs/examples/users/delete.md +13 -0
  763. package/docs/examples/users/get-mfa-recovery-codes.md +13 -0
  764. package/docs/examples/users/get-prefs.md +13 -0
  765. package/docs/examples/users/get-target.md +14 -0
  766. package/docs/examples/users/get-usage.md +13 -0
  767. package/docs/examples/users/get.md +13 -0
  768. package/docs/examples/users/list-identities.md +14 -0
  769. package/docs/examples/users/list-logs.md +14 -0
  770. package/docs/examples/users/list-memberships.md +13 -0
  771. package/docs/examples/users/list-mfa-factors.md +13 -0
  772. package/docs/examples/users/list-sessions.md +13 -0
  773. package/docs/examples/users/list-targets.md +14 -0
  774. package/docs/examples/users/list.md +14 -0
  775. package/docs/examples/users/update-email-verification.md +14 -0
  776. package/docs/examples/users/update-email.md +14 -0
  777. package/docs/examples/users/update-labels.md +14 -0
  778. package/docs/examples/users/update-mfa-recovery-codes.md +13 -0
  779. package/docs/examples/users/update-mfa.md +14 -0
  780. package/docs/examples/users/update-name.md +14 -0
  781. package/docs/examples/users/update-password.md +14 -0
  782. package/docs/examples/users/update-phone-verification.md +14 -0
  783. package/docs/examples/users/update-phone.md +14 -0
  784. package/docs/examples/users/update-prefs.md +14 -0
  785. package/docs/examples/users/update-status.md +14 -0
  786. package/docs/examples/users/update-target.md +17 -0
  787. package/docs/examples/vcs/create-repository-detection.md +15 -0
  788. package/docs/examples/vcs/create-repository.md +15 -0
  789. package/docs/examples/vcs/delete-installation.md +13 -0
  790. package/docs/examples/vcs/get-installation.md +13 -0
  791. package/docs/examples/vcs/get-repository-contents.md +15 -0
  792. package/docs/examples/vcs/get-repository.md +14 -0
  793. package/docs/examples/vcs/list-installations.md +14 -0
  794. package/docs/examples/vcs/list-repositories.md +14 -0
  795. package/docs/examples/vcs/list-repository-branches.md +14 -0
  796. package/docs/examples/vcs/update-external-deployments.md +15 -0
  797. package/package.json +29 -141
  798. package/publish.sh +4 -0
  799. package/src/client.ts +397 -0
  800. package/src/enums/api-service.ts +13 -0
  801. package/src/enums/api.ts +5 -0
  802. package/src/enums/auth-method.ts +9 -0
  803. package/src/enums/browser.ts +16 -0
  804. package/src/enums/compression.ts +5 -0
  805. package/src/enums/credit-card.ts +18 -0
  806. package/src/enums/database-usage-range.ts +5 -0
  807. package/src/enums/email-template-locale.ts +133 -0
  808. package/src/enums/email-template-type.ts +9 -0
  809. package/src/enums/entities/EntityLimitType.ts +4 -0
  810. package/src/enums/entities/PropertyAttributeName.ts +27 -0
  811. package/src/enums/entities/PropertyCondition.ts +8 -0
  812. package/src/enums/entities/PropertyType.ts +16 -0
  813. package/src/enums/entities/PropertyValueType.ts +6 -0
  814. package/src/enums/entities/RowAccess.ts +2 -0
  815. package/src/enums/entities/ViewFilterCondition.ts +12 -0
  816. package/src/enums/execution-method.ts +8 -0
  817. package/src/enums/flag.ts +197 -0
  818. package/src/enums/function-usage-range.ts +5 -0
  819. package/src/enums/image-format.ts +7 -0
  820. package/src/enums/image-gravity.ts +11 -0
  821. package/src/enums/index-type.ts +5 -0
  822. package/src/enums/messaging-provider-type.ts +5 -0
  823. package/src/enums/name.ts +14 -0
  824. package/src/enums/o-auth-provider copy.ts +41 -0
  825. package/src/enums/password-hash.ts +13 -0
  826. package/src/enums/platform-type.ts +17 -0
  827. package/src/enums/project-usage-range.ts +4 -0
  828. package/src/enums/region.ts +4 -0
  829. package/src/enums/relation-mutate.ts +5 -0
  830. package/src/enums/relationship-type.ts +6 -0
  831. package/src/enums/resource-type.ts +4 -0
  832. package/src/enums/runtime.ts +48 -0
  833. package/src/enums/s-m-t-p-secure.ts +3 -0
  834. package/src/enums/shared/ApplicationLayout.ts +4 -0
  835. package/src/enums/shared/Colors.ts +24 -0
  836. package/src/enums/shared/InputType.ts +6 -0
  837. package/src/enums/shared/Periodicity.ts +7 -0
  838. package/src/enums/shared/SvgIcon.ts +37 -0
  839. package/src/enums/shared/Theme.ts +4 -0
  840. package/src/enums/sms-template-locale.ts +133 -0
  841. package/src/enums/sms-template-type.ts +6 -0
  842. package/src/enums/smtp-encryption.ts +5 -0
  843. package/src/enums/storage-usage-range.ts +5 -0
  844. package/src/enums/subscriptions/PricingModel.ts +14 -0
  845. package/src/enums/subscriptions/SubscriptionBillingPeriod.ts +15 -0
  846. package/src/enums/subscriptions/SubscriptionFeatureLimitType.ts +16 -0
  847. package/src/enums/subscriptions/SubscriptionPriceType.ts +10 -0
  848. package/src/enums/tenants/LinkedAccountStatus.ts +5 -0
  849. package/src/enums/tenants/TenantUserJoined.ts +6 -0
  850. package/src/enums/tenants/TenantUserStatus.ts +6 -0
  851. package/src/enums/tenants/TenantUserType.ts +5 -0
  852. package/src/enums/user-usage-range.ts +5 -0
  853. package/src/getAppcondaClient.ts +75 -0
  854. package/src/getSDKForService.ts +71 -0
  855. package/src/id.ts +47 -0
  856. package/src/index.ts +3 -0
  857. package/src/inputFile.ts +23 -0
  858. package/src/lib/errors.ts +141 -0
  859. package/src/lib/index.ts +0 -0
  860. package/src/lib/types.ts +7 -0
  861. package/src/models.ts +3339 -0
  862. package/src/modules/account/enums/authentication-factor.ts +6 -0
  863. package/src/modules/account/enums/authenticator-type.ts +3 -0
  864. package/src/modules/account/enums/o-auth-provider.ts +41 -0
  865. package/src/modules/account/index.ts +3 -0
  866. package/src/modules/account/schema.ts +8 -0
  867. package/src/modules/account/service.ts +1648 -0
  868. package/src/modules/account/types.ts +426 -0
  869. package/src/modules/accounv1/index.ts +4 -0
  870. package/src/modules/accounv1/schema.ts +50 -0
  871. package/src/modules/accounv1/service.ts +43 -0
  872. package/src/modules/accounv1/types.ts +16 -0
  873. package/src/modules/acl/service.ts +55 -0
  874. package/src/modules/agent/action.ts +66 -0
  875. package/src/modules/agent/index.ts +4 -0
  876. package/src/modules/agent/schema.ts +25 -0
  877. package/src/modules/agent/service.ts +34 -0
  878. package/src/modules/agent/types.ts +15 -0
  879. package/src/modules/ai/index.ts +1 -0
  880. package/src/modules/ai/node/actions.ts +14 -0
  881. package/src/modules/ai/node/index.ts +2 -0
  882. package/src/modules/ai/node/service.ts +18 -0
  883. package/src/modules/bpm/index.ts +3 -0
  884. package/src/modules/bpm/schema.ts +23 -0
  885. package/src/modules/bpm/service.ts +28 -0
  886. package/src/modules/bpm/types.ts +11 -0
  887. package/src/modules/builder/action.ts +234 -0
  888. package/src/modules/builder/index.ts +4 -0
  889. package/src/modules/builder/schema.ts +95 -0
  890. package/src/modules/builder/service.ts +74 -0
  891. package/src/modules/builder/types.ts +68 -0
  892. package/src/modules/datasource/action.ts +189 -0
  893. package/src/modules/datasource/index.ts +4 -0
  894. package/src/modules/datasource/schema.ts +69 -0
  895. package/src/modules/datasource/service.ts +58 -0
  896. package/src/modules/datasource/types.ts +31 -0
  897. package/src/modules/emploid/action.ts +1063 -0
  898. package/src/modules/emploid/index.ts +4 -0
  899. package/src/modules/emploid/schema.ts +405 -0
  900. package/src/modules/emploid/service.ts +295 -0
  901. package/src/modules/emploid/types.ts +132 -0
  902. package/src/modules/google/action.ts +54 -0
  903. package/src/modules/google/index.ts +4 -0
  904. package/src/modules/google/schema.ts +19 -0
  905. package/src/modules/google/service.ts +23 -0
  906. package/src/modules/google/types.ts +15 -0
  907. package/src/modules/hooks/index.ts +5 -0
  908. package/src/modules/hooks/lib/Hooks.ts +103 -0
  909. package/src/modules/hooks/lib/handler.ts +27 -0
  910. package/src/modules/hooks/lib/jobs/index.ts +2 -0
  911. package/src/modules/hooks/lib/jobs/job1.ts +20 -0
  912. package/src/modules/hooks/lib/jobs/log-job.ts +10 -0
  913. package/src/modules/hooks/lib/wait.ts +17 -0
  914. package/src/modules/index.ts +17 -0
  915. package/src/modules/mail/action.ts +22 -0
  916. package/src/modules/mail/index.ts +4 -0
  917. package/src/modules/mail/schema.ts +9 -0
  918. package/src/modules/mail/service.ts +15 -0
  919. package/src/modules/mail/types.ts +11 -0
  920. package/src/modules/notion/action.ts +53 -0
  921. package/src/modules/notion/index.ts +4 -0
  922. package/src/modules/notion/schema.ts +21 -0
  923. package/src/modules/notion/service.ts +26 -0
  924. package/src/modules/notion/types.ts +14 -0
  925. package/src/modules/organization/action.ts +71 -0
  926. package/src/modules/organization/index.ts +4 -0
  927. package/src/modules/organization/schema.ts +23 -0
  928. package/src/modules/organization/service.ts +32 -0
  929. package/src/modules/organization/types.ts +15 -0
  930. package/src/modules/scheduled-job/action.ts +212 -0
  931. package/src/modules/scheduled-job/index.ts +8 -0
  932. package/src/modules/scheduled-job/lib/Schedules.ts +105 -0
  933. package/src/modules/scheduled-job/lib/handler.ts +27 -0
  934. package/src/modules/scheduled-job/lib/jobs/index.ts +2 -0
  935. package/src/modules/scheduled-job/lib/jobs/job1.ts +12 -0
  936. package/src/modules/scheduled-job/lib/wait.ts +17 -0
  937. package/src/modules/scheduled-job/schema.ts +62 -0
  938. package/src/modules/scheduled-job/service.ts +63 -0
  939. package/src/modules/scheduled-job/types.ts +79 -0
  940. package/src/modules/task/action.ts +819 -0
  941. package/src/modules/task/index.ts +4 -0
  942. package/src/modules/task/schema.ts +455 -0
  943. package/src/modules/task/service.ts +268 -0
  944. package/src/modules/task/types.ts +325 -0
  945. package/src/modules/tenant/actions.ts +173 -0
  946. package/src/modules/tenant/index.ts +3 -0
  947. package/src/modules/tenant/schema.ts +32 -0
  948. package/src/modules/tenant/service.ts +43 -0
  949. package/src/modules/tenant/tenant.ts +193 -0
  950. package/src/modules/tenant/types.ts +22 -0
  951. package/src/modules/waitlist/action.ts +93 -0
  952. package/src/modules/waitlist/index.ts +4 -0
  953. package/src/modules/waitlist/schema.ts +24 -0
  954. package/src/modules/waitlist/service.ts +41 -0
  955. package/src/modules/waitlist/types.ts +18 -0
  956. package/src/permission.ts +57 -0
  957. package/src/query.ts +261 -0
  958. package/src/role.ts +100 -0
  959. package/src/service-client.ts +40 -0
  960. package/src/service.ts +30 -0
  961. package/src/services/applets.ts +75 -0
  962. package/src/services/avatars.ts +314 -0
  963. package/src/services/chat-flow.ts +32 -0
  964. package/src/services/community.ts +102 -0
  965. package/src/services/configuration.ts +15 -0
  966. package/src/services/databases.ts +2037 -0
  967. package/src/services/functions.ts +986 -0
  968. package/src/services/graphql.ts +75 -0
  969. package/src/services/health.ts +629 -0
  970. package/src/services/locale.ts +205 -0
  971. package/src/services/messaging.ts +2247 -0
  972. package/src/services/permissions.ts +131 -0
  973. package/src/services/pricing.ts +30 -0
  974. package/src/services/projects.ts +1901 -0
  975. package/src/services/roles.ts +101 -0
  976. package/src/services/schema.ts +65 -0
  977. package/src/services/storage.ts +576 -0
  978. package/src/services/subscription.ts +39 -0
  979. package/src/services/teams.ts +490 -0
  980. package/src/services/tenant-subscription.ts +93 -0
  981. package/src/services/users.ts +1584 -0
  982. package/tsconfig.json +32 -0
  983. package/index.d.ts +0 -3367
  984. package/index.js +0 -407
package/index.d.ts DELETED
@@ -1,3367 +0,0 @@
1
- // Generated by dts-bundle v0.7.3
2
-
3
- /**
4
- * Appconda Web SDK
5
- *
6
- * This SDK is compatible with Appconda server version 1.6.x.
7
- * For older versions, please check
8
- * [previous releases](https://github.com/appconda/sdk-for-web/releases).
9
- */
10
-
11
- import 'isomorphic-form-data';
12
- type Payload = {
13
- [key: string]: any;
14
- };
15
- export type Headers = {
16
- [key: string]: string;
17
- };
18
- export type RealtimeResponseEvent<T extends unknown> = {
19
- events: string[];
20
- channels: string[];
21
- timestamp: number;
22
- payload: T;
23
- };
24
- export type UploadProgress = {
25
- $id: string;
26
- progress: number;
27
- sizeUploaded: number;
28
- chunksTotal: number;
29
- chunksUploaded: number;
30
- };
31
- export class AppcondaException extends Error {
32
- code: number;
33
- response: string;
34
- type: string;
35
- constructor(message: string, code?: number, type?: string, response?: string);
36
- }
37
- class Client {
38
- config: {
39
- endpoint: string;
40
- endpointRealtime: string;
41
- project: string;
42
- key: string;
43
- jwt: string;
44
- locale: string;
45
- mode: string;
46
- };
47
- headers: Headers;
48
- /**
49
- * Set Endpoint
50
- *
51
- * Your project endpoint
52
- *
53
- * @param {string} endpoint
54
- *
55
- * @returns {this}
56
- */
57
- setEndpoint(endpoint: string): this;
58
- /**
59
- * Set Realtime Endpoint
60
- *
61
- * @param {string} endpointRealtime
62
- *
63
- * @returns {this}
64
- */
65
- setEndpointRealtime(endpointRealtime: string): this;
66
- /**
67
- * Set Project
68
- *
69
- * Your project ID
70
- *
71
- * @param value string
72
- *
73
- * @return {this}
74
- */
75
- setProject(value: string): this;
76
- /**
77
- * Set Key
78
- *
79
- * Your secret API key
80
- *
81
- * @param value string
82
- *
83
- * @return {this}
84
- */
85
- setKey(value: string): this;
86
- /**
87
- * Set JWT
88
- *
89
- * Your secret JSON Web Token
90
- *
91
- * @param value string
92
- *
93
- * @return {this}
94
- */
95
- setJWT(value: string): this;
96
- /**
97
- * Set Locale
98
- *
99
- * @param value string
100
- *
101
- * @return {this}
102
- */
103
- setLocale(value: string): this;
104
- /**
105
- * Set Mode
106
- *
107
- * @param value string
108
- *
109
- * @return {this}
110
- */
111
- setMode(value: string): this;
112
- /**
113
- * Subscribes to Realmocean events and passes you the payload in realtime.
114
- *
115
- * @param {string|string[]} channels
116
- * Channel to subscribe - pass a single channel as a string or multiple with an array of strings.
117
- *
118
- * Possible channels are:
119
- * - account
120
- * - collections
121
- * - collections.[ID]
122
- * - collections.[ID].documents
123
- * - documents
124
- * - documents.[ID]
125
- * - files
126
- * - files.[ID]
127
- * - executions
128
- * - executions.[ID]
129
- * - functions.[ID]
130
- * - teams
131
- * - teams.[ID]
132
- * - memberships
133
- * - memberships.[ID]
134
- * @param {(payload: RealtimeMessage) => void} callback Is called on every realtime update.
135
- * @returns {() => void} Unsubscribes from events.
136
- */
137
- subscribe<T extends unknown>(channels: string | string[], callback: (payload: RealtimeResponseEvent<T>) => void): () => void;
138
- call(method: string, url: URL, headers?: Headers, params?: Payload): Promise<any>;
139
- }
140
- export { Client };
141
- export type { Models, Payload };
142
-
143
- export class Account extends Service {
144
- constructor(client: Client);
145
- /**
146
- * Get account
147
- *
148
- * Get the currently logged in user.
149
- *
150
- * @throws {AppcondaException}
151
- * @returns {Promise}
152
- */
153
- get<Preferences extends Models.Preferences>(): Promise<Models.User<Preferences>>;
154
- /**
155
- * Create account
156
- *
157
- * Use this endpoint to allow a new user to register a new account in your
158
- * project. After the user registration completes successfully, you can use
159
- * the
160
- * [/account/verfication](https://appwrite.io/docs/references/cloud/client-web/account#createVerification)
161
- * route to start verifying the user email address. To allow the new user to
162
- * login to their new account, you need to create a new [account
163
- * session](https://appwrite.io/docs/references/cloud/client-web/account#createEmailSession).
164
- *
165
- * @param {string} userId
166
- * @param {string} email
167
- * @param {string} password
168
- * @param {string} name
169
- * @throws {AppcondaException}
170
- * @returns {Promise}
171
- */
172
- create<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
173
- /**
174
- * Update email
175
- *
176
- * Update currently logged in user account email address. After changing user
177
- * address, the user confirmation status will get reset. A new confirmation
178
- * email is not sent automatically however you can use the send confirmation
179
- * email endpoint again to send the confirmation email. For security measures,
180
- * user password is required to complete this request.
181
- * This endpoint can also be used to convert an anonymous account to a normal
182
- * one, by passing an email address and a new password.
183
- *
184
- *
185
- * @param {string} email
186
- * @param {string} password
187
- * @throws {AppcondaException}
188
- * @returns {Promise}
189
- */
190
- updateEmail<Preferences extends Models.Preferences>(email: string, password: string): Promise<Models.User<Preferences>>;
191
- /**
192
- * List Identities
193
- *
194
- * Get the list of identities for the currently logged in user.
195
- *
196
- * @param {string[]} queries
197
- * @throws {AppcondaException}
198
- * @returns {Promise}
199
- */
200
- listIdentities(queries?: string[]): Promise<Models.IdentityList>;
201
- /**
202
- * Delete identity
203
- *
204
- * Delete an identity by its unique ID.
205
- *
206
- * @param {string} identityId
207
- * @throws {AppcondaException}
208
- * @returns {Promise}
209
- */
210
- deleteIdentity(identityId: string): Promise<{}>;
211
- /**
212
- * Create JWT
213
- *
214
- * Use this endpoint to create a JSON Web Token. You can use the resulting JWT
215
- * to authenticate on behalf of the current user when working with the
216
- * Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes
217
- * from its creation and will be invalid if the user will logout in that time
218
- * frame.
219
- *
220
- * @throws {AppcondaException}
221
- * @returns {Promise}
222
- */
223
- createJWT(): Promise<Models.Jwt>;
224
- /**
225
- * List logs
226
- *
227
- * Get the list of latest security activity logs for the currently logged in
228
- * user. Each log returns user IP address, location and date and time of log.
229
- *
230
- * @param {string[]} queries
231
- * @throws {AppcondaException}
232
- * @returns {Promise}
233
- */
234
- listLogs(queries?: string[]): Promise<Models.LogList>;
235
- /**
236
- * Update MFA
237
- *
238
- * Enable or disable MFA on an account.
239
- *
240
- * @param {boolean} mfa
241
- * @throws {AppcondaException}
242
- * @returns {Promise}
243
- */
244
- updateMFA<Preferences extends Models.Preferences>(mfa: boolean): Promise<Models.User<Preferences>>;
245
- /**
246
- * Add Authenticator
247
- *
248
- * Add an authenticator app to be used as an MFA factor. Verify the
249
- * authenticator using the [verify
250
- * authenticator](/docs/references/cloud/client-web/account#verifyAuthenticator)
251
- * method.
252
- *
253
- * @param {AuthenticatorType} type
254
- * @throws {AppcondaException}
255
- * @returns {Promise}
256
- */
257
- createMfaAuthenticator(type: AuthenticatorType): Promise<Models.MfaType>;
258
- /**
259
- * Verify Authenticator
260
- *
261
- * Verify an authenticator app after adding it using the [add
262
- * authenticator](/docs/references/cloud/client-web/account#addAuthenticator)
263
- * method.
264
- *
265
- * @param {AuthenticatorType} type
266
- * @param {string} otp
267
- * @throws {AppcondaException}
268
- * @returns {Promise}
269
- */
270
- updateMfaAuthenticator<Preferences extends Models.Preferences>(type: AuthenticatorType, otp: string): Promise<Models.User<Preferences>>;
271
- /**
272
- * Delete Authenticator
273
- *
274
- * Delete an authenticator for a user by ID.
275
- *
276
- * @param {AuthenticatorType} type
277
- * @param {string} otp
278
- * @throws {AppcondaException}
279
- * @returns {Promise}
280
- */
281
- deleteMfaAuthenticator<Preferences extends Models.Preferences>(type: AuthenticatorType, otp: string): Promise<Models.User<Preferences>>;
282
- /**
283
- * Create 2FA Challenge
284
- *
285
- * Begin the process of MFA verification after sign-in. Finish the flow with
286
- * [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge)
287
- * method.
288
- *
289
- * @param {AuthenticationFactor} factor
290
- * @throws {AppcondaException}
291
- * @returns {Promise}
292
- */
293
- createMfaChallenge(factor: AuthenticationFactor): Promise<Models.MfaChallenge>;
294
- /**
295
- * Create MFA Challenge (confirmation)
296
- *
297
- * Complete the MFA challenge by providing the one-time password. Finish the
298
- * process of MFA verification by providing the one-time password. To begin
299
- * the flow, use
300
- * [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge)
301
- * method.
302
- *
303
- * @param {string} challengeId
304
- * @param {string} otp
305
- * @throws {AppcondaException}
306
- * @returns {Promise}
307
- */
308
- updateMfaChallenge(challengeId: string, otp: string): Promise<{}>;
309
- /**
310
- * List Factors
311
- *
312
- * List the factors available on the account to be used as a MFA challange.
313
- *
314
- * @throws {AppcondaException}
315
- * @returns {Promise}
316
- */
317
- listMfaFactors(): Promise<Models.MfaFactors>;
318
- /**
319
- * Get MFA Recovery Codes
320
- *
321
- * Get recovery codes that can be used as backup for MFA flow. Before getting
322
- * codes, they must be generated using
323
- * [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes)
324
- * method. An OTP challenge is required to read recovery codes.
325
- *
326
- * @throws {AppcondaException}
327
- * @returns {Promise}
328
- */
329
- getMfaRecoveryCodes(): Promise<Models.MfaRecoveryCodes>;
330
- /**
331
- * Create MFA Recovery Codes
332
- *
333
- * Generate recovery codes as backup for MFA flow. It's recommended to
334
- * generate and show then immediately after user successfully adds their
335
- * authehticator. Recovery codes can be used as a MFA verification type in
336
- * [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge)
337
- * method.
338
- *
339
- * @throws {AppcondaException}
340
- * @returns {Promise}
341
- */
342
- createMfaRecoveryCodes(): Promise<Models.MfaRecoveryCodes>;
343
- /**
344
- * Regenerate MFA Recovery Codes
345
- *
346
- * Regenerate recovery codes that can be used as backup for MFA flow. Before
347
- * regenerating codes, they must be first generated using
348
- * [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes)
349
- * method. An OTP challenge is required to regenreate recovery codes.
350
- *
351
- * @throws {AppcondaException}
352
- * @returns {Promise}
353
- */
354
- updateMfaRecoveryCodes(): Promise<Models.MfaRecoveryCodes>;
355
- /**
356
- * Update name
357
- *
358
- * Update currently logged in user account name.
359
- *
360
- * @param {string} name
361
- * @throws {AppcondaException}
362
- * @returns {Promise}
363
- */
364
- updateName<Preferences extends Models.Preferences>(name: string): Promise<Models.User<Preferences>>;
365
- /**
366
- * Update password
367
- *
368
- * Update currently logged in user password. For validation, user is required
369
- * to pass in the new password, and the old password. For users created with
370
- * OAuth, Team Invites and Magic URL, oldPassword is optional.
371
- *
372
- * @param {string} password
373
- * @param {string} oldPassword
374
- * @throws {AppcondaException}
375
- * @returns {Promise}
376
- */
377
- updatePassword<Preferences extends Models.Preferences>(password: string, oldPassword?: string): Promise<Models.User<Preferences>>;
378
- /**
379
- * Update phone
380
- *
381
- * Update the currently logged in user's phone number. After updating the
382
- * phone number, the phone verification status will be reset. A confirmation
383
- * SMS is not sent automatically, however you can use the [POST
384
- * /account/verification/phone](https://appwrite.io/docs/references/cloud/client-web/account#createPhoneVerification)
385
- * endpoint to send a confirmation SMS.
386
- *
387
- * @param {string} phone
388
- * @param {string} password
389
- * @throws {AppcondaException}
390
- * @returns {Promise}
391
- */
392
- updatePhone<Preferences extends Models.Preferences>(phone: string, password: string): Promise<Models.User<Preferences>>;
393
- /**
394
- * Get account preferences
395
- *
396
- * Get the preferences as a key-value object for the currently logged in user.
397
- *
398
- * @throws {AppcondaException}
399
- * @returns {Promise}
400
- */
401
- getPrefs<Preferences extends Models.Preferences>(): Promise<Preferences>;
402
- /**
403
- * Update preferences
404
- *
405
- * Update currently logged in user account preferences. The object you pass is
406
- * stored as is, and replaces any previous value. The maximum allowed prefs
407
- * size is 64kB and throws error if exceeded.
408
- *
409
- * @param {Partial<Preferences>} prefs
410
- * @throws {AppcondaException}
411
- * @returns {Promise}
412
- */
413
- updatePrefs<Preferences extends Models.Preferences>(prefs: Partial<Preferences>): Promise<Models.User<Preferences>>;
414
- /**
415
- * Create password recovery
416
- *
417
- * Sends the user an email with a temporary secret key for password reset.
418
- * When the user clicks the confirmation link he is redirected back to your
419
- * app password reset URL with the secret key and email address values
420
- * attached to the URL query string. Use the query string params to submit a
421
- * request to the [PUT
422
- * /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#updateRecovery)
423
- * endpoint to complete the process. The verification link sent to the user's
424
- * email address is valid for 1 hour.
425
- *
426
- * @param {string} email
427
- * @param {string} url
428
- * @throws {AppcondaException}
429
- * @returns {Promise}
430
- */
431
- createRecovery(email: string, url: string): Promise<Models.Token>;
432
- /**
433
- * Create password recovery (confirmation)
434
- *
435
- * Use this endpoint to complete the user account password reset. Both the
436
- * **userId** and **secret** arguments will be passed as query parameters to
437
- * the redirect URL you have provided when sending your request to the [POST
438
- * /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#createRecovery)
439
- * endpoint.
440
- *
441
- * Please note that in order to avoid a [Redirect
442
- * Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md)
443
- * the only valid redirect URLs are the ones from domains you have set when
444
- * adding your platforms in the console interface.
445
- *
446
- * @param {string} userId
447
- * @param {string} secret
448
- * @param {string} password
449
- * @throws {AppcondaException}
450
- * @returns {Promise}
451
- */
452
- updateRecovery(userId: string, secret: string, password: string): Promise<Models.Token>;
453
- /**
454
- * List sessions
455
- *
456
- * Get the list of active sessions across different devices for the currently
457
- * logged in user.
458
- *
459
- * @throws {AppcondaException}
460
- * @returns {Promise}
461
- */
462
- listSessions(): Promise<Models.SessionList>;
463
- /**
464
- * Delete sessions
465
- *
466
- * Delete all sessions from the user account and remove any sessions cookies
467
- * from the end client.
468
- *
469
- * @throws {AppcondaException}
470
- * @returns {Promise}
471
- */
472
- deleteSessions(): Promise<{}>;
473
- /**
474
- * Create anonymous session
475
- *
476
- * Use this endpoint to allow a new user to register an anonymous account in
477
- * your project. This route will also create a new session for the user. To
478
- * allow the new user to convert an anonymous account to a normal account, you
479
- * need to update its [email and
480
- * password](https://appwrite.io/docs/references/cloud/client-web/account#updateEmail)
481
- * or create an [OAuth2
482
- * session](https://appwrite.io/docs/references/cloud/client-web/account#CreateOAuth2Session).
483
- *
484
- * @throws {AppcondaException}
485
- * @returns {Promise}
486
- */
487
- createAnonymousSession(): Promise<Models.Session>;
488
- /**
489
- * Create email password session
490
- *
491
- * Allow the user to login into their account by providing a valid email and
492
- * password combination. This route will create a new session for the user.
493
- *
494
- * A user is limited to 10 active sessions at a time by default. [Learn more
495
- * about session
496
- * limits](https://appwrite.io/docs/authentication-security#limits).
497
- *
498
- * @param {string} email
499
- * @param {string} password
500
- * @throws {AppcondaException}
501
- * @returns {Promise}
502
- */
503
- createEmailPasswordSession(email: string, password: string): Promise<Models.Session>;
504
- /**
505
- * Update magic URL session
506
- *
507
- * Use this endpoint to create a session from token. Provide the **userId**
508
- * and **secret** parameters from the successful response of authentication
509
- * flows initiated by token creation. For example, magic URL and phone login.
510
- *
511
- * @param {string} userId
512
- * @param {string} secret
513
- * @throws {AppcondaException}
514
- * @returns {Promise}
515
- */
516
- updateMagicURLSession(userId: string, secret: string): Promise<Models.Session>;
517
- /**
518
- * Create OAuth2 session
519
- *
520
- * Allow the user to login to their account using the OAuth2 provider of their
521
- * choice. Each OAuth2 provider should be enabled from the Appwrite console
522
- * first. Use the success and failure arguments to provide a redirect URL's
523
- * back to your app when login is completed.
524
- *
525
- * If there is already an active session, the new session will be attached to
526
- * the logged-in account. If there are no active sessions, the server will
527
- * attempt to look for a user with the same email address as the email
528
- * received from the OAuth2 provider and attach the new session to the
529
- * existing user. If no matching user is found - the server will create a new
530
- * user.
531
- *
532
- * A user is limited to 10 active sessions at a time by default. [Learn more
533
- * about session
534
- * limits](https://appwrite.io/docs/authentication-security#limits).
535
- *
536
- *
537
- * @param {OAuthProvider} provider
538
- * @param {string} success
539
- * @param {string} failure
540
- * @param {string[]} scopes
541
- * @throws {AppcondaException}
542
- * @returns {void|string}
543
- */
544
- createOAuth2Session(provider: OAuthProvider, success?: string, failure?: string, scopes?: string[]): void | URL;
545
- /**
546
- * Update phone session
547
- *
548
- * Use this endpoint to create a session from token. Provide the **userId**
549
- * and **secret** parameters from the successful response of authentication
550
- * flows initiated by token creation. For example, magic URL and phone login.
551
- *
552
- * @param {string} userId
553
- * @param {string} secret
554
- * @throws {AppcondaException}
555
- * @returns {Promise}
556
- */
557
- updatePhoneSession(userId: string, secret: string): Promise<Models.Session>;
558
- /**
559
- * Create session
560
- *
561
- * Use this endpoint to create a session from token. Provide the **userId**
562
- * and **secret** parameters from the successful response of authentication
563
- * flows initiated by token creation. For example, magic URL and phone login.
564
- *
565
- * @param {string} userId
566
- * @param {string} secret
567
- * @throws {AppcondaException}
568
- * @returns {Promise}
569
- */
570
- createSession(userId: string, secret: string): Promise<Models.Session>;
571
- /**
572
- * Get session
573
- *
574
- * Use this endpoint to get a logged in user's session using a Session ID.
575
- * Inputting 'current' will return the current session being used.
576
- *
577
- * @param {string} sessionId
578
- * @throws {AppcondaException}
579
- * @returns {Promise}
580
- */
581
- getSession(sessionId: string): Promise<Models.Session>;
582
- /**
583
- * Update session
584
- *
585
- * Use this endpoint to extend a session's length. Extending a session is
586
- * useful when session expiry is short. If the session was created using an
587
- * OAuth provider, this endpoint refreshes the access token from the provider.
588
- *
589
- * @param {string} sessionId
590
- * @throws {AppcondaException}
591
- * @returns {Promise}
592
- */
593
- updateSession(sessionId: string): Promise<Models.Session>;
594
- /**
595
- * Delete session
596
- *
597
- * Logout the user. Use 'current' as the session ID to logout on this device,
598
- * use a session ID to logout on another device. If you're looking to logout
599
- * the user on all devices, use [Delete
600
- * Sessions](https://appwrite.io/docs/references/cloud/client-web/account#deleteSessions)
601
- * instead.
602
- *
603
- * @param {string} sessionId
604
- * @throws {AppcondaException}
605
- * @returns {Promise}
606
- */
607
- deleteSession(sessionId: string): Promise<{}>;
608
- /**
609
- * Update status
610
- *
611
- * Block the currently logged in user account. Behind the scene, the user
612
- * record is not deleted but permanently blocked from any access. To
613
- * completely delete a user, use the Users API instead.
614
- *
615
- * @throws {AppcondaException}
616
- * @returns {Promise}
617
- */
618
- updateStatus<Preferences extends Models.Preferences>(): Promise<Models.User<Preferences>>;
619
- /**
620
- * Create push target
621
- *
622
- *
623
- * @param {string} targetId
624
- * @param {string} identifier
625
- * @param {string} providerId
626
- * @throws {AppcondaException}
627
- * @returns {Promise}
628
- */
629
- createPushTarget(targetId: string, identifier: string, providerId?: string): Promise<Models.Target>;
630
- /**
631
- * Update push target
632
- *
633
- *
634
- * @param {string} targetId
635
- * @param {string} identifier
636
- * @throws {AppcondaException}
637
- * @returns {Promise}
638
- */
639
- updatePushTarget(targetId: string, identifier: string): Promise<Models.Target>;
640
- /**
641
- * Delete push target
642
- *
643
- *
644
- * @param {string} targetId
645
- * @throws {AppcondaException}
646
- * @returns {Promise}
647
- */
648
- deletePushTarget(targetId: string): Promise<{}>;
649
- /**
650
- * Create email token (OTP)
651
- *
652
- * Sends the user an email with a secret key for creating a session. If the
653
- * provided user ID has not be registered, a new user will be created. Use the
654
- * returned user ID and secret and submit a request to the [POST
655
- * /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession)
656
- * endpoint to complete the login process. The secret sent to the user's email
657
- * is valid for 15 minutes.
658
- *
659
- * A user is limited to 10 active sessions at a time by default. [Learn more
660
- * about session
661
- * limits](https://appwrite.io/docs/authentication-security#limits).
662
- *
663
- * @param {string} userId
664
- * @param {string} email
665
- * @param {boolean} phrase
666
- * @throws {AppcondaException}
667
- * @returns {Promise}
668
- */
669
- createEmailToken(userId: string, email: string, phrase?: boolean): Promise<Models.Token>;
670
- /**
671
- * Create magic URL token
672
- *
673
- * Sends the user an email with a secret key for creating a session. If the
674
- * provided user ID has not been registered, a new user will be created. When
675
- * the user clicks the link in the email, the user is redirected back to the
676
- * URL you provided with the secret key and userId values attached to the URL
677
- * query string. Use the query string parameters to submit a request to the
678
- * [POST
679
- * /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession)
680
- * endpoint to complete the login process. The link sent to the user's email
681
- * address is valid for 1 hour. If you are on a mobile device you can leave
682
- * the URL parameter empty, so that the login completion will be handled by
683
- * your Appwrite instance by default.
684
- *
685
- * A user is limited to 10 active sessions at a time by default. [Learn more
686
- * about session
687
- * limits](https://appwrite.io/docs/authentication-security#limits).
688
- *
689
- *
690
- * @param {string} userId
691
- * @param {string} email
692
- * @param {string} url
693
- * @param {boolean} phrase
694
- * @throws {AppcondaException}
695
- * @returns {Promise}
696
- */
697
- createMagicURLToken(userId: string, email: string, url?: string, phrase?: boolean): Promise<Models.Token>;
698
- /**
699
- * Create OAuth2 token
700
- *
701
- * Allow the user to login to their account using the OAuth2 provider of their
702
- * choice. Each OAuth2 provider should be enabled from the Appwrite console
703
- * first. Use the success and failure arguments to provide a redirect URL's
704
- * back to your app when login is completed.
705
- *
706
- * If authentication succeeds, `userId` and `secret` of a token will be
707
- * appended to the success URL as query parameters. These can be used to
708
- * create a new session using the [Create
709
- * session](https://appwrite.io/docs/references/cloud/client-web/account#createSession)
710
- * endpoint.
711
- *
712
- * A user is limited to 10 active sessions at a time by default. [Learn more
713
- * about session
714
- * limits](https://appwrite.io/docs/authentication-security#limits).
715
- *
716
- * @param {OAuthProvider} provider
717
- * @param {string} success
718
- * @param {string} failure
719
- * @param {string[]} scopes
720
- * @throws {AppcondaException}
721
- * @returns {void|string}
722
- */
723
- createOAuth2Token(provider: OAuthProvider, success?: string, failure?: string, scopes?: string[]): void | URL;
724
- /**
725
- * Create phone token
726
- *
727
- * Sends the user an SMS with a secret key for creating a session. If the
728
- * provided user ID has not be registered, a new user will be created. Use the
729
- * returned user ID and secret and submit a request to the [POST
730
- * /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession)
731
- * endpoint to complete the login process. The secret sent to the user's phone
732
- * is valid for 15 minutes.
733
- *
734
- * A user is limited to 10 active sessions at a time by default. [Learn more
735
- * about session
736
- * limits](https://appwrite.io/docs/authentication-security#limits).
737
- *
738
- * @param {string} userId
739
- * @param {string} phone
740
- * @throws {AppcondaException}
741
- * @returns {Promise}
742
- */
743
- createPhoneToken(userId: string, phone: string): Promise<Models.Token>;
744
- /**
745
- * Create email verification
746
- *
747
- * Use this endpoint to send a verification message to your user email address
748
- * to confirm they are the valid owners of that address. Both the **userId**
749
- * and **secret** arguments will be passed as query parameters to the URL you
750
- * have provided to be attached to the verification email. The provided URL
751
- * should redirect the user back to your app and allow you to complete the
752
- * verification process by verifying both the **userId** and **secret**
753
- * parameters. Learn more about how to [complete the verification
754
- * process](https://appwrite.io/docs/references/cloud/client-web/account#updateVerification).
755
- * The verification link sent to the user's email address is valid for 7 days.
756
- *
757
- * Please note that in order to avoid a [Redirect
758
- * Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md),
759
- * the only valid redirect URLs are the ones from domains you have set when
760
- * adding your platforms in the console interface.
761
- *
762
- *
763
- * @param {string} url
764
- * @throws {AppcondaException}
765
- * @returns {Promise}
766
- */
767
- createVerification(url: string): Promise<Models.Token>;
768
- /**
769
- * Create email verification (confirmation)
770
- *
771
- * Use this endpoint to complete the user email verification process. Use both
772
- * the **userId** and **secret** parameters that were attached to your app URL
773
- * to verify the user email ownership. If confirmed this route will return a
774
- * 200 status code.
775
- *
776
- * @param {string} userId
777
- * @param {string} secret
778
- * @throws {AppcondaException}
779
- * @returns {Promise}
780
- */
781
- updateVerification(userId: string, secret: string): Promise<Models.Token>;
782
- /**
783
- * Create phone verification
784
- *
785
- * Use this endpoint to send a verification SMS to the currently logged in
786
- * user. This endpoint is meant for use after updating a user's phone number
787
- * using the
788
- * [accountUpdatePhone](https://appwrite.io/docs/references/cloud/client-web/account#updatePhone)
789
- * endpoint. Learn more about how to [complete the verification
790
- * process](https://appwrite.io/docs/references/cloud/client-web/account#updatePhoneVerification).
791
- * The verification code sent to the user's phone number is valid for 15
792
- * minutes.
793
- *
794
- * @throws {AppcondaException}
795
- * @returns {Promise}
796
- */
797
- createPhoneVerification(): Promise<Models.Token>;
798
- /**
799
- * Create phone verification (confirmation)
800
- *
801
- * Use this endpoint to complete the user phone verification process. Use the
802
- * **userId** and **secret** that were sent to your user's phone number to
803
- * verify the user email ownership. If confirmed this route will return a 200
804
- * status code.
805
- *
806
- * @param {string} userId
807
- * @param {string} secret
808
- * @throws {AppcondaException}
809
- * @returns {Promise}
810
- */
811
- updatePhoneVerification(userId: string, secret: string): Promise<Models.Token>;
812
- }
813
-
814
- export class Avatars extends Service {
815
- constructor(client: Client);
816
- /**
817
- * Get browser icon
818
- *
819
- * You can use this endpoint to show different browser icons to your users.
820
- * The code argument receives the browser code as it appears in your user [GET
821
- * /account/sessions](https://appwrite.io/docs/references/cloud/client-web/account#getSessions)
822
- * endpoint. Use width, height and quality arguments to change the output
823
- * settings.
824
- *
825
- * When one dimension is specified and the other is 0, the image is scaled
826
- * with preserved aspect ratio. If both dimensions are 0, the API provides an
827
- * image at source quality. If dimensions are not specified, the default size
828
- * of image returned is 100x100px.
829
- *
830
- * @param {Browser} code
831
- * @param {number} width
832
- * @param {number} height
833
- * @param {number} quality
834
- * @throws {AppwriteException}
835
- * @returns {URL}
836
- */
837
- getBrowser(code: Browser, width?: number, height?: number, quality?: number): URL;
838
- /**
839
- * Get credit card icon
840
- *
841
- * The credit card endpoint will return you the icon of the credit card
842
- * provider you need. Use width, height and quality arguments to change the
843
- * output settings.
844
- *
845
- * When one dimension is specified and the other is 0, the image is scaled
846
- * with preserved aspect ratio. If both dimensions are 0, the API provides an
847
- * image at source quality. If dimensions are not specified, the default size
848
- * of image returned is 100x100px.
849
- *
850
- *
851
- * @param {CreditCard} code
852
- * @param {number} width
853
- * @param {number} height
854
- * @param {number} quality
855
- * @throws {AppwriteException}
856
- * @returns {URL}
857
- */
858
- getCreditCard(code: CreditCard, width?: number, height?: number, quality?: number): URL;
859
- /**
860
- * Get favicon
861
- *
862
- * Use this endpoint to fetch the favorite icon (AKA favicon) of any remote
863
- * website URL.
864
- *
865
- *
866
- * @param {string} url
867
- * @throws {AppwriteException}
868
- * @returns {URL}
869
- */
870
- getFavicon(url: string): URL;
871
- /**
872
- * Get country flag
873
- *
874
- * You can use this endpoint to show different country flags icons to your
875
- * users. The code argument receives the 2 letter country code. Use width,
876
- * height and quality arguments to change the output settings. Country codes
877
- * follow the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard.
878
- *
879
- * When one dimension is specified and the other is 0, the image is scaled
880
- * with preserved aspect ratio. If both dimensions are 0, the API provides an
881
- * image at source quality. If dimensions are not specified, the default size
882
- * of image returned is 100x100px.
883
- *
884
- *
885
- * @param {Flag} code
886
- * @param {number} width
887
- * @param {number} height
888
- * @param {number} quality
889
- * @throws {AppwriteException}
890
- * @returns {URL}
891
- */
892
- getFlag(code: Flag, width?: number, height?: number, quality?: number): URL;
893
- /**
894
- * Get image from URL
895
- *
896
- * Use this endpoint to fetch a remote image URL and crop it to any image size
897
- * you want. This endpoint is very useful if you need to crop and display
898
- * remote images in your app or in case you want to make sure a 3rd party
899
- * image is properly served using a TLS protocol.
900
- *
901
- * When one dimension is specified and the other is 0, the image is scaled
902
- * with preserved aspect ratio. If both dimensions are 0, the API provides an
903
- * image at source quality. If dimensions are not specified, the default size
904
- * of image returned is 400x400px.
905
- *
906
- *
907
- * @param {string} url
908
- * @param {number} width
909
- * @param {number} height
910
- * @throws {AppwriteException}
911
- * @returns {URL}
912
- */
913
- getImage(url: string, width?: number, height?: number): URL;
914
- /**
915
- * Get user initials
916
- *
917
- * Use this endpoint to show your user initials avatar icon on your website or
918
- * app. By default, this route will try to print your logged-in user name or
919
- * email initials. You can also overwrite the user name if you pass the 'name'
920
- * parameter. If no name is given and no user is logged, an empty avatar will
921
- * be returned.
922
- *
923
- * You can use the color and background params to change the avatar colors. By
924
- * default, a random theme will be selected. The random theme will persist for
925
- * the user's initials when reloading the same theme will always return for
926
- * the same initials.
927
- *
928
- * When one dimension is specified and the other is 0, the image is scaled
929
- * with preserved aspect ratio. If both dimensions are 0, the API provides an
930
- * image at source quality. If dimensions are not specified, the default size
931
- * of image returned is 100x100px.
932
- *
933
- *
934
- * @param {string} name
935
- * @param {number} width
936
- * @param {number} height
937
- * @param {string} background
938
- * @throws {AppwriteException}
939
- * @returns {URL}
940
- */
941
- getInitials(name?: string, width?: number, height?: number, background?: string): URL;
942
- /**
943
- * Get QR code
944
- *
945
- * Converts a given plain text to a QR code image. You can use the query
946
- * parameters to change the size and style of the resulting image.
947
- *
948
- *
949
- * @param {string} text
950
- * @param {number} size
951
- * @param {number} margin
952
- * @param {boolean} download
953
- * @throws {AppwriteException}
954
- * @returns {URL}
955
- */
956
- getQR(text: string, size?: number, margin?: number, download?: boolean): URL;
957
- }
958
-
959
- export class Databases {
960
- client: Client;
961
- constructor(client: Client);
962
- /**
963
- * List documents
964
- *
965
- * Get a list of all the user&#039;s documents in a given collection. You can use the query params to filter your results.
966
- *
967
- * @param {string} databaseId
968
- * @param {string} collectionId
969
- * @param {string[]} queries
970
- * @throws {AppcondaException}
971
- * @returns {Promise<Models.DocumentList<Document>>}
972
- */
973
- listDocuments<Document extends Models.Document>(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.DocumentList<Document>>;
974
- /**
975
- * Create document
976
- *
977
- * Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https://appconda.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
978
- *
979
- * @param {string} databaseId
980
- * @param {string} collectionId
981
- * @param {string} documentId
982
- * @param {Omit<Document, keyof Models.Document>} data
983
- * @param {string[]} permissions
984
- * @throws {AppcondaException}
985
- * @returns {Promise<Document>}
986
- */
987
- createDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, data: Omit<Document, keyof Models.Document>, permissions?: string[]): Promise<Document>;
988
- /**
989
- * Get document
990
- *
991
- * Get a document by its unique ID. This endpoint response returns a JSON object with the document data.
992
- *
993
- * @param {string} databaseId
994
- * @param {string} collectionId
995
- * @param {string} documentId
996
- * @param {string[]} queries
997
- * @throws {AppcondaException}
998
- * @returns {Promise<Document>}
999
- */
1000
- getDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, queries?: string[]): Promise<Document>;
1001
- /**
1002
- * Update document
1003
- *
1004
- * Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.
1005
- *
1006
- * @param {string} databaseId
1007
- * @param {string} collectionId
1008
- * @param {string} documentId
1009
- * @param {Partial<Omit<Document, keyof Models.Document>>} data
1010
- * @param {string[]} permissions
1011
- * @throws {AppcondaException}
1012
- * @returns {Promise<Document>}
1013
- */
1014
- updateDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, data?: Partial<Omit<Document, keyof Models.Document>>, permissions?: string[]): Promise<Document>;
1015
- /**
1016
- * Delete document
1017
- *
1018
- * Delete a document by its unique ID.
1019
- *
1020
- * @param {string} databaseId
1021
- * @param {string} collectionId
1022
- * @param {string} documentId
1023
- * @throws {AppcondaException}
1024
- * @returns {Promise<{}>}
1025
- */
1026
- deleteDocument(databaseId: string, collectionId: string, documentId: string): Promise<{}>;
1027
- }
1028
-
1029
- export class Functions {
1030
- client: Client;
1031
- constructor(client: Client);
1032
- /**
1033
- * List executions
1034
- *
1035
- * Get a list of all the current user function execution logs. You can use the query params to filter your results.
1036
- *
1037
- * @param {string} functionId
1038
- * @param {string[]} queries
1039
- * @param {string} search
1040
- * @throws {AppcondaException}
1041
- * @returns {Promise<Models.ExecutionList>}
1042
- */
1043
- listExecutions(functionId: string, queries?: string[], search?: string): Promise<Models.ExecutionList>;
1044
- /**
1045
- * Create execution
1046
- *
1047
- * Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.
1048
- *
1049
- * @param {string} functionId
1050
- * @param {string} body
1051
- * @param {boolean} async
1052
- * @param {string} xpath
1053
- * @param {ExecutionMethod} method
1054
- * @param {object} headers
1055
- * @param {string} scheduledAt
1056
- * @throws {AppcondaException}
1057
- * @returns {Promise<Models.Execution>}
1058
- */
1059
- createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: ExecutionMethod, headers?: object, scheduledAt?: string): Promise<Models.Execution>;
1060
- /**
1061
- * Get execution
1062
- *
1063
- * Get a function execution log by its unique ID.
1064
- *
1065
- * @param {string} functionId
1066
- * @param {string} executionId
1067
- * @throws {AppcondaException}
1068
- * @returns {Promise<Models.Execution>}
1069
- */
1070
- getExecution(functionId: string, executionId: string): Promise<Models.Execution>;
1071
- }
1072
-
1073
- export class Graphql {
1074
- client: Client;
1075
- constructor(client: Client);
1076
- /**
1077
- * GraphQL endpoint
1078
- *
1079
- * Execute a GraphQL mutation.
1080
- *
1081
- * @param {object} query
1082
- * @throws {AppcondaException}
1083
- * @returns {Promise<{}>}
1084
- */
1085
- query(query: object): Promise<{}>;
1086
- /**
1087
- * GraphQL endpoint
1088
- *
1089
- * Execute a GraphQL mutation.
1090
- *
1091
- * @param {object} query
1092
- * @throws {AppcondaException}
1093
- * @returns {Promise<{}>}
1094
- */
1095
- mutation(query: object): Promise<{}>;
1096
- }
1097
-
1098
- export class Locale {
1099
- client: Client;
1100
- constructor(client: Client);
1101
- /**
1102
- * Get user locale
1103
- *
1104
- * Get the current user location based on IP. Returns an object with user country code, country name, continent name, continent code, ip address and suggested currency. You can use the locale header to get the data in a supported language.
1105
-
1106
- ([IP Geolocation by DB-IP](https://db-ip.com))
1107
- *
1108
- * @throws {AppcondaException}
1109
- * @returns {Promise<Models.Locale>}
1110
- */
1111
- get(): Promise<Models.Locale>;
1112
- /**
1113
- * List Locale Codes
1114
- *
1115
- * List of all locale codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).
1116
- *
1117
- * @throws {AppcondaException}
1118
- * @returns {Promise<Models.LocaleCodeList>}
1119
- */
1120
- listCodes(): Promise<Models.LocaleCodeList>;
1121
- /**
1122
- * List continents
1123
- *
1124
- * List of all continents. You can use the locale header to get the data in a supported language.
1125
- *
1126
- * @throws {AppcondaException}
1127
- * @returns {Promise<Models.ContinentList>}
1128
- */
1129
- listContinents(): Promise<Models.ContinentList>;
1130
- /**
1131
- * List countries
1132
- *
1133
- * List of all countries. You can use the locale header to get the data in a supported language.
1134
- *
1135
- * @throws {AppcondaException}
1136
- * @returns {Promise<Models.CountryList>}
1137
- */
1138
- listCountries(): Promise<Models.CountryList>;
1139
- /**
1140
- * List EU countries
1141
- *
1142
- * List of all countries that are currently members of the EU. You can use the locale header to get the data in a supported language.
1143
- *
1144
- * @throws {AppcondaException}
1145
- * @returns {Promise<Models.CountryList>}
1146
- */
1147
- listCountriesEU(): Promise<Models.CountryList>;
1148
- /**
1149
- * List countries phone codes
1150
- *
1151
- * List of all countries phone codes. You can use the locale header to get the data in a supported language.
1152
- *
1153
- * @throws {AppcondaException}
1154
- * @returns {Promise<Models.PhoneList>}
1155
- */
1156
- listCountriesPhones(): Promise<Models.PhoneList>;
1157
- /**
1158
- * List currencies
1159
- *
1160
- * List of all currencies, including currency symbol, name, plural, and decimal digits for all major and minor currencies. You can use the locale header to get the data in a supported language.
1161
- *
1162
- * @throws {AppcondaException}
1163
- * @returns {Promise<Models.CurrencyList>}
1164
- */
1165
- listCurrencies(): Promise<Models.CurrencyList>;
1166
- /**
1167
- * List languages
1168
- *
1169
- * List of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.
1170
- *
1171
- * @throws {AppcondaException}
1172
- * @returns {Promise<Models.LanguageList>}
1173
- */
1174
- listLanguages(): Promise<Models.LanguageList>;
1175
- }
1176
-
1177
- export class Messaging {
1178
- client: Client;
1179
- constructor(client: Client);
1180
- /**
1181
- * Create subscriber
1182
- *
1183
- * Create a new subscriber.
1184
- *
1185
- * @param {string} topicId
1186
- * @param {string} subscriberId
1187
- * @param {string} targetId
1188
- * @throws {AppcondaException}
1189
- * @returns {Promise<Models.Subscriber>}
1190
- */
1191
- createSubscriber(topicId: string, subscriberId: string, targetId: string): Promise<Models.Subscriber>;
1192
- /**
1193
- * Delete subscriber
1194
- *
1195
- * Delete a subscriber by its unique ID.
1196
- *
1197
- * @param {string} topicId
1198
- * @param {string} subscriberId
1199
- * @throws {AppcondaException}
1200
- * @returns {Promise<{}>}
1201
- */
1202
- deleteSubscriber(topicId: string, subscriberId: string): Promise<{}>;
1203
- }
1204
-
1205
- export class Storage extends Service {
1206
- constructor(client: Client);
1207
- /**
1208
- * List files
1209
- *
1210
- * Get a list of all the user files. You can use the query params to filter
1211
- * your results.
1212
- *
1213
- * @param {string} bucketId
1214
- * @param {string[]} queries
1215
- * @param {string} search
1216
- * @throws {AppcondaException}
1217
- * @returns {Promise}
1218
- */
1219
- listFiles(bucketId: string, queries?: string[], search?: string): Promise<Models.FileList>;
1220
- /**
1221
- * Create file
1222
- *
1223
- * Create a new file. Before using this route, you should create a new bucket
1224
- * resource using either a [server
1225
- * integration](https://appwrite.io/docs/server/storage#storageCreateBucket)
1226
- * API or directly from your Appwrite console.
1227
- *
1228
- * Larger files should be uploaded using multiple requests with the
1229
- * [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range)
1230
- * header to send a partial request with a maximum supported chunk of `5MB`.
1231
- * The `content-range` header values should always be in bytes.
1232
- *
1233
- * When the first request is sent, the server will return the **File** object,
1234
- * and the subsequent part request must include the file's **id** in
1235
- * `x-appwrite-id` header to allow the server to know that the partial upload
1236
- * is for the existing file and not for a new one.
1237
- *
1238
- * If you're creating a new file using one of the Appwrite SDKs, all the
1239
- * chunking logic will be managed by the SDK internally.
1240
- *
1241
- *
1242
- * @param {string} bucketId
1243
- * @param {string} fileId
1244
- * @param {File} file
1245
- * @param {string[]} permissions
1246
- * @throws {AppcondaException}
1247
- * @returns {Promise}
1248
- */
1249
- createFile(bucketId: string, fileId: string, file: File, permissions?: string[], onProgress?: (progress: UploadProgress) => void): Promise<Models.File>;
1250
- /**
1251
- * Get file
1252
- *
1253
- * Get a file by its unique ID. This endpoint response returns a JSON object
1254
- * with the file metadata.
1255
- *
1256
- * @param {string} bucketId
1257
- * @param {string} fileId
1258
- * @throws {AppcondaException}
1259
- * @returns {Promise}
1260
- */
1261
- getFile(bucketId: string, fileId: string): Promise<Models.File>;
1262
- /**
1263
- * Update file
1264
- *
1265
- * Update a file by its unique ID. Only users with write permissions have
1266
- * access to update this resource.
1267
- *
1268
- * @param {string} bucketId
1269
- * @param {string} fileId
1270
- * @param {string} name
1271
- * @param {string[]} permissions
1272
- * @throws {AppcondaException}
1273
- * @returns {Promise}
1274
- */
1275
- updateFile(bucketId: string, fileId: string, name?: string, permissions?: string[]): Promise<Models.File>;
1276
- /**
1277
- * Delete File
1278
- *
1279
- * Delete a file by its unique ID. Only users with write permissions have
1280
- * access to delete this resource.
1281
- *
1282
- * @param {string} bucketId
1283
- * @param {string} fileId
1284
- * @throws {AppcondaException}
1285
- * @returns {Promise}
1286
- */
1287
- deleteFile(bucketId: string, fileId: string): Promise<{}>;
1288
- /**
1289
- * Get file for download
1290
- *
1291
- * Get a file content by its unique ID. The endpoint response return with a
1292
- * 'Content-Disposition: attachment' header that tells the browser to start
1293
- * downloading the file to user downloads directory.
1294
- *
1295
- * @param {string} bucketId
1296
- * @param {string} fileId
1297
- * @throws {AppcondaException}
1298
- * @returns {URL}
1299
- */
1300
- getFileDownload(bucketId: string, fileId: string): URL;
1301
- /**
1302
- * Get file preview
1303
- *
1304
- * Get a file preview image. Currently, this method supports preview for image
1305
- * files (jpg, png, and gif), other supported formats, like pdf, docs, slides,
1306
- * and spreadsheets, will return the file icon image. You can also pass query
1307
- * string arguments for cutting and resizing your preview image. Preview is
1308
- * supported only for image files smaller than 10MB.
1309
- *
1310
- * @param {string} bucketId
1311
- * @param {string} fileId
1312
- * @param {number} width
1313
- * @param {number} height
1314
- * @param {ImageGravity} gravity
1315
- * @param {number} quality
1316
- * @param {number} borderWidth
1317
- * @param {string} borderColor
1318
- * @param {number} borderRadius
1319
- * @param {number} opacity
1320
- * @param {number} rotation
1321
- * @param {string} background
1322
- * @param {ImageFormat} output
1323
- * @throws {AppcondaException}
1324
- * @returns {URL}
1325
- */
1326
- getFilePreview(bucketId: string, fileId: string, width?: number, height?: number, gravity?: ImageGravity, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: ImageFormat): URL;
1327
- /**
1328
- * Get file for view
1329
- *
1330
- * Get a file content by its unique ID. This endpoint is similar to the
1331
- * download method but returns with no 'Content-Disposition: attachment'
1332
- * header.
1333
- *
1334
- * @param {string} bucketId
1335
- * @param {string} fileId
1336
- * @throws {AppcondaException}
1337
- * @returns {URL}
1338
- */
1339
- getFileView(bucketId: string, fileId: string): URL;
1340
- }
1341
-
1342
- export class Teams {
1343
- client: Client;
1344
- constructor(client: Client);
1345
- /**
1346
- * List teams
1347
- *
1348
- * Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.
1349
- *
1350
- * @param {string[]} queries
1351
- * @param {string} search
1352
- * @throws {AppcondaException}
1353
- * @returns {Promise<Models.TeamList<Preferences>>}
1354
- */
1355
- list<Preferences extends Models.Preferences>(queries?: string[], search?: string): Promise<Models.TeamList<Preferences>>;
1356
- /**
1357
- * Create team
1358
- *
1359
- * Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.
1360
- *
1361
- * @param {string} teamId
1362
- * @param {string} name
1363
- * @param {string[]} roles
1364
- * @throws {AppcondaException}
1365
- * @returns {Promise<Models.Team<Preferences>>}
1366
- */
1367
- create<Preferences extends Models.Preferences>(teamId: string, name: string, roles?: string[]): Promise<Models.Team<Preferences>>;
1368
- /**
1369
- * Get team
1370
- *
1371
- * Get a team by its ID. All team members have read access for this resource.
1372
- *
1373
- * @param {string} teamId
1374
- * @throws {AppcondaException}
1375
- * @returns {Promise<Models.Team<Preferences>>}
1376
- */
1377
- get<Preferences extends Models.Preferences>(teamId: string): Promise<Models.Team<Preferences>>;
1378
- /**
1379
- * Update name
1380
- *
1381
- * Update the team&#039;s name by its unique ID.
1382
- *
1383
- * @param {string} teamId
1384
- * @param {string} name
1385
- * @throws {AppcondaException}
1386
- * @returns {Promise<Models.Team<Preferences>>}
1387
- */
1388
- updateName<Preferences extends Models.Preferences>(teamId: string, name: string): Promise<Models.Team<Preferences>>;
1389
- /**
1390
- * Delete team
1391
- *
1392
- * Delete a team using its ID. Only team members with the owner role can delete the team.
1393
- *
1394
- * @param {string} teamId
1395
- * @throws {AppcondaException}
1396
- * @returns {Promise<{}>}
1397
- */
1398
- delete(teamId: string): Promise<{}>;
1399
- /**
1400
- * List team memberships
1401
- *
1402
- * Use this endpoint to list a team&#039;s members using the team&#039;s ID. All team members have read access to this endpoint.
1403
- *
1404
- * @param {string} teamId
1405
- * @param {string[]} queries
1406
- * @param {string} search
1407
- * @throws {AppcondaException}
1408
- * @returns {Promise<Models.MembershipList>}
1409
- */
1410
- listMemberships(teamId: string, queries?: string[], search?: string): Promise<Models.MembershipList>;
1411
- /**
1412
- * Create team membership
1413
- *
1414
- * Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appconda will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn&#039;t exist. If initiated from a Server SDK, the new member will be added automatically to the team.
1415
-
1416
- You only need to provide one of a user ID, email, or phone number. Appconda will prioritize accepting the user ID &gt; email &gt; phone number if you provide more than one of these parameters.
1417
-
1418
- Use the `url` parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](https://appconda.io/docs/references/cloud/client-web/teams#updateMembershipStatus) endpoint to allow the user to accept the invitation to the team.
1419
-
1420
- Please note that to avoid a [Redirect Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) Appconda will accept the only redirect URLs under the domains you have added as a platform on the Appconda Console.
1421
-
1422
- *
1423
- * @param {string} teamId
1424
- * @param {string[]} roles
1425
- * @param {string} email
1426
- * @param {string} userId
1427
- * @param {string} phone
1428
- * @param {string} url
1429
- * @param {string} name
1430
- * @throws {AppcondaException}
1431
- * @returns {Promise<Models.Membership>}
1432
- */
1433
- createMembership(teamId: string, roles: string[], email?: string, userId?: string, phone?: string, url?: string, name?: string): Promise<Models.Membership>;
1434
- /**
1435
- * Get team membership
1436
- *
1437
- * Get a team member by the membership unique id. All team members have read access for this resource.
1438
- *
1439
- * @param {string} teamId
1440
- * @param {string} membershipId
1441
- * @throws {AppcondaException}
1442
- * @returns {Promise<Models.Membership>}
1443
- */
1444
- getMembership(teamId: string, membershipId: string): Promise<Models.Membership>;
1445
- /**
1446
- * Update membership
1447
- *
1448
- * Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](https://appconda.io/docs/permissions).
1449
-
1450
- *
1451
- * @param {string} teamId
1452
- * @param {string} membershipId
1453
- * @param {string[]} roles
1454
- * @throws {AppcondaException}
1455
- * @returns {Promise<Models.Membership>}
1456
- */
1457
- updateMembership(teamId: string, membershipId: string, roles: string[]): Promise<Models.Membership>;
1458
- /**
1459
- * Delete team membership
1460
- *
1461
- * This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.
1462
- *
1463
- * @param {string} teamId
1464
- * @param {string} membershipId
1465
- * @throws {AppcondaException}
1466
- * @returns {Promise<{}>}
1467
- */
1468
- deleteMembership(teamId: string, membershipId: string): Promise<{}>;
1469
- /**
1470
- * Update team membership status
1471
- *
1472
- * Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.
1473
-
1474
- If the request is successful, a session for the user is automatically created.
1475
-
1476
- *
1477
- * @param {string} teamId
1478
- * @param {string} membershipId
1479
- * @param {string} userId
1480
- * @param {string} secret
1481
- * @throws {AppcondaException}
1482
- * @returns {Promise<Models.Membership>}
1483
- */
1484
- updateMembershipStatus(teamId: string, membershipId: string, userId: string, secret: string): Promise<Models.Membership>;
1485
- /**
1486
- * Get team preferences
1487
- *
1488
- * Get the team&#039;s shared preferences by its unique ID. If a preference doesn&#039;t need to be shared by all team members, prefer storing them in [user preferences](https://appconda.io/docs/references/cloud/client-web/account#getPrefs).
1489
- *
1490
- * @param {string} teamId
1491
- * @throws {AppcondaException}
1492
- * @returns {Promise<Preferences>}
1493
- */
1494
- getPrefs<Preferences extends Models.Preferences>(teamId: string): Promise<Preferences>;
1495
- /**
1496
- * Update preferences
1497
- *
1498
- * Update the team&#039;s preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.
1499
- *
1500
- * @param {string} teamId
1501
- * @param {object} prefs
1502
- * @throws {AppcondaException}
1503
- * @returns {Promise<Preferences>}
1504
- */
1505
- updatePrefs<Preferences extends Models.Preferences>(teamId: string, prefs: object): Promise<Preferences>;
1506
- }
1507
-
1508
- type QueryTypesSingle = string | number | boolean;
1509
- export type QueryTypesList = string[] | number[] | boolean[] | Query[];
1510
- export type QueryTypes = QueryTypesSingle | QueryTypesList;
1511
- type AttributesTypes = string | string[];
1512
- /**
1513
- * Helper class to generate query strings.
1514
- */
1515
- export class Query {
1516
- method: string;
1517
- attribute: AttributesTypes | undefined;
1518
- values: QueryTypesList | undefined;
1519
- /**
1520
- * Constructor for Query class.
1521
- *
1522
- * @param {string} method
1523
- * @param {AttributesTypes} attribute
1524
- * @param {QueryTypes} values
1525
- */
1526
- constructor(method: string, attribute?: AttributesTypes, values?: QueryTypes);
1527
- /**
1528
- * Convert the query object to a JSON string.
1529
- *
1530
- * @returns {string}
1531
- */
1532
- toString(): string;
1533
- /**
1534
- * Filter resources where attribute is equal to value.
1535
- *
1536
- * @param {string} attribute
1537
- * @param {QueryTypes} value
1538
- * @returns {string}
1539
- */
1540
- static equal: (attribute: string, value: QueryTypes) => string;
1541
- /**
1542
- * Filter resources where attribute is not equal to value.
1543
- *
1544
- * @param {string} attribute
1545
- * @param {QueryTypes} value
1546
- * @returns {string}
1547
- */
1548
- static notEqual: (attribute: string, value: QueryTypes) => string;
1549
- /**
1550
- * Filter resources where attribute is less than value.
1551
- *
1552
- * @param {string} attribute
1553
- * @param {QueryTypes} value
1554
- * @returns {string}
1555
- */
1556
- static lessThan: (attribute: string, value: QueryTypes) => string;
1557
- /**
1558
- * Filter resources where attribute is less than or equal to value.
1559
- *
1560
- * @param {string} attribute
1561
- * @param {QueryTypes} value
1562
- * @returns {string}
1563
- */
1564
- static lessThanEqual: (attribute: string, value: QueryTypes) => string;
1565
- /**
1566
- * Filter resources where attribute is greater than value.
1567
- *
1568
- * @param {string} attribute
1569
- * @param {QueryTypes} value
1570
- * @returns {string}
1571
- */
1572
- static greaterThan: (attribute: string, value: QueryTypes) => string;
1573
- /**
1574
- * Filter resources where attribute is greater than or equal to value.
1575
- *
1576
- * @param {string} attribute
1577
- * @param {QueryTypes} value
1578
- * @returns {string}
1579
- */
1580
- static greaterThanEqual: (attribute: string, value: QueryTypes) => string;
1581
- /**
1582
- * Filter resources where attribute is null.
1583
- *
1584
- * @param {string} attribute
1585
- * @returns {string}
1586
- */
1587
- static isNull: (attribute: string) => string;
1588
- /**
1589
- * Filter resources where attribute is not null.
1590
- *
1591
- * @param {string} attribute
1592
- * @returns {string}
1593
- */
1594
- static isNotNull: (attribute: string) => string;
1595
- /**
1596
- * Filter resources where attribute is between start and end (inclusive).
1597
- *
1598
- * @param {string} attribute
1599
- * @param {string | number} start
1600
- * @param {string | number} end
1601
- * @returns {string}
1602
- */
1603
- static between: (attribute: string, start: string | number, end: string | number) => string;
1604
- /**
1605
- * Filter resources where attribute starts with value.
1606
- *
1607
- * @param {string} attribute
1608
- * @param {string} value
1609
- * @returns {string}
1610
- */
1611
- static startsWith: (attribute: string, value: string) => string;
1612
- /**
1613
- * Filter resources where attribute ends with value.
1614
- *
1615
- * @param {string} attribute
1616
- * @param {string} value
1617
- * @returns {string}
1618
- */
1619
- static endsWith: (attribute: string, value: string) => string;
1620
- /**
1621
- * Specify which attributes should be returned by the API call.
1622
- *
1623
- * @param {string[]} attributes
1624
- * @returns {string}
1625
- */
1626
- static select: (attributes: string[]) => string;
1627
- /**
1628
- * Filter resources by searching attribute for value.
1629
- * A fulltext index on attribute is required for this query to work.
1630
- *
1631
- * @param {string} attribute
1632
- * @param {string} value
1633
- * @returns {string}
1634
- */
1635
- static search: (attribute: string, value: string) => string;
1636
- /**
1637
- * Sort results by attribute descending.
1638
- *
1639
- * @param {string} attribute
1640
- * @returns {string}
1641
- */
1642
- static orderDesc: (attribute: string) => string;
1643
- /**
1644
- * Sort results by attribute ascending.
1645
- *
1646
- * @param {string} attribute
1647
- * @returns {string}
1648
- */
1649
- static orderAsc: (attribute: string) => string;
1650
- /**
1651
- * Return results after documentId.
1652
- *
1653
- * @param {string} documentId
1654
- * @returns {string}
1655
- */
1656
- static cursorAfter: (documentId: string) => string;
1657
- /**
1658
- * Return results before documentId.
1659
- *
1660
- * @param {string} documentId
1661
- * @returns {string}
1662
- */
1663
- static cursorBefore: (documentId: string) => string;
1664
- /**
1665
- * Return only limit results.
1666
- *
1667
- * @param {number} limit
1668
- * @returns {string}
1669
- */
1670
- static limit: (limit: number) => string;
1671
- /**
1672
- * Filter resources by skipping the first offset results.
1673
- *
1674
- * @param {number} offset
1675
- * @returns {string}
1676
- */
1677
- static offset: (offset: number) => string;
1678
- /**
1679
- * Filter resources where attribute contains the specified value.
1680
- *
1681
- * @param {string} attribute
1682
- * @param {string | string[]} value
1683
- * @returns {string}
1684
- */
1685
- static contains: (attribute: string, value: string | string[]) => string;
1686
- /**
1687
- * Combine multiple queries using logical OR operator.
1688
- *
1689
- * @param {string[]} queries
1690
- * @returns {string}
1691
- */
1692
- static or: (queries: string[]) => string;
1693
- /**
1694
- * Combine multiple queries using logical AND operator.
1695
- *
1696
- * @param {string[]} queries
1697
- * @returns {string}
1698
- */
1699
- static and: (queries: string[]) => string;
1700
- }
1701
- export {};
1702
-
1703
- /**
1704
- * Helper class to generate permission strings for resources.
1705
- */
1706
- export class Permission {
1707
- /**
1708
- * Generate read permission string for the provided role.
1709
- *
1710
- * @param {string} role
1711
- * @returns {string}
1712
- */
1713
- static read: (role: string) => string;
1714
- /**
1715
- * Generate write permission string for the provided role.
1716
- *
1717
- * This is an alias of update, delete, and possibly create.
1718
- * Don't use write in combination with update, delete, or create.
1719
- *
1720
- * @param {string} role
1721
- * @returns {string}
1722
- */
1723
- static write: (role: string) => string;
1724
- /**
1725
- * Generate create permission string for the provided role.
1726
- *
1727
- * @param {string} role
1728
- * @returns {string}
1729
- */
1730
- static create: (role: string) => string;
1731
- /**
1732
- * Generate update permission string for the provided role.
1733
- *
1734
- * @param {string} role
1735
- * @returns {string}
1736
- */
1737
- static update: (role: string) => string;
1738
- /**
1739
- * Generate delete permission string for the provided role.
1740
- *
1741
- * @param {string} role
1742
- * @returns {string}
1743
- */
1744
- static delete: (role: string) => string;
1745
- }
1746
-
1747
- /**
1748
- * Helper class to generate role strings for `Permission`.
1749
- */
1750
- export class Role {
1751
- /**
1752
- * Grants access to anyone.
1753
- *
1754
- * This includes authenticated and unauthenticated users.
1755
- *
1756
- * @returns {string}
1757
- */
1758
- static any(): string;
1759
- /**
1760
- * Grants access to a specific user by user ID.
1761
- *
1762
- * You can optionally pass verified or unverified for
1763
- * `status` to target specific types of users.
1764
- *
1765
- * @param {string} id
1766
- * @param {string} status
1767
- * @returns {string}
1768
- */
1769
- static user(id: string, status?: string): string;
1770
- /**
1771
- * Grants access to any authenticated or anonymous user.
1772
- *
1773
- * You can optionally pass verified or unverified for
1774
- * `status` to target specific types of users.
1775
- *
1776
- * @param {string} status
1777
- * @returns {string}
1778
- */
1779
- static users(status?: string): string;
1780
- /**
1781
- * Grants access to any guest user without a session.
1782
- *
1783
- * Authenticated users don't have access to this role.
1784
- *
1785
- * @returns {string}
1786
- */
1787
- static guests(): string;
1788
- /**
1789
- * Grants access to a team by team ID.
1790
- *
1791
- * You can optionally pass a role for `role` to target
1792
- * team members with the specified role.
1793
- *
1794
- * @param {string} id
1795
- * @param {string} role
1796
- * @returns {string}
1797
- */
1798
- static team(id: string, role?: string): string;
1799
- /**
1800
- * Grants access to a specific member of a team.
1801
- *
1802
- * When the member is removed from the team, they will
1803
- * no longer have access.
1804
- *
1805
- * @param {string} id
1806
- * @returns {string}
1807
- */
1808
- static member(id: string): string;
1809
- /**
1810
- * Grants access to a user with the specified label.
1811
- *
1812
- * @param {string} name
1813
- * @returns {string}
1814
- */
1815
- static label(name: string): string;
1816
- }
1817
-
1818
- /**
1819
- * Helper class to generate ID strings for resources.
1820
- */
1821
- export class ID {
1822
- #private;
1823
- /**
1824
- * Uses the provided ID as the ID for the resource.
1825
- *
1826
- * @param {string} id
1827
- * @returns {string}
1828
- */
1829
- static custom(id: string): string;
1830
- /**
1831
- * Have Appconda generate a unique ID for you.
1832
- *
1833
- * @param {number} padding. Default is 7.
1834
- * @returns {string}
1835
- */
1836
- static unique(padding?: number): string;
1837
- }
1838
-
1839
- export enum AuthenticatorType {
1840
- Totp = "totp"
1841
- }
1842
-
1843
- export enum AuthenticationFactor {
1844
- Email = "email",
1845
- Phone = "phone",
1846
- Totp = "totp",
1847
- Recoverycode = "recoverycode"
1848
- }
1849
-
1850
- export enum OAuthProvider {
1851
- Amazon = "amazon",
1852
- Apple = "apple",
1853
- Auth0 = "auth0",
1854
- Authentik = "authentik",
1855
- Autodesk = "autodesk",
1856
- Bitbucket = "bitbucket",
1857
- Bitly = "bitly",
1858
- Box = "box",
1859
- Dailymotion = "dailymotion",
1860
- Discord = "discord",
1861
- Disqus = "disqus",
1862
- Dropbox = "dropbox",
1863
- Etsy = "etsy",
1864
- Facebook = "facebook",
1865
- Github = "github",
1866
- Gitlab = "gitlab",
1867
- Google = "google",
1868
- Linkedin = "linkedin",
1869
- Microsoft = "microsoft",
1870
- Notion = "notion",
1871
- Oidc = "oidc",
1872
- Okta = "okta",
1873
- Paypal = "paypal",
1874
- PaypalSandbox = "paypalSandbox",
1875
- Podio = "podio",
1876
- Salesforce = "salesforce",
1877
- Slack = "slack",
1878
- Spotify = "spotify",
1879
- Stripe = "stripe",
1880
- Tradeshift = "tradeshift",
1881
- TradeshiftBox = "tradeshiftBox",
1882
- Twitch = "twitch",
1883
- Wordpress = "wordpress",
1884
- Yahoo = "yahoo",
1885
- Yammer = "yammer",
1886
- Yandex = "yandex",
1887
- Zoho = "zoho",
1888
- Zoom = "zoom",
1889
- Mock = "mock"
1890
- }
1891
-
1892
- export enum Browser {
1893
- AvantBrowser = "aa",
1894
- AndroidWebViewBeta = "an",
1895
- GoogleChrome = "ch",
1896
- GoogleChromeIOS = "ci",
1897
- GoogleChromeMobile = "cm",
1898
- Chromium = "cr",
1899
- MozillaFirefox = "ff",
1900
- Safari = "sf",
1901
- MobileSafari = "mf",
1902
- MicrosoftEdge = "ps",
1903
- MicrosoftEdgeIOS = "oi",
1904
- OperaMini = "om",
1905
- Opera = "op",
1906
- OperaNext = "on"
1907
- }
1908
-
1909
- export enum CreditCard {
1910
- AmericanExpress = "amex",
1911
- Argencard = "argencard",
1912
- Cabal = "cabal",
1913
- Cencosud = "cencosud",
1914
- DinersClub = "diners",
1915
- Discover = "discover",
1916
- Elo = "elo",
1917
- Hipercard = "hipercard",
1918
- JCB = "jcb",
1919
- Mastercard = "mastercard",
1920
- Naranja = "naranja",
1921
- TarjetaShopping = "targeta-shopping",
1922
- UnionChinaPay = "union-china-pay",
1923
- Visa = "visa",
1924
- MIR = "mir",
1925
- Maestro = "maestro"
1926
- }
1927
-
1928
- export enum Flag {
1929
- Afghanistan = "af",
1930
- Angola = "ao",
1931
- Albania = "al",
1932
- Andorra = "ad",
1933
- UnitedArabEmirates = "ae",
1934
- Argentina = "ar",
1935
- Armenia = "am",
1936
- AntiguaAndBarbuda = "ag",
1937
- Australia = "au",
1938
- Austria = "at",
1939
- Azerbaijan = "az",
1940
- Burundi = "bi",
1941
- Belgium = "be",
1942
- Benin = "bj",
1943
- BurkinaFaso = "bf",
1944
- Bangladesh = "bd",
1945
- Bulgaria = "bg",
1946
- Bahrain = "bh",
1947
- Bahamas = "bs",
1948
- BosniaAndHerzegovina = "ba",
1949
- Belarus = "by",
1950
- Belize = "bz",
1951
- Bolivia = "bo",
1952
- Brazil = "br",
1953
- Barbados = "bb",
1954
- BruneiDarussalam = "bn",
1955
- Bhutan = "bt",
1956
- Botswana = "bw",
1957
- CentralAfricanRepublic = "cf",
1958
- Canada = "ca",
1959
- Switzerland = "ch",
1960
- Chile = "cl",
1961
- China = "cn",
1962
- CoteDIvoire = "ci",
1963
- Cameroon = "cm",
1964
- DemocraticRepublicOfTheCongo = "cd",
1965
- RepublicOfTheCongo = "cg",
1966
- Colombia = "co",
1967
- Comoros = "km",
1968
- CapeVerde = "cv",
1969
- CostaRica = "cr",
1970
- Cuba = "cu",
1971
- Cyprus = "cy",
1972
- CzechRepublic = "cz",
1973
- Germany = "de",
1974
- Djibouti = "dj",
1975
- Dominica = "dm",
1976
- Denmark = "dk",
1977
- DominicanRepublic = "do",
1978
- Algeria = "dz",
1979
- Ecuador = "ec",
1980
- Egypt = "eg",
1981
- Eritrea = "er",
1982
- Spain = "es",
1983
- Estonia = "ee",
1984
- Ethiopia = "et",
1985
- Finland = "fi",
1986
- Fiji = "fj",
1987
- France = "fr",
1988
- MicronesiaFederatedStatesOf = "fm",
1989
- Gabon = "ga",
1990
- UnitedKingdom = "gb",
1991
- Georgia = "ge",
1992
- Ghana = "gh",
1993
- Guinea = "gn",
1994
- Gambia = "gm",
1995
- GuineaBissau = "gw",
1996
- EquatorialGuinea = "gq",
1997
- Greece = "gr",
1998
- Grenada = "gd",
1999
- Guatemala = "gt",
2000
- Guyana = "gy",
2001
- Honduras = "hn",
2002
- Croatia = "hr",
2003
- Haiti = "ht",
2004
- Hungary = "hu",
2005
- Indonesia = "id",
2006
- India = "in",
2007
- Ireland = "ie",
2008
- IranIslamicRepublicOf = "ir",
2009
- Iraq = "iq",
2010
- Iceland = "is",
2011
- Israel = "il",
2012
- Italy = "it",
2013
- Jamaica = "jm",
2014
- Jordan = "jo",
2015
- Japan = "jp",
2016
- Kazakhstan = "kz",
2017
- Kenya = "ke",
2018
- Kyrgyzstan = "kg",
2019
- Cambodia = "kh",
2020
- Kiribati = "ki",
2021
- SaintKittsAndNevis = "kn",
2022
- SouthKorea = "kr",
2023
- Kuwait = "kw",
2024
- LaoPeopleSDemocraticRepublic = "la",
2025
- Lebanon = "lb",
2026
- Liberia = "lr",
2027
- Libya = "ly",
2028
- SaintLucia = "lc",
2029
- Liechtenstein = "li",
2030
- SriLanka = "lk",
2031
- Lesotho = "ls",
2032
- Lithuania = "lt",
2033
- Luxembourg = "lu",
2034
- Latvia = "lv",
2035
- Morocco = "ma",
2036
- Monaco = "mc",
2037
- Moldova = "md",
2038
- Madagascar = "mg",
2039
- Maldives = "mv",
2040
- Mexico = "mx",
2041
- MarshallIslands = "mh",
2042
- NorthMacedonia = "mk",
2043
- Mali = "ml",
2044
- Malta = "mt",
2045
- Myanmar = "mm",
2046
- Montenegro = "me",
2047
- Mongolia = "mn",
2048
- Mozambique = "mz",
2049
- Mauritania = "mr",
2050
- Mauritius = "mu",
2051
- Malawi = "mw",
2052
- Malaysia = "my",
2053
- Namibia = "na",
2054
- Niger = "ne",
2055
- Nigeria = "ng",
2056
- Nicaragua = "ni",
2057
- Netherlands = "nl",
2058
- Norway = "no",
2059
- Nepal = "np",
2060
- Nauru = "nr",
2061
- NewZealand = "nz",
2062
- Oman = "om",
2063
- Pakistan = "pk",
2064
- Panama = "pa",
2065
- Peru = "pe",
2066
- Philippines = "ph",
2067
- Palau = "pw",
2068
- PapuaNewGuinea = "pg",
2069
- Poland = "pl",
2070
- FrenchPolynesia = "pf",
2071
- NorthKorea = "kp",
2072
- Portugal = "pt",
2073
- Paraguay = "py",
2074
- Qatar = "qa",
2075
- Romania = "ro",
2076
- Russia = "ru",
2077
- Rwanda = "rw",
2078
- SaudiArabia = "sa",
2079
- Sudan = "sd",
2080
- Senegal = "sn",
2081
- Singapore = "sg",
2082
- SolomonIslands = "sb",
2083
- SierraLeone = "sl",
2084
- ElSalvador = "sv",
2085
- SanMarino = "sm",
2086
- Somalia = "so",
2087
- Serbia = "rs",
2088
- SouthSudan = "ss",
2089
- SaoTomeAndPrincipe = "st",
2090
- Suriname = "sr",
2091
- Slovakia = "sk",
2092
- Slovenia = "si",
2093
- Sweden = "se",
2094
- Eswatini = "sz",
2095
- Seychelles = "sc",
2096
- Syria = "sy",
2097
- Chad = "td",
2098
- Togo = "tg",
2099
- Thailand = "th",
2100
- Tajikistan = "tj",
2101
- Turkmenistan = "tm",
2102
- TimorLeste = "tl",
2103
- Tonga = "to",
2104
- TrinidadAndTobago = "tt",
2105
- Tunisia = "tn",
2106
- Turkey = "tr",
2107
- Tuvalu = "tv",
2108
- Tanzania = "tz",
2109
- Uganda = "ug",
2110
- Ukraine = "ua",
2111
- Uruguay = "uy",
2112
- UnitedStates = "us",
2113
- Uzbekistan = "uz",
2114
- VaticanCity = "va",
2115
- SaintVincentAndTheGrenadines = "vc",
2116
- Venezuela = "ve",
2117
- Vietnam = "vn",
2118
- Vanuatu = "vu",
2119
- Samoa = "ws",
2120
- Yemen = "ye",
2121
- SouthAfrica = "za",
2122
- Zambia = "zm",
2123
- Zimbabwe = "zw"
2124
- }
2125
-
2126
- export enum ExecutionMethod {
2127
- GET = "GET",
2128
- POST = "POST",
2129
- PUT = "PUT",
2130
- PATCH = "PATCH",
2131
- DELETE = "DELETE",
2132
- OPTIONS = "OPTIONS"
2133
- }
2134
-
2135
- export enum ImageGravity {
2136
- Center = "center",
2137
- Topleft = "top-left",
2138
- Top = "top",
2139
- Topright = "top-right",
2140
- Left = "left",
2141
- Right = "right",
2142
- Bottomleft = "bottom-left",
2143
- Bottom = "bottom",
2144
- Bottomright = "bottom-right"
2145
- }
2146
-
2147
- export enum ImageFormat {
2148
- Jpg = "jpg",
2149
- Jpeg = "jpeg",
2150
- Gif = "gif",
2151
- Png = "png",
2152
- Webp = "webp"
2153
- }
2154
-
2155
- /**
2156
- * Appconda Models
2157
- */
2158
- export namespace Models {
2159
- /**
2160
- * Documents List
2161
- */
2162
- type DocumentList<Document extends Models.Document> = {
2163
- /**
2164
- * Total number of documents documents that matched your query.
2165
- */
2166
- total: number;
2167
- /**
2168
- * List of documents.
2169
- */
2170
- documents: Document[];
2171
- };
2172
- /**
2173
- * Sessions List
2174
- */
2175
- type SessionList = {
2176
- /**
2177
- * Total number of sessions documents that matched your query.
2178
- */
2179
- total: number;
2180
- /**
2181
- * List of sessions.
2182
- */
2183
- sessions: Session[];
2184
- };
2185
- /**
2186
- * Identities List
2187
- */
2188
- type IdentityList = {
2189
- /**
2190
- * Total number of identities documents that matched your query.
2191
- */
2192
- total: number;
2193
- /**
2194
- * List of identities.
2195
- */
2196
- identities: Identity[];
2197
- };
2198
- /**
2199
- * Logs List
2200
- */
2201
- type LogList = {
2202
- /**
2203
- * Total number of logs documents that matched your query.
2204
- */
2205
- total: number;
2206
- /**
2207
- * List of logs.
2208
- */
2209
- logs: Log[];
2210
- };
2211
- /**
2212
- * Files List
2213
- */
2214
- type FileList = {
2215
- /**
2216
- * Total number of files documents that matched your query.
2217
- */
2218
- total: number;
2219
- /**
2220
- * List of files.
2221
- */
2222
- files: File[];
2223
- };
2224
- /**
2225
- * Teams List
2226
- */
2227
- type TeamList<Preferences extends Models.Preferences> = {
2228
- /**
2229
- * Total number of teams documents that matched your query.
2230
- */
2231
- total: number;
2232
- /**
2233
- * List of teams.
2234
- */
2235
- teams: Team<Preferences>[];
2236
- };
2237
- /**
2238
- * Memberships List
2239
- */
2240
- type MembershipList = {
2241
- /**
2242
- * Total number of memberships documents that matched your query.
2243
- */
2244
- total: number;
2245
- /**
2246
- * List of memberships.
2247
- */
2248
- memberships: Membership[];
2249
- };
2250
- /**
2251
- * Executions List
2252
- */
2253
- type ExecutionList = {
2254
- /**
2255
- * Total number of executions documents that matched your query.
2256
- */
2257
- total: number;
2258
- /**
2259
- * List of executions.
2260
- */
2261
- executions: Execution[];
2262
- };
2263
- /**
2264
- * Countries List
2265
- */
2266
- type CountryList = {
2267
- /**
2268
- * Total number of countries documents that matched your query.
2269
- */
2270
- total: number;
2271
- /**
2272
- * List of countries.
2273
- */
2274
- countries: Country[];
2275
- };
2276
- /**
2277
- * Continents List
2278
- */
2279
- type ContinentList = {
2280
- /**
2281
- * Total number of continents documents that matched your query.
2282
- */
2283
- total: number;
2284
- /**
2285
- * List of continents.
2286
- */
2287
- continents: Continent[];
2288
- };
2289
- /**
2290
- * Languages List
2291
- */
2292
- type LanguageList = {
2293
- /**
2294
- * Total number of languages documents that matched your query.
2295
- */
2296
- total: number;
2297
- /**
2298
- * List of languages.
2299
- */
2300
- languages: Language[];
2301
- };
2302
- /**
2303
- * Currencies List
2304
- */
2305
- type CurrencyList = {
2306
- /**
2307
- * Total number of currencies documents that matched your query.
2308
- */
2309
- total: number;
2310
- /**
2311
- * List of currencies.
2312
- */
2313
- currencies: Currency[];
2314
- };
2315
- /**
2316
- * Phones List
2317
- */
2318
- type PhoneList = {
2319
- /**
2320
- * Total number of phones documents that matched your query.
2321
- */
2322
- total: number;
2323
- /**
2324
- * List of phones.
2325
- */
2326
- phones: Phone[];
2327
- };
2328
- /**
2329
- * Locale codes list
2330
- */
2331
- type LocaleCodeList = {
2332
- /**
2333
- * Total number of localeCodes documents that matched your query.
2334
- */
2335
- total: number;
2336
- /**
2337
- * List of localeCodes.
2338
- */
2339
- localeCodes: LocaleCode[];
2340
- };
2341
- /**
2342
- * Document
2343
- */
2344
- type Document = {
2345
- /**
2346
- * Document ID.
2347
- */
2348
- $id: string;
2349
- /**
2350
- * Collection ID.
2351
- */
2352
- $collectionId: string;
2353
- /**
2354
- * Database ID.
2355
- */
2356
- $databaseId: string;
2357
- /**
2358
- * Document creation date in ISO 8601 format.
2359
- */
2360
- $createdAt: string;
2361
- /**
2362
- * Document update date in ISO 8601 format.
2363
- */
2364
- $updatedAt: string;
2365
- /**
2366
- * Document permissions. [Learn more about permissions](https://appconda.io/docs/permissions).
2367
- */
2368
- $permissions: string[];
2369
- [key: string]: any;
2370
- };
2371
- /**
2372
- * Log
2373
- */
2374
- type Log = {
2375
- /**
2376
- * Event name.
2377
- */
2378
- event: string;
2379
- /**
2380
- * User ID.
2381
- */
2382
- userId: string;
2383
- /**
2384
- * User Email.
2385
- */
2386
- userEmail: string;
2387
- /**
2388
- * User Name.
2389
- */
2390
- userName: string;
2391
- /**
2392
- * API mode when event triggered.
2393
- */
2394
- mode: string;
2395
- /**
2396
- * IP session in use when the session was created.
2397
- */
2398
- ip: string;
2399
- /**
2400
- * Log creation date in ISO 8601 format.
2401
- */
2402
- time: string;
2403
- /**
2404
- * Operating system code name. View list of [available options](https://github.com/appconda/appconda/blob/master/docs/lists/os.json).
2405
- */
2406
- osCode: string;
2407
- /**
2408
- * Operating system name.
2409
- */
2410
- osName: string;
2411
- /**
2412
- * Operating system version.
2413
- */
2414
- osVersion: string;
2415
- /**
2416
- * Client type.
2417
- */
2418
- clientType: string;
2419
- /**
2420
- * Client code name. View list of [available options](https://github.com/appconda/appconda/blob/master/docs/lists/clients.json).
2421
- */
2422
- clientCode: string;
2423
- /**
2424
- * Client name.
2425
- */
2426
- clientName: string;
2427
- /**
2428
- * Client version.
2429
- */
2430
- clientVersion: string;
2431
- /**
2432
- * Client engine name.
2433
- */
2434
- clientEngine: string;
2435
- /**
2436
- * Client engine name.
2437
- */
2438
- clientEngineVersion: string;
2439
- /**
2440
- * Device name.
2441
- */
2442
- deviceName: string;
2443
- /**
2444
- * Device brand name.
2445
- */
2446
- deviceBrand: string;
2447
- /**
2448
- * Device model name.
2449
- */
2450
- deviceModel: string;
2451
- /**
2452
- * Country two-character ISO 3166-1 alpha code.
2453
- */
2454
- countryCode: string;
2455
- /**
2456
- * Country name.
2457
- */
2458
- countryName: string;
2459
- };
2460
- /**
2461
- * User
2462
- */
2463
- type User<Preferences extends Models.Preferences> = {
2464
- /**
2465
- * User ID.
2466
- */
2467
- $id: string;
2468
- /**
2469
- * User creation date in ISO 8601 format.
2470
- */
2471
- $createdAt: string;
2472
- /**
2473
- * User update date in ISO 8601 format.
2474
- */
2475
- $updatedAt: string;
2476
- /**
2477
- * User name.
2478
- */
2479
- name: string;
2480
- /**
2481
- * Hashed user password.
2482
- */
2483
- password?: string;
2484
- /**
2485
- * Password hashing algorithm.
2486
- */
2487
- hash?: string;
2488
- /**
2489
- * Password hashing algorithm configuration.
2490
- */
2491
- hashOptions?: object;
2492
- /**
2493
- * User registration date in ISO 8601 format.
2494
- */
2495
- registration: string;
2496
- /**
2497
- * User status. Pass `true` for enabled and `false` for disabled.
2498
- */
2499
- status: boolean;
2500
- /**
2501
- * Labels for the user.
2502
- */
2503
- labels: string[];
2504
- /**
2505
- * Password update time in ISO 8601 format.
2506
- */
2507
- passwordUpdate: string;
2508
- /**
2509
- * User email address.
2510
- */
2511
- email: string;
2512
- /**
2513
- * User phone number in E.164 format.
2514
- */
2515
- phone: string;
2516
- /**
2517
- * Email verification status.
2518
- */
2519
- emailVerification: boolean;
2520
- /**
2521
- * Phone verification status.
2522
- */
2523
- phoneVerification: boolean;
2524
- /**
2525
- * Multi factor authentication status.
2526
- */
2527
- mfa: boolean;
2528
- /**
2529
- * User preferences as a key-value object
2530
- */
2531
- prefs: Preferences;
2532
- /**
2533
- * 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.
2534
- */
2535
- targets: Target[];
2536
- /**
2537
- * Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.
2538
- */
2539
- accessedAt: string;
2540
- };
2541
- /**
2542
- * AlgoMD5
2543
- */
2544
- type AlgoMd5 = {
2545
- /**
2546
- * Algo type.
2547
- */
2548
- type: string;
2549
- };
2550
- /**
2551
- * AlgoSHA
2552
- */
2553
- type AlgoSha = {
2554
- /**
2555
- * Algo type.
2556
- */
2557
- type: string;
2558
- };
2559
- /**
2560
- * AlgoPHPass
2561
- */
2562
- type AlgoPhpass = {
2563
- /**
2564
- * Algo type.
2565
- */
2566
- type: string;
2567
- };
2568
- /**
2569
- * AlgoBcrypt
2570
- */
2571
- type AlgoBcrypt = {
2572
- /**
2573
- * Algo type.
2574
- */
2575
- type: string;
2576
- };
2577
- /**
2578
- * AlgoScrypt
2579
- */
2580
- type AlgoScrypt = {
2581
- /**
2582
- * Algo type.
2583
- */
2584
- type: string;
2585
- /**
2586
- * CPU complexity of computed hash.
2587
- */
2588
- costCpu: number;
2589
- /**
2590
- * Memory complexity of computed hash.
2591
- */
2592
- costMemory: number;
2593
- /**
2594
- * Parallelization of computed hash.
2595
- */
2596
- costParallel: number;
2597
- /**
2598
- * Length used to compute hash.
2599
- */
2600
- length: number;
2601
- };
2602
- /**
2603
- * AlgoScryptModified
2604
- */
2605
- type AlgoScryptModified = {
2606
- /**
2607
- * Algo type.
2608
- */
2609
- type: string;
2610
- /**
2611
- * Salt used to compute hash.
2612
- */
2613
- salt: string;
2614
- /**
2615
- * Separator used to compute hash.
2616
- */
2617
- saltSeparator: string;
2618
- /**
2619
- * Key used to compute hash.
2620
- */
2621
- signerKey: string;
2622
- };
2623
- /**
2624
- * AlgoArgon2
2625
- */
2626
- type AlgoArgon2 = {
2627
- /**
2628
- * Algo type.
2629
- */
2630
- type: string;
2631
- /**
2632
- * Memory used to compute hash.
2633
- */
2634
- memoryCost: number;
2635
- /**
2636
- * Amount of time consumed to compute hash
2637
- */
2638
- timeCost: number;
2639
- /**
2640
- * Number of threads used to compute hash.
2641
- */
2642
- threads: number;
2643
- };
2644
- /**
2645
- * Preferences
2646
- */
2647
- type Preferences = {
2648
- [key: string]: any;
2649
- };
2650
- /**
2651
- * Session
2652
- */
2653
- type Session = {
2654
- /**
2655
- * Session ID.
2656
- */
2657
- $id: string;
2658
- /**
2659
- * Session creation date in ISO 8601 format.
2660
- */
2661
- $createdAt: string;
2662
- /**
2663
- * Session update date in ISO 8601 format.
2664
- */
2665
- $updatedAt: string;
2666
- /**
2667
- * User ID.
2668
- */
2669
- userId: string;
2670
- /**
2671
- * Session expiration date in ISO 8601 format.
2672
- */
2673
- expire: string;
2674
- /**
2675
- * Session Provider.
2676
- */
2677
- provider: string;
2678
- /**
2679
- * Session Provider User ID.
2680
- */
2681
- providerUid: string;
2682
- /**
2683
- * Session Provider Access Token.
2684
- */
2685
- providerAccessToken: string;
2686
- /**
2687
- * The date of when the access token expires in ISO 8601 format.
2688
- */
2689
- providerAccessTokenExpiry: string;
2690
- /**
2691
- * Session Provider Refresh Token.
2692
- */
2693
- providerRefreshToken: string;
2694
- /**
2695
- * IP in use when the session was created.
2696
- */
2697
- ip: string;
2698
- /**
2699
- * Operating system code name. View list of [available options](https://github.com/appconda/appconda/blob/master/docs/lists/os.json).
2700
- */
2701
- osCode: string;
2702
- /**
2703
- * Operating system name.
2704
- */
2705
- osName: string;
2706
- /**
2707
- * Operating system version.
2708
- */
2709
- osVersion: string;
2710
- /**
2711
- * Client type.
2712
- */
2713
- clientType: string;
2714
- /**
2715
- * Client code name. View list of [available options](https://github.com/appconda/appconda/blob/master/docs/lists/clients.json).
2716
- */
2717
- clientCode: string;
2718
- /**
2719
- * Client name.
2720
- */
2721
- clientName: string;
2722
- /**
2723
- * Client version.
2724
- */
2725
- clientVersion: string;
2726
- /**
2727
- * Client engine name.
2728
- */
2729
- clientEngine: string;
2730
- /**
2731
- * Client engine name.
2732
- */
2733
- clientEngineVersion: string;
2734
- /**
2735
- * Device name.
2736
- */
2737
- deviceName: string;
2738
- /**
2739
- * Device brand name.
2740
- */
2741
- deviceBrand: string;
2742
- /**
2743
- * Device model name.
2744
- */
2745
- deviceModel: string;
2746
- /**
2747
- * Country two-character ISO 3166-1 alpha code.
2748
- */
2749
- countryCode: string;
2750
- /**
2751
- * Country name.
2752
- */
2753
- countryName: string;
2754
- /**
2755
- * Returns true if this the current user session.
2756
- */
2757
- current: boolean;
2758
- /**
2759
- * Returns a list of active session factors.
2760
- */
2761
- factors: string[];
2762
- /**
2763
- * Secret used to authenticate the user. Only included if the request was made with an API key
2764
- */
2765
- secret: string;
2766
- /**
2767
- * Most recent date in ISO 8601 format when the session successfully passed MFA challenge.
2768
- */
2769
- mfaUpdatedAt: string;
2770
- };
2771
- /**
2772
- * Identity
2773
- */
2774
- type Identity = {
2775
- /**
2776
- * Identity ID.
2777
- */
2778
- $id: string;
2779
- /**
2780
- * Identity creation date in ISO 8601 format.
2781
- */
2782
- $createdAt: string;
2783
- /**
2784
- * Identity update date in ISO 8601 format.
2785
- */
2786
- $updatedAt: string;
2787
- /**
2788
- * User ID.
2789
- */
2790
- userId: string;
2791
- /**
2792
- * Identity Provider.
2793
- */
2794
- provider: string;
2795
- /**
2796
- * ID of the User in the Identity Provider.
2797
- */
2798
- providerUid: string;
2799
- /**
2800
- * Email of the User in the Identity Provider.
2801
- */
2802
- providerEmail: string;
2803
- /**
2804
- * Identity Provider Access Token.
2805
- */
2806
- providerAccessToken: string;
2807
- /**
2808
- * The date of when the access token expires in ISO 8601 format.
2809
- */
2810
- providerAccessTokenExpiry: string;
2811
- /**
2812
- * Identity Provider Refresh Token.
2813
- */
2814
- providerRefreshToken: string;
2815
- };
2816
- /**
2817
- * Token
2818
- */
2819
- type Token = {
2820
- /**
2821
- * Token ID.
2822
- */
2823
- $id: string;
2824
- /**
2825
- * Token creation date in ISO 8601 format.
2826
- */
2827
- $createdAt: string;
2828
- /**
2829
- * User ID.
2830
- */
2831
- userId: string;
2832
- /**
2833
- * 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.
2834
- */
2835
- secret: string;
2836
- /**
2837
- * Token expiration date in ISO 8601 format.
2838
- */
2839
- expire: string;
2840
- /**
2841
- * 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.
2842
- */
2843
- phrase: string;
2844
- };
2845
- /**
2846
- * JWT
2847
- */
2848
- type Jwt = {
2849
- /**
2850
- * JWT encoded string.
2851
- */
2852
- jwt: string;
2853
- };
2854
- /**
2855
- * Locale
2856
- */
2857
- type Locale = {
2858
- /**
2859
- * User IP address.
2860
- */
2861
- ip: string;
2862
- /**
2863
- * Country code in [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) two-character format
2864
- */
2865
- countryCode: string;
2866
- /**
2867
- * Country name. This field support localization.
2868
- */
2869
- country: string;
2870
- /**
2871
- * 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.
2872
- */
2873
- continentCode: string;
2874
- /**
2875
- * Continent name. This field support localization.
2876
- */
2877
- continent: string;
2878
- /**
2879
- * True if country is part of the European Union.
2880
- */
2881
- eu: boolean;
2882
- /**
2883
- * Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format
2884
- */
2885
- currency: string;
2886
- };
2887
- /**
2888
- * LocaleCode
2889
- */
2890
- type LocaleCode = {
2891
- /**
2892
- * Locale codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
2893
- */
2894
- code: string;
2895
- /**
2896
- * Locale name
2897
- */
2898
- name: string;
2899
- };
2900
- /**
2901
- * File
2902
- */
2903
- type File = {
2904
- /**
2905
- * File ID.
2906
- */
2907
- $id: string;
2908
- /**
2909
- * Bucket ID.
2910
- */
2911
- bucketId: string;
2912
- /**
2913
- * File creation date in ISO 8601 format.
2914
- */
2915
- $createdAt: string;
2916
- /**
2917
- * File update date in ISO 8601 format.
2918
- */
2919
- $updatedAt: string;
2920
- /**
2921
- * File permissions. [Learn more about permissions](https://appconda.io/docs/permissions).
2922
- */
2923
- $permissions: string[];
2924
- /**
2925
- * File name.
2926
- */
2927
- name: string;
2928
- /**
2929
- * File MD5 signature.
2930
- */
2931
- signature: string;
2932
- /**
2933
- * File mime type.
2934
- */
2935
- mimeType: string;
2936
- /**
2937
- * File original size in bytes.
2938
- */
2939
- sizeOriginal: number;
2940
- /**
2941
- * Total number of chunks available
2942
- */
2943
- chunksTotal: number;
2944
- /**
2945
- * Total number of chunks uploaded
2946
- */
2947
- chunksUploaded: number;
2948
- };
2949
- /**
2950
- * Team
2951
- */
2952
- type Team<Preferences extends Models.Preferences> = {
2953
- /**
2954
- * Team ID.
2955
- */
2956
- $id: string;
2957
- /**
2958
- * Team creation date in ISO 8601 format.
2959
- */
2960
- $createdAt: string;
2961
- /**
2962
- * Team update date in ISO 8601 format.
2963
- */
2964
- $updatedAt: string;
2965
- /**
2966
- * Team name.
2967
- */
2968
- name: string;
2969
- /**
2970
- * Total number of team members.
2971
- */
2972
- total: number;
2973
- /**
2974
- * Team preferences as a key-value object
2975
- */
2976
- prefs: Preferences;
2977
- };
2978
- /**
2979
- * Membership
2980
- */
2981
- type Membership = {
2982
- /**
2983
- * Membership ID.
2984
- */
2985
- $id: string;
2986
- /**
2987
- * Membership creation date in ISO 8601 format.
2988
- */
2989
- $createdAt: string;
2990
- /**
2991
- * Membership update date in ISO 8601 format.
2992
- */
2993
- $updatedAt: string;
2994
- /**
2995
- * User ID.
2996
- */
2997
- userId: string;
2998
- /**
2999
- * User name.
3000
- */
3001
- userName: string;
3002
- /**
3003
- * User email address.
3004
- */
3005
- userEmail: string;
3006
- /**
3007
- * Team ID.
3008
- */
3009
- teamId: string;
3010
- /**
3011
- * Team name.
3012
- */
3013
- teamName: string;
3014
- /**
3015
- * Date, the user has been invited to join the team in ISO 8601 format.
3016
- */
3017
- invited: string;
3018
- /**
3019
- * Date, the user has accepted the invitation to join the team in ISO 8601 format.
3020
- */
3021
- joined: string;
3022
- /**
3023
- * User confirmation status, true if the user has joined the team or false otherwise.
3024
- */
3025
- confirm: boolean;
3026
- /**
3027
- * Multi factor authentication status, true if the user has MFA enabled or false otherwise.
3028
- */
3029
- mfa: boolean;
3030
- /**
3031
- * User list of roles
3032
- */
3033
- roles: string[];
3034
- };
3035
- /**
3036
- * Execution
3037
- */
3038
- type Execution = {
3039
- /**
3040
- * Execution ID.
3041
- */
3042
- $id: string;
3043
- /**
3044
- * Execution creation date in ISO 8601 format.
3045
- */
3046
- $createdAt: string;
3047
- /**
3048
- * Execution upate date in ISO 8601 format.
3049
- */
3050
- $updatedAt: string;
3051
- /**
3052
- * Execution roles.
3053
- */
3054
- $permissions: string[];
3055
- /**
3056
- * Function ID.
3057
- */
3058
- functionId: string;
3059
- /**
3060
- * The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.
3061
- */
3062
- trigger: string;
3063
- /**
3064
- * The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`.
3065
- */
3066
- status: string;
3067
- /**
3068
- * HTTP request method type.
3069
- */
3070
- requestMethod: string;
3071
- /**
3072
- * HTTP request path and query.
3073
- */
3074
- requestPath: string;
3075
- /**
3076
- * HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.
3077
- */
3078
- requestHeaders: Headers[];
3079
- /**
3080
- * HTTP response status code.
3081
- */
3082
- responseStatusCode: number;
3083
- /**
3084
- * HTTP response body. This will return empty unless execution is created as synchronous.
3085
- */
3086
- responseBody: string;
3087
- /**
3088
- * HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.
3089
- */
3090
- responseHeaders: Headers[];
3091
- /**
3092
- * 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.
3093
- */
3094
- logs: string;
3095
- /**
3096
- * 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.
3097
- */
3098
- errors: string;
3099
- /**
3100
- * Function execution duration in seconds.
3101
- */
3102
- duration: number;
3103
- /**
3104
- * The scheduled time for execution. If left empty, execution will be queued immediately.
3105
- */
3106
- scheduledAt?: string;
3107
- };
3108
- /**
3109
- * Country
3110
- */
3111
- type Country = {
3112
- /**
3113
- * Country name.
3114
- */
3115
- name: string;
3116
- /**
3117
- * Country two-character ISO 3166-1 alpha code.
3118
- */
3119
- code: string;
3120
- };
3121
- /**
3122
- * Continent
3123
- */
3124
- type Continent = {
3125
- /**
3126
- * Continent name.
3127
- */
3128
- name: string;
3129
- /**
3130
- * Continent two letter code.
3131
- */
3132
- code: string;
3133
- };
3134
- /**
3135
- * Language
3136
- */
3137
- type Language = {
3138
- /**
3139
- * Language name.
3140
- */
3141
- name: string;
3142
- /**
3143
- * Language two-character ISO 639-1 codes.
3144
- */
3145
- code: string;
3146
- /**
3147
- * Language native name.
3148
- */
3149
- nativeName: string;
3150
- };
3151
- /**
3152
- * Currency
3153
- */
3154
- type Currency = {
3155
- /**
3156
- * Currency symbol.
3157
- */
3158
- symbol: string;
3159
- /**
3160
- * Currency name.
3161
- */
3162
- name: string;
3163
- /**
3164
- * Currency native symbol.
3165
- */
3166
- symbolNative: string;
3167
- /**
3168
- * Number of decimal digits.
3169
- */
3170
- decimalDigits: number;
3171
- /**
3172
- * Currency digit rounding.
3173
- */
3174
- rounding: number;
3175
- /**
3176
- * Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format.
3177
- */
3178
- code: string;
3179
- /**
3180
- * Currency plural name
3181
- */
3182
- namePlural: string;
3183
- };
3184
- /**
3185
- * Phone
3186
- */
3187
- type Phone = {
3188
- /**
3189
- * Phone code.
3190
- */
3191
- code: string;
3192
- /**
3193
- * Country two-character ISO 3166-1 alpha code.
3194
- */
3195
- countryCode: string;
3196
- /**
3197
- * Country name.
3198
- */
3199
- countryName: string;
3200
- };
3201
- /**
3202
- * Headers
3203
- */
3204
- type Headers = {
3205
- /**
3206
- * Header name.
3207
- */
3208
- name: string;
3209
- /**
3210
- * Header value.
3211
- */
3212
- value: string;
3213
- };
3214
- /**
3215
- * MFA Challenge
3216
- */
3217
- type MfaChallenge = {
3218
- /**
3219
- * Token ID.
3220
- */
3221
- $id: string;
3222
- /**
3223
- * Token creation date in ISO 8601 format.
3224
- */
3225
- $createdAt: string;
3226
- /**
3227
- * User ID.
3228
- */
3229
- userId: string;
3230
- /**
3231
- * Token expiration date in ISO 8601 format.
3232
- */
3233
- expire: string;
3234
- };
3235
- /**
3236
- * MFA Recovery Codes
3237
- */
3238
- type MfaRecoveryCodes = {
3239
- /**
3240
- * Recovery codes.
3241
- */
3242
- recoveryCodes: string[];
3243
- };
3244
- /**
3245
- * MFAType
3246
- */
3247
- type MfaType = {
3248
- /**
3249
- * Secret token used for TOTP factor.
3250
- */
3251
- secret: string;
3252
- /**
3253
- * URI for authenticator apps.
3254
- */
3255
- uri: string;
3256
- };
3257
- /**
3258
- * MFAFactors
3259
- */
3260
- type MfaFactors = {
3261
- /**
3262
- * Can TOTP be used for MFA challenge for this account.
3263
- */
3264
- totp: boolean;
3265
- /**
3266
- * Can phone (SMS) be used for MFA challenge for this account.
3267
- */
3268
- phone: boolean;
3269
- /**
3270
- * Can email be used for MFA challenge for this account.
3271
- */
3272
- email: boolean;
3273
- /**
3274
- * Can recovery code be used for MFA challenge for this account.
3275
- */
3276
- recoveryCode: boolean;
3277
- };
3278
- /**
3279
- * Subscriber
3280
- */
3281
- type Subscriber = {
3282
- /**
3283
- * Subscriber ID.
3284
- */
3285
- $id: string;
3286
- /**
3287
- * Subscriber creation time in ISO 8601 format.
3288
- */
3289
- $createdAt: string;
3290
- /**
3291
- * Subscriber update date in ISO 8601 format.
3292
- */
3293
- $updatedAt: string;
3294
- /**
3295
- * Target ID.
3296
- */
3297
- targetId: string;
3298
- /**
3299
- * Target.
3300
- */
3301
- target: Target;
3302
- /**
3303
- * Topic ID.
3304
- */
3305
- userId: string;
3306
- /**
3307
- * User Name.
3308
- */
3309
- userName: string;
3310
- /**
3311
- * Topic ID.
3312
- */
3313
- topicId: string;
3314
- /**
3315
- * The target provider type. Can be one of the following: `email`, `sms` or `push`.
3316
- */
3317
- providerType: string;
3318
- };
3319
- /**
3320
- * Target
3321
- */
3322
- type Target = {
3323
- /**
3324
- * Target ID.
3325
- */
3326
- $id: string;
3327
- /**
3328
- * Target creation time in ISO 8601 format.
3329
- */
3330
- $createdAt: string;
3331
- /**
3332
- * Target update date in ISO 8601 format.
3333
- */
3334
- $updatedAt: string;
3335
- /**
3336
- * Target Name.
3337
- */
3338
- name: string;
3339
- /**
3340
- * User ID.
3341
- */
3342
- userId: string;
3343
- /**
3344
- * Provider ID.
3345
- */
3346
- providerId?: string;
3347
- /**
3348
- * The target provider type. Can be one of the following: `email`, `sms` or `push`.
3349
- */
3350
- providerType: string;
3351
- /**
3352
- * The target identifier.
3353
- */
3354
- identifier: string;
3355
- };
3356
- }
3357
-
3358
- export class Service {
3359
- /**
3360
- * The size for chunked uploads in bytes.
3361
- */
3362
- static CHUNK_SIZE: number;
3363
- client: Client;
3364
- constructor(client: Client);
3365
- static flatten(data: Payload, prefix?: string): Payload;
3366
- }
3367
-