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,3 +0,0 @@
1
- export interface GroupsQueryParams {
2
- order?: string;
3
- }
@@ -1,26 +0,0 @@
1
- export * from './attendance-query-params.interface.js';
2
- export * from './availability-patterns-query-params.interface.js';
3
- export * from './availability-query-params.interface.js';
4
- export * from './common-shift-times-query-params.interface.js';
5
- export * from './daily-budgets-query-params.interface.js';
6
- export * from './daily-revenue-query-params.interface.js';
7
- export * from './day-notes-query-params.interface.js';
8
- export * from './days-off-patterns-query-params.interface.js';
9
- export * from './days-off-query-params.interface.js';
10
- export * from './documents-query-params.interface.js';
11
- export * from './groups-query-params.interface.js';
12
- export * from './leave-embargoes-query-params.interface.js';
13
- export * from './leave-query-params.interface.js';
14
- export * from './leave-requests-query-params.interface.js';
15
- export * from './locations-query-params.interface.js';
16
- export * from './logbook-events-query-params.interface.js';
17
- export * from './pay-periods-query-params.interface.js';
18
- export * from './roles-query-params.interface.js';
19
- export * from './settings-query-params.interface.js';
20
- export * from './shifts-query-params.interface.js';
21
- export * from './swap-requests-query-params.interface.js';
22
- export * from './terminals-query-params.interface.js';
23
- export * from './toil-accruals-query-params.interface.js';
24
- export * from './toil-allowance-query-params.interface.js';
25
- export * from './unavailability-requests-query-params.interface.js';
26
- export * from './users-query-params.interface.js';
@@ -1,5 +0,0 @@
1
- export interface LeaveEmbargoesQueryParams {
2
- start?: string;
3
- end?: string;
4
- users?: number[];
5
- }
@@ -1,13 +0,0 @@
1
- export interface LeaveQueryParams {
2
- start?: string;
3
- end?: string;
4
- year?: number;
5
- users?: number[];
6
- types?: number[];
7
- order?: string;
8
- only_managed?: boolean;
9
- include_deleted?: boolean;
10
- include_denied?: boolean;
11
- include_requested?: boolean;
12
- include_expired?: boolean;
13
- }
@@ -1,4 +0,0 @@
1
- export interface LeaveRequestsQueryParams {
2
- status?: 'requested' | 'approved' | 'denied' | 'expired';
3
- include_deleted?: boolean;
4
- }
@@ -1,7 +0,0 @@
1
- export interface LocationsQueryParams {
2
- ids?: number[];
3
- search?: string;
4
- only_visible?: boolean;
5
- only_managed?: boolean;
6
- include_deleted?: boolean;
7
- }
@@ -1,3 +0,0 @@
1
- export interface LogbookEventsQueryParams {
2
- user?: number;
3
- }
@@ -1,4 +0,0 @@
1
- export interface PayPeriodsQueryParams {
2
- start?: string;
3
- end?: string;
4
- }
@@ -1,5 +0,0 @@
1
- export interface RolesQueryParams {
2
- ids?: number[];
3
- search?: string;
4
- include_deleted?: boolean;
5
- }
@@ -1,3 +0,0 @@
1
- export interface SettingsQueryParams {
2
- only_values?: boolean;
3
- }
@@ -1,14 +0,0 @@
1
- export interface ShiftsQueryParams {
2
- start: number;
3
- end: number;
4
- ids?: number[];
5
- users?: number[];
6
- locations?: number[];
7
- roles?: number[];
8
- open?: boolean;
9
- published?: boolean;
10
- acknowledged?: boolean;
11
- deleted?: boolean;
12
- sort?: string;
13
- include_deleted?: boolean;
14
- }
@@ -1,8 +0,0 @@
1
- export interface SwapRequestsQueryParams {
2
- status?: string;
3
- start?: number;
4
- end?: number;
5
- old_user?: number;
6
- new_user?: number;
7
- include_deleted?: boolean;
8
- }
@@ -1,3 +0,0 @@
1
- export interface TerminalsQueryParams {
2
- include_deleted?: boolean;
3
- }
@@ -1,4 +0,0 @@
1
- export interface ToilAccrualsQueryParams {
2
- year?: number;
3
- users?: number[];
4
- }
@@ -1,8 +0,0 @@
1
- export interface UnavailabilityRequestsQueryParams {
2
- status?: string;
3
- start?: number;
4
- end?: number;
5
- shift_start?: number;
6
- shift_end?: number;
7
- include_deleted?: boolean;
8
- }
@@ -1,24 +0,0 @@
1
- export interface UsersQueryParams {
2
- ids?: number[];
3
- locations?: number[];
4
- /**
5
- * Works different from {UserQueryParams.locations},
6
- * When filtering out employees for rota, this is more suggested,
7
- * one scenario would be filtering out employees base on their starting and
8
- * final working date, using {UserQueryParams.locations} will not work in tandem
9
- * of {UserQueryParams.start_date} and {UserQueryParams.end_date}
10
- */
11
- location?: number;
12
- roles?: number[];
13
- only_managed?: boolean;
14
- include_self?: boolean;
15
- level?: string;
16
- search?: string;
17
- order?: string;
18
- period?: string;
19
- start_time?: number;
20
- end_time?: number;
21
- start_date?: string;
22
- end_date?: string;
23
- include_deleted?: boolean;
24
- }
@@ -1,6 +0,0 @@
1
- export interface RoleRate {
2
- [key: string]: {
3
- per_hour: number | null;
4
- per_shift: number | null;
5
- };
6
- }
@@ -1,9 +0,0 @@
1
- export interface Role {
2
- id: number;
3
- deleted: boolean;
4
- name: string;
5
- colour: string | null;
6
- default_break: number;
7
- users: number[];
8
- pay_code: string;
9
- }
@@ -1,47 +0,0 @@
1
- import { AxiosInterceptorManager, AxiosResponse, InternalAxiosRequestConfig } from 'axios';
2
- export declare enum RetryStrategy {
3
- Exponential = "expo",
4
- Static = "static"
5
- }
6
- export type RetryOptions = {
7
- /** Use exponential back-off */
8
- exponential?: false;
9
- /** The maximum number of retries before erroring */
10
- maxRetries: number;
11
- /** Delay in milliseconds between retry attempts - not used in exponential back-off */
12
- delay: number;
13
- } | {
14
- /** Use exponential back-off */
15
- exponential: true;
16
- /** The maximum number of retries before erroring */
17
- maxRetries: number;
18
- };
19
- type RequestInterceptor = Parameters<AxiosInterceptorManager<InternalAxiosRequestConfig>['use']>;
20
- type ResponseInterceptor = Parameters<AxiosInterceptorManager<AxiosResponse>['use']>;
21
- export interface SDKBase {
22
- baseUri?: string;
23
- accountId?: number;
24
- userId?: number;
25
- retry?: false | `${RetryStrategy}` | RetryOptions;
26
- interceptors?: {
27
- request?: (RequestInterceptor[0] | {
28
- success?: RequestInterceptor[0];
29
- error?: RequestInterceptor[1];
30
- })[];
31
- response?: (ResponseInterceptor[0] | {
32
- success?: ResponseInterceptor[0];
33
- error?: ResponseInterceptor[1];
34
- })[];
35
- };
36
- [key: string]: unknown;
37
- }
38
- export interface SDKBearerAuth extends SDKBase {
39
- apiKey: string;
40
- basicAuth?: never;
41
- }
42
- export interface SDKBasicAuth extends SDKBase {
43
- apiKey?: never;
44
- basicAuth: string;
45
- }
46
- export type SDKConfig = SDKBasicAuth | SDKBearerAuth;
47
- export {};
@@ -1,64 +0,0 @@
1
- export interface PayCodes {
2
- [pay_code_id: string]: string | {
3
- [leave_type_id: string]: string;
4
- };
5
- }
6
- export interface Settings {
7
- attendance_record_breaks: string;
8
- automatically_clock_in_to_consecutive_shifts: boolean;
9
- availability_employees_can_edit: boolean;
10
- availability_managers_can_edit: boolean;
11
- breaks_paid: boolean;
12
- clock_in_out_reminders_minutes: number;
13
- clock_in_without_shift_allowed: string;
14
- currency_symbol: string;
15
- dashboard_show_unpublished_shifts: boolean;
16
- early_clock_ins_paid_from: string;
17
- early_clock_in_minutes: number;
18
- employee_shift_note_visibility: string;
19
- employees_can_edit_timesheets: boolean;
20
- employees_can_only_see_self: boolean;
21
- employees_can_see_all_locations: boolean;
22
- employees_can_see_everyones_leave: boolean;
23
- flag_in_out_discrepancies_minutes: number;
24
- holiday_accrual_rate: number;
25
- late_clock_outs_paid_until: string;
26
- lateness_added_after_minutes: number;
27
- leave_can_request_over_allowance: boolean;
28
- leave_prorate_allowances: boolean;
29
- leave_requests_enabled: boolean;
30
- leave_requests_notice_days: number;
31
- leave_year_start_day: number;
32
- leave_year_start_month: number;
33
- metadata_enabled: boolean;
34
- mobile_clocking_enabled: boolean;
35
- no_show_notifications_minutes: number;
36
- open_shift_claiming_enabled: boolean;
37
- public_holiday_affects_allowance: boolean;
38
- reminders_enabled: boolean;
39
- rota_grouping: string;
40
- rota_salaried_cost_method: string;
41
- rota_show_employee_photos: boolean;
42
- round_breaks: string;
43
- round_breaks_direction: string;
44
- round_currency: string;
45
- round_currency_direction: string;
46
- round_hours: string;
47
- round_hours_direction: string;
48
- shift_acknowledgement_enabled: boolean;
49
- shift_swaps_across_locations_enabled: boolean;
50
- shift_swaps_enabled: boolean;
51
- shift_swaps_notice_hours: number;
52
- shift_swaps_require_approval: boolean;
53
- shift_swaps_shift_range_days: number;
54
- show_open_shifts_from_other_locations: boolean;
55
- show_shifts_from_other_locations: boolean;
56
- time_format: string;
57
- unavailability_notice_hours: number;
58
- unavailability_requests_enabled: boolean;
59
- unpaid_leave_types_included_in_accrual: number[];
60
- paid_leave_types_included_in_accrual: number[];
61
- week_starts: string;
62
- pay_codes: PayCodes;
63
- webhook_signing_secret: string;
64
- }
@@ -1,16 +0,0 @@
1
- export type RequestStatus = 'expired' | 'shift_changed' | 'approved' | 'denied' | 'requested';
2
- export interface ShiftSwapRequest {
3
- id: number;
4
- deleted: boolean;
5
- status: RequestStatus;
6
- requested_at: number;
7
- old_user: number;
8
- new_user: number;
9
- admin: number | null;
10
- user_approved: boolean | null;
11
- user_replied_at: number | null;
12
- admin_approved: boolean | null;
13
- admin_replied_at: number | null;
14
- shift: number;
15
- swapped_shift: number;
16
- }
@@ -1,23 +0,0 @@
1
- export interface Terminal {
2
- id: number;
3
- deleted: boolean;
4
- name: string;
5
- active: boolean;
6
- platform: string | null;
7
- default_location: number | null;
8
- device: string | null;
9
- version: string | null;
10
- ip: string | null;
11
- location: TerminalLocation | null;
12
- timezone: number;
13
- require_photo: boolean;
14
- require_photo_breaks: boolean;
15
- debug: boolean;
16
- secret: string | null;
17
- server_time?: number;
18
- }
19
- export interface TerminalLocation {
20
- lat: number;
21
- lng: number;
22
- accuracy: number;
23
- }
@@ -1,7 +0,0 @@
1
- export interface TimeZone {
2
- id: number;
3
- name: string;
4
- continent: string;
5
- city: string;
6
- sub: string;
7
- }
@@ -1,14 +0,0 @@
1
- export interface ToilAccrual {
2
- comments: string;
3
- created_at: number;
4
- created_by: number | null;
5
- date: string;
6
- deleted: boolean;
7
- deleted_at: string | null;
8
- deleted_by: number | null;
9
- duration_hours: number;
10
- id: number;
11
- leave_year: number;
12
- location_id: number | null;
13
- user_id: number;
14
- }
@@ -1,7 +0,0 @@
1
- export interface ToilAllowance {
2
- user: number;
3
- accrued_hours: number;
4
- remaining_hours: number;
5
- used_hours: number;
6
- has_toil_records: boolean;
7
- }
@@ -1,48 +0,0 @@
1
- import { LeaveRate, RoleRate, TerminalLocation } from './index.js';
2
- export type ManagerPermission = 'rotas' | 'rota_requests' | 'leave_requests' | 'leave_self' | 'leave_embargoes' | 'employees' | 'employees_salary' | 'timesheets' | 'payroll' | 'roles' | 'reports';
3
- export interface User {
4
- id: number;
5
- created_at: number;
6
- created_by: number;
7
- deleted: boolean;
8
- deleted_at: number | null;
9
- deleted_by: number | null;
10
- level: 'admin' | 'employee' | 'manager';
11
- first_name: string;
12
- middle_name: string | null;
13
- last_name: string;
14
- preferred_name: string | null;
15
- photo: string | null;
16
- two_factor_enabled: boolean;
17
- email: string;
18
- has_account: boolean;
19
- invite_sent: boolean;
20
- group: number | null;
21
- locations: number[];
22
- roles: number[];
23
- default_role: number | null;
24
- dob: string | null;
25
- start_date: string | null;
26
- final_working_date: string | null;
27
- weekly_hours: number | null;
28
- holiday_allowance: number;
29
- holiday_allowance_unit: string;
30
- payroll_id: string | null;
31
- salary: number;
32
- salary_type: 'annual' | 'hourly';
33
- overtime_rate: number;
34
- role_rates: RoleRate | null;
35
- leave_rates: LeaveRate;
36
- leave_rates_unit: string;
37
- leave_rates_type: string;
38
- notes: string | null;
39
- pin: string | null;
40
- salaried_cost_location: number | null;
41
- permissions: ManagerPermission[];
42
- }
43
- export interface UserBreak {
44
- start_time: number;
45
- start_location: TerminalLocation;
46
- end_time?: number;
47
- end_location?: TerminalLocation;
48
- }
@@ -1,14 +0,0 @@
1
- import { Shift, TerminalLocation, UserBreak } from '../interfaces/index.js';
2
- export interface UserClockedIn {
3
- user: number;
4
- location: number;
5
- role: number;
6
- in_time: number;
7
- minutes_late: number;
8
- shift: Pick<Shift, 'id' | 'start_time' | 'end_time' | 'minutes_break' | 'location' | 'role'>;
9
- in_method: string;
10
- in_location: TerminalLocation;
11
- in_device: string | null;
12
- in_terminal: number | null;
13
- breaks_clocked: UserBreak[];
14
- }
@@ -1,26 +0,0 @@
1
- import { Shift, TerminalLocation } from './index.js';
2
- export interface UserClockedOut {
3
- id: number;
4
- deleted: boolean;
5
- approved: boolean;
6
- user: number;
7
- location: number;
8
- role: number;
9
- in_time: number;
10
- out_time: number;
11
- minutes_break: number;
12
- minutes_late: number;
13
- hours: number;
14
- hours_auto: number;
15
- hours_is_auto: boolean;
16
- notes: string | null;
17
- shift: Pick<Shift, 'id' | 'start_time' | 'end_time' | 'minutes_break' | 'location' | 'role'>;
18
- in_method: string;
19
- in_location: TerminalLocation;
20
- in_device: string | null;
21
- in_terminal: number | null;
22
- out_method: string;
23
- out_location: TerminalLocation;
24
- out_device: string | null;
25
- out_terminal: number | null;
26
- }
@@ -1,11 +0,0 @@
1
- export interface SDKErrorConfig {
2
- message?: string;
3
- code?: number;
4
- data?: unknown;
5
- }
6
- export declare class SDKError extends Error {
7
- name: string;
8
- readonly code?: number;
9
- readonly data?: unknown;
10
- constructor(errorConfig: SDKErrorConfig);
11
- }
@@ -1 +0,0 @@
1
- export * from './SDKError.model.js';
@@ -1,3 +0,0 @@
1
- {
2
- "type": "module"
3
- }
@@ -1,47 +0,0 @@
1
- import { AccountsService, AttendanceService, AuthService, AvailabilityService, DailyBudgetsService, DailyRevenueService, DayNotesService, DaysOffService, GroupsService, LeaveEmbargoesService, LeaveRequestService, LeaveTypesService, LeaveService, LocationsService, RolesService, SettingsService, ShiftsService, TerminalsService, TerminalsActiveService, TimeZoneService, ToilAccrualsService, ToilAllowanceService, UsersService, UsersClockInService } from './services/index.js';
2
- import { RetryOptions, RetryStrategy, SDKConfig } from './interfaces/index.js';
3
- import { PinsService } from './services/pins.service.js';
4
- import { DocumentsService } from './services/documents.service.js';
5
- export declare class RotaCloud {
6
- private client;
7
- private sdkConfig;
8
- defaultAPIURI: string | undefined;
9
- accounts: AccountsService;
10
- attendance: AttendanceService;
11
- auth: AuthService;
12
- availability: AvailabilityService;
13
- dailyBudgets: DailyBudgetsService;
14
- dailyRevenue: DailyRevenueService;
15
- dayNotes: DayNotesService;
16
- daysOff: DaysOffService;
17
- documents: DocumentsService;
18
- group: GroupsService;
19
- leaveEmbargoes: LeaveEmbargoesService;
20
- leaveRequests: LeaveRequestService;
21
- leaveTypes: LeaveTypesService;
22
- leave: LeaveService;
23
- locations: LocationsService;
24
- pins: PinsService;
25
- roles: RolesService;
26
- settings: SettingsService;
27
- shifts: ShiftsService;
28
- terminals: TerminalsService;
29
- terminalsActive: TerminalsActiveService;
30
- timeZone: TimeZoneService;
31
- toilAccruals: ToilAccrualsService;
32
- toilAllowance: ToilAllowanceService;
33
- usersClockInService: UsersClockInService;
34
- users: UsersService;
35
- constructor(config: SDKConfig);
36
- /**
37
- * Overrides undefined config with the default config without removing getters in the object
38
- */
39
- private createConfig;
40
- get config(): SDKConfig;
41
- set config(configVal: SDKConfig);
42
- private setupInterceptors;
43
- }
44
- export { RetryStrategy, RetryOptions };
45
- export * from './interfaces/index.js';
46
- export * from './interfaces/query-params/index.js';
47
- export * from './models/index.js';
@@ -1,133 +0,0 @@
1
- import axios, { isAxiosError } from 'axios';
2
- import axiosRetry, { isNetworkOrIdempotentRequestError } from 'axios-retry';
3
- import { AccountsService, AttendanceService, AuthService, AvailabilityService, DailyBudgetsService, DailyRevenueService, DayNotesService, DaysOffService, GroupsService, LeaveEmbargoesService, LeaveRequestService, LeaveTypesService, LeaveService, LocationsService, RolesService, SettingsService, ShiftsService, TerminalsService, TerminalsActiveService, TimeZoneService, ToilAccrualsService, ToilAllowanceService, UsersService, UsersClockInService, } from './services/index.js';
4
- import { RetryStrategy } from './interfaces/index.js';
5
- import { PinsService } from './services/pins.service.js';
6
- import { SDKError } from './models/index.js';
7
- import { DocumentsService } from './services/documents.service.js';
8
- const DEFAULT_RETRIES = 3;
9
- const DEFAULT_RETRY_DELAY = 2000;
10
- const DEFAULT_RETRY_STRATEGY_OPTIONS = {
11
- [RetryStrategy.Exponential]: {
12
- exponential: true,
13
- maxRetries: DEFAULT_RETRIES,
14
- },
15
- [RetryStrategy.Static]: {
16
- exponential: false,
17
- maxRetries: DEFAULT_RETRIES,
18
- delay: DEFAULT_RETRY_DELAY,
19
- },
20
- };
21
- const DEFAULT_CONFIG = {
22
- baseUri: 'https://api.rotacloud.com/v1',
23
- retry: RetryStrategy.Exponential,
24
- };
25
- function parseClientError(error) {
26
- const axiosErrorLocation = error.response || error.request;
27
- const apiErrorMessage = axiosErrorLocation.data?.error;
28
- return new SDKError({
29
- code: axiosErrorLocation.status,
30
- message: apiErrorMessage || error.message,
31
- data: axiosErrorLocation.data,
32
- });
33
- }
34
- export class RotaCloud {
35
- constructor(config) {
36
- this.client = axios.create();
37
- this.defaultAPIURI = DEFAULT_CONFIG.baseUri;
38
- this.config = this.createConfig(config);
39
- const client = this;
40
- const options = {
41
- get config() {
42
- return client.config;
43
- },
44
- };
45
- this.accounts = new AccountsService(this.client, options);
46
- this.attendance = new AttendanceService(this.client, options);
47
- this.auth = new AuthService(this.client, options);
48
- this.availability = new AvailabilityService(this.client, options);
49
- this.dailyBudgets = new DailyBudgetsService(this.client, options);
50
- this.dailyRevenue = new DailyRevenueService(this.client, options);
51
- this.dayNotes = new DayNotesService(this.client, options);
52
- this.daysOff = new DaysOffService(this.client, options);
53
- this.documents = new DocumentsService(this.client, options);
54
- this.group = new GroupsService(this.client, options);
55
- this.leaveEmbargoes = new LeaveEmbargoesService(this.client, options);
56
- this.leaveRequests = new LeaveRequestService(this.client, options);
57
- this.leaveTypes = new LeaveTypesService(this.client, options);
58
- this.leave = new LeaveService(this.client, options);
59
- this.locations = new LocationsService(this.client, options);
60
- this.pins = new PinsService(this.client, options);
61
- this.roles = new RolesService(this.client, options);
62
- this.settings = new SettingsService(this.client, options);
63
- this.shifts = new ShiftsService(this.client, options);
64
- this.terminals = new TerminalsService(this.client, options);
65
- this.terminalsActive = new TerminalsActiveService(this.client, options);
66
- this.timeZone = new TimeZoneService(this.client, options);
67
- this.toilAccruals = new ToilAccrualsService(this.client, options);
68
- this.toilAllowance = new ToilAllowanceService(this.client, options);
69
- this.usersClockInService = new UsersClockInService(this.client, options);
70
- this.users = new UsersService(this.client, options);
71
- }
72
- /**
73
- * Overrides undefined config with the default config without removing getters in the object
74
- */
75
- createConfig(config) {
76
- const keys = Object.keys(DEFAULT_CONFIG);
77
- for (const key of keys) {
78
- config[key] ?? (config[key] = DEFAULT_CONFIG[key]);
79
- }
80
- return config;
81
- }
82
- get config() {
83
- return this.sdkConfig;
84
- }
85
- set config(configVal) {
86
- this.sdkConfig = configVal;
87
- this.setupInterceptors(configVal.retry, configVal.interceptors);
88
- }
89
- setupInterceptors(retry, customInterceptors) {
90
- this.client.interceptors.request.clear();
91
- this.client.interceptors.response.clear();
92
- // NOTE: Retry interceptor - must be setup first
93
- if (retry) {
94
- const retryConfig = typeof retry === 'string' ? DEFAULT_RETRY_STRATEGY_OPTIONS[retry] : retry;
95
- axiosRetry(this.client, {
96
- retries: retryConfig.maxRetries,
97
- shouldResetTimeout: true,
98
- retryCondition: (err) => isNetworkOrIdempotentRequestError(err) || err.response?.status === 429,
99
- retryDelay: (retryCount) => {
100
- if (retryConfig.exponential) {
101
- return axiosRetry.exponentialDelay(retryCount);
102
- }
103
- return retryConfig.delay;
104
- },
105
- });
106
- }
107
- // NOTE: Error interceptor - must be setup after retry but before custom
108
- this.client.interceptors.response.use((response) => response, (error) => {
109
- let parsedError = error;
110
- if (isAxiosError(error)) {
111
- parsedError = parseClientError(error);
112
- }
113
- return Promise.reject(parsedError);
114
- });
115
- // NOTE: Custom interceptors - must be setup last
116
- for (const requestInterceptor of customInterceptors?.request ?? []) {
117
- const callbacks = typeof requestInterceptor === 'function'
118
- ? [requestInterceptor]
119
- : [requestInterceptor?.success, requestInterceptor?.error];
120
- this.client.interceptors.request.use(...callbacks);
121
- }
122
- for (const responseInterceptor of customInterceptors?.response ?? []) {
123
- const callbacks = typeof responseInterceptor === 'function'
124
- ? [responseInterceptor]
125
- : [responseInterceptor?.success, responseInterceptor?.error];
126
- this.client.interceptors.response.use(...callbacks);
127
- }
128
- }
129
- }
130
- export { RetryStrategy };
131
- export * from './interfaces/index.js';
132
- export * from './interfaces/query-params/index.js';
133
- export * from './models/index.js';