rotacloud 1.5.2 → 2.0.1

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,44 +0,0 @@
1
- import { Service } from './index.js';
2
- export class TerminalsService extends Service {
3
- constructor() {
4
- super(...arguments);
5
- this.apiPath = '/terminals';
6
- }
7
- create(data, options) {
8
- return super
9
- .fetch({ url: this.apiPath, data, method: 'POST' })
10
- .then((res) => (options?.rawResponse ? res : res.data));
11
- }
12
- get(id, options) {
13
- return super
14
- .fetch({ url: `${this.apiPath}/${id}` }, options)
15
- .then((res) => (options?.rawResponse ? res : res.data));
16
- }
17
- update(id, data, options) {
18
- return super
19
- .fetch({
20
- url: `${this.apiPath}/${id}`,
21
- data,
22
- method: 'POST',
23
- })
24
- .then((res) => (options?.rawResponse ? res : res.data));
25
- }
26
- closeTerminal(id, options) {
27
- return super
28
- .fetch({ url: `${this.apiPath}/${id}`, method: 'DELETE' })
29
- .then((res) => (options?.rawResponse ? res : res.status));
30
- }
31
- async *list(options) {
32
- yield* super.iterator({ url: this.apiPath }, options);
33
- }
34
- async listAll(options) {
35
- const users = [];
36
- for await (const user of this.list(options)) {
37
- users.push(user);
38
- }
39
- return users;
40
- }
41
- listByPage(options) {
42
- return super.iterator({ url: this.apiPath }, options).byPage();
43
- }
44
- }
@@ -1,14 +0,0 @@
1
- import { AxiosResponse } from 'axios';
2
- import { Service, Options } from './index.js';
3
- import { TimeZone } from '../interfaces/index.js';
4
- export declare class TimeZoneService extends Service<TimeZone> {
5
- private apiPath;
6
- get(id: number): Promise<TimeZone>;
7
- get(id: number, options: {
8
- rawResponse: true;
9
- } & Options): Promise<AxiosResponse<TimeZone, any>>;
10
- get(id: number, options: Options): Promise<TimeZone>;
11
- list(options?: Options): AsyncGenerator<TimeZone, void, undefined>;
12
- listAll(options?: Options): Promise<TimeZone[]>;
13
- listByPage(options?: Options): AsyncGenerator<AxiosResponse<TimeZone[], any>, any, unknown>;
14
- }
@@ -1,25 +0,0 @@
1
- import { Service } from './index.js';
2
- export class TimeZoneService extends Service {
3
- constructor() {
4
- super(...arguments);
5
- this.apiPath = '/timezones';
6
- }
7
- get(id, options) {
8
- return super
9
- .fetch({ url: `${this.apiPath}/${id}` }, options)
10
- .then((res) => (options?.rawResponse ? res : res.data));
11
- }
12
- async *list(options) {
13
- yield* super.iterator({ url: this.apiPath }, options);
14
- }
15
- async listAll(options) {
16
- const timezones = [];
17
- for await (const timezone of this.list(options)) {
18
- timezones.push(timezone);
19
- }
20
- return timezones;
21
- }
22
- listByPage(options) {
23
- return super.iterator({ url: this.apiPath }, options).byPage();
24
- }
25
- }
@@ -1,27 +0,0 @@
1
- import { AxiosResponse } from 'axios';
2
- import { Options, RequirementsOf, Service } from './service.js';
3
- import { ToilAccrualsQueryParams } from '../interfaces/query-params/toil-accruals-query-params.interface.js';
4
- import { ToilAccrual } from '../interfaces/toil-accrual.interface.js';
5
- type RequiredProps = 'duration_hours' | 'leave_year' | 'user_id';
6
- export declare class ToilAccrualsService extends Service {
7
- private apiPath;
8
- create(data: RequirementsOf<ToilAccrual, RequiredProps>): Promise<ToilAccrual>;
9
- create(data: RequirementsOf<ToilAccrual, RequiredProps>, options: {
10
- rawResponse: true;
11
- } & Options): Promise<AxiosResponse<ToilAccrual, any>>;
12
- create(data: RequirementsOf<ToilAccrual, RequiredProps>, options: Options): Promise<ToilAccrual>;
13
- get(id: number): Promise<ToilAccrual>;
14
- get(id: number, options: {
15
- rawResponse: true;
16
- } & Options): Promise<AxiosResponse<ToilAccrual, any>>;
17
- get(id: number, options: Options): Promise<ToilAccrual>;
18
- list(query?: ToilAccrualsQueryParams, options?: Options): AsyncGenerator<ToilAccrual, void, undefined>;
19
- listAll(query?: ToilAccrualsQueryParams, options?: Options): Promise<ToilAccrual[]>;
20
- listByPage(query?: ToilAccrualsQueryParams, options?: Options): AsyncGenerator<AxiosResponse<ToilAccrual[], any>, any, unknown>;
21
- delete(id: number): Promise<number>;
22
- delete(id: number, options: {
23
- rawResponse: true;
24
- } & Options): Promise<AxiosResponse<void>>;
25
- delete(id: number, options: Options): Promise<number>;
26
- }
27
- export {};
@@ -1,35 +0,0 @@
1
- import { Service } from './service.js';
2
- export class ToilAccrualsService extends Service {
3
- constructor() {
4
- super(...arguments);
5
- this.apiPath = '/toil_accruals';
6
- }
7
- create(data, options) {
8
- return super
9
- .fetch({ url: this.apiPath, data, method: 'POST' })
10
- .then((res) => (options?.rawResponse ? res : res.data));
11
- }
12
- get(id, options) {
13
- return super
14
- .fetch({ url: `${this.apiPath}/${id}` }, options)
15
- .then((res) => (options?.rawResponse ? res : res.data));
16
- }
17
- async *list(query, options) {
18
- yield* super.iterator({ url: this.apiPath, params: query }, options);
19
- }
20
- async listAll(query, options) {
21
- const toilAccruals = [];
22
- for await (const accrual of this.list(query, options)) {
23
- toilAccruals.push(accrual);
24
- }
25
- return toilAccruals;
26
- }
27
- listByPage(query, options) {
28
- return super.iterator({ url: this.apiPath, params: query }, options).byPage();
29
- }
30
- delete(id, options) {
31
- return super
32
- .fetch({ url: `${this.apiPath}/${id}`, method: 'DELETE' })
33
- .then((res) => (options?.rawResponse ? res : res.status));
34
- }
35
- }
@@ -1,9 +0,0 @@
1
- import { Options, Service } from './service.js';
2
- import { ToilAllowanceQueryParams } from '../interfaces/query-params/toil-allowance-query-params.interface.js';
3
- import { ToilAllowance } from '../interfaces/toil-allowance.interface.js';
4
- export declare class ToilAllowanceService extends Service<ToilAllowance> {
5
- private apiPath;
6
- list(year: number, query: ToilAllowanceQueryParams, options?: Options): AsyncGenerator<ToilAllowance, void, undefined>;
7
- listAll(year: number, query: ToilAllowanceQueryParams, options?: Options): Promise<ToilAllowance[]>;
8
- listByPage(year: number, query: ToilAllowanceQueryParams, options?: Options): AsyncGenerator<import("axios").AxiosResponse<ToilAllowance[], any>, any, unknown>;
9
- }
@@ -1,20 +0,0 @@
1
- import { Service } from './service.js';
2
- export class ToilAllowanceService extends Service {
3
- constructor() {
4
- super(...arguments);
5
- this.apiPath = '/toil_allowance';
6
- }
7
- async *list(year, query, options) {
8
- yield* super.iterator({ url: `${this.apiPath}/${year}`, params: query }, options);
9
- }
10
- async listAll(year, query, options) {
11
- const toilAllowances = [];
12
- for await (const allowance of this.list(year, query, options)) {
13
- toilAllowances.push(allowance);
14
- }
15
- return toilAllowances;
16
- }
17
- listByPage(year, query, options) {
18
- return super.iterator({ url: `${this.apiPath}/${year}`, params: query }, options).byPage();
19
- }
20
- }
@@ -1,66 +0,0 @@
1
- import { AxiosResponse } from 'axios';
2
- import { UserBreak, UserClockedIn, UserClockedOut, TerminalLocation } from '../interfaces/index.js';
3
- import { Service, Options, RequirementsOf, OptionsExtended } from './index.js';
4
- interface UserClockIn {
5
- method: string;
6
- shift: number;
7
- terminal?: number;
8
- user: number;
9
- photo?: string;
10
- location?: TerminalLocation;
11
- }
12
- interface UserClockOut extends Omit<UserClockIn, 'user' | 'shift'> {
13
- }
14
- interface UserBreakRequest {
15
- method: string;
16
- action: string;
17
- terminal: number;
18
- photo?: string;
19
- location: TerminalLocation;
20
- }
21
- type RequiredPropsClockIn = 'method';
22
- type RequiredPropsBreak = 'method' | 'action';
23
- export declare class UsersClockInService extends Service<UserClockedIn> {
24
- private apiPath;
25
- getClockedInUser(id: number): Promise<UserClockedIn>;
26
- getClockedInUser(id: number, options: {
27
- rawResponse: true;
28
- } & Options): Promise<AxiosResponse<UserClockedIn>>;
29
- getClockedInUser(id: number, options: Options): Promise<UserClockedIn>;
30
- list(): AsyncGenerator<UserClockedIn>;
31
- list<F extends keyof UserClockedIn>(options: {
32
- fields: F[];
33
- } & OptionsExtended<UserClockedIn>): AsyncGenerator<Pick<UserClockedIn, F>>;
34
- list(options?: OptionsExtended<UserClockedIn>): AsyncGenerator<UserClockedIn>;
35
- listAll(): Promise<UserClockedIn[]>;
36
- listAll<F extends keyof UserClockedIn>(options: {
37
- fields: F[];
38
- } & OptionsExtended<UserClockedIn>): Promise<Pick<UserClockedIn, F>[]>;
39
- listAll(options?: OptionsExtended<UserClockedIn>): Promise<UserClockedIn[]>;
40
- listByPage(): AsyncGenerator<AxiosResponse<UserClockedIn[]>>;
41
- listByPage<F extends keyof UserClockedIn>(options: {
42
- fields: F[];
43
- } & OptionsExtended<UserClockedIn>): AsyncGenerator<AxiosResponse<Pick<UserClockedIn, F>[]>>;
44
- listByPage(options?: OptionsExtended<UserClockedIn>): AsyncGenerator<AxiosResponse<UserClockedIn[]>>;
45
- clockIn(data: RequirementsOf<UserClockIn, RequiredPropsClockIn>): Promise<UserClockedIn>;
46
- clockIn(data: RequirementsOf<UserClockIn, RequiredPropsClockIn>, options: {
47
- rawResponse: true;
48
- } & Options): Promise<AxiosResponse<UserClockedIn>>;
49
- clockIn(data: RequirementsOf<UserClockIn, RequiredPropsClockIn>, options: Options): Promise<UserClockedIn>;
50
- clockOut(id: number, data: UserClockOut): Promise<UserClockedOut>;
51
- clockOut(id: number, data: UserClockOut, options: {
52
- rawResponse: true;
53
- } & Options): Promise<AxiosResponse<UserClockedOut>>;
54
- clockOut(id: number, data: UserClockOut, options: Options): Promise<UserClockedOut>;
55
- startBreak(id: number, data: RequirementsOf<UserBreakRequest, RequiredPropsBreak>): Promise<UserBreak>;
56
- startBreak(id: number, data: RequirementsOf<UserBreakRequest, RequiredPropsBreak>, options: {
57
- rawResponse: true;
58
- } & Options): Promise<AxiosResponse<UserBreak>>;
59
- startBreak(id: number, data: RequirementsOf<UserBreakRequest, RequiredPropsBreak>, options: Options): Promise<UserBreak>;
60
- endBreak(id: number, data: RequirementsOf<UserBreakRequest, RequiredPropsBreak>): Promise<UserBreak>;
61
- endBreak(id: number, data: RequirementsOf<UserBreakRequest, RequiredPropsBreak>, options: {
62
- rawResponse: true;
63
- } & Options): Promise<AxiosResponse<UserBreak>>;
64
- endBreak(id: number, data: RequirementsOf<UserBreakRequest, RequiredPropsBreak>, options: Options): Promise<UserBreak>;
65
- }
66
- export {};
@@ -1,47 +0,0 @@
1
- import { Service } from './index.js';
2
- export class UsersClockInService extends Service {
3
- constructor() {
4
- super(...arguments);
5
- this.apiPath = '/users_clocked_in';
6
- }
7
- getClockedInUser(id, options) {
8
- return super
9
- .fetch({ url: `${this.apiPath}/${id}` }, options)
10
- .then((res) => (options?.rawResponse ? res : res.data));
11
- }
12
- async *list(options) {
13
- for await (const res of super.iterator({ url: this.apiPath }, options)) {
14
- yield res;
15
- }
16
- }
17
- async listAll(options) {
18
- const users = [];
19
- for await (const user of this.list(options)) {
20
- users.push(user);
21
- }
22
- return users;
23
- }
24
- listByPage(options) {
25
- return super.iterator({ url: this.apiPath }, options).byPage();
26
- }
27
- clockIn(data, options) {
28
- return super
29
- .fetch({ url: this.apiPath, data, method: 'POST' })
30
- .then((res) => (options?.rawResponse ? res : res.data));
31
- }
32
- clockOut(id, data, options) {
33
- return super
34
- .fetch({ url: `${this.apiPath}/${id}`, data, method: 'DELETE' })
35
- .then((res) => (options?.rawResponse ? res : res.data));
36
- }
37
- startBreak(id, data, options) {
38
- return super
39
- .fetch({ url: `${this.apiPath}/${id}`, data, method: 'POST' })
40
- .then((res) => (options?.rawResponse ? res : res.data));
41
- }
42
- endBreak(id, data, options) {
43
- return super
44
- .fetch({ url: `${this.apiPath}/${id}`, data, method: 'POST' })
45
- .then((res) => (options?.rawResponse ? res : res.data));
46
- }
47
- }
@@ -1,51 +0,0 @@
1
- import { AxiosResponse } from 'axios';
2
- import { User } from '../interfaces/index.js';
3
- import { Service, Options, RequirementsOf, OptionsExtended } from './index.js';
4
- import { UsersQueryParams } from '../interfaces/query-params/users-query-params.interface.js';
5
- type RequiredProps = 'first_name' | 'last_name';
6
- export declare class UsersService extends Service<User> {
7
- private apiPath;
8
- create(data: RequirementsOf<User, RequiredProps>): Promise<User>;
9
- create(data: RequirementsOf<User, RequiredProps>, options: {
10
- rawResponse: true;
11
- } & Options): Promise<AxiosResponse<User>>;
12
- create(data: RequirementsOf<User, RequiredProps>, options: Options): Promise<User>;
13
- get(id: number): Promise<User>;
14
- get<F extends keyof User>(id: number, options: {
15
- fields: F[];
16
- rawResponse: true;
17
- } & OptionsExtended<User>): Promise<AxiosResponse<Pick<User, F>>>;
18
- get<F extends keyof User>(id: number, options: {
19
- fields: F[];
20
- } & OptionsExtended<User>): Promise<Pick<User, F>>;
21
- get(id: number, options: {
22
- rawResponse: true;
23
- } & Options): Promise<AxiosResponse<User>>;
24
- get(id: number, options?: OptionsExtended<User>): Promise<User>;
25
- list(query?: UsersQueryParams): AsyncGenerator<User>;
26
- list<F extends keyof User>(query: UsersQueryParams, options: {
27
- fields: F[];
28
- } & OptionsExtended<User>): AsyncGenerator<Pick<User, F>>;
29
- list(query?: UsersQueryParams, options?: OptionsExtended<User>): AsyncGenerator<User>;
30
- listAll(query?: UsersQueryParams): Promise<User[]>;
31
- listAll<F extends keyof User>(query: UsersQueryParams, options: {
32
- fields: F[];
33
- } & OptionsExtended<User>): Promise<Pick<User, F>[]>;
34
- listAll(query?: UsersQueryParams, options?: OptionsExtended<User>): Promise<User[]>;
35
- listByPage(query?: UsersQueryParams): AsyncGenerator<AxiosResponse<User[]>>;
36
- listByPage<F extends keyof User>(query: UsersQueryParams, options: {
37
- fields: F[];
38
- } & OptionsExtended<User>): AsyncGenerator<AxiosResponse<Pick<User, F>[]>>;
39
- listByPage(query?: UsersQueryParams, options?: OptionsExtended<User>): AsyncGenerator<AxiosResponse<User[]>>;
40
- update(id: number, data: Partial<User>): Promise<User>;
41
- update(id: number, data: Partial<User>, options: {
42
- rawResponse: true;
43
- } & Options): Promise<AxiosResponse<User, any>>;
44
- update(id: number, data: Partial<User>, options: Options): Promise<User>;
45
- delete(id: number): Promise<number>;
46
- delete(id: number, options: {
47
- rawResponse: true;
48
- } & Options): Promise<AxiosResponse<void>>;
49
- delete(id: number, options: Options): Promise<number>;
50
- }
51
- export {};
@@ -1,44 +0,0 @@
1
- import { Service } from './index.js';
2
- export class UsersService extends Service {
3
- constructor() {
4
- super(...arguments);
5
- this.apiPath = '/users';
6
- }
7
- create(data, options) {
8
- return super
9
- .fetch({ url: this.apiPath, data, method: 'POST' }, options)
10
- .then((res) => (options?.rawResponse ? res : res.data));
11
- }
12
- get(id, options) {
13
- return super
14
- .fetch({ url: `${this.apiPath}/${id}` }, options)
15
- .then((res) => (options?.rawResponse ? res : res.data));
16
- }
17
- async *list(query, options) {
18
- yield* super.iterator({ url: this.apiPath, params: query }, options);
19
- }
20
- async listAll(query, options) {
21
- const users = [];
22
- for await (const user of this.list(query, options)) {
23
- users.push(user);
24
- }
25
- return users;
26
- }
27
- listByPage(query, options) {
28
- return super.iterator({ url: this.apiPath, params: query }, options).byPage();
29
- }
30
- update(id, data, options) {
31
- return super
32
- .fetch({
33
- url: `${this.apiPath}/${id}`,
34
- data,
35
- method: 'POST',
36
- }, options)
37
- .then((res) => (options?.rawResponse ? res : res.data));
38
- }
39
- delete(id, options) {
40
- return super
41
- .fetch({ url: `${this.apiPath}/${id}`, method: 'DELETE' }, options)
42
- .then((res) => (options?.rawResponse ? res : res.status));
43
- }
44
- }
@@ -1,3 +0,0 @@
1
- export declare const Version: {
2
- version: string;
3
- };
@@ -1 +0,0 @@
1
- export const Version = { version: '1.5.2' };
package/fixup DELETED
@@ -1,12 +0,0 @@
1
- #!/bin/bash
2
- cat >dist/cjs/package.json <<!EOF
3
- {
4
- "type": "commonjs"
5
- }
6
- !EOF
7
-
8
- cat >dist/mjs/package.json <<!EOF
9
- {
10
- "type": "module"
11
- }
12
- !EOF
package/src/rotacloud.ts DELETED
@@ -1,207 +0,0 @@
1
- import axios, { AxiosError, isAxiosError } from 'axios';
2
- import axiosRetry, { isNetworkOrIdempotentRequestError } from 'axios-retry';
3
- import {
4
- AccountsService,
5
- AttendanceService,
6
- AuthService,
7
- AvailabilityService,
8
- DailyBudgetsService,
9
- DailyRevenueService,
10
- DayNotesService,
11
- DaysOffService,
12
- GroupsService,
13
- LeaveEmbargoesService,
14
- LeaveRequestService,
15
- LeaveTypesService,
16
- LeaveService,
17
- LocationsService,
18
- RolesService,
19
- SettingsService,
20
- ShiftsService,
21
- TerminalsService,
22
- TerminalsActiveService,
23
- TimeZoneService,
24
- ToilAccrualsService,
25
- ToilAllowanceService,
26
- UsersService,
27
- UsersClockInService,
28
- } from './services/index.js';
29
- import { RetryOptions, RetryStrategy, SDKBase, SDKConfig } from './interfaces/index.js';
30
- import { PinsService } from './services/pins.service.js';
31
- import { SDKError } from './models/index.js';
32
- import { DocumentsService } from './services/documents.service.js';
33
-
34
- const DEFAULT_RETRIES = 3;
35
- const DEFAULT_RETRY_DELAY = 2000;
36
-
37
- const DEFAULT_RETRY_STRATEGY_OPTIONS: Record<RetryStrategy, RetryOptions> = {
38
- [RetryStrategy.Exponential]: {
39
- exponential: true,
40
- maxRetries: DEFAULT_RETRIES,
41
- },
42
- [RetryStrategy.Static]: {
43
- exponential: false,
44
- maxRetries: DEFAULT_RETRIES,
45
- delay: DEFAULT_RETRY_DELAY,
46
- },
47
- };
48
-
49
- const DEFAULT_CONFIG: Partial<SDKBase> = {
50
- baseUri: 'https://api.rotacloud.com/v1',
51
- retry: RetryStrategy.Exponential,
52
- };
53
-
54
- function parseClientError(error: AxiosError): SDKError {
55
- const axiosErrorLocation = error.response || error.request;
56
- const apiErrorMessage = axiosErrorLocation.data?.error;
57
- return new SDKError({
58
- code: axiosErrorLocation.status,
59
- message: apiErrorMessage || error.message,
60
- data: axiosErrorLocation.data,
61
- });
62
- }
63
-
64
- export class RotaCloud {
65
- private client = axios.create();
66
- private sdkConfig: SDKConfig;
67
-
68
- defaultAPIURI = DEFAULT_CONFIG.baseUri;
69
- accounts: AccountsService;
70
- attendance: AttendanceService;
71
- auth: AuthService;
72
- availability: AvailabilityService;
73
- dailyBudgets: DailyBudgetsService;
74
- dailyRevenue: DailyRevenueService;
75
- dayNotes: DayNotesService;
76
- daysOff: DaysOffService;
77
- documents: DocumentsService;
78
- group: GroupsService;
79
- leaveEmbargoes: LeaveEmbargoesService;
80
- leaveRequests: LeaveRequestService;
81
- leaveTypes: LeaveTypesService;
82
- leave: LeaveService;
83
- locations: LocationsService;
84
- pins: PinsService;
85
- roles: RolesService;
86
- settings: SettingsService;
87
- shifts: ShiftsService;
88
- terminals: TerminalsService;
89
- terminalsActive: TerminalsActiveService;
90
- timeZone: TimeZoneService;
91
- toilAccruals: ToilAccrualsService;
92
- toilAllowance: ToilAllowanceService;
93
- usersClockInService: UsersClockInService;
94
- users: UsersService;
95
-
96
- constructor(config: SDKConfig) {
97
- this.config = this.createConfig(config);
98
- const client = this;
99
- const options = {
100
- get config(): SDKConfig {
101
- return client.config;
102
- },
103
- };
104
-
105
- this.accounts = new AccountsService(this.client, options);
106
- this.attendance = new AttendanceService(this.client, options);
107
- this.auth = new AuthService(this.client, options);
108
- this.availability = new AvailabilityService(this.client, options);
109
- this.dailyBudgets = new DailyBudgetsService(this.client, options);
110
- this.dailyRevenue = new DailyRevenueService(this.client, options);
111
- this.dayNotes = new DayNotesService(this.client, options);
112
- this.daysOff = new DaysOffService(this.client, options);
113
- this.documents = new DocumentsService(this.client, options);
114
- this.group = new GroupsService(this.client, options);
115
- this.leaveEmbargoes = new LeaveEmbargoesService(this.client, options);
116
- this.leaveRequests = new LeaveRequestService(this.client, options);
117
- this.leaveTypes = new LeaveTypesService(this.client, options);
118
- this.leave = new LeaveService(this.client, options);
119
- this.locations = new LocationsService(this.client, options);
120
- this.pins = new PinsService(this.client, options);
121
- this.roles = new RolesService(this.client, options);
122
- this.settings = new SettingsService(this.client, options);
123
- this.shifts = new ShiftsService(this.client, options);
124
- this.terminals = new TerminalsService(this.client, options);
125
- this.terminalsActive = new TerminalsActiveService(this.client, options);
126
- this.timeZone = new TimeZoneService(this.client, options);
127
- this.toilAccruals = new ToilAccrualsService(this.client, options);
128
- this.toilAllowance = new ToilAllowanceService(this.client, options);
129
- this.usersClockInService = new UsersClockInService(this.client, options);
130
- this.users = new UsersService(this.client, options);
131
- }
132
-
133
- /**
134
- * Overrides undefined config with the default config without removing getters in the object
135
- */
136
- private createConfig(config: SDKConfig): SDKConfig {
137
- const keys = Object.keys(DEFAULT_CONFIG) as (keyof typeof DEFAULT_CONFIG)[];
138
- for (const key of keys) {
139
- config[key] ??= DEFAULT_CONFIG[key];
140
- }
141
- return config;
142
- }
143
-
144
- get config() {
145
- return this.sdkConfig;
146
- }
147
-
148
- set config(configVal: SDKConfig) {
149
- this.sdkConfig = configVal;
150
- this.setupInterceptors(configVal.retry, configVal.interceptors);
151
- }
152
-
153
- private setupInterceptors(retry: SDKConfig['retry'], customInterceptors: SDKConfig['interceptors']) {
154
- this.client.interceptors.request.clear();
155
- this.client.interceptors.response.clear();
156
-
157
- // NOTE: Retry interceptor - must be setup first
158
- if (retry) {
159
- const retryConfig = typeof retry === 'string' ? DEFAULT_RETRY_STRATEGY_OPTIONS[retry] : retry;
160
-
161
- axiosRetry(this.client, {
162
- retries: retryConfig.maxRetries,
163
- shouldResetTimeout: true,
164
- retryCondition: (err) => isNetworkOrIdempotentRequestError(err) || err.response?.status === 429,
165
- retryDelay: (retryCount) => {
166
- if (retryConfig.exponential) {
167
- return axiosRetry.exponentialDelay(retryCount);
168
- }
169
- return retryConfig.delay;
170
- },
171
- });
172
- }
173
-
174
- // NOTE: Error interceptor - must be setup after retry but before custom
175
- this.client.interceptors.response.use(
176
- (response) => response,
177
- (error: unknown) => {
178
- let parsedError = error;
179
- if (isAxiosError(error)) {
180
- parsedError = parseClientError(error);
181
- }
182
- return Promise.reject(parsedError);
183
- },
184
- );
185
-
186
- // NOTE: Custom interceptors - must be setup last
187
- for (const requestInterceptor of customInterceptors?.request ?? []) {
188
- const callbacks =
189
- typeof requestInterceptor === 'function'
190
- ? ([requestInterceptor] as const)
191
- : ([requestInterceptor?.success, requestInterceptor?.error] as const);
192
- this.client.interceptors.request.use(...callbacks);
193
- }
194
- for (const responseInterceptor of customInterceptors?.response ?? []) {
195
- const callbacks =
196
- typeof responseInterceptor === 'function'
197
- ? ([responseInterceptor] as const)
198
- : ([responseInterceptor?.success, responseInterceptor?.error] as const);
199
- this.client.interceptors.response.use(...callbacks);
200
- }
201
- }
202
- }
203
-
204
- export { RetryStrategy, RetryOptions };
205
- export * from './interfaces/index.js';
206
- export * from './interfaces/query-params/index.js';
207
- export * from './models/index.js';
@@ -1,52 +0,0 @@
1
- import { AxiosResponse } from 'axios';
2
- import { Service, Options, OptionsExtended } from './index.js';
3
-
4
- import { Account } from '../interfaces/index.js';
5
-
6
- export class AccountsService extends Service<Account> {
7
- private apiPath = '/accounts';
8
-
9
- get(id: number): Promise<Account>;
10
- get<F extends keyof Account>(
11
- id: number,
12
- options: { fields: F[]; rawResponse: true } & OptionsExtended<Account>,
13
- ): Promise<AxiosResponse<Pick<Account, F>>>;
14
- get<F extends keyof Account>(
15
- id: number,
16
- options: { fields: F[] } & OptionsExtended<Account>,
17
- ): Promise<Pick<Account, F>>;
18
- get(id: number, options: { rawResponse: true } & OptionsExtended<Account>): Promise<AxiosResponse<Account>>;
19
- get(id: number, options?: OptionsExtended<Account>): Promise<Account>;
20
- get(id: number, options?: OptionsExtended<Account>) {
21
- return super
22
- .fetch<Account>({ url: `${this.apiPath}/${id}` }, options)
23
- .then((res) => (options?.rawResponse ? res : res.data));
24
- }
25
-
26
- list(): AsyncGenerator<Account>;
27
- list<F extends keyof Account>(options: { fields: F[] } & OptionsExtended<Account>): AsyncGenerator<Pick<Account, F>>;
28
- list(options?: OptionsExtended<Account>): AsyncGenerator<Account>;
29
- async *list(options?: OptionsExtended<Account>) {
30
- yield* super.iterator({ url: this.apiPath }, options);
31
- }
32
-
33
- listAll(): Promise<Account[]>;
34
- listAll<F extends keyof Account>(options: { fields: F[] } & OptionsExtended<Account>): Promise<Pick<Account, F>[]>;
35
- listAll(options?: OptionsExtended<Account>): Promise<Account[]>;
36
- async listAll(options?: OptionsExtended<Account>) {
37
- const accounts = [] as Account[];
38
- for await (const account of this.list(options)) {
39
- accounts.push(account);
40
- }
41
- return accounts;
42
- }
43
-
44
- listByPage(): AsyncGenerator<AxiosResponse<Account[]>>;
45
- listByPage<F extends keyof Account>(
46
- options: { fields: F[] } & OptionsExtended<Account>,
47
- ): AsyncGenerator<AxiosResponse<Pick<Account, F>[]>>;
48
- listByPage(options: OptionsExtended<Account>): AsyncGenerator<AxiosResponse<Account[]>>;
49
- listByPage(options?: OptionsExtended<Account>) {
50
- return super.iterator({ url: this.apiPath }, options).byPage();
51
- }
52
- }