@emilgroup/tenant-sdk-node 1.0.0-beta.1 → 1.0.0

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 (356) hide show
  1. package/.openapi-generator/FILES +30 -56
  2. package/api/custom-schema-api.ts +77 -69
  3. package/api/data-report-api.ts +687 -0
  4. package/api/data-report-executor-api.ts +19 -17
  5. package/api/invite-organizations-api.ts +379 -0
  6. package/api/invite-users-api.ts +670 -0
  7. package/api/organizations-api.ts +343 -0
  8. package/api/users-api.ts +181 -721
  9. package/api.ts +9 -20
  10. package/base.ts +2 -1
  11. package/common.ts +2 -2
  12. package/configuration.ts +1 -1
  13. package/dist/api/custom-schema-api.d.ts +59 -59
  14. package/dist/api/custom-schema-api.js +51 -44
  15. package/dist/api/data-report-api.d.ts +380 -0
  16. package/dist/api/{dashboard-api.js → data-report-api.js} +162 -241
  17. package/dist/api/data-report-executor-api.d.ts +13 -13
  18. package/dist/api/data-report-executor-api.js +12 -10
  19. package/dist/api/invite-organizations-api.d.ts +216 -0
  20. package/dist/api/invite-organizations-api.js +370 -0
  21. package/dist/api/invite-users-api.d.ts +368 -0
  22. package/dist/api/{reports-api.js → invite-users-api.js} +178 -292
  23. package/dist/api/organizations-api.d.ts +197 -0
  24. package/dist/api/{tariff-comparisons-api.js → organizations-api.js} +104 -160
  25. package/dist/api/users-api.d.ts +136 -432
  26. package/dist/api/users-api.js +114 -567
  27. package/dist/api.d.ts +5 -12
  28. package/dist/api.js +5 -14
  29. package/dist/base.d.ts +3 -2
  30. package/dist/base.js +2 -1
  31. package/dist/common.d.ts +2 -2
  32. package/dist/common.js +1 -1
  33. package/dist/configuration.d.ts +1 -1
  34. package/dist/configuration.js +1 -1
  35. package/dist/index.d.ts +2 -2
  36. package/dist/index.js +3 -2
  37. package/dist/models/assign-user-roles-request-dto.d.ts +1 -1
  38. package/dist/models/assign-user-roles-request-dto.js +1 -1
  39. package/dist/models/assign-user-roles-response-class.d.ts +1 -1
  40. package/dist/models/assign-user-roles-response-class.js +1 -1
  41. package/dist/models/batch-delete-request-dto.d.ts +2 -2
  42. package/dist/models/batch-delete-request-dto.js +1 -1
  43. package/dist/models/{get-embedded-url-response-class.d.ts → batch-delete-response-class.d.ts} +7 -7
  44. package/dist/models/{alert-class.js → batch-delete-response-class.js} +1 -1
  45. package/dist/models/create-custom-schema-request-dto.d.ts +1 -1
  46. package/dist/models/create-custom-schema-request-dto.js +1 -1
  47. package/dist/models/create-custom-schema-response-class.d.ts +1 -1
  48. package/dist/models/create-custom-schema-response-class.js +1 -1
  49. package/dist/models/create-data-report-request-dto.d.ts +61 -0
  50. package/dist/models/{alert-history-class.js → create-data-report-request-dto.js} +1 -1
  51. package/dist/models/{channel-response-class.d.ts → create-data-report-response-class.d.ts} +8 -13
  52. package/dist/models/{compare-tariffs-response-class.js → create-data-report-response-class.js} +1 -1
  53. package/dist/models/create-permission-request-dto.d.ts +1 -7
  54. package/dist/models/create-permission-request-dto.js +1 -1
  55. package/dist/models/create-role-request-dto.d.ts +2 -2
  56. package/dist/models/create-role-request-dto.js +1 -1
  57. package/dist/models/create-tenant-request-dto.d.ts +1 -1
  58. package/dist/models/create-tenant-request-dto.js +1 -1
  59. package/dist/models/custom-field-dto.d.ts +1 -1
  60. package/dist/models/custom-field-dto.js +1 -1
  61. package/dist/models/custom-schema-class.d.ts +1 -1
  62. package/dist/models/custom-schema-class.js +1 -1
  63. package/dist/models/data-report-class.d.ts +79 -0
  64. package/dist/models/{channel-response-class.js → data-report-class.js} +1 -1
  65. package/dist/models/data-report-filter-class.d.ts +72 -0
  66. package/dist/models/data-report-filter-class.js +15 -0
  67. package/dist/models/data-report-filter-dto.d.ts +48 -0
  68. package/dist/models/data-report-filter-dto.js +15 -0
  69. package/dist/models/data-report-filter-single-value-dto.d.ts +5 -5
  70. package/dist/models/data-report-filter-single-value-dto.js +1 -1
  71. package/dist/models/data-report-filter-value-dto.d.ts +2 -2
  72. package/dist/models/data-report-filter-value-dto.js +1 -1
  73. package/dist/models/dbconfig-dto.d.ts +1 -1
  74. package/dist/models/dbconfig-dto.js +1 -1
  75. package/dist/models/{manage-subscription-request-dto.d.ts → delete-response-class.d.ts} +6 -6
  76. package/dist/models/delete-response-class.js +15 -0
  77. package/dist/models/disable-user-response-class.d.ts +1 -1
  78. package/dist/models/disable-user-response-class.js +1 -1
  79. package/dist/models/disable-users-request-dto.d.ts +1 -1
  80. package/dist/models/disable-users-request-dto.js +1 -1
  81. package/dist/models/{insurance-company-response-class.d.ts → disable-users-response-class.d.ts} +7 -7
  82. package/dist/models/disable-users-response-class.js +15 -0
  83. package/dist/models/enable-user-response-class.d.ts +1 -1
  84. package/dist/models/enable-user-response-class.js +1 -1
  85. package/dist/models/enable-users-request-dto.d.ts +1 -1
  86. package/dist/models/enable-users-request-dto.js +1 -1
  87. package/dist/models/{insurance-response-class.d.ts → enable-users-response-class.d.ts} +7 -7
  88. package/dist/models/enable-users-response-class.js +15 -0
  89. package/dist/models/get-custom-schema-response-class.d.ts +1 -1
  90. package/dist/models/get-custom-schema-response-class.js +1 -1
  91. package/dist/models/{create-alert-response-class.d.ts → get-data-report-response-class.d.ts} +8 -8
  92. package/dist/models/get-data-report-response-class.js +15 -0
  93. package/dist/models/{create-dashboard-response-class.d.ts → get-organization-response-class.d.ts} +8 -8
  94. package/dist/models/get-organization-response-class.js +15 -0
  95. package/dist/models/{get-alert-response-class.d.ts → get-settings-response-class.d.ts} +7 -8
  96. package/dist/models/get-settings-response-class.js +15 -0
  97. package/dist/models/get-user-response-class.d.ts +1 -1
  98. package/dist/models/get-user-response-class.js +1 -1
  99. package/dist/models/index.d.ts +26 -49
  100. package/dist/models/index.js +26 -49
  101. package/dist/models/invite-class.d.ts +10 -9
  102. package/dist/models/invite-class.js +1 -1
  103. package/dist/models/invite-org-request-dto.d.ts +90 -0
  104. package/dist/models/invite-org-request-dto.js +21 -0
  105. package/dist/models/invite-user-request-dto.d.ts +9 -3
  106. package/dist/models/invite-user-request-dto.js +1 -1
  107. package/dist/models/invite-user-response-class.d.ts +2 -2
  108. package/dist/models/invite-user-response-class.js +1 -1
  109. package/dist/models/invite-users-request-dto.d.ts +3 -3
  110. package/dist/models/invite-users-request-dto.js +1 -1
  111. package/dist/models/invite-users-response-class.d.ts +24 -0
  112. package/dist/models/invite-users-response-class.js +15 -0
  113. package/dist/models/list-custom-schemas-response-class.d.ts +1 -1
  114. package/dist/models/list-custom-schemas-response-class.js +1 -1
  115. package/dist/models/list-data-reports-response-class.d.ts +31 -0
  116. package/dist/models/list-data-reports-response-class.js +15 -0
  117. package/dist/models/list-invites-response-class.d.ts +3 -3
  118. package/dist/models/list-invites-response-class.js +1 -1
  119. package/dist/models/list-org-invitations-response-class.d.ts +31 -0
  120. package/dist/models/list-org-invitations-response-class.js +15 -0
  121. package/dist/models/list-organizations-response-class.d.ts +31 -0
  122. package/dist/models/list-organizations-response-class.js +15 -0
  123. package/dist/models/list-users-response-class.d.ts +1 -1
  124. package/dist/models/list-users-response-class.js +1 -1
  125. package/dist/models/org-invitation-class.d.ts +115 -0
  126. package/dist/models/{update-alert-request-dto.js → org-invitation-class.js} +6 -6
  127. package/dist/models/org-invitation-response-class.d.ts +25 -0
  128. package/dist/models/org-invitation-response-class.js +15 -0
  129. package/dist/models/organization-class.d.ts +90 -0
  130. package/dist/models/{condition-dto.js → organization-class.js} +6 -7
  131. package/dist/models/permission-class.d.ts +60 -0
  132. package/dist/models/permission-class.js +15 -0
  133. package/dist/models/role-class.d.ts +61 -0
  134. package/dist/models/role-class.js +15 -0
  135. package/dist/models/run-data-report-request-dto.d.ts +2 -2
  136. package/dist/models/run-data-report-request-dto.js +1 -1
  137. package/dist/models/run-data-report-response-class.d.ts +2 -2
  138. package/dist/models/run-data-report-response-class.js +1 -1
  139. package/dist/models/{set-user-setting-request-dto.d.ts → set-setting-request-dto.d.ts} +15 -9
  140. package/dist/models/set-setting-request-dto.js +15 -0
  141. package/dist/models/set-user-setting-response-class.d.ts +36 -0
  142. package/dist/models/set-user-setting-response-class.js +15 -0
  143. package/dist/models/subscription-class.d.ts +12 -5
  144. package/dist/models/subscription-class.js +1 -1
  145. package/dist/models/tenant-admin-user-dto.d.ts +1 -1
  146. package/dist/models/tenant-admin-user-dto.js +1 -1
  147. package/dist/models/update-custom-schema-request-dto.d.ts +1 -1
  148. package/dist/models/update-custom-schema-request-dto.js +1 -1
  149. package/dist/models/update-custom-schema-response-class.d.ts +1 -1
  150. package/dist/models/update-custom-schema-response-class.js +1 -1
  151. package/dist/models/update-data-report-request-dto.d.ts +61 -0
  152. package/dist/models/update-data-report-request-dto.js +15 -0
  153. package/dist/models/{create-report-response-class.d.ts → update-data-report-response-class.d.ts} +8 -8
  154. package/dist/models/update-data-report-response-class.js +15 -0
  155. package/dist/models/update-role-request-dto.d.ts +4 -4
  156. package/dist/models/update-role-request-dto.js +1 -1
  157. package/dist/models/user-class.d.ts +14 -6
  158. package/dist/models/user-class.js +1 -1
  159. package/index.ts +2 -2
  160. package/models/assign-user-roles-request-dto.ts +1 -1
  161. package/models/assign-user-roles-response-class.ts +1 -1
  162. package/models/batch-delete-request-dto.ts +2 -2
  163. package/models/{get-embedded-url-response-class.ts → batch-delete-response-class.ts} +7 -7
  164. package/models/create-custom-schema-request-dto.ts +1 -1
  165. package/models/create-custom-schema-response-class.ts +1 -1
  166. package/models/create-data-report-request-dto.ts +67 -0
  167. package/models/{create-dashboard-response-class.ts → create-data-report-response-class.ts} +8 -8
  168. package/models/create-permission-request-dto.ts +1 -7
  169. package/models/create-role-request-dto.ts +2 -2
  170. package/models/create-tenant-request-dto.ts +1 -1
  171. package/models/custom-field-dto.ts +1 -1
  172. package/models/custom-schema-class.ts +1 -1
  173. package/models/data-report-class.ts +85 -0
  174. package/models/data-report-filter-class.ts +78 -0
  175. package/models/data-report-filter-dto.ts +54 -0
  176. package/models/data-report-filter-single-value-dto.ts +5 -5
  177. package/models/data-report-filter-value-dto.ts +2 -2
  178. package/models/dbconfig-dto.ts +1 -1
  179. package/models/{manage-subscription-request-dto.ts → delete-response-class.ts} +6 -6
  180. package/models/disable-user-response-class.ts +1 -1
  181. package/models/disable-users-request-dto.ts +1 -1
  182. package/models/{insurance-company-response-class.ts → disable-users-response-class.ts} +7 -7
  183. package/models/enable-user-response-class.ts +1 -1
  184. package/models/enable-users-request-dto.ts +1 -1
  185. package/models/{insurance-response-class.ts → enable-users-response-class.ts} +7 -7
  186. package/models/get-custom-schema-response-class.ts +1 -1
  187. package/models/{channel-response-class.ts → get-data-report-response-class.ts} +8 -13
  188. package/models/{create-alert-response-class.ts → get-organization-response-class.ts} +8 -8
  189. package/models/{get-alert-response-class.ts → get-settings-response-class.ts} +7 -8
  190. package/models/get-user-response-class.ts +1 -1
  191. package/models/index.ts +26 -49
  192. package/models/invite-class.ts +10 -9
  193. package/models/invite-org-request-dto.ts +99 -0
  194. package/models/invite-user-request-dto.ts +9 -3
  195. package/models/invite-user-response-class.ts +2 -2
  196. package/models/invite-users-request-dto.ts +3 -3
  197. package/models/invite-users-response-class.ts +30 -0
  198. package/models/list-custom-schemas-response-class.ts +1 -1
  199. package/models/{list-dashboards-response-class.ts → list-data-reports-response-class.ts} +10 -10
  200. package/models/list-invites-response-class.ts +3 -3
  201. package/models/{list-alert-history-response-class.ts → list-org-invitations-response-class.ts} +10 -10
  202. package/models/{list-alerts-response-class.ts → list-organizations-response-class.ts} +10 -10
  203. package/models/list-users-response-class.ts +1 -1
  204. package/models/org-invitation-class.ts +124 -0
  205. package/models/org-invitation-response-class.ts +31 -0
  206. package/models/organization-class.ts +99 -0
  207. package/models/{report-class.ts → permission-class.ts} +20 -26
  208. package/models/role-class.ts +67 -0
  209. package/models/run-data-report-request-dto.ts +2 -2
  210. package/models/run-data-report-response-class.ts +3 -2
  211. package/models/{set-user-setting-request-dto.ts → set-setting-request-dto.ts} +15 -9
  212. package/models/set-user-setting-response-class.ts +42 -0
  213. package/models/subscription-class.ts +12 -5
  214. package/models/tenant-admin-user-dto.ts +1 -1
  215. package/models/update-custom-schema-request-dto.ts +1 -1
  216. package/models/update-custom-schema-response-class.ts +1 -1
  217. package/models/update-data-report-request-dto.ts +67 -0
  218. package/models/{create-report-response-class.ts → update-data-report-response-class.ts} +8 -8
  219. package/models/update-role-request-dto.ts +4 -4
  220. package/models/user-class.ts +14 -6
  221. package/package.json +2 -2
  222. package/api/alerts-api.ts +0 -860
  223. package/api/dashboard-api.ts +0 -792
  224. package/api/reports-api.ts +0 -860
  225. package/api/scenario-analysis-api.ts +0 -977
  226. package/api/settings-api.ts +0 -478
  227. package/api/tariff-comparisons-api.ts +0 -381
  228. package/api/user-subscription-api.ts +0 -191
  229. package/dist/api/alerts-api.d.ts +0 -479
  230. package/dist/api/alerts-api.js +0 -752
  231. package/dist/api/dashboard-api.d.ts +0 -434
  232. package/dist/api/reports-api.d.ts +0 -479
  233. package/dist/api/scenario-analysis-api.d.ts +0 -529
  234. package/dist/api/scenario-analysis-api.js +0 -895
  235. package/dist/api/settings-api.d.ts +0 -261
  236. package/dist/api/settings-api.js +0 -509
  237. package/dist/api/tariff-comparisons-api.d.ts +0 -206
  238. package/dist/api/user-subscription-api.d.ts +0 -111
  239. package/dist/api/user-subscription-api.js +0 -236
  240. package/dist/models/alert-class.d.ts +0 -90
  241. package/dist/models/alert-history-class.d.ts +0 -108
  242. package/dist/models/compare-tariffs-request-dto.d.ts +0 -37
  243. package/dist/models/compare-tariffs-request-dto.js +0 -22
  244. package/dist/models/compare-tariffs-response-class.d.ts +0 -31
  245. package/dist/models/condition-dto.d.ts +0 -43
  246. package/dist/models/create-alert-request-dto.d.ts +0 -79
  247. package/dist/models/create-alert-request-dto.js +0 -27
  248. package/dist/models/create-alert-response-class.js +0 -15
  249. package/dist/models/create-dashboard-request-dto.d.ts +0 -70
  250. package/dist/models/create-dashboard-request-dto.js +0 -29
  251. package/dist/models/create-dashboard-response-class.js +0 -15
  252. package/dist/models/create-report-request-dto.d.ts +0 -49
  253. package/dist/models/create-report-request-dto.js +0 -22
  254. package/dist/models/create-report-response-class.js +0 -15
  255. package/dist/models/create-scenario-analysis-request-dto.d.ts +0 -74
  256. package/dist/models/create-scenario-analysis-request-dto.js +0 -22
  257. package/dist/models/create-scenario-analysis-response-class.d.ts +0 -25
  258. package/dist/models/create-scenario-analysis-response-class.js +0 -15
  259. package/dist/models/dashboard-class.d.ts +0 -78
  260. package/dist/models/dashboard-class.js +0 -15
  261. package/dist/models/get-alert-response-class.js +0 -15
  262. package/dist/models/get-dashboard-response-class.d.ts +0 -25
  263. package/dist/models/get-dashboard-response-class.js +0 -15
  264. package/dist/models/get-embedded-url-response-class.js +0 -15
  265. package/dist/models/get-report-response-class.d.ts +0 -25
  266. package/dist/models/get-report-response-class.js +0 -15
  267. package/dist/models/get-scenario-analysis-response-class.d.ts +0 -25
  268. package/dist/models/get-scenario-analysis-response-class.js +0 -15
  269. package/dist/models/grouped-tariff-class.d.ts +0 -30
  270. package/dist/models/grouped-tariff-class.js +0 -15
  271. package/dist/models/insurance-company-response-class.js +0 -15
  272. package/dist/models/insurance-response-class.js +0 -15
  273. package/dist/models/list-alert-history-response-class.d.ts +0 -31
  274. package/dist/models/list-alert-history-response-class.js +0 -15
  275. package/dist/models/list-alerts-response-class.d.ts +0 -31
  276. package/dist/models/list-alerts-response-class.js +0 -15
  277. package/dist/models/list-channels-response-class.d.ts +0 -25
  278. package/dist/models/list-channels-response-class.js +0 -15
  279. package/dist/models/list-dashboards-response-class.d.ts +0 -31
  280. package/dist/models/list-dashboards-response-class.js +0 -15
  281. package/dist/models/list-insurance-companies-response-class.d.ts +0 -25
  282. package/dist/models/list-insurance-companies-response-class.js +0 -15
  283. package/dist/models/list-report-history-response-class.d.ts +0 -31
  284. package/dist/models/list-report-history-response-class.js +0 -15
  285. package/dist/models/list-reports-response-class.d.ts +0 -31
  286. package/dist/models/list-reports-response-class.js +0 -15
  287. package/dist/models/list-scenario-analyses-response-class.d.ts +0 -31
  288. package/dist/models/list-scenario-analyses-response-class.js +0 -15
  289. package/dist/models/list-scenario-analysis-dates-response-class.d.ts +0 -25
  290. package/dist/models/list-scenario-analysis-dates-response-class.js +0 -15
  291. package/dist/models/list-tariff-insurance-companies-response-class.d.ts +0 -25
  292. package/dist/models/list-tariff-insurance-companies-response-class.js +0 -15
  293. package/dist/models/list-tariffs-response-class.d.ts +0 -25
  294. package/dist/models/list-tariffs-response-class.js +0 -15
  295. package/dist/models/manage-subscription-request-dto.js +0 -15
  296. package/dist/models/manage-subscription-response-class.d.ts +0 -25
  297. package/dist/models/manage-subscription-response-class.js +0 -15
  298. package/dist/models/report-class.d.ts +0 -66
  299. package/dist/models/report-class.js +0 -15
  300. package/dist/models/report-history-class.d.ts +0 -48
  301. package/dist/models/report-history-class.js +0 -15
  302. package/dist/models/scenario-analysis-class.d.ts +0 -108
  303. package/dist/models/scenario-analysis-class.js +0 -15
  304. package/dist/models/scenario-analysis-date-response-class.d.ts +0 -36
  305. package/dist/models/scenario-analysis-date-response-class.js +0 -15
  306. package/dist/models/set-user-setting-request-dto.js +0 -15
  307. package/dist/models/update-alert-request-dto.d.ts +0 -72
  308. package/dist/models/update-alert-response-class.d.ts +0 -25
  309. package/dist/models/update-alert-response-class.js +0 -15
  310. package/dist/models/update-dashboard-request-dto.d.ts +0 -76
  311. package/dist/models/update-dashboard-request-dto.js +0 -29
  312. package/dist/models/update-dashboard-response-class.d.ts +0 -25
  313. package/dist/models/update-dashboard-response-class.js +0 -15
  314. package/dist/models/update-report-request-dto.d.ts +0 -55
  315. package/dist/models/update-report-request-dto.js +0 -22
  316. package/dist/models/update-report-response-class.d.ts +0 -25
  317. package/dist/models/update-report-response-class.js +0 -15
  318. package/dist/models/update-scenario-analysis-request-dto.d.ts +0 -74
  319. package/dist/models/update-scenario-analysis-request-dto.js +0 -22
  320. package/dist/models/update-scenario-analysis-response-class.d.ts +0 -25
  321. package/dist/models/update-scenario-analysis-response-class.js +0 -15
  322. package/models/alert-class.ts +0 -96
  323. package/models/alert-history-class.ts +0 -114
  324. package/models/compare-tariffs-request-dto.ts +0 -46
  325. package/models/compare-tariffs-response-class.ts +0 -37
  326. package/models/condition-dto.ts +0 -52
  327. package/models/create-alert-request-dto.ts +0 -89
  328. package/models/create-dashboard-request-dto.ts +0 -81
  329. package/models/create-report-request-dto.ts +0 -58
  330. package/models/create-scenario-analysis-request-dto.ts +0 -83
  331. package/models/create-scenario-analysis-response-class.ts +0 -31
  332. package/models/dashboard-class.ts +0 -84
  333. package/models/get-dashboard-response-class.ts +0 -31
  334. package/models/get-report-response-class.ts +0 -31
  335. package/models/get-scenario-analysis-response-class.ts +0 -31
  336. package/models/grouped-tariff-class.ts +0 -36
  337. package/models/list-channels-response-class.ts +0 -31
  338. package/models/list-insurance-companies-response-class.ts +0 -31
  339. package/models/list-report-history-response-class.ts +0 -37
  340. package/models/list-reports-response-class.ts +0 -37
  341. package/models/list-scenario-analyses-response-class.ts +0 -37
  342. package/models/list-scenario-analysis-dates-response-class.ts +0 -31
  343. package/models/list-tariff-insurance-companies-response-class.ts +0 -31
  344. package/models/list-tariffs-response-class.ts +0 -31
  345. package/models/manage-subscription-response-class.ts +0 -31
  346. package/models/report-history-class.ts +0 -54
  347. package/models/scenario-analysis-class.ts +0 -114
  348. package/models/scenario-analysis-date-response-class.ts +0 -42
  349. package/models/update-alert-request-dto.ts +0 -81
  350. package/models/update-alert-response-class.ts +0 -31
  351. package/models/update-dashboard-request-dto.ts +0 -87
  352. package/models/update-dashboard-response-class.ts +0 -31
  353. package/models/update-report-request-dto.ts +0 -64
  354. package/models/update-report-response-class.ts +0 -31
  355. package/models/update-scenario-analysis-request-dto.ts +0 -83
  356. package/models/update-scenario-analysis-response-class.ts +0 -31
@@ -0,0 +1,670 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL Tenant Service
5
+ * The EMIL TenantService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
17
+ import { Configuration } from '../configuration';
18
+ // Some imports not used depending on template conditions
19
+ // @ts-ignore
20
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
21
+ // @ts-ignore
22
+ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
+ // @ts-ignore
24
+ import { BatchDeleteRequestDto } from '../models';
25
+ // @ts-ignore
26
+ import { BatchDeleteResponseClass } from '../models';
27
+ // @ts-ignore
28
+ import { DeleteResponseClass } from '../models';
29
+ // @ts-ignore
30
+ import { InviteUserRequestDto } from '../models';
31
+ // @ts-ignore
32
+ import { InviteUserResponseClass } from '../models';
33
+ // @ts-ignore
34
+ import { InviteUsersRequestDto } from '../models';
35
+ // @ts-ignore
36
+ import { InviteUsersResponseClass } from '../models';
37
+ // @ts-ignore
38
+ import { ListInvitesResponseClass } from '../models';
39
+ // URLSearchParams not necessarily used
40
+ // @ts-ignore
41
+ import { URL, URLSearchParams } from 'url';
42
+ const FormData = require('form-data');
43
+ /**
44
+ * InviteUsersApi - axios parameter creator
45
+ * @export
46
+ */
47
+ export const InviteUsersApiAxiosParamCreator = function (configuration?: Configuration) {
48
+ return {
49
+ /**
50
+ * Permanently deletes the invited user. Supply the unique id that was returned when you created the invited user and this will delete it.
51
+ * @summary Delete the invited user
52
+ * @param {string} authorization Bearer Token
53
+ * @param {number} id
54
+ * @param {*} [options] Override http request option.
55
+ * @throws {RequiredError}
56
+ */
57
+ deleteInvite: async (authorization: string, id: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
58
+ // verify required parameter 'authorization' is not null or undefined
59
+ assertParamExists('deleteInvite', 'authorization', authorization)
60
+ // verify required parameter 'id' is not null or undefined
61
+ assertParamExists('deleteInvite', 'id', id)
62
+ const localVarPath = `/tenantservice/v1/users/invites/{id}`
63
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
64
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
65
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
66
+ let baseOptions;
67
+ let baseAccessToken;
68
+ if (configuration) {
69
+ baseOptions = configuration.baseOptions;
70
+ baseAccessToken = configuration.accessToken;
71
+ }
72
+
73
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
74
+ const localVarHeaderParameter = {} as any;
75
+ const localVarQueryParameter = {} as any;
76
+
77
+ // authentication bearer required
78
+ // http bearer authentication required
79
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
80
+
81
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
82
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
83
+ }
84
+
85
+
86
+
87
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
88
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
89
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
90
+
91
+ return {
92
+ url: toPathString(localVarUrlObj),
93
+ options: localVarRequestOptions,
94
+ };
95
+ },
96
+ /**
97
+ * This will deletes the users who has been invited. Supply array of ids that were returned when users has been created and this will delete it.
98
+ * @summary Delete invited users.
99
+ * @param {string} authorization Bearer Token
100
+ * @param {BatchDeleteRequestDto} batchDeleteRequestDto
101
+ * @param {*} [options] Override http request option.
102
+ * @throws {RequiredError}
103
+ */
104
+ deleteInvites: async (authorization: string, batchDeleteRequestDto: BatchDeleteRequestDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
105
+ // verify required parameter 'authorization' is not null or undefined
106
+ assertParamExists('deleteInvites', 'authorization', authorization)
107
+ // verify required parameter 'batchDeleteRequestDto' is not null or undefined
108
+ assertParamExists('deleteInvites', 'batchDeleteRequestDto', batchDeleteRequestDto)
109
+ const localVarPath = `/tenantservice/v1/users/invites/delete-batch`;
110
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
111
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
112
+ let baseOptions;
113
+ let baseAccessToken;
114
+ if (configuration) {
115
+ baseOptions = configuration.baseOptions;
116
+ baseAccessToken = configuration.accessToken;
117
+ }
118
+
119
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
120
+ const localVarHeaderParameter = {} as any;
121
+ const localVarQueryParameter = {} as any;
122
+
123
+ // authentication bearer required
124
+ // http bearer authentication required
125
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
126
+
127
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
128
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
129
+ }
130
+
131
+
132
+
133
+ localVarHeaderParameter['Content-Type'] = 'application/json';
134
+
135
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
136
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
137
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
138
+ localVarRequestOptions.data = serializeDataIfNeeded(batchDeleteRequestDto, localVarRequestOptions, configuration)
139
+
140
+ return {
141
+ url: toPathString(localVarUrlObj),
142
+ options: localVarRequestOptions,
143
+ };
144
+ },
145
+ /**
146
+ * This send an email to invite a user with the specific role/roles.
147
+ * @summary Invite a user
148
+ * @param {string} authorization Bearer Token
149
+ * @param {InviteUserRequestDto} inviteUserRequestDto
150
+ * @param {*} [options] Override http request option.
151
+ * @throws {RequiredError}
152
+ */
153
+ inviteUser: async (authorization: string, inviteUserRequestDto: InviteUserRequestDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
154
+ // verify required parameter 'authorization' is not null or undefined
155
+ assertParamExists('inviteUser', 'authorization', authorization)
156
+ // verify required parameter 'inviteUserRequestDto' is not null or undefined
157
+ assertParamExists('inviteUser', 'inviteUserRequestDto', inviteUserRequestDto)
158
+ const localVarPath = `/tenantservice/v1/users/invites`;
159
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
160
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
161
+ let baseOptions;
162
+ let baseAccessToken;
163
+ if (configuration) {
164
+ baseOptions = configuration.baseOptions;
165
+ baseAccessToken = configuration.accessToken;
166
+ }
167
+
168
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
169
+ const localVarHeaderParameter = {} as any;
170
+ const localVarQueryParameter = {} as any;
171
+
172
+ // authentication bearer required
173
+ // http bearer authentication required
174
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
175
+
176
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
177
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
178
+ }
179
+
180
+
181
+
182
+ localVarHeaderParameter['Content-Type'] = 'application/json';
183
+
184
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
185
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
186
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
187
+ localVarRequestOptions.data = serializeDataIfNeeded(inviteUserRequestDto, localVarRequestOptions, configuration)
188
+
189
+ return {
190
+ url: toPathString(localVarUrlObj),
191
+ options: localVarRequestOptions,
192
+ };
193
+ },
194
+ /**
195
+ * This send bulk emails to invite users with the specific role/roles.
196
+ * @summary Invite batch of users
197
+ * @param {string} authorization Bearer Token
198
+ * @param {InviteUsersRequestDto} inviteUsersRequestDto
199
+ * @param {*} [options] Override http request option.
200
+ * @throws {RequiredError}
201
+ */
202
+ inviteUsers: async (authorization: string, inviteUsersRequestDto: InviteUsersRequestDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
203
+ // verify required parameter 'authorization' is not null or undefined
204
+ assertParamExists('inviteUsers', 'authorization', authorization)
205
+ // verify required parameter 'inviteUsersRequestDto' is not null or undefined
206
+ assertParamExists('inviteUsers', 'inviteUsersRequestDto', inviteUsersRequestDto)
207
+ const localVarPath = `/tenantservice/v1/users/invites/batch`;
208
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
209
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
210
+ let baseOptions;
211
+ let baseAccessToken;
212
+ if (configuration) {
213
+ baseOptions = configuration.baseOptions;
214
+ baseAccessToken = configuration.accessToken;
215
+ }
216
+
217
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
218
+ const localVarHeaderParameter = {} as any;
219
+ const localVarQueryParameter = {} as any;
220
+
221
+ // authentication bearer required
222
+ // http bearer authentication required
223
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
224
+
225
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
226
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
227
+ }
228
+
229
+
230
+
231
+ localVarHeaderParameter['Content-Type'] = 'application/json';
232
+
233
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
234
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
235
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
236
+ localVarRequestOptions.data = serializeDataIfNeeded(inviteUsersRequestDto, localVarRequestOptions, configuration)
237
+
238
+ return {
239
+ url: toPathString(localVarUrlObj),
240
+ options: localVarRequestOptions,
241
+ };
242
+ },
243
+ /**
244
+ * Returns a list of invited users you have previously created. The invited users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
245
+ * @summary List invited users
246
+ * @param {string} authorization Bearer Token
247
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
248
+ * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
249
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
250
+ * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
251
+ * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
252
+ * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
253
+ * @param {*} [options] Override http request option.
254
+ * @throws {RequiredError}
255
+ */
256
+ listInvites: async (authorization: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
257
+ // verify required parameter 'authorization' is not null or undefined
258
+ assertParamExists('listInvites', 'authorization', authorization)
259
+ const localVarPath = `/tenantservice/v1/users/invites`;
260
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
261
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
262
+ let baseOptions;
263
+ let baseAccessToken;
264
+ if (configuration) {
265
+ baseOptions = configuration.baseOptions;
266
+ baseAccessToken = configuration.accessToken;
267
+ }
268
+
269
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
270
+ const localVarHeaderParameter = {} as any;
271
+ const localVarQueryParameter = {} as any;
272
+
273
+ // authentication bearer required
274
+ // http bearer authentication required
275
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
276
+
277
+ if (pageSize !== undefined) {
278
+ localVarQueryParameter['pageSize'] = pageSize;
279
+ }
280
+
281
+ if (pageToken !== undefined) {
282
+ localVarQueryParameter['pageToken'] = pageToken;
283
+ }
284
+
285
+ if (filter !== undefined) {
286
+ localVarQueryParameter['filter'] = filter;
287
+ }
288
+
289
+ if (search !== undefined) {
290
+ localVarQueryParameter['search'] = search;
291
+ }
292
+
293
+ if (order !== undefined) {
294
+ localVarQueryParameter['order'] = order;
295
+ }
296
+
297
+ if (expand !== undefined) {
298
+ localVarQueryParameter['expand'] = expand;
299
+ }
300
+
301
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
302
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
303
+ }
304
+
305
+
306
+
307
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
308
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
309
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
310
+
311
+ return {
312
+ url: toPathString(localVarUrlObj),
313
+ options: localVarRequestOptions,
314
+ };
315
+ },
316
+ }
317
+ };
318
+
319
+ /**
320
+ * InviteUsersApi - functional programming interface
321
+ * @export
322
+ */
323
+ export const InviteUsersApiFp = function(configuration?: Configuration) {
324
+ const localVarAxiosParamCreator = InviteUsersApiAxiosParamCreator(configuration)
325
+ return {
326
+ /**
327
+ * Permanently deletes the invited user. Supply the unique id that was returned when you created the invited user and this will delete it.
328
+ * @summary Delete the invited user
329
+ * @param {string} authorization Bearer Token
330
+ * @param {number} id
331
+ * @param {*} [options] Override http request option.
332
+ * @throws {RequiredError}
333
+ */
334
+ async deleteInvite(authorization: string, id: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>> {
335
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteInvite(authorization, id, options);
336
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
337
+ },
338
+ /**
339
+ * This will deletes the users who has been invited. Supply array of ids that were returned when users has been created and this will delete it.
340
+ * @summary Delete invited users.
341
+ * @param {string} authorization Bearer Token
342
+ * @param {BatchDeleteRequestDto} batchDeleteRequestDto
343
+ * @param {*} [options] Override http request option.
344
+ * @throws {RequiredError}
345
+ */
346
+ async deleteInvites(authorization: string, batchDeleteRequestDto: BatchDeleteRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BatchDeleteResponseClass>> {
347
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteInvites(authorization, batchDeleteRequestDto, options);
348
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
349
+ },
350
+ /**
351
+ * This send an email to invite a user with the specific role/roles.
352
+ * @summary Invite a user
353
+ * @param {string} authorization Bearer Token
354
+ * @param {InviteUserRequestDto} inviteUserRequestDto
355
+ * @param {*} [options] Override http request option.
356
+ * @throws {RequiredError}
357
+ */
358
+ async inviteUser(authorization: string, inviteUserRequestDto: InviteUserRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InviteUserResponseClass>> {
359
+ const localVarAxiosArgs = await localVarAxiosParamCreator.inviteUser(authorization, inviteUserRequestDto, options);
360
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
361
+ },
362
+ /**
363
+ * This send bulk emails to invite users with the specific role/roles.
364
+ * @summary Invite batch of users
365
+ * @param {string} authorization Bearer Token
366
+ * @param {InviteUsersRequestDto} inviteUsersRequestDto
367
+ * @param {*} [options] Override http request option.
368
+ * @throws {RequiredError}
369
+ */
370
+ async inviteUsers(authorization: string, inviteUsersRequestDto: InviteUsersRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InviteUsersResponseClass>> {
371
+ const localVarAxiosArgs = await localVarAxiosParamCreator.inviteUsers(authorization, inviteUsersRequestDto, options);
372
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
373
+ },
374
+ /**
375
+ * Returns a list of invited users you have previously created. The invited users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
376
+ * @summary List invited users
377
+ * @param {string} authorization Bearer Token
378
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
379
+ * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
380
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
381
+ * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
382
+ * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
383
+ * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
384
+ * @param {*} [options] Override http request option.
385
+ * @throws {RequiredError}
386
+ */
387
+ async listInvites(authorization: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInvitesResponseClass>> {
388
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listInvites(authorization, pageSize, pageToken, filter, search, order, expand, options);
389
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
390
+ },
391
+ }
392
+ };
393
+
394
+ /**
395
+ * InviteUsersApi - factory interface
396
+ * @export
397
+ */
398
+ export const InviteUsersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
399
+ const localVarFp = InviteUsersApiFp(configuration)
400
+ return {
401
+ /**
402
+ * Permanently deletes the invited user. Supply the unique id that was returned when you created the invited user and this will delete it.
403
+ * @summary Delete the invited user
404
+ * @param {string} authorization Bearer Token
405
+ * @param {number} id
406
+ * @param {*} [options] Override http request option.
407
+ * @throws {RequiredError}
408
+ */
409
+ deleteInvite(authorization: string, id: number, options?: any): AxiosPromise<DeleteResponseClass> {
410
+ return localVarFp.deleteInvite(authorization, id, options).then((request) => request(axios, basePath));
411
+ },
412
+ /**
413
+ * This will deletes the users who has been invited. Supply array of ids that were returned when users has been created and this will delete it.
414
+ * @summary Delete invited users.
415
+ * @param {string} authorization Bearer Token
416
+ * @param {BatchDeleteRequestDto} batchDeleteRequestDto
417
+ * @param {*} [options] Override http request option.
418
+ * @throws {RequiredError}
419
+ */
420
+ deleteInvites(authorization: string, batchDeleteRequestDto: BatchDeleteRequestDto, options?: any): AxiosPromise<BatchDeleteResponseClass> {
421
+ return localVarFp.deleteInvites(authorization, batchDeleteRequestDto, options).then((request) => request(axios, basePath));
422
+ },
423
+ /**
424
+ * This send an email to invite a user with the specific role/roles.
425
+ * @summary Invite a user
426
+ * @param {string} authorization Bearer Token
427
+ * @param {InviteUserRequestDto} inviteUserRequestDto
428
+ * @param {*} [options] Override http request option.
429
+ * @throws {RequiredError}
430
+ */
431
+ inviteUser(authorization: string, inviteUserRequestDto: InviteUserRequestDto, options?: any): AxiosPromise<InviteUserResponseClass> {
432
+ return localVarFp.inviteUser(authorization, inviteUserRequestDto, options).then((request) => request(axios, basePath));
433
+ },
434
+ /**
435
+ * This send bulk emails to invite users with the specific role/roles.
436
+ * @summary Invite batch of users
437
+ * @param {string} authorization Bearer Token
438
+ * @param {InviteUsersRequestDto} inviteUsersRequestDto
439
+ * @param {*} [options] Override http request option.
440
+ * @throws {RequiredError}
441
+ */
442
+ inviteUsers(authorization: string, inviteUsersRequestDto: InviteUsersRequestDto, options?: any): AxiosPromise<InviteUsersResponseClass> {
443
+ return localVarFp.inviteUsers(authorization, inviteUsersRequestDto, options).then((request) => request(axios, basePath));
444
+ },
445
+ /**
446
+ * Returns a list of invited users you have previously created. The invited users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
447
+ * @summary List invited users
448
+ * @param {string} authorization Bearer Token
449
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
450
+ * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
451
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
452
+ * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
453
+ * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
454
+ * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
455
+ * @param {*} [options] Override http request option.
456
+ * @throws {RequiredError}
457
+ */
458
+ listInvites(authorization: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListInvitesResponseClass> {
459
+ return localVarFp.listInvites(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
460
+ },
461
+ };
462
+ };
463
+
464
+ /**
465
+ * Request parameters for deleteInvite operation in InviteUsersApi.
466
+ * @export
467
+ * @interface InviteUsersApiDeleteInviteRequest
468
+ */
469
+ export interface InviteUsersApiDeleteInviteRequest {
470
+ /**
471
+ * Bearer Token
472
+ * @type {string}
473
+ * @memberof InviteUsersApiDeleteInvite
474
+ */
475
+ readonly authorization: string
476
+
477
+ /**
478
+ *
479
+ * @type {number}
480
+ * @memberof InviteUsersApiDeleteInvite
481
+ */
482
+ readonly id: number
483
+ }
484
+
485
+ /**
486
+ * Request parameters for deleteInvites operation in InviteUsersApi.
487
+ * @export
488
+ * @interface InviteUsersApiDeleteInvitesRequest
489
+ */
490
+ export interface InviteUsersApiDeleteInvitesRequest {
491
+ /**
492
+ * Bearer Token
493
+ * @type {string}
494
+ * @memberof InviteUsersApiDeleteInvites
495
+ */
496
+ readonly authorization: string
497
+
498
+ /**
499
+ *
500
+ * @type {BatchDeleteRequestDto}
501
+ * @memberof InviteUsersApiDeleteInvites
502
+ */
503
+ readonly batchDeleteRequestDto: BatchDeleteRequestDto
504
+ }
505
+
506
+ /**
507
+ * Request parameters for inviteUser operation in InviteUsersApi.
508
+ * @export
509
+ * @interface InviteUsersApiInviteUserRequest
510
+ */
511
+ export interface InviteUsersApiInviteUserRequest {
512
+ /**
513
+ * Bearer Token
514
+ * @type {string}
515
+ * @memberof InviteUsersApiInviteUser
516
+ */
517
+ readonly authorization: string
518
+
519
+ /**
520
+ *
521
+ * @type {InviteUserRequestDto}
522
+ * @memberof InviteUsersApiInviteUser
523
+ */
524
+ readonly inviteUserRequestDto: InviteUserRequestDto
525
+ }
526
+
527
+ /**
528
+ * Request parameters for inviteUsers operation in InviteUsersApi.
529
+ * @export
530
+ * @interface InviteUsersApiInviteUsersRequest
531
+ */
532
+ export interface InviteUsersApiInviteUsersRequest {
533
+ /**
534
+ * Bearer Token
535
+ * @type {string}
536
+ * @memberof InviteUsersApiInviteUsers
537
+ */
538
+ readonly authorization: string
539
+
540
+ /**
541
+ *
542
+ * @type {InviteUsersRequestDto}
543
+ * @memberof InviteUsersApiInviteUsers
544
+ */
545
+ readonly inviteUsersRequestDto: InviteUsersRequestDto
546
+ }
547
+
548
+ /**
549
+ * Request parameters for listInvites operation in InviteUsersApi.
550
+ * @export
551
+ * @interface InviteUsersApiListInvitesRequest
552
+ */
553
+ export interface InviteUsersApiListInvitesRequest {
554
+ /**
555
+ * Bearer Token
556
+ * @type {string}
557
+ * @memberof InviteUsersApiListInvites
558
+ */
559
+ readonly authorization: string
560
+
561
+ /**
562
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
563
+ * @type {any}
564
+ * @memberof InviteUsersApiListInvites
565
+ */
566
+ readonly pageSize?: any
567
+
568
+ /**
569
+ * A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
570
+ * @type {any}
571
+ * @memberof InviteUsersApiListInvites
572
+ */
573
+ readonly pageToken?: any
574
+
575
+ /**
576
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
577
+ * @type {any}
578
+ * @memberof InviteUsersApiListInvites
579
+ */
580
+ readonly filter?: any
581
+
582
+ /**
583
+ * Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
584
+ * @type {any}
585
+ * @memberof InviteUsersApiListInvites
586
+ */
587
+ readonly search?: any
588
+
589
+ /**
590
+ * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
591
+ * @type {any}
592
+ * @memberof InviteUsersApiListInvites
593
+ */
594
+ readonly order?: any
595
+
596
+ /**
597
+ * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
598
+ * @type {any}
599
+ * @memberof InviteUsersApiListInvites
600
+ */
601
+ readonly expand?: any
602
+ }
603
+
604
+ /**
605
+ * InviteUsersApi - object-oriented interface
606
+ * @export
607
+ * @class InviteUsersApi
608
+ * @extends {BaseAPI}
609
+ */
610
+ export class InviteUsersApi extends BaseAPI {
611
+ /**
612
+ * Permanently deletes the invited user. Supply the unique id that was returned when you created the invited user and this will delete it.
613
+ * @summary Delete the invited user
614
+ * @param {InviteUsersApiDeleteInviteRequest} requestParameters Request parameters.
615
+ * @param {*} [options] Override http request option.
616
+ * @throws {RequiredError}
617
+ * @memberof InviteUsersApi
618
+ */
619
+ public deleteInvite(requestParameters: InviteUsersApiDeleteInviteRequest, options?: AxiosRequestConfig) {
620
+ return InviteUsersApiFp(this.configuration).deleteInvite(requestParameters.authorization, requestParameters.id, options).then((request) => request(this.axios, this.basePath));
621
+ }
622
+
623
+ /**
624
+ * This will deletes the users who has been invited. Supply array of ids that were returned when users has been created and this will delete it.
625
+ * @summary Delete invited users.
626
+ * @param {InviteUsersApiDeleteInvitesRequest} requestParameters Request parameters.
627
+ * @param {*} [options] Override http request option.
628
+ * @throws {RequiredError}
629
+ * @memberof InviteUsersApi
630
+ */
631
+ public deleteInvites(requestParameters: InviteUsersApiDeleteInvitesRequest, options?: AxiosRequestConfig) {
632
+ return InviteUsersApiFp(this.configuration).deleteInvites(requestParameters.authorization, requestParameters.batchDeleteRequestDto, options).then((request) => request(this.axios, this.basePath));
633
+ }
634
+
635
+ /**
636
+ * This send an email to invite a user with the specific role/roles.
637
+ * @summary Invite a user
638
+ * @param {InviteUsersApiInviteUserRequest} requestParameters Request parameters.
639
+ * @param {*} [options] Override http request option.
640
+ * @throws {RequiredError}
641
+ * @memberof InviteUsersApi
642
+ */
643
+ public inviteUser(requestParameters: InviteUsersApiInviteUserRequest, options?: AxiosRequestConfig) {
644
+ return InviteUsersApiFp(this.configuration).inviteUser(requestParameters.authorization, requestParameters.inviteUserRequestDto, options).then((request) => request(this.axios, this.basePath));
645
+ }
646
+
647
+ /**
648
+ * This send bulk emails to invite users with the specific role/roles.
649
+ * @summary Invite batch of users
650
+ * @param {InviteUsersApiInviteUsersRequest} requestParameters Request parameters.
651
+ * @param {*} [options] Override http request option.
652
+ * @throws {RequiredError}
653
+ * @memberof InviteUsersApi
654
+ */
655
+ public inviteUsers(requestParameters: InviteUsersApiInviteUsersRequest, options?: AxiosRequestConfig) {
656
+ return InviteUsersApiFp(this.configuration).inviteUsers(requestParameters.authorization, requestParameters.inviteUsersRequestDto, options).then((request) => request(this.axios, this.basePath));
657
+ }
658
+
659
+ /**
660
+ * Returns a list of invited users you have previously created. The invited users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
661
+ * @summary List invited users
662
+ * @param {InviteUsersApiListInvitesRequest} requestParameters Request parameters.
663
+ * @param {*} [options] Override http request option.
664
+ * @throws {RequiredError}
665
+ * @memberof InviteUsersApi
666
+ */
667
+ public listInvites(requestParameters: InviteUsersApiListInvitesRequest, options?: AxiosRequestConfig) {
668
+ return InviteUsersApiFp(this.configuration).listInvites(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
669
+ }
670
+ }