rotacloud 1.5.2 → 2.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 (488) hide show
  1. package/README.md +23 -13
  2. package/dist/client-builder.d.ts +34 -0
  3. package/dist/client-builder.js +70 -0
  4. package/dist/client-builder.test.js +163 -0
  5. package/dist/endpoint.d.ts +51 -0
  6. package/dist/interfaces/launch-terminal.interface.d.ts +6 -0
  7. package/dist/{mjs/interfaces → interfaces}/leave-request.interface.d.ts +1 -1
  8. package/dist/{cjs/interfaces → interfaces}/leave.interface.d.ts +1 -1
  9. package/dist/{mjs/interfaces → interfaces}/query-params/toil-allowance-query-params.interface.d.ts +1 -0
  10. package/dist/{cjs/interfaces → interfaces}/sdk-config.interface.d.ts +8 -11
  11. package/dist/{mjs/interfaces → interfaces}/shift.interface.d.ts +11 -0
  12. package/dist/interfaces/user-clock-in.interface.d.ts +18 -0
  13. package/dist/interfaces/user-clock-in.interface.js +1 -0
  14. package/dist/{cjs/interfaces → interfaces}/user.interface.d.ts +1 -1
  15. package/dist/interfaces/user.interface.js +1 -0
  16. package/dist/interfaces/users-clocked-in.interface.js +1 -0
  17. package/dist/interfaces/users-clocked-out.interface.js +1 -0
  18. package/dist/main.d.ts +203 -0
  19. package/dist/main.js +6 -0
  20. package/dist/models/SDKError.model.d.ts +15 -0
  21. package/dist/{mjs/models → models}/SDKError.model.js +10 -3
  22. package/dist/ops.d.ts +195 -0
  23. package/dist/ops.js +304 -0
  24. package/dist/ops.test.d.ts +1 -0
  25. package/dist/ops.test.js +101 -0
  26. package/dist/service.d.ts +233 -0
  27. package/dist/service.js +317 -0
  28. package/dist/utils.d.ts +41 -0
  29. package/dist/utils.js +149 -0
  30. package/package.json +19 -20
  31. package/src/client-builder.test.ts +188 -0
  32. package/src/client-builder.ts +118 -0
  33. package/src/endpoint.ts +99 -0
  34. package/src/interfaces/launch-terminal.interface.ts +7 -0
  35. package/src/interfaces/leave-request.interface.ts +1 -1
  36. package/src/interfaces/leave.interface.ts +1 -1
  37. package/src/interfaces/query-params/toil-allowance-query-params.interface.ts +1 -0
  38. package/src/interfaces/sdk-config.interface.ts +11 -14
  39. package/src/interfaces/shift.interface.ts +12 -0
  40. package/src/interfaces/time-zone.interface.ts +6 -6
  41. package/src/interfaces/user-clock-in.interface.ts +20 -0
  42. package/src/interfaces/user.interface.ts +1 -1
  43. package/src/main.ts +7 -0
  44. package/src/models/SDKError.model.ts +8 -8
  45. package/src/ops.test.ts +121 -0
  46. package/src/ops.ts +533 -0
  47. package/src/service.ts +395 -0
  48. package/src/utils.ts +193 -0
  49. package/.eslintignore +0 -5
  50. package/.eslintrc.json +0 -27
  51. package/.gitattributes +0 -1
  52. package/.github/workflows/check.yml +0 -36
  53. package/.github/workflows/publish.yml +0 -44
  54. package/.prettierrc.json +0 -7
  55. package/.vscode/settings.json +0 -4
  56. package/dist/cjs/interfaces/account-service.interface.js +0 -2
  57. package/dist/cjs/interfaces/account-services.interface.js +0 -2
  58. package/dist/cjs/interfaces/account.interface.js +0 -2
  59. package/dist/cjs/interfaces/attendance.interface.js +0 -2
  60. package/dist/cjs/interfaces/auth.interface.js +0 -2
  61. package/dist/cjs/interfaces/availability-pattern.interface.js +0 -2
  62. package/dist/cjs/interfaces/availability.interface.js +0 -2
  63. package/dist/cjs/interfaces/daily-budgets.interface.js +0 -2
  64. package/dist/cjs/interfaces/daily-revenue.interface.js +0 -2
  65. package/dist/cjs/interfaces/day-note.interface.js +0 -2
  66. package/dist/cjs/interfaces/days-off-pattern.interface.js +0 -2
  67. package/dist/cjs/interfaces/days-off.interface.js +0 -2
  68. package/dist/cjs/interfaces/document.interface.js +0 -2
  69. package/dist/cjs/interfaces/drop-request.interface.js +0 -2
  70. package/dist/cjs/interfaces/group.interface.js +0 -2
  71. package/dist/cjs/interfaces/holiday_allowance.interface.js +0 -2
  72. package/dist/cjs/interfaces/index.js +0 -55
  73. package/dist/cjs/interfaces/leave-date.interface.js +0 -2
  74. package/dist/cjs/interfaces/leave-embargo.interface.js +0 -2
  75. package/dist/cjs/interfaces/leave-rate.interface.js +0 -2
  76. package/dist/cjs/interfaces/leave-request.interface.d.ts +0 -23
  77. package/dist/cjs/interfaces/leave-request.interface.js +0 -2
  78. package/dist/cjs/interfaces/leave-type.interface.js +0 -2
  79. package/dist/cjs/interfaces/leave.interface.js +0 -2
  80. package/dist/cjs/interfaces/location-coordinate.interface.js +0 -2
  81. package/dist/cjs/interfaces/location.interface.js +0 -2
  82. package/dist/cjs/interfaces/logbook-category.interface.js +0 -2
  83. package/dist/cjs/interfaces/logbook-event.interface.js +0 -2
  84. package/dist/cjs/interfaces/pay-period.interface.js +0 -2
  85. package/dist/cjs/interfaces/pin.interface.js +0 -2
  86. package/dist/cjs/interfaces/query-params/attendance-query-params.interface.js +0 -2
  87. package/dist/cjs/interfaces/query-params/availability-patterns-query-params.interface.js +0 -2
  88. package/dist/cjs/interfaces/query-params/availability-query-params.interface.js +0 -2
  89. package/dist/cjs/interfaces/query-params/common-shift-times-query-params.interface.js +0 -2
  90. package/dist/cjs/interfaces/query-params/daily-budgets-query-params.interface.js +0 -2
  91. package/dist/cjs/interfaces/query-params/daily-revenue-query-params.interface.js +0 -2
  92. package/dist/cjs/interfaces/query-params/day-notes-query-params.interface.js +0 -2
  93. package/dist/cjs/interfaces/query-params/days-off-patterns-query-params.interface.js +0 -2
  94. package/dist/cjs/interfaces/query-params/days-off-query-params.interface.js +0 -2
  95. package/dist/cjs/interfaces/query-params/documents-query-params.interface.js +0 -2
  96. package/dist/cjs/interfaces/query-params/groups-query-params.interface.js +0 -2
  97. package/dist/cjs/interfaces/query-params/index.js +0 -42
  98. package/dist/cjs/interfaces/query-params/leave-embargoes-query-params.interface.js +0 -2
  99. package/dist/cjs/interfaces/query-params/leave-query-params.interface.js +0 -2
  100. package/dist/cjs/interfaces/query-params/leave-requests-query-params.interface.js +0 -2
  101. package/dist/cjs/interfaces/query-params/locations-query-params.interface.js +0 -2
  102. package/dist/cjs/interfaces/query-params/logbook-events-query-params.interface.js +0 -2
  103. package/dist/cjs/interfaces/query-params/pay-periods-query-params.interface.js +0 -2
  104. package/dist/cjs/interfaces/query-params/roles-query-params.interface.js +0 -2
  105. package/dist/cjs/interfaces/query-params/settings-query-params.interface.js +0 -2
  106. package/dist/cjs/interfaces/query-params/shifts-query-params.interface.js +0 -2
  107. package/dist/cjs/interfaces/query-params/swap-requests-query-params.interface.js +0 -2
  108. package/dist/cjs/interfaces/query-params/terminals-query-params.interface.js +0 -2
  109. package/dist/cjs/interfaces/query-params/toil-accruals-query-params.interface.js +0 -2
  110. package/dist/cjs/interfaces/query-params/toil-allowance-query-params.interface.d.ts +0 -3
  111. package/dist/cjs/interfaces/query-params/toil-allowance-query-params.interface.js +0 -2
  112. package/dist/cjs/interfaces/query-params/unavailability-requests-query-params.interface.js +0 -2
  113. package/dist/cjs/interfaces/query-params/users-query-params.interface.js +0 -2
  114. package/dist/cjs/interfaces/role-rate.interface.js +0 -2
  115. package/dist/cjs/interfaces/role.interface.js +0 -2
  116. package/dist/cjs/interfaces/sdk-config.interface.js +0 -8
  117. package/dist/cjs/interfaces/settings.interface.js +0 -2
  118. package/dist/cjs/interfaces/shift.interface.d.ts +0 -25
  119. package/dist/cjs/interfaces/shift.interface.js +0 -2
  120. package/dist/cjs/interfaces/swap-request.interface.js +0 -2
  121. package/dist/cjs/interfaces/terminal.interface.js +0 -2
  122. package/dist/cjs/interfaces/time-zone.interface.js +0 -2
  123. package/dist/cjs/interfaces/toil-accrual.interface.js +0 -2
  124. package/dist/cjs/interfaces/toil-allowance.interface.js +0 -2
  125. package/dist/cjs/interfaces/user.interface.js +0 -2
  126. package/dist/cjs/interfaces/users-clocked-in.interface.js +0 -2
  127. package/dist/cjs/interfaces/users-clocked-out.interface.js +0 -2
  128. package/dist/cjs/models/SDKError.model.d.ts +0 -11
  129. package/dist/cjs/models/SDKError.model.js +0 -15
  130. package/dist/cjs/models/index.js +0 -17
  131. package/dist/cjs/package.json +0 -3
  132. package/dist/cjs/rotacloud.d.ts +0 -47
  133. package/dist/cjs/rotacloud.js +0 -166
  134. package/dist/cjs/services/accounts.service.d.ts +0 -33
  135. package/dist/cjs/services/accounts.service.js +0 -83
  136. package/dist/cjs/services/attendance.service.d.ts +0 -51
  137. package/dist/cjs/services/attendance.service.js +0 -102
  138. package/dist/cjs/services/auth.service.d.ts +0 -10
  139. package/dist/cjs/services/auth.service.js +0 -14
  140. package/dist/cjs/services/availability.service.d.ts +0 -25
  141. package/dist/cjs/services/availability.service.js +0 -69
  142. package/dist/cjs/services/daily-budgets.service.d.ts +0 -27
  143. package/dist/cjs/services/daily-budgets.service.js +0 -87
  144. package/dist/cjs/services/daily-revenue.service.d.ts +0 -27
  145. package/dist/cjs/services/daily-revenue.service.js +0 -87
  146. package/dist/cjs/services/day-notes.service.d.ts +0 -49
  147. package/dist/cjs/services/day-notes.service.js +0 -102
  148. package/dist/cjs/services/days-off.service.d.ts +0 -32
  149. package/dist/cjs/services/days-off.service.js +0 -102
  150. package/dist/cjs/services/documents.service.d.ts +0 -73
  151. package/dist/cjs/services/documents.service.js +0 -125
  152. package/dist/cjs/services/groups.service.d.ts +0 -51
  153. package/dist/cjs/services/groups.service.js +0 -102
  154. package/dist/cjs/services/index.d.ts +0 -25
  155. package/dist/cjs/services/index.js +0 -41
  156. package/dist/cjs/services/leave-embargoes.service.d.ts +0 -51
  157. package/dist/cjs/services/leave-embargoes.service.js +0 -102
  158. package/dist/cjs/services/leave-request.service.d.ts +0 -51
  159. package/dist/cjs/services/leave-request.service.js +0 -106
  160. package/dist/cjs/services/leave-types.service.d.ts +0 -11
  161. package/dist/cjs/services/leave-types.service.js +0 -16
  162. package/dist/cjs/services/leave.service.d.ts +0 -51
  163. package/dist/cjs/services/leave.service.js +0 -102
  164. package/dist/cjs/services/locations.service.d.ts +0 -51
  165. package/dist/cjs/services/locations.service.js +0 -102
  166. package/dist/cjs/services/pins.service.d.ts +0 -18
  167. package/dist/cjs/services/pins.service.js +0 -16
  168. package/dist/cjs/services/roles.service.d.ts +0 -51
  169. package/dist/cjs/services/roles.service.js +0 -102
  170. package/dist/cjs/services/service.d.ts +0 -47
  171. package/dist/cjs/services/service.js +0 -149
  172. package/dist/cjs/services/settings.service.d.ts +0 -12
  173. package/dist/cjs/services/settings.service.js +0 -16
  174. package/dist/cjs/services/shifts.service.d.ts +0 -120
  175. package/dist/cjs/services/shifts.service.js +0 -154
  176. package/dist/cjs/services/terminals-active.service.d.ts +0 -46
  177. package/dist/cjs/services/terminals-active.service.js +0 -97
  178. package/dist/cjs/services/terminals.service.d.ts +0 -50
  179. package/dist/cjs/services/terminals.service.js +0 -102
  180. package/dist/cjs/services/time-zone.service.d.ts +0 -14
  181. package/dist/cjs/services/time-zone.service.js +0 -83
  182. package/dist/cjs/services/toil-accruals.service.d.ts +0 -27
  183. package/dist/cjs/services/toil-accruals.service.js +0 -93
  184. package/dist/cjs/services/toil-allowance.service.d.ts +0 -9
  185. package/dist/cjs/services/toil-allowance.service.js +0 -78
  186. package/dist/cjs/services/users-clock-in.service.d.ts +0 -66
  187. package/dist/cjs/services/users-clock-in.service.js +0 -113
  188. package/dist/cjs/services/users.service.d.ts +0 -51
  189. package/dist/cjs/services/users.service.js +0 -102
  190. package/dist/cjs/version.d.ts +0 -3
  191. package/dist/cjs/version.js +0 -4
  192. package/dist/mjs/interfaces/account-service.interface.d.ts +0 -6
  193. package/dist/mjs/interfaces/account-services.interface.d.ts +0 -6
  194. package/dist/mjs/interfaces/account.interface.d.ts +0 -40
  195. package/dist/mjs/interfaces/attendance.interface.d.ts +0 -31
  196. package/dist/mjs/interfaces/auth.interface.d.ts +0 -8
  197. package/dist/mjs/interfaces/availability-pattern.interface.d.ts +0 -20
  198. package/dist/mjs/interfaces/availability.interface.d.ts +0 -13
  199. package/dist/mjs/interfaces/daily-budgets.interface.d.ts +0 -6
  200. package/dist/mjs/interfaces/daily-revenue.interface.d.ts +0 -7
  201. package/dist/mjs/interfaces/day-note.interface.d.ts +0 -9
  202. package/dist/mjs/interfaces/days-off-pattern.interface.d.ts +0 -13
  203. package/dist/mjs/interfaces/days-off.interface.d.ts +0 -8
  204. package/dist/mjs/interfaces/document.interface.d.ts +0 -36
  205. package/dist/mjs/interfaces/drop-request.interface.d.ts +0 -13
  206. package/dist/mjs/interfaces/group.interface.d.ts +0 -7
  207. package/dist/mjs/interfaces/holiday_allowance.interface.d.ts +0 -11
  208. package/dist/mjs/interfaces/index.d.ts +0 -39
  209. package/dist/mjs/interfaces/leave-date.interface.d.ts +0 -8
  210. package/dist/mjs/interfaces/leave-embargo.interface.d.ts +0 -10
  211. package/dist/mjs/interfaces/leave-rate.interface.d.ts +0 -3
  212. package/dist/mjs/interfaces/leave-type.interface.d.ts +0 -8
  213. package/dist/mjs/interfaces/leave.interface.d.ts +0 -8
  214. package/dist/mjs/interfaces/location-coordinate.interface.d.ts +0 -5
  215. package/dist/mjs/interfaces/location.interface.d.ts +0 -13
  216. package/dist/mjs/interfaces/logbook-category.interface.d.ts +0 -5
  217. package/dist/mjs/interfaces/logbook-event.interface.d.ts +0 -16
  218. package/dist/mjs/interfaces/pay-period.interface.d.ts +0 -16
  219. package/dist/mjs/interfaces/pin.interface.d.ts +0 -3
  220. package/dist/mjs/interfaces/query-params/attendance-query-params.interface.d.ts +0 -9
  221. package/dist/mjs/interfaces/query-params/availability-patterns-query-params.interface.d.ts +0 -5
  222. package/dist/mjs/interfaces/query-params/availability-query-params.interface.d.ts +0 -12
  223. package/dist/mjs/interfaces/query-params/common-shift-times-query-params.interface.d.ts +0 -3
  224. package/dist/mjs/interfaces/query-params/daily-budgets-query-params.interface.d.ts +0 -5
  225. package/dist/mjs/interfaces/query-params/daily-revenue-query-params.interface.d.ts +0 -5
  226. package/dist/mjs/interfaces/query-params/day-notes-query-params.interface.d.ts +0 -5
  227. package/dist/mjs/interfaces/query-params/days-off-patterns-query-params.interface.d.ts +0 -5
  228. package/dist/mjs/interfaces/query-params/days-off-query-params.interface.d.ts +0 -5
  229. package/dist/mjs/interfaces/query-params/documents-query-params.interface.d.ts +0 -4
  230. package/dist/mjs/interfaces/query-params/groups-query-params.interface.d.ts +0 -3
  231. package/dist/mjs/interfaces/query-params/index.d.ts +0 -26
  232. package/dist/mjs/interfaces/query-params/leave-embargoes-query-params.interface.d.ts +0 -5
  233. package/dist/mjs/interfaces/query-params/leave-query-params.interface.d.ts +0 -13
  234. package/dist/mjs/interfaces/query-params/leave-requests-query-params.interface.d.ts +0 -4
  235. package/dist/mjs/interfaces/query-params/locations-query-params.interface.d.ts +0 -7
  236. package/dist/mjs/interfaces/query-params/logbook-events-query-params.interface.d.ts +0 -3
  237. package/dist/mjs/interfaces/query-params/pay-periods-query-params.interface.d.ts +0 -4
  238. package/dist/mjs/interfaces/query-params/roles-query-params.interface.d.ts +0 -5
  239. package/dist/mjs/interfaces/query-params/settings-query-params.interface.d.ts +0 -3
  240. package/dist/mjs/interfaces/query-params/shifts-query-params.interface.d.ts +0 -14
  241. package/dist/mjs/interfaces/query-params/swap-requests-query-params.interface.d.ts +0 -8
  242. package/dist/mjs/interfaces/query-params/terminals-query-params.interface.d.ts +0 -3
  243. package/dist/mjs/interfaces/query-params/toil-accruals-query-params.interface.d.ts +0 -4
  244. package/dist/mjs/interfaces/query-params/unavailability-requests-query-params.interface.d.ts +0 -8
  245. package/dist/mjs/interfaces/query-params/users-query-params.interface.d.ts +0 -24
  246. package/dist/mjs/interfaces/role-rate.interface.d.ts +0 -6
  247. package/dist/mjs/interfaces/role.interface.d.ts +0 -9
  248. package/dist/mjs/interfaces/sdk-config.interface.d.ts +0 -47
  249. package/dist/mjs/interfaces/settings.interface.d.ts +0 -64
  250. package/dist/mjs/interfaces/swap-request.interface.d.ts +0 -16
  251. package/dist/mjs/interfaces/terminal.interface.d.ts +0 -23
  252. package/dist/mjs/interfaces/time-zone.interface.d.ts +0 -7
  253. package/dist/mjs/interfaces/toil-accrual.interface.d.ts +0 -14
  254. package/dist/mjs/interfaces/toil-allowance.interface.d.ts +0 -7
  255. package/dist/mjs/interfaces/user.interface.d.ts +0 -48
  256. package/dist/mjs/interfaces/users-clocked-in.interface.d.ts +0 -14
  257. package/dist/mjs/interfaces/users-clocked-out.interface.d.ts +0 -26
  258. package/dist/mjs/models/SDKError.model.d.ts +0 -11
  259. package/dist/mjs/models/index.d.ts +0 -1
  260. package/dist/mjs/package.json +0 -3
  261. package/dist/mjs/rotacloud.d.ts +0 -47
  262. package/dist/mjs/rotacloud.js +0 -133
  263. package/dist/mjs/services/accounts.service.d.ts +0 -33
  264. package/dist/mjs/services/accounts.service.js +0 -25
  265. package/dist/mjs/services/attendance.service.d.ts +0 -51
  266. package/dist/mjs/services/attendance.service.js +0 -44
  267. package/dist/mjs/services/auth.service.d.ts +0 -10
  268. package/dist/mjs/services/auth.service.js +0 -10
  269. package/dist/mjs/services/availability.service.d.ts +0 -25
  270. package/dist/mjs/services/availability.service.js +0 -35
  271. package/dist/mjs/services/daily-budgets.service.d.ts +0 -27
  272. package/dist/mjs/services/daily-budgets.service.js +0 -29
  273. package/dist/mjs/services/daily-revenue.service.d.ts +0 -27
  274. package/dist/mjs/services/daily-revenue.service.js +0 -29
  275. package/dist/mjs/services/day-notes.service.d.ts +0 -49
  276. package/dist/mjs/services/day-notes.service.js +0 -44
  277. package/dist/mjs/services/days-off.service.d.ts +0 -32
  278. package/dist/mjs/services/days-off.service.js +0 -44
  279. package/dist/mjs/services/documents.service.d.ts +0 -73
  280. package/dist/mjs/services/documents.service.js +0 -67
  281. package/dist/mjs/services/groups.service.d.ts +0 -51
  282. package/dist/mjs/services/groups.service.js +0 -44
  283. package/dist/mjs/services/index.d.ts +0 -25
  284. package/dist/mjs/services/index.js +0 -25
  285. package/dist/mjs/services/leave-embargoes.service.d.ts +0 -51
  286. package/dist/mjs/services/leave-embargoes.service.js +0 -44
  287. package/dist/mjs/services/leave-request.service.d.ts +0 -51
  288. package/dist/mjs/services/leave-request.service.js +0 -48
  289. package/dist/mjs/services/leave-types.service.d.ts +0 -11
  290. package/dist/mjs/services/leave-types.service.js +0 -12
  291. package/dist/mjs/services/leave.service.d.ts +0 -51
  292. package/dist/mjs/services/leave.service.js +0 -44
  293. package/dist/mjs/services/locations.service.d.ts +0 -51
  294. package/dist/mjs/services/locations.service.js +0 -44
  295. package/dist/mjs/services/pins.service.d.ts +0 -18
  296. package/dist/mjs/services/pins.service.js +0 -12
  297. package/dist/mjs/services/roles.service.d.ts +0 -51
  298. package/dist/mjs/services/roles.service.js +0 -44
  299. package/dist/mjs/services/service.d.ts +0 -47
  300. package/dist/mjs/services/service.js +0 -101
  301. package/dist/mjs/services/settings.service.d.ts +0 -12
  302. package/dist/mjs/services/settings.service.js +0 -12
  303. package/dist/mjs/services/shifts.service.d.ts +0 -120
  304. package/dist/mjs/services/shifts.service.js +0 -96
  305. package/dist/mjs/services/terminals-active.service.d.ts +0 -46
  306. package/dist/mjs/services/terminals-active.service.js +0 -39
  307. package/dist/mjs/services/terminals.service.d.ts +0 -50
  308. package/dist/mjs/services/terminals.service.js +0 -44
  309. package/dist/mjs/services/time-zone.service.d.ts +0 -14
  310. package/dist/mjs/services/time-zone.service.js +0 -25
  311. package/dist/mjs/services/toil-accruals.service.d.ts +0 -27
  312. package/dist/mjs/services/toil-accruals.service.js +0 -35
  313. package/dist/mjs/services/toil-allowance.service.d.ts +0 -9
  314. package/dist/mjs/services/toil-allowance.service.js +0 -20
  315. package/dist/mjs/services/users-clock-in.service.d.ts +0 -66
  316. package/dist/mjs/services/users-clock-in.service.js +0 -47
  317. package/dist/mjs/services/users.service.d.ts +0 -51
  318. package/dist/mjs/services/users.service.js +0 -44
  319. package/dist/mjs/version.d.ts +0 -3
  320. package/dist/mjs/version.js +0 -1
  321. package/fixup +0 -12
  322. package/src/rotacloud.ts +0 -207
  323. package/src/services/accounts.service.ts +0 -52
  324. package/src/services/attendance.service.ts +0 -106
  325. package/src/services/auth.service.ts +0 -13
  326. package/src/services/availability.service.ts +0 -58
  327. package/src/services/daily-budgets.service.ts +0 -65
  328. package/src/services/daily-revenue.service.ts +0 -62
  329. package/src/services/day-notes.service.ts +0 -98
  330. package/src/services/days-off.service.ts +0 -85
  331. package/src/services/documents.service.ts +0 -142
  332. package/src/services/groups.service.ts +0 -97
  333. package/src/services/index.ts +0 -25
  334. package/src/services/leave-embargoes.service.ts +0 -106
  335. package/src/services/leave-request.service.ts +0 -113
  336. package/src/services/leave-types.service.ts +0 -16
  337. package/src/services/leave.service.ts +0 -100
  338. package/src/services/locations.service.ts +0 -106
  339. package/src/services/pins.service.ts +0 -21
  340. package/src/services/roles.service.ts +0 -96
  341. package/src/services/service.ts +0 -168
  342. package/src/services/settings.service.ts +0 -19
  343. package/src/services/shifts.service.ts +0 -200
  344. package/src/services/terminals-active.service.ts +0 -85
  345. package/src/services/terminals.service.ts +0 -93
  346. package/src/services/time-zone.service.ts +0 -34
  347. package/src/services/toil-accruals.service.ts +0 -56
  348. package/src/services/toil-allowance.service.ts +0 -23
  349. package/src/services/users-clock-in.service.ts +0 -130
  350. package/src/services/users.service.ts +0 -96
  351. package/src/version.ts +0 -1
  352. package/tsconfig-base.json +0 -98
  353. package/tsconfig-cjs.json +0 -8
  354. package/tsconfig.json +0 -8
  355. /package/dist/{mjs/interfaces/account-service.interface.js → client-builder.test.d.ts} +0 -0
  356. /package/dist/{mjs/interfaces/account-services.interface.js → endpoint.js} +0 -0
  357. /package/dist/{cjs/interfaces → interfaces}/account-service.interface.d.ts +0 -0
  358. /package/dist/{mjs/interfaces/account.interface.js → interfaces/account-service.interface.js} +0 -0
  359. /package/dist/{cjs/interfaces → interfaces}/account-services.interface.d.ts +0 -0
  360. /package/dist/{mjs/interfaces/attendance.interface.js → interfaces/account-services.interface.js} +0 -0
  361. /package/dist/{cjs/interfaces → interfaces}/account.interface.d.ts +0 -0
  362. /package/dist/{mjs/interfaces/auth.interface.js → interfaces/account.interface.js} +0 -0
  363. /package/dist/{cjs/interfaces → interfaces}/attendance.interface.d.ts +0 -0
  364. /package/dist/{mjs/interfaces/availability-pattern.interface.js → interfaces/attendance.interface.js} +0 -0
  365. /package/dist/{cjs/interfaces → interfaces}/auth.interface.d.ts +0 -0
  366. /package/dist/{mjs/interfaces/availability.interface.js → interfaces/auth.interface.js} +0 -0
  367. /package/dist/{cjs/interfaces → interfaces}/availability-pattern.interface.d.ts +0 -0
  368. /package/dist/{mjs/interfaces/daily-budgets.interface.js → interfaces/availability-pattern.interface.js} +0 -0
  369. /package/dist/{cjs/interfaces → interfaces}/availability.interface.d.ts +0 -0
  370. /package/dist/{mjs/interfaces/daily-revenue.interface.js → interfaces/availability.interface.js} +0 -0
  371. /package/dist/{cjs/interfaces → interfaces}/daily-budgets.interface.d.ts +0 -0
  372. /package/dist/{mjs/interfaces/day-note.interface.js → interfaces/daily-budgets.interface.js} +0 -0
  373. /package/dist/{cjs/interfaces → interfaces}/daily-revenue.interface.d.ts +0 -0
  374. /package/dist/{mjs/interfaces/days-off-pattern.interface.js → interfaces/daily-revenue.interface.js} +0 -0
  375. /package/dist/{cjs/interfaces → interfaces}/day-note.interface.d.ts +0 -0
  376. /package/dist/{mjs/interfaces/days-off.interface.js → interfaces/day-note.interface.js} +0 -0
  377. /package/dist/{cjs/interfaces → interfaces}/days-off-pattern.interface.d.ts +0 -0
  378. /package/dist/{mjs/interfaces/document.interface.js → interfaces/days-off-pattern.interface.js} +0 -0
  379. /package/dist/{cjs/interfaces → interfaces}/days-off.interface.d.ts +0 -0
  380. /package/dist/{mjs/interfaces/drop-request.interface.js → interfaces/days-off.interface.js} +0 -0
  381. /package/dist/{cjs/interfaces → interfaces}/document.interface.d.ts +0 -0
  382. /package/dist/{mjs/interfaces/group.interface.js → interfaces/document.interface.js} +0 -0
  383. /package/dist/{cjs/interfaces → interfaces}/drop-request.interface.d.ts +0 -0
  384. /package/dist/{mjs/interfaces/holiday_allowance.interface.js → interfaces/drop-request.interface.js} +0 -0
  385. /package/dist/{cjs/interfaces → interfaces}/group.interface.d.ts +0 -0
  386. /package/dist/{mjs/interfaces/leave-date.interface.js → interfaces/group.interface.js} +0 -0
  387. /package/dist/{cjs/interfaces → interfaces}/holiday_allowance.interface.d.ts +0 -0
  388. /package/dist/{mjs/interfaces/leave-embargo.interface.js → interfaces/holiday_allowance.interface.js} +0 -0
  389. /package/dist/{cjs/interfaces → interfaces}/index.d.ts +0 -0
  390. /package/dist/{mjs/interfaces → interfaces}/index.js +0 -0
  391. /package/dist/{mjs/interfaces/leave-rate.interface.js → interfaces/launch-terminal.interface.js} +0 -0
  392. /package/dist/{cjs/interfaces → interfaces}/leave-date.interface.d.ts +0 -0
  393. /package/dist/{mjs/interfaces/leave-request.interface.js → interfaces/leave-date.interface.js} +0 -0
  394. /package/dist/{cjs/interfaces → interfaces}/leave-embargo.interface.d.ts +0 -0
  395. /package/dist/{mjs/interfaces/leave-type.interface.js → interfaces/leave-embargo.interface.js} +0 -0
  396. /package/dist/{cjs/interfaces → interfaces}/leave-rate.interface.d.ts +0 -0
  397. /package/dist/{mjs/interfaces/leave.interface.js → interfaces/leave-rate.interface.js} +0 -0
  398. /package/dist/{mjs/interfaces/location-coordinate.interface.js → interfaces/leave-request.interface.js} +0 -0
  399. /package/dist/{cjs/interfaces → interfaces}/leave-type.interface.d.ts +0 -0
  400. /package/dist/{mjs/interfaces/location.interface.js → interfaces/leave-type.interface.js} +0 -0
  401. /package/dist/{mjs/interfaces/logbook-category.interface.js → interfaces/leave.interface.js} +0 -0
  402. /package/dist/{cjs/interfaces → interfaces}/location-coordinate.interface.d.ts +0 -0
  403. /package/dist/{mjs/interfaces/logbook-event.interface.js → interfaces/location-coordinate.interface.js} +0 -0
  404. /package/dist/{cjs/interfaces → interfaces}/location.interface.d.ts +0 -0
  405. /package/dist/{mjs/interfaces/pay-period.interface.js → interfaces/location.interface.js} +0 -0
  406. /package/dist/{cjs/interfaces → interfaces}/logbook-category.interface.d.ts +0 -0
  407. /package/dist/{mjs/interfaces/pin.interface.js → interfaces/logbook-category.interface.js} +0 -0
  408. /package/dist/{cjs/interfaces → interfaces}/logbook-event.interface.d.ts +0 -0
  409. /package/dist/{mjs/interfaces/query-params/attendance-query-params.interface.js → interfaces/logbook-event.interface.js} +0 -0
  410. /package/dist/{cjs/interfaces → interfaces}/pay-period.interface.d.ts +0 -0
  411. /package/dist/{mjs/interfaces/query-params/availability-patterns-query-params.interface.js → interfaces/pay-period.interface.js} +0 -0
  412. /package/dist/{cjs/interfaces → interfaces}/pin.interface.d.ts +0 -0
  413. /package/dist/{mjs/interfaces/query-params/availability-query-params.interface.js → interfaces/pin.interface.js} +0 -0
  414. /package/dist/{cjs/interfaces → interfaces}/query-params/attendance-query-params.interface.d.ts +0 -0
  415. /package/dist/{mjs/interfaces/query-params/common-shift-times-query-params.interface.js → interfaces/query-params/attendance-query-params.interface.js} +0 -0
  416. /package/dist/{cjs/interfaces → interfaces}/query-params/availability-patterns-query-params.interface.d.ts +0 -0
  417. /package/dist/{mjs/interfaces/query-params/daily-budgets-query-params.interface.js → interfaces/query-params/availability-patterns-query-params.interface.js} +0 -0
  418. /package/dist/{cjs/interfaces → interfaces}/query-params/availability-query-params.interface.d.ts +0 -0
  419. /package/dist/{mjs/interfaces/query-params/daily-revenue-query-params.interface.js → interfaces/query-params/availability-query-params.interface.js} +0 -0
  420. /package/dist/{cjs/interfaces → interfaces}/query-params/common-shift-times-query-params.interface.d.ts +0 -0
  421. /package/dist/{mjs/interfaces/query-params/day-notes-query-params.interface.js → interfaces/query-params/common-shift-times-query-params.interface.js} +0 -0
  422. /package/dist/{cjs/interfaces → interfaces}/query-params/daily-budgets-query-params.interface.d.ts +0 -0
  423. /package/dist/{mjs/interfaces/query-params/days-off-patterns-query-params.interface.js → interfaces/query-params/daily-budgets-query-params.interface.js} +0 -0
  424. /package/dist/{cjs/interfaces → interfaces}/query-params/daily-revenue-query-params.interface.d.ts +0 -0
  425. /package/dist/{mjs/interfaces/query-params/days-off-query-params.interface.js → interfaces/query-params/daily-revenue-query-params.interface.js} +0 -0
  426. /package/dist/{cjs/interfaces → interfaces}/query-params/day-notes-query-params.interface.d.ts +0 -0
  427. /package/dist/{mjs/interfaces/query-params/documents-query-params.interface.js → interfaces/query-params/day-notes-query-params.interface.js} +0 -0
  428. /package/dist/{cjs/interfaces → interfaces}/query-params/days-off-patterns-query-params.interface.d.ts +0 -0
  429. /package/dist/{mjs/interfaces/query-params/groups-query-params.interface.js → interfaces/query-params/days-off-patterns-query-params.interface.js} +0 -0
  430. /package/dist/{cjs/interfaces → interfaces}/query-params/days-off-query-params.interface.d.ts +0 -0
  431. /package/dist/{mjs/interfaces/query-params/leave-embargoes-query-params.interface.js → interfaces/query-params/days-off-query-params.interface.js} +0 -0
  432. /package/dist/{cjs/interfaces → interfaces}/query-params/documents-query-params.interface.d.ts +0 -0
  433. /package/dist/{mjs/interfaces/query-params/leave-query-params.interface.js → interfaces/query-params/documents-query-params.interface.js} +0 -0
  434. /package/dist/{cjs/interfaces → interfaces}/query-params/groups-query-params.interface.d.ts +0 -0
  435. /package/dist/{mjs/interfaces/query-params/leave-requests-query-params.interface.js → interfaces/query-params/groups-query-params.interface.js} +0 -0
  436. /package/dist/{cjs/interfaces → interfaces}/query-params/index.d.ts +0 -0
  437. /package/dist/{mjs/interfaces → interfaces}/query-params/index.js +0 -0
  438. /package/dist/{cjs/interfaces → interfaces}/query-params/leave-embargoes-query-params.interface.d.ts +0 -0
  439. /package/dist/{mjs/interfaces/query-params/locations-query-params.interface.js → interfaces/query-params/leave-embargoes-query-params.interface.js} +0 -0
  440. /package/dist/{cjs/interfaces → interfaces}/query-params/leave-query-params.interface.d.ts +0 -0
  441. /package/dist/{mjs/interfaces/query-params/logbook-events-query-params.interface.js → interfaces/query-params/leave-query-params.interface.js} +0 -0
  442. /package/dist/{cjs/interfaces → interfaces}/query-params/leave-requests-query-params.interface.d.ts +0 -0
  443. /package/dist/{mjs/interfaces/query-params/pay-periods-query-params.interface.js → interfaces/query-params/leave-requests-query-params.interface.js} +0 -0
  444. /package/dist/{cjs/interfaces → interfaces}/query-params/locations-query-params.interface.d.ts +0 -0
  445. /package/dist/{mjs/interfaces/query-params/roles-query-params.interface.js → interfaces/query-params/locations-query-params.interface.js} +0 -0
  446. /package/dist/{cjs/interfaces → interfaces}/query-params/logbook-events-query-params.interface.d.ts +0 -0
  447. /package/dist/{mjs/interfaces/query-params/settings-query-params.interface.js → interfaces/query-params/logbook-events-query-params.interface.js} +0 -0
  448. /package/dist/{cjs/interfaces → interfaces}/query-params/pay-periods-query-params.interface.d.ts +0 -0
  449. /package/dist/{mjs/interfaces/query-params/shifts-query-params.interface.js → interfaces/query-params/pay-periods-query-params.interface.js} +0 -0
  450. /package/dist/{cjs/interfaces → interfaces}/query-params/roles-query-params.interface.d.ts +0 -0
  451. /package/dist/{mjs/interfaces/query-params/swap-requests-query-params.interface.js → interfaces/query-params/roles-query-params.interface.js} +0 -0
  452. /package/dist/{cjs/interfaces → interfaces}/query-params/settings-query-params.interface.d.ts +0 -0
  453. /package/dist/{mjs/interfaces/query-params/terminals-query-params.interface.js → interfaces/query-params/settings-query-params.interface.js} +0 -0
  454. /package/dist/{cjs/interfaces → interfaces}/query-params/shifts-query-params.interface.d.ts +0 -0
  455. /package/dist/{mjs/interfaces/query-params/toil-accruals-query-params.interface.js → interfaces/query-params/shifts-query-params.interface.js} +0 -0
  456. /package/dist/{cjs/interfaces → interfaces}/query-params/swap-requests-query-params.interface.d.ts +0 -0
  457. /package/dist/{mjs/interfaces/query-params/toil-allowance-query-params.interface.js → interfaces/query-params/swap-requests-query-params.interface.js} +0 -0
  458. /package/dist/{cjs/interfaces → interfaces}/query-params/terminals-query-params.interface.d.ts +0 -0
  459. /package/dist/{mjs/interfaces/query-params/unavailability-requests-query-params.interface.js → interfaces/query-params/terminals-query-params.interface.js} +0 -0
  460. /package/dist/{cjs/interfaces → interfaces}/query-params/toil-accruals-query-params.interface.d.ts +0 -0
  461. /package/dist/{mjs/interfaces/query-params/users-query-params.interface.js → interfaces/query-params/toil-accruals-query-params.interface.js} +0 -0
  462. /package/dist/{mjs/interfaces/role-rate.interface.js → interfaces/query-params/toil-allowance-query-params.interface.js} +0 -0
  463. /package/dist/{cjs/interfaces → interfaces}/query-params/unavailability-requests-query-params.interface.d.ts +0 -0
  464. /package/dist/{mjs/interfaces/role.interface.js → interfaces/query-params/unavailability-requests-query-params.interface.js} +0 -0
  465. /package/dist/{cjs/interfaces → interfaces}/query-params/users-query-params.interface.d.ts +0 -0
  466. /package/dist/{mjs/interfaces/settings.interface.js → interfaces/query-params/users-query-params.interface.js} +0 -0
  467. /package/dist/{cjs/interfaces → interfaces}/role-rate.interface.d.ts +0 -0
  468. /package/dist/{mjs/interfaces/shift.interface.js → interfaces/role-rate.interface.js} +0 -0
  469. /package/dist/{cjs/interfaces → interfaces}/role.interface.d.ts +0 -0
  470. /package/dist/{mjs/interfaces/swap-request.interface.js → interfaces/role.interface.js} +0 -0
  471. /package/dist/{mjs/interfaces → interfaces}/sdk-config.interface.js +0 -0
  472. /package/dist/{cjs/interfaces → interfaces}/settings.interface.d.ts +0 -0
  473. /package/dist/{mjs/interfaces/terminal.interface.js → interfaces/settings.interface.js} +0 -0
  474. /package/dist/{mjs/interfaces/time-zone.interface.js → interfaces/shift.interface.js} +0 -0
  475. /package/dist/{cjs/interfaces → interfaces}/swap-request.interface.d.ts +0 -0
  476. /package/dist/{mjs/interfaces/toil-accrual.interface.js → interfaces/swap-request.interface.js} +0 -0
  477. /package/dist/{cjs/interfaces → interfaces}/terminal.interface.d.ts +0 -0
  478. /package/dist/{mjs/interfaces/toil-allowance.interface.js → interfaces/terminal.interface.js} +0 -0
  479. /package/dist/{cjs/interfaces → interfaces}/time-zone.interface.d.ts +0 -0
  480. /package/dist/{mjs/interfaces/user.interface.js → interfaces/time-zone.interface.js} +0 -0
  481. /package/dist/{cjs/interfaces → interfaces}/toil-accrual.interface.d.ts +0 -0
  482. /package/dist/{mjs/interfaces/users-clocked-in.interface.js → interfaces/toil-accrual.interface.js} +0 -0
  483. /package/dist/{cjs/interfaces → interfaces}/toil-allowance.interface.d.ts +0 -0
  484. /package/dist/{mjs/interfaces/users-clocked-out.interface.js → interfaces/toil-allowance.interface.js} +0 -0
  485. /package/dist/{cjs/interfaces → interfaces}/users-clocked-in.interface.d.ts +0 -0
  486. /package/dist/{cjs/interfaces → interfaces}/users-clocked-out.interface.d.ts +0 -0
  487. /package/dist/{cjs/models → models}/index.d.ts +0 -0
  488. /package/dist/{mjs/models → models}/index.js +0 -0
@@ -1,96 +0,0 @@
1
- import { AxiosResponse } from 'axios';
2
- import { Role } from '../interfaces/index.js';
3
- import { Service, Options, RequirementsOf, OptionsExtended } from './index.js';
4
-
5
- import { RolesQueryParams } from '../interfaces/query-params/roles-query-params.interface.js';
6
-
7
- type RequiredProps = 'name';
8
-
9
- export class RolesService extends Service<Role> {
10
- private apiPath = '/roles';
11
-
12
- create(data: RequirementsOf<Role, RequiredProps>): Promise<Role>;
13
- create(
14
- data: RequirementsOf<Role, RequiredProps>,
15
- options: { rawResponse: true } & Options,
16
- ): Promise<AxiosResponse<Role, any>>;
17
- create(data: RequirementsOf<Role, RequiredProps>, options: Options): Promise<Role>;
18
- create(data: RequirementsOf<Role, RequiredProps>, options?: Options) {
19
- return super
20
- .fetch<Role>({ url: this.apiPath, data, method: 'POST' }, options)
21
- .then((res) => (options?.rawResponse ? res : res.data));
22
- }
23
-
24
- get(id: number): Promise<Role>;
25
- get<F extends keyof Role>(
26
- id: number,
27
- options: { fields: F[]; rawResponse: true } & OptionsExtended<Role>,
28
- ): Promise<AxiosResponse<Pick<Role, F>>>;
29
- get<F extends keyof Role>(id: number, options: { fields: F[] } & OptionsExtended<Role>): Promise<Pick<Role, F>>;
30
- get(id: number, options: { rawResponse: true } & Options): Promise<AxiosResponse<Role>>;
31
- get(id: number, options?: OptionsExtended<Role>): Promise<Role>;
32
- get(id: number, options?: OptionsExtended<Role>) {
33
- return super
34
- .fetch<Role>({ url: `${this.apiPath}/${id}` }, options)
35
- .then((res) => (options?.rawResponse ? res : res.data));
36
- }
37
-
38
- list(query?: RolesQueryParams): AsyncGenerator<Role>;
39
- list<F extends keyof Role>(
40
- query: RolesQueryParams,
41
- options: { fields: F[] } & OptionsExtended<Role>,
42
- ): AsyncGenerator<Pick<Role, F>>;
43
- list(query?: RolesQueryParams, options?: OptionsExtended<Role>): AsyncGenerator<Role>;
44
- async *list(query?: RolesQueryParams, options?: OptionsExtended<Role>) {
45
- yield* super.iterator({ url: this.apiPath, params: query }, options);
46
- }
47
-
48
- listAll(query?: RolesQueryParams): Promise<Role[]>;
49
- listAll<F extends keyof Role>(
50
- query: RolesQueryParams,
51
- options: { fields: F[] } & OptionsExtended<Role>,
52
- ): Promise<Pick<Role, F>[]>;
53
- listAll(query?: RolesQueryParams, options?: OptionsExtended<Role>): Promise<Role[]>;
54
- async listAll(query?: RolesQueryParams, options?: OptionsExtended<Role>) {
55
- const roles = [] as Role[];
56
- for await (const role of this.list(query, options)) {
57
- roles.push(role);
58
- }
59
- return roles;
60
- }
61
-
62
- listByPage(query?: RolesQueryParams): AsyncGenerator<AxiosResponse<Role[]>>;
63
- listByPage<F extends keyof Role>(
64
- query: RolesQueryParams,
65
- options: { fields: F[] } & OptionsExtended<Role>,
66
- ): AsyncGenerator<AxiosResponse<Pick<Role, F>[]>>;
67
- listByPage(query?: RolesQueryParams, options?: OptionsExtended<Role>): AsyncGenerator<AxiosResponse<Role[]>>;
68
- listByPage(query?: RolesQueryParams, options?: OptionsExtended<Role>) {
69
- return super.iterator({ url: this.apiPath, params: query }, options).byPage();
70
- }
71
-
72
- update(id: number, data: Partial<Role>): Promise<Role>;
73
- update(id: number, data: Partial<Role>, options: { rawResponse: true } & Options): Promise<AxiosResponse<Role, any>>;
74
- update(id: number, data: Partial<Role>, options: Options): Promise<Role>;
75
- update(id: number, data: Partial<Role>, options?: Options) {
76
- return super
77
- .fetch<Role>(
78
- {
79
- url: `${this.apiPath}/${id}`,
80
- data,
81
- method: 'POST',
82
- },
83
- options,
84
- )
85
- .then((res) => (options?.rawResponse ? res : res.data));
86
- }
87
-
88
- delete(id: number): Promise<number>;
89
- delete(id: number, options: { rawResponse: true } & Options): Promise<AxiosResponse<void>>;
90
- delete(id: number, options: Options): Promise<number>;
91
- delete(id: number, options?: Options) {
92
- return super
93
- .fetch<void>({ url: `${this.apiPath}/${id}`, method: 'DELETE' }, options)
94
- .then((res) => (options?.rawResponse ? res : res.status));
95
- }
96
- }
@@ -1,168 +0,0 @@
1
- import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
2
- import { Version } from '../version.js';
3
- import { SDKConfig } from '../interfaces';
4
-
5
- export type RequirementsOf<T, K extends keyof T> = Required<Pick<T, K>> & Partial<T>;
6
-
7
- export type Options =
8
- | {
9
- rawResponse?: boolean;
10
- maxResults?: number;
11
- limit?: never;
12
- offset?: number;
13
- dryRun?: boolean;
14
- }
15
- | {
16
- rawResponse?: boolean;
17
- maxResults?: never;
18
- /** @deprecated use `maxResults` instead */
19
- limit?: number;
20
- offset?: number;
21
- dryRun?: boolean;
22
- };
23
-
24
- export type OptionsExtended<T = unknown> = Options & {
25
- fields?: (keyof T)[];
26
- };
27
-
28
- type ParameterPrimitive = string | boolean | number | null | symbol;
29
- type ParameterValue = ParameterPrimitive | ParameterPrimitive[] | undefined;
30
-
31
- export abstract class Service<ApiResponse = any> {
32
- constructor(
33
- protected client: AxiosInstance,
34
- // opt to use options object here, so we could
35
- // define the config property as a getter
36
- // in RotaCloud class. With this change config in
37
- // this class will always be up-to-date with
38
- // RotaCloud client config
39
- protected readonly options: { config: SDKConfig },
40
- ) {}
41
-
42
- private isLeaveRequest(endpoint?: string): boolean {
43
- return endpoint === '/leave_requests';
44
- }
45
-
46
- private buildQueryParams<T = ApiResponse>(
47
- options?: OptionsExtended<T>,
48
- extraParams?: Record<string, ParameterValue>,
49
- ) {
50
- const queryParams: Record<string, ParameterValue> = {
51
- fields: options?.fields,
52
- limit: options?.maxResults ?? options?.limit,
53
- offset: options?.offset,
54
- dry_run: options?.dryRun,
55
- ...extraParams,
56
- // NOTE: Should not overridable so must come after spread of params
57
- exclude_link_header: true,
58
- };
59
- const reducedParams = Object.entries(queryParams ?? {}).reduce((params, [key, val]) => {
60
- if (val !== undefined && val !== '') {
61
- if (Array.isArray(val)) params.push(...val.map((item) => [`${key}[]`, String(item)]));
62
- else params.push([key, String(val)]);
63
- }
64
- return params;
65
- }, [] as string[][]);
66
-
67
- return new URLSearchParams(reducedParams);
68
- }
69
-
70
- fetch<T = ApiResponse>(reqConfig: AxiosRequestConfig): Promise<AxiosResponse<T>>;
71
- fetch<T = ApiResponse>(
72
- reqConfig: AxiosRequestConfig,
73
- options: { fields: Required<OptionsExtended<T>>['fields'] } & OptionsExtended<T>,
74
- ): Promise<AxiosResponse<Pick<T, (typeof options)['fields'][number]>>>;
75
- fetch<T extends unknown[] = ApiResponse[], E = T[number]>(
76
- reqConfig: AxiosRequestConfig,
77
- options: { fields: Required<OptionsExtended<E>>['fields'] } & OptionsExtended<E>,
78
- ): Promise<AxiosResponse<Pick<E, (typeof options)['fields'][number]>[]>>;
79
- fetch<T extends unknown[] = ApiResponse[]>(
80
- reqConfig: AxiosRequestConfig,
81
- options?: Options,
82
- ): Promise<AxiosResponse<T>>;
83
- fetch<T = ApiResponse>(reqConfig: AxiosRequestConfig, options?: Options): Promise<AxiosResponse<T | Partial<T>>>;
84
- fetch<T = ApiResponse>(reqConfig: AxiosRequestConfig, options?: Options) {
85
- const headers: Record<string, string> = {
86
- Authorization: this.options.config.apiKey
87
- ? `Bearer ${this.options.config.apiKey}`
88
- : `Basic ${this.options.config.basicAuth}`,
89
- 'SDK-Version': Version.version,
90
- };
91
-
92
- const extraHeaders = this.options.config.headers;
93
- if (extraHeaders && typeof extraHeaders === 'object') {
94
- for (const [key, val] of Object.entries(extraHeaders)) {
95
- if (typeof key === 'string' && typeof val === 'string') {
96
- headers[key] = val;
97
- }
98
- }
99
- }
100
-
101
- if (this.options.config.accountId) {
102
- headers.Account = String(this.options.config.accountId);
103
- } else {
104
- // need to convert user field in payload to a header for creating leave_requests when using an API key
105
- this.isLeaveRequest(reqConfig.url) ? (headers.User = `${reqConfig.data.user}`) : undefined;
106
- }
107
-
108
- const finalReqConfig: AxiosRequestConfig<T> = {
109
- ...reqConfig,
110
- baseURL: this.options.config.baseUri,
111
- headers,
112
- params: this.buildQueryParams(options, reqConfig.params),
113
- };
114
-
115
- return this.client.request<T>(finalReqConfig);
116
- }
117
-
118
- /** Iterates through every page for a potentially paginated request */
119
- private fetchPages<T = ApiResponse>(
120
- reqConfig: AxiosRequestConfig<T[]>,
121
- options: { fields: Required<OptionsExtended<T>>['fields'] } & OptionsExtended<T>,
122
- ): AsyncGenerator<AxiosResponse<Pick<T, (typeof options)['fields'][number]>[]>>;
123
- private fetchPages<T = ApiResponse>(
124
- reqConfig: AxiosRequestConfig<T[]>,
125
- options?: Options,
126
- ): AsyncGenerator<AxiosResponse<T[]>>;
127
- private async *fetchPages<T = ApiResponse>(
128
- reqConfig: AxiosRequestConfig<T[]>,
129
- options?: Options,
130
- ): AsyncGenerator<AxiosResponse<T[]>> {
131
- const fallbackLimit = 20;
132
- const res = await this.fetch<T[]>(reqConfig, options);
133
- yield res;
134
-
135
- const limit = Number(res.headers['x-limit']) || fallbackLimit;
136
- const entityCount = Number(res.headers['x-total-count']) || 0;
137
- const requestOffset = Number(res.headers['x-offset']) || 0;
138
-
139
- for (let offset = requestOffset + limit; offset < entityCount; offset += limit) {
140
- yield this.fetch<T[]>(reqConfig, { ...options, offset });
141
- }
142
- }
143
-
144
- private async *listResponses<T = ApiResponse>(reqConfig: AxiosRequestConfig<T[]>, options?: Options) {
145
- if (!options?.maxResults) {
146
- for await (const res of this.fetchPages<T>(reqConfig, options)) {
147
- yield* res.data;
148
- }
149
- return;
150
- }
151
-
152
- let entityCount = 0;
153
- for await (const res of this.fetchPages<T>(reqConfig, options)) {
154
- for (const entity of res.data) {
155
- yield entity;
156
- entityCount += 1;
157
- if (entityCount >= options.maxResults) return;
158
- }
159
- }
160
- }
161
-
162
- iterator<T = ApiResponse>(reqConfig: AxiosRequestConfig<T[]>, options?: Options) {
163
- return {
164
- [Symbol.asyncIterator]: () => this.listResponses<T>(reqConfig, options),
165
- byPage: () => this.fetchPages<T>(reqConfig, options),
166
- };
167
- }
168
- }
@@ -1,19 +0,0 @@
1
- import { AxiosResponse } from 'axios';
2
- import { Service, Options } from './index.js';
3
-
4
- import { Settings } from '../interfaces/index.js';
5
-
6
- import { SettingsQueryParams } from '../rotacloud.js';
7
-
8
- export class SettingsService extends Service<Settings> {
9
- private apiPath = '/settings';
10
-
11
- get(query: SettingsQueryParams): Promise<Settings>;
12
- get(query: SettingsQueryParams, options: { rawResponse: true } & Options): Promise<AxiosResponse<Settings, any>>;
13
- get(query: SettingsQueryParams, options: Options): Promise<Settings>;
14
- get(query: SettingsQueryParams, options?: Options) {
15
- return super
16
- .fetch<Settings>({ url: `${this.apiPath}`, params: query }, options)
17
- .then((res) => (options?.rawResponse ? res : res.data));
18
- }
19
- }
@@ -1,200 +0,0 @@
1
- import { AxiosRequestConfig, AxiosResponse } from 'axios';
2
- import { Shift } from '../interfaces/index.js';
3
- import { Options, OptionsExtended, RequirementsOf, Service } from './index.js';
4
-
5
- import { ShiftDropRequest } from '../interfaces/drop-request.interface.js';
6
- import { ShiftsQueryParams } from '../interfaces/query-params/shifts-query-params.interface.js';
7
- import { ShiftSwapRequest } from '../interfaces/swap-request.interface.js';
8
-
9
- type RequiredProps = 'end_time' | 'start_time' | 'location';
10
-
11
- export class ShiftsService extends Service<Shift> {
12
- private apiPath = '/shifts';
13
-
14
- create(data: RequirementsOf<Shift, RequiredProps>): Promise<Shift>;
15
- create(
16
- data: RequirementsOf<Shift, RequiredProps>,
17
- options: { rawResponse: true } & Options,
18
- ): Promise<AxiosResponse<Shift, any>>;
19
- create(data: RequirementsOf<Shift, RequiredProps>, options: Options): Promise<Shift>;
20
- create(data: RequirementsOf<Shift, RequiredProps>, options?: Options) {
21
- return super
22
- .fetch<Shift>({ url: this.apiPath, data, method: 'POST' }, options)
23
- .then((res) => (options?.rawResponse ? res : res.data));
24
- }
25
-
26
- get(id: number): Promise<Shift>;
27
- get<F extends keyof Shift>(
28
- id: number,
29
- options: { fields: F[]; rawResponse: true } & OptionsExtended<Shift>,
30
- ): Promise<AxiosResponse<Pick<Shift, F>>>;
31
- get<F extends keyof Shift>(id: number, options: { fields: F[] } & OptionsExtended<Shift>): Promise<Pick<Shift, F>>;
32
- get(id: number, options: { rawResponse: true } & Options): Promise<AxiosResponse<Shift>>;
33
- get(id: number, options?: OptionsExtended<Shift>): Promise<Shift>;
34
- get(id: number, options?: OptionsExtended<Shift>) {
35
- return super
36
- .fetch<Shift>({ url: `${this.apiPath}/${id}` }, options)
37
- .then((res) => (options?.rawResponse ? res : res.data));
38
- }
39
-
40
- list(query: ShiftsQueryParams): AsyncGenerator<Shift>;
41
- list<F extends keyof Shift>(
42
- query: ShiftsQueryParams,
43
- options: { fields: F[] } & OptionsExtended<Shift>,
44
- ): AsyncGenerator<Pick<Shift, F>>;
45
- list(query: ShiftsQueryParams, options?: OptionsExtended<Shift>): AsyncGenerator<Shift>;
46
- async *list(query: ShiftsQueryParams, options?: OptionsExtended<Shift>) {
47
- yield* super.iterator({ url: this.apiPath, params: query }, options);
48
- }
49
-
50
- listAll(query: ShiftsQueryParams): Promise<Shift[]>;
51
- listAll<F extends keyof Shift>(
52
- query: ShiftsQueryParams,
53
- options: { fields: F[] } & OptionsExtended<Shift>,
54
- ): Promise<Pick<Shift, F>[]>;
55
- listAll(query: ShiftsQueryParams, options?: OptionsExtended<Shift>): Promise<Shift[]>;
56
- async listAll(query: ShiftsQueryParams, options?: OptionsExtended<Shift>) {
57
- const shifts = [] as Shift[];
58
- for await (const shift of this.list(query, options)) {
59
- shifts.push(shift);
60
- }
61
- return shifts;
62
- }
63
-
64
- listByPage(query: ShiftsQueryParams): AsyncGenerator<AxiosResponse<Shift[]>>;
65
- listByPage<F extends keyof Shift>(
66
- query: ShiftsQueryParams,
67
- options: { fields: F[] } & OptionsExtended<Shift>,
68
- ): AsyncGenerator<AxiosResponse<Pick<Shift, F>[]>>;
69
- listByPage(query: ShiftsQueryParams, options?: OptionsExtended<Shift>): AsyncGenerator<AxiosResponse<Shift[]>>;
70
- listByPage(query: ShiftsQueryParams, options?: OptionsExtended<Shift>) {
71
- return super.iterator<Shift>({ url: this.apiPath, params: query }, options).byPage();
72
- }
73
-
74
- update(shift: RequirementsOf<Shift, 'id'>): Promise<Shift>;
75
- update(shift: RequirementsOf<Shift, 'id'>, options: { rawResponse: true } & Options): Promise<AxiosResponse<Shift>>;
76
- update(shift: RequirementsOf<Shift, 'id'>, options: Options): Promise<Shift>;
77
- update(shifts: RequirementsOf<Shift, 'id'>[]): Promise<{ success: Shift[]; failed: { id: number; error: string }[] }>;
78
- update(
79
- shifts: RequirementsOf<Shift, 'id'>[],
80
- options: { rawResponse: true } & Options,
81
- ): Promise<AxiosResponse<{ code: number; data?: Shift; error?: string }[]>>;
82
- update(
83
- shifts: RequirementsOf<Shift, 'id'>[],
84
- options: Options,
85
- ): Promise<{ success: Shift[]; failed: { id: number; error: string }[] }>;
86
- update(shifts: RequirementsOf<Shift, 'id'> | RequirementsOf<Shift, 'id'>[], options?: Options) {
87
- if (!Array.isArray(shifts)) {
88
- return super
89
- .fetch<Shift>(
90
- {
91
- url: `${this.apiPath}/${shifts.id}`,
92
- data: shifts,
93
- method: 'POST',
94
- },
95
- options,
96
- )
97
- .then((res) => (options?.rawResponse ? res : res.data));
98
- }
99
-
100
- return super
101
- .fetch<{ code: number; data?: Shift; error?: string }[]>(
102
- {
103
- url: this.apiPath,
104
- data: shifts,
105
- method: 'POST',
106
- },
107
- options,
108
- )
109
- .then((res) => {
110
- if (options?.rawResponse) return res;
111
-
112
- const success: Shift[] = [];
113
- const failed: { id: number; error: string }[] = [];
114
- for (let shiftIdx = 0; shiftIdx < res.data.length; shiftIdx += 1) {
115
- const { data, error } = res.data[shiftIdx];
116
- if (data) success.push(data);
117
- if (error) failed.push({ id: shifts[shiftIdx].id, error });
118
- }
119
- return { success, failed };
120
- });
121
- }
122
-
123
- delete(ids: number | number[]): Promise<number>;
124
- delete(ids: number | number[], options: { rawResponse: true } & Options): Promise<AxiosResponse<void>>;
125
- delete(ids: number | number[], options: Options): Promise<number>;
126
- delete(ids: number | number[], options?: Options) {
127
- const params: AxiosRequestConfig = Array.isArray(ids)
128
- ? { url: this.apiPath, data: { ids }, method: 'DELETE' }
129
- : { url: `${this.apiPath}/${ids}`, method: 'DELETE' };
130
-
131
- return super.fetch<void>(params, options).then((res) => (options?.rawResponse ? res : res.status));
132
- }
133
-
134
- acknowledge(shifts: number[]): Promise<number>;
135
- acknowledge(shifts: number[], options: { rawResponse: true } & Options): Promise<AxiosResponse<any>>;
136
- acknowledge(shifts: number[], options: Options): Promise<number>;
137
- acknowledge(shifts: number[], options?: Options) {
138
- return super
139
- .fetch<Shift>({ url: '/shifts_acknowledged', data: { shifts }, method: 'POST' }, options)
140
- .then((res) => (options?.rawResponse ? res : res.status));
141
- }
142
-
143
- publish(data: { shifts: number[] }): Promise<number>;
144
- publish(data: { shifts: number[] }, options: { rawResponse: true } & Options): Promise<AxiosResponse<any>>;
145
- publish(data: { shifts: number[] }, options: Options): Promise<number>;
146
- publish(data: { shifts: number[] }, options?: Options) {
147
- return super
148
- .fetch<Shift>({ url: '/shifts_published', data, method: 'POST' }, options)
149
- .then((res) => (options?.rawResponse ? res : res.status));
150
- }
151
-
152
- unpublish(data: { shifts: number[] }): Promise<number>;
153
- unpublish(data: { shifts: number[] }, options: { rawResponse: true } & Options): Promise<AxiosResponse<any>>;
154
- unpublish(data: { shifts: number[] }, options: Options): Promise<number>;
155
- unpublish(data: { shifts: number[] }, options?: Options) {
156
- return super
157
- .fetch<Shift>({ url: '/shifts_published', data, method: 'DELETE' }, options)
158
- .then((res) => (options?.rawResponse ? res : res.status));
159
- }
160
-
161
- updateSwap(data: ShiftSwapRequest): Promise<ShiftSwapRequest>;
162
- updateSwap(
163
- data: ShiftSwapRequest,
164
- options: { rawResponse: true } & Options,
165
- ): Promise<AxiosResponse<ShiftSwapRequest>>;
166
- updateSwap(data: ShiftSwapRequest, options: Options): Promise<ShiftSwapRequest>;
167
- updateSwap(data: ShiftSwapRequest, options?: Options) {
168
- return super
169
- .fetch<Shift>({ url: `/swap_requests/${data.id}`, data, method: 'POST' }, options)
170
- .then((res) => (options?.rawResponse ? res : res.data));
171
- }
172
-
173
- updateDrop(data: {
174
- request: RequirementsOf<ShiftDropRequest, 'id' | 'user_message'>;
175
- approved: boolean;
176
- }): Promise<ShiftDropRequest>;
177
- updateDrop(
178
- data: { request: RequirementsOf<ShiftDropRequest, 'id' | 'user_message'>; approved: boolean },
179
- options: { rawResponse: true } & Options,
180
- ): Promise<AxiosResponse<ShiftDropRequest>>;
181
- updateDrop(
182
- data: { request: RequirementsOf<ShiftDropRequest, 'id' | 'user_message'>; approved: boolean },
183
- options: Options,
184
- ): Promise<ShiftDropRequest>;
185
- updateDrop(
186
- data: { request: RequirementsOf<ShiftDropRequest, 'id' | 'user_message'>; approved: boolean },
187
- options?: Options,
188
- ) {
189
- return super
190
- .fetch<Shift>(
191
- {
192
- url: `/unavailability_requests/${data.request.id}/${data.approved ? 'approve' : 'deny'}`,
193
- data: { message: data.request.user_message },
194
- method: 'POST',
195
- },
196
- options,
197
- )
198
- .then((res) => (options?.rawResponse ? res : res.data));
199
- }
200
- }
@@ -1,85 +0,0 @@
1
- import { AxiosResponse } from 'axios';
2
- import { Terminal, TerminalLocation } from '../interfaces/index.js';
3
- import { Service, Options, OptionsExtended } from './index.js';
4
-
5
- interface LaunchTerminal {
6
- terminal: number;
7
- device: string;
8
- location?: TerminalLocation;
9
- }
10
-
11
- interface PingTerminal {
12
- action: string;
13
- device: string;
14
- }
15
-
16
- export class TerminalsActiveService extends Service<Terminal> {
17
- private apiPath = '/terminals_active';
18
-
19
- launchTerminal(data: LaunchTerminal): Promise<Terminal>;
20
- launchTerminal(data: LaunchTerminal, options: { rawResponse: true } & Options): Promise<AxiosResponse<Terminal>>;
21
- launchTerminal(data: LaunchTerminal, options: Options): Promise<Terminal>;
22
- launchTerminal(data: LaunchTerminal, options?: Options) {
23
- return super
24
- .fetch<Terminal>(
25
- {
26
- url: this.apiPath,
27
- data,
28
- method: 'POST',
29
- },
30
- options,
31
- )
32
- .then((res) => (options?.rawResponse ? res : res.data));
33
- }
34
-
35
- pingTerminal(id: number, data: PingTerminal): Promise<number>;
36
- pingTerminal(
37
- id: number,
38
- data: PingTerminal,
39
- options: { rawResponse: true } & Options,
40
- ): Promise<AxiosResponse<number>>;
41
- pingTerminal(id: number, data: PingTerminal, options: Options): Promise<number>;
42
- pingTerminal(id: number, data: PingTerminal, options?: Options) {
43
- return super
44
- .fetch<number>({ url: `${this.apiPath}/${id}`, data, method: 'POST' }, options)
45
- .then((res) => (options?.rawResponse ? res : res.data));
46
- }
47
-
48
- list(): AsyncGenerator<Terminal>;
49
- list<F extends keyof Terminal>(
50
- options: { fields: F[] } & OptionsExtended<Terminal>,
51
- ): AsyncGenerator<Pick<Terminal, F>>;
52
- list(options?: OptionsExtended<Terminal>): AsyncGenerator<Terminal>;
53
- async *list(options?: OptionsExtended<Terminal>) {
54
- yield* super.iterator({ url: this.apiPath }, options);
55
- }
56
-
57
- listAll(): Promise<Terminal[]>;
58
- listAll<F extends keyof Terminal>(options: { fields: F[] } & OptionsExtended<Terminal>): Promise<Pick<Terminal, F>[]>;
59
- listAll(options?: OptionsExtended<Terminal>): Promise<Terminal[]>;
60
- async listAll(options?: OptionsExtended<Terminal>) {
61
- const users = [] as Terminal[];
62
- for await (const user of this.list(options)) {
63
- users.push(user);
64
- }
65
- return users;
66
- }
67
-
68
- listByPage(): AsyncGenerator<AxiosResponse<Terminal[]>>;
69
- listByPage<F extends keyof Terminal>(
70
- options: { fields: F[] } & OptionsExtended<Terminal>,
71
- ): AsyncGenerator<AxiosResponse<Pick<Terminal, F>[]>>;
72
- listByPage(options?: OptionsExtended<Terminal>): AsyncGenerator<AxiosResponse<Terminal[]>>;
73
- listByPage(options?: OptionsExtended<Terminal>) {
74
- return super.iterator({ url: this.apiPath }, options).byPage();
75
- }
76
-
77
- closeTerminal(id: number): Promise<number>;
78
- closeTerminal(id: number, options: { rawResponse: true } & Options): Promise<AxiosResponse<void>>;
79
- closeTerminal(id: number, options: Options): Promise<number>;
80
- closeTerminal(id: number, options?: Options) {
81
- return super
82
- .fetch<void>({ url: `${this.apiPath}/${id}`, method: 'DELETE' }, options)
83
- .then((res) => (options?.rawResponse ? res : res.status));
84
- }
85
- }
@@ -1,93 +0,0 @@
1
- import { AxiosResponse } from 'axios';
2
- import { Terminal } from '../interfaces/index.js';
3
- import { Service, Options, RequirementsOf, OptionsExtended } from './index.js';
4
-
5
- type RequiredProps = 'name' | 'timezone';
6
-
7
- export class TerminalsService extends Service<Terminal> {
8
- private apiPath = '/terminals';
9
-
10
- create(data: RequirementsOf<Terminal, RequiredProps>): Promise<Terminal>;
11
- create(
12
- data: RequirementsOf<Terminal, RequiredProps>,
13
- options: { rawResponse: true } & Options,
14
- ): Promise<AxiosResponse<Terminal, any>>;
15
- create(data: RequirementsOf<Terminal, RequiredProps>, options: Options): Promise<Terminal>;
16
- create(data: RequirementsOf<Terminal, RequiredProps>, options?: Options) {
17
- return super
18
- .fetch<Terminal>({ url: this.apiPath, data, method: 'POST' })
19
- .then((res) => (options?.rawResponse ? res : res.data));
20
- }
21
-
22
- get(id: number): Promise<Terminal>;
23
- get<F extends keyof Terminal>(
24
- id: number,
25
- options: { fields: F[]; rawResponse: true } & OptionsExtended<Terminal>,
26
- ): Promise<AxiosResponse<Pick<Terminal, F>>>;
27
- get<F extends keyof Terminal>(
28
- id: number,
29
- options: { fields: F[] } & OptionsExtended<Terminal>,
30
- ): Promise<Pick<Terminal, F>>;
31
- get(id: number, options: { rawResponse: true } & Options): Promise<AxiosResponse<Terminal>>;
32
- get(id: number, options?: OptionsExtended<Terminal>): Promise<Terminal>;
33
- get(id: number, options?: Options) {
34
- return super
35
- .fetch<Terminal>({ url: `${this.apiPath}/${id}` }, options)
36
- .then((res) => (options?.rawResponse ? res : res.data));
37
- }
38
-
39
- update(id: number, data: Partial<Terminal>): Promise<Terminal>;
40
- update(
41
- id: number,
42
- data: Partial<Terminal>,
43
- options: { rawResponse: true } & Options,
44
- ): Promise<AxiosResponse<Terminal, any>>;
45
- update(id: number, data: Partial<Terminal>, options: Options): Promise<Terminal>;
46
- update(id: number, data: Partial<Terminal>, options?: Options) {
47
- return super
48
- .fetch<Terminal>({
49
- url: `${this.apiPath}/${id}`,
50
- data,
51
- method: 'POST',
52
- })
53
- .then((res) => (options?.rawResponse ? res : res.data));
54
- }
55
-
56
- closeTerminal(id: number): Promise<number>;
57
- closeTerminal(id: number, options: { rawResponse: true } & Options): Promise<AxiosResponse<void>>;
58
- closeTerminal(id: number, options: Options): Promise<number>;
59
- closeTerminal(id: number, options?: Options) {
60
- return super
61
- .fetch<void>({ url: `${this.apiPath}/${id}`, method: 'DELETE' })
62
- .then((res) => (options?.rawResponse ? res : res.status));
63
- }
64
-
65
- list(): AsyncGenerator<Terminal>;
66
- list<F extends keyof Terminal>(
67
- options: { fields: F[] } & OptionsExtended<Terminal>,
68
- ): AsyncGenerator<Pick<Terminal, F>>;
69
- list(options?: OptionsExtended<Terminal>): AsyncGenerator<Terminal>;
70
- async *list(options?: OptionsExtended<Terminal>) {
71
- yield* super.iterator({ url: this.apiPath }, options);
72
- }
73
-
74
- listAll(): Promise<Terminal[]>;
75
- listAll<F extends keyof Terminal>(options: { fields: F[] } & OptionsExtended<Terminal>): Promise<Pick<Terminal, F>[]>;
76
- listAll(options?: OptionsExtended<Terminal>): Promise<Terminal[]>;
77
- async listAll(options?: OptionsExtended<Terminal>) {
78
- const users = [] as Terminal[];
79
- for await (const user of this.list(options)) {
80
- users.push(user);
81
- }
82
- return users;
83
- }
84
-
85
- listByPage(): AsyncGenerator<AxiosResponse<Terminal[]>>;
86
- listByPage<F extends keyof Terminal>(
87
- options: { fields: F[] } & OptionsExtended<Terminal>,
88
- ): AsyncGenerator<AxiosResponse<Pick<Terminal, F>[]>>;
89
- listByPage(options?: OptionsExtended<Terminal>): AsyncGenerator<AxiosResponse<Terminal[]>>;
90
- listByPage(options?: OptionsExtended<Terminal>) {
91
- return super.iterator({ url: this.apiPath }, options).byPage();
92
- }
93
- }