@chrt-inc/typescript-sdk 0.0.174 → 0.0.183

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 (310) hide show
  1. package/dist/cjs/Client.d.ts +24 -24
  2. package/dist/cjs/Client.js +48 -48
  3. package/dist/cjs/api/index.d.ts +1 -1
  4. package/dist/cjs/api/index.js +1 -1
  5. package/dist/cjs/api/resources/connections/client/Client.d.ts +8 -8
  6. package/dist/cjs/api/resources/connections/client/Client.js +14 -14
  7. package/dist/cjs/api/resources/connections/resources/connectionToCourier/client/Client.d.ts +1 -1
  8. package/dist/cjs/api/resources/connections/resources/connectionToCourier/client/Client.js +1 -1
  9. package/dist/cjs/api/resources/courierPayDriverLineItemGroup/client/Client.d.ts +26 -26
  10. package/dist/cjs/api/resources/courierPayDriverLineItemGroup/client/Client.js +79 -79
  11. package/dist/cjs/api/resources/courierPayDriverLineItemGroup/client/requests/index.d.ts +1 -1
  12. package/dist/cjs/api/resources/courierPayDriverLineItemGroup/resources/addLineItems/client/Client.d.ts +1 -1
  13. package/dist/cjs/api/resources/courierPayDriverLineItemGroup/resources/addLineItems/client/Client.js +1 -1
  14. package/dist/cjs/api/resources/courierPayDriverLineItemGroup/resources/removeLineItems/client/Client.d.ts +1 -1
  15. package/dist/cjs/api/resources/courierPayDriverLineItemGroup/resources/removeLineItems/client/Client.js +1 -1
  16. package/dist/cjs/api/resources/courierPayDriverPayouts/client/Client.d.ts +16 -12
  17. package/dist/cjs/api/resources/courierPayDriverPayouts/client/Client.js +27 -23
  18. package/dist/cjs/api/resources/courierPayDriverPayouts/client/requests/CourierPayDriverPayoutClientCreate1.d.ts +3 -3
  19. package/dist/cjs/api/resources/courierPayDriverRateSheets/client/Client.d.ts +39 -26
  20. package/dist/cjs/api/resources/courierPayDriverRateSheets/client/Client.js +112 -67
  21. package/dist/cjs/api/resources/courierPayDriverRateSheets/client/requests/CourierPayDriverRateSheetClientCreate1.d.ts +24 -24
  22. package/dist/cjs/api/resources/courierPayDriverRateSheets/client/requests/CourierPayDriverRateSheetClientUpdate1.d.ts +12 -12
  23. package/dist/cjs/api/resources/courierPayDriverRateSheets/client/requests/index.d.ts +0 -1
  24. package/dist/cjs/api/resources/courierPayDriverRateSheets/index.d.ts +0 -1
  25. package/dist/cjs/api/resources/courierPayDriverRateSheets/index.js +0 -1
  26. package/dist/cjs/api/resources/dev/client/Client.d.ts +28 -10
  27. package/dist/cjs/api/resources/dev/client/Client.js +103 -46
  28. package/dist/cjs/api/resources/drivers/client/Client.d.ts +52 -50
  29. package/dist/cjs/api/resources/drivers/client/Client.js +109 -107
  30. package/dist/cjs/api/resources/drivers/client/requests/SetDriverActivationReq.d.ts +3 -3
  31. package/dist/cjs/api/resources/drivers/client/requests/index.d.ts +1 -1
  32. package/dist/cjs/api/resources/index.d.ts +14 -15
  33. package/dist/cjs/api/resources/index.js +15 -16
  34. package/dist/cjs/api/resources/milestoneNotifications/client/Client.d.ts +2 -2
  35. package/dist/cjs/api/resources/milestoneNotifications/client/Client.js +2 -2
  36. package/dist/cjs/api/resources/milestoneNotifications/client/requests/MilestoneNotificationPreferencesClientCreate1.d.ts +3 -3
  37. package/dist/cjs/api/resources/milestones/client/Client.d.ts +16 -16
  38. package/dist/cjs/api/resources/milestones/client/Client.js +25 -25
  39. package/dist/cjs/api/resources/milestones/client/requests/MilestoneAddToTaskReq.d.ts +1 -1
  40. package/dist/cjs/api/resources/milestones/client/requests/MilestoneUpdateReq.d.ts +1 -1
  41. package/dist/cjs/api/resources/milestones/client/requests/index.d.ts +1 -1
  42. package/dist/cjs/api/resources/milestones/resources/blurhash/client/Client.d.ts +1 -5
  43. package/dist/cjs/api/resources/milestones/resources/blurhash/client/Client.js +1 -5
  44. package/dist/cjs/api/resources/milestones/resources/images/client/Client.d.ts +14 -14
  45. package/dist/cjs/api/resources/milestones/resources/images/client/Client.js +35 -35
  46. package/dist/cjs/api/resources/milestones/resources/index.d.ts +1 -1
  47. package/dist/cjs/api/resources/milestones/resources/index.js +2 -2
  48. package/dist/cjs/api/resources/notifications/client/Client.d.ts +3 -3
  49. package/dist/cjs/api/resources/notifications/client/Client.js +6 -6
  50. package/dist/cjs/api/resources/notifications/resources/courierPreferences/client/Client.d.ts +2 -2
  51. package/dist/cjs/api/resources/notifications/resources/courierPreferences/client/Client.js +2 -2
  52. package/dist/cjs/api/resources/notifications/resources/courierPreferences/client/requests/CourierNotificationPreferencesClientCreate1.d.ts +3 -3
  53. package/dist/cjs/api/resources/notifications/resources/index.d.ts +2 -2
  54. package/dist/cjs/api/resources/notifications/resources/index.js +3 -3
  55. package/dist/cjs/api/resources/notifications/resources/shipper/client/Client.d.ts +2 -2
  56. package/dist/cjs/api/resources/notifications/resources/shipper/client/Client.js +2 -2
  57. package/dist/cjs/api/resources/notifications/resources/shipper/client/requests/ShipperNotificationPreferencesClientCreate1.d.ts +3 -3
  58. package/dist/cjs/api/resources/offChrtShipperOrgConnectionInfo/client/Client.d.ts +6 -6
  59. package/dist/cjs/api/resources/offChrtShipperOrgConnectionInfo/client/Client.js +6 -6
  60. package/dist/cjs/api/resources/offChrtShipperOrgConnectionInfo/client/requests/OffChrtShipperOrgConnectionInfoClientCreate1.d.ts +8 -8
  61. package/dist/cjs/api/resources/offChrtShipperOrgConnectionInfo/client/requests/OffChrtShipperOrgConnectionInfoClientUpdate1.d.ts +4 -4
  62. package/dist/cjs/api/resources/orders/client/Client.d.ts +30 -26
  63. package/dist/cjs/api/resources/orders/client/Client.js +74 -70
  64. package/dist/cjs/api/resources/orders/client/requests/CreateOrderReq.d.ts +16 -16
  65. package/dist/cjs/api/resources/orders/resources/full/client/Client.d.ts +12 -12
  66. package/dist/cjs/api/resources/orders/resources/full/client/Client.js +33 -33
  67. package/dist/cjs/api/resources/orgConnectionInfos/client/Client.d.ts +3 -3
  68. package/dist/cjs/api/resources/orgConnectionInfos/client/Client.js +6 -6
  69. package/dist/cjs/api/resources/orgConnectionInfos/resources/courier/client/Client.d.ts +5 -5
  70. package/dist/cjs/api/resources/orgConnectionInfos/resources/courier/client/Client.js +5 -5
  71. package/dist/cjs/api/resources/orgConnectionInfos/resources/courier/client/requests/CourierOrgConnectionInfoClientCreate1.d.ts +7 -7
  72. package/dist/cjs/api/resources/orgConnectionInfos/resources/courier/client/requests/CourierOrgConnectionInfoClientUpdate1.d.ts +4 -4
  73. package/dist/cjs/api/resources/orgConnectionInfos/resources/index.d.ts +2 -2
  74. package/dist/cjs/api/resources/orgConnectionInfos/resources/index.js +3 -3
  75. package/dist/cjs/api/resources/orgConnectionInfos/resources/shipper/client/Client.d.ts +5 -5
  76. package/dist/cjs/api/resources/orgConnectionInfos/resources/shipper/client/Client.js +5 -5
  77. package/dist/cjs/api/resources/orgConnectionInfos/resources/shipper/client/requests/ShipperOrgConnectionInfoClientCreate1.d.ts +7 -7
  78. package/dist/cjs/api/resources/orgConnectionInfos/resources/shipper/client/requests/ShipperOrgConnectionInfoClientUpdate1.d.ts +4 -4
  79. package/dist/cjs/api/resources/orgProfiles/client/Client.d.ts +15 -17
  80. package/dist/cjs/api/resources/orgProfiles/client/Client.js +43 -49
  81. package/dist/cjs/api/resources/orgProfiles/client/requests/CourierOrgProfileClientCreate3.d.ts +3 -3
  82. package/dist/cjs/api/resources/orgProfiles/client/requests/index.d.ts +0 -1
  83. package/dist/cjs/api/resources/orgs/client/Client.d.ts +41 -37
  84. package/dist/cjs/api/resources/orgs/client/Client.js +90 -86
  85. package/dist/cjs/api/resources/orgs/client/requests/CreateOrgPublicDataReq.d.ts +3 -3
  86. package/dist/cjs/api/resources/orgs/client/requests/UpdateOrgPublicDataReq.d.ts +1 -1
  87. package/dist/cjs/api/resources/payments/client/Client.d.ts +3 -7
  88. package/dist/cjs/api/resources/payments/client/Client.js +3 -7
  89. package/dist/cjs/api/resources/root/client/Client.d.ts +19 -13
  90. package/dist/cjs/api/resources/root/client/Client.js +31 -25
  91. package/dist/cjs/api/resources/shipperContactInfo/client/Client.d.ts +42 -42
  92. package/dist/cjs/api/resources/shipperContactInfo/client/Client.js +90 -90
  93. package/dist/cjs/api/resources/shipperContactInfo/client/requests/ShipperContactInfoClientUpdate1.d.ts +4 -4
  94. package/dist/cjs/api/resources/taskGroups/client/Client.d.ts +24 -18
  95. package/dist/cjs/api/resources/taskGroups/client/Client.js +43 -37
  96. package/dist/cjs/api/resources/taskGroups/client/requests/UpdateTaskGroupReq.d.ts +2 -2
  97. package/dist/cjs/api/resources/taskGroups/resources/full/client/Client.d.ts +2 -2
  98. package/dist/cjs/api/resources/taskGroups/resources/full/client/Client.js +2 -2
  99. package/dist/cjs/api/resources/taskGroups/resources/togglePause/client/Client.d.ts +4 -2
  100. package/dist/cjs/api/resources/taskGroups/resources/togglePause/client/Client.js +4 -2
  101. package/dist/cjs/api/resources/taskGroups/resources/togglePause/client/requests/SetTaskGroupPauseReq.d.ts +3 -3
  102. package/dist/cjs/api/resources/users/client/Client.d.ts +2 -0
  103. package/dist/cjs/api/resources/users/client/Client.js +2 -0
  104. package/dist/cjs/api/types/Cargo1.d.ts +6 -6
  105. package/dist/cjs/api/types/CargoClientCreate1.d.ts +3 -3
  106. package/dist/cjs/api/types/CourierNotificationPreferences1.d.ts +9 -9
  107. package/dist/cjs/api/types/CourierOrgConnectionInfo1.d.ts +10 -10
  108. package/dist/cjs/api/types/CourierOrgProfile3.d.ts +3 -3
  109. package/dist/cjs/api/types/CourierPayDriverLineItemGroup1.d.ts +5 -5
  110. package/dist/cjs/api/types/CourierPayDriverLineItemGroupClientCreate1.d.ts +1 -1
  111. package/dist/cjs/api/types/CourierPayDriverRateSheet1.d.ts +16 -16
  112. package/dist/cjs/api/types/DecodedJwtWithOrgAndUserId.d.ts +8 -8
  113. package/dist/cjs/api/types/Driver1.d.ts +6 -6
  114. package/dist/cjs/api/types/Expense1.d.ts +3 -3
  115. package/dist/cjs/api/types/Feature.d.ts +3 -3
  116. package/dist/cjs/api/types/GetOrderFullRes.d.ts +2 -2
  117. package/dist/cjs/api/types/Incident1.d.ts +1 -1
  118. package/dist/cjs/api/types/Insurance1.d.ts +1 -1
  119. package/dist/cjs/api/types/LineItem1.d.ts +1 -1
  120. package/dist/cjs/api/types/Milestone1.d.ts +13 -13
  121. package/dist/cjs/api/types/MilestoneClientCreate1.d.ts +1 -1
  122. package/dist/cjs/api/types/MilestoneNotificationPreferences1.d.ts +9 -9
  123. package/dist/cjs/api/types/OffChrtShipperOrgConnectionInfo1.d.ts +11 -11
  124. package/dist/cjs/api/types/Order1.d.ts +11 -11
  125. package/dist/cjs/api/types/OrgMemberDetails.d.ts +2 -2
  126. package/dist/cjs/api/types/OrgMembersAndDrivers.d.ts +1 -1
  127. package/dist/cjs/api/types/OrgPublicData2.d.ts +4 -4
  128. package/dist/cjs/api/types/PayablesInvoice1.d.ts +11 -11
  129. package/dist/cjs/api/types/ReceivablesInvoice1.d.ts +7 -7
  130. package/dist/cjs/api/types/ShipperContactInfo1.d.ts +11 -11
  131. package/dist/cjs/api/types/ShipperContactInfoClientCreate1.d.ts +6 -6
  132. package/dist/cjs/api/types/ShipperCourierConnection1.d.ts +4 -4
  133. package/dist/cjs/api/types/ShipperNotificationPreferences1.d.ts +9 -9
  134. package/dist/cjs/api/types/ShipperOrgConnectionInfo1.d.ts +6 -6
  135. package/dist/cjs/api/types/StripeConnectInvoice1.d.ts +5 -5
  136. package/dist/cjs/api/types/Task1.d.ts +13 -13
  137. package/dist/cjs/api/types/TaskClientCreate1.d.ts +4 -4
  138. package/dist/cjs/api/types/TaskCreateBundle.d.ts +2 -2
  139. package/dist/cjs/api/types/TaskGroup1.d.ts +11 -11
  140. package/dist/cjs/api/types/TaskWithDetails.d.ts +2 -2
  141. package/dist/cjs/api/types/Tracker1.d.ts +1 -1
  142. package/dist/cjs/api/types/TrackerSession1.d.ts +1 -1
  143. package/dist/cjs/api/types/UserPublicData6.d.ts +6 -6
  144. package/dist/cjs/api/types/Vehicle1.d.ts +1 -1
  145. package/dist/cjs/version.d.ts +1 -1
  146. package/dist/cjs/version.js +1 -1
  147. package/dist/esm/Client.d.mts +24 -24
  148. package/dist/esm/Client.mjs +36 -36
  149. package/dist/esm/api/index.d.mts +1 -1
  150. package/dist/esm/api/index.mjs +1 -1
  151. package/dist/esm/api/resources/connections/client/Client.d.mts +8 -8
  152. package/dist/esm/api/resources/connections/client/Client.mjs +14 -14
  153. package/dist/esm/api/resources/connections/resources/connectionToCourier/client/Client.d.mts +1 -1
  154. package/dist/esm/api/resources/connections/resources/connectionToCourier/client/Client.mjs +1 -1
  155. package/dist/esm/api/resources/courierPayDriverLineItemGroup/client/Client.d.mts +26 -26
  156. package/dist/esm/api/resources/courierPayDriverLineItemGroup/client/Client.mjs +79 -79
  157. package/dist/esm/api/resources/courierPayDriverLineItemGroup/client/requests/index.d.mts +1 -1
  158. package/dist/esm/api/resources/courierPayDriverLineItemGroup/resources/addLineItems/client/Client.d.mts +1 -1
  159. package/dist/esm/api/resources/courierPayDriverLineItemGroup/resources/addLineItems/client/Client.mjs +1 -1
  160. package/dist/esm/api/resources/courierPayDriverLineItemGroup/resources/removeLineItems/client/Client.d.mts +1 -1
  161. package/dist/esm/api/resources/courierPayDriverLineItemGroup/resources/removeLineItems/client/Client.mjs +1 -1
  162. package/dist/esm/api/resources/courierPayDriverPayouts/client/Client.d.mts +16 -12
  163. package/dist/esm/api/resources/courierPayDriverPayouts/client/Client.mjs +27 -23
  164. package/dist/esm/api/resources/courierPayDriverPayouts/client/requests/CourierPayDriverPayoutClientCreate1.d.mts +3 -3
  165. package/dist/esm/api/resources/courierPayDriverRateSheets/client/Client.d.mts +39 -26
  166. package/dist/esm/api/resources/courierPayDriverRateSheets/client/Client.mjs +112 -67
  167. package/dist/esm/api/resources/courierPayDriverRateSheets/client/requests/CourierPayDriverRateSheetClientCreate1.d.mts +24 -24
  168. package/dist/esm/api/resources/courierPayDriverRateSheets/client/requests/CourierPayDriverRateSheetClientUpdate1.d.mts +12 -12
  169. package/dist/esm/api/resources/courierPayDriverRateSheets/client/requests/index.d.mts +0 -1
  170. package/dist/esm/api/resources/courierPayDriverRateSheets/index.d.mts +0 -1
  171. package/dist/esm/api/resources/courierPayDriverRateSheets/index.mjs +0 -1
  172. package/dist/esm/api/resources/dev/client/Client.d.mts +28 -10
  173. package/dist/esm/api/resources/dev/client/Client.mjs +103 -46
  174. package/dist/esm/api/resources/drivers/client/Client.d.mts +52 -50
  175. package/dist/esm/api/resources/drivers/client/Client.mjs +109 -107
  176. package/dist/esm/api/resources/drivers/client/requests/SetDriverActivationReq.d.mts +3 -3
  177. package/dist/esm/api/resources/drivers/client/requests/index.d.mts +1 -1
  178. package/dist/esm/api/resources/index.d.mts +14 -15
  179. package/dist/esm/api/resources/index.mjs +14 -15
  180. package/dist/esm/api/resources/milestoneNotifications/client/Client.d.mts +2 -2
  181. package/dist/esm/api/resources/milestoneNotifications/client/Client.mjs +2 -2
  182. package/dist/esm/api/resources/milestoneNotifications/client/requests/MilestoneNotificationPreferencesClientCreate1.d.mts +3 -3
  183. package/dist/esm/api/resources/milestones/client/Client.d.mts +16 -16
  184. package/dist/esm/api/resources/milestones/client/Client.mjs +24 -24
  185. package/dist/esm/api/resources/milestones/client/requests/MilestoneAddToTaskReq.d.mts +1 -1
  186. package/dist/esm/api/resources/milestones/client/requests/MilestoneUpdateReq.d.mts +1 -1
  187. package/dist/esm/api/resources/milestones/client/requests/index.d.mts +1 -1
  188. package/dist/esm/api/resources/milestones/resources/blurhash/client/Client.d.mts +1 -5
  189. package/dist/esm/api/resources/milestones/resources/blurhash/client/Client.mjs +1 -5
  190. package/dist/esm/api/resources/milestones/resources/images/client/Client.d.mts +14 -14
  191. package/dist/esm/api/resources/milestones/resources/images/client/Client.mjs +35 -35
  192. package/dist/esm/api/resources/milestones/resources/index.d.mts +1 -1
  193. package/dist/esm/api/resources/milestones/resources/index.mjs +1 -1
  194. package/dist/esm/api/resources/notifications/client/Client.d.mts +3 -3
  195. package/dist/esm/api/resources/notifications/client/Client.mjs +5 -5
  196. package/dist/esm/api/resources/notifications/resources/courierPreferences/client/Client.d.mts +2 -2
  197. package/dist/esm/api/resources/notifications/resources/courierPreferences/client/Client.mjs +2 -2
  198. package/dist/esm/api/resources/notifications/resources/courierPreferences/client/requests/CourierNotificationPreferencesClientCreate1.d.mts +3 -3
  199. package/dist/esm/api/resources/notifications/resources/index.d.mts +2 -2
  200. package/dist/esm/api/resources/notifications/resources/index.mjs +2 -2
  201. package/dist/esm/api/resources/notifications/resources/shipper/client/Client.d.mts +2 -2
  202. package/dist/esm/api/resources/notifications/resources/shipper/client/Client.mjs +2 -2
  203. package/dist/esm/api/resources/notifications/resources/shipper/client/requests/ShipperNotificationPreferencesClientCreate1.d.mts +3 -3
  204. package/dist/esm/api/resources/offChrtShipperOrgConnectionInfo/client/Client.d.mts +6 -6
  205. package/dist/esm/api/resources/offChrtShipperOrgConnectionInfo/client/Client.mjs +6 -6
  206. package/dist/esm/api/resources/offChrtShipperOrgConnectionInfo/client/requests/OffChrtShipperOrgConnectionInfoClientCreate1.d.mts +8 -8
  207. package/dist/esm/api/resources/offChrtShipperOrgConnectionInfo/client/requests/OffChrtShipperOrgConnectionInfoClientUpdate1.d.mts +4 -4
  208. package/dist/esm/api/resources/orders/client/Client.d.mts +30 -26
  209. package/dist/esm/api/resources/orders/client/Client.mjs +74 -70
  210. package/dist/esm/api/resources/orders/client/requests/CreateOrderReq.d.mts +16 -16
  211. package/dist/esm/api/resources/orders/resources/full/client/Client.d.mts +12 -12
  212. package/dist/esm/api/resources/orders/resources/full/client/Client.mjs +33 -33
  213. package/dist/esm/api/resources/orgConnectionInfos/client/Client.d.mts +3 -3
  214. package/dist/esm/api/resources/orgConnectionInfos/client/Client.mjs +5 -5
  215. package/dist/esm/api/resources/orgConnectionInfos/resources/courier/client/Client.d.mts +5 -5
  216. package/dist/esm/api/resources/orgConnectionInfos/resources/courier/client/Client.mjs +5 -5
  217. package/dist/esm/api/resources/orgConnectionInfos/resources/courier/client/requests/CourierOrgConnectionInfoClientCreate1.d.mts +7 -7
  218. package/dist/esm/api/resources/orgConnectionInfos/resources/courier/client/requests/CourierOrgConnectionInfoClientUpdate1.d.mts +4 -4
  219. package/dist/esm/api/resources/orgConnectionInfos/resources/index.d.mts +2 -2
  220. package/dist/esm/api/resources/orgConnectionInfos/resources/index.mjs +2 -2
  221. package/dist/esm/api/resources/orgConnectionInfos/resources/shipper/client/Client.d.mts +5 -5
  222. package/dist/esm/api/resources/orgConnectionInfos/resources/shipper/client/Client.mjs +5 -5
  223. package/dist/esm/api/resources/orgConnectionInfos/resources/shipper/client/requests/ShipperOrgConnectionInfoClientCreate1.d.mts +7 -7
  224. package/dist/esm/api/resources/orgConnectionInfos/resources/shipper/client/requests/ShipperOrgConnectionInfoClientUpdate1.d.mts +4 -4
  225. package/dist/esm/api/resources/orgProfiles/client/Client.d.mts +15 -17
  226. package/dist/esm/api/resources/orgProfiles/client/Client.mjs +43 -49
  227. package/dist/esm/api/resources/orgProfiles/client/requests/CourierOrgProfileClientCreate3.d.mts +3 -3
  228. package/dist/esm/api/resources/orgProfiles/client/requests/index.d.mts +0 -1
  229. package/dist/esm/api/resources/orgs/client/Client.d.mts +41 -37
  230. package/dist/esm/api/resources/orgs/client/Client.mjs +90 -86
  231. package/dist/esm/api/resources/orgs/client/requests/CreateOrgPublicDataReq.d.mts +3 -3
  232. package/dist/esm/api/resources/orgs/client/requests/UpdateOrgPublicDataReq.d.mts +1 -1
  233. package/dist/esm/api/resources/payments/client/Client.d.mts +3 -7
  234. package/dist/esm/api/resources/payments/client/Client.mjs +3 -7
  235. package/dist/esm/api/resources/root/client/Client.d.mts +19 -13
  236. package/dist/esm/api/resources/root/client/Client.mjs +31 -25
  237. package/dist/esm/api/resources/shipperContactInfo/client/Client.d.mts +42 -42
  238. package/dist/esm/api/resources/shipperContactInfo/client/Client.mjs +90 -90
  239. package/dist/esm/api/resources/shipperContactInfo/client/requests/ShipperContactInfoClientUpdate1.d.mts +4 -4
  240. package/dist/esm/api/resources/taskGroups/client/Client.d.mts +24 -18
  241. package/dist/esm/api/resources/taskGroups/client/Client.mjs +43 -37
  242. package/dist/esm/api/resources/taskGroups/client/requests/UpdateTaskGroupReq.d.mts +2 -2
  243. package/dist/esm/api/resources/taskGroups/resources/full/client/Client.d.mts +2 -2
  244. package/dist/esm/api/resources/taskGroups/resources/full/client/Client.mjs +2 -2
  245. package/dist/esm/api/resources/taskGroups/resources/togglePause/client/Client.d.mts +4 -2
  246. package/dist/esm/api/resources/taskGroups/resources/togglePause/client/Client.mjs +4 -2
  247. package/dist/esm/api/resources/taskGroups/resources/togglePause/client/requests/SetTaskGroupPauseReq.d.mts +3 -3
  248. package/dist/esm/api/resources/users/client/Client.d.mts +2 -0
  249. package/dist/esm/api/resources/users/client/Client.mjs +2 -0
  250. package/dist/esm/api/types/Cargo1.d.mts +6 -6
  251. package/dist/esm/api/types/CargoClientCreate1.d.mts +3 -3
  252. package/dist/esm/api/types/CourierNotificationPreferences1.d.mts +9 -9
  253. package/dist/esm/api/types/CourierOrgConnectionInfo1.d.mts +10 -10
  254. package/dist/esm/api/types/CourierOrgProfile3.d.mts +3 -3
  255. package/dist/esm/api/types/CourierPayDriverLineItemGroup1.d.mts +5 -5
  256. package/dist/esm/api/types/CourierPayDriverLineItemGroupClientCreate1.d.mts +1 -1
  257. package/dist/esm/api/types/CourierPayDriverRateSheet1.d.mts +16 -16
  258. package/dist/esm/api/types/DecodedJwtWithOrgAndUserId.d.mts +8 -8
  259. package/dist/esm/api/types/Driver1.d.mts +6 -6
  260. package/dist/esm/api/types/Expense1.d.mts +3 -3
  261. package/dist/esm/api/types/Feature.d.mts +3 -3
  262. package/dist/esm/api/types/GetOrderFullRes.d.mts +2 -2
  263. package/dist/esm/api/types/Incident1.d.mts +1 -1
  264. package/dist/esm/api/types/Insurance1.d.mts +1 -1
  265. package/dist/esm/api/types/LineItem1.d.mts +1 -1
  266. package/dist/esm/api/types/Milestone1.d.mts +13 -13
  267. package/dist/esm/api/types/MilestoneClientCreate1.d.mts +1 -1
  268. package/dist/esm/api/types/MilestoneNotificationPreferences1.d.mts +9 -9
  269. package/dist/esm/api/types/OffChrtShipperOrgConnectionInfo1.d.mts +11 -11
  270. package/dist/esm/api/types/Order1.d.mts +11 -11
  271. package/dist/esm/api/types/OrgMemberDetails.d.mts +2 -2
  272. package/dist/esm/api/types/OrgMembersAndDrivers.d.mts +1 -1
  273. package/dist/esm/api/types/OrgPublicData2.d.mts +4 -4
  274. package/dist/esm/api/types/PayablesInvoice1.d.mts +11 -11
  275. package/dist/esm/api/types/ReceivablesInvoice1.d.mts +7 -7
  276. package/dist/esm/api/types/ShipperContactInfo1.d.mts +11 -11
  277. package/dist/esm/api/types/ShipperContactInfoClientCreate1.d.mts +6 -6
  278. package/dist/esm/api/types/ShipperCourierConnection1.d.mts +4 -4
  279. package/dist/esm/api/types/ShipperNotificationPreferences1.d.mts +9 -9
  280. package/dist/esm/api/types/ShipperOrgConnectionInfo1.d.mts +6 -6
  281. package/dist/esm/api/types/StripeConnectInvoice1.d.mts +5 -5
  282. package/dist/esm/api/types/Task1.d.mts +13 -13
  283. package/dist/esm/api/types/TaskClientCreate1.d.mts +4 -4
  284. package/dist/esm/api/types/TaskCreateBundle.d.mts +2 -2
  285. package/dist/esm/api/types/TaskGroup1.d.mts +11 -11
  286. package/dist/esm/api/types/TaskWithDetails.d.mts +2 -2
  287. package/dist/esm/api/types/Tracker1.d.mts +1 -1
  288. package/dist/esm/api/types/TrackerSession1.d.mts +1 -1
  289. package/dist/esm/api/types/UserPublicData6.d.mts +6 -6
  290. package/dist/esm/api/types/Vehicle1.d.mts +1 -1
  291. package/dist/esm/version.d.mts +1 -1
  292. package/dist/esm/version.mjs +1 -1
  293. package/package.json +1 -1
  294. package/reference.md +1196 -764
  295. package/dist/cjs/api/resources/courierPayDriverRateSheets/client/requests/CourierPayDriverRateSheetsGetRequest.d.ts +0 -11
  296. package/dist/cjs/api/resources/courierPayDriverRateSheets/client/requests/CourierPayDriverRateSheetsGetRequest.js +0 -5
  297. package/dist/cjs/api/resources/courierPayDriverRateSheets/types/CourierPayDriverRateSheetsGetResponse.d.ts +0 -5
  298. package/dist/cjs/api/resources/courierPayDriverRateSheets/types/CourierPayDriverRateSheetsGetResponse.js +0 -5
  299. package/dist/cjs/api/resources/courierPayDriverRateSheets/types/index.d.ts +0 -1
  300. package/dist/cjs/api/resources/courierPayDriverRateSheets/types/index.js +0 -17
  301. package/dist/cjs/api/resources/orgProfiles/client/requests/OrgProfilesGetAvatarRequest.d.ts +0 -12
  302. package/dist/cjs/api/resources/orgProfiles/client/requests/OrgProfilesGetAvatarRequest.js +0 -5
  303. package/dist/esm/api/resources/courierPayDriverRateSheets/client/requests/CourierPayDriverRateSheetsGetRequest.d.mts +0 -11
  304. package/dist/esm/api/resources/courierPayDriverRateSheets/client/requests/CourierPayDriverRateSheetsGetRequest.mjs +0 -4
  305. package/dist/esm/api/resources/courierPayDriverRateSheets/types/CourierPayDriverRateSheetsGetResponse.d.mts +0 -5
  306. package/dist/esm/api/resources/courierPayDriverRateSheets/types/CourierPayDriverRateSheetsGetResponse.mjs +0 -4
  307. package/dist/esm/api/resources/courierPayDriverRateSheets/types/index.d.mts +0 -1
  308. package/dist/esm/api/resources/courierPayDriverRateSheets/types/index.mjs +0 -1
  309. package/dist/esm/api/resources/orgProfiles/client/requests/OrgProfilesGetAvatarRequest.d.mts +0 -12
  310. package/dist/esm/api/resources/orgProfiles/client/requests/OrgProfilesGetAvatarRequest.mjs +0 -4
package/reference.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # Reference
2
2
 
3
- ## Root
3
+ ## Dev
4
4
 
5
- <details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">pingUnauthd</a>() -> unknown</code></summary>
5
+ <details><summary><code>client.dev.<a href="/src/api/resources/dev/client/Client.ts">getUserId</a>() -> string</code></summary>
6
6
  <dl>
7
7
  <dd>
8
8
 
@@ -14,7 +14,7 @@
14
14
  <dl>
15
15
  <dd>
16
16
 
17
- Returns a greeting message
17
+ Get the user id from the jwt: This is in the description
18
18
 
19
19
  </dd>
20
20
  </dl>
@@ -30,7 +30,7 @@ Returns a greeting message
30
30
  <dd>
31
31
 
32
32
  ```typescript
33
- await client.root.pingUnauthd();
33
+ await client.dev.getUserId();
34
34
  ```
35
35
 
36
36
  </dd>
@@ -46,7 +46,7 @@ await client.root.pingUnauthd();
46
46
  <dl>
47
47
  <dd>
48
48
 
49
- **requestOptions:** `Root.RequestOptions`
49
+ **requestOptions:** `Dev.RequestOptions`
50
50
 
51
51
  </dd>
52
52
  </dl>
@@ -57,28 +57,11 @@ await client.root.pingUnauthd();
57
57
  </dl>
58
58
  </details>
59
59
 
60
- <details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">pingAuthd</a>() -> Record<string, string></code></summary>
61
- <dl>
62
- <dd>
63
-
64
- #### 🔌 Usage
65
-
66
- <dl>
67
- <dd>
68
-
60
+ <details><summary><code>client.dev.<a href="/src/api/resources/dev/client/Client.ts">getDecodedJwt</a>() -> Chrt.DecodedJwtWithOrgAndUserId</code></summary>
69
61
  <dl>
70
62
  <dd>
71
63
 
72
- ```typescript
73
- await client.root.pingAuthd();
74
- ```
75
-
76
- </dd>
77
- </dl>
78
- </dd>
79
- </dl>
80
-
81
- #### ⚙️ Parameters
64
+ #### 📝 Description
82
65
 
83
66
  <dl>
84
67
  <dd>
@@ -86,21 +69,13 @@ await client.root.pingAuthd();
86
69
  <dl>
87
70
  <dd>
88
71
 
89
- **requestOptions:** `Root.RequestOptions`
72
+ Returns the complete decoded JWT token information for development purposes.
90
73
 
91
74
  </dd>
92
75
  </dl>
93
76
  </dd>
94
77
  </dl>
95
78
 
96
- </dd>
97
- </dl>
98
- </details>
99
-
100
- <details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">failure</a>() -> unknown</code></summary>
101
- <dl>
102
- <dd>
103
-
104
79
  #### 🔌 Usage
105
80
 
106
81
  <dl>
@@ -110,7 +85,7 @@ await client.root.pingAuthd();
110
85
  <dd>
111
86
 
112
87
  ```typescript
113
- await client.root.failure();
88
+ await client.dev.getDecodedJwt();
114
89
  ```
115
90
 
116
91
  </dd>
@@ -126,7 +101,7 @@ await client.root.failure();
126
101
  <dl>
127
102
  <dd>
128
103
 
129
- **requestOptions:** `Root.RequestOptions`
104
+ **requestOptions:** `Dev.RequestOptions`
130
105
 
131
106
  </dd>
132
107
  </dl>
@@ -137,7 +112,7 @@ await client.root.failure();
137
112
  </dl>
138
113
  </details>
139
114
 
140
- <details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">health</a>() -> unknown</code></summary>
115
+ <details><summary><code>client.dev.<a href="/src/api/resources/dev/client/Client.ts">getEmail</a>() -> string</code></summary>
141
116
  <dl>
142
117
  <dd>
143
118
 
@@ -149,7 +124,7 @@ await client.root.failure();
149
124
  <dl>
150
125
  <dd>
151
126
 
152
- Used for monitoring system health
127
+ Retrieves the primary email address for the authenticated user from the authentication service.
153
128
 
154
129
  </dd>
155
130
  </dl>
@@ -165,7 +140,7 @@ Used for monitoring system health
165
140
  <dd>
166
141
 
167
142
  ```typescript
168
- await client.root.health();
143
+ await client.dev.getEmail();
169
144
  ```
170
145
 
171
146
  </dd>
@@ -181,7 +156,7 @@ await client.root.health();
181
156
  <dl>
182
157
  <dd>
183
158
 
184
- **requestOptions:** `Root.RequestOptions`
159
+ **requestOptions:** `Dev.RequestOptions`
185
160
 
186
161
  </dd>
187
162
  </dl>
@@ -192,28 +167,11 @@ await client.root.health();
192
167
  </dl>
193
168
  </details>
194
169
 
195
- <details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">pingOptionallyAuthd</a>() -> unknown</code></summary>
196
- <dl>
197
- <dd>
198
-
199
- #### 🔌 Usage
200
-
201
- <dl>
202
- <dd>
203
-
170
+ <details><summary><code>client.dev.<a href="/src/api/resources/dev/client/Client.ts">getGitInfo</a>() -> Record<string, string></code></summary>
204
171
  <dl>
205
172
  <dd>
206
173
 
207
- ```typescript
208
- await client.root.pingOptionallyAuthd();
209
- ```
210
-
211
- </dd>
212
- </dl>
213
- </dd>
214
- </dl>
215
-
216
- #### ⚙️ Parameters
174
+ #### 📝 Description
217
175
 
218
176
  <dl>
219
177
  <dd>
@@ -221,23 +179,13 @@ await client.root.pingOptionallyAuthd();
221
179
  <dl>
222
180
  <dd>
223
181
 
224
- **requestOptions:** `Root.RequestOptions`
182
+ Returns the current GitHub PR number and commit hash for the deployment.
225
183
 
226
184
  </dd>
227
185
  </dl>
228
186
  </dd>
229
187
  </dl>
230
188
 
231
- </dd>
232
- </dl>
233
- </details>
234
-
235
- ## Dev
236
-
237
- <details><summary><code>client.dev.<a href="/src/api/resources/dev/client/Client.ts">getDecodedJwt</a>() -> Chrt.DecodedJwtWithOrgAndUserId</code></summary>
238
- <dl>
239
- <dd>
240
-
241
189
  #### 🔌 Usage
242
190
 
243
191
  <dl>
@@ -247,7 +195,7 @@ await client.root.pingOptionallyAuthd();
247
195
  <dd>
248
196
 
249
197
  ```typescript
250
- await client.dev.getDecodedJwt();
198
+ await client.dev.getGitInfo();
251
199
  ```
252
200
 
253
201
  </dd>
@@ -274,28 +222,11 @@ await client.dev.getDecodedJwt();
274
222
  </dl>
275
223
  </details>
276
224
 
277
- <details><summary><code>client.dev.<a href="/src/api/resources/dev/client/Client.ts">getEmail</a>() -> string</code></summary>
278
- <dl>
279
- <dd>
280
-
281
- #### 🔌 Usage
282
-
283
- <dl>
284
- <dd>
285
-
225
+ <details><summary><code>client.dev.<a href="/src/api/resources/dev/client/Client.ts">getTemplate</a>() -> string</code></summary>
286
226
  <dl>
287
227
  <dd>
288
228
 
289
- ```typescript
290
- await client.dev.getEmail();
291
- ```
292
-
293
- </dd>
294
- </dl>
295
- </dd>
296
- </dl>
297
-
298
- #### ⚙️ Parameters
229
+ #### 📝 Description
299
230
 
300
231
  <dl>
301
232
  <dd>
@@ -303,21 +234,13 @@ await client.dev.getEmail();
303
234
  <dl>
304
235
  <dd>
305
236
 
306
- **requestOptions:** `Dev.RequestOptions`
237
+ Development template endpoint that returns the authenticated user's ID for testing.
307
238
 
308
239
  </dd>
309
240
  </dl>
310
241
  </dd>
311
242
  </dl>
312
243
 
313
- </dd>
314
- </dl>
315
- </details>
316
-
317
- <details><summary><code>client.dev.<a href="/src/api/resources/dev/client/Client.ts">getTemplate</a>() -> string</code></summary>
318
- <dl>
319
- <dd>
320
-
321
244
  #### 🔌 Usage
322
245
 
323
246
  <dl>
@@ -358,6 +281,21 @@ await client.dev.getTemplate();
358
281
  <dl>
359
282
  <dd>
360
283
 
284
+ #### 📝 Description
285
+
286
+ <dl>
287
+ <dd>
288
+
289
+ <dl>
290
+ <dd>
291
+
292
+ Development template endpoint that demonstrates transaction handling and request mirroring.
293
+
294
+ </dd>
295
+ </dl>
296
+ </dd>
297
+ </dl>
298
+
361
299
  #### 🔌 Usage
362
300
 
363
301
  <dl>
@@ -406,7 +344,9 @@ await client.dev.createTemplate({
406
344
  </dl>
407
345
  </details>
408
346
 
409
- <details><summary><code>client.dev.<a href="/src/api/resources/dev/client/Client.ts">getUserId</a>() -> string</code></summary>
347
+ ## Drivers
348
+
349
+ <details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">listOrgMembersAndDrivers</a>() -> Chrt.OrgMembersAndDrivers[]</code></summary>
410
350
  <dl>
411
351
  <dd>
412
352
 
@@ -418,7 +358,7 @@ await client.dev.createTemplate({
418
358
  <dl>
419
359
  <dd>
420
360
 
421
- Get the user id from the jwt: This is in the description
361
+ Lists all organization members paired with their driver information if they are drivers.
422
362
 
423
363
  </dd>
424
364
  </dl>
@@ -434,7 +374,7 @@ Get the user id from the jwt: This is in the description
434
374
  <dd>
435
375
 
436
376
  ```typescript
437
- await client.dev.getUserId();
377
+ await client.drivers.listOrgMembersAndDrivers();
438
378
  ```
439
379
 
440
380
  </dd>
@@ -450,7 +390,7 @@ await client.dev.getUserId();
450
390
  <dl>
451
391
  <dd>
452
392
 
453
- **requestOptions:** `Dev.RequestOptions`
393
+ **requestOptions:** `Drivers.RequestOptions`
454
394
 
455
395
  </dd>
456
396
  </dl>
@@ -461,9 +401,7 @@ await client.dev.getUserId();
461
401
  </dl>
462
402
  </details>
463
403
 
464
- ## Connections
465
-
466
- <details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">listCouriers</a>() -> Chrt.CourierOrgConnectionInfo1[]</code></summary>
404
+ <details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">list</a>() -> Chrt.Driver1[]</code></summary>
467
405
  <dl>
468
406
  <dd>
469
407
 
@@ -475,7 +413,7 @@ await client.dev.getUserId();
475
413
  <dl>
476
414
  <dd>
477
415
 
478
- List all couriers connected to the current org
416
+ Lists all drivers belonging to the authenticated organization.
479
417
 
480
418
  </dd>
481
419
  </dl>
@@ -491,7 +429,7 @@ List all couriers connected to the current org
491
429
  <dd>
492
430
 
493
431
  ```typescript
494
- await client.connections.listCouriers();
432
+ await client.drivers.list();
495
433
  ```
496
434
 
497
435
  </dd>
@@ -507,7 +445,7 @@ await client.connections.listCouriers();
507
445
  <dl>
508
446
  <dd>
509
447
 
510
- **requestOptions:** `Connections.RequestOptions`
448
+ **requestOptions:** `Drivers.RequestOptions`
511
449
 
512
450
  </dd>
513
451
  </dl>
@@ -518,7 +456,7 @@ await client.connections.listCouriers();
518
456
  </dl>
519
457
  </details>
520
458
 
521
- <details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">listShippers</a>() -> Chrt.ShipperOrgConnectionInfo1[]</code></summary>
459
+ <details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">create</a>({ ...params }) -> string</code></summary>
522
460
  <dl>
523
461
  <dd>
524
462
 
@@ -530,7 +468,7 @@ await client.connections.listCouriers();
530
468
  <dl>
531
469
  <dd>
532
470
 
533
- List all shippers connected to the current org
471
+ Creates a new driver profile for an organization member with optional vehicle type assignments.
534
472
 
535
473
  </dd>
536
474
  </dl>
@@ -546,7 +484,12 @@ List all shippers connected to the current org
546
484
  <dd>
547
485
 
548
486
  ```typescript
549
- await client.connections.listShippers();
487
+ await client.drivers.create({
488
+ org_member: {
489
+ role: "role",
490
+ user_id: "user_id",
491
+ },
492
+ });
550
493
  ```
551
494
 
552
495
  </dd>
@@ -562,7 +505,15 @@ await client.connections.listShippers();
562
505
  <dl>
563
506
  <dd>
564
507
 
565
- **requestOptions:** `Connections.RequestOptions`
508
+ **request:** `Chrt.DriverCreateReq`
509
+
510
+ </dd>
511
+ </dl>
512
+
513
+ <dl>
514
+ <dd>
515
+
516
+ **requestOptions:** `Drivers.RequestOptions`
566
517
 
567
518
  </dd>
568
519
  </dl>
@@ -573,9 +524,7 @@ await client.connections.listShippers();
573
524
  </dl>
574
525
  </details>
575
526
 
576
- ## CourierPayDriverLineItemGroup
577
-
578
- <details><summary><code>client.courierPayDriverLineItemGroup.<a href="/src/api/resources/courierPayDriverLineItemGroup/client/Client.ts">byTaskGroupId</a>(taskGroupId) -> Chrt.CourierPayDriverLineItemGroup1</code></summary>
527
+ <details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">get</a>() -> Chrt.Driver1</code></summary>
579
528
  <dl>
580
529
  <dd>
581
530
 
@@ -587,7 +536,7 @@ await client.connections.listShippers();
587
536
  <dl>
588
537
  <dd>
589
538
 
590
- Get a courier pay driver line item group by task group ID
539
+ Retrieves driver information for the authenticated user within their organization.
591
540
 
592
541
  </dd>
593
542
  </dl>
@@ -603,7 +552,7 @@ Get a courier pay driver line item group by task group ID
603
552
  <dd>
604
553
 
605
554
  ```typescript
606
- await client.courierPayDriverLineItemGroup.byTaskGroupId("task_group_id");
555
+ await client.drivers.get();
607
556
  ```
608
557
 
609
558
  </dd>
@@ -619,15 +568,7 @@ await client.courierPayDriverLineItemGroup.byTaskGroupId("task_group_id");
619
568
  <dl>
620
569
  <dd>
621
570
 
622
- **taskGroupId:** `string`
623
-
624
- </dd>
625
- </dl>
626
-
627
- <dl>
628
- <dd>
629
-
630
- **requestOptions:** `CourierPayDriverLineItemGroup.RequestOptions`
571
+ **requestOptions:** `Drivers.RequestOptions`
631
572
 
632
573
  </dd>
633
574
  </dl>
@@ -638,7 +579,7 @@ await client.courierPayDriverLineItemGroup.byTaskGroupId("task_group_id");
638
579
  </dl>
639
580
  </details>
640
581
 
641
- <details><summary><code>client.courierPayDriverLineItemGroup.<a href="/src/api/resources/courierPayDriverLineItemGroup/client/Client.ts">create</a>({ ...params }) -> string</code></summary>
582
+ <details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">getByDriverId</a>(driverId) -> Chrt.Driver1</code></summary>
642
583
  <dl>
643
584
  <dd>
644
585
 
@@ -650,7 +591,7 @@ await client.courierPayDriverLineItemGroup.byTaskGroupId("task_group_id");
650
591
  <dl>
651
592
  <dd>
652
593
 
653
- Create a courier pay driver line item group by calculating line items from rate sheet and task group
594
+ Retrieves detailed driver information by driver ID within the organization.
654
595
 
655
596
  </dd>
656
597
  </dl>
@@ -666,10 +607,7 @@ Create a courier pay driver line item group by calculating line items from rate
666
607
  <dd>
667
608
 
668
609
  ```typescript
669
- await client.courierPayDriverLineItemGroup.create({
670
- courier_pay_driver_rate_sheet_id: "courier_pay_driver_rate_sheet_id",
671
- task_group_id: "task_group_id",
672
- });
610
+ await client.drivers.getByDriverId("driver_id");
673
611
  ```
674
612
 
675
613
  </dd>
@@ -685,7 +623,7 @@ await client.courierPayDriverLineItemGroup.create({
685
623
  <dl>
686
624
  <dd>
687
625
 
688
- **request:** `Chrt.CourierPayDriverLineItemGroupCreateRequest`
626
+ **driverId:** `string`
689
627
 
690
628
  </dd>
691
629
  </dl>
@@ -693,7 +631,7 @@ await client.courierPayDriverLineItemGroup.create({
693
631
  <dl>
694
632
  <dd>
695
633
 
696
- **requestOptions:** `CourierPayDriverLineItemGroup.RequestOptions`
634
+ **requestOptions:** `Drivers.RequestOptions`
697
635
 
698
636
  </dd>
699
637
  </dl>
@@ -704,7 +642,7 @@ await client.courierPayDriverLineItemGroup.create({
704
642
  </dl>
705
643
  </details>
706
644
 
707
- <details><summary><code>client.courierPayDriverLineItemGroup.<a href="/src/api/resources/courierPayDriverLineItemGroup/client/Client.ts">preview</a>({ ...params }) -> Chrt.CourierPayDriverLineItemGroupClientCreate1</code></summary>
645
+ <details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">delete</a>(driverId) -> boolean</code></summary>
708
646
  <dl>
709
647
  <dd>
710
648
 
@@ -716,7 +654,7 @@ await client.courierPayDriverLineItemGroup.create({
716
654
  <dl>
717
655
  <dd>
718
656
 
719
- Calculate a courier pay driver line item group
657
+ Deletes a driver from the organization and removes them from associated rate sheets.
720
658
 
721
659
  </dd>
722
660
  </dl>
@@ -732,10 +670,7 @@ Calculate a courier pay driver line item group
732
670
  <dd>
733
671
 
734
672
  ```typescript
735
- await client.courierPayDriverLineItemGroup.preview({
736
- courier_pay_driver_rate_sheet_id: "courier_pay_driver_rate_sheet_id",
737
- task_group_id: "task_group_id",
738
- });
673
+ await client.drivers.delete("driver_id");
739
674
  ```
740
675
 
741
676
  </dd>
@@ -751,7 +686,7 @@ await client.courierPayDriverLineItemGroup.preview({
751
686
  <dl>
752
687
  <dd>
753
688
 
754
- **request:** `Chrt.CourierPayDriverLineItemGroupPreviewRequest`
689
+ **driverId:** `string`
755
690
 
756
691
  </dd>
757
692
  </dl>
@@ -759,7 +694,7 @@ await client.courierPayDriverLineItemGroup.preview({
759
694
  <dl>
760
695
  <dd>
761
696
 
762
- **requestOptions:** `CourierPayDriverLineItemGroup.RequestOptions`
697
+ **requestOptions:** `Drivers.RequestOptions`
763
698
 
764
699
  </dd>
765
700
  </dl>
@@ -770,7 +705,7 @@ await client.courierPayDriverLineItemGroup.preview({
770
705
  </dl>
771
706
  </details>
772
707
 
773
- <details><summary><code>client.courierPayDriverLineItemGroup.<a href="/src/api/resources/courierPayDriverLineItemGroup/client/Client.ts">getById</a>(id) -> Chrt.CourierPayDriverLineItemGroup1</code></summary>
708
+ <details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">setActivation</a>({ ...params }) -> boolean</code></summary>
774
709
  <dl>
775
710
  <dd>
776
711
 
@@ -782,7 +717,7 @@ await client.courierPayDriverLineItemGroup.preview({
782
717
  <dl>
783
718
  <dd>
784
719
 
785
- Get a courier pay driver line item group by ID
720
+ Sets the activation status of a driver (active/inactive) within the organization.
786
721
 
787
722
  </dd>
788
723
  </dl>
@@ -798,7 +733,10 @@ Get a courier pay driver line item group by ID
798
733
  <dd>
799
734
 
800
735
  ```typescript
801
- await client.courierPayDriverLineItemGroup.getById("id");
736
+ await client.drivers.setActivation({
737
+ driver_object_id: "driver_object_id",
738
+ active: true,
739
+ });
802
740
  ```
803
741
 
804
742
  </dd>
@@ -814,7 +752,7 @@ await client.courierPayDriverLineItemGroup.getById("id");
814
752
  <dl>
815
753
  <dd>
816
754
 
817
- **id:** `string`
755
+ **request:** `Chrt.SetDriverActivationReq`
818
756
 
819
757
  </dd>
820
758
  </dl>
@@ -822,7 +760,7 @@ await client.courierPayDriverLineItemGroup.getById("id");
822
760
  <dl>
823
761
  <dd>
824
762
 
825
- **requestOptions:** `CourierPayDriverLineItemGroup.RequestOptions`
763
+ **requestOptions:** `Drivers.RequestOptions`
826
764
 
827
765
  </dd>
828
766
  </dl>
@@ -833,9 +771,7 @@ await client.courierPayDriverLineItemGroup.getById("id");
833
771
  </dl>
834
772
  </details>
835
773
 
836
- ## CourierPayDriverPayouts
837
-
838
- <details><summary><code>client.courierPayDriverPayouts.<a href="/src/api/resources/courierPayDriverPayouts/client/Client.ts">create</a>({ ...params }) -> string</code></summary>
774
+ <details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">lastSeen</a>({ ...params }) -> boolean</code></summary>
839
775
  <dl>
840
776
  <dd>
841
777
 
@@ -847,7 +783,7 @@ await client.courierPayDriverLineItemGroup.getById("id");
847
783
  <dl>
848
784
  <dd>
849
785
 
850
- Create a new courier pay driver payout from selected line item groups
786
+ Updates the driver's last known location and timestamp for tracking purposes.
851
787
 
852
788
  </dd>
853
789
  </dl>
@@ -863,9 +799,10 @@ Create a new courier pay driver payout from selected line item groups
863
799
  <dd>
864
800
 
865
801
  ```typescript
866
- await client.courierPayDriverPayouts.create({
867
- line_item_group_ids: ["line_item_group_ids"],
868
- schema_version: 1,
802
+ await client.drivers.lastSeen({
803
+ location: {
804
+ type: "Feature",
805
+ },
869
806
  });
870
807
  ```
871
808
 
@@ -882,7 +819,7 @@ await client.courierPayDriverPayouts.create({
882
819
  <dl>
883
820
  <dd>
884
821
 
885
- **request:** `Chrt.CourierPayDriverPayoutClientCreate1`
822
+ **request:** `Chrt.DriverLastSeenReq`
886
823
 
887
824
  </dd>
888
825
  </dl>
@@ -890,7 +827,7 @@ await client.courierPayDriverPayouts.create({
890
827
  <dl>
891
828
  <dd>
892
829
 
893
- **requestOptions:** `CourierPayDriverPayouts.RequestOptions`
830
+ **requestOptions:** `Drivers.RequestOptions`
894
831
 
895
832
  </dd>
896
833
  </dl>
@@ -901,10 +838,25 @@ await client.courierPayDriverPayouts.create({
901
838
  </dl>
902
839
  </details>
903
840
 
904
- <details><summary><code>client.courierPayDriverPayouts.<a href="/src/api/resources/courierPayDriverPayouts/client/Client.ts">listByDriverId</a>(driverId) -> unknown</code></summary>
841
+ <details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">updateDriver</a>({ ...params }) -> boolean</code></summary>
842
+ <dl>
843
+ <dd>
844
+
845
+ #### 📝 Description
846
+
847
+ <dl>
848
+ <dd>
849
+
905
850
  <dl>
906
851
  <dd>
907
852
 
853
+ Updates driver contact details and vehicle type assignments within the organization.
854
+
855
+ </dd>
856
+ </dl>
857
+ </dd>
858
+ </dl>
859
+
908
860
  #### 🔌 Usage
909
861
 
910
862
  <dl>
@@ -914,7 +866,9 @@ await client.courierPayDriverPayouts.create({
914
866
  <dd>
915
867
 
916
868
  ```typescript
917
- await client.courierPayDriverPayouts.listByDriverId("driver_id");
869
+ await client.drivers.updateDriver({
870
+ driver_object_id: "driver_object_id",
871
+ });
918
872
  ```
919
873
 
920
874
  </dd>
@@ -930,7 +884,7 @@ await client.courierPayDriverPayouts.listByDriverId("driver_id");
930
884
  <dl>
931
885
  <dd>
932
886
 
933
- **driverId:** `string`
887
+ **request:** `Chrt.UpdateDriverDetailsReq`
934
888
 
935
889
  </dd>
936
890
  </dl>
@@ -938,7 +892,7 @@ await client.courierPayDriverPayouts.listByDriverId("driver_id");
938
892
  <dl>
939
893
  <dd>
940
894
 
941
- **requestOptions:** `CourierPayDriverPayouts.RequestOptions`
895
+ **requestOptions:** `Drivers.RequestOptions`
942
896
 
943
897
  </dd>
944
898
  </dl>
@@ -949,11 +903,28 @@ await client.courierPayDriverPayouts.listByDriverId("driver_id");
949
903
  </dl>
950
904
  </details>
951
905
 
952
- <details><summary><code>client.courierPayDriverPayouts.<a href="/src/api/resources/courierPayDriverPayouts/client/Client.ts">getById</a>(id) -> unknown</code></summary>
906
+ ## Milestones
907
+
908
+ <details><summary><code>client.milestones.<a href="/src/api/resources/milestones/client/Client.ts">update</a>({ ...params }) -> boolean</code></summary>
953
909
  <dl>
954
910
  <dd>
955
911
 
956
- #### 🔌 Usage
912
+ #### 📝 Description
913
+
914
+ <dl>
915
+ <dd>
916
+
917
+ <dl>
918
+ <dd>
919
+
920
+ Updates milestone completion status and comments, recalculating task and order statuses.
921
+
922
+ </dd>
923
+ </dl>
924
+ </dd>
925
+ </dl>
926
+
927
+ #### 🔌 Usage
957
928
 
958
929
  <dl>
959
930
  <dd>
@@ -962,7 +933,9 @@ await client.courierPayDriverPayouts.listByDriverId("driver_id");
962
933
  <dd>
963
934
 
964
935
  ```typescript
965
- await client.courierPayDriverPayouts.getById("id");
936
+ await client.milestones.update({
937
+ milestone_id: "milestone_id",
938
+ });
966
939
  ```
967
940
 
968
941
  </dd>
@@ -978,7 +951,7 @@ await client.courierPayDriverPayouts.getById("id");
978
951
  <dl>
979
952
  <dd>
980
953
 
981
- **id:** `string`
954
+ **request:** `Chrt.MilestoneUpdateReq`
982
955
 
983
956
  </dd>
984
957
  </dl>
@@ -986,7 +959,7 @@ await client.courierPayDriverPayouts.getById("id");
986
959
  <dl>
987
960
  <dd>
988
961
 
989
- **requestOptions:** `CourierPayDriverPayouts.RequestOptions`
962
+ **requestOptions:** `Milestones.RequestOptions`
990
963
 
991
964
  </dd>
992
965
  </dl>
@@ -997,9 +970,7 @@ await client.courierPayDriverPayouts.getById("id");
997
970
  </dl>
998
971
  </details>
999
972
 
1000
- ## CourierPayDriverRateSheets
1001
-
1002
- <details><summary><code>client.courierPayDriverRateSheets.<a href="/src/api/resources/courierPayDriverRateSheets/client/Client.ts">create</a>({ ...params }) -> string</code></summary>
973
+ <details><summary><code>client.milestones.<a href="/src/api/resources/milestones/client/Client.ts">addToTask</a>({ ...params }) -> boolean</code></summary>
1003
974
  <dl>
1004
975
  <dd>
1005
976
 
@@ -1011,7 +982,7 @@ await client.courierPayDriverPayouts.getById("id");
1011
982
  <dl>
1012
983
  <dd>
1013
984
 
1014
- This is for creating a rate sheet
985
+ Adds a new milestone to an existing task and updates task completion status.
1015
986
 
1016
987
  </dd>
1017
988
  </dl>
@@ -1027,22 +998,9 @@ This is for creating a rate sheet
1027
998
  <dd>
1028
999
 
1029
1000
  ```typescript
1030
- await client.courierPayDriverRateSheets.create({
1031
- additional_mileage_rate_usd_per_mile: 1.1,
1032
- after_hours: 1.1,
1033
- base_mileage_distance_miles: 1.1,
1034
- base_mileage_rate_usd_per_instance: 1.1,
1035
- courier_org_id: "courier_org_id",
1036
- dangerous_goods_rate_usd_per_instance: 1.1,
1037
- extra_stop_rate_usd: 1.1,
1038
- fuel_surchage_rate_usd_per_mile: 1.1,
1039
- holiday: 1.1,
1040
- long_distance_surcharge_miles_before_surcharge: 1.1,
1041
- long_distance_surcharge_rate_usd_per_mile: 1.1,
1042
- schema_version: 1,
1043
- wait_time_before_charge_minutes: 1.1,
1044
- wait_time_rate_usd_per_minute: 1.1,
1045
- weekend: 1.1,
1001
+ await client.milestones.addToTask({
1002
+ task_id: "task_id",
1003
+ type: "image",
1046
1004
  });
1047
1005
  ```
1048
1006
 
@@ -1059,7 +1017,7 @@ await client.courierPayDriverRateSheets.create({
1059
1017
  <dl>
1060
1018
  <dd>
1061
1019
 
1062
- **request:** `Chrt.CourierPayDriverRateSheetClientCreate1`
1020
+ **request:** `Chrt.MilestoneAddToTaskReq`
1063
1021
 
1064
1022
  </dd>
1065
1023
  </dl>
@@ -1067,7 +1025,7 @@ await client.courierPayDriverRateSheets.create({
1067
1025
  <dl>
1068
1026
  <dd>
1069
1027
 
1070
- **requestOptions:** `CourierPayDriverRateSheets.RequestOptions`
1028
+ **requestOptions:** `Milestones.RequestOptions`
1071
1029
 
1072
1030
  </dd>
1073
1031
  </dl>
@@ -1078,7 +1036,9 @@ await client.courierPayDriverRateSheets.create({
1078
1036
  </dl>
1079
1037
  </details>
1080
1038
 
1081
- <details><summary><code>client.courierPayDriverRateSheets.<a href="/src/api/resources/courierPayDriverRateSheets/client/Client.ts">get</a>({ ...params }) -> Chrt.CourierPayDriverRateSheetsGetResponse</code></summary>
1039
+ ## OffChrtShipperOrgConnectionInfo
1040
+
1041
+ <details><summary><code>client.offChrtShipperOrgConnectionInfo.<a href="/src/api/resources/offChrtShipperOrgConnectionInfo/client/Client.ts">create</a>({ ...params }) -> string</code></summary>
1082
1042
  <dl>
1083
1043
  <dd>
1084
1044
 
@@ -1090,7 +1050,7 @@ await client.courierPayDriverRateSheets.create({
1090
1050
  <dl>
1091
1051
  <dd>
1092
1052
 
1093
- Get rate sheet(s) by rate sheet ID or driver ID
1053
+ Creates connection information for working with off-platform shipper organizations.
1094
1054
 
1095
1055
  </dd>
1096
1056
  </dl>
@@ -1106,7 +1066,10 @@ Get rate sheet(s) by rate sheet ID or driver ID
1106
1066
  <dd>
1107
1067
 
1108
1068
  ```typescript
1109
- await client.courierPayDriverRateSheets.get();
1069
+ await client.offChrtShipperOrgConnectionInfo.create({
1070
+ schema_version: 1,
1071
+ email_address_primary: "email_address_primary",
1072
+ });
1110
1073
  ```
1111
1074
 
1112
1075
  </dd>
@@ -1122,7 +1085,7 @@ await client.courierPayDriverRateSheets.get();
1122
1085
  <dl>
1123
1086
  <dd>
1124
1087
 
1125
- **request:** `Chrt.CourierPayDriverRateSheetsGetRequest`
1088
+ **request:** `Chrt.OffChrtShipperOrgConnectionInfoClientCreate1`
1126
1089
 
1127
1090
  </dd>
1128
1091
  </dl>
@@ -1130,7 +1093,7 @@ await client.courierPayDriverRateSheets.get();
1130
1093
  <dl>
1131
1094
  <dd>
1132
1095
 
1133
- **requestOptions:** `CourierPayDriverRateSheets.RequestOptions`
1096
+ **requestOptions:** `OffChrtShipperOrgConnectionInfo.RequestOptions`
1134
1097
 
1135
1098
  </dd>
1136
1099
  </dl>
@@ -1141,7 +1104,7 @@ await client.courierPayDriverRateSheets.get();
1141
1104
  </dl>
1142
1105
  </details>
1143
1106
 
1144
- <details><summary><code>client.courierPayDriverRateSheets.<a href="/src/api/resources/courierPayDriverRateSheets/client/Client.ts">listByCourierOrgId</a>() -> Chrt.CourierPayDriverRateSheet1[]</code></summary>
1107
+ <details><summary><code>client.offChrtShipperOrgConnectionInfo.<a href="/src/api/resources/offChrtShipperOrgConnectionInfo/client/Client.ts">list</a>() -> Chrt.OffChrtShipperOrgConnectionInfo1[]</code></summary>
1145
1108
  <dl>
1146
1109
  <dd>
1147
1110
 
@@ -1153,7 +1116,7 @@ await client.courierPayDriverRateSheets.get();
1153
1116
  <dl>
1154
1117
  <dd>
1155
1118
 
1156
- This is for getting a list of all rate sheets by courier org id from the JWT
1119
+ Lists all off-platform shipper connections created by the authenticated organization.
1157
1120
 
1158
1121
  </dd>
1159
1122
  </dl>
@@ -1169,7 +1132,7 @@ This is for getting a list of all rate sheets by courier org id from the JWT
1169
1132
  <dd>
1170
1133
 
1171
1134
  ```typescript
1172
- await client.courierPayDriverRateSheets.listByCourierOrgId();
1135
+ await client.offChrtShipperOrgConnectionInfo.list();
1173
1136
  ```
1174
1137
 
1175
1138
  </dd>
@@ -1185,7 +1148,7 @@ await client.courierPayDriverRateSheets.listByCourierOrgId();
1185
1148
  <dl>
1186
1149
  <dd>
1187
1150
 
1188
- **requestOptions:** `CourierPayDriverRateSheets.RequestOptions`
1151
+ **requestOptions:** `OffChrtShipperOrgConnectionInfo.RequestOptions`
1189
1152
 
1190
1153
  </dd>
1191
1154
  </dl>
@@ -1196,7 +1159,7 @@ await client.courierPayDriverRateSheets.listByCourierOrgId();
1196
1159
  </dl>
1197
1160
  </details>
1198
1161
 
1199
- <details><summary><code>client.courierPayDriverRateSheets.<a href="/src/api/resources/courierPayDriverRateSheets/client/Client.ts">deleteById</a>(id) -> boolean</code></summary>
1162
+ <details><summary><code>client.offChrtShipperOrgConnectionInfo.<a href="/src/api/resources/offChrtShipperOrgConnectionInfo/client/Client.ts">getById</a>(id) -> Chrt.OffChrtShipperOrgConnectionInfo1</code></summary>
1200
1163
  <dl>
1201
1164
  <dd>
1202
1165
 
@@ -1208,7 +1171,7 @@ await client.courierPayDriverRateSheets.listByCourierOrgId();
1208
1171
  <dl>
1209
1172
  <dd>
1210
1173
 
1211
- Delete a rate sheet scoped to the caller's org
1174
+ Retrieves specific off-platform shipper connection information by ID.
1212
1175
 
1213
1176
  </dd>
1214
1177
  </dl>
@@ -1224,7 +1187,7 @@ Delete a rate sheet scoped to the caller's org
1224
1187
  <dd>
1225
1188
 
1226
1189
  ```typescript
1227
- await client.courierPayDriverRateSheets.deleteById("id");
1190
+ await client.offChrtShipperOrgConnectionInfo.getById("id");
1228
1191
  ```
1229
1192
 
1230
1193
  </dd>
@@ -1248,7 +1211,7 @@ await client.courierPayDriverRateSheets.deleteById("id");
1248
1211
  <dl>
1249
1212
  <dd>
1250
1213
 
1251
- **requestOptions:** `CourierPayDriverRateSheets.RequestOptions`
1214
+ **requestOptions:** `OffChrtShipperOrgConnectionInfo.RequestOptions`
1252
1215
 
1253
1216
  </dd>
1254
1217
  </dl>
@@ -1259,7 +1222,7 @@ await client.courierPayDriverRateSheets.deleteById("id");
1259
1222
  </dl>
1260
1223
  </details>
1261
1224
 
1262
- <details><summary><code>client.courierPayDriverRateSheets.<a href="/src/api/resources/courierPayDriverRateSheets/client/Client.ts">updateById</a>(id, { ...params }) -> Chrt.CourierPayDriverRateSheet1</code></summary>
1225
+ <details><summary><code>client.offChrtShipperOrgConnectionInfo.<a href="/src/api/resources/offChrtShipperOrgConnectionInfo/client/Client.ts">updateById</a>(id, { ...params }) -> boolean</code></summary>
1263
1226
  <dl>
1264
1227
  <dd>
1265
1228
 
@@ -1271,7 +1234,7 @@ await client.courierPayDriverRateSheets.deleteById("id");
1271
1234
  <dl>
1272
1235
  <dd>
1273
1236
 
1274
- Update a rate sheet
1237
+ Updates existing off-platform shipper connection information owned by the authenticated organization.
1275
1238
 
1276
1239
  </dd>
1277
1240
  </dl>
@@ -1287,7 +1250,7 @@ Update a rate sheet
1287
1250
  <dd>
1288
1251
 
1289
1252
  ```typescript
1290
- await client.courierPayDriverRateSheets.updateById("id");
1253
+ await client.offChrtShipperOrgConnectionInfo.updateById("id");
1291
1254
  ```
1292
1255
 
1293
1256
  </dd>
@@ -1311,7 +1274,7 @@ await client.courierPayDriverRateSheets.updateById("id");
1311
1274
  <dl>
1312
1275
  <dd>
1313
1276
 
1314
- **request:** `Chrt.CourierPayDriverRateSheetClientUpdate1`
1277
+ **request:** `Chrt.OffChrtShipperOrgConnectionInfoClientUpdate1`
1315
1278
 
1316
1279
  </dd>
1317
1280
  </dl>
@@ -1319,7 +1282,7 @@ await client.courierPayDriverRateSheets.updateById("id");
1319
1282
  <dl>
1320
1283
  <dd>
1321
1284
 
1322
- **requestOptions:** `CourierPayDriverRateSheets.RequestOptions`
1285
+ **requestOptions:** `OffChrtShipperOrgConnectionInfo.RequestOptions`
1323
1286
 
1324
1287
  </dd>
1325
1288
  </dl>
@@ -1330,9 +1293,9 @@ await client.courierPayDriverRateSheets.updateById("id");
1330
1293
  </dl>
1331
1294
  </details>
1332
1295
 
1333
- ## Drivers
1296
+ ## OrgProfiles
1334
1297
 
1335
- <details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">get</a>() -> Chrt.Driver1</code></summary>
1298
+ <details><summary><code>client.orgProfiles.<a href="/src/api/resources/orgProfiles/client/Client.ts">get</a>() -> Chrt.CourierOrgProfile3</code></summary>
1336
1299
  <dl>
1337
1300
  <dd>
1338
1301
 
@@ -1344,7 +1307,7 @@ await client.courierPayDriverRateSheets.updateById("id");
1344
1307
  <dl>
1345
1308
  <dd>
1346
1309
 
1347
- Returns a driver by user_id from the JWT
1310
+ Retrieve the courier organization profile for the authenticated organization using the org_id from the JWT token.
1348
1311
 
1349
1312
  </dd>
1350
1313
  </dl>
@@ -1360,7 +1323,7 @@ Returns a driver by user_id from the JWT
1360
1323
  <dd>
1361
1324
 
1362
1325
  ```typescript
1363
- await client.drivers.get();
1326
+ await client.orgProfiles.get();
1364
1327
  ```
1365
1328
 
1366
1329
  </dd>
@@ -1376,7 +1339,7 @@ await client.drivers.get();
1376
1339
  <dl>
1377
1340
  <dd>
1378
1341
 
1379
- **requestOptions:** `Drivers.RequestOptions`
1342
+ **requestOptions:** `OrgProfiles.RequestOptions`
1380
1343
 
1381
1344
  </dd>
1382
1345
  </dl>
@@ -1387,7 +1350,7 @@ await client.drivers.get();
1387
1350
  </dl>
1388
1351
  </details>
1389
1352
 
1390
- <details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">create</a>({ ...params }) -> string</code></summary>
1353
+ <details><summary><code>client.orgProfiles.<a href="/src/api/resources/orgProfiles/client/Client.ts">create</a>({ ...params }) -> string</code></summary>
1391
1354
  <dl>
1392
1355
  <dd>
1393
1356
 
@@ -1399,7 +1362,7 @@ await client.drivers.get();
1399
1362
  <dl>
1400
1363
  <dd>
1401
1364
 
1402
- Create a new driver for the authenticated organization
1365
+ Create a new courier organization profile. This endpoint will fail if a profile already exists for the organization.
1403
1366
 
1404
1367
  </dd>
1405
1368
  </dl>
@@ -1415,11 +1378,11 @@ Create a new driver for the authenticated organization
1415
1378
  <dd>
1416
1379
 
1417
1380
  ```typescript
1418
- await client.drivers.create({
1419
- org_member: {
1420
- role: "role",
1421
- user_id: "user_id",
1422
- },
1381
+ await client.orgProfiles.create({
1382
+ schema_version: 1,
1383
+ description: "description",
1384
+ email_address_primary: "email_address_primary",
1385
+ phone_number_primary: "phone_number_primary",
1423
1386
  });
1424
1387
  ```
1425
1388
 
@@ -1436,7 +1399,7 @@ await client.drivers.create({
1436
1399
  <dl>
1437
1400
  <dd>
1438
1401
 
1439
- **request:** `Chrt.DriverCreateReq`
1402
+ **request:** `Chrt.CourierOrgProfileClientCreate3`
1440
1403
 
1441
1404
  </dd>
1442
1405
  </dl>
@@ -1444,7 +1407,7 @@ await client.drivers.create({
1444
1407
  <dl>
1445
1408
  <dd>
1446
1409
 
1447
- **requestOptions:** `Drivers.RequestOptions`
1410
+ **requestOptions:** `OrgProfiles.RequestOptions`
1448
1411
 
1449
1412
  </dd>
1450
1413
  </dl>
@@ -1455,7 +1418,7 @@ await client.drivers.create({
1455
1418
  </dl>
1456
1419
  </details>
1457
1420
 
1458
- <details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">lastSeen</a>({ ...params }) -> boolean</code></summary>
1421
+ <details><summary><code>client.orgProfiles.<a href="/src/api/resources/orgProfiles/client/Client.ts">update</a>({ ...params }) -> boolean</code></summary>
1459
1422
  <dl>
1460
1423
  <dd>
1461
1424
 
@@ -1467,7 +1430,7 @@ await client.drivers.create({
1467
1430
  <dl>
1468
1431
  <dd>
1469
1432
 
1470
- Updates a driver's last seen location and timestamp
1433
+ Update an existing courier organization profile. Can update one or more fields. Profile must exist before updating.
1471
1434
 
1472
1435
  </dd>
1473
1436
  </dl>
@@ -1483,11 +1446,7 @@ Updates a driver's last seen location and timestamp
1483
1446
  <dd>
1484
1447
 
1485
1448
  ```typescript
1486
- await client.drivers.lastSeen({
1487
- location: {
1488
- type: "Feature",
1489
- },
1490
- });
1449
+ await client.orgProfiles.update();
1491
1450
  ```
1492
1451
 
1493
1452
  </dd>
@@ -1503,7 +1462,7 @@ await client.drivers.lastSeen({
1503
1462
  <dl>
1504
1463
  <dd>
1505
1464
 
1506
- **request:** `Chrt.DriverLastSeenReq`
1465
+ **request:** `Chrt.CourierOrgProfileClientUpdate3`
1507
1466
 
1508
1467
  </dd>
1509
1468
  </dl>
@@ -1511,7 +1470,7 @@ await client.drivers.lastSeen({
1511
1470
  <dl>
1512
1471
  <dd>
1513
1472
 
1514
- **requestOptions:** `Drivers.RequestOptions`
1473
+ **requestOptions:** `OrgProfiles.RequestOptions`
1515
1474
 
1516
1475
  </dd>
1517
1476
  </dl>
@@ -1522,7 +1481,7 @@ await client.drivers.lastSeen({
1522
1481
  </dl>
1523
1482
  </details>
1524
1483
 
1525
- <details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">list</a>() -> Chrt.Driver1[]</code></summary>
1484
+ <details><summary><code>client.orgProfiles.<a href="/src/api/resources/orgProfiles/client/Client.ts">getByHandle</a>(handle) -> Chrt.CourierOrgProfile3</code></summary>
1526
1485
  <dl>
1527
1486
  <dd>
1528
1487
 
@@ -1534,7 +1493,7 @@ await client.drivers.lastSeen({
1534
1493
  <dl>
1535
1494
  <dd>
1536
1495
 
1537
- Returns a list of all drivers belonging to the authenticated organization.
1496
+ Retrieve a courier organization profile using the organization's handle. This endpoint is used for public profile viewing.
1538
1497
 
1539
1498
  </dd>
1540
1499
  </dl>
@@ -1550,7 +1509,7 @@ Returns a list of all drivers belonging to the authenticated organization.
1550
1509
  <dd>
1551
1510
 
1552
1511
  ```typescript
1553
- await client.drivers.list();
1512
+ await client.orgProfiles.getByHandle("handle");
1554
1513
  ```
1555
1514
 
1556
1515
  </dd>
@@ -1566,7 +1525,15 @@ await client.drivers.list();
1566
1525
  <dl>
1567
1526
  <dd>
1568
1527
 
1569
- **requestOptions:** `Drivers.RequestOptions`
1528
+ **handle:** `string`
1529
+
1530
+ </dd>
1531
+ </dl>
1532
+
1533
+ <dl>
1534
+ <dd>
1535
+
1536
+ **requestOptions:** `OrgProfiles.RequestOptions`
1570
1537
 
1571
1538
  </dd>
1572
1539
  </dl>
@@ -1577,7 +1544,7 @@ await client.drivers.list();
1577
1544
  </dl>
1578
1545
  </details>
1579
1546
 
1580
- <details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">listOrgMembersAndDrivers</a>() -> Chrt.OrgMembersAndDrivers[]</code></summary>
1547
+ <details><summary><code>client.orgProfiles.<a href="/src/api/resources/orgProfiles/client/Client.ts">getAvatar</a>(handle) -> string</code></summary>
1581
1548
  <dl>
1582
1549
  <dd>
1583
1550
 
@@ -1589,7 +1556,7 @@ await client.drivers.list();
1589
1556
  <dl>
1590
1557
  <dd>
1591
1558
 
1592
- Returns a list of all organization members paired with their corresponding driver information (if they are drivers).
1559
+ Returns the image URL from Clerk or a placeholder if not found.
1593
1560
 
1594
1561
  </dd>
1595
1562
  </dl>
@@ -1605,7 +1572,7 @@ Returns a list of all organization members paired with their corresponding drive
1605
1572
  <dd>
1606
1573
 
1607
1574
  ```typescript
1608
- await client.drivers.listOrgMembersAndDrivers();
1575
+ await client.orgProfiles.getAvatar("handle");
1609
1576
  ```
1610
1577
 
1611
1578
  </dd>
@@ -1621,7 +1588,15 @@ await client.drivers.listOrgMembersAndDrivers();
1621
1588
  <dl>
1622
1589
  <dd>
1623
1590
 
1624
- **requestOptions:** `Drivers.RequestOptions`
1591
+ **handle:** `string`
1592
+
1593
+ </dd>
1594
+ </dl>
1595
+
1596
+ <dl>
1597
+ <dd>
1598
+
1599
+ **requestOptions:** `OrgProfiles.RequestOptions`
1625
1600
 
1626
1601
  </dd>
1627
1602
  </dl>
@@ -1632,7 +1607,9 @@ await client.drivers.listOrgMembersAndDrivers();
1632
1607
  </dl>
1633
1608
  </details>
1634
1609
 
1635
- <details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">setActivation</a>({ ...params }) -> boolean</code></summary>
1610
+ ## Orders
1611
+
1612
+ <details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">getByOrderIdOrShortId</a>(orderIdOrShortId) -> Chrt.GetOrderRes</code></summary>
1636
1613
  <dl>
1637
1614
  <dd>
1638
1615
 
@@ -1644,7 +1621,7 @@ await client.drivers.listOrgMembersAndDrivers();
1644
1621
  <dl>
1645
1622
  <dd>
1646
1623
 
1647
- Set a driver's activation status (active=true/false)
1624
+ Retrieves an order by its full ID or short ID.
1648
1625
 
1649
1626
  </dd>
1650
1627
  </dl>
@@ -1660,10 +1637,7 @@ Set a driver's activation status (active=true/false)
1660
1637
  <dd>
1661
1638
 
1662
1639
  ```typescript
1663
- await client.drivers.setActivation({
1664
- active: true,
1665
- driver_object_id: "driver_object_id",
1666
- });
1640
+ await client.orders.getByOrderIdOrShortId("order_id_or_short_id");
1667
1641
  ```
1668
1642
 
1669
1643
  </dd>
@@ -1679,7 +1653,7 @@ await client.drivers.setActivation({
1679
1653
  <dl>
1680
1654
  <dd>
1681
1655
 
1682
- **request:** `Chrt.SetDriverActivationReq`
1656
+ **orderIdOrShortId:** `string`
1683
1657
 
1684
1658
  </dd>
1685
1659
  </dl>
@@ -1687,7 +1661,7 @@ await client.drivers.setActivation({
1687
1661
  <dl>
1688
1662
  <dd>
1689
1663
 
1690
- **requestOptions:** `Drivers.RequestOptions`
1664
+ **requestOptions:** `Orders.RequestOptions`
1691
1665
 
1692
1666
  </dd>
1693
1667
  </dl>
@@ -1698,10 +1672,25 @@ await client.drivers.setActivation({
1698
1672
  </dl>
1699
1673
  </details>
1700
1674
 
1701
- <details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">updateDriver</a>({ ...params }) -> boolean</code></summary>
1675
+ <details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">cancelByOrderIdOrShortId</a>(orderIdOrShortId) -> boolean</code></summary>
1676
+ <dl>
1677
+ <dd>
1678
+
1679
+ #### 📝 Description
1680
+
1681
+ <dl>
1682
+ <dd>
1683
+
1702
1684
  <dl>
1703
1685
  <dd>
1704
1686
 
1687
+ Cancels an order and all associated task groups and line item groups.
1688
+
1689
+ </dd>
1690
+ </dl>
1691
+ </dd>
1692
+ </dl>
1693
+
1705
1694
  #### 🔌 Usage
1706
1695
 
1707
1696
  <dl>
@@ -1711,9 +1700,7 @@ await client.drivers.setActivation({
1711
1700
  <dd>
1712
1701
 
1713
1702
  ```typescript
1714
- await client.drivers.updateDriver({
1715
- driver_object_id: "driver_object_id",
1716
- });
1703
+ await client.orders.cancelByOrderIdOrShortId("order_id_or_short_id");
1717
1704
  ```
1718
1705
 
1719
1706
  </dd>
@@ -1729,7 +1716,7 @@ await client.drivers.updateDriver({
1729
1716
  <dl>
1730
1717
  <dd>
1731
1718
 
1732
- **request:** `Chrt.UpdateDriverDetailsReq`
1719
+ **orderIdOrShortId:** `string`
1733
1720
 
1734
1721
  </dd>
1735
1722
  </dl>
@@ -1737,7 +1724,7 @@ await client.drivers.updateDriver({
1737
1724
  <dl>
1738
1725
  <dd>
1739
1726
 
1740
- **requestOptions:** `Drivers.RequestOptions`
1727
+ **requestOptions:** `Orders.RequestOptions`
1741
1728
 
1742
1729
  </dd>
1743
1730
  </dl>
@@ -1748,7 +1735,7 @@ await client.drivers.updateDriver({
1748
1735
  </dl>
1749
1736
  </details>
1750
1737
 
1751
- <details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">getByDriverId</a>(driverId) -> Chrt.Driver1</code></summary>
1738
+ <details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">create</a>({ ...params }) -> Chrt.CreateOrderRes</code></summary>
1752
1739
  <dl>
1753
1740
  <dd>
1754
1741
 
@@ -1760,7 +1747,7 @@ await client.drivers.updateDriver({
1760
1747
  <dl>
1761
1748
  <dd>
1762
1749
 
1763
- Returns a driver by id
1750
+ Creates a comprehensive order with task groups, tasks, milestones, and cargo.
1764
1751
 
1765
1752
  </dd>
1766
1753
  </dl>
@@ -1776,7 +1763,29 @@ Returns a driver by id
1776
1763
  <dd>
1777
1764
 
1778
1765
  ```typescript
1779
- await client.drivers.getByDriverId("driver_id");
1766
+ await client.orders.create({
1767
+ order_client_create: {
1768
+ schema_version: 1,
1769
+ },
1770
+ task_client_creates_bundle_groupings: [
1771
+ [
1772
+ {
1773
+ task_client_create: {
1774
+ schema_version: 1,
1775
+ },
1776
+ },
1777
+ ],
1778
+ ],
1779
+ cargo_client_creates_map: {
1780
+ key: {
1781
+ schema_version: 1,
1782
+ cargo_type: "spare_parts",
1783
+ },
1784
+ },
1785
+ order_created_by_type: "chrt",
1786
+ order_dispatch_type: "dtc",
1787
+ transport_type: "ground_only",
1788
+ });
1780
1789
  ```
1781
1790
 
1782
1791
  </dd>
@@ -1792,7 +1801,7 @@ await client.drivers.getByDriverId("driver_id");
1792
1801
  <dl>
1793
1802
  <dd>
1794
1803
 
1795
- **driverId:** `string`
1804
+ **request:** `Chrt.CreateOrderReq`
1796
1805
 
1797
1806
  </dd>
1798
1807
  </dl>
@@ -1800,7 +1809,7 @@ await client.drivers.getByDriverId("driver_id");
1800
1809
  <dl>
1801
1810
  <dd>
1802
1811
 
1803
- **requestOptions:** `Drivers.RequestOptions`
1812
+ **requestOptions:** `Orders.RequestOptions`
1804
1813
 
1805
1814
  </dd>
1806
1815
  </dl>
@@ -1811,7 +1820,7 @@ await client.drivers.getByDriverId("driver_id");
1811
1820
  </dl>
1812
1821
  </details>
1813
1822
 
1814
- <details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">delete</a>(driverId) -> boolean</code></summary>
1823
+ <details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">listByShipperOrgId</a>() -> Chrt.Order1[]</code></summary>
1815
1824
  <dl>
1816
1825
  <dd>
1817
1826
 
@@ -1823,7 +1832,7 @@ await client.drivers.getByDriverId("driver_id");
1823
1832
  <dl>
1824
1833
  <dd>
1825
1834
 
1826
- Deletes a driver from the database
1835
+ Lists all orders for the authenticated shipper organization.
1827
1836
 
1828
1837
  </dd>
1829
1838
  </dl>
@@ -1839,7 +1848,7 @@ Deletes a driver from the database
1839
1848
  <dd>
1840
1849
 
1841
1850
  ```typescript
1842
- await client.drivers.delete("driver_id");
1851
+ await client.orders.listByShipperOrgId();
1843
1852
  ```
1844
1853
 
1845
1854
  </dd>
@@ -1855,15 +1864,7 @@ await client.drivers.delete("driver_id");
1855
1864
  <dl>
1856
1865
  <dd>
1857
1866
 
1858
- **driverId:** `string`
1859
-
1860
- </dd>
1861
- </dl>
1862
-
1863
- <dl>
1864
- <dd>
1865
-
1866
- **requestOptions:** `Drivers.RequestOptions`
1867
+ **requestOptions:** `Orders.RequestOptions`
1867
1868
 
1868
1869
  </dd>
1869
1870
  </dl>
@@ -1874,9 +1875,7 @@ await client.drivers.delete("driver_id");
1874
1875
  </dl>
1875
1876
  </details>
1876
1877
 
1877
- ## MilestoneNotifications
1878
-
1879
- <details><summary><code>client.milestoneNotifications.<a href="/src/api/resources/milestoneNotifications/client/Client.ts">getPreferences</a>() -> Chrt.MilestoneNotificationPreferences1</code></summary>
1878
+ <details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">listByCourierOrgId</a>() -> Chrt.Order1[]</code></summary>
1880
1879
  <dl>
1881
1880
  <dd>
1882
1881
 
@@ -1888,7 +1887,7 @@ await client.drivers.delete("driver_id");
1888
1887
  <dl>
1889
1888
  <dd>
1890
1889
 
1891
- Get notification preferences by org id from jwt
1890
+ Lists all orders assigned to the authenticated courier organization.
1892
1891
 
1893
1892
  </dd>
1894
1893
  </dl>
@@ -1904,7 +1903,7 @@ Get notification preferences by org id from jwt
1904
1903
  <dd>
1905
1904
 
1906
1905
  ```typescript
1907
- await client.milestoneNotifications.getPreferences();
1906
+ await client.orders.listByCourierOrgId();
1908
1907
  ```
1909
1908
 
1910
1909
  </dd>
@@ -1920,7 +1919,7 @@ await client.milestoneNotifications.getPreferences();
1920
1919
  <dl>
1921
1920
  <dd>
1922
1921
 
1923
- **requestOptions:** `MilestoneNotifications.RequestOptions`
1922
+ **requestOptions:** `Orders.RequestOptions`
1924
1923
 
1925
1924
  </dd>
1926
1925
  </dl>
@@ -1931,7 +1930,9 @@ await client.milestoneNotifications.getPreferences();
1931
1930
  </dl>
1932
1931
  </details>
1933
1932
 
1934
- <details><summary><code>client.milestoneNotifications.<a href="/src/api/resources/milestoneNotifications/client/Client.ts">upsertPreferences</a>({ ...params }) -> string</code></summary>
1933
+ ## CourierPayDriverRateSheets
1934
+
1935
+ <details><summary><code>client.courierPayDriverRateSheets.<a href="/src/api/resources/courierPayDriverRateSheets/client/Client.ts">listByCourierOrgId</a>() -> Chrt.CourierPayDriverRateSheet1[]</code></summary>
1935
1936
  <dl>
1936
1937
  <dd>
1937
1938
 
@@ -1943,7 +1944,7 @@ await client.milestoneNotifications.getPreferences();
1943
1944
  <dl>
1944
1945
  <dd>
1945
1946
 
1946
- Upsert notification preferences for org in jwt
1947
+ Lists all driver rate sheets for the authenticated courier organization.
1947
1948
 
1948
1949
  </dd>
1949
1950
  </dl>
@@ -1959,9 +1960,7 @@ Upsert notification preferences for org in jwt
1959
1960
  <dd>
1960
1961
 
1961
1962
  ```typescript
1962
- await client.milestoneNotifications.upsertPreferences({
1963
- schema_version: 1,
1964
- });
1963
+ await client.courierPayDriverRateSheets.listByCourierOrgId();
1965
1964
  ```
1966
1965
 
1967
1966
  </dd>
@@ -1977,15 +1976,7 @@ await client.milestoneNotifications.upsertPreferences({
1977
1976
  <dl>
1978
1977
  <dd>
1979
1978
 
1980
- **request:** `Chrt.MilestoneNotificationPreferencesClientCreate1`
1981
-
1982
- </dd>
1983
- </dl>
1984
-
1985
- <dl>
1986
- <dd>
1987
-
1988
- **requestOptions:** `MilestoneNotifications.RequestOptions`
1979
+ **requestOptions:** `CourierPayDriverRateSheets.RequestOptions`
1989
1980
 
1990
1981
  </dd>
1991
1982
  </dl>
@@ -1996,9 +1987,7 @@ await client.milestoneNotifications.upsertPreferences({
1996
1987
  </dl>
1997
1988
  </details>
1998
1989
 
1999
- ## Milestones
2000
-
2001
- <details><summary><code>client.milestones.<a href="/src/api/resources/milestones/client/Client.ts">addToTask</a>({ ...params }) -> boolean</code></summary>
1990
+ <details><summary><code>client.courierPayDriverRateSheets.<a href="/src/api/resources/courierPayDriverRateSheets/client/Client.ts">create</a>({ ...params }) -> string</code></summary>
2002
1991
  <dl>
2003
1992
  <dd>
2004
1993
 
@@ -2010,7 +1999,7 @@ await client.milestoneNotifications.upsertPreferences({
2010
1999
  <dl>
2011
2000
  <dd>
2012
2001
 
2013
- Add a new milestone to an existing task
2002
+ Creates a new driver rate sheet for calculating courier payments.
2014
2003
 
2015
2004
  </dd>
2016
2005
  </dl>
@@ -2026,9 +2015,22 @@ Add a new milestone to an existing task
2026
2015
  <dd>
2027
2016
 
2028
2017
  ```typescript
2029
- await client.milestones.addToTask({
2030
- task_id: "task_id",
2031
- type: "image",
2018
+ await client.courierPayDriverRateSheets.create({
2019
+ schema_version: 1,
2020
+ courier_org_id: "courier_org_id",
2021
+ base_mileage_distance_miles: 1.1,
2022
+ base_mileage_rate_usd_per_instance: 1.1,
2023
+ additional_mileage_rate_usd_per_mile: 1.1,
2024
+ long_distance_surcharge_miles_before_surcharge: 1.1,
2025
+ long_distance_surcharge_rate_usd_per_mile: 1.1,
2026
+ fuel_surchage_rate_usd_per_mile: 1.1,
2027
+ wait_time_before_charge_minutes: 1.1,
2028
+ wait_time_rate_usd_per_minute: 1.1,
2029
+ extra_stop_rate_usd: 1.1,
2030
+ dangerous_goods_rate_usd_per_instance: 1.1,
2031
+ after_hours: 1.1,
2032
+ weekend: 1.1,
2033
+ holiday: 1.1,
2032
2034
  });
2033
2035
  ```
2034
2036
 
@@ -2045,7 +2047,7 @@ await client.milestones.addToTask({
2045
2047
  <dl>
2046
2048
  <dd>
2047
2049
 
2048
- **request:** `Chrt.MilestoneAddToTaskReq`
2050
+ **request:** `Chrt.CourierPayDriverRateSheetClientCreate1`
2049
2051
 
2050
2052
  </dd>
2051
2053
  </dl>
@@ -2053,7 +2055,7 @@ await client.milestones.addToTask({
2053
2055
  <dl>
2054
2056
  <dd>
2055
2057
 
2056
- **requestOptions:** `Milestones.RequestOptions`
2058
+ **requestOptions:** `CourierPayDriverRateSheets.RequestOptions`
2057
2059
 
2058
2060
  </dd>
2059
2061
  </dl>
@@ -2064,7 +2066,7 @@ await client.milestones.addToTask({
2064
2066
  </dl>
2065
2067
  </details>
2066
2068
 
2067
- <details><summary><code>client.milestones.<a href="/src/api/resources/milestones/client/Client.ts">update</a>({ ...params }) -> boolean</code></summary>
2069
+ <details><summary><code>client.courierPayDriverRateSheets.<a href="/src/api/resources/courierPayDriverRateSheets/client/Client.ts">get</a>(id) -> Chrt.CourierPayDriverRateSheet1</code></summary>
2068
2070
  <dl>
2069
2071
  <dd>
2070
2072
 
@@ -2076,7 +2078,7 @@ await client.milestones.addToTask({
2076
2078
  <dl>
2077
2079
  <dd>
2078
2080
 
2079
- Update a milestone's completion status and comments
2081
+ Retrieves a single rate sheet by its ID.
2080
2082
 
2081
2083
  </dd>
2082
2084
  </dl>
@@ -2092,8 +2094,271 @@ Update a milestone's completion status and comments
2092
2094
  <dd>
2093
2095
 
2094
2096
  ```typescript
2095
- await client.milestones.update({
2096
- milestone_id: "milestone_id",
2097
+ await client.courierPayDriverRateSheets.get("id");
2098
+ ```
2099
+
2100
+ </dd>
2101
+ </dl>
2102
+ </dd>
2103
+ </dl>
2104
+
2105
+ #### ⚙️ Parameters
2106
+
2107
+ <dl>
2108
+ <dd>
2109
+
2110
+ <dl>
2111
+ <dd>
2112
+
2113
+ **id:** `string`
2114
+
2115
+ </dd>
2116
+ </dl>
2117
+
2118
+ <dl>
2119
+ <dd>
2120
+
2121
+ **requestOptions:** `CourierPayDriverRateSheets.RequestOptions`
2122
+
2123
+ </dd>
2124
+ </dl>
2125
+ </dd>
2126
+ </dl>
2127
+
2128
+ </dd>
2129
+ </dl>
2130
+ </details>
2131
+
2132
+ <details><summary><code>client.courierPayDriverRateSheets.<a href="/src/api/resources/courierPayDriverRateSheets/client/Client.ts">deleteById</a>(id) -> boolean</code></summary>
2133
+ <dl>
2134
+ <dd>
2135
+
2136
+ #### 📝 Description
2137
+
2138
+ <dl>
2139
+ <dd>
2140
+
2141
+ <dl>
2142
+ <dd>
2143
+
2144
+ Deletes a driver rate sheet owned by the authenticated organization.
2145
+
2146
+ </dd>
2147
+ </dl>
2148
+ </dd>
2149
+ </dl>
2150
+
2151
+ #### 🔌 Usage
2152
+
2153
+ <dl>
2154
+ <dd>
2155
+
2156
+ <dl>
2157
+ <dd>
2158
+
2159
+ ```typescript
2160
+ await client.courierPayDriverRateSheets.deleteById("id");
2161
+ ```
2162
+
2163
+ </dd>
2164
+ </dl>
2165
+ </dd>
2166
+ </dl>
2167
+
2168
+ #### ⚙️ Parameters
2169
+
2170
+ <dl>
2171
+ <dd>
2172
+
2173
+ <dl>
2174
+ <dd>
2175
+
2176
+ **id:** `string`
2177
+
2178
+ </dd>
2179
+ </dl>
2180
+
2181
+ <dl>
2182
+ <dd>
2183
+
2184
+ **requestOptions:** `CourierPayDriverRateSheets.RequestOptions`
2185
+
2186
+ </dd>
2187
+ </dl>
2188
+ </dd>
2189
+ </dl>
2190
+
2191
+ </dd>
2192
+ </dl>
2193
+ </details>
2194
+
2195
+ <details><summary><code>client.courierPayDriverRateSheets.<a href="/src/api/resources/courierPayDriverRateSheets/client/Client.ts">updateById</a>(id, { ...params }) -> Chrt.CourierPayDriverRateSheet1</code></summary>
2196
+ <dl>
2197
+ <dd>
2198
+
2199
+ #### 📝 Description
2200
+
2201
+ <dl>
2202
+ <dd>
2203
+
2204
+ <dl>
2205
+ <dd>
2206
+
2207
+ Updates an existing driver rate sheet owned by the authenticated organization.
2208
+
2209
+ </dd>
2210
+ </dl>
2211
+ </dd>
2212
+ </dl>
2213
+
2214
+ #### 🔌 Usage
2215
+
2216
+ <dl>
2217
+ <dd>
2218
+
2219
+ <dl>
2220
+ <dd>
2221
+
2222
+ ```typescript
2223
+ await client.courierPayDriverRateSheets.updateById("id");
2224
+ ```
2225
+
2226
+ </dd>
2227
+ </dl>
2228
+ </dd>
2229
+ </dl>
2230
+
2231
+ #### ⚙️ Parameters
2232
+
2233
+ <dl>
2234
+ <dd>
2235
+
2236
+ <dl>
2237
+ <dd>
2238
+
2239
+ **id:** `string`
2240
+
2241
+ </dd>
2242
+ </dl>
2243
+
2244
+ <dl>
2245
+ <dd>
2246
+
2247
+ **request:** `Chrt.CourierPayDriverRateSheetClientUpdate1`
2248
+
2249
+ </dd>
2250
+ </dl>
2251
+
2252
+ <dl>
2253
+ <dd>
2254
+
2255
+ **requestOptions:** `CourierPayDriverRateSheets.RequestOptions`
2256
+
2257
+ </dd>
2258
+ </dl>
2259
+ </dd>
2260
+ </dl>
2261
+
2262
+ </dd>
2263
+ </dl>
2264
+ </details>
2265
+
2266
+ <details><summary><code>client.courierPayDriverRateSheets.<a href="/src/api/resources/courierPayDriverRateSheets/client/Client.ts">listByDriverId</a>(driverId) -> Chrt.CourierPayDriverRateSheet1[]</code></summary>
2267
+ <dl>
2268
+ <dd>
2269
+
2270
+ #### 📝 Description
2271
+
2272
+ <dl>
2273
+ <dd>
2274
+
2275
+ <dl>
2276
+ <dd>
2277
+
2278
+ Retrieves all rate sheets assigned to a specific driver.
2279
+
2280
+ </dd>
2281
+ </dl>
2282
+ </dd>
2283
+ </dl>
2284
+
2285
+ #### 🔌 Usage
2286
+
2287
+ <dl>
2288
+ <dd>
2289
+
2290
+ <dl>
2291
+ <dd>
2292
+
2293
+ ```typescript
2294
+ await client.courierPayDriverRateSheets.listByDriverId("driver_id");
2295
+ ```
2296
+
2297
+ </dd>
2298
+ </dl>
2299
+ </dd>
2300
+ </dl>
2301
+
2302
+ #### ⚙️ Parameters
2303
+
2304
+ <dl>
2305
+ <dd>
2306
+
2307
+ <dl>
2308
+ <dd>
2309
+
2310
+ **driverId:** `string`
2311
+
2312
+ </dd>
2313
+ </dl>
2314
+
2315
+ <dl>
2316
+ <dd>
2317
+
2318
+ **requestOptions:** `CourierPayDriverRateSheets.RequestOptions`
2319
+
2320
+ </dd>
2321
+ </dl>
2322
+ </dd>
2323
+ </dl>
2324
+
2325
+ </dd>
2326
+ </dl>
2327
+ </details>
2328
+
2329
+ ## CourierPayDriverLineItemGroup
2330
+
2331
+ <details><summary><code>client.courierPayDriverLineItemGroup.<a href="/src/api/resources/courierPayDriverLineItemGroup/client/Client.ts">preview</a>({ ...params }) -> Chrt.CourierPayDriverLineItemGroupClientCreate1</code></summary>
2332
+ <dl>
2333
+ <dd>
2334
+
2335
+ #### 📝 Description
2336
+
2337
+ <dl>
2338
+ <dd>
2339
+
2340
+ <dl>
2341
+ <dd>
2342
+
2343
+ Previews calculated line items for a driver based on rate sheet and task group without creating the group.
2344
+
2345
+ </dd>
2346
+ </dl>
2347
+ </dd>
2348
+ </dl>
2349
+
2350
+ #### 🔌 Usage
2351
+
2352
+ <dl>
2353
+ <dd>
2354
+
2355
+ <dl>
2356
+ <dd>
2357
+
2358
+ ```typescript
2359
+ await client.courierPayDriverLineItemGroup.preview({
2360
+ courier_pay_driver_rate_sheet_id: "courier_pay_driver_rate_sheet_id",
2361
+ task_group_id: "task_group_id",
2097
2362
  });
2098
2363
  ```
2099
2364
 
@@ -2110,7 +2375,7 @@ await client.milestones.update({
2110
2375
  <dl>
2111
2376
  <dd>
2112
2377
 
2113
- **request:** `Chrt.MilestoneUpdateReq`
2378
+ **request:** `Chrt.CourierPayDriverLineItemGroupPreviewRequest`
2114
2379
 
2115
2380
  </dd>
2116
2381
  </dl>
@@ -2118,7 +2383,7 @@ await client.milestones.update({
2118
2383
  <dl>
2119
2384
  <dd>
2120
2385
 
2121
- **requestOptions:** `Milestones.RequestOptions`
2386
+ **requestOptions:** `CourierPayDriverLineItemGroup.RequestOptions`
2122
2387
 
2123
2388
  </dd>
2124
2389
  </dl>
@@ -2129,9 +2394,70 @@ await client.milestones.update({
2129
2394
  </dl>
2130
2395
  </details>
2131
2396
 
2132
- ## OffChrtShipperOrgConnectionInfo
2397
+ <details><summary><code>client.courierPayDriverLineItemGroup.<a href="/src/api/resources/courierPayDriverLineItemGroup/client/Client.ts">getById</a>(id) -> Chrt.CourierPayDriverLineItemGroup1</code></summary>
2398
+ <dl>
2399
+ <dd>
2400
+
2401
+ #### 📝 Description
2133
2402
 
2134
- <details><summary><code>client.offChrtShipperOrgConnectionInfo.<a href="/src/api/resources/offChrtShipperOrgConnectionInfo/client/Client.ts">create</a>({ ...params }) -> string</code></summary>
2403
+ <dl>
2404
+ <dd>
2405
+
2406
+ <dl>
2407
+ <dd>
2408
+
2409
+ Retrieves a courier driver line item group by its ID.
2410
+
2411
+ </dd>
2412
+ </dl>
2413
+ </dd>
2414
+ </dl>
2415
+
2416
+ #### 🔌 Usage
2417
+
2418
+ <dl>
2419
+ <dd>
2420
+
2421
+ <dl>
2422
+ <dd>
2423
+
2424
+ ```typescript
2425
+ await client.courierPayDriverLineItemGroup.getById("id");
2426
+ ```
2427
+
2428
+ </dd>
2429
+ </dl>
2430
+ </dd>
2431
+ </dl>
2432
+
2433
+ #### ⚙️ Parameters
2434
+
2435
+ <dl>
2436
+ <dd>
2437
+
2438
+ <dl>
2439
+ <dd>
2440
+
2441
+ **id:** `string`
2442
+
2443
+ </dd>
2444
+ </dl>
2445
+
2446
+ <dl>
2447
+ <dd>
2448
+
2449
+ **requestOptions:** `CourierPayDriverLineItemGroup.RequestOptions`
2450
+
2451
+ </dd>
2452
+ </dl>
2453
+ </dd>
2454
+ </dl>
2455
+
2456
+ </dd>
2457
+ </dl>
2458
+ </details>
2459
+
2460
+ <details><summary><code>client.courierPayDriverLineItemGroup.<a href="/src/api/resources/courierPayDriverLineItemGroup/client/Client.ts">byTaskGroupId</a>(taskGroupId) -> Chrt.CourierPayDriverLineItemGroup1</code></summary>
2135
2461
  <dl>
2136
2462
  <dd>
2137
2463
 
@@ -2143,7 +2469,7 @@ await client.milestones.update({
2143
2469
  <dl>
2144
2470
  <dd>
2145
2471
 
2146
- Create a new off-CHRT shipper org connection info record.
2472
+ Retrieves a courier driver line item group by its associated task group ID.
2147
2473
 
2148
2474
  </dd>
2149
2475
  </dl>
@@ -2159,9 +2485,72 @@ Create a new off-CHRT shipper org connection info record.
2159
2485
  <dd>
2160
2486
 
2161
2487
  ```typescript
2162
- await client.offChrtShipperOrgConnectionInfo.create({
2163
- email_address_primary: "email_address_primary",
2164
- schema_version: 1,
2488
+ await client.courierPayDriverLineItemGroup.byTaskGroupId("task_group_id");
2489
+ ```
2490
+
2491
+ </dd>
2492
+ </dl>
2493
+ </dd>
2494
+ </dl>
2495
+
2496
+ #### ⚙️ Parameters
2497
+
2498
+ <dl>
2499
+ <dd>
2500
+
2501
+ <dl>
2502
+ <dd>
2503
+
2504
+ **taskGroupId:** `string`
2505
+
2506
+ </dd>
2507
+ </dl>
2508
+
2509
+ <dl>
2510
+ <dd>
2511
+
2512
+ **requestOptions:** `CourierPayDriverLineItemGroup.RequestOptions`
2513
+
2514
+ </dd>
2515
+ </dl>
2516
+ </dd>
2517
+ </dl>
2518
+
2519
+ </dd>
2520
+ </dl>
2521
+ </details>
2522
+
2523
+ <details><summary><code>client.courierPayDriverLineItemGroup.<a href="/src/api/resources/courierPayDriverLineItemGroup/client/Client.ts">create</a>({ ...params }) -> string</code></summary>
2524
+ <dl>
2525
+ <dd>
2526
+
2527
+ #### 📝 Description
2528
+
2529
+ <dl>
2530
+ <dd>
2531
+
2532
+ <dl>
2533
+ <dd>
2534
+
2535
+ Creates a courier driver line item group by calculating items from rate sheet and task group.
2536
+
2537
+ </dd>
2538
+ </dl>
2539
+ </dd>
2540
+ </dl>
2541
+
2542
+ #### 🔌 Usage
2543
+
2544
+ <dl>
2545
+ <dd>
2546
+
2547
+ <dl>
2548
+ <dd>
2549
+
2550
+ ```typescript
2551
+ await client.courierPayDriverLineItemGroup.create({
2552
+ courier_pay_driver_rate_sheet_id: "courier_pay_driver_rate_sheet_id",
2553
+ task_group_id: "task_group_id",
2165
2554
  });
2166
2555
  ```
2167
2556
 
@@ -2178,7 +2567,72 @@ await client.offChrtShipperOrgConnectionInfo.create({
2178
2567
  <dl>
2179
2568
  <dd>
2180
2569
 
2181
- **request:** `Chrt.OffChrtShipperOrgConnectionInfoClientCreate1`
2570
+ **request:** `Chrt.CourierPayDriverLineItemGroupCreateRequest`
2571
+
2572
+ </dd>
2573
+ </dl>
2574
+
2575
+ <dl>
2576
+ <dd>
2577
+
2578
+ **requestOptions:** `CourierPayDriverLineItemGroup.RequestOptions`
2579
+
2580
+ </dd>
2581
+ </dl>
2582
+ </dd>
2583
+ </dl>
2584
+
2585
+ </dd>
2586
+ </dl>
2587
+ </details>
2588
+
2589
+ ## CourierPayDriverPayouts
2590
+
2591
+ <details><summary><code>client.courierPayDriverPayouts.<a href="/src/api/resources/courierPayDriverPayouts/client/Client.ts">getById</a>(id) -> unknown</code></summary>
2592
+ <dl>
2593
+ <dd>
2594
+
2595
+ #### 📝 Description
2596
+
2597
+ <dl>
2598
+ <dd>
2599
+
2600
+ <dl>
2601
+ <dd>
2602
+
2603
+ Retrieves a specific courier driver payout by ID for the authenticated organization.
2604
+
2605
+ </dd>
2606
+ </dl>
2607
+ </dd>
2608
+ </dl>
2609
+
2610
+ #### 🔌 Usage
2611
+
2612
+ <dl>
2613
+ <dd>
2614
+
2615
+ <dl>
2616
+ <dd>
2617
+
2618
+ ```typescript
2619
+ await client.courierPayDriverPayouts.getById("id");
2620
+ ```
2621
+
2622
+ </dd>
2623
+ </dl>
2624
+ </dd>
2625
+ </dl>
2626
+
2627
+ #### ⚙️ Parameters
2628
+
2629
+ <dl>
2630
+ <dd>
2631
+
2632
+ <dl>
2633
+ <dd>
2634
+
2635
+ **id:** `string`
2182
2636
 
2183
2637
  </dd>
2184
2638
  </dl>
@@ -2186,7 +2640,7 @@ await client.offChrtShipperOrgConnectionInfo.create({
2186
2640
  <dl>
2187
2641
  <dd>
2188
2642
 
2189
- **requestOptions:** `OffChrtShipperOrgConnectionInfo.RequestOptions`
2643
+ **requestOptions:** `CourierPayDriverPayouts.RequestOptions`
2190
2644
 
2191
2645
  </dd>
2192
2646
  </dl>
@@ -2197,7 +2651,7 @@ await client.offChrtShipperOrgConnectionInfo.create({
2197
2651
  </dl>
2198
2652
  </details>
2199
2653
 
2200
- <details><summary><code>client.offChrtShipperOrgConnectionInfo.<a href="/src/api/resources/offChrtShipperOrgConnectionInfo/client/Client.ts">list</a>() -> Chrt.OffChrtShipperOrgConnectionInfo1[]</code></summary>
2654
+ <details><summary><code>client.courierPayDriverPayouts.<a href="/src/api/resources/courierPayDriverPayouts/client/Client.ts">listByDriverId</a>(driverId) -> unknown</code></summary>
2201
2655
  <dl>
2202
2656
  <dd>
2203
2657
 
@@ -2209,7 +2663,7 @@ await client.offChrtShipperOrgConnectionInfo.create({
2209
2663
  <dl>
2210
2664
  <dd>
2211
2665
 
2212
- Get a list of all off-CHRT shipper connections created by the authenticated user's organization (Courier org).
2666
+ Lists all payouts for a specific driver within the authenticated organization.
2213
2667
 
2214
2668
  </dd>
2215
2669
  </dl>
@@ -2225,7 +2679,7 @@ Get a list of all off-CHRT shipper connections created by the authenticated user
2225
2679
  <dd>
2226
2680
 
2227
2681
  ```typescript
2228
- await client.offChrtShipperOrgConnectionInfo.list();
2682
+ await client.courierPayDriverPayouts.listByDriverId("driver_id");
2229
2683
  ```
2230
2684
 
2231
2685
  </dd>
@@ -2241,7 +2695,15 @@ await client.offChrtShipperOrgConnectionInfo.list();
2241
2695
  <dl>
2242
2696
  <dd>
2243
2697
 
2244
- **requestOptions:** `OffChrtShipperOrgConnectionInfo.RequestOptions`
2698
+ **driverId:** `string`
2699
+
2700
+ </dd>
2701
+ </dl>
2702
+
2703
+ <dl>
2704
+ <dd>
2705
+
2706
+ **requestOptions:** `CourierPayDriverPayouts.RequestOptions`
2245
2707
 
2246
2708
  </dd>
2247
2709
  </dl>
@@ -2252,7 +2714,7 @@ await client.offChrtShipperOrgConnectionInfo.list();
2252
2714
  </dl>
2253
2715
  </details>
2254
2716
 
2255
- <details><summary><code>client.offChrtShipperOrgConnectionInfo.<a href="/src/api/resources/offChrtShipperOrgConnectionInfo/client/Client.ts">getById</a>(id) -> Chrt.OffChrtShipperOrgConnectionInfo1</code></summary>
2717
+ <details><summary><code>client.courierPayDriverPayouts.<a href="/src/api/resources/courierPayDriverPayouts/client/Client.ts">create</a>({ ...params }) -> string</code></summary>
2256
2718
  <dl>
2257
2719
  <dd>
2258
2720
 
@@ -2264,7 +2726,7 @@ await client.offChrtShipperOrgConnectionInfo.list();
2264
2726
  <dl>
2265
2727
  <dd>
2266
2728
 
2267
- Get an off-CHRT shipper org connection info record by ID.
2729
+ Creates a new driver payout from selected line item groups.
2268
2730
 
2269
2731
  </dd>
2270
2732
  </dl>
@@ -2280,7 +2742,10 @@ Get an off-CHRT shipper org connection info record by ID.
2280
2742
  <dd>
2281
2743
 
2282
2744
  ```typescript
2283
- await client.offChrtShipperOrgConnectionInfo.getById("id");
2745
+ await client.courierPayDriverPayouts.create({
2746
+ schema_version: 1,
2747
+ line_item_group_ids: ["line_item_group_ids"],
2748
+ });
2284
2749
  ```
2285
2750
 
2286
2751
  </dd>
@@ -2296,7 +2761,7 @@ await client.offChrtShipperOrgConnectionInfo.getById("id");
2296
2761
  <dl>
2297
2762
  <dd>
2298
2763
 
2299
- **id:** `string`
2764
+ **request:** `Chrt.CourierPayDriverPayoutClientCreate1`
2300
2765
 
2301
2766
  </dd>
2302
2767
  </dl>
@@ -2304,7 +2769,7 @@ await client.offChrtShipperOrgConnectionInfo.getById("id");
2304
2769
  <dl>
2305
2770
  <dd>
2306
2771
 
2307
- **requestOptions:** `OffChrtShipperOrgConnectionInfo.RequestOptions`
2772
+ **requestOptions:** `CourierPayDriverPayouts.RequestOptions`
2308
2773
 
2309
2774
  </dd>
2310
2775
  </dl>
@@ -2315,7 +2780,9 @@ await client.offChrtShipperOrgConnectionInfo.getById("id");
2315
2780
  </dl>
2316
2781
  </details>
2317
2782
 
2318
- <details><summary><code>client.offChrtShipperOrgConnectionInfo.<a href="/src/api/resources/offChrtShipperOrgConnectionInfo/client/Client.ts">updateById</a>(id, { ...params }) -> boolean</code></summary>
2783
+ ## Connections
2784
+
2785
+ <details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">listShippers</a>() -> Chrt.ShipperOrgConnectionInfo1[]</code></summary>
2319
2786
  <dl>
2320
2787
  <dd>
2321
2788
 
@@ -2327,7 +2794,7 @@ await client.offChrtShipperOrgConnectionInfo.getById("id");
2327
2794
  <dl>
2328
2795
  <dd>
2329
2796
 
2330
- Update an off-CHRT shipper org connection info record by ID.
2797
+ Lists all shipper organizations connected to the authenticated courier organization.
2331
2798
 
2332
2799
  </dd>
2333
2800
  </dl>
@@ -2343,7 +2810,7 @@ Update an off-CHRT shipper org connection info record by ID.
2343
2810
  <dd>
2344
2811
 
2345
2812
  ```typescript
2346
- await client.offChrtShipperOrgConnectionInfo.updateById("id");
2813
+ await client.connections.listShippers();
2347
2814
  ```
2348
2815
 
2349
2816
  </dd>
@@ -2359,39 +2826,36 @@ await client.offChrtShipperOrgConnectionInfo.updateById("id");
2359
2826
  <dl>
2360
2827
  <dd>
2361
2828
 
2362
- **id:** `string`
2829
+ **requestOptions:** `Connections.RequestOptions`
2830
+
2831
+ </dd>
2832
+ </dl>
2833
+ </dd>
2834
+ </dl>
2363
2835
 
2364
2836
  </dd>
2365
2837
  </dl>
2838
+ </details>
2366
2839
 
2840
+ <details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">listCouriers</a>() -> Chrt.CourierOrgConnectionInfo1[]</code></summary>
2367
2841
  <dl>
2368
2842
  <dd>
2369
2843
 
2370
- **request:** `Chrt.OffChrtShipperOrgConnectionInfoClientUpdate1`
2844
+ #### 📝 Description
2371
2845
 
2372
- </dd>
2373
- </dl>
2846
+ <dl>
2847
+ <dd>
2374
2848
 
2375
2849
  <dl>
2376
2850
  <dd>
2377
2851
 
2378
- **requestOptions:** `OffChrtShipperOrgConnectionInfo.RequestOptions`
2852
+ Lists all courier organizations connected to the authenticated shipper organization.
2379
2853
 
2380
2854
  </dd>
2381
2855
  </dl>
2382
2856
  </dd>
2383
2857
  </dl>
2384
2858
 
2385
- </dd>
2386
- </dl>
2387
- </details>
2388
-
2389
- ## Orders
2390
-
2391
- <details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">cancelByOrderIdOrShortId</a>(orderIdOrShortId) -> boolean</code></summary>
2392
- <dl>
2393
- <dd>
2394
-
2395
2859
  #### 🔌 Usage
2396
2860
 
2397
2861
  <dl>
@@ -2401,7 +2865,7 @@ await client.offChrtShipperOrgConnectionInfo.updateById("id");
2401
2865
  <dd>
2402
2866
 
2403
2867
  ```typescript
2404
- await client.orders.cancelByOrderIdOrShortId("order_id_or_short_id");
2868
+ await client.connections.listCouriers();
2405
2869
  ```
2406
2870
 
2407
2871
  </dd>
@@ -2417,15 +2881,7 @@ await client.orders.cancelByOrderIdOrShortId("order_id_or_short_id");
2417
2881
  <dl>
2418
2882
  <dd>
2419
2883
 
2420
- **orderIdOrShortId:** `string`
2421
-
2422
- </dd>
2423
- </dl>
2424
-
2425
- <dl>
2426
- <dd>
2427
-
2428
- **requestOptions:** `Orders.RequestOptions`
2884
+ **requestOptions:** `Connections.RequestOptions`
2429
2885
 
2430
2886
  </dd>
2431
2887
  </dl>
@@ -2436,11 +2892,13 @@ await client.orders.cancelByOrderIdOrShortId("order_id_or_short_id");
2436
2892
  </dl>
2437
2893
  </details>
2438
2894
 
2439
- <details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">create</a>({ ...params }) -> Chrt.CreateOrderRes</code></summary>
2895
+ ## TaskGroups
2896
+
2897
+ <details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">listByCourierOrgId</a>() -> Chrt.MultipleTaskGroupsWithTasks</code></summary>
2440
2898
  <dl>
2441
2899
  <dd>
2442
2900
 
2443
- #### 🔌 Usage
2901
+ #### 📝 Description
2444
2902
 
2445
2903
  <dl>
2446
2904
  <dd>
@@ -2448,38 +2906,14 @@ await client.orders.cancelByOrderIdOrShortId("order_id_or_short_id");
2448
2906
  <dl>
2449
2907
  <dd>
2450
2908
 
2451
- ```typescript
2452
- await client.orders.create({
2453
- cargo_client_creates_map: {
2454
- key: {
2455
- cargo_type: "spare_parts",
2456
- schema_version: 1,
2457
- },
2458
- },
2459
- order_client_create: {
2460
- schema_version: 1,
2461
- },
2462
- order_created_by_type: "chrt",
2463
- order_dispatch_type: "dtc",
2464
- task_client_creates_bundle_groupings: [
2465
- [
2466
- {
2467
- task_client_create: {
2468
- schema_version: 1,
2469
- },
2470
- },
2471
- ],
2472
- ],
2473
- transport_type: "ground_only",
2474
- });
2475
- ```
2909
+ Lists all task groups assigned to the authenticated courier organization with their associated tasks.
2476
2910
 
2477
2911
  </dd>
2478
2912
  </dl>
2479
2913
  </dd>
2480
2914
  </dl>
2481
2915
 
2482
- #### ⚙️ Parameters
2916
+ #### 🔌 Usage
2483
2917
 
2484
2918
  <dl>
2485
2919
  <dd>
@@ -2487,15 +2921,24 @@ await client.orders.create({
2487
2921
  <dl>
2488
2922
  <dd>
2489
2923
 
2490
- **request:** `Chrt.CreateOrderReq`
2924
+ ```typescript
2925
+ await client.taskGroups.listByCourierOrgId();
2926
+ ```
2491
2927
 
2492
2928
  </dd>
2493
2929
  </dl>
2930
+ </dd>
2931
+ </dl>
2932
+
2933
+ #### ⚙️ Parameters
2494
2934
 
2495
2935
  <dl>
2496
2936
  <dd>
2497
2937
 
2498
- **requestOptions:** `Orders.RequestOptions`
2938
+ <dl>
2939
+ <dd>
2940
+
2941
+ **requestOptions:** `TaskGroups.RequestOptions`
2499
2942
 
2500
2943
  </dd>
2501
2944
  </dl>
@@ -2506,7 +2949,7 @@ await client.orders.create({
2506
2949
  </dl>
2507
2950
  </details>
2508
2951
 
2509
- <details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">listByCourierOrgId</a>() -> Chrt.Order1[]</code></summary>
2952
+ <details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">getById</a>(id) -> Chrt.TaskGroupWithTasks</code></summary>
2510
2953
  <dl>
2511
2954
  <dd>
2512
2955
 
@@ -2518,7 +2961,7 @@ await client.orders.create({
2518
2961
  <dl>
2519
2962
  <dd>
2520
2963
 
2521
- Uses the org_id from the JWT
2964
+ Retrieves a specific task group by ID with its associated tasks.
2522
2965
 
2523
2966
  </dd>
2524
2967
  </dl>
@@ -2534,7 +2977,7 @@ Uses the org_id from the JWT
2534
2977
  <dd>
2535
2978
 
2536
2979
  ```typescript
2537
- await client.orders.listByCourierOrgId();
2980
+ await client.taskGroups.getById("id");
2538
2981
  ```
2539
2982
 
2540
2983
  </dd>
@@ -2550,7 +2993,15 @@ await client.orders.listByCourierOrgId();
2550
2993
  <dl>
2551
2994
  <dd>
2552
2995
 
2553
- **requestOptions:** `Orders.RequestOptions`
2996
+ **id:** `string`
2997
+
2998
+ </dd>
2999
+ </dl>
3000
+
3001
+ <dl>
3002
+ <dd>
3003
+
3004
+ **requestOptions:** `TaskGroups.RequestOptions`
2554
3005
 
2555
3006
  </dd>
2556
3007
  </dl>
@@ -2561,7 +3012,7 @@ await client.orders.listByCourierOrgId();
2561
3012
  </dl>
2562
3013
  </details>
2563
3014
 
2564
- <details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">listByShipperOrgId</a>() -> Chrt.Order1[]</code></summary>
3015
+ <details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">update</a>({ ...params }) -> Chrt.UpdateTaskGroupRes</code></summary>
2565
3016
  <dl>
2566
3017
  <dd>
2567
3018
 
@@ -2573,7 +3024,7 @@ await client.orders.listByCourierOrgId();
2573
3024
  <dl>
2574
3025
  <dd>
2575
3026
 
2576
- Uses the org_id from the JWT
3027
+ Updates task group driver assignments by adding or removing drivers.
2577
3028
 
2578
3029
  </dd>
2579
3030
  </dl>
@@ -2589,7 +3040,9 @@ Uses the org_id from the JWT
2589
3040
  <dd>
2590
3041
 
2591
3042
  ```typescript
2592
- await client.orders.listByShipperOrgId();
3043
+ await client.taskGroups.update({
3044
+ task_group_id: "task_group_id",
3045
+ });
2593
3046
  ```
2594
3047
 
2595
3048
  </dd>
@@ -2605,7 +3058,15 @@ await client.orders.listByShipperOrgId();
2605
3058
  <dl>
2606
3059
  <dd>
2607
3060
 
2608
- **requestOptions:** `Orders.RequestOptions`
3061
+ **request:** `Chrt.UpdateTaskGroupReq`
3062
+
3063
+ </dd>
3064
+ </dl>
3065
+
3066
+ <dl>
3067
+ <dd>
3068
+
3069
+ **requestOptions:** `TaskGroups.RequestOptions`
2609
3070
 
2610
3071
  </dd>
2611
3072
  </dl>
@@ -2616,7 +3077,7 @@ await client.orders.listByShipperOrgId();
2616
3077
  </dl>
2617
3078
  </details>
2618
3079
 
2619
- <details><summary><code>client.orders.<a href="/src/api/resources/orders/client/Client.ts">getByOrderIdOrShortId</a>(orderIdOrShortId) -> Chrt.GetOrderRes</code></summary>
3080
+ <details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">listByDriverId</a>(driverId) -> Chrt.TaskGroup1[]</code></summary>
2620
3081
  <dl>
2621
3082
  <dd>
2622
3083
 
@@ -2628,7 +3089,7 @@ await client.orders.listByShipperOrgId();
2628
3089
  <dl>
2629
3090
  <dd>
2630
3091
 
2631
- Accepts both order_id and order_short_id values and returns just the Order
3092
+ Lists all task groups assigned to a specific driver.
2632
3093
 
2633
3094
  </dd>
2634
3095
  </dl>
@@ -2644,7 +3105,7 @@ Accepts both order_id and order_short_id values and returns just the Order
2644
3105
  <dd>
2645
3106
 
2646
3107
  ```typescript
2647
- await client.orders.getByOrderIdOrShortId("order_id_or_short_id");
3108
+ await client.taskGroups.listByDriverId("driver_id");
2648
3109
  ```
2649
3110
 
2650
3111
  </dd>
@@ -2660,7 +3121,7 @@ await client.orders.getByOrderIdOrShortId("order_id_or_short_id");
2660
3121
  <dl>
2661
3122
  <dd>
2662
3123
 
2663
- **orderIdOrShortId:** `string`
3124
+ **driverId:** `string`
2664
3125
 
2665
3126
  </dd>
2666
3127
  </dl>
@@ -2668,7 +3129,7 @@ await client.orders.getByOrderIdOrShortId("order_id_or_short_id");
2668
3129
  <dl>
2669
3130
  <dd>
2670
3131
 
2671
- **requestOptions:** `Orders.RequestOptions`
3132
+ **requestOptions:** `TaskGroups.RequestOptions`
2672
3133
 
2673
3134
  </dd>
2674
3135
  </dl>
@@ -2679,9 +3140,7 @@ await client.orders.getByOrderIdOrShortId("order_id_or_short_id");
2679
3140
  </dl>
2680
3141
  </details>
2681
3142
 
2682
- ## OrgProfiles
2683
-
2684
- <details><summary><code>client.orgProfiles.<a href="/src/api/resources/orgProfiles/client/Client.ts">get</a>() -> Chrt.CourierOrgProfile3</code></summary>
3143
+ <details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">start</a>(id) -> boolean</code></summary>
2685
3144
  <dl>
2686
3145
  <dd>
2687
3146
 
@@ -2693,7 +3152,7 @@ await client.orders.getByOrderIdOrShortId("order_id_or_short_id");
2693
3152
  <dl>
2694
3153
  <dd>
2695
3154
 
2696
- Retrieve the courier organization profile for the authenticated organization using the org_id from the JWT token.
3155
+ Starts a task group by changing its status to in-progress and updating the order status.
2697
3156
 
2698
3157
  </dd>
2699
3158
  </dl>
@@ -2709,7 +3168,7 @@ Retrieve the courier organization profile for the authenticated organization usi
2709
3168
  <dd>
2710
3169
 
2711
3170
  ```typescript
2712
- await client.orgProfiles.get();
3171
+ await client.taskGroups.start("id");
2713
3172
  ```
2714
3173
 
2715
3174
  </dd>
@@ -2725,7 +3184,15 @@ await client.orgProfiles.get();
2725
3184
  <dl>
2726
3185
  <dd>
2727
3186
 
2728
- **requestOptions:** `OrgProfiles.RequestOptions`
3187
+ **id:** `string`
3188
+
3189
+ </dd>
3190
+ </dl>
3191
+
3192
+ <dl>
3193
+ <dd>
3194
+
3195
+ **requestOptions:** `TaskGroups.RequestOptions`
2729
3196
 
2730
3197
  </dd>
2731
3198
  </dl>
@@ -2736,7 +3203,9 @@ await client.orgProfiles.get();
2736
3203
  </dl>
2737
3204
  </details>
2738
3205
 
2739
- <details><summary><code>client.orgProfiles.<a href="/src/api/resources/orgProfiles/client/Client.ts">getAvatar</a>({ ...params }) -> string</code></summary>
3206
+ ## ShipperContactInfo
3207
+
3208
+ <details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">getByJwtUserId</a>() -> Chrt.ShipperContactInfo1</code></summary>
2740
3209
  <dl>
2741
3210
  <dd>
2742
3211
 
@@ -2748,7 +3217,7 @@ await client.orgProfiles.get();
2748
3217
  <dl>
2749
3218
  <dd>
2750
3219
 
2751
- Get the avatar image URL for an organization using their handle. Returns the image URL from Clerk or a placeholder if not found.
3220
+ Retrieves the authenticated user's own shipper contact information.
2752
3221
 
2753
3222
  </dd>
2754
3223
  </dl>
@@ -2764,9 +3233,7 @@ Get the avatar image URL for an organization using their handle. Returns the ima
2764
3233
  <dd>
2765
3234
 
2766
3235
  ```typescript
2767
- await client.orgProfiles.getAvatar({
2768
- handle: "handle",
2769
- });
3236
+ await client.shipperContactInfo.getByJwtUserId();
2770
3237
  ```
2771
3238
 
2772
3239
  </dd>
@@ -2782,15 +3249,7 @@ await client.orgProfiles.getAvatar({
2782
3249
  <dl>
2783
3250
  <dd>
2784
3251
 
2785
- **request:** `Chrt.OrgProfilesGetAvatarRequest`
2786
-
2787
- </dd>
2788
- </dl>
2789
-
2790
- <dl>
2791
- <dd>
2792
-
2793
- **requestOptions:** `OrgProfiles.RequestOptions`
3252
+ **requestOptions:** `ShipperContactInfo.RequestOptions`
2794
3253
 
2795
3254
  </dd>
2796
3255
  </dl>
@@ -2801,7 +3260,7 @@ await client.orgProfiles.getAvatar({
2801
3260
  </dl>
2802
3261
  </details>
2803
3262
 
2804
- <details><summary><code>client.orgProfiles.<a href="/src/api/resources/orgProfiles/client/Client.ts">create</a>({ ...params }) -> string</code></summary>
3263
+ <details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">listByJwtOrgId</a>() -> Chrt.ShipperContactInfo1[]</code></summary>
2805
3264
  <dl>
2806
3265
  <dd>
2807
3266
 
@@ -2813,7 +3272,7 @@ await client.orgProfiles.getAvatar({
2813
3272
  <dl>
2814
3273
  <dd>
2815
3274
 
2816
- Create a new courier organization profile. This endpoint will fail if a profile already exists for the organization.
3275
+ Lists all shipper contacts created by the authenticated organization.
2817
3276
 
2818
3277
  </dd>
2819
3278
  </dl>
@@ -2829,12 +3288,7 @@ Create a new courier organization profile. This endpoint will fail if a profile
2829
3288
  <dd>
2830
3289
 
2831
3290
  ```typescript
2832
- await client.orgProfiles.create({
2833
- description: "description",
2834
- email_address_primary: "email_address_primary",
2835
- phone_number_primary: "phone_number_primary",
2836
- schema_version: 1,
2837
- });
3291
+ await client.shipperContactInfo.listByJwtOrgId();
2838
3292
  ```
2839
3293
 
2840
3294
  </dd>
@@ -2850,15 +3304,7 @@ await client.orgProfiles.create({
2850
3304
  <dl>
2851
3305
  <dd>
2852
3306
 
2853
- **request:** `Chrt.CourierOrgProfileClientCreate3`
2854
-
2855
- </dd>
2856
- </dl>
2857
-
2858
- <dl>
2859
- <dd>
2860
-
2861
- **requestOptions:** `OrgProfiles.RequestOptions`
3307
+ **requestOptions:** `ShipperContactInfo.RequestOptions`
2862
3308
 
2863
3309
  </dd>
2864
3310
  </dl>
@@ -2869,7 +3315,7 @@ await client.orgProfiles.create({
2869
3315
  </dl>
2870
3316
  </details>
2871
3317
 
2872
- <details><summary><code>client.orgProfiles.<a href="/src/api/resources/orgProfiles/client/Client.ts">update</a>({ ...params }) -> boolean</code></summary>
3318
+ <details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">listCourierContactsByShipperOrgId</a>(shipperOrgId) -> Chrt.ShipperContactInfo1[]</code></summary>
2873
3319
  <dl>
2874
3320
  <dd>
2875
3321
 
@@ -2881,7 +3327,7 @@ await client.orgProfiles.create({
2881
3327
  <dl>
2882
3328
  <dd>
2883
3329
 
2884
- Update an existing courier organization profile. Can update one or more fields. Profile must exist before updating.
3330
+ Lists all shipper contacts accessible to the courier organization for a specific on-platform shipper.
2885
3331
 
2886
3332
  </dd>
2887
3333
  </dl>
@@ -2897,7 +3343,7 @@ Update an existing courier organization profile. Can update one or more fields.
2897
3343
  <dd>
2898
3344
 
2899
3345
  ```typescript
2900
- await client.orgProfiles.update();
3346
+ await client.shipperContactInfo.listCourierContactsByShipperOrgId("shipper_org_id");
2901
3347
  ```
2902
3348
 
2903
3349
  </dd>
@@ -2913,7 +3359,7 @@ await client.orgProfiles.update();
2913
3359
  <dl>
2914
3360
  <dd>
2915
3361
 
2916
- **request:** `Chrt.CourierOrgProfileClientUpdate3`
3362
+ **shipperOrgId:** `string`
2917
3363
 
2918
3364
  </dd>
2919
3365
  </dl>
@@ -2921,7 +3367,7 @@ await client.orgProfiles.update();
2921
3367
  <dl>
2922
3368
  <dd>
2923
3369
 
2924
- **requestOptions:** `OrgProfiles.RequestOptions`
3370
+ **requestOptions:** `ShipperContactInfo.RequestOptions`
2925
3371
 
2926
3372
  </dd>
2927
3373
  </dl>
@@ -2932,7 +3378,7 @@ await client.orgProfiles.update();
2932
3378
  </dl>
2933
3379
  </details>
2934
3380
 
2935
- <details><summary><code>client.orgProfiles.<a href="/src/api/resources/orgProfiles/client/Client.ts">getByHandle</a>(handle) -> Chrt.CourierOrgProfile3</code></summary>
3381
+ <details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">listByOffChrtShipperOrgConnectionInfoId</a>(offChrtShipperOrgConnectionInfoId) -> Chrt.ShipperContactInfo1[]</code></summary>
2936
3382
  <dl>
2937
3383
  <dd>
2938
3384
 
@@ -2944,7 +3390,7 @@ await client.orgProfiles.update();
2944
3390
  <dl>
2945
3391
  <dd>
2946
3392
 
2947
- Retrieve a courier organization profile using the organization's handle. This endpoint is used for public profile viewing.
3393
+ Lists all shipper contacts for a specific off-platform shipper connection.
2948
3394
 
2949
3395
  </dd>
2950
3396
  </dl>
@@ -2960,7 +3406,7 @@ Retrieve a courier organization profile using the organization's handle. This en
2960
3406
  <dd>
2961
3407
 
2962
3408
  ```typescript
2963
- await client.orgProfiles.getByHandle("handle");
3409
+ await client.shipperContactInfo.listByOffChrtShipperOrgConnectionInfoId("off_chrt_shipper_org_connection_info_id");
2964
3410
  ```
2965
3411
 
2966
3412
  </dd>
@@ -2976,7 +3422,7 @@ await client.orgProfiles.getByHandle("handle");
2976
3422
  <dl>
2977
3423
  <dd>
2978
3424
 
2979
- **handle:** `string`
3425
+ **offChrtShipperOrgConnectionInfoId:** `string`
2980
3426
 
2981
3427
  </dd>
2982
3428
  </dl>
@@ -2984,7 +3430,7 @@ await client.orgProfiles.getByHandle("handle");
2984
3430
  <dl>
2985
3431
  <dd>
2986
3432
 
2987
- **requestOptions:** `OrgProfiles.RequestOptions`
3433
+ **requestOptions:** `ShipperContactInfo.RequestOptions`
2988
3434
 
2989
3435
  </dd>
2990
3436
  </dl>
@@ -2995,9 +3441,7 @@ await client.orgProfiles.getByHandle("handle");
2995
3441
  </dl>
2996
3442
  </details>
2997
3443
 
2998
- ## ShipperContactInfo
2999
-
3000
- <details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">getByJwtUserId</a>() -> Chrt.ShipperContactInfo1</code></summary>
3444
+ <details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">getById</a>(id) -> Chrt.ShipperContactInfo1</code></summary>
3001
3445
  <dl>
3002
3446
  <dd>
3003
3447
 
@@ -3009,7 +3453,7 @@ await client.orgProfiles.getByHandle("handle");
3009
3453
  <dl>
3010
3454
  <dd>
3011
3455
 
3012
- Get my own shipper contact info (for authenticated shippers users)
3456
+ Retrieves a specific shipper contact by ID if authorized to access it.
3013
3457
 
3014
3458
  </dd>
3015
3459
  </dl>
@@ -3025,7 +3469,7 @@ Get my own shipper contact info (for authenticated shippers users)
3025
3469
  <dd>
3026
3470
 
3027
3471
  ```typescript
3028
- await client.shipperContactInfo.getByJwtUserId();
3472
+ await client.shipperContactInfo.getById("id");
3029
3473
  ```
3030
3474
 
3031
3475
  </dd>
@@ -3041,6 +3485,14 @@ await client.shipperContactInfo.getByJwtUserId();
3041
3485
  <dl>
3042
3486
  <dd>
3043
3487
 
3488
+ **id:** `string`
3489
+
3490
+ </dd>
3491
+ </dl>
3492
+
3493
+ <dl>
3494
+ <dd>
3495
+
3044
3496
  **requestOptions:** `ShipperContactInfo.RequestOptions`
3045
3497
 
3046
3498
  </dd>
@@ -3052,7 +3504,7 @@ await client.shipperContactInfo.getByJwtUserId();
3052
3504
  </dl>
3053
3505
  </details>
3054
3506
 
3055
- <details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">listCourierContactsByShipperOrgId</a>(shipperOrgId) -> Chrt.ShipperContactInfo1[]</code></summary>
3507
+ <details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">createOnPlatform</a>({ ...params }) -> string</code></summary>
3056
3508
  <dl>
3057
3509
  <dd>
3058
3510
 
@@ -3064,15 +3516,12 @@ await client.shipperContactInfo.getByJwtUserId();
3064
3516
  <dl>
3065
3517
  <dd>
3066
3518
 
3067
- Get all contacts accessible to courier org for a specific on-platform shipper.
3068
- Returns:
3519
+ Creates contact information for an on-platform shipper organization or user.
3069
3520
 
3070
- 1. Contacts created by the courier org that are linked to the shipper org
3071
- 2. Contacts created by the shipper org themselves (if courier and shipper are connected)
3072
- </dd>
3073
- </dl>
3074
- </dd>
3075
- </dl>
3521
+ </dd>
3522
+ </dl>
3523
+ </dd>
3524
+ </dl>
3076
3525
 
3077
3526
  #### 🔌 Usage
3078
3527
 
@@ -3083,7 +3532,9 @@ Returns:
3083
3532
  <dd>
3084
3533
 
3085
3534
  ```typescript
3086
- await client.shipperContactInfo.listCourierContactsByShipperOrgId("shipper_org_id");
3535
+ await client.shipperContactInfo.createOnPlatform({
3536
+ schema_version: 1,
3537
+ });
3087
3538
  ```
3088
3539
 
3089
3540
  </dd>
@@ -3099,7 +3550,7 @@ await client.shipperContactInfo.listCourierContactsByShipperOrgId("shipper_org_i
3099
3550
  <dl>
3100
3551
  <dd>
3101
3552
 
3102
- **shipperOrgId:** `string`
3553
+ **request:** `Chrt.ShipperContactInfoClientCreate1`
3103
3554
 
3104
3555
  </dd>
3105
3556
  </dl>
@@ -3130,7 +3581,7 @@ await client.shipperContactInfo.listCourierContactsByShipperOrgId("shipper_org_i
3130
3581
  <dl>
3131
3582
  <dd>
3132
3583
 
3133
- Create shipper contact info for off-platform shipper (scenario 3)
3584
+ Creates contact information for an off-platform shipper using connection info.
3134
3585
 
3135
3586
  </dd>
3136
3587
  </dl>
@@ -3183,7 +3634,7 @@ await client.shipperContactInfo.createOffPlatform({
3183
3634
  </dl>
3184
3635
  </details>
3185
3636
 
3186
- <details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">createOnPlatform</a>({ ...params }) -> string</code></summary>
3637
+ <details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">update</a>(shipperContactInfoId, { ...params }) -> boolean</code></summary>
3187
3638
  <dl>
3188
3639
  <dd>
3189
3640
 
@@ -3195,7 +3646,7 @@ await client.shipperContactInfo.createOffPlatform({
3195
3646
  <dl>
3196
3647
  <dd>
3197
3648
 
3198
- Create shipper contact info for on-platform shipper (scenarios 1 & 2)
3649
+ Updates existing shipper contact information owned by the authenticated organization.
3199
3650
 
3200
3651
  </dd>
3201
3652
  </dl>
@@ -3211,9 +3662,7 @@ Create shipper contact info for on-platform shipper (scenarios 1 & 2)
3211
3662
  <dd>
3212
3663
 
3213
3664
  ```typescript
3214
- await client.shipperContactInfo.createOnPlatform({
3215
- schema_version: 1,
3216
- });
3665
+ await client.shipperContactInfo.update("shipper_contact_info_id");
3217
3666
  ```
3218
3667
 
3219
3668
  </dd>
@@ -3229,7 +3678,15 @@ await client.shipperContactInfo.createOnPlatform({
3229
3678
  <dl>
3230
3679
  <dd>
3231
3680
 
3232
- **request:** `Chrt.ShipperContactInfoClientCreate1`
3681
+ **shipperContactInfoId:** `string`
3682
+
3683
+ </dd>
3684
+ </dl>
3685
+
3686
+ <dl>
3687
+ <dd>
3688
+
3689
+ **request:** `Chrt.ShipperContactInfoClientUpdate1`
3233
3690
 
3234
3691
  </dd>
3235
3692
  </dl>
@@ -3252,6 +3709,21 @@ await client.shipperContactInfo.createOnPlatform({
3252
3709
  <dl>
3253
3710
  <dd>
3254
3711
 
3712
+ #### 📝 Description
3713
+
3714
+ <dl>
3715
+ <dd>
3716
+
3717
+ <dl>
3718
+ <dd>
3719
+
3720
+ Deletes shipper contact information owned by the authenticated organization.
3721
+
3722
+ </dd>
3723
+ </dl>
3724
+ </dd>
3725
+ </dl>
3726
+
3255
3727
  #### 🔌 Usage
3256
3728
 
3257
3729
  <dl>
@@ -3296,7 +3768,9 @@ await client.shipperContactInfo.deleteById("id");
3296
3768
  </dl>
3297
3769
  </details>
3298
3770
 
3299
- <details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">listByJwtOrgId</a>() -> Chrt.ShipperContactInfo1[]</code></summary>
3771
+ ## MilestoneNotifications
3772
+
3773
+ <details><summary><code>client.milestoneNotifications.<a href="/src/api/resources/milestoneNotifications/client/Client.ts">getPreferences</a>() -> Chrt.MilestoneNotificationPreferences1</code></summary>
3300
3774
  <dl>
3301
3775
  <dd>
3302
3776
 
@@ -3308,7 +3782,7 @@ await client.shipperContactInfo.deleteById("id");
3308
3782
  <dl>
3309
3783
  <dd>
3310
3784
 
3311
- Get all contacts for my organization which were created by the shipper org (for authenticated shipper orgs)
3785
+ Retrieves milestone notification preferences for the authenticated organization.
3312
3786
 
3313
3787
  </dd>
3314
3788
  </dl>
@@ -3324,7 +3798,7 @@ Get all contacts for my organization which were created by the shipper org (for
3324
3798
  <dd>
3325
3799
 
3326
3800
  ```typescript
3327
- await client.shipperContactInfo.listByJwtOrgId();
3801
+ await client.milestoneNotifications.getPreferences();
3328
3802
  ```
3329
3803
 
3330
3804
  </dd>
@@ -3340,7 +3814,7 @@ await client.shipperContactInfo.listByJwtOrgId();
3340
3814
  <dl>
3341
3815
  <dd>
3342
3816
 
3343
- **requestOptions:** `ShipperContactInfo.RequestOptions`
3817
+ **requestOptions:** `MilestoneNotifications.RequestOptions`
3344
3818
 
3345
3819
  </dd>
3346
3820
  </dl>
@@ -3351,7 +3825,7 @@ await client.shipperContactInfo.listByJwtOrgId();
3351
3825
  </dl>
3352
3826
  </details>
3353
3827
 
3354
- <details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">listByOffChrtShipperOrgConnectionInfoId</a>(offChrtShipperOrgConnectionInfoId) -> Chrt.ShipperContactInfo1[]</code></summary>
3828
+ <details><summary><code>client.milestoneNotifications.<a href="/src/api/resources/milestoneNotifications/client/Client.ts">upsertPreferences</a>({ ...params }) -> string</code></summary>
3355
3829
  <dl>
3356
3830
  <dd>
3357
3831
 
@@ -3363,8 +3837,7 @@ await client.shipperContactInfo.listByJwtOrgId();
3363
3837
  <dl>
3364
3838
  <dd>
3365
3839
 
3366
- Get all contacts accessible to courier org for a specific off-platform shipper.
3367
- Returns only contacts created by the courier org since off-platform shippers cannot create their own contacts.
3840
+ Creates or updates milestone notification preferences for the authenticated organization.
3368
3841
 
3369
3842
  </dd>
3370
3843
  </dl>
@@ -3380,7 +3853,9 @@ Returns only contacts created by the courier org since off-platform shippers can
3380
3853
  <dd>
3381
3854
 
3382
3855
  ```typescript
3383
- await client.shipperContactInfo.listByOffChrtShipperOrgConnectionInfoId("off_chrt_shipper_org_connection_info_id");
3856
+ await client.milestoneNotifications.upsertPreferences({
3857
+ schema_version: 1,
3858
+ });
3384
3859
  ```
3385
3860
 
3386
3861
  </dd>
@@ -3396,7 +3871,7 @@ await client.shipperContactInfo.listByOffChrtShipperOrgConnectionInfoId("off_chr
3396
3871
  <dl>
3397
3872
  <dd>
3398
3873
 
3399
- **offChrtShipperOrgConnectionInfoId:** `string`
3874
+ **request:** `Chrt.MilestoneNotificationPreferencesClientCreate1`
3400
3875
 
3401
3876
  </dd>
3402
3877
  </dl>
@@ -3404,7 +3879,7 @@ await client.shipperContactInfo.listByOffChrtShipperOrgConnectionInfoId("off_chr
3404
3879
  <dl>
3405
3880
  <dd>
3406
3881
 
3407
- **requestOptions:** `ShipperContactInfo.RequestOptions`
3882
+ **requestOptions:** `MilestoneNotifications.RequestOptions`
3408
3883
 
3409
3884
  </dd>
3410
3885
  </dl>
@@ -3415,11 +3890,13 @@ await client.shipperContactInfo.listByOffChrtShipperOrgConnectionInfoId("off_chr
3415
3890
  </dl>
3416
3891
  </details>
3417
3892
 
3418
- <details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">update</a>(shipperContactInfoId, { ...params }) -> boolean</code></summary>
3893
+ ## Orgs
3894
+
3895
+ <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getInfo</a>() -> unknown</code></summary>
3419
3896
  <dl>
3420
3897
  <dd>
3421
3898
 
3422
- #### 🔌 Usage
3899
+ #### 📝 Description
3423
3900
 
3424
3901
  <dl>
3425
3902
  <dd>
@@ -3427,16 +3904,14 @@ await client.shipperContactInfo.listByOffChrtShipperOrgConnectionInfoId("off_chr
3427
3904
  <dl>
3428
3905
  <dd>
3429
3906
 
3430
- ```typescript
3431
- await client.shipperContactInfo.update("shipper_contact_info_id");
3432
- ```
3907
+ Retrieves basic organization information from the authentication service.
3433
3908
 
3434
3909
  </dd>
3435
3910
  </dl>
3436
3911
  </dd>
3437
3912
  </dl>
3438
3913
 
3439
- #### ⚙️ Parameters
3914
+ #### 🔌 Usage
3440
3915
 
3441
3916
  <dl>
3442
3917
  <dd>
@@ -3444,23 +3919,24 @@ await client.shipperContactInfo.update("shipper_contact_info_id");
3444
3919
  <dl>
3445
3920
  <dd>
3446
3921
 
3447
- **shipperContactInfoId:** `string`
3922
+ ```typescript
3923
+ await client.orgs.getInfo();
3924
+ ```
3448
3925
 
3449
3926
  </dd>
3450
3927
  </dl>
3928
+ </dd>
3929
+ </dl>
3930
+
3931
+ #### ⚙️ Parameters
3451
3932
 
3452
3933
  <dl>
3453
3934
  <dd>
3454
3935
 
3455
- **request:** `Chrt.ShipperContactInfoClientUpdate1`
3456
-
3457
- </dd>
3458
- </dl>
3459
-
3460
3936
  <dl>
3461
3937
  <dd>
3462
3938
 
3463
- **requestOptions:** `ShipperContactInfo.RequestOptions`
3939
+ **requestOptions:** `Orgs.RequestOptions`
3464
3940
 
3465
3941
  </dd>
3466
3942
  </dl>
@@ -3471,7 +3947,7 @@ await client.shipperContactInfo.update("shipper_contact_info_id");
3471
3947
  </dl>
3472
3948
  </details>
3473
3949
 
3474
- <details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">getById</a>(id) -> Chrt.ShipperContactInfo1</code></summary>
3950
+ <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">listMembers</a>() -> Chrt.OrgMemberDetails[]</code></summary>
3475
3951
  <dl>
3476
3952
  <dd>
3477
3953
 
@@ -3483,7 +3959,7 @@ await client.shipperContactInfo.update("shipper_contact_info_id");
3483
3959
  <dl>
3484
3960
  <dd>
3485
3961
 
3486
- Get a specific shipper contact info by ID
3962
+ Lists all members of the authenticated organization with their roles and details.
3487
3963
 
3488
3964
  </dd>
3489
3965
  </dl>
@@ -3499,7 +3975,7 @@ Get a specific shipper contact info by ID
3499
3975
  <dd>
3500
3976
 
3501
3977
  ```typescript
3502
- await client.shipperContactInfo.getById("id");
3978
+ await client.orgs.listMembers();
3503
3979
  ```
3504
3980
 
3505
3981
  </dd>
@@ -3515,15 +3991,7 @@ await client.shipperContactInfo.getById("id");
3515
3991
  <dl>
3516
3992
  <dd>
3517
3993
 
3518
- **id:** `string`
3519
-
3520
- </dd>
3521
- </dl>
3522
-
3523
- <dl>
3524
- <dd>
3525
-
3526
- **requestOptions:** `ShipperContactInfo.RequestOptions`
3994
+ **requestOptions:** `Orgs.RequestOptions`
3527
3995
 
3528
3996
  </dd>
3529
3997
  </dl>
@@ -3534,9 +4002,7 @@ await client.shipperContactInfo.getById("id");
3534
4002
  </dl>
3535
4003
  </details>
3536
4004
 
3537
- ## TaskGroups
3538
-
3539
- <details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">listByCourierOrgId</a>() -> Chrt.MultipleTaskGroupsWithTasks</code></summary>
4005
+ <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getPublicData</a>() -> Chrt.OrgPublicData2</code></summary>
3540
4006
  <dl>
3541
4007
  <dd>
3542
4008
 
@@ -3548,7 +4014,7 @@ await client.shipperContactInfo.getById("id");
3548
4014
  <dl>
3549
4015
  <dd>
3550
4016
 
3551
- Uses the org_id from the JWT - returns task groups and with their list of tasks for the courier org
4017
+ Retrieves public organization data for the authenticated organization.
3552
4018
 
3553
4019
  </dd>
3554
4020
  </dl>
@@ -3564,7 +4030,7 @@ Uses the org_id from the JWT - returns task groups and with their list of tasks
3564
4030
  <dd>
3565
4031
 
3566
4032
  ```typescript
3567
- await client.taskGroups.listByCourierOrgId();
4033
+ await client.orgs.getPublicData();
3568
4034
  ```
3569
4035
 
3570
4036
  </dd>
@@ -3580,7 +4046,7 @@ await client.taskGroups.listByCourierOrgId();
3580
4046
  <dl>
3581
4047
  <dd>
3582
4048
 
3583
- **requestOptions:** `TaskGroups.RequestOptions`
4049
+ **requestOptions:** `Orgs.RequestOptions`
3584
4050
 
3585
4051
  </dd>
3586
4052
  </dl>
@@ -3591,58 +4057,25 @@ await client.taskGroups.listByCourierOrgId();
3591
4057
  </dl>
3592
4058
  </details>
3593
4059
 
3594
- <details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">listByDriverId</a>(driverId) -> Chrt.TaskGroup1[]</code></summary>
3595
- <dl>
3596
- <dd>
3597
-
3598
- #### 🔌 Usage
3599
-
3600
- <dl>
3601
- <dd>
3602
-
4060
+ <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getPublicDataByOrgId</a>(orgId) -> Chrt.OrgPublicData2</code></summary>
3603
4061
  <dl>
3604
4062
  <dd>
3605
4063
 
3606
- ```typescript
3607
- await client.taskGroups.listByDriverId("driver_id");
3608
- ```
3609
-
3610
- </dd>
3611
- </dl>
3612
- </dd>
3613
- </dl>
3614
-
3615
- #### ⚙️ Parameters
3616
-
3617
- <dl>
3618
- <dd>
4064
+ #### 📝 Description
3619
4065
 
3620
4066
  <dl>
3621
4067
  <dd>
3622
4068
 
3623
- **driverId:** `string`
3624
-
3625
- </dd>
3626
- </dl>
3627
-
3628
4069
  <dl>
3629
4070
  <dd>
3630
4071
 
3631
- **requestOptions:** `TaskGroups.RequestOptions`
4072
+ Retrieves public organization data for a specific organization by ID.
3632
4073
 
3633
4074
  </dd>
3634
4075
  </dl>
3635
4076
  </dd>
3636
4077
  </dl>
3637
4078
 
3638
- </dd>
3639
- </dl>
3640
- </details>
3641
-
3642
- <details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">start</a>(id) -> boolean</code></summary>
3643
- <dl>
3644
- <dd>
3645
-
3646
4079
  #### 🔌 Usage
3647
4080
 
3648
4081
  <dl>
@@ -3652,7 +4085,7 @@ await client.taskGroups.listByDriverId("driver_id");
3652
4085
  <dd>
3653
4086
 
3654
4087
  ```typescript
3655
- await client.taskGroups.start("id");
4088
+ await client.orgs.getPublicDataByOrgId("org_id");
3656
4089
  ```
3657
4090
 
3658
4091
  </dd>
@@ -3668,7 +4101,7 @@ await client.taskGroups.start("id");
3668
4101
  <dl>
3669
4102
  <dd>
3670
4103
 
3671
- **id:** `string`
4104
+ **orgId:** `string`
3672
4105
 
3673
4106
  </dd>
3674
4107
  </dl>
@@ -3676,7 +4109,7 @@ await client.taskGroups.start("id");
3676
4109
  <dl>
3677
4110
  <dd>
3678
4111
 
3679
- **requestOptions:** `TaskGroups.RequestOptions`
4112
+ **requestOptions:** `Orgs.RequestOptions`
3680
4113
 
3681
4114
  </dd>
3682
4115
  </dl>
@@ -3687,11 +4120,11 @@ await client.taskGroups.start("id");
3687
4120
  </dl>
3688
4121
  </details>
3689
4122
 
3690
- <details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">update</a>({ ...params }) -> Chrt.UpdateTaskGroupRes</code></summary>
4123
+ <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getHandle</a>() -> string</code></summary>
3691
4124
  <dl>
3692
4125
  <dd>
3693
4126
 
3694
- #### 🔌 Usage
4127
+ #### 📝 Description
3695
4128
 
3696
4129
  <dl>
3697
4130
  <dd>
@@ -3699,18 +4132,14 @@ await client.taskGroups.start("id");
3699
4132
  <dl>
3700
4133
  <dd>
3701
4134
 
3702
- ```typescript
3703
- await client.taskGroups.update({
3704
- task_group_id: "task_group_id",
3705
- });
3706
- ```
4135
+ Retrieves the organization handle for the authenticated organization.
3707
4136
 
3708
4137
  </dd>
3709
4138
  </dl>
3710
4139
  </dd>
3711
4140
  </dl>
3712
4141
 
3713
- #### ⚙️ Parameters
4142
+ #### 🔌 Usage
3714
4143
 
3715
4144
  <dl>
3716
4145
  <dd>
@@ -3718,15 +4147,24 @@ await client.taskGroups.update({
3718
4147
  <dl>
3719
4148
  <dd>
3720
4149
 
3721
- **request:** `Chrt.UpdateTaskGroupReq`
4150
+ ```typescript
4151
+ await client.orgs.getHandle();
4152
+ ```
3722
4153
 
3723
4154
  </dd>
3724
4155
  </dl>
4156
+ </dd>
4157
+ </dl>
4158
+
4159
+ #### ⚙️ Parameters
3725
4160
 
3726
4161
  <dl>
3727
4162
  <dd>
3728
4163
 
3729
- **requestOptions:** `TaskGroups.RequestOptions`
4164
+ <dl>
4165
+ <dd>
4166
+
4167
+ **requestOptions:** `Orgs.RequestOptions`
3730
4168
 
3731
4169
  </dd>
3732
4170
  </dl>
@@ -3737,7 +4175,7 @@ await client.taskGroups.update({
3737
4175
  </dl>
3738
4176
  </details>
3739
4177
 
3740
- <details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">getById</a>(id) -> Chrt.TaskGroupWithTasks</code></summary>
4178
+ <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getHandleAvailability</a>(handle) -> boolean</code></summary>
3741
4179
  <dl>
3742
4180
  <dd>
3743
4181
 
@@ -3749,7 +4187,7 @@ await client.taskGroups.update({
3749
4187
  <dl>
3750
4188
  <dd>
3751
4189
 
3752
- Returns a single task group and its tasks
4190
+ Checks if an organization handle is available for use.
3753
4191
 
3754
4192
  </dd>
3755
4193
  </dl>
@@ -3765,7 +4203,7 @@ Returns a single task group and its tasks
3765
4203
  <dd>
3766
4204
 
3767
4205
  ```typescript
3768
- await client.taskGroups.getById("id");
4206
+ await client.orgs.getHandleAvailability("handle");
3769
4207
  ```
3770
4208
 
3771
4209
  </dd>
@@ -3781,7 +4219,7 @@ await client.taskGroups.getById("id");
3781
4219
  <dl>
3782
4220
  <dd>
3783
4221
 
3784
- **id:** `string`
4222
+ **handle:** `string`
3785
4223
 
3786
4224
  </dd>
3787
4225
  </dl>
@@ -3789,7 +4227,7 @@ await client.taskGroups.getById("id");
3789
4227
  <dl>
3790
4228
  <dd>
3791
4229
 
3792
- **requestOptions:** `TaskGroups.RequestOptions`
4230
+ **requestOptions:** `Orgs.RequestOptions`
3793
4231
 
3794
4232
  </dd>
3795
4233
  </dl>
@@ -3800,9 +4238,7 @@ await client.taskGroups.getById("id");
3800
4238
  </dl>
3801
4239
  </details>
3802
4240
 
3803
- ## Orgs
3804
-
3805
- <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getHandle</a>() -> string</code></summary>
4241
+ <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">createPublicData</a>({ ...params }) -> boolean</code></summary>
3806
4242
  <dl>
3807
4243
  <dd>
3808
4244
 
@@ -3814,7 +4250,7 @@ await client.taskGroups.getById("id");
3814
4250
  <dl>
3815
4251
  <dd>
3816
4252
 
3817
- Get the handle for the org from JWT
4253
+ Creates public organization data with handle and company name for the authenticated organization.
3818
4254
 
3819
4255
  </dd>
3820
4256
  </dl>
@@ -3830,7 +4266,10 @@ Get the handle for the org from JWT
3830
4266
  <dd>
3831
4267
 
3832
4268
  ```typescript
3833
- await client.orgs.getHandle();
4269
+ await client.orgs.createPublicData({
4270
+ handle: "handle",
4271
+ company_name: "company_name",
4272
+ });
3834
4273
  ```
3835
4274
 
3836
4275
  </dd>
@@ -3846,6 +4285,14 @@ await client.orgs.getHandle();
3846
4285
  <dl>
3847
4286
  <dd>
3848
4287
 
4288
+ **request:** `Chrt.CreateOrgPublicDataReq`
4289
+
4290
+ </dd>
4291
+ </dl>
4292
+
4293
+ <dl>
4294
+ <dd>
4295
+
3849
4296
  **requestOptions:** `Orgs.RequestOptions`
3850
4297
 
3851
4298
  </dd>
@@ -3857,7 +4304,7 @@ await client.orgs.getHandle();
3857
4304
  </dl>
3858
4305
  </details>
3859
4306
 
3860
- <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getHandleAvailability</a>(handle) -> boolean</code></summary>
4307
+ <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">updatePublicData</a>({ ...params }) -> boolean</code></summary>
3861
4308
  <dl>
3862
4309
  <dd>
3863
4310
 
@@ -3869,7 +4316,7 @@ await client.orgs.getHandle();
3869
4316
  <dl>
3870
4317
  <dd>
3871
4318
 
3872
- Check if a handle is available, returns true if it is, false if it is not
4319
+ Updates the organization handle or company name for the authenticated organization.
3873
4320
 
3874
4321
  </dd>
3875
4322
  </dl>
@@ -3885,7 +4332,7 @@ Check if a handle is available, returns true if it is, false if it is not
3885
4332
  <dd>
3886
4333
 
3887
4334
  ```typescript
3888
- await client.orgs.getHandleAvailability("handle");
4335
+ await client.orgs.updatePublicData();
3889
4336
  ```
3890
4337
 
3891
4338
  </dd>
@@ -3901,7 +4348,7 @@ await client.orgs.getHandleAvailability("handle");
3901
4348
  <dl>
3902
4349
  <dd>
3903
4350
 
3904
- **handle:** `string`
4351
+ **request:** `Chrt.UpdateOrgPublicDataReq`
3905
4352
 
3906
4353
  </dd>
3907
4354
  </dl>
@@ -3920,11 +4367,13 @@ await client.orgs.getHandleAvailability("handle");
3920
4367
  </dl>
3921
4368
  </details>
3922
4369
 
3923
- <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getInfo</a>() -> Chrt.OrgMemberDetails[]</code></summary>
4370
+ ## Payments
4371
+
4372
+ <details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">createCheckoutSession</a>({ ...params }) -> Chrt.CreateCheckoutSessionRes2</code></summary>
3924
4373
  <dl>
3925
4374
  <dd>
3926
4375
 
3927
- #### 🔌 Usage
4376
+ #### 📝 Description
3928
4377
 
3929
4378
  <dl>
3930
4379
  <dd>
@@ -3932,16 +4381,14 @@ await client.orgs.getHandleAvailability("handle");
3932
4381
  <dl>
3933
4382
  <dd>
3934
4383
 
3935
- ```typescript
3936
- await client.orgs.getInfo();
3937
- ```
4384
+ Create a checkout session for a subscription
3938
4385
 
3939
4386
  </dd>
3940
4387
  </dl>
3941
4388
  </dd>
3942
4389
  </dl>
3943
4390
 
3944
- #### ⚙️ Parameters
4391
+ #### 🔌 Usage
3945
4392
 
3946
4393
  <dl>
3947
4394
  <dd>
@@ -3949,22 +4396,18 @@ await client.orgs.getInfo();
3949
4396
  <dl>
3950
4397
  <dd>
3951
4398
 
3952
- **requestOptions:** `Orgs.RequestOptions`
4399
+ ```typescript
4400
+ await client.payments.createCheckoutSession({
4401
+ price_name: "courier_ops_solo_100_month",
4402
+ });
4403
+ ```
3953
4404
 
3954
4405
  </dd>
3955
4406
  </dl>
3956
4407
  </dd>
3957
4408
  </dl>
3958
4409
 
3959
- </dd>
3960
- </dl>
3961
- </details>
3962
-
3963
- <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">listMembers</a>() -> Chrt.OrgMemberDetails[]</code></summary>
3964
- <dl>
3965
- <dd>
3966
-
3967
- #### 🔌 Usage
4410
+ #### ⚙️ Parameters
3968
4411
 
3969
4412
  <dl>
3970
4413
  <dd>
@@ -3972,24 +4415,15 @@ await client.orgs.getInfo();
3972
4415
  <dl>
3973
4416
  <dd>
3974
4417
 
3975
- ```typescript
3976
- await client.orgs.listMembers();
3977
- ```
4418
+ **request:** `Chrt.CreateCheckoutSessionReq2`
3978
4419
 
3979
4420
  </dd>
3980
4421
  </dl>
3981
- </dd>
3982
- </dl>
3983
-
3984
- #### ⚙️ Parameters
3985
-
3986
- <dl>
3987
- <dd>
3988
4422
 
3989
4423
  <dl>
3990
4424
  <dd>
3991
4425
 
3992
- **requestOptions:** `Orgs.RequestOptions`
4426
+ **requestOptions:** `Payments.RequestOptions`
3993
4427
 
3994
4428
  </dd>
3995
4429
  </dl>
@@ -4000,7 +4434,7 @@ await client.orgs.listMembers();
4000
4434
  </dl>
4001
4435
  </details>
4002
4436
 
4003
- <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getPublicData</a>() -> Chrt.OrgPublicData2</code></summary>
4437
+ <details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">syncStripeToClerk</a>() -> boolean</code></summary>
4004
4438
  <dl>
4005
4439
  <dd>
4006
4440
 
@@ -4012,7 +4446,7 @@ await client.orgs.listMembers();
4012
4446
  <dl>
4013
4447
  <dd>
4014
4448
 
4015
- Get the org public data for the org from JWT
4449
+ Synchronizes subscription data from Stripe to the authentication service for the current user.
4016
4450
 
4017
4451
  </dd>
4018
4452
  </dl>
@@ -4028,7 +4462,7 @@ Get the org public data for the org from JWT
4028
4462
  <dd>
4029
4463
 
4030
4464
  ```typescript
4031
- await client.orgs.getPublicData();
4465
+ await client.payments.syncStripeToClerk();
4032
4466
  ```
4033
4467
 
4034
4468
  </dd>
@@ -4044,7 +4478,7 @@ await client.orgs.getPublicData();
4044
4478
  <dl>
4045
4479
  <dd>
4046
4480
 
4047
- **requestOptions:** `Orgs.RequestOptions`
4481
+ **requestOptions:** `Payments.RequestOptions`
4048
4482
 
4049
4483
  </dd>
4050
4484
  </dl>
@@ -4055,7 +4489,9 @@ await client.orgs.getPublicData();
4055
4489
  </dl>
4056
4490
  </details>
4057
4491
 
4058
- <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">createPublicData</a>({ ...params }) -> boolean</code></summary>
4492
+ ## Root
4493
+
4494
+ <details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">pingAuthd</a>() -> Record<string, string></code></summary>
4059
4495
  <dl>
4060
4496
  <dd>
4061
4497
 
@@ -4067,7 +4503,7 @@ await client.orgs.getPublicData();
4067
4503
  <dl>
4068
4504
  <dd>
4069
4505
 
4070
- Create org public data with handle and company name
4506
+ Test endpoint for authenticated requests that requires valid authentication tokens.
4071
4507
 
4072
4508
  </dd>
4073
4509
  </dl>
@@ -4083,10 +4519,7 @@ Create org public data with handle and company name
4083
4519
  <dd>
4084
4520
 
4085
4521
  ```typescript
4086
- await client.orgs.createPublicData({
4087
- company_name: "company_name",
4088
- handle: "handle",
4089
- });
4522
+ await client.root.pingAuthd();
4090
4523
  ```
4091
4524
 
4092
4525
  </dd>
@@ -4097,20 +4530,12 @@ await client.orgs.createPublicData({
4097
4530
  #### ⚙️ Parameters
4098
4531
 
4099
4532
  <dl>
4100
- <dd>
4101
-
4102
- <dl>
4103
- <dd>
4104
-
4105
- **request:** `Chrt.CreateOrgPublicDataReq`
4106
-
4107
- </dd>
4108
- </dl>
4533
+ <dd>
4109
4534
 
4110
4535
  <dl>
4111
4536
  <dd>
4112
4537
 
4113
- **requestOptions:** `Orgs.RequestOptions`
4538
+ **requestOptions:** `Root.RequestOptions`
4114
4539
 
4115
4540
  </dd>
4116
4541
  </dl>
@@ -4121,7 +4546,7 @@ await client.orgs.createPublicData({
4121
4546
  </dl>
4122
4547
  </details>
4123
4548
 
4124
- <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">updatePublicData</a>({ ...params }) -> boolean</code></summary>
4549
+ <details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">pingOptionallyAuthd</a>() -> unknown</code></summary>
4125
4550
  <dl>
4126
4551
  <dd>
4127
4552
 
@@ -4133,7 +4558,7 @@ await client.orgs.createPublicData({
4133
4558
  <dl>
4134
4559
  <dd>
4135
4560
 
4136
- Update handle or company_name for an org
4561
+ Test endpoint for optionally authenticated requests that works with or without authentication.
4137
4562
 
4138
4563
  </dd>
4139
4564
  </dl>
@@ -4149,7 +4574,7 @@ Update handle or company_name for an org
4149
4574
  <dd>
4150
4575
 
4151
4576
  ```typescript
4152
- await client.orgs.updatePublicData();
4577
+ await client.root.pingOptionallyAuthd();
4153
4578
  ```
4154
4579
 
4155
4580
  </dd>
@@ -4165,15 +4590,7 @@ await client.orgs.updatePublicData();
4165
4590
  <dl>
4166
4591
  <dd>
4167
4592
 
4168
- **request:** `Chrt.UpdateOrgPublicDataReq`
4169
-
4170
- </dd>
4171
- </dl>
4172
-
4173
- <dl>
4174
- <dd>
4175
-
4176
- **requestOptions:** `Orgs.RequestOptions`
4593
+ **requestOptions:** `Root.RequestOptions`
4177
4594
 
4178
4595
  </dd>
4179
4596
  </dl>
@@ -4184,7 +4601,7 @@ await client.orgs.updatePublicData();
4184
4601
  </dl>
4185
4602
  </details>
4186
4603
 
4187
- <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getPublicDataByOrgId</a>(orgId) -> Chrt.OrgPublicData2</code></summary>
4604
+ <details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">pingUnauthd</a>() -> unknown</code></summary>
4188
4605
  <dl>
4189
4606
  <dd>
4190
4607
 
@@ -4196,7 +4613,7 @@ await client.orgs.updatePublicData();
4196
4613
  <dl>
4197
4614
  <dd>
4198
4615
 
4199
- Get the org public data for the org from org_id
4616
+ Returns a greeting message
4200
4617
 
4201
4618
  </dd>
4202
4619
  </dl>
@@ -4212,7 +4629,7 @@ Get the org public data for the org from org_id
4212
4629
  <dd>
4213
4630
 
4214
4631
  ```typescript
4215
- await client.orgs.getPublicDataByOrgId("org_id");
4632
+ await client.root.pingUnauthd();
4216
4633
  ```
4217
4634
 
4218
4635
  </dd>
@@ -4228,15 +4645,7 @@ await client.orgs.getPublicDataByOrgId("org_id");
4228
4645
  <dl>
4229
4646
  <dd>
4230
4647
 
4231
- **orgId:** `string`
4232
-
4233
- </dd>
4234
- </dl>
4235
-
4236
- <dl>
4237
- <dd>
4238
-
4239
- **requestOptions:** `Orgs.RequestOptions`
4648
+ **requestOptions:** `Root.RequestOptions`
4240
4649
 
4241
4650
  </dd>
4242
4651
  </dl>
@@ -4247,9 +4656,7 @@ await client.orgs.getPublicDataByOrgId("org_id");
4247
4656
  </dl>
4248
4657
  </details>
4249
4658
 
4250
- ## Payments
4251
-
4252
- <details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">createCheckoutSession</a>({ ...params }) -> Chrt.CreateCheckoutSessionRes2</code></summary>
4659
+ <details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">health</a>() -> unknown</code></summary>
4253
4660
  <dl>
4254
4661
  <dd>
4255
4662
 
@@ -4261,13 +4668,7 @@ await client.orgs.getPublicDataByOrgId("org_id");
4261
4668
  <dl>
4262
4669
  <dd>
4263
4670
 
4264
- Steps:
4265
- (1) (a) Validate and decode the jwt, (b) check for an org_id
4266
- (2) Resolve the subscription_plan
4267
- (3) Check for an already-active same subscription within the org
4268
- (4) Check if the current org membership count <= subscription_plan's limit
4269
- (5) Get the customer_id
4270
- (6) Create the checkout session url
4671
+ Used for monitoring system health
4271
4672
 
4272
4673
  </dd>
4273
4674
  </dl>
@@ -4283,9 +4684,7 @@ Steps:
4283
4684
  <dd>
4284
4685
 
4285
4686
  ```typescript
4286
- await client.payments.createCheckoutSession({
4287
- price_name: "courier_ops_solo_100_month",
4288
- });
4687
+ await client.root.health();
4289
4688
  ```
4290
4689
 
4291
4690
  </dd>
@@ -4301,15 +4700,7 @@ await client.payments.createCheckoutSession({
4301
4700
  <dl>
4302
4701
  <dd>
4303
4702
 
4304
- **request:** `Chrt.CreateCheckoutSessionReq2`
4305
-
4306
- </dd>
4307
- </dl>
4308
-
4309
- <dl>
4310
- <dd>
4311
-
4312
- **requestOptions:** `Payments.RequestOptions`
4703
+ **requestOptions:** `Root.RequestOptions`
4313
4704
 
4314
4705
  </dd>
4315
4706
  </dl>
@@ -4320,10 +4711,25 @@ await client.payments.createCheckoutSession({
4320
4711
  </dl>
4321
4712
  </details>
4322
4713
 
4323
- <details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">syncStripeToClerk</a>() -> boolean</code></summary>
4714
+ <details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">failure</a>() -> unknown</code></summary>
4715
+ <dl>
4716
+ <dd>
4717
+
4718
+ #### 📝 Description
4719
+
4720
+ <dl>
4721
+ <dd>
4722
+
4324
4723
  <dl>
4325
4724
  <dd>
4326
4725
 
4726
+ Test endpoint that intentionally fails for error handling validation and monitoring purposes.
4727
+
4728
+ </dd>
4729
+ </dl>
4730
+ </dd>
4731
+ </dl>
4732
+
4327
4733
  #### 🔌 Usage
4328
4734
 
4329
4735
  <dl>
@@ -4333,7 +4739,7 @@ await client.payments.createCheckoutSession({
4333
4739
  <dd>
4334
4740
 
4335
4741
  ```typescript
4336
- await client.payments.syncStripeToClerk();
4742
+ await client.root.failure();
4337
4743
  ```
4338
4744
 
4339
4745
  </dd>
@@ -4349,7 +4755,7 @@ await client.payments.syncStripeToClerk();
4349
4755
  <dl>
4350
4756
  <dd>
4351
4757
 
4352
- **requestOptions:** `Payments.RequestOptions`
4758
+ **requestOptions:** `Root.RequestOptions`
4353
4759
 
4354
4760
  </dd>
4355
4761
  </dl>
@@ -4366,6 +4772,21 @@ await client.payments.syncStripeToClerk();
4366
4772
  <dl>
4367
4773
  <dd>
4368
4774
 
4775
+ #### 📝 Description
4776
+
4777
+ <dl>
4778
+ <dd>
4779
+
4780
+ <dl>
4781
+ <dd>
4782
+
4783
+ Retrieves public user data for the authenticated user.
4784
+
4785
+ </dd>
4786
+ </dl>
4787
+ </dd>
4788
+ </dl>
4789
+
4369
4790
  #### 🔌 Usage
4370
4791
 
4371
4792
  <dl>
@@ -4416,7 +4837,7 @@ await client.users.getPublicData();
4416
4837
  <dl>
4417
4838
  <dd>
4418
4839
 
4419
- Body: Courier Handle, Shipper Org Id from JWT
4840
+ Creates a new connection between a shipper and courier organization using the courier's handle.
4420
4841
 
4421
4842
  </dd>
4422
4843
  </dl>
@@ -4483,7 +4904,7 @@ await client.connections.connectionToCourier.create({
4483
4904
  <dl>
4484
4905
  <dd>
4485
4906
 
4486
- Add line items to a courier pay driver line item group
4907
+ Adds additional line items to an existing courier driver line item group.
4487
4908
 
4488
4909
  </dd>
4489
4910
  </dl>
@@ -4565,7 +4986,7 @@ await client.courierPayDriverLineItemGroup.addLineItems.byId("id", {
4565
4986
  <dl>
4566
4987
  <dd>
4567
4988
 
4568
- Remove line items from a courier pay driver line item group by exact match
4989
+ Removes specific line items from a courier driver line item group by exact match.
4569
4990
 
4570
4991
  </dd>
4571
4992
  </dl>
@@ -4633,9 +5054,9 @@ await client.courierPayDriverLineItemGroup.removeLineItems.byId("id", {
4633
5054
  </dl>
4634
5055
  </details>
4635
5056
 
4636
- ## Milestones Blurhash
5057
+ ## Milestones Images
4637
5058
 
4638
- <details><summary><code>client.milestones.blurhash.<a href="/src/api/resources/milestones/resources/blurhash/client/Client.ts">getByMetadataId</a>(milestoneS3ObjectMetadataId) -> string</code></summary>
5059
+ <details><summary><code>client.milestones.images.<a href="/src/api/resources/milestones/resources/images/client/Client.ts">uploadByMilestoneId</a>(milestoneId, { ...params }) -> boolean</code></summary>
4639
5060
  <dl>
4640
5061
  <dd>
4641
5062
 
@@ -4647,11 +5068,7 @@ await client.courierPayDriverLineItemGroup.removeLineItems.byId("id", {
4647
5068
  <dl>
4648
5069
  <dd>
4649
5070
 
4650
- Get the blurhash for a milestone image.
4651
-
4652
- This endpoint returns only the blurhash string, which is much faster
4653
- than downloading the full image. Clients can use this for showing
4654
- image placeholders while the full image loads.
5071
+ Uploads an image file to a milestone with automatic blurhash generation.
4655
5072
 
4656
5073
  </dd>
4657
5074
  </dl>
@@ -4667,7 +5084,9 @@ image placeholders while the full image loads.
4667
5084
  <dd>
4668
5085
 
4669
5086
  ```typescript
4670
- await client.milestones.blurhash.getByMetadataId("milestone_s3_object_metadata_id");
5087
+ await client.milestones.images.uploadByMilestoneId("milestone_id", {
5088
+ image: fs.createReadStream("/path/to/your/file"),
5089
+ });
4671
5090
  ```
4672
5091
 
4673
5092
  </dd>
@@ -4683,7 +5102,7 @@ await client.milestones.blurhash.getByMetadataId("milestone_s3_object_metadata_i
4683
5102
  <dl>
4684
5103
  <dd>
4685
5104
 
4686
- **milestoneS3ObjectMetadataId:** `string`
5105
+ **milestoneId:** `string`
4687
5106
 
4688
5107
  </dd>
4689
5108
  </dl>
@@ -4691,7 +5110,15 @@ await client.milestones.blurhash.getByMetadataId("milestone_s3_object_metadata_i
4691
5110
  <dl>
4692
5111
  <dd>
4693
5112
 
4694
- **requestOptions:** `Blurhash.RequestOptions`
5113
+ **request:** `Chrt.milestones.BodyPostMilestonesUploadImageOortMilestonesImagesUploadMilestoneIdPost`
5114
+
5115
+ </dd>
5116
+ </dl>
5117
+
5118
+ <dl>
5119
+ <dd>
5120
+
5121
+ **requestOptions:** `Images.RequestOptions`
4695
5122
 
4696
5123
  </dd>
4697
5124
  </dl>
@@ -4702,8 +5129,6 @@ await client.milestones.blurhash.getByMetadataId("milestone_s3_object_metadata_i
4702
5129
  </dl>
4703
5130
  </details>
4704
5131
 
4705
- ## Milestones Images
4706
-
4707
5132
  <details><summary><code>client.milestones.images.<a href="/src/api/resources/milestones/resources/images/client/Client.ts">deleteByMetadataId</a>(milestoneS3ObjectMetadataId) -> boolean</code></summary>
4708
5133
  <dl>
4709
5134
  <dd>
@@ -4716,7 +5141,7 @@ await client.milestones.blurhash.getByMetadataId("milestone_s3_object_metadata_i
4716
5141
  <dl>
4717
5142
  <dd>
4718
5143
 
4719
- Delete an image from a milestone using the MilestoneS3ObjectMetadata1 id
5144
+ Deletes a milestone image from both S3 storage and database metadata.
4720
5145
 
4721
5146
  </dd>
4722
5147
  </dl>
@@ -4767,7 +5192,7 @@ await client.milestones.images.deleteByMetadataId("milestone_s3_object_metadata_
4767
5192
  </dl>
4768
5193
  </details>
4769
5194
 
4770
- <details><summary><code>client.milestones.images.<a href="/src/api/resources/milestones/resources/images/client/Client.ts">uploadByMilestoneId</a>(milestoneId, { ...params }) -> boolean</code></summary>
5195
+ <details><summary><code>client.milestones.images.<a href="/src/api/resources/milestones/resources/images/client/Client.ts">getByMetadataId</a>(milestoneS3ObjectMetadataId) -> unknown</code></summary>
4771
5196
  <dl>
4772
5197
  <dd>
4773
5198
 
@@ -4779,7 +5204,7 @@ await client.milestones.images.deleteByMetadataId("milestone_s3_object_metadata_
4779
5204
  <dl>
4780
5205
  <dd>
4781
5206
 
4782
- Upload an image file to a milestone
5207
+ Streams a milestone image file from S3 storage.
4783
5208
 
4784
5209
  </dd>
4785
5210
  </dl>
@@ -4795,9 +5220,7 @@ Upload an image file to a milestone
4795
5220
  <dd>
4796
5221
 
4797
5222
  ```typescript
4798
- await client.milestones.images.uploadByMilestoneId("milestone_id", {
4799
- image: fs.createReadStream("/path/to/your/file"),
4800
- });
5223
+ await client.milestones.images.getByMetadataId("milestone_s3_object_metadata_id");
4801
5224
  ```
4802
5225
 
4803
5226
  </dd>
@@ -4813,15 +5236,7 @@ await client.milestones.images.uploadByMilestoneId("milestone_id", {
4813
5236
  <dl>
4814
5237
  <dd>
4815
5238
 
4816
- **milestoneId:** `string`
4817
-
4818
- </dd>
4819
- </dl>
4820
-
4821
- <dl>
4822
- <dd>
4823
-
4824
- **request:** `Chrt.milestones.BodyPostMilestonesUploadImageOortMilestonesImagesUploadMilestoneIdPost`
5239
+ **milestoneS3ObjectMetadataId:** `string`
4825
5240
 
4826
5241
  </dd>
4827
5242
  </dl>
@@ -4840,7 +5255,9 @@ await client.milestones.images.uploadByMilestoneId("milestone_id", {
4840
5255
  </dl>
4841
5256
  </details>
4842
5257
 
4843
- <details><summary><code>client.milestones.images.<a href="/src/api/resources/milestones/resources/images/client/Client.ts">getByMetadataId</a>(milestoneS3ObjectMetadataId) -> unknown</code></summary>
5258
+ ## Milestones Blurhash
5259
+
5260
+ <details><summary><code>client.milestones.blurhash.<a href="/src/api/resources/milestones/resources/blurhash/client/Client.ts">getByMetadataId</a>(milestoneS3ObjectMetadataId) -> string</code></summary>
4844
5261
  <dl>
4845
5262
  <dd>
4846
5263
 
@@ -4852,7 +5269,7 @@ await client.milestones.images.uploadByMilestoneId("milestone_id", {
4852
5269
  <dl>
4853
5270
  <dd>
4854
5271
 
4855
- Get an image file from a milestone as a streaming response
5272
+ Retrieves the blurhash string for a milestone image for fast placeholder loading.
4856
5273
 
4857
5274
  </dd>
4858
5275
  </dl>
@@ -4868,7 +5285,7 @@ Get an image file from a milestone as a streaming response
4868
5285
  <dd>
4869
5286
 
4870
5287
  ```typescript
4871
- await client.milestones.images.getByMetadataId("milestone_s3_object_metadata_id");
5288
+ await client.milestones.blurhash.getByMetadataId("milestone_s3_object_metadata_id");
4872
5289
  ```
4873
5290
 
4874
5291
  </dd>
@@ -4892,7 +5309,7 @@ await client.milestones.images.getByMetadataId("milestone_s3_object_metadata_id"
4892
5309
  <dl>
4893
5310
  <dd>
4894
5311
 
4895
- **requestOptions:** `Images.RequestOptions`
5312
+ **requestOptions:** `Blurhash.RequestOptions`
4896
5313
 
4897
5314
  </dd>
4898
5315
  </dl>
@@ -4903,9 +5320,9 @@ await client.milestones.images.getByMetadataId("milestone_s3_object_metadata_id"
4903
5320
  </dl>
4904
5321
  </details>
4905
5322
 
4906
- ## Notifications CourierPreferences
5323
+ ## Notifications Shipper
4907
5324
 
4908
- <details><summary><code>client.notifications.courierPreferences.<a href="/src/api/resources/notifications/resources/courierPreferences/client/Client.ts">get</a>() -> Chrt.CourierNotificationPreferences1</code></summary>
5325
+ <details><summary><code>client.notifications.shipper.<a href="/src/api/resources/notifications/resources/shipper/client/Client.ts">getPreferences</a>() -> Chrt.ShipperNotificationPreferences1</code></summary>
4909
5326
  <dl>
4910
5327
  <dd>
4911
5328
 
@@ -4917,7 +5334,7 @@ await client.milestones.images.getByMetadataId("milestone_s3_object_metadata_id"
4917
5334
  <dl>
4918
5335
  <dd>
4919
5336
 
4920
- Get notification preferences by org id from jwt
5337
+ Retrieves notification preferences for the authenticated shipper organization.
4921
5338
 
4922
5339
  </dd>
4923
5340
  </dl>
@@ -4933,7 +5350,7 @@ Get notification preferences by org id from jwt
4933
5350
  <dd>
4934
5351
 
4935
5352
  ```typescript
4936
- await client.notifications.courierPreferences.get();
5353
+ await client.notifications.shipper.getPreferences();
4937
5354
  ```
4938
5355
 
4939
5356
  </dd>
@@ -4949,7 +5366,7 @@ await client.notifications.courierPreferences.get();
4949
5366
  <dl>
4950
5367
  <dd>
4951
5368
 
4952
- **requestOptions:** `CourierPreferences.RequestOptions`
5369
+ **requestOptions:** `Shipper.RequestOptions`
4953
5370
 
4954
5371
  </dd>
4955
5372
  </dl>
@@ -4960,7 +5377,7 @@ await client.notifications.courierPreferences.get();
4960
5377
  </dl>
4961
5378
  </details>
4962
5379
 
4963
- <details><summary><code>client.notifications.courierPreferences.<a href="/src/api/resources/notifications/resources/courierPreferences/client/Client.ts">upsert</a>({ ...params }) -> string</code></summary>
5380
+ <details><summary><code>client.notifications.shipper.<a href="/src/api/resources/notifications/resources/shipper/client/Client.ts">upsertPreferences</a>({ ...params }) -> string</code></summary>
4964
5381
  <dl>
4965
5382
  <dd>
4966
5383
 
@@ -4972,7 +5389,7 @@ await client.notifications.courierPreferences.get();
4972
5389
  <dl>
4973
5390
  <dd>
4974
5391
 
4975
- Upsert notification preferences for org in jwt
5392
+ Creates or updates notification preferences for the authenticated shipper organization.
4976
5393
 
4977
5394
  </dd>
4978
5395
  </dl>
@@ -4988,7 +5405,7 @@ Upsert notification preferences for org in jwt
4988
5405
  <dd>
4989
5406
 
4990
5407
  ```typescript
4991
- await client.notifications.courierPreferences.upsert({
5408
+ await client.notifications.shipper.upsertPreferences({
4992
5409
  schema_version: 1,
4993
5410
  });
4994
5411
  ```
@@ -5006,7 +5423,7 @@ await client.notifications.courierPreferences.upsert({
5006
5423
  <dl>
5007
5424
  <dd>
5008
5425
 
5009
- **request:** `Chrt.notifications.CourierNotificationPreferencesClientCreate1`
5426
+ **request:** `Chrt.notifications.ShipperNotificationPreferencesClientCreate1`
5010
5427
 
5011
5428
  </dd>
5012
5429
  </dl>
@@ -5014,7 +5431,7 @@ await client.notifications.courierPreferences.upsert({
5014
5431
  <dl>
5015
5432
  <dd>
5016
5433
 
5017
- **requestOptions:** `CourierPreferences.RequestOptions`
5434
+ **requestOptions:** `Shipper.RequestOptions`
5018
5435
 
5019
5436
  </dd>
5020
5437
  </dl>
@@ -5025,9 +5442,9 @@ await client.notifications.courierPreferences.upsert({
5025
5442
  </dl>
5026
5443
  </details>
5027
5444
 
5028
- ## Notifications Shipper
5445
+ ## Notifications CourierPreferences
5029
5446
 
5030
- <details><summary><code>client.notifications.shipper.<a href="/src/api/resources/notifications/resources/shipper/client/Client.ts">getPreferences</a>() -> Chrt.ShipperNotificationPreferences1</code></summary>
5447
+ <details><summary><code>client.notifications.courierPreferences.<a href="/src/api/resources/notifications/resources/courierPreferences/client/Client.ts">get</a>() -> Chrt.CourierNotificationPreferences1</code></summary>
5031
5448
  <dl>
5032
5449
  <dd>
5033
5450
 
@@ -5039,7 +5456,7 @@ await client.notifications.courierPreferences.upsert({
5039
5456
  <dl>
5040
5457
  <dd>
5041
5458
 
5042
- Get notification preferences by org id from jwt
5459
+ Retrieves notification preferences for the authenticated courier organization.
5043
5460
 
5044
5461
  </dd>
5045
5462
  </dl>
@@ -5055,7 +5472,7 @@ Get notification preferences by org id from jwt
5055
5472
  <dd>
5056
5473
 
5057
5474
  ```typescript
5058
- await client.notifications.shipper.getPreferences();
5475
+ await client.notifications.courierPreferences.get();
5059
5476
  ```
5060
5477
 
5061
5478
  </dd>
@@ -5071,7 +5488,7 @@ await client.notifications.shipper.getPreferences();
5071
5488
  <dl>
5072
5489
  <dd>
5073
5490
 
5074
- **requestOptions:** `Shipper.RequestOptions`
5491
+ **requestOptions:** `CourierPreferences.RequestOptions`
5075
5492
 
5076
5493
  </dd>
5077
5494
  </dl>
@@ -5082,7 +5499,7 @@ await client.notifications.shipper.getPreferences();
5082
5499
  </dl>
5083
5500
  </details>
5084
5501
 
5085
- <details><summary><code>client.notifications.shipper.<a href="/src/api/resources/notifications/resources/shipper/client/Client.ts">upsertPreferences</a>({ ...params }) -> string</code></summary>
5502
+ <details><summary><code>client.notifications.courierPreferences.<a href="/src/api/resources/notifications/resources/courierPreferences/client/Client.ts">upsert</a>({ ...params }) -> string</code></summary>
5086
5503
  <dl>
5087
5504
  <dd>
5088
5505
 
@@ -5094,7 +5511,7 @@ await client.notifications.shipper.getPreferences();
5094
5511
  <dl>
5095
5512
  <dd>
5096
5513
 
5097
- Upsert notification preferences for org in jwt
5514
+ Creates or updates notification preferences for the authenticated courier organization.
5098
5515
 
5099
5516
  </dd>
5100
5517
  </dl>
@@ -5110,7 +5527,7 @@ Upsert notification preferences for org in jwt
5110
5527
  <dd>
5111
5528
 
5112
5529
  ```typescript
5113
- await client.notifications.shipper.upsertPreferences({
5530
+ await client.notifications.courierPreferences.upsert({
5114
5531
  schema_version: 1,
5115
5532
  });
5116
5533
  ```
@@ -5128,7 +5545,7 @@ await client.notifications.shipper.upsertPreferences({
5128
5545
  <dl>
5129
5546
  <dd>
5130
5547
 
5131
- **request:** `Chrt.notifications.ShipperNotificationPreferencesClientCreate1`
5548
+ **request:** `Chrt.notifications.CourierNotificationPreferencesClientCreate1`
5132
5549
 
5133
5550
  </dd>
5134
5551
  </dl>
@@ -5136,7 +5553,7 @@ await client.notifications.shipper.upsertPreferences({
5136
5553
  <dl>
5137
5554
  <dd>
5138
5555
 
5139
- **requestOptions:** `Shipper.RequestOptions`
5556
+ **requestOptions:** `CourierPreferences.RequestOptions`
5140
5557
 
5141
5558
  </dd>
5142
5559
  </dl>
@@ -5149,7 +5566,7 @@ await client.notifications.shipper.upsertPreferences({
5149
5566
 
5150
5567
  ## Orders Full
5151
5568
 
5152
- <details><summary><code>client.orders.full.<a href="/src/api/resources/orders/resources/full/client/Client.ts">listByCourierOrgId</a>() -> Chrt.GetOrderFullRes[]</code></summary>
5569
+ <details><summary><code>client.orders.full.<a href="/src/api/resources/orders/resources/full/client/Client.ts">getByOrderIdOrShortId</a>(orderIdOrShortId) -> Chrt.GetOrderFullRes</code></summary>
5153
5570
  <dl>
5154
5571
  <dd>
5155
5572
 
@@ -5161,7 +5578,7 @@ await client.notifications.shipper.upsertPreferences({
5161
5578
  <dl>
5162
5579
  <dd>
5163
5580
 
5164
- Uses the org_id from the JWT
5581
+ Retrieves an order with all related task groups, tasks, milestones, and cargo information.
5165
5582
 
5166
5583
  </dd>
5167
5584
  </dl>
@@ -5177,7 +5594,7 @@ Uses the org_id from the JWT
5177
5594
  <dd>
5178
5595
 
5179
5596
  ```typescript
5180
- await client.orders.full.listByCourierOrgId();
5597
+ await client.orders.full.getByOrderIdOrShortId("order_id_or_short_id");
5181
5598
  ```
5182
5599
 
5183
5600
  </dd>
@@ -5193,6 +5610,14 @@ await client.orders.full.listByCourierOrgId();
5193
5610
  <dl>
5194
5611
  <dd>
5195
5612
 
5613
+ **orderIdOrShortId:** `string`
5614
+
5615
+ </dd>
5616
+ </dl>
5617
+
5618
+ <dl>
5619
+ <dd>
5620
+
5196
5621
  **requestOptions:** `Full.RequestOptions`
5197
5622
 
5198
5623
  </dd>
@@ -5216,7 +5641,7 @@ await client.orders.full.listByCourierOrgId();
5216
5641
  <dl>
5217
5642
  <dd>
5218
5643
 
5219
- Uses the org_id from the JWT
5644
+ Lists all orders for the authenticated shipper organization with complete task groups, tasks, milestones, and cargo details.
5220
5645
 
5221
5646
  </dd>
5222
5647
  </dl>
@@ -5259,7 +5684,7 @@ await client.orders.full.listByShipperOrgId();
5259
5684
  </dl>
5260
5685
  </details>
5261
5686
 
5262
- <details><summary><code>client.orders.full.<a href="/src/api/resources/orders/resources/full/client/Client.ts">getByOrderIdOrShortId</a>(orderIdOrShortId) -> Chrt.GetOrderFullRes</code></summary>
5687
+ <details><summary><code>client.orders.full.<a href="/src/api/resources/orders/resources/full/client/Client.ts">listByCourierOrgId</a>() -> Chrt.GetOrderFullRes[]</code></summary>
5263
5688
  <dl>
5264
5689
  <dd>
5265
5690
 
@@ -5271,7 +5696,7 @@ await client.orders.full.listByShipperOrgId();
5271
5696
  <dl>
5272
5697
  <dd>
5273
5698
 
5274
- Accepts both order_id and order_short_id values and returns the Order with all its Task Groups, Tasks, Milestones, and Cargos
5699
+ Lists all orders assigned to the authenticated courier organization with complete task groups, tasks, milestones, and cargo details.
5275
5700
 
5276
5701
  </dd>
5277
5702
  </dl>
@@ -5287,7 +5712,7 @@ Accepts both order_id and order_short_id values and returns the Order with all i
5287
5712
  <dd>
5288
5713
 
5289
5714
  ```typescript
5290
- await client.orders.full.getByOrderIdOrShortId("order_id_or_short_id");
5715
+ await client.orders.full.listByCourierOrgId();
5291
5716
  ```
5292
5717
 
5293
5718
  </dd>
@@ -5303,14 +5728,6 @@ await client.orders.full.getByOrderIdOrShortId("order_id_or_short_id");
5303
5728
  <dl>
5304
5729
  <dd>
5305
5730
 
5306
- **orderIdOrShortId:** `string`
5307
-
5308
- </dd>
5309
- </dl>
5310
-
5311
- <dl>
5312
- <dd>
5313
-
5314
5731
  **requestOptions:** `Full.RequestOptions`
5315
5732
 
5316
5733
  </dd>
@@ -5322,9 +5739,9 @@ await client.orders.full.getByOrderIdOrShortId("order_id_or_short_id");
5322
5739
  </dl>
5323
5740
  </details>
5324
5741
 
5325
- ## OrgConnectionInfos Courier
5742
+ ## OrgConnectionInfos Shipper
5326
5743
 
5327
- <details><summary><code>client.orgConnectionInfos.courier.<a href="/src/api/resources/orgConnectionInfos/resources/courier/client/Client.ts">get</a>() -> Chrt.CourierOrgConnectionInfo1</code></summary>
5744
+ <details><summary><code>client.orgConnectionInfos.shipper.<a href="/src/api/resources/orgConnectionInfos/resources/shipper/client/Client.ts">get</a>() -> Chrt.ShipperOrgConnectionInfo1</code></summary>
5328
5745
  <dl>
5329
5746
  <dd>
5330
5747
 
@@ -5336,7 +5753,7 @@ await client.orders.full.getByOrderIdOrShortId("order_id_or_short_id");
5336
5753
  <dl>
5337
5754
  <dd>
5338
5755
 
5339
- Gets the courier org info for the authenticated user
5756
+ Retrieves shipper organization connection information for the authenticated organization.
5340
5757
 
5341
5758
  </dd>
5342
5759
  </dl>
@@ -5352,7 +5769,7 @@ Gets the courier org info for the authenticated user
5352
5769
  <dd>
5353
5770
 
5354
5771
  ```typescript
5355
- await client.orgConnectionInfos.courier.get();
5772
+ await client.orgConnectionInfos.shipper.get();
5356
5773
  ```
5357
5774
 
5358
5775
  </dd>
@@ -5368,7 +5785,7 @@ await client.orgConnectionInfos.courier.get();
5368
5785
  <dl>
5369
5786
  <dd>
5370
5787
 
5371
- **requestOptions:** `Courier.RequestOptions`
5788
+ **requestOptions:** `Shipper.RequestOptions`
5372
5789
 
5373
5790
  </dd>
5374
5791
  </dl>
@@ -5379,7 +5796,7 @@ await client.orgConnectionInfos.courier.get();
5379
5796
  </dl>
5380
5797
  </details>
5381
5798
 
5382
- <details><summary><code>client.orgConnectionInfos.courier.<a href="/src/api/resources/orgConnectionInfos/resources/courier/client/Client.ts">create</a>({ ...params }) -> string</code></summary>
5799
+ <details><summary><code>client.orgConnectionInfos.shipper.<a href="/src/api/resources/orgConnectionInfos/resources/shipper/client/Client.ts">create</a>({ ...params }) -> string</code></summary>
5383
5800
  <dl>
5384
5801
  <dd>
5385
5802
 
@@ -5391,7 +5808,7 @@ await client.orgConnectionInfos.courier.get();
5391
5808
  <dl>
5392
5809
  <dd>
5393
5810
 
5394
- Create a new courier org info. Fails if one already exists.
5811
+ Creates shipper organization connection information. Fails if already exists.
5395
5812
 
5396
5813
  </dd>
5397
5814
  </dl>
@@ -5407,9 +5824,9 @@ Create a new courier org info. Fails if one already exists.
5407
5824
  <dd>
5408
5825
 
5409
5826
  ```typescript
5410
- await client.orgConnectionInfos.courier.create({
5411
- email_address_primary: "email_address_primary",
5827
+ await client.orgConnectionInfos.shipper.create({
5412
5828
  schema_version: 1,
5829
+ email_address_primary: "email_address_primary",
5413
5830
  });
5414
5831
  ```
5415
5832
 
@@ -5426,7 +5843,7 @@ await client.orgConnectionInfos.courier.create({
5426
5843
  <dl>
5427
5844
  <dd>
5428
5845
 
5429
- **request:** `Chrt.orgConnectionInfos.CourierOrgConnectionInfoClientCreate1`
5846
+ **request:** `Chrt.orgConnectionInfos.ShipperOrgConnectionInfoClientCreate1`
5430
5847
 
5431
5848
  </dd>
5432
5849
  </dl>
@@ -5434,7 +5851,7 @@ await client.orgConnectionInfos.courier.create({
5434
5851
  <dl>
5435
5852
  <dd>
5436
5853
 
5437
- **requestOptions:** `Courier.RequestOptions`
5854
+ **requestOptions:** `Shipper.RequestOptions`
5438
5855
 
5439
5856
  </dd>
5440
5857
  </dl>
@@ -5445,7 +5862,7 @@ await client.orgConnectionInfos.courier.create({
5445
5862
  </dl>
5446
5863
  </details>
5447
5864
 
5448
- <details><summary><code>client.orgConnectionInfos.courier.<a href="/src/api/resources/orgConnectionInfos/resources/courier/client/Client.ts">update</a>({ ...params }) -> boolean</code></summary>
5865
+ <details><summary><code>client.orgConnectionInfos.shipper.<a href="/src/api/resources/orgConnectionInfos/resources/shipper/client/Client.ts">update</a>({ ...params }) -> boolean</code></summary>
5449
5866
  <dl>
5450
5867
  <dd>
5451
5868
 
@@ -5457,7 +5874,7 @@ await client.orgConnectionInfos.courier.create({
5457
5874
  <dl>
5458
5875
  <dd>
5459
5876
 
5460
- Update existing courier org info. Can update one or more fields.
5877
+ Updates existing shipper organization connection information.
5461
5878
 
5462
5879
  </dd>
5463
5880
  </dl>
@@ -5473,7 +5890,7 @@ Update existing courier org info. Can update one or more fields.
5473
5890
  <dd>
5474
5891
 
5475
5892
  ```typescript
5476
- await client.orgConnectionInfos.courier.update();
5893
+ await client.orgConnectionInfos.shipper.update();
5477
5894
  ```
5478
5895
 
5479
5896
  </dd>
@@ -5489,7 +5906,7 @@ await client.orgConnectionInfos.courier.update();
5489
5906
  <dl>
5490
5907
  <dd>
5491
5908
 
5492
- **request:** `Chrt.orgConnectionInfos.CourierOrgConnectionInfoClientUpdate1`
5909
+ **request:** `Chrt.orgConnectionInfos.ShipperOrgConnectionInfoClientUpdate1`
5493
5910
 
5494
5911
  </dd>
5495
5912
  </dl>
@@ -5497,7 +5914,7 @@ await client.orgConnectionInfos.courier.update();
5497
5914
  <dl>
5498
5915
  <dd>
5499
5916
 
5500
- **requestOptions:** `Courier.RequestOptions`
5917
+ **requestOptions:** `Shipper.RequestOptions`
5501
5918
 
5502
5919
  </dd>
5503
5920
  </dl>
@@ -5508,9 +5925,9 @@ await client.orgConnectionInfos.courier.update();
5508
5925
  </dl>
5509
5926
  </details>
5510
5927
 
5511
- ## OrgConnectionInfos Shipper
5928
+ ## OrgConnectionInfos Courier
5512
5929
 
5513
- <details><summary><code>client.orgConnectionInfos.shipper.<a href="/src/api/resources/orgConnectionInfos/resources/shipper/client/Client.ts">get</a>() -> Chrt.ShipperOrgConnectionInfo1</code></summary>
5930
+ <details><summary><code>client.orgConnectionInfos.courier.<a href="/src/api/resources/orgConnectionInfos/resources/courier/client/Client.ts">get</a>() -> Chrt.CourierOrgConnectionInfo1</code></summary>
5514
5931
  <dl>
5515
5932
  <dd>
5516
5933
 
@@ -5522,7 +5939,7 @@ await client.orgConnectionInfos.courier.update();
5522
5939
  <dl>
5523
5940
  <dd>
5524
5941
 
5525
- Gets the shipper org info for the authenticated user
5942
+ Retrieves courier organization connection information for the authenticated organization.
5526
5943
 
5527
5944
  </dd>
5528
5945
  </dl>
@@ -5538,7 +5955,7 @@ Gets the shipper org info for the authenticated user
5538
5955
  <dd>
5539
5956
 
5540
5957
  ```typescript
5541
- await client.orgConnectionInfos.shipper.get();
5958
+ await client.orgConnectionInfos.courier.get();
5542
5959
  ```
5543
5960
 
5544
5961
  </dd>
@@ -5554,7 +5971,7 @@ await client.orgConnectionInfos.shipper.get();
5554
5971
  <dl>
5555
5972
  <dd>
5556
5973
 
5557
- **requestOptions:** `Shipper.RequestOptions`
5974
+ **requestOptions:** `Courier.RequestOptions`
5558
5975
 
5559
5976
  </dd>
5560
5977
  </dl>
@@ -5565,7 +5982,7 @@ await client.orgConnectionInfos.shipper.get();
5565
5982
  </dl>
5566
5983
  </details>
5567
5984
 
5568
- <details><summary><code>client.orgConnectionInfos.shipper.<a href="/src/api/resources/orgConnectionInfos/resources/shipper/client/Client.ts">create</a>({ ...params }) -> string</code></summary>
5985
+ <details><summary><code>client.orgConnectionInfos.courier.<a href="/src/api/resources/orgConnectionInfos/resources/courier/client/Client.ts">create</a>({ ...params }) -> string</code></summary>
5569
5986
  <dl>
5570
5987
  <dd>
5571
5988
 
@@ -5577,7 +5994,7 @@ await client.orgConnectionInfos.shipper.get();
5577
5994
  <dl>
5578
5995
  <dd>
5579
5996
 
5580
- Create a new shipper org info. Fails if one already exists.
5997
+ Creates courier organization connection information. Fails if already exists.
5581
5998
 
5582
5999
  </dd>
5583
6000
  </dl>
@@ -5593,9 +6010,9 @@ Create a new shipper org info. Fails if one already exists.
5593
6010
  <dd>
5594
6011
 
5595
6012
  ```typescript
5596
- await client.orgConnectionInfos.shipper.create({
5597
- email_address_primary: "email_address_primary",
6013
+ await client.orgConnectionInfos.courier.create({
5598
6014
  schema_version: 1,
6015
+ email_address_primary: "email_address_primary",
5599
6016
  });
5600
6017
  ```
5601
6018
 
@@ -5612,7 +6029,7 @@ await client.orgConnectionInfos.shipper.create({
5612
6029
  <dl>
5613
6030
  <dd>
5614
6031
 
5615
- **request:** `Chrt.orgConnectionInfos.ShipperOrgConnectionInfoClientCreate1`
6032
+ **request:** `Chrt.orgConnectionInfos.CourierOrgConnectionInfoClientCreate1`
5616
6033
 
5617
6034
  </dd>
5618
6035
  </dl>
@@ -5620,7 +6037,7 @@ await client.orgConnectionInfos.shipper.create({
5620
6037
  <dl>
5621
6038
  <dd>
5622
6039
 
5623
- **requestOptions:** `Shipper.RequestOptions`
6040
+ **requestOptions:** `Courier.RequestOptions`
5624
6041
 
5625
6042
  </dd>
5626
6043
  </dl>
@@ -5631,7 +6048,7 @@ await client.orgConnectionInfos.shipper.create({
5631
6048
  </dl>
5632
6049
  </details>
5633
6050
 
5634
- <details><summary><code>client.orgConnectionInfos.shipper.<a href="/src/api/resources/orgConnectionInfos/resources/shipper/client/Client.ts">update</a>({ ...params }) -> boolean</code></summary>
6051
+ <details><summary><code>client.orgConnectionInfos.courier.<a href="/src/api/resources/orgConnectionInfos/resources/courier/client/Client.ts">update</a>({ ...params }) -> boolean</code></summary>
5635
6052
  <dl>
5636
6053
  <dd>
5637
6054
 
@@ -5643,7 +6060,7 @@ await client.orgConnectionInfos.shipper.create({
5643
6060
  <dl>
5644
6061
  <dd>
5645
6062
 
5646
- Update existing shipper org info. Can update one or more fields.
6063
+ Updates existing courier organization connection information.
5647
6064
 
5648
6065
  </dd>
5649
6066
  </dl>
@@ -5659,7 +6076,7 @@ Update existing shipper org info. Can update one or more fields.
5659
6076
  <dd>
5660
6077
 
5661
6078
  ```typescript
5662
- await client.orgConnectionInfos.shipper.update();
6079
+ await client.orgConnectionInfos.courier.update();
5663
6080
  ```
5664
6081
 
5665
6082
  </dd>
@@ -5675,7 +6092,7 @@ await client.orgConnectionInfos.shipper.update();
5675
6092
  <dl>
5676
6093
  <dd>
5677
6094
 
5678
- **request:** `Chrt.orgConnectionInfos.ShipperOrgConnectionInfoClientUpdate1`
6095
+ **request:** `Chrt.orgConnectionInfos.CourierOrgConnectionInfoClientUpdate1`
5679
6096
 
5680
6097
  </dd>
5681
6098
  </dl>
@@ -5683,7 +6100,7 @@ await client.orgConnectionInfos.shipper.update();
5683
6100
  <dl>
5684
6101
  <dd>
5685
6102
 
5686
- **requestOptions:** `Shipper.RequestOptions`
6103
+ **requestOptions:** `Courier.RequestOptions`
5687
6104
 
5688
6105
  </dd>
5689
6106
  </dl>
@@ -5708,7 +6125,7 @@ await client.orgConnectionInfos.shipper.update();
5708
6125
  <dl>
5709
6126
  <dd>
5710
6127
 
5711
- Uses the org_id from the JWT - returns multiple task groups with their tasks, milestones, and cargos
6128
+ Lists all task groups for the authenticated courier organization with complete tasks, milestones, and cargo details.
5712
6129
 
5713
6130
  </dd>
5714
6131
  </dl>
@@ -5763,7 +6180,7 @@ await client.taskGroups.full.listByCourierOrgId();
5763
6180
  <dl>
5764
6181
  <dd>
5765
6182
 
5766
- Returns a single task group and its tasks, milestones, and cargos
6183
+ Retrieves a specific task group with complete tasks, milestones, and cargo information.
5767
6184
 
5768
6185
  </dd>
5769
6186
  </dl>
@@ -5820,6 +6237,21 @@ await client.taskGroups.full.getByTaskGroupId("id");
5820
6237
  <dl>
5821
6238
  <dd>
5822
6239
 
6240
+ #### 📝 Description
6241
+
6242
+ <dl>
6243
+ <dd>
6244
+
6245
+ <dl>
6246
+ <dd>
6247
+
6248
+ Toggles the pause status of an in-progress task group.
6249
+
6250
+ </dd>
6251
+ </dl>
6252
+ </dd>
6253
+ </dl>
6254
+
5823
6255
  #### 🔌 Usage
5824
6256
 
5825
6257
  <dl>
@@ -5830,8 +6262,8 @@ await client.taskGroups.full.getByTaskGroupId("id");
5830
6262
 
5831
6263
  ```typescript
5832
6264
  await client.taskGroups.togglePause.byId("id", {
5833
- paused: true,
5834
6265
  task_group_id: "task_group_id",
6266
+ paused: true,
5835
6267
  });
5836
6268
  ```
5837
6269