@chrt-inc/typescript-sdk 1.363.0 → 1.378.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (300) hide show
  1. package/dist/cjs/Client.d.ts +6 -6
  2. package/dist/cjs/Client.js +36 -36
  3. package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/Client.d.ts +1 -1
  4. package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/Client.js +1 -1
  5. package/dist/cjs/api/resources/directoryEntries/client/Client.d.ts +99 -0
  6. package/dist/cjs/api/resources/directoryEntries/client/Client.js +364 -0
  7. package/dist/cjs/api/{types/ShipperContactClientCreate1.d.ts → resources/directoryEntries/client/requests/DirectoryEntryClientCreate1.d.ts} +11 -7
  8. package/dist/cjs/api/resources/{shipperContactInfo/client/requests/ShipperContactClientUpdate1.d.ts → directoryEntries/client/requests/DirectoryEntryClientUpdate1.d.ts} +2 -2
  9. package/dist/cjs/api/resources/directoryEntries/client/requests/index.d.ts +2 -0
  10. package/dist/cjs/api/resources/drivers/client/Client.d.ts +3 -3
  11. package/dist/cjs/api/resources/index.d.ts +3 -4
  12. package/dist/cjs/api/resources/index.js +4 -5
  13. package/dist/cjs/api/resources/notifications/client/Client.d.ts +12 -41
  14. package/dist/cjs/api/resources/notifications/client/Client.js +16 -169
  15. package/dist/cjs/api/resources/notifications/client/index.d.ts +0 -1
  16. package/dist/cjs/api/resources/notifications/client/index.js +0 -15
  17. package/dist/cjs/api/resources/notifications/index.d.ts +1 -0
  18. package/dist/cjs/api/resources/notifications/index.js +1 -0
  19. package/dist/cjs/api/resources/notifications/resources/adHoc/client/Client.d.ts +77 -0
  20. package/dist/cjs/api/resources/notifications/resources/adHoc/client/Client.js +252 -0
  21. package/dist/cjs/api/resources/notifications/resources/adHoc/client/index.d.ts +2 -0
  22. package/dist/cjs/api/resources/notifications/resources/adHoc/client/index.js +17 -0
  23. package/dist/cjs/api/resources/notifications/resources/adHoc/client/requests/NotificationIntentAdHocClientCreate1.d.ts +18 -0
  24. package/dist/cjs/api/resources/notifications/resources/adHoc/client/requests/index.d.ts +1 -0
  25. package/dist/cjs/api/resources/notifications/resources/adHoc/index.d.ts +1 -0
  26. package/dist/cjs/api/resources/notifications/resources/adHoc/index.js +17 -0
  27. package/dist/cjs/api/resources/notifications/resources/groups/client/Client.d.ts +209 -0
  28. package/dist/cjs/api/resources/{shipperContactInfo → notifications/resources/groups}/client/Client.js +305 -118
  29. package/dist/cjs/api/resources/notifications/resources/groups/client/index.d.ts +2 -0
  30. package/dist/cjs/api/resources/notifications/resources/groups/client/index.js +17 -0
  31. package/dist/cjs/api/resources/notifications/resources/groups/client/requests/GroupsUpdateNameV1Request.d.ts +12 -0
  32. package/dist/cjs/api/resources/notifications/resources/groups/client/requests/NotificationGroupClientCreate1.d.ts +14 -0
  33. package/dist/cjs/api/resources/notifications/resources/groups/client/requests/index.d.ts +2 -0
  34. package/dist/cjs/api/resources/notifications/resources/groups/client/requests/index.js +2 -0
  35. package/dist/cjs/api/resources/notifications/resources/groups/index.d.ts +1 -0
  36. package/dist/cjs/api/resources/notifications/resources/groups/index.js +17 -0
  37. package/dist/cjs/api/resources/notifications/resources/index.d.ts +7 -0
  38. package/dist/cjs/api/resources/notifications/resources/index.js +46 -0
  39. package/dist/cjs/api/resources/notifications/resources/userPreferences/client/Client.d.ts +67 -0
  40. package/dist/cjs/api/resources/notifications/resources/userPreferences/client/Client.js +232 -0
  41. package/dist/cjs/api/resources/notifications/resources/userPreferences/client/index.d.ts +2 -0
  42. package/dist/cjs/api/resources/notifications/resources/userPreferences/client/index.js +17 -0
  43. package/dist/cjs/api/resources/notifications/resources/userPreferences/client/requests/UserNotificationPreferencesUpdateRequest.d.ts +15 -0
  44. package/dist/cjs/api/resources/notifications/resources/userPreferences/client/requests/index.d.ts +1 -0
  45. package/dist/cjs/api/resources/notifications/resources/userPreferences/client/requests/index.js +2 -0
  46. package/dist/cjs/api/resources/notifications/resources/userPreferences/index.d.ts +1 -0
  47. package/dist/cjs/api/resources/notifications/resources/userPreferences/index.js +17 -0
  48. package/dist/cjs/api/resources/notifications/resources/webhookSetup/client/Client.d.ts +74 -0
  49. package/dist/cjs/api/resources/notifications/resources/webhookSetup/client/Client.js +271 -0
  50. package/dist/cjs/api/resources/notifications/resources/webhookSetup/client/index.js +2 -0
  51. package/dist/cjs/api/resources/notifications/resources/webhookSetup/index.d.ts +1 -0
  52. package/dist/cjs/api/resources/notifications/resources/webhookSetup/index.js +17 -0
  53. package/dist/cjs/api/types/BillingLineItemGroupMessageWebhookPayload.d.ts +13 -0
  54. package/dist/cjs/api/types/BillingLineItemGroupS3ObjectAddedWebhookPayload.d.ts +13 -0
  55. package/dist/cjs/api/types/BillingLineItemGroupS3ObjectAddedWebhookPayload.js +5 -0
  56. package/dist/cjs/api/types/BillingStatementOpenedWebhookPayload.d.ts +11 -0
  57. package/dist/cjs/api/types/BillingStatementOpenedWebhookPayload.js +5 -0
  58. package/dist/cjs/api/types/BillingStatementPaidWebhookPayload.d.ts +11 -0
  59. package/dist/cjs/api/types/BillingStatementPaidWebhookPayload.js +5 -0
  60. package/dist/cjs/api/types/{ShipperContact1.d.ts → DirectoryEntry1.d.ts} +4 -6
  61. package/dist/cjs/api/types/DirectoryEntry1.js +5 -0
  62. package/dist/cjs/api/types/{Driver1.d.ts → Driver1Input.d.ts} +1 -1
  63. package/dist/cjs/api/types/Driver1Input.js +5 -0
  64. package/dist/cjs/api/types/Driver1Output.d.ts +27 -0
  65. package/dist/cjs/api/types/Driver1Output.js +5 -0
  66. package/dist/cjs/api/types/NotificationChannelsEnum.d.ts +12 -0
  67. package/dist/cjs/api/types/NotificationChannelsEnum.js +11 -0
  68. package/dist/cjs/api/types/NotificationEventsForAdHocEnum.d.ts +14 -0
  69. package/dist/cjs/api/types/NotificationEventsForAdHocEnum.js +10 -0
  70. package/dist/cjs/api/types/NotificationEventsForOrgsEnum.d.ts +29 -0
  71. package/dist/cjs/api/types/NotificationEventsForOrgsEnum.js +26 -0
  72. package/dist/cjs/api/types/NotificationEventsForUsersEnum.d.ts +20 -0
  73. package/dist/cjs/api/types/NotificationEventsForUsersEnum.js +15 -0
  74. package/dist/cjs/api/types/NotificationGroup1.d.ts +18 -0
  75. package/dist/cjs/api/types/NotificationGroup1.js +5 -0
  76. package/dist/cjs/api/types/NotificationGroupLimitedForDriver1.d.ts +23 -0
  77. package/dist/cjs/api/types/NotificationGroupLimitedForDriver1.js +5 -0
  78. package/dist/cjs/api/types/NotificationIntentAdHoc1.d.ts +18 -0
  79. package/dist/cjs/api/types/NotificationIntentAdHoc1.js +5 -0
  80. package/dist/cjs/api/types/NotificationUserPreferences1.d.ts +15 -0
  81. package/dist/cjs/api/types/NotificationUserPreferences1.js +5 -0
  82. package/dist/cjs/api/types/OrderAndTaskGroupExpandedReq.d.ts +1 -1
  83. package/dist/cjs/api/types/OrgMembersAndDrivers.d.ts +1 -1
  84. package/dist/cjs/api/types/OrgPrivateData1.d.ts +2 -0
  85. package/dist/cjs/api/types/ShippingOrderCancelledWebhookPayload.d.ts +11 -0
  86. package/dist/cjs/api/types/ShippingOrderCancelledWebhookPayload.js +5 -0
  87. package/dist/cjs/api/types/ShippingOrderCompletedWebhookPayload.d.ts +11 -0
  88. package/dist/cjs/api/types/ShippingOrderCompletedWebhookPayload.js +5 -0
  89. package/dist/cjs/api/types/ShippingOrderStagedWebhookPayload.d.ts +11 -0
  90. package/dist/cjs/api/types/ShippingOrderStagedWebhookPayload.js +5 -0
  91. package/dist/cjs/api/types/ShippingTaskAddedWebhookPayload.d.ts +15 -0
  92. package/dist/cjs/api/types/ShippingTaskAddedWebhookPayload.js +5 -0
  93. package/dist/cjs/api/types/ShippingTaskCompletedWebhookPayload.d.ts +15 -0
  94. package/dist/cjs/api/types/ShippingTaskCompletedWebhookPayload.js +5 -0
  95. package/dist/cjs/api/types/ShippingTaskDeletedWebhookPayload.d.ts +14 -0
  96. package/dist/cjs/api/types/ShippingTaskDeletedWebhookPayload.js +5 -0
  97. package/dist/cjs/api/types/ShippingTaskGroupCourierOrgAssignedWebhookPayload.d.ts +14 -0
  98. package/dist/cjs/api/types/ShippingTaskGroupCourierOrgAssignedWebhookPayload.js +5 -0
  99. package/dist/cjs/api/types/ShippingTaskGroupDriverAssignedWebhookPayload.d.ts +15 -0
  100. package/dist/cjs/api/types/ShippingTaskGroupDriverAssignedWebhookPayload.js +5 -0
  101. package/dist/cjs/api/types/ShippingTaskGroupFlightInfoUpdatedWebhookPayload.d.ts +16 -0
  102. package/dist/cjs/api/types/ShippingTaskGroupFlightInfoUpdatedWebhookPayload.js +5 -0
  103. package/dist/cjs/api/types/ShippingTaskGroupInProgressWebhookPayload.d.ts +13 -0
  104. package/dist/cjs/api/types/ShippingTaskGroupInProgressWebhookPayload.js +5 -0
  105. package/dist/cjs/api/types/ShippingTaskGroupMessageWebhookPayload.d.ts +15 -0
  106. package/dist/cjs/api/types/ShippingTaskGroupMessageWebhookPayload.js +5 -0
  107. package/dist/cjs/api/types/ShippingTaskGroupS3ObjectAddedWebhookPayload.d.ts +15 -0
  108. package/dist/cjs/api/types/ShippingTaskGroupS3ObjectAddedWebhookPayload.js +5 -0
  109. package/dist/cjs/api/types/ShippingTaskGroupTasksOrderingUpdatedWebhookPayload.d.ts +14 -0
  110. package/dist/cjs/api/types/ShippingTaskGroupTasksOrderingUpdatedWebhookPayload.js +5 -0
  111. package/dist/cjs/api/types/ShippingTaskSkippedWebhookPayload.d.ts +15 -0
  112. package/dist/cjs/api/types/ShippingTaskSkippedWebhookPayload.js +5 -0
  113. package/dist/cjs/api/types/Statement1.d.ts +1 -1
  114. package/dist/cjs/api/types/{Task1.d.ts → Task1Input.d.ts} +4 -8
  115. package/dist/cjs/api/types/Task1Input.js +5 -0
  116. package/dist/cjs/api/types/Task1Output.d.ts +36 -0
  117. package/dist/cjs/api/types/Task1Output.js +5 -0
  118. package/dist/cjs/api/types/TaskClientCreate1.d.ts +1 -1
  119. package/dist/cjs/api/types/TaskClientUpdate1.d.ts +1 -1
  120. package/dist/cjs/api/types/TaskExpanded.d.ts +2 -2
  121. package/dist/cjs/api/types/TaskGroupExpanded.d.ts +1 -1
  122. package/dist/cjs/api/types/UserPublicData1.d.ts +0 -1
  123. package/dist/cjs/api/types/WebhookAppPortalAccessRes.d.ts +10 -0
  124. package/dist/cjs/api/types/WebhookAppPortalAccessRes.js +5 -0
  125. package/dist/cjs/api/types/index.d.ts +32 -6
  126. package/dist/cjs/api/types/index.js +32 -6
  127. package/dist/cjs/version.d.ts +1 -1
  128. package/dist/cjs/version.js +1 -1
  129. package/dist/esm/Client.d.mts +6 -6
  130. package/dist/esm/Client.mjs +10 -10
  131. package/dist/esm/api/resources/billing/resources/lineItemGroups/client/Client.d.mts +1 -1
  132. package/dist/esm/api/resources/billing/resources/lineItemGroups/client/Client.mjs +1 -1
  133. package/dist/esm/api/resources/directoryEntries/client/Client.d.mts +99 -0
  134. package/dist/esm/api/resources/directoryEntries/client/Client.mjs +327 -0
  135. package/dist/esm/api/{types/ShipperContactClientCreate1.d.mts → resources/directoryEntries/client/requests/DirectoryEntryClientCreate1.d.mts} +11 -7
  136. package/dist/esm/api/resources/{shipperContactInfo/client/requests/ShipperContactClientUpdate1.d.mts → directoryEntries/client/requests/DirectoryEntryClientUpdate1.d.mts} +2 -2
  137. package/dist/esm/api/resources/directoryEntries/client/requests/index.d.mts +2 -0
  138. package/dist/esm/api/resources/drivers/client/Client.d.mts +3 -3
  139. package/dist/esm/api/resources/index.d.mts +3 -4
  140. package/dist/esm/api/resources/index.mjs +3 -4
  141. package/dist/esm/api/resources/notifications/client/Client.d.mts +12 -41
  142. package/dist/esm/api/resources/notifications/client/Client.mjs +16 -136
  143. package/dist/esm/api/resources/notifications/client/index.d.mts +0 -1
  144. package/dist/esm/api/resources/notifications/client/index.mjs +1 -1
  145. package/dist/esm/api/resources/notifications/index.d.mts +1 -0
  146. package/dist/esm/api/resources/notifications/index.mjs +1 -0
  147. package/dist/esm/api/resources/notifications/resources/adHoc/client/Client.d.mts +77 -0
  148. package/dist/esm/api/resources/notifications/resources/adHoc/client/Client.mjs +215 -0
  149. package/dist/esm/api/resources/notifications/resources/adHoc/client/index.d.mts +2 -0
  150. package/dist/esm/api/resources/notifications/resources/adHoc/client/index.mjs +1 -0
  151. package/dist/esm/api/resources/notifications/resources/adHoc/client/requests/NotificationIntentAdHocClientCreate1.d.mts +18 -0
  152. package/dist/esm/api/resources/notifications/resources/adHoc/client/requests/index.d.mts +1 -0
  153. package/dist/esm/api/resources/notifications/resources/adHoc/client/requests/index.mjs +1 -0
  154. package/dist/esm/api/resources/notifications/resources/adHoc/index.d.mts +1 -0
  155. package/dist/esm/api/resources/notifications/resources/adHoc/index.mjs +1 -0
  156. package/dist/esm/api/resources/notifications/resources/groups/client/Client.d.mts +209 -0
  157. package/dist/esm/api/resources/{shipperContactInfo → notifications/resources/groups}/client/Client.mjs +303 -116
  158. package/dist/esm/api/resources/notifications/resources/groups/client/index.d.mts +2 -0
  159. package/dist/esm/api/resources/notifications/resources/groups/client/index.mjs +1 -0
  160. package/dist/esm/api/resources/notifications/resources/groups/client/requests/GroupsUpdateNameV1Request.d.mts +12 -0
  161. package/dist/esm/api/resources/notifications/resources/groups/client/requests/NotificationGroupClientCreate1.d.mts +14 -0
  162. package/dist/esm/api/resources/notifications/resources/groups/client/requests/index.d.mts +2 -0
  163. package/dist/esm/api/resources/notifications/resources/groups/client/requests/index.mjs +1 -0
  164. package/dist/esm/api/resources/notifications/resources/groups/index.d.mts +1 -0
  165. package/dist/esm/api/resources/notifications/resources/groups/index.mjs +1 -0
  166. package/dist/esm/api/resources/notifications/resources/index.d.mts +7 -0
  167. package/dist/esm/api/resources/notifications/resources/index.mjs +7 -0
  168. package/dist/esm/api/resources/notifications/resources/userPreferences/client/Client.d.mts +67 -0
  169. package/dist/esm/api/resources/notifications/resources/userPreferences/client/Client.mjs +195 -0
  170. package/dist/esm/api/resources/notifications/resources/userPreferences/client/index.d.mts +2 -0
  171. package/dist/esm/api/resources/notifications/resources/userPreferences/client/index.mjs +1 -0
  172. package/dist/esm/api/resources/notifications/resources/userPreferences/client/requests/UserNotificationPreferencesUpdateRequest.d.mts +15 -0
  173. package/dist/esm/api/resources/notifications/resources/userPreferences/client/requests/index.d.mts +1 -0
  174. package/dist/esm/api/resources/notifications/resources/userPreferences/client/requests/index.mjs +1 -0
  175. package/dist/esm/api/resources/notifications/resources/userPreferences/index.d.mts +1 -0
  176. package/dist/esm/api/resources/notifications/resources/userPreferences/index.mjs +1 -0
  177. package/dist/esm/api/resources/notifications/resources/webhookSetup/client/Client.d.mts +74 -0
  178. package/dist/esm/api/resources/notifications/resources/webhookSetup/client/Client.mjs +234 -0
  179. package/dist/esm/api/resources/notifications/resources/webhookSetup/client/index.d.mts +1 -0
  180. package/dist/esm/api/resources/notifications/resources/webhookSetup/client/index.mjs +1 -0
  181. package/dist/esm/api/resources/notifications/resources/webhookSetup/index.d.mts +1 -0
  182. package/dist/esm/api/resources/notifications/resources/webhookSetup/index.mjs +1 -0
  183. package/dist/esm/api/types/BillingLineItemGroupMessageWebhookPayload.d.mts +13 -0
  184. package/dist/esm/api/types/BillingLineItemGroupS3ObjectAddedWebhookPayload.d.mts +13 -0
  185. package/dist/esm/api/types/BillingLineItemGroupS3ObjectAddedWebhookPayload.mjs +4 -0
  186. package/dist/esm/api/types/BillingStatementOpenedWebhookPayload.d.mts +11 -0
  187. package/dist/esm/api/types/BillingStatementOpenedWebhookPayload.mjs +4 -0
  188. package/dist/esm/api/types/BillingStatementPaidWebhookPayload.d.mts +11 -0
  189. package/dist/esm/api/types/BillingStatementPaidWebhookPayload.mjs +4 -0
  190. package/dist/esm/api/types/{ShipperContact1.d.mts → DirectoryEntry1.d.mts} +4 -6
  191. package/dist/esm/api/types/DirectoryEntry1.mjs +4 -0
  192. package/dist/esm/api/types/{Driver1.d.mts → Driver1Input.d.mts} +1 -1
  193. package/dist/esm/api/types/Driver1Input.mjs +4 -0
  194. package/dist/esm/api/types/Driver1Output.d.mts +27 -0
  195. package/dist/esm/api/types/Driver1Output.mjs +4 -0
  196. package/dist/esm/api/types/NotificationChannelsEnum.d.mts +12 -0
  197. package/dist/esm/api/types/NotificationChannelsEnum.mjs +8 -0
  198. package/dist/esm/api/types/NotificationEventsForAdHocEnum.d.mts +14 -0
  199. package/dist/esm/api/types/NotificationEventsForAdHocEnum.mjs +7 -0
  200. package/dist/esm/api/types/NotificationEventsForOrgsEnum.d.mts +29 -0
  201. package/dist/esm/api/types/NotificationEventsForOrgsEnum.mjs +23 -0
  202. package/dist/esm/api/types/NotificationEventsForUsersEnum.d.mts +20 -0
  203. package/dist/esm/api/types/NotificationEventsForUsersEnum.mjs +12 -0
  204. package/dist/esm/api/types/NotificationGroup1.d.mts +18 -0
  205. package/dist/esm/api/types/NotificationGroup1.mjs +4 -0
  206. package/dist/esm/api/types/NotificationGroupLimitedForDriver1.d.mts +23 -0
  207. package/dist/esm/api/types/NotificationGroupLimitedForDriver1.mjs +4 -0
  208. package/dist/esm/api/types/NotificationIntentAdHoc1.d.mts +18 -0
  209. package/dist/esm/api/types/NotificationIntentAdHoc1.mjs +4 -0
  210. package/dist/esm/api/types/NotificationUserPreferences1.d.mts +15 -0
  211. package/dist/esm/api/types/NotificationUserPreferences1.mjs +4 -0
  212. package/dist/esm/api/types/OrderAndTaskGroupExpandedReq.d.mts +1 -1
  213. package/dist/esm/api/types/OrgMembersAndDrivers.d.mts +1 -1
  214. package/dist/esm/api/types/OrgPrivateData1.d.mts +2 -0
  215. package/dist/esm/api/types/ShippingOrderCancelledWebhookPayload.d.mts +11 -0
  216. package/dist/esm/api/types/ShippingOrderCancelledWebhookPayload.mjs +4 -0
  217. package/dist/esm/api/types/ShippingOrderCompletedWebhookPayload.d.mts +11 -0
  218. package/dist/esm/api/types/ShippingOrderCompletedWebhookPayload.mjs +4 -0
  219. package/dist/esm/api/types/ShippingOrderStagedWebhookPayload.d.mts +11 -0
  220. package/dist/esm/api/types/ShippingOrderStagedWebhookPayload.mjs +4 -0
  221. package/dist/esm/api/types/ShippingTaskAddedWebhookPayload.d.mts +15 -0
  222. package/dist/esm/api/types/ShippingTaskAddedWebhookPayload.mjs +4 -0
  223. package/dist/esm/api/types/ShippingTaskCompletedWebhookPayload.d.mts +15 -0
  224. package/dist/esm/api/types/ShippingTaskCompletedWebhookPayload.mjs +4 -0
  225. package/dist/esm/api/types/ShippingTaskDeletedWebhookPayload.d.mts +14 -0
  226. package/dist/esm/api/types/ShippingTaskDeletedWebhookPayload.mjs +4 -0
  227. package/dist/esm/api/types/ShippingTaskGroupCourierOrgAssignedWebhookPayload.d.mts +14 -0
  228. package/dist/esm/api/types/ShippingTaskGroupCourierOrgAssignedWebhookPayload.mjs +4 -0
  229. package/dist/esm/api/types/ShippingTaskGroupDriverAssignedWebhookPayload.d.mts +15 -0
  230. package/dist/esm/api/types/ShippingTaskGroupDriverAssignedWebhookPayload.mjs +4 -0
  231. package/dist/esm/api/types/ShippingTaskGroupFlightInfoUpdatedWebhookPayload.d.mts +16 -0
  232. package/dist/esm/api/types/ShippingTaskGroupFlightInfoUpdatedWebhookPayload.mjs +4 -0
  233. package/dist/esm/api/types/ShippingTaskGroupInProgressWebhookPayload.d.mts +13 -0
  234. package/dist/esm/api/types/ShippingTaskGroupInProgressWebhookPayload.mjs +4 -0
  235. package/dist/esm/api/types/ShippingTaskGroupMessageWebhookPayload.d.mts +15 -0
  236. package/dist/esm/api/types/ShippingTaskGroupMessageWebhookPayload.mjs +4 -0
  237. package/dist/esm/api/types/ShippingTaskGroupS3ObjectAddedWebhookPayload.d.mts +15 -0
  238. package/dist/esm/api/types/ShippingTaskGroupS3ObjectAddedWebhookPayload.mjs +4 -0
  239. package/dist/esm/api/types/ShippingTaskGroupTasksOrderingUpdatedWebhookPayload.d.mts +14 -0
  240. package/dist/esm/api/types/ShippingTaskGroupTasksOrderingUpdatedWebhookPayload.mjs +4 -0
  241. package/dist/esm/api/types/ShippingTaskSkippedWebhookPayload.d.mts +15 -0
  242. package/dist/esm/api/types/ShippingTaskSkippedWebhookPayload.mjs +4 -0
  243. package/dist/esm/api/types/Statement1.d.mts +1 -1
  244. package/dist/esm/api/types/{Task1.d.mts → Task1Input.d.mts} +4 -8
  245. package/dist/esm/api/types/Task1Input.mjs +4 -0
  246. package/dist/esm/api/types/Task1Output.d.mts +36 -0
  247. package/dist/esm/api/types/Task1Output.mjs +4 -0
  248. package/dist/esm/api/types/TaskClientCreate1.d.mts +1 -1
  249. package/dist/esm/api/types/TaskClientUpdate1.d.mts +1 -1
  250. package/dist/esm/api/types/TaskExpanded.d.mts +2 -2
  251. package/dist/esm/api/types/TaskGroupExpanded.d.mts +1 -1
  252. package/dist/esm/api/types/UserPublicData1.d.mts +0 -1
  253. package/dist/esm/api/types/WebhookAppPortalAccessRes.d.mts +10 -0
  254. package/dist/esm/api/types/WebhookAppPortalAccessRes.mjs +4 -0
  255. package/dist/esm/api/types/index.d.mts +32 -6
  256. package/dist/esm/api/types/index.mjs +32 -6
  257. package/dist/esm/version.d.mts +1 -1
  258. package/dist/esm/version.mjs +1 -1
  259. package/package.json +1 -1
  260. package/reference.md +1786 -754
  261. package/dist/cjs/api/resources/notifications/client/requests/NotificationReq.d.ts +0 -17
  262. package/dist/cjs/api/resources/notifications/client/requests/index.d.ts +0 -1
  263. package/dist/cjs/api/resources/shipperContactInfo/client/Client.d.ts +0 -163
  264. package/dist/cjs/api/resources/shipperContactInfo/client/requests/index.d.ts +0 -1
  265. package/dist/cjs/api/types/ChrtEmailRecipient.d.ts +0 -10
  266. package/dist/cjs/api/types/ChrtEmailRecipient.js +0 -12
  267. package/dist/cjs/api/types/NotificationRes.d.ts +0 -10
  268. package/dist/esm/api/resources/notifications/client/requests/NotificationReq.d.mts +0 -17
  269. package/dist/esm/api/resources/notifications/client/requests/index.d.mts +0 -1
  270. package/dist/esm/api/resources/shipperContactInfo/client/Client.d.mts +0 -163
  271. package/dist/esm/api/resources/shipperContactInfo/client/requests/index.d.mts +0 -1
  272. package/dist/esm/api/types/ChrtEmailRecipient.d.mts +0 -10
  273. package/dist/esm/api/types/ChrtEmailRecipient.mjs +0 -9
  274. package/dist/esm/api/types/NotificationRes.d.mts +0 -10
  275. /package/dist/cjs/api/resources/{shipperContactInfo → directoryEntries}/client/index.d.ts +0 -0
  276. /package/dist/cjs/api/resources/{shipperContactInfo → directoryEntries}/client/index.js +0 -0
  277. /package/dist/cjs/api/resources/{notifications/client/requests/NotificationReq.js → directoryEntries/client/requests/DirectoryEntryClientCreate1.js} +0 -0
  278. /package/dist/cjs/api/resources/{shipperContactInfo/client/requests/ShipperContactClientUpdate1.js → directoryEntries/client/requests/DirectoryEntryClientUpdate1.js} +0 -0
  279. /package/dist/cjs/api/resources/{notifications → directoryEntries}/client/requests/index.js +0 -0
  280. /package/dist/cjs/api/resources/{shipperContactInfo → directoryEntries}/index.d.ts +0 -0
  281. /package/dist/cjs/api/resources/{shipperContactInfo → directoryEntries}/index.js +0 -0
  282. /package/dist/cjs/api/{types/Driver1.js → resources/notifications/resources/adHoc/client/requests/NotificationIntentAdHocClientCreate1.js} +0 -0
  283. /package/dist/cjs/api/resources/{shipperContactInfo → notifications/resources/adHoc}/client/requests/index.js +0 -0
  284. /package/dist/cjs/api/{types/NotificationRes.js → resources/notifications/resources/groups/client/requests/GroupsUpdateNameV1Request.js} +0 -0
  285. /package/dist/cjs/api/{types/ShipperContact1.js → resources/notifications/resources/groups/client/requests/NotificationGroupClientCreate1.js} +0 -0
  286. /package/dist/cjs/api/{types/ShipperContactClientCreate1.js → resources/notifications/resources/userPreferences/client/requests/UserNotificationPreferencesUpdateRequest.js} +0 -0
  287. /package/dist/{esm/api/resources/notifications/client/requests/index.mjs → cjs/api/resources/notifications/resources/webhookSetup/client/index.d.ts} +0 -0
  288. /package/dist/cjs/api/types/{Task1.js → BillingLineItemGroupMessageWebhookPayload.js} +0 -0
  289. /package/dist/esm/api/resources/{shipperContactInfo → directoryEntries}/client/index.d.mts +0 -0
  290. /package/dist/esm/api/resources/{shipperContactInfo → directoryEntries}/client/index.mjs +0 -0
  291. /package/dist/esm/api/resources/{notifications/client/requests/NotificationReq.mjs → directoryEntries/client/requests/DirectoryEntryClientCreate1.mjs} +0 -0
  292. /package/dist/esm/api/resources/{shipperContactInfo/client/requests/ShipperContactClientUpdate1.mjs → directoryEntries/client/requests/DirectoryEntryClientUpdate1.mjs} +0 -0
  293. /package/dist/esm/api/resources/{shipperContactInfo → directoryEntries}/client/requests/index.mjs +0 -0
  294. /package/dist/esm/api/resources/{shipperContactInfo → directoryEntries}/index.d.mts +0 -0
  295. /package/dist/esm/api/resources/{shipperContactInfo → directoryEntries}/index.mjs +0 -0
  296. /package/dist/esm/api/{types/Driver1.mjs → resources/notifications/resources/adHoc/client/requests/NotificationIntentAdHocClientCreate1.mjs} +0 -0
  297. /package/dist/esm/api/{types/NotificationRes.mjs → resources/notifications/resources/groups/client/requests/GroupsUpdateNameV1Request.mjs} +0 -0
  298. /package/dist/esm/api/{types/ShipperContact1.mjs → resources/notifications/resources/groups/client/requests/NotificationGroupClientCreate1.mjs} +0 -0
  299. /package/dist/esm/api/{types/ShipperContactClientCreate1.mjs → resources/notifications/resources/userPreferences/client/requests/UserNotificationPreferencesUpdateRequest.mjs} +0 -0
  300. /package/dist/esm/api/types/{Task1.mjs → BillingLineItemGroupMessageWebhookPayload.mjs} +0 -0
package/reference.md CHANGED
@@ -1371,133 +1371,9 @@ await client.flights.getFlightInfoForTaskV1("task_id");
1371
1371
  </dl>
1372
1372
  </details>
1373
1373
 
1374
- ## Notifications
1375
-
1376
- <details><summary><code>client.notifications.<a href="/src/api/resources/notifications/client/Client.ts">getNotificationV1</a>() -> string</code></summary>
1377
- <dl>
1378
- <dd>
1379
-
1380
- #### 📝 Description
1381
-
1382
- <dl>
1383
- <dd>
1384
-
1385
- <dl>
1386
- <dd>
1387
-
1388
- Development notification endpoint that returns the caller's ID for testing. | () -> (str)
1389
-
1390
- </dd>
1391
- </dl>
1392
- </dd>
1393
- </dl>
1394
-
1395
- #### 🔌 Usage
1396
-
1397
- <dl>
1398
- <dd>
1399
-
1400
- <dl>
1401
- <dd>
1402
-
1403
- ```typescript
1404
- await client.notifications.getNotificationV1();
1405
- ```
1406
-
1407
- </dd>
1408
- </dl>
1409
- </dd>
1410
- </dl>
1411
-
1412
- #### ⚙️ Parameters
1413
-
1414
- <dl>
1415
- <dd>
1416
-
1417
- <dl>
1418
- <dd>
1419
-
1420
- **requestOptions:** `Notifications.RequestOptions`
1421
-
1422
- </dd>
1423
- </dl>
1424
- </dd>
1425
- </dl>
1426
-
1427
- </dd>
1428
- </dl>
1429
- </details>
1430
-
1431
- <details><summary><code>client.notifications.<a href="/src/api/resources/notifications/client/Client.ts">createNotificationV1</a>({ ...params }) -> Chrt.NotificationRes</code></summary>
1432
- <dl>
1433
- <dd>
1434
-
1435
- #### 📝 Description
1436
-
1437
- <dl>
1438
- <dd>
1439
-
1440
- <dl>
1441
- <dd>
1442
-
1443
- Send a notification email to a chrt.com recipient. | (NotificationReq) -> (NotificationRes)
1444
-
1445
- </dd>
1446
- </dl>
1447
- </dd>
1448
- </dl>
1449
-
1450
- #### 🔌 Usage
1451
-
1452
- <dl>
1453
- <dd>
1454
-
1455
- <dl>
1456
- <dd>
1457
-
1458
- ```typescript
1459
- await client.notifications.createNotificationV1({
1460
- recipient: "aaron",
1461
- name: "name",
1462
- message: "message",
1463
- });
1464
- ```
1465
-
1466
- </dd>
1467
- </dl>
1468
- </dd>
1469
- </dl>
1470
-
1471
- #### ⚙️ Parameters
1472
-
1473
- <dl>
1474
- <dd>
1475
-
1476
- <dl>
1477
- <dd>
1478
-
1479
- **request:** `Chrt.NotificationReq`
1480
-
1481
- </dd>
1482
- </dl>
1483
-
1484
- <dl>
1485
- <dd>
1486
-
1487
- **requestOptions:** `Notifications.RequestOptions`
1488
-
1489
- </dd>
1490
- </dl>
1491
- </dd>
1492
- </dl>
1493
-
1494
- </dd>
1495
- </dl>
1496
- </details>
1497
-
1498
1374
  ## Drivers
1499
1375
 
1500
- <details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">getForCallerV1</a>() -> Chrt.Driver1</code></summary>
1376
+ <details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">getForCallerV1</a>() -> Chrt.Driver1Output</code></summary>
1501
1377
  <dl>
1502
1378
  <dd>
1503
1379
 
@@ -1552,7 +1428,7 @@ await client.drivers.getForCallerV1();
1552
1428
  </dl>
1553
1429
  </details>
1554
1430
 
1555
- <details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">getByDriverIdV1</a>(driverId) -> Chrt.Driver1</code></summary>
1431
+ <details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">getByDriverIdV1</a>(driverId) -> Chrt.Driver1Output</code></summary>
1556
1432
  <dl>
1557
1433
  <dd>
1558
1434
 
@@ -1681,7 +1557,7 @@ await client.drivers.listOrgMembersAndDriversV1({
1681
1557
  </dl>
1682
1558
  </details>
1683
1559
 
1684
- <details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">listV1</a>({ ...params }) -> Chrt.Driver1[]</code></summary>
1560
+ <details><summary><code>client.drivers.<a href="/src/api/resources/drivers/client/Client.ts">listV1</a>({ ...params }) -> Chrt.Driver1Output[]</code></summary>
1685
1561
  <dl>
1686
1562
  <dd>
1687
1563
 
@@ -4023,9 +3899,9 @@ await client.tasks.deleteV1("task_id");
4023
3899
  </dl>
4024
3900
  </details>
4025
3901
 
4026
- ## ShipperContactInfo
3902
+ ## DirectoryEntries
4027
3903
 
4028
- <details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">getCallerV1</a>() -> Chrt.ShipperContact1</code></summary>
3904
+ <details><summary><code>client.directoryEntries.<a href="/src/api/resources/directoryEntries/client/Client.ts">getV1</a>(directoryEntryId) -> Chrt.DirectoryEntry1</code></summary>
4029
3905
  <dl>
4030
3906
  <dd>
4031
3907
 
@@ -4037,7 +3913,7 @@ await client.tasks.deleteV1("task_id");
4037
3913
  <dl>
4038
3914
  <dd>
4039
3915
 
4040
- Retrieves the shipper contact information associated with the caller's ID. | () -> (ShipperContact1)
3916
+ Retrieves a specific directory entry by ID if authorized to access it. | authz: min_org_role=operator | () -> (DirectoryEntry1)
4041
3917
 
4042
3918
  </dd>
4043
3919
  </dl>
@@ -4053,7 +3929,7 @@ Retrieves the shipper contact information associated with the caller's ID. | ()
4053
3929
  <dd>
4054
3930
 
4055
3931
  ```typescript
4056
- await client.shipperContactInfo.getCallerV1();
3932
+ await client.directoryEntries.getV1("directory_entry_id");
4057
3933
  ```
4058
3934
 
4059
3935
  </dd>
@@ -4069,7 +3945,15 @@ await client.shipperContactInfo.getCallerV1();
4069
3945
  <dl>
4070
3946
  <dd>
4071
3947
 
4072
- **requestOptions:** `ShipperContactInfo.RequestOptions`
3948
+ **directoryEntryId:** `string`
3949
+
3950
+ </dd>
3951
+ </dl>
3952
+
3953
+ <dl>
3954
+ <dd>
3955
+
3956
+ **requestOptions:** `DirectoryEntries.RequestOptions`
4073
3957
 
4074
3958
  </dd>
4075
3959
  </dl>
@@ -4080,7 +3964,7 @@ await client.shipperContactInfo.getCallerV1();
4080
3964
  </dl>
4081
3965
  </details>
4082
3966
 
4083
- <details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">listV1</a>() -> Chrt.ShipperContact1[]</code></summary>
3967
+ <details><summary><code>client.directoryEntries.<a href="/src/api/resources/directoryEntries/client/Client.ts">listV1</a>() -> Chrt.DirectoryEntry1[]</code></summary>
4084
3968
  <dl>
4085
3969
  <dd>
4086
3970
 
@@ -4092,7 +3976,7 @@ await client.shipperContactInfo.getCallerV1();
4092
3976
  <dl>
4093
3977
  <dd>
4094
3978
 
4095
- Lists all shipper contacts for the caller's organization. | () -> (list[ShipperContact1])
3979
+ Lists all directory entries created by the caller's organization. | authz: min_org_role=operator | () -> (list[DirectoryEntry1])
4096
3980
 
4097
3981
  </dd>
4098
3982
  </dl>
@@ -4108,7 +3992,7 @@ Lists all shipper contacts for the caller's organization. | () -> (list[ShipperC
4108
3992
  <dd>
4109
3993
 
4110
3994
  ```typescript
4111
- await client.shipperContactInfo.listV1();
3995
+ await client.directoryEntries.listV1();
4112
3996
  ```
4113
3997
 
4114
3998
  </dd>
@@ -4124,7 +4008,7 @@ await client.shipperContactInfo.listV1();
4124
4008
  <dl>
4125
4009
  <dd>
4126
4010
 
4127
- **requestOptions:** `ShipperContactInfo.RequestOptions`
4011
+ **requestOptions:** `DirectoryEntries.RequestOptions`
4128
4012
 
4129
4013
  </dd>
4130
4014
  </dl>
@@ -4135,7 +4019,7 @@ await client.shipperContactInfo.listV1();
4135
4019
  </dl>
4136
4020
  </details>
4137
4021
 
4138
- <details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">listCourierContactsV1</a>(shipperOrgId) -> Chrt.ShipperContact1[]</code></summary>
4022
+ <details><summary><code>client.directoryEntries.<a href="/src/api/resources/directoryEntries/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
4139
4023
  <dl>
4140
4024
  <dd>
4141
4025
 
@@ -4147,7 +4031,7 @@ await client.shipperContactInfo.listV1();
4147
4031
  <dl>
4148
4032
  <dd>
4149
4033
 
4150
- Lists all shipper contacts accessible to the courier organization for a specific on-platform shipper. | () -> (list[ShipperContact1])
4034
+ Creates a directory entry. | (DirectoryEntryClientCreate1) -> (PydanticObjectId)
4151
4035
 
4152
4036
  </dd>
4153
4037
  </dl>
@@ -4163,7 +4047,9 @@ Lists all shipper contacts accessible to the courier organization for a specific
4163
4047
  <dd>
4164
4048
 
4165
4049
  ```typescript
4166
- await client.shipperContactInfo.listCourierContactsV1("shipper_org_id");
4050
+ await client.directoryEntries.createV1({
4051
+ schema_version: 1,
4052
+ });
4167
4053
  ```
4168
4054
 
4169
4055
  </dd>
@@ -4179,7 +4065,7 @@ await client.shipperContactInfo.listCourierContactsV1("shipper_org_id");
4179
4065
  <dl>
4180
4066
  <dd>
4181
4067
 
4182
- **shipperOrgId:** `string`
4068
+ **request:** `Chrt.DirectoryEntryClientCreate1`
4183
4069
 
4184
4070
  </dd>
4185
4071
  </dl>
@@ -4187,7 +4073,7 @@ await client.shipperContactInfo.listCourierContactsV1("shipper_org_id");
4187
4073
  <dl>
4188
4074
  <dd>
4189
4075
 
4190
- **requestOptions:** `ShipperContactInfo.RequestOptions`
4076
+ **requestOptions:** `DirectoryEntries.RequestOptions`
4191
4077
 
4192
4078
  </dd>
4193
4079
  </dl>
@@ -4198,7 +4084,7 @@ await client.shipperContactInfo.listCourierContactsV1("shipper_org_id");
4198
4084
  </dl>
4199
4085
  </details>
4200
4086
 
4201
- <details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">listForwarderContactsV1</a>(shipperOrgId) -> Chrt.ShipperContact1[]</code></summary>
4087
+ <details><summary><code>client.directoryEntries.<a href="/src/api/resources/directoryEntries/client/Client.ts">updateV1</a>(directoryEntryId, { ...params }) -> boolean</code></summary>
4202
4088
  <dl>
4203
4089
  <dd>
4204
4090
 
@@ -4210,7 +4096,7 @@ await client.shipperContactInfo.listCourierContactsV1("shipper_org_id");
4210
4096
  <dl>
4211
4097
  <dd>
4212
4098
 
4213
- Lists all shipper contacts accessible to the forwarder organization for a specific on-platform shipper. | () -> (list[ShipperContact1])
4099
+ Updates existing directory entry owned by the caller's organization. | (DirectoryEntryClientUpdate1) -> (bool)
4214
4100
 
4215
4101
  </dd>
4216
4102
  </dl>
@@ -4226,7 +4112,7 @@ Lists all shipper contacts accessible to the forwarder organization for a specif
4226
4112
  <dd>
4227
4113
 
4228
4114
  ```typescript
4229
- await client.shipperContactInfo.listForwarderContactsV1("shipper_org_id");
4115
+ await client.directoryEntries.updateV1("directory_entry_id");
4230
4116
  ```
4231
4117
 
4232
4118
  </dd>
@@ -4242,7 +4128,15 @@ await client.shipperContactInfo.listForwarderContactsV1("shipper_org_id");
4242
4128
  <dl>
4243
4129
  <dd>
4244
4130
 
4245
- **shipperOrgId:** `string`
4131
+ **directoryEntryId:** `string`
4132
+
4133
+ </dd>
4134
+ </dl>
4135
+
4136
+ <dl>
4137
+ <dd>
4138
+
4139
+ **request:** `Chrt.DirectoryEntryClientUpdate1`
4246
4140
 
4247
4141
  </dd>
4248
4142
  </dl>
@@ -4250,7 +4144,7 @@ await client.shipperContactInfo.listForwarderContactsV1("shipper_org_id");
4250
4144
  <dl>
4251
4145
  <dd>
4252
4146
 
4253
- **requestOptions:** `ShipperContactInfo.RequestOptions`
4147
+ **requestOptions:** `DirectoryEntries.RequestOptions`
4254
4148
 
4255
4149
  </dd>
4256
4150
  </dl>
@@ -4261,7 +4155,7 @@ await client.shipperContactInfo.listForwarderContactsV1("shipper_org_id");
4261
4155
  </dl>
4262
4156
  </details>
4263
4157
 
4264
- <details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">listOffPlatformContactsV1</a>(offChrtShipperOrgId) -> Chrt.ShipperContact1[]</code></summary>
4158
+ <details><summary><code>client.directoryEntries.<a href="/src/api/resources/directoryEntries/client/Client.ts">deleteV1</a>(directoryEntryId) -> boolean</code></summary>
4265
4159
  <dl>
4266
4160
  <dd>
4267
4161
 
@@ -4273,7 +4167,7 @@ await client.shipperContactInfo.listForwarderContactsV1("shipper_org_id");
4273
4167
  <dl>
4274
4168
  <dd>
4275
4169
 
4276
- Lists all shipper contacts for a specific off-platform shipper. | () -> (list[ShipperContact1])
4170
+ Deletes directory entry owned by the caller's organization. | authz: min_org_role=operator | () -> (bool)
4277
4171
 
4278
4172
  </dd>
4279
4173
  </dl>
@@ -4289,7 +4183,7 @@ Lists all shipper contacts for a specific off-platform shipper. | () -> (list[Sh
4289
4183
  <dd>
4290
4184
 
4291
4185
  ```typescript
4292
- await client.shipperContactInfo.listOffPlatformContactsV1("off_chrt_shipper_org_id");
4186
+ await client.directoryEntries.deleteV1("directory_entry_id");
4293
4187
  ```
4294
4188
 
4295
4189
  </dd>
@@ -4305,7 +4199,7 @@ await client.shipperContactInfo.listOffPlatformContactsV1("off_chrt_shipper_org_
4305
4199
  <dl>
4306
4200
  <dd>
4307
4201
 
4308
- **offChrtShipperOrgId:** `string`
4202
+ **directoryEntryId:** `string`
4309
4203
 
4310
4204
  </dd>
4311
4205
  </dl>
@@ -4313,7 +4207,7 @@ await client.shipperContactInfo.listOffPlatformContactsV1("off_chrt_shipper_org_
4313
4207
  <dl>
4314
4208
  <dd>
4315
4209
 
4316
- **requestOptions:** `ShipperContactInfo.RequestOptions`
4210
+ **requestOptions:** `DirectoryEntries.RequestOptions`
4317
4211
 
4318
4212
  </dd>
4319
4213
  </dl>
@@ -4324,7 +4218,9 @@ await client.shipperContactInfo.listOffPlatformContactsV1("off_chrt_shipper_org_
4324
4218
  </dl>
4325
4219
  </details>
4326
4220
 
4327
- <details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">getV1</a>(id) -> Chrt.ShipperContact1</code></summary>
4221
+ ## Orgs
4222
+
4223
+ <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getInfoV1</a>() -> Record&lt;string, unknown&gt;</code></summary>
4328
4224
  <dl>
4329
4225
  <dd>
4330
4226
 
@@ -4336,7 +4232,7 @@ await client.shipperContactInfo.listOffPlatformContactsV1("off_chrt_shipper_org_
4336
4232
  <dl>
4337
4233
  <dd>
4338
4234
 
4339
- Retrieves a specific shipper contact by ID if authorized to access it. | () -> (ShipperContact1)
4235
+ Retrieves basic organization information from the authentication service. | () -> (dict)
4340
4236
 
4341
4237
  </dd>
4342
4238
  </dl>
@@ -4352,7 +4248,7 @@ Retrieves a specific shipper contact by ID if authorized to access it. | () -> (
4352
4248
  <dd>
4353
4249
 
4354
4250
  ```typescript
4355
- await client.shipperContactInfo.getV1("id");
4251
+ await client.orgs.getInfoV1();
4356
4252
  ```
4357
4253
 
4358
4254
  </dd>
@@ -4368,15 +4264,7 @@ await client.shipperContactInfo.getV1("id");
4368
4264
  <dl>
4369
4265
  <dd>
4370
4266
 
4371
- **id:** `string`
4372
-
4373
- </dd>
4374
- </dl>
4375
-
4376
- <dl>
4377
- <dd>
4378
-
4379
- **requestOptions:** `ShipperContactInfo.RequestOptions`
4267
+ **requestOptions:** `Orgs.RequestOptions`
4380
4268
 
4381
4269
  </dd>
4382
4270
  </dl>
@@ -4387,7 +4275,7 @@ await client.shipperContactInfo.getV1("id");
4387
4275
  </dl>
4388
4276
  </details>
4389
4277
 
4390
- <details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">createOnPlatformV1</a>({ ...params }) -> string</code></summary>
4278
+ <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">listMembersV1</a>() -> Chrt.OrgMemberDetails[]</code></summary>
4391
4279
  <dl>
4392
4280
  <dd>
4393
4281
 
@@ -4399,7 +4287,7 @@ await client.shipperContactInfo.getV1("id");
4399
4287
  <dl>
4400
4288
  <dd>
4401
4289
 
4402
- Creates contact information for an on-platform shipper organization or user. | (ShipperContactClientCreate1) -> (PydanticObjectId)
4290
+ Lists all members of the caller's organization with their roles and details. | () -> (list[OrgMemberDetails])
4403
4291
 
4404
4292
  </dd>
4405
4293
  </dl>
@@ -4415,9 +4303,7 @@ Creates contact information for an on-platform shipper organization or user. | (
4415
4303
  <dd>
4416
4304
 
4417
4305
  ```typescript
4418
- await client.shipperContactInfo.createOnPlatformV1({
4419
- schema_version: 1,
4420
- });
4306
+ await client.orgs.listMembersV1();
4421
4307
  ```
4422
4308
 
4423
4309
  </dd>
@@ -4433,15 +4319,7 @@ await client.shipperContactInfo.createOnPlatformV1({
4433
4319
  <dl>
4434
4320
  <dd>
4435
4321
 
4436
- **request:** `Chrt.ShipperContactClientCreate1`
4437
-
4438
- </dd>
4439
- </dl>
4440
-
4441
- <dl>
4442
- <dd>
4443
-
4444
- **requestOptions:** `ShipperContactInfo.RequestOptions`
4322
+ **requestOptions:** `Orgs.RequestOptions`
4445
4323
 
4446
4324
  </dd>
4447
4325
  </dl>
@@ -4452,7 +4330,7 @@ await client.shipperContactInfo.createOnPlatformV1({
4452
4330
  </dl>
4453
4331
  </details>
4454
4332
 
4455
- <details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">createOffPlatformV1</a>({ ...params }) -> string</code></summary>
4333
+ <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getOrgPrivateDataV1</a>() -> Chrt.OrgPrivateData1</code></summary>
4456
4334
  <dl>
4457
4335
  <dd>
4458
4336
 
@@ -4464,7 +4342,7 @@ await client.shipperContactInfo.createOnPlatformV1({
4464
4342
  <dl>
4465
4343
  <dd>
4466
4344
 
4467
- Creates contact information for an off-platform shipper using connection info. | (ShipperContactClientCreate1) -> (PydanticObjectId)
4345
+ Retrieves private organization data for the caller's organization. | authz: min_org_role=operator | () -> (OrgPrivateData1)
4468
4346
 
4469
4347
  </dd>
4470
4348
  </dl>
@@ -4480,9 +4358,7 @@ Creates contact information for an off-platform shipper using connection info. |
4480
4358
  <dd>
4481
4359
 
4482
4360
  ```typescript
4483
- await client.shipperContactInfo.createOffPlatformV1({
4484
- schema_version: 1,
4485
- });
4361
+ await client.orgs.getOrgPrivateDataV1();
4486
4362
  ```
4487
4363
 
4488
4364
  </dd>
@@ -4498,15 +4374,7 @@ await client.shipperContactInfo.createOffPlatformV1({
4498
4374
  <dl>
4499
4375
  <dd>
4500
4376
 
4501
- **request:** `Chrt.ShipperContactClientCreate1`
4502
-
4503
- </dd>
4504
- </dl>
4505
-
4506
- <dl>
4507
- <dd>
4508
-
4509
- **requestOptions:** `ShipperContactInfo.RequestOptions`
4377
+ **requestOptions:** `Orgs.RequestOptions`
4510
4378
 
4511
4379
  </dd>
4512
4380
  </dl>
@@ -4517,7 +4385,7 @@ await client.shipperContactInfo.createOffPlatformV1({
4517
4385
  </dl>
4518
4386
  </details>
4519
4387
 
4520
- <details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">updateV1</a>(shipperContactInfoId, { ...params }) -> boolean</code></summary>
4388
+ <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getOrgPublicDataV1</a>() -> Chrt.OrgPublicData1</code></summary>
4521
4389
  <dl>
4522
4390
  <dd>
4523
4391
 
@@ -4529,7 +4397,7 @@ await client.shipperContactInfo.createOffPlatformV1({
4529
4397
  <dl>
4530
4398
  <dd>
4531
4399
 
4532
- Updates existing shipper contact information owned by the caller's organization. | (ShipperContactClientUpdate1) -> (bool)
4400
+ Retrieves public organization data for the caller's organization. | () -> (OrgPublicData1)
4533
4401
 
4534
4402
  </dd>
4535
4403
  </dl>
@@ -4545,7 +4413,7 @@ Updates existing shipper contact information owned by the caller's organization.
4545
4413
  <dd>
4546
4414
 
4547
4415
  ```typescript
4548
- await client.shipperContactInfo.updateV1("shipper_contact_info_id");
4416
+ await client.orgs.getOrgPublicDataV1();
4549
4417
  ```
4550
4418
 
4551
4419
  </dd>
@@ -4561,23 +4429,7 @@ await client.shipperContactInfo.updateV1("shipper_contact_info_id");
4561
4429
  <dl>
4562
4430
  <dd>
4563
4431
 
4564
- **shipperContactInfoId:** `string`
4565
-
4566
- </dd>
4567
- </dl>
4568
-
4569
- <dl>
4570
- <dd>
4571
-
4572
- **request:** `Chrt.ShipperContactClientUpdate1`
4573
-
4574
- </dd>
4575
- </dl>
4576
-
4577
- <dl>
4578
- <dd>
4579
-
4580
- **requestOptions:** `ShipperContactInfo.RequestOptions`
4432
+ **requestOptions:** `Orgs.RequestOptions`
4581
4433
 
4582
4434
  </dd>
4583
4435
  </dl>
@@ -4588,7 +4440,7 @@ await client.shipperContactInfo.updateV1("shipper_contact_info_id");
4588
4440
  </dl>
4589
4441
  </details>
4590
4442
 
4591
- <details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">deleteV1</a>(id) -> boolean</code></summary>
4443
+ <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">createOrgPublicDataV1</a>({ ...params }) -> Chrt.CreateOrgPublicDataRes</code></summary>
4592
4444
  <dl>
4593
4445
  <dd>
4594
4446
 
@@ -4600,7 +4452,7 @@ await client.shipperContactInfo.updateV1("shipper_contact_info_id");
4600
4452
  <dl>
4601
4453
  <dd>
4602
4454
 
4603
- Deletes shipper contact information owned by the caller's organization. | () -> (bool)
4455
+ Creates org_public_data and org_private_data documents for the caller's organization using org_type from JWT. | (CreateOrgPublicDataReq) -> (CreateOrgPublicDataRes)
4604
4456
 
4605
4457
  </dd>
4606
4458
  </dl>
@@ -4616,7 +4468,7 @@ Deletes shipper contact information owned by the caller's organization. | () ->
4616
4468
  <dd>
4617
4469
 
4618
4470
  ```typescript
4619
- await client.shipperContactInfo.deleteV1("id");
4471
+ await client.orgs.createOrgPublicDataV1();
4620
4472
  ```
4621
4473
 
4622
4474
  </dd>
@@ -4632,7 +4484,7 @@ await client.shipperContactInfo.deleteV1("id");
4632
4484
  <dl>
4633
4485
  <dd>
4634
4486
 
4635
- **id:** `string`
4487
+ **request:** `Chrt.CreateOrgPublicDataReq`
4636
4488
 
4637
4489
  </dd>
4638
4490
  </dl>
@@ -4640,7 +4492,7 @@ await client.shipperContactInfo.deleteV1("id");
4640
4492
  <dl>
4641
4493
  <dd>
4642
4494
 
4643
- **requestOptions:** `ShipperContactInfo.RequestOptions`
4495
+ **requestOptions:** `Orgs.RequestOptions`
4644
4496
 
4645
4497
  </dd>
4646
4498
  </dl>
@@ -4651,9 +4503,7 @@ await client.shipperContactInfo.deleteV1("id");
4651
4503
  </dl>
4652
4504
  </details>
4653
4505
 
4654
- ## Orgs
4655
-
4656
- <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getInfoV1</a>() -> Record&lt;string, unknown&gt;</code></summary>
4506
+ <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">updateOrgPublicDataV1</a>({ ...params }) -> boolean</code></summary>
4657
4507
  <dl>
4658
4508
  <dd>
4659
4509
 
@@ -4665,7 +4515,7 @@ await client.shipperContactInfo.deleteV1("id");
4665
4515
  <dl>
4666
4516
  <dd>
4667
4517
 
4668
- Retrieves basic organization information from the authentication service. | () -> (dict)
4518
+ Updates the handle and/or company_name for the caller's organization. | (UpdateOrgPublicDataReq) -> (bool)
4669
4519
 
4670
4520
  </dd>
4671
4521
  </dl>
@@ -4681,7 +4531,7 @@ Retrieves basic organization information from the authentication service. | () -
4681
4531
  <dd>
4682
4532
 
4683
4533
  ```typescript
4684
- await client.orgs.getInfoV1();
4534
+ await client.orgs.updateOrgPublicDataV1();
4685
4535
  ```
4686
4536
 
4687
4537
  </dd>
@@ -4697,6 +4547,14 @@ await client.orgs.getInfoV1();
4697
4547
  <dl>
4698
4548
  <dd>
4699
4549
 
4550
+ **request:** `Chrt.UpdateOrgPublicDataReq`
4551
+
4552
+ </dd>
4553
+ </dl>
4554
+
4555
+ <dl>
4556
+ <dd>
4557
+
4700
4558
  **requestOptions:** `Orgs.RequestOptions`
4701
4559
 
4702
4560
  </dd>
@@ -4708,7 +4566,7 @@ await client.orgs.getInfoV1();
4708
4566
  </dl>
4709
4567
  </details>
4710
4568
 
4711
- <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">listMembersV1</a>() -> Chrt.OrgMemberDetails[]</code></summary>
4569
+ <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getOrgPublicDataByOrgIdV1</a>(orgId) -> Chrt.OrgPublicData1</code></summary>
4712
4570
  <dl>
4713
4571
  <dd>
4714
4572
 
@@ -4720,7 +4578,7 @@ await client.orgs.getInfoV1();
4720
4578
  <dl>
4721
4579
  <dd>
4722
4580
 
4723
- Lists all members of the caller's organization with their roles and details. | () -> (list[OrgMemberDetails])
4581
+ Retrieves public organization data for a specific organization by ID. | () -> (OrgPublicData1)
4724
4582
 
4725
4583
  </dd>
4726
4584
  </dl>
@@ -4736,7 +4594,7 @@ Lists all members of the caller's organization with their roles and details. | (
4736
4594
  <dd>
4737
4595
 
4738
4596
  ```typescript
4739
- await client.orgs.listMembersV1();
4597
+ await client.orgs.getOrgPublicDataByOrgIdV1("org_id");
4740
4598
  ```
4741
4599
 
4742
4600
  </dd>
@@ -4752,6 +4610,14 @@ await client.orgs.listMembersV1();
4752
4610
  <dl>
4753
4611
  <dd>
4754
4612
 
4613
+ **orgId:** `string`
4614
+
4615
+ </dd>
4616
+ </dl>
4617
+
4618
+ <dl>
4619
+ <dd>
4620
+
4755
4621
  **requestOptions:** `Orgs.RequestOptions`
4756
4622
 
4757
4623
  </dd>
@@ -4763,7 +4629,7 @@ await client.orgs.listMembersV1();
4763
4629
  </dl>
4764
4630
  </details>
4765
4631
 
4766
- <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getOrgPrivateDataV1</a>() -> Chrt.OrgPrivateData1</code></summary>
4632
+ <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getOrgPublicDataHandleAvailabilityV1</a>(handle) -> boolean</code></summary>
4767
4633
  <dl>
4768
4634
  <dd>
4769
4635
 
@@ -4775,7 +4641,7 @@ await client.orgs.listMembersV1();
4775
4641
  <dl>
4776
4642
  <dd>
4777
4643
 
4778
- Retrieves private organization data for the caller's organization. | authz: min_org_role=operator | () -> (OrgPrivateData1)
4644
+ Returns True when the provided handle is available, otherwise False. | () -> (bool)
4779
4645
 
4780
4646
  </dd>
4781
4647
  </dl>
@@ -4791,7 +4657,7 @@ Retrieves private organization data for the caller's organization. | authz: min_
4791
4657
  <dd>
4792
4658
 
4793
4659
  ```typescript
4794
- await client.orgs.getOrgPrivateDataV1();
4660
+ await client.orgs.getOrgPublicDataHandleAvailabilityV1("handle");
4795
4661
  ```
4796
4662
 
4797
4663
  </dd>
@@ -4807,6 +4673,14 @@ await client.orgs.getOrgPrivateDataV1();
4807
4673
  <dl>
4808
4674
  <dd>
4809
4675
 
4676
+ **handle:** `string`
4677
+
4678
+ </dd>
4679
+ </dl>
4680
+
4681
+ <dl>
4682
+ <dd>
4683
+
4810
4684
  **requestOptions:** `Orgs.RequestOptions`
4811
4685
 
4812
4686
  </dd>
@@ -4818,7 +4692,7 @@ await client.orgs.getOrgPrivateDataV1();
4818
4692
  </dl>
4819
4693
  </details>
4820
4694
 
4821
- <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getOrgPublicDataV1</a>() -> Chrt.OrgPublicData1</code></summary>
4695
+ <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">setOrgTypeV1</a>({ ...params }) -> boolean</code></summary>
4822
4696
  <dl>
4823
4697
  <dd>
4824
4698
 
@@ -4830,7 +4704,7 @@ await client.orgs.getOrgPrivateDataV1();
4830
4704
  <dl>
4831
4705
  <dd>
4832
4706
 
4833
- Retrieves public organization data for the caller's organization. | () -> (OrgPublicData1)
4707
+ Sets the org_type in Clerk's JWT public metadata. Returns True if already set and matching, sets it if not present, or raises exception if conflicting. | (SetOrgTypeReq) -> (bool)
4834
4708
 
4835
4709
  </dd>
4836
4710
  </dl>
@@ -4846,7 +4720,9 @@ Retrieves public organization data for the caller's organization. | () -> (OrgPu
4846
4720
  <dd>
4847
4721
 
4848
4722
  ```typescript
4849
- await client.orgs.getOrgPublicDataV1();
4723
+ await client.orgs.setOrgTypeV1({
4724
+ org_type: "courier",
4725
+ });
4850
4726
  ```
4851
4727
 
4852
4728
  </dd>
@@ -4862,6 +4738,14 @@ await client.orgs.getOrgPublicDataV1();
4862
4738
  <dl>
4863
4739
  <dd>
4864
4740
 
4741
+ **request:** `Chrt.SetOrgTypeReq`
4742
+
4743
+ </dd>
4744
+ </dl>
4745
+
4746
+ <dl>
4747
+ <dd>
4748
+
4865
4749
  **requestOptions:** `Orgs.RequestOptions`
4866
4750
 
4867
4751
  </dd>
@@ -4873,7 +4757,7 @@ await client.orgs.getOrgPublicDataV1();
4873
4757
  </dl>
4874
4758
  </details>
4875
4759
 
4876
- <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">createOrgPublicDataV1</a>({ ...params }) -> Chrt.CreateOrgPublicDataRes</code></summary>
4760
+ <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getStripeConnectAccountIdV1</a>() -> string</code></summary>
4877
4761
  <dl>
4878
4762
  <dd>
4879
4763
 
@@ -4885,7 +4769,7 @@ await client.orgs.getOrgPublicDataV1();
4885
4769
  <dl>
4886
4770
  <dd>
4887
4771
 
4888
- Creates org_public_data and org_private_data documents for the caller's organization using org_type from JWT. | (CreateOrgPublicDataReq) -> (CreateOrgPublicDataRes)
4772
+ Retrieves the Stripe Connect account ID for the caller's organization. Returns 404 if not set. | () -> (str)
4889
4773
 
4890
4774
  </dd>
4891
4775
  </dl>
@@ -4901,7 +4785,7 @@ Creates org_public_data and org_private_data documents for the caller's organiza
4901
4785
  <dd>
4902
4786
 
4903
4787
  ```typescript
4904
- await client.orgs.createOrgPublicDataV1();
4788
+ await client.orgs.getStripeConnectAccountIdV1();
4905
4789
  ```
4906
4790
 
4907
4791
  </dd>
@@ -4917,14 +4801,6 @@ await client.orgs.createOrgPublicDataV1();
4917
4801
  <dl>
4918
4802
  <dd>
4919
4803
 
4920
- **request:** `Chrt.CreateOrgPublicDataReq`
4921
-
4922
- </dd>
4923
- </dl>
4924
-
4925
- <dl>
4926
- <dd>
4927
-
4928
4804
  **requestOptions:** `Orgs.RequestOptions`
4929
4805
 
4930
4806
  </dd>
@@ -4936,7 +4812,9 @@ await client.orgs.createOrgPublicDataV1();
4936
4812
  </dl>
4937
4813
  </details>
4938
4814
 
4939
- <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">updateOrgPublicDataV1</a>({ ...params }) -> boolean</code></summary>
4815
+ ## Root
4816
+
4817
+ <details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">pingAuthd</a>() -> Record&lt;string, string&gt;</code></summary>
4940
4818
  <dl>
4941
4819
  <dd>
4942
4820
 
@@ -4948,7 +4826,7 @@ await client.orgs.createOrgPublicDataV1();
4948
4826
  <dl>
4949
4827
  <dd>
4950
4828
 
4951
- Updates the handle and/or company_name for the caller's organization. | (UpdateOrgPublicDataReq) -> (bool)
4829
+ Test endpoint for authenticated requests that requires valid authentication tokens. | () -> (dict[str, str])
4952
4830
 
4953
4831
  </dd>
4954
4832
  </dl>
@@ -4964,7 +4842,7 @@ Updates the handle and/or company_name for the caller's organization. | (UpdateO
4964
4842
  <dd>
4965
4843
 
4966
4844
  ```typescript
4967
- await client.orgs.updateOrgPublicDataV1();
4845
+ await client.root.pingAuthd();
4968
4846
  ```
4969
4847
 
4970
4848
  </dd>
@@ -4980,15 +4858,7 @@ await client.orgs.updateOrgPublicDataV1();
4980
4858
  <dl>
4981
4859
  <dd>
4982
4860
 
4983
- **request:** `Chrt.UpdateOrgPublicDataReq`
4984
-
4985
- </dd>
4986
- </dl>
4987
-
4988
- <dl>
4989
- <dd>
4990
-
4991
- **requestOptions:** `Orgs.RequestOptions`
4861
+ **requestOptions:** `Root.RequestOptions`
4992
4862
 
4993
4863
  </dd>
4994
4864
  </dl>
@@ -4999,7 +4869,7 @@ await client.orgs.updateOrgPublicDataV1();
4999
4869
  </dl>
5000
4870
  </details>
5001
4871
 
5002
- <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getOrgPublicDataByOrgIdV1</a>(orgId) -> Chrt.OrgPublicData1</code></summary>
4872
+ <details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">pingOptionallyAuthd</a>() -> Record&lt;string, unknown&gt;</code></summary>
5003
4873
  <dl>
5004
4874
  <dd>
5005
4875
 
@@ -5011,7 +4881,7 @@ await client.orgs.updateOrgPublicDataV1();
5011
4881
  <dl>
5012
4882
  <dd>
5013
4883
 
5014
- Retrieves public organization data for a specific organization by ID. | () -> (OrgPublicData1)
4884
+ Test endpoint for optionally authenticated requests that works with or without authentication. | () -> (dict)
5015
4885
 
5016
4886
  </dd>
5017
4887
  </dl>
@@ -5027,7 +4897,7 @@ Retrieves public organization data for a specific organization by ID. | () -> (O
5027
4897
  <dd>
5028
4898
 
5029
4899
  ```typescript
5030
- await client.orgs.getOrgPublicDataByOrgIdV1("org_id");
4900
+ await client.root.pingOptionallyAuthd();
5031
4901
  ```
5032
4902
 
5033
4903
  </dd>
@@ -5043,15 +4913,7 @@ await client.orgs.getOrgPublicDataByOrgIdV1("org_id");
5043
4913
  <dl>
5044
4914
  <dd>
5045
4915
 
5046
- **orgId:** `string`
5047
-
5048
- </dd>
5049
- </dl>
5050
-
5051
- <dl>
5052
- <dd>
5053
-
5054
- **requestOptions:** `Orgs.RequestOptions`
4916
+ **requestOptions:** `Root.RequestOptions`
5055
4917
 
5056
4918
  </dd>
5057
4919
  </dl>
@@ -5062,7 +4924,7 @@ await client.orgs.getOrgPublicDataByOrgIdV1("org_id");
5062
4924
  </dl>
5063
4925
  </details>
5064
4926
 
5065
- <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getOrgPublicDataHandleAvailabilityV1</a>(handle) -> boolean</code></summary>
4927
+ <details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">pingUnauthd</a>() -> Record&lt;string, unknown&gt;</code></summary>
5066
4928
  <dl>
5067
4929
  <dd>
5068
4930
 
@@ -5074,7 +4936,7 @@ await client.orgs.getOrgPublicDataByOrgIdV1("org_id");
5074
4936
  <dl>
5075
4937
  <dd>
5076
4938
 
5077
- Returns True when the provided handle is available, otherwise False. | () -> (bool)
4939
+ Returns a greeting message to verify the API is accessible. | () -> (dict)
5078
4940
 
5079
4941
  </dd>
5080
4942
  </dl>
@@ -5090,7 +4952,7 @@ Returns True when the provided handle is available, otherwise False. | () -> (bo
5090
4952
  <dd>
5091
4953
 
5092
4954
  ```typescript
5093
- await client.orgs.getOrgPublicDataHandleAvailabilityV1("handle");
4955
+ await client.root.pingUnauthd();
5094
4956
  ```
5095
4957
 
5096
4958
  </dd>
@@ -5106,15 +4968,7 @@ await client.orgs.getOrgPublicDataHandleAvailabilityV1("handle");
5106
4968
  <dl>
5107
4969
  <dd>
5108
4970
 
5109
- **handle:** `string`
5110
-
5111
- </dd>
5112
- </dl>
5113
-
5114
- <dl>
5115
- <dd>
5116
-
5117
- **requestOptions:** `Orgs.RequestOptions`
4971
+ **requestOptions:** `Root.RequestOptions`
5118
4972
 
5119
4973
  </dd>
5120
4974
  </dl>
@@ -5125,7 +4979,7 @@ await client.orgs.getOrgPublicDataHandleAvailabilityV1("handle");
5125
4979
  </dl>
5126
4980
  </details>
5127
4981
 
5128
- <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">setOrgTypeV1</a>({ ...params }) -> boolean</code></summary>
4982
+ <details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">health</a>() -> Record&lt;string, unknown&gt;</code></summary>
5129
4983
  <dl>
5130
4984
  <dd>
5131
4985
 
@@ -5137,7 +4991,7 @@ await client.orgs.getOrgPublicDataHandleAvailabilityV1("handle");
5137
4991
  <dl>
5138
4992
  <dd>
5139
4993
 
5140
- Sets the org_type in Clerk's JWT public metadata. Returns True if already set and matching, sets it if not present, or raises exception if conflicting. | (SetOrgTypeReq) -> (bool)
4994
+ Returns a health status message used for monitoring system availability and uptime. | () -> (dict)
5141
4995
 
5142
4996
  </dd>
5143
4997
  </dl>
@@ -5153,9 +5007,7 @@ Sets the org_type in Clerk's JWT public metadata. Returns True if already set an
5153
5007
  <dd>
5154
5008
 
5155
5009
  ```typescript
5156
- await client.orgs.setOrgTypeV1({
5157
- org_type: "courier",
5158
- });
5010
+ await client.root.health();
5159
5011
  ```
5160
5012
 
5161
5013
  </dd>
@@ -5171,15 +5023,7 @@ await client.orgs.setOrgTypeV1({
5171
5023
  <dl>
5172
5024
  <dd>
5173
5025
 
5174
- **request:** `Chrt.SetOrgTypeReq`
5175
-
5176
- </dd>
5177
- </dl>
5178
-
5179
- <dl>
5180
- <dd>
5181
-
5182
- **requestOptions:** `Orgs.RequestOptions`
5026
+ **requestOptions:** `Root.RequestOptions`
5183
5027
 
5184
5028
  </dd>
5185
5029
  </dl>
@@ -5190,7 +5034,7 @@ await client.orgs.setOrgTypeV1({
5190
5034
  </dl>
5191
5035
  </details>
5192
5036
 
5193
- <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getStripeConnectAccountIdV1</a>() -> string</code></summary>
5037
+ <details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">failure</a>() -> unknown</code></summary>
5194
5038
  <dl>
5195
5039
  <dd>
5196
5040
 
@@ -5202,7 +5046,7 @@ await client.orgs.setOrgTypeV1({
5202
5046
  <dl>
5203
5047
  <dd>
5204
5048
 
5205
- Retrieves the Stripe Connect account ID for the caller's organization. Returns 404 if not set. | () -> (str)
5049
+ Test endpoint that intentionally fails for error handling validation and monitoring purposes. | () -> (None)
5206
5050
 
5207
5051
  </dd>
5208
5052
  </dl>
@@ -5218,7 +5062,7 @@ Retrieves the Stripe Connect account ID for the caller's organization. Returns 4
5218
5062
  <dd>
5219
5063
 
5220
5064
  ```typescript
5221
- await client.orgs.getStripeConnectAccountIdV1();
5065
+ await client.root.failure();
5222
5066
  ```
5223
5067
 
5224
5068
  </dd>
@@ -5234,7 +5078,7 @@ await client.orgs.getStripeConnectAccountIdV1();
5234
5078
  <dl>
5235
5079
  <dd>
5236
5080
 
5237
- **requestOptions:** `Orgs.RequestOptions`
5081
+ **requestOptions:** `Root.RequestOptions`
5238
5082
 
5239
5083
  </dd>
5240
5084
  </dl>
@@ -5245,9 +5089,9 @@ await client.orgs.getStripeConnectAccountIdV1();
5245
5089
  </dl>
5246
5090
  </details>
5247
5091
 
5248
- ## Root
5092
+ ## Users
5249
5093
 
5250
- <details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">pingAuthd</a>() -> Record&lt;string, string&gt;</code></summary>
5094
+ <details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">getUserPublicDataV1</a>() -> Chrt.UserPublicData1</code></summary>
5251
5095
  <dl>
5252
5096
  <dd>
5253
5097
 
@@ -5259,7 +5103,7 @@ await client.orgs.getStripeConnectAccountIdV1();
5259
5103
  <dl>
5260
5104
  <dd>
5261
5105
 
5262
- Test endpoint for authenticated requests that requires valid authentication tokens. | () -> (dict[str, str])
5106
+ Retrieves public user data for the caller. | () -> (UserPublicData1)
5263
5107
 
5264
5108
  </dd>
5265
5109
  </dl>
@@ -5275,7 +5119,7 @@ Test endpoint for authenticated requests that requires valid authentication toke
5275
5119
  <dd>
5276
5120
 
5277
5121
  ```typescript
5278
- await client.root.pingAuthd();
5122
+ await client.users.getUserPublicDataV1();
5279
5123
  ```
5280
5124
 
5281
5125
  </dd>
@@ -5291,7 +5135,7 @@ await client.root.pingAuthd();
5291
5135
  <dl>
5292
5136
  <dd>
5293
5137
 
5294
- **requestOptions:** `Root.RequestOptions`
5138
+ **requestOptions:** `Users.RequestOptions`
5295
5139
 
5296
5140
  </dd>
5297
5141
  </dl>
@@ -5302,7 +5146,9 @@ await client.root.pingAuthd();
5302
5146
  </dl>
5303
5147
  </details>
5304
5148
 
5305
- <details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">pingOptionallyAuthd</a>() -> Record&lt;string, unknown&gt;</code></summary>
5149
+ ## Utils
5150
+
5151
+ <details><summary><code>client.utils.<a href="/src/api/resources/utils/client/Client.ts">getTimezoneV1</a>({ ...params }) -> Chrt.TimezoneResponse</code></summary>
5306
5152
  <dl>
5307
5153
  <dd>
5308
5154
 
@@ -5314,7 +5160,7 @@ await client.root.pingAuthd();
5314
5160
  <dl>
5315
5161
  <dd>
5316
5162
 
5317
- Test endpoint for optionally authenticated requests that works with or without authentication. | () -> (dict)
5163
+ Returns the IANA timezone identifier (e.g., 'America/Los_Angeles') for the given latitude and longitude coordinates. Falls back to closest timezone if the point is in the ocean or at an edge. | () -> (TimezoneResponse)
5318
5164
 
5319
5165
  </dd>
5320
5166
  </dl>
@@ -5330,7 +5176,10 @@ Test endpoint for optionally authenticated requests that works with or without a
5330
5176
  <dd>
5331
5177
 
5332
5178
  ```typescript
5333
- await client.root.pingOptionallyAuthd();
5179
+ await client.utils.getTimezoneV1({
5180
+ lat: 37.7749,
5181
+ lng: -122.4194,
5182
+ });
5334
5183
  ```
5335
5184
 
5336
5185
  </dd>
@@ -5346,7 +5195,15 @@ await client.root.pingOptionallyAuthd();
5346
5195
  <dl>
5347
5196
  <dd>
5348
5197
 
5349
- **requestOptions:** `Root.RequestOptions`
5198
+ **request:** `Chrt.UtilsGetTimezoneV1Request`
5199
+
5200
+ </dd>
5201
+ </dl>
5202
+
5203
+ <dl>
5204
+ <dd>
5205
+
5206
+ **requestOptions:** `Utils.RequestOptions`
5350
5207
 
5351
5208
  </dd>
5352
5209
  </dl>
@@ -5357,7 +5214,9 @@ await client.root.pingOptionallyAuthd();
5357
5214
  </dl>
5358
5215
  </details>
5359
5216
 
5360
- <details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">pingUnauthd</a>() -> Record&lt;string, unknown&gt;</code></summary>
5217
+ ## Billing LineItemGroups
5218
+
5219
+ <details><summary><code>client.billing.lineItemGroups.<a href="/src/api/resources/billing/resources/lineItemGroups/client/Client.ts">getV1</a>(lineItemGroupId) -> Chrt.LineItemGroup1</code></summary>
5361
5220
  <dl>
5362
5221
  <dd>
5363
5222
 
@@ -5369,7 +5228,7 @@ await client.root.pingOptionallyAuthd();
5369
5228
  <dl>
5370
5229
  <dd>
5371
5230
 
5372
- Returns a greeting message to verify the API is accessible. | () -> (dict)
5231
+ Gets a line item group by ID. | authz_personas=[lig_org_operators, lig_driver] | () -> (LineItemGroup1)
5373
5232
 
5374
5233
  </dd>
5375
5234
  </dl>
@@ -5385,7 +5244,7 @@ Returns a greeting message to verify the API is accessible. | () -> (dict)
5385
5244
  <dd>
5386
5245
 
5387
5246
  ```typescript
5388
- await client.root.pingUnauthd();
5247
+ await client.billing.lineItemGroups.getV1("line_item_group_id");
5389
5248
  ```
5390
5249
 
5391
5250
  </dd>
@@ -5401,7 +5260,15 @@ await client.root.pingUnauthd();
5401
5260
  <dl>
5402
5261
  <dd>
5403
5262
 
5404
- **requestOptions:** `Root.RequestOptions`
5263
+ **lineItemGroupId:** `string`
5264
+
5265
+ </dd>
5266
+ </dl>
5267
+
5268
+ <dl>
5269
+ <dd>
5270
+
5271
+ **requestOptions:** `LineItemGroups.RequestOptions`
5405
5272
 
5406
5273
  </dd>
5407
5274
  </dl>
@@ -5412,7 +5279,7 @@ await client.root.pingUnauthd();
5412
5279
  </dl>
5413
5280
  </details>
5414
5281
 
5415
- <details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">health</a>() -> Record&lt;string, unknown&gt;</code></summary>
5282
+ <details><summary><code>client.billing.lineItemGroups.<a href="/src/api/resources/billing/resources/lineItemGroups/client/Client.ts">listForCourierOrgV1</a>({ ...params }) -> Chrt.LineItemGroupListRes</code></summary>
5416
5283
  <dl>
5417
5284
  <dd>
5418
5285
 
@@ -5424,7 +5291,7 @@ await client.root.pingUnauthd();
5424
5291
  <dl>
5425
5292
  <dd>
5426
5293
 
5427
- Returns a health status message used for monitoring system availability and uptime. | () -> (dict)
5294
+ Lists line item groups for the authenticated courier organization with filtering and pagination. | org_type=[courier], min_org_role=operator | () -> (LineItemGroupListRes)
5428
5295
 
5429
5296
  </dd>
5430
5297
  </dl>
@@ -5440,7 +5307,13 @@ Returns a health status message used for monitoring system availability and upti
5440
5307
  <dd>
5441
5308
 
5442
5309
  ```typescript
5443
- await client.root.health();
5310
+ await client.billing.lineItemGroups.listForCourierOrgV1({
5311
+ filter_driver_id: "filter_driver_id",
5312
+ filter_attached_to_statement: true,
5313
+ filter_payment_role: "origin",
5314
+ page: 1,
5315
+ page_size: 1,
5316
+ });
5444
5317
  ```
5445
5318
 
5446
5319
  </dd>
@@ -5456,7 +5329,15 @@ await client.root.health();
5456
5329
  <dl>
5457
5330
  <dd>
5458
5331
 
5459
- **requestOptions:** `Root.RequestOptions`
5332
+ **request:** `Chrt.billing.LineItemGroupsListForCourierOrgV1Request`
5333
+
5334
+ </dd>
5335
+ </dl>
5336
+
5337
+ <dl>
5338
+ <dd>
5339
+
5340
+ **requestOptions:** `LineItemGroups.RequestOptions`
5460
5341
 
5461
5342
  </dd>
5462
5343
  </dl>
@@ -5467,7 +5348,7 @@ await client.root.health();
5467
5348
  </dl>
5468
5349
  </details>
5469
5350
 
5470
- <details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">failure</a>() -> unknown</code></summary>
5351
+ <details><summary><code>client.billing.lineItemGroups.<a href="/src/api/resources/billing/resources/lineItemGroups/client/Client.ts">quoteV1</a>(taskGroupId, { ...params }) -> Chrt.Quote</code></summary>
5471
5352
  <dl>
5472
5353
  <dd>
5473
5354
 
@@ -5479,7 +5360,7 @@ await client.root.health();
5479
5360
  <dl>
5480
5361
  <dd>
5481
5362
 
5482
- Test endpoint that intentionally fails for error handling validation and monitoring purposes. | () -> (None)
5363
+ Calculates a quote (line item group preview) for a task group and payment vector without persisting any data. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators, shipper_org_operators] | () -> (Quote)
5483
5364
 
5484
5365
  </dd>
5485
5366
  </dl>
@@ -5495,7 +5376,10 @@ Test endpoint that intentionally fails for error handling validation and monitor
5495
5376
  <dd>
5496
5377
 
5497
5378
  ```typescript
5498
- await client.root.failure();
5379
+ await client.billing.lineItemGroups.quoteV1("task_group_id", {
5380
+ payment_vector_type: "shipper_pay_forwarder",
5381
+ rate_sheet_id: "rate_sheet_id",
5382
+ });
5499
5383
  ```
5500
5384
 
5501
5385
  </dd>
@@ -5511,7 +5395,23 @@ await client.root.failure();
5511
5395
  <dl>
5512
5396
  <dd>
5513
5397
 
5514
- **requestOptions:** `Root.RequestOptions`
5398
+ **taskGroupId:** `string`
5399
+
5400
+ </dd>
5401
+ </dl>
5402
+
5403
+ <dl>
5404
+ <dd>
5405
+
5406
+ **request:** `Chrt.billing.LineItemGroupsQuoteV1Request`
5407
+
5408
+ </dd>
5409
+ </dl>
5410
+
5411
+ <dl>
5412
+ <dd>
5413
+
5414
+ **requestOptions:** `LineItemGroups.RequestOptions`
5515
5415
 
5516
5416
  </dd>
5517
5417
  </dl>
@@ -5522,9 +5422,7 @@ await client.root.failure();
5522
5422
  </dl>
5523
5423
  </details>
5524
5424
 
5525
- ## Users
5526
-
5527
- <details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">getUserPublicDataV1</a>() -> Chrt.UserPublicData1</code></summary>
5425
+ <details><summary><code>client.billing.lineItemGroups.<a href="/src/api/resources/billing/resources/lineItemGroups/client/Client.ts">finalizeV1</a>(lineItemGroupId) -> Chrt.LineItemGroup1</code></summary>
5528
5426
  <dl>
5529
5427
  <dd>
5530
5428
 
@@ -5536,7 +5434,7 @@ await client.root.failure();
5536
5434
  <dl>
5537
5435
  <dd>
5538
5436
 
5539
- Retrieves public user data for the caller. | () -> (UserPublicData1)
5437
+ Finalizes a line item group. LIG must be in ADJUSTABLE status. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | () -> (LineItemGroup1)
5540
5438
 
5541
5439
  </dd>
5542
5440
  </dl>
@@ -5552,7 +5450,7 @@ Retrieves public user data for the caller. | () -> (UserPublicData1)
5552
5450
  <dd>
5553
5451
 
5554
5452
  ```typescript
5555
- await client.users.getUserPublicDataV1();
5453
+ await client.billing.lineItemGroups.finalizeV1("line_item_group_id");
5556
5454
  ```
5557
5455
 
5558
5456
  </dd>
@@ -5568,7 +5466,15 @@ await client.users.getUserPublicDataV1();
5568
5466
  <dl>
5569
5467
  <dd>
5570
5468
 
5571
- **requestOptions:** `Users.RequestOptions`
5469
+ **lineItemGroupId:** `string`
5470
+
5471
+ </dd>
5472
+ </dl>
5473
+
5474
+ <dl>
5475
+ <dd>
5476
+
5477
+ **requestOptions:** `LineItemGroups.RequestOptions`
5572
5478
 
5573
5479
  </dd>
5574
5480
  </dl>
@@ -5579,9 +5485,7 @@ await client.users.getUserPublicDataV1();
5579
5485
  </dl>
5580
5486
  </details>
5581
5487
 
5582
- ## Utils
5583
-
5584
- <details><summary><code>client.utils.<a href="/src/api/resources/utils/client/Client.ts">getTimezoneV1</a>({ ...params }) -> Chrt.TimezoneResponse</code></summary>
5488
+ <details><summary><code>client.billing.lineItemGroups.<a href="/src/api/resources/billing/resources/lineItemGroups/client/Client.ts">calculateLineItemsV1</a>(lineItemGroupId) -> Chrt.LineItemGroup1</code></summary>
5585
5489
  <dl>
5586
5490
  <dd>
5587
5491
 
@@ -5593,7 +5497,7 @@ await client.users.getUserPublicDataV1();
5593
5497
  <dl>
5594
5498
  <dd>
5595
5499
 
5596
- Returns the IANA timezone identifier (e.g., 'America/Los_Angeles') for the given latitude and longitude coordinates. Falls back to closest timezone if the point is in the ocean or at an edge. | () -> (TimezoneResponse)
5500
+ (Re)calculates line items for a line item group. LIG must be PENDING_CALCULATION or ADJUSTABLE and must be associated with a TaskGroup. Note: Line item calculation normally happens automatically; this route is primarily for PENDING_CALCULATION LIGs where automatic calculation failed (e.g., due to third-party service failure). | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | () -> (LineItemGroup1)
5597
5501
 
5598
5502
  </dd>
5599
5503
  </dl>
@@ -5609,10 +5513,7 @@ Returns the IANA timezone identifier (e.g., 'America/Los_Angeles') for the given
5609
5513
  <dd>
5610
5514
 
5611
5515
  ```typescript
5612
- await client.utils.getTimezoneV1({
5613
- lat: 37.7749,
5614
- lng: -122.4194,
5615
- });
5516
+ await client.billing.lineItemGroups.calculateLineItemsV1("line_item_group_id");
5616
5517
  ```
5617
5518
 
5618
5519
  </dd>
@@ -5628,7 +5529,7 @@ await client.utils.getTimezoneV1({
5628
5529
  <dl>
5629
5530
  <dd>
5630
5531
 
5631
- **request:** `Chrt.UtilsGetTimezoneV1Request`
5532
+ **lineItemGroupId:** `string`
5632
5533
 
5633
5534
  </dd>
5634
5535
  </dl>
@@ -5636,7 +5537,7 @@ await client.utils.getTimezoneV1({
5636
5537
  <dl>
5637
5538
  <dd>
5638
5539
 
5639
- **requestOptions:** `Utils.RequestOptions`
5540
+ **requestOptions:** `LineItemGroups.RequestOptions`
5640
5541
 
5641
5542
  </dd>
5642
5543
  </dl>
@@ -5647,9 +5548,7 @@ await client.utils.getTimezoneV1({
5647
5548
  </dl>
5648
5549
  </details>
5649
5550
 
5650
- ## Billing LineItemGroups
5651
-
5652
- <details><summary><code>client.billing.lineItemGroups.<a href="/src/api/resources/billing/resources/lineItemGroups/client/Client.ts">getV1</a>(lineItemGroupId) -> Chrt.LineItemGroup1</code></summary>
5551
+ <details><summary><code>client.billing.lineItemGroups.<a href="/src/api/resources/billing/resources/lineItemGroups/client/Client.ts">associateWithStatementV1</a>(lineItemGroupId, { ...params }) -> Chrt.LineItemGroup1</code></summary>
5653
5552
  <dl>
5654
5553
  <dd>
5655
5554
 
@@ -5661,7 +5560,7 @@ await client.utils.getTimezoneV1({
5661
5560
  <dl>
5662
5561
  <dd>
5663
5562
 
5664
- Gets a line item group by ID. | authz_personas=[lig_org_operators, lig_driver] | () -> (LineItemGroup1)
5563
+ Associates a line item group with a statement. LIG must be PENDING_RATES, PENDING_CALCULATION, ADJUSTABLE, or FINALIZED (before OPEN). Statement must be STAGED. LIG payment info must match Statement. Also removes from previous statement if any. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators, statement_owner_operators] | (PydanticObjectId) -> (LineItemGroup1)
5665
5564
 
5666
5565
  </dd>
5667
5566
  </dl>
@@ -5677,7 +5576,9 @@ Gets a line item group by ID. | authz_personas=[lig_org_operators, lig_driver] |
5677
5576
  <dd>
5678
5577
 
5679
5578
  ```typescript
5680
- await client.billing.lineItemGroups.getV1("line_item_group_id");
5579
+ await client.billing.lineItemGroups.associateWithStatementV1("line_item_group_id", {
5580
+ statement_id: "statement_id",
5581
+ });
5681
5582
  ```
5682
5583
 
5683
5584
  </dd>
@@ -5701,6 +5602,14 @@ await client.billing.lineItemGroups.getV1("line_item_group_id");
5701
5602
  <dl>
5702
5603
  <dd>
5703
5604
 
5605
+ **request:** `Chrt.billing.LineItemGroupsAssociateWithStatementV1Request`
5606
+
5607
+ </dd>
5608
+ </dl>
5609
+
5610
+ <dl>
5611
+ <dd>
5612
+
5704
5613
  **requestOptions:** `LineItemGroups.RequestOptions`
5705
5614
 
5706
5615
  </dd>
@@ -5712,7 +5621,7 @@ await client.billing.lineItemGroups.getV1("line_item_group_id");
5712
5621
  </dl>
5713
5622
  </details>
5714
5623
 
5715
- <details><summary><code>client.billing.lineItemGroups.<a href="/src/api/resources/billing/resources/lineItemGroups/client/Client.ts">listForCourierOrgV1</a>({ ...params }) -> Chrt.LineItemGroupListRes</code></summary>
5624
+ <details><summary><code>client.billing.lineItemGroups.<a href="/src/api/resources/billing/resources/lineItemGroups/client/Client.ts">adjustLineItemV1</a>(lineItemGroupId, { ...params }) -> Chrt.LineItemGroup1</code></summary>
5716
5625
  <dl>
5717
5626
  <dd>
5718
5627
 
@@ -5724,7 +5633,7 @@ await client.billing.lineItemGroups.getV1("line_item_group_id");
5724
5633
  <dl>
5725
5634
  <dd>
5726
5635
 
5727
- Lists line item groups for the authenticated courier organization with filtering and pagination. | org_type=[courier], min_org_role=operator | () -> (LineItemGroupListRes)
5636
+ Adjusts a line item within a line item group. LIG must be ADJUSTABLE. Adjustment can be negative beyond item.amount to serve as a credit. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | (AdjustLineItemReq) -> (LineItemGroup1)
5728
5637
 
5729
5638
  </dd>
5730
5639
  </dl>
@@ -5740,12 +5649,9 @@ Lists line item groups for the authenticated courier organization with filtering
5740
5649
  <dd>
5741
5650
 
5742
5651
  ```typescript
5743
- await client.billing.lineItemGroups.listForCourierOrgV1({
5744
- filter_driver_id: "filter_driver_id",
5745
- filter_attached_to_statement: true,
5746
- filter_payment_role: "origin",
5747
- page: 1,
5748
- page_size: 1,
5652
+ await client.billing.lineItemGroups.adjustLineItemV1("line_item_group_id", {
5653
+ line_item_uuid_str: "line_item_uuid_str",
5654
+ adjustment: 1.1,
5749
5655
  });
5750
5656
  ```
5751
5657
 
@@ -5762,7 +5668,7 @@ await client.billing.lineItemGroups.listForCourierOrgV1({
5762
5668
  <dl>
5763
5669
  <dd>
5764
5670
 
5765
- **request:** `Chrt.billing.LineItemGroupsListForCourierOrgV1Request`
5671
+ **lineItemGroupId:** `string`
5766
5672
 
5767
5673
  </dd>
5768
5674
  </dl>
@@ -5770,18 +5676,28 @@ await client.billing.lineItemGroups.listForCourierOrgV1({
5770
5676
  <dl>
5771
5677
  <dd>
5772
5678
 
5773
- **requestOptions:** `LineItemGroups.RequestOptions`
5679
+ **request:** `Chrt.billing.AdjustLineItemReq`
5774
5680
 
5775
- </dd>
5776
- </dl>
5777
5681
  </dd>
5778
5682
  </dl>
5779
5683
 
5780
- </dd>
5781
- </dl>
5782
- </details>
5684
+ <dl>
5685
+ <dd>
5783
5686
 
5784
- <details><summary><code>client.billing.lineItemGroups.<a href="/src/api/resources/billing/resources/lineItemGroups/client/Client.ts">quoteV1</a>(taskGroupId, { ...params }) -> Chrt.Quote</code></summary>
5687
+ **requestOptions:** `LineItemGroups.RequestOptions`
5688
+
5689
+ </dd>
5690
+ </dl>
5691
+ </dd>
5692
+ </dl>
5693
+
5694
+ </dd>
5695
+ </dl>
5696
+ </details>
5697
+
5698
+ ## Billing RateSheets
5699
+
5700
+ <details><summary><code>client.billing.rateSheets.<a href="/src/api/resources/billing/resources/rateSheets/client/Client.ts">getV1</a>(rateSheetId) -> Chrt.RateSheet1</code></summary>
5785
5701
  <dl>
5786
5702
  <dd>
5787
5703
 
@@ -5793,7 +5709,7 @@ await client.billing.lineItemGroups.listForCourierOrgV1({
5793
5709
  <dl>
5794
5710
  <dd>
5795
5711
 
5796
- Calculates a quote (line item group preview) for a task group and payment vector without persisting any data. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators, shipper_org_operators] | () -> (Quote)
5712
+ Retrieves a rate sheet by ID. Only the owning org can fetch. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (RateSheet1)
5797
5713
 
5798
5714
  </dd>
5799
5715
  </dl>
@@ -5809,10 +5725,7 @@ Calculates a quote (line item group preview) for a task group and payment vector
5809
5725
  <dd>
5810
5726
 
5811
5727
  ```typescript
5812
- await client.billing.lineItemGroups.quoteV1("task_group_id", {
5813
- payment_vector_type: "shipper_pay_forwarder",
5814
- rate_sheet_id: "rate_sheet_id",
5815
- });
5728
+ await client.billing.rateSheets.getV1("rate_sheet_id");
5816
5729
  ```
5817
5730
 
5818
5731
  </dd>
@@ -5828,7 +5741,7 @@ await client.billing.lineItemGroups.quoteV1("task_group_id", {
5828
5741
  <dl>
5829
5742
  <dd>
5830
5743
 
5831
- **taskGroupId:** `string`
5744
+ **rateSheetId:** `string`
5832
5745
 
5833
5746
  </dd>
5834
5747
  </dl>
@@ -5836,15 +5749,78 @@ await client.billing.lineItemGroups.quoteV1("task_group_id", {
5836
5749
  <dl>
5837
5750
  <dd>
5838
5751
 
5839
- **request:** `Chrt.billing.LineItemGroupsQuoteV1Request`
5752
+ **requestOptions:** `RateSheets.RequestOptions`
5753
+
5754
+ </dd>
5755
+ </dl>
5756
+ </dd>
5757
+ </dl>
5840
5758
 
5841
5759
  </dd>
5842
5760
  </dl>
5761
+ </details>
5843
5762
 
5763
+ <details><summary><code>client.billing.rateSheets.<a href="/src/api/resources/billing/resources/rateSheets/client/Client.ts">updateV1</a>(rateSheetId, { ...params }) -> Chrt.RateSheet1</code></summary>
5844
5764
  <dl>
5845
5765
  <dd>
5846
5766
 
5847
- **requestOptions:** `LineItemGroups.RequestOptions`
5767
+ #### 📝 Description
5768
+
5769
+ <dl>
5770
+ <dd>
5771
+
5772
+ <dl>
5773
+ <dd>
5774
+
5775
+ Updates a rate sheet. Only name, comments, cargo_types, and vehicle_types can be changed. Use the archive endpoint for archiving. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | (RateSheetClientUpdate1) -> (RateSheet1)
5776
+
5777
+ </dd>
5778
+ </dl>
5779
+ </dd>
5780
+ </dl>
5781
+
5782
+ #### 🔌 Usage
5783
+
5784
+ <dl>
5785
+ <dd>
5786
+
5787
+ <dl>
5788
+ <dd>
5789
+
5790
+ ```typescript
5791
+ await client.billing.rateSheets.updateV1("rate_sheet_id");
5792
+ ```
5793
+
5794
+ </dd>
5795
+ </dl>
5796
+ </dd>
5797
+ </dl>
5798
+
5799
+ #### ⚙️ Parameters
5800
+
5801
+ <dl>
5802
+ <dd>
5803
+
5804
+ <dl>
5805
+ <dd>
5806
+
5807
+ **rateSheetId:** `string`
5808
+
5809
+ </dd>
5810
+ </dl>
5811
+
5812
+ <dl>
5813
+ <dd>
5814
+
5815
+ **request:** `Chrt.billing.RateSheetClientUpdate1`
5816
+
5817
+ </dd>
5818
+ </dl>
5819
+
5820
+ <dl>
5821
+ <dd>
5822
+
5823
+ **requestOptions:** `RateSheets.RequestOptions`
5848
5824
 
5849
5825
  </dd>
5850
5826
  </dl>
@@ -5855,7 +5831,7 @@ await client.billing.lineItemGroups.quoteV1("task_group_id", {
5855
5831
  </dl>
5856
5832
  </details>
5857
5833
 
5858
- <details><summary><code>client.billing.lineItemGroups.<a href="/src/api/resources/billing/resources/lineItemGroups/client/Client.ts">finalizeV1</a>(lineItemGroupId) -> Chrt.LineItemGroup1</code></summary>
5834
+ <details><summary><code>client.billing.rateSheets.<a href="/src/api/resources/billing/resources/rateSheets/client/Client.ts">listByOrgV1</a>({ ...params }) -> Chrt.RateSheetListResponse</code></summary>
5859
5835
  <dl>
5860
5836
  <dd>
5861
5837
 
@@ -5867,7 +5843,7 @@ await client.billing.lineItemGroups.quoteV1("task_group_id", {
5867
5843
  <dl>
5868
5844
  <dd>
5869
5845
 
5870
- Finalizes a line item group. LIG must be in ADJUSTABLE status. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | () -> (LineItemGroup1)
5846
+ Lists rate sheets for the caller's organization with filtering, sorting, and pagination. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (RateSheetListResponse)
5871
5847
 
5872
5848
  </dd>
5873
5849
  </dl>
@@ -5883,7 +5859,17 @@ Finalizes a line item group. LIG must be in ADJUSTABLE status. | org_type=[couri
5883
5859
  <dd>
5884
5860
 
5885
5861
  ```typescript
5886
- await client.billing.lineItemGroups.finalizeV1("line_item_group_id");
5862
+ await client.billing.rateSheets.listByOrgV1({
5863
+ sort_by: "id",
5864
+ sort_order: "ascending",
5865
+ page: 1,
5866
+ page_size: 1,
5867
+ filter_archived: true,
5868
+ filter_payment_vector_type: "shipper_pay_forwarder",
5869
+ filter_service_type: "on_demand",
5870
+ filter_cargo_type: "spare_parts",
5871
+ filter_vehicle_type: "sedan",
5872
+ });
5887
5873
  ```
5888
5874
 
5889
5875
  </dd>
@@ -5899,7 +5885,7 @@ await client.billing.lineItemGroups.finalizeV1("line_item_group_id");
5899
5885
  <dl>
5900
5886
  <dd>
5901
5887
 
5902
- **lineItemGroupId:** `string`
5888
+ **request:** `Chrt.billing.RateSheetsListByOrgV1Request`
5903
5889
 
5904
5890
  </dd>
5905
5891
  </dl>
@@ -5907,7 +5893,7 @@ await client.billing.lineItemGroups.finalizeV1("line_item_group_id");
5907
5893
  <dl>
5908
5894
  <dd>
5909
5895
 
5910
- **requestOptions:** `LineItemGroups.RequestOptions`
5896
+ **requestOptions:** `RateSheets.RequestOptions`
5911
5897
 
5912
5898
  </dd>
5913
5899
  </dl>
@@ -5918,7 +5904,7 @@ await client.billing.lineItemGroups.finalizeV1("line_item_group_id");
5918
5904
  </dl>
5919
5905
  </details>
5920
5906
 
5921
- <details><summary><code>client.billing.lineItemGroups.<a href="/src/api/resources/billing/resources/lineItemGroups/client/Client.ts">calculateLineItemsV1</a>(lineItemGroupId) -> Chrt.LineItemGroup1</code></summary>
5907
+ <details><summary><code>client.billing.rateSheets.<a href="/src/api/resources/billing/resources/rateSheets/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
5922
5908
  <dl>
5923
5909
  <dd>
5924
5910
 
@@ -5930,7 +5916,7 @@ await client.billing.lineItemGroups.finalizeV1("line_item_group_id");
5930
5916
  <dl>
5931
5917
  <dd>
5932
5918
 
5933
- (Re)calculates line items for a line item group. LIG must be PENDING_CALCULATION or ADJUSTABLE and must be associated with a TaskGroup. Note: Line item calculation normally happens automatically; this route is primarily for PENDING_CALCULATION LIGs where automatic calculation failed (e.g., due to third-party service failure). | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | () -> (LineItemGroup1)
5919
+ Creates a rate sheet. Couriers and forwarders only. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | (RateSheetClientCreate1) -> (PydanticObjectId)
5934
5920
 
5935
5921
  </dd>
5936
5922
  </dl>
@@ -5946,7 +5932,11 @@ await client.billing.lineItemGroups.finalizeV1("line_item_group_id");
5946
5932
  <dd>
5947
5933
 
5948
5934
  ```typescript
5949
- await client.billing.lineItemGroups.calculateLineItemsV1("line_item_group_id");
5935
+ await client.billing.rateSheets.createV1({
5936
+ payment_vector_type: "shipper_pay_forwarder",
5937
+ schema_version: 1,
5938
+ service_type: "on_demand",
5939
+ });
5950
5940
  ```
5951
5941
 
5952
5942
  </dd>
@@ -5962,7 +5952,7 @@ await client.billing.lineItemGroups.calculateLineItemsV1("line_item_group_id");
5962
5952
  <dl>
5963
5953
  <dd>
5964
5954
 
5965
- **lineItemGroupId:** `string`
5955
+ **request:** `Chrt.billing.RateSheetClientCreate1`
5966
5956
 
5967
5957
  </dd>
5968
5958
  </dl>
@@ -5970,7 +5960,7 @@ await client.billing.lineItemGroups.calculateLineItemsV1("line_item_group_id");
5970
5960
  <dl>
5971
5961
  <dd>
5972
5962
 
5973
- **requestOptions:** `LineItemGroups.RequestOptions`
5963
+ **requestOptions:** `RateSheets.RequestOptions`
5974
5964
 
5975
5965
  </dd>
5976
5966
  </dl>
@@ -5981,7 +5971,7 @@ await client.billing.lineItemGroups.calculateLineItemsV1("line_item_group_id");
5981
5971
  </dl>
5982
5972
  </details>
5983
5973
 
5984
- <details><summary><code>client.billing.lineItemGroups.<a href="/src/api/resources/billing/resources/lineItemGroups/client/Client.ts">associateWithStatementV1</a>(lineItemGroupId, { ...params }) -> Chrt.LineItemGroup1</code></summary>
5974
+ <details><summary><code>client.billing.rateSheets.<a href="/src/api/resources/billing/resources/rateSheets/client/Client.ts">archiveV1</a>(rateSheetId, { ...params }) -> boolean</code></summary>
5985
5975
  <dl>
5986
5976
  <dd>
5987
5977
 
@@ -5993,7 +5983,7 @@ await client.billing.lineItemGroups.calculateLineItemsV1("line_item_group_id");
5993
5983
  <dl>
5994
5984
  <dd>
5995
5985
 
5996
- Associates a line item group with a statement. LIG must be PENDING_RATES, PENDING_CALCULATION, ADJUSTABLE, or FINALIZED (before OPEN). Statement must be OPEN. LIG payment info must match Statement. Also removes from previous statement if any. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators, statement_owner_operators] | (PydanticObjectId) -> (LineItemGroup1)
5986
+ Archives or unarchives a rate sheet. When archiving, automatically removes the rate sheet from all default assignments (OrgPrivateData, Connections, Drivers). | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (bool)
5997
5987
 
5998
5988
  </dd>
5999
5989
  </dl>
@@ -6009,8 +5999,8 @@ Associates a line item group with a statement. LIG must be PENDING_RATES, PENDIN
6009
5999
  <dd>
6010
6000
 
6011
6001
  ```typescript
6012
- await client.billing.lineItemGroups.associateWithStatementV1("line_item_group_id", {
6013
- statement_id: "statement_id",
6002
+ await client.billing.rateSheets.archiveV1("rate_sheet_id", {
6003
+ archive: true,
6014
6004
  });
6015
6005
  ```
6016
6006
 
@@ -6027,7 +6017,7 @@ await client.billing.lineItemGroups.associateWithStatementV1("line_item_group_id
6027
6017
  <dl>
6028
6018
  <dd>
6029
6019
 
6030
- **lineItemGroupId:** `string`
6020
+ **rateSheetId:** `string`
6031
6021
 
6032
6022
  </dd>
6033
6023
  </dl>
@@ -6035,7 +6025,7 @@ await client.billing.lineItemGroups.associateWithStatementV1("line_item_group_id
6035
6025
  <dl>
6036
6026
  <dd>
6037
6027
 
6038
- **request:** `Chrt.billing.LineItemGroupsAssociateWithStatementV1Request`
6028
+ **request:** `Chrt.billing.RateSheetsArchiveV1Request`
6039
6029
 
6040
6030
  </dd>
6041
6031
  </dl>
@@ -6043,7 +6033,7 @@ await client.billing.lineItemGroups.associateWithStatementV1("line_item_group_id
6043
6033
  <dl>
6044
6034
  <dd>
6045
6035
 
6046
- **requestOptions:** `LineItemGroups.RequestOptions`
6036
+ **requestOptions:** `RateSheets.RequestOptions`
6047
6037
 
6048
6038
  </dd>
6049
6039
  </dl>
@@ -6054,7 +6044,7 @@ await client.billing.lineItemGroups.associateWithStatementV1("line_item_group_id
6054
6044
  </dl>
6055
6045
  </details>
6056
6046
 
6057
- <details><summary><code>client.billing.lineItemGroups.<a href="/src/api/resources/billing/resources/lineItemGroups/client/Client.ts">adjustLineItemV1</a>(lineItemGroupId, { ...params }) -> Chrt.LineItemGroup1</code></summary>
6047
+ <details><summary><code>client.billing.rateSheets.<a href="/src/api/resources/billing/resources/rateSheets/client/Client.ts">updateOrgDefaultForServiceTypeV1</a>({ ...params }) -> boolean</code></summary>
6058
6048
  <dl>
6059
6049
  <dd>
6060
6050
 
@@ -6066,7 +6056,7 @@ await client.billing.lineItemGroups.associateWithStatementV1("line_item_group_id
6066
6056
  <dl>
6067
6057
  <dd>
6068
6058
 
6069
- Adjusts a line item within a line item group. LIG must be ADJUSTABLE. Adjustment can be negative beyond item.amount to serve as a credit. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | (AdjustLineItemReq) -> (LineItemGroup1)
6059
+ Sets or clears the org's default rate sheet for a payment vector type and service type. Pass rate_sheet_id to set a default, or omit it to clear the default. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (bool)
6070
6060
 
6071
6061
  </dd>
6072
6062
  </dl>
@@ -6082,9 +6072,10 @@ Adjusts a line item within a line item group. LIG must be ADJUSTABLE. Adjustment
6082
6072
  <dd>
6083
6073
 
6084
6074
  ```typescript
6085
- await client.billing.lineItemGroups.adjustLineItemV1("line_item_group_id", {
6086
- line_item_uuid_str: "line_item_uuid_str",
6087
- adjustment: 1.1,
6075
+ await client.billing.rateSheets.updateOrgDefaultForServiceTypeV1({
6076
+ payment_vector_type: "shipper_pay_forwarder",
6077
+ service_type: "on_demand",
6078
+ rate_sheet_id: "rate_sheet_id",
6088
6079
  });
6089
6080
  ```
6090
6081
 
@@ -6101,7 +6092,7 @@ await client.billing.lineItemGroups.adjustLineItemV1("line_item_group_id", {
6101
6092
  <dl>
6102
6093
  <dd>
6103
6094
 
6104
- **lineItemGroupId:** `string`
6095
+ **request:** `Chrt.billing.RateSheetsUpdateOrgDefaultForServiceTypeV1Request`
6105
6096
 
6106
6097
  </dd>
6107
6098
  </dl>
@@ -6109,28 +6100,85 @@ await client.billing.lineItemGroups.adjustLineItemV1("line_item_group_id", {
6109
6100
  <dl>
6110
6101
  <dd>
6111
6102
 
6112
- **request:** `Chrt.billing.AdjustLineItemReq`
6103
+ **requestOptions:** `RateSheets.RequestOptions`
6104
+
6105
+ </dd>
6106
+ </dl>
6107
+ </dd>
6108
+ </dl>
6113
6109
 
6114
6110
  </dd>
6115
6111
  </dl>
6112
+ </details>
6116
6113
 
6114
+ <details><summary><code>client.billing.rateSheets.<a href="/src/api/resources/billing/resources/rateSheets/client/Client.ts">updateDefaultForConnectionV1</a>({ ...params }) -> boolean</code></summary>
6117
6115
  <dl>
6118
6116
  <dd>
6119
6117
 
6120
- **requestOptions:** `LineItemGroups.RequestOptions`
6118
+ #### 📝 Description
6119
+
6120
+ <dl>
6121
+ <dd>
6122
+
6123
+ <dl>
6124
+ <dd>
6125
+
6126
+ Sets or clears a rate sheet as the default for a connection. Pass rate_sheet_id to set a default, or omit it to clear the default. One default per service type per connection. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (bool)
6121
6127
 
6122
6128
  </dd>
6123
6129
  </dl>
6124
6130
  </dd>
6125
6131
  </dl>
6126
6132
 
6133
+ #### 🔌 Usage
6134
+
6135
+ <dl>
6136
+ <dd>
6137
+
6138
+ <dl>
6139
+ <dd>
6140
+
6141
+ ```typescript
6142
+ await client.billing.rateSheets.updateDefaultForConnectionV1({
6143
+ connection_id: "connection_id",
6144
+ service_type: "on_demand",
6145
+ rate_sheet_id: "rate_sheet_id",
6146
+ });
6147
+ ```
6148
+
6149
+ </dd>
6150
+ </dl>
6127
6151
  </dd>
6128
6152
  </dl>
6129
- </details>
6130
6153
 
6131
- ## Billing RateSheets
6154
+ #### ⚙️ Parameters
6132
6155
 
6133
- <details><summary><code>client.billing.rateSheets.<a href="/src/api/resources/billing/resources/rateSheets/client/Client.ts">getV1</a>(rateSheetId) -> Chrt.RateSheet1</code></summary>
6156
+ <dl>
6157
+ <dd>
6158
+
6159
+ <dl>
6160
+ <dd>
6161
+
6162
+ **request:** `Chrt.billing.RateSheetsUpdateDefaultForConnectionV1Request`
6163
+
6164
+ </dd>
6165
+ </dl>
6166
+
6167
+ <dl>
6168
+ <dd>
6169
+
6170
+ **requestOptions:** `RateSheets.RequestOptions`
6171
+
6172
+ </dd>
6173
+ </dl>
6174
+ </dd>
6175
+ </dl>
6176
+
6177
+ </dd>
6178
+ </dl>
6179
+ </details>
6180
+
6181
+ <details><summary><code>client.billing.rateSheets.<a href="/src/api/resources/billing/resources/rateSheets/client/Client.ts">updateDefaultForDriverV1</a>({ ...params }) -> boolean</code></summary>
6134
6182
  <dl>
6135
6183
  <dd>
6136
6184
 
@@ -6142,7 +6190,7 @@ await client.billing.lineItemGroups.adjustLineItemV1("line_item_group_id", {
6142
6190
  <dl>
6143
6191
  <dd>
6144
6192
 
6145
- Retrieves a rate sheet by ID. Only the owning org can fetch. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (RateSheet1)
6193
+ Sets or clears a rate sheet as the default for a driver. Pass rate_sheet_id to set a default, or omit it to clear the default. One default per service type per driver. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (bool)
6146
6194
 
6147
6195
  </dd>
6148
6196
  </dl>
@@ -6158,7 +6206,11 @@ Retrieves a rate sheet by ID. Only the owning org can fetch. | authz: allowed_or
6158
6206
  <dd>
6159
6207
 
6160
6208
  ```typescript
6161
- await client.billing.rateSheets.getV1("rate_sheet_id");
6209
+ await client.billing.rateSheets.updateDefaultForDriverV1({
6210
+ driver_id: "driver_id",
6211
+ service_type: "on_demand",
6212
+ rate_sheet_id: "rate_sheet_id",
6213
+ });
6162
6214
  ```
6163
6215
 
6164
6216
  </dd>
@@ -6174,7 +6226,7 @@ await client.billing.rateSheets.getV1("rate_sheet_id");
6174
6226
  <dl>
6175
6227
  <dd>
6176
6228
 
6177
- **rateSheetId:** `string`
6229
+ **request:** `Chrt.billing.RateSheetsUpdateDefaultForDriverV1Request`
6178
6230
 
6179
6231
  </dd>
6180
6232
  </dl>
@@ -6193,7 +6245,7 @@ await client.billing.rateSheets.getV1("rate_sheet_id");
6193
6245
  </dl>
6194
6246
  </details>
6195
6247
 
6196
- <details><summary><code>client.billing.rateSheets.<a href="/src/api/resources/billing/resources/rateSheets/client/Client.ts">updateV1</a>(rateSheetId, { ...params }) -> Chrt.RateSheet1</code></summary>
6248
+ <details><summary><code>client.billing.rateSheets.<a href="/src/api/resources/billing/resources/rateSheets/client/Client.ts">updateDefaultForOffChrtShipperV1</a>({ ...params }) -> boolean</code></summary>
6197
6249
  <dl>
6198
6250
  <dd>
6199
6251
 
@@ -6205,7 +6257,7 @@ await client.billing.rateSheets.getV1("rate_sheet_id");
6205
6257
  <dl>
6206
6258
  <dd>
6207
6259
 
6208
- Updates a rate sheet. Only name, comments, cargo_types, and vehicle_types can be changed. Use the archive endpoint for archiving. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | (RateSheetClientUpdate1) -> (RateSheet1)
6260
+ Sets or clears a rate sheet as the default for an off-chrt shipper. Pass rate_sheet_id to set a default, or omit it to clear the default. One default per service type per off-chrt shipper. | authz: allowed_org_types=[courier], min_org_role=operator | () -> (bool)
6209
6261
 
6210
6262
  </dd>
6211
6263
  </dl>
@@ -6221,7 +6273,11 @@ Updates a rate sheet. Only name, comments, cargo_types, and vehicle_types can be
6221
6273
  <dd>
6222
6274
 
6223
6275
  ```typescript
6224
- await client.billing.rateSheets.updateV1("rate_sheet_id");
6276
+ await client.billing.rateSheets.updateDefaultForOffChrtShipperV1({
6277
+ off_chrt_shipper_org_id: "off_chrt_shipper_org_id",
6278
+ service_type: "on_demand",
6279
+ rate_sheet_id: "rate_sheet_id",
6280
+ });
6225
6281
  ```
6226
6282
 
6227
6283
  </dd>
@@ -6237,7 +6293,1070 @@ await client.billing.rateSheets.updateV1("rate_sheet_id");
6237
6293
  <dl>
6238
6294
  <dd>
6239
6295
 
6240
- **rateSheetId:** `string`
6296
+ **request:** `Chrt.billing.RateSheetsUpdateDefaultForOffChrtShipperV1Request`
6297
+
6298
+ </dd>
6299
+ </dl>
6300
+
6301
+ <dl>
6302
+ <dd>
6303
+
6304
+ **requestOptions:** `RateSheets.RequestOptions`
6305
+
6306
+ </dd>
6307
+ </dl>
6308
+ </dd>
6309
+ </dl>
6310
+
6311
+ </dd>
6312
+ </dl>
6313
+ </details>
6314
+
6315
+ ## Billing Statements
6316
+
6317
+ <details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">getV1</a>(statementId) -> Chrt.Statement1</code></summary>
6318
+ <dl>
6319
+ <dd>
6320
+
6321
+ #### 📝 Description
6322
+
6323
+ <dl>
6324
+ <dd>
6325
+
6326
+ <dl>
6327
+ <dd>
6328
+
6329
+ Gets a statement by ID. | authz_personas=[statement_org_operators, statement_driver] | () -> (Statement1)
6330
+
6331
+ </dd>
6332
+ </dl>
6333
+ </dd>
6334
+ </dl>
6335
+
6336
+ #### 🔌 Usage
6337
+
6338
+ <dl>
6339
+ <dd>
6340
+
6341
+ <dl>
6342
+ <dd>
6343
+
6344
+ ```typescript
6345
+ await client.billing.statements.getV1("statement_id");
6346
+ ```
6347
+
6348
+ </dd>
6349
+ </dl>
6350
+ </dd>
6351
+ </dl>
6352
+
6353
+ #### ⚙️ Parameters
6354
+
6355
+ <dl>
6356
+ <dd>
6357
+
6358
+ <dl>
6359
+ <dd>
6360
+
6361
+ **statementId:** `string`
6362
+
6363
+ </dd>
6364
+ </dl>
6365
+
6366
+ <dl>
6367
+ <dd>
6368
+
6369
+ **requestOptions:** `Statements.RequestOptions`
6370
+
6371
+ </dd>
6372
+ </dl>
6373
+ </dd>
6374
+ </dl>
6375
+
6376
+ </dd>
6377
+ </dl>
6378
+ </details>
6379
+
6380
+ <details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">getByLigIdV1</a>(lineItemGroupId) -> Chrt.Statement1</code></summary>
6381
+ <dl>
6382
+ <dd>
6383
+
6384
+ #### 📝 Description
6385
+
6386
+ <dl>
6387
+ <dd>
6388
+
6389
+ <dl>
6390
+ <dd>
6391
+
6392
+ Gets a statement by its associated LineItemGroup ID. | authz_personas=[statement_org_operators, statement_driver] | () -> (Statement1)
6393
+
6394
+ </dd>
6395
+ </dl>
6396
+ </dd>
6397
+ </dl>
6398
+
6399
+ #### 🔌 Usage
6400
+
6401
+ <dl>
6402
+ <dd>
6403
+
6404
+ <dl>
6405
+ <dd>
6406
+
6407
+ ```typescript
6408
+ await client.billing.statements.getByLigIdV1("line_item_group_id");
6409
+ ```
6410
+
6411
+ </dd>
6412
+ </dl>
6413
+ </dd>
6414
+ </dl>
6415
+
6416
+ #### ⚙️ Parameters
6417
+
6418
+ <dl>
6419
+ <dd>
6420
+
6421
+ <dl>
6422
+ <dd>
6423
+
6424
+ **lineItemGroupId:** `string`
6425
+
6426
+ </dd>
6427
+ </dl>
6428
+
6429
+ <dl>
6430
+ <dd>
6431
+
6432
+ **requestOptions:** `Statements.RequestOptions`
6433
+
6434
+ </dd>
6435
+ </dl>
6436
+ </dd>
6437
+ </dl>
6438
+
6439
+ </dd>
6440
+ </dl>
6441
+ </details>
6442
+
6443
+ <details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">expandedRetrieveV1</a>({ ...params }) -> Chrt.StatementExpandedRes</code></summary>
6444
+ <dl>
6445
+ <dd>
6446
+
6447
+ #### 📝 Description
6448
+
6449
+ <dl>
6450
+ <dd>
6451
+
6452
+ <dl>
6453
+ <dd>
6454
+
6455
+ Retrieves a statement with its associated LineItemGroups expanded. | authz_personas=[statement_org_operators, statement_driver] | (StatementExpandedRetrieveReq) -> (StatementExpandedRes)
6456
+
6457
+ </dd>
6458
+ </dl>
6459
+ </dd>
6460
+ </dl>
6461
+
6462
+ #### 🔌 Usage
6463
+
6464
+ <dl>
6465
+ <dd>
6466
+
6467
+ <dl>
6468
+ <dd>
6469
+
6470
+ ```typescript
6471
+ await client.billing.statements.expandedRetrieveV1({
6472
+ statement_id: "statement_id",
6473
+ });
6474
+ ```
6475
+
6476
+ </dd>
6477
+ </dl>
6478
+ </dd>
6479
+ </dl>
6480
+
6481
+ #### ⚙️ Parameters
6482
+
6483
+ <dl>
6484
+ <dd>
6485
+
6486
+ <dl>
6487
+ <dd>
6488
+
6489
+ **request:** `Chrt.billing.StatementExpandedRetrieveReq`
6490
+
6491
+ </dd>
6492
+ </dl>
6493
+
6494
+ <dl>
6495
+ <dd>
6496
+
6497
+ **requestOptions:** `Statements.RequestOptions`
6498
+
6499
+ </dd>
6500
+ </dl>
6501
+ </dd>
6502
+ </dl>
6503
+
6504
+ </dd>
6505
+ </dl>
6506
+ </details>
6507
+
6508
+ <details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">listV1</a>({ ...params }) -> Chrt.StatementsListRes</code></summary>
6509
+ <dl>
6510
+ <dd>
6511
+
6512
+ #### 📝 Description
6513
+
6514
+ <dl>
6515
+ <dd>
6516
+
6517
+ <dl>
6518
+ <dd>
6519
+
6520
+ Lists statements with filtering, sorting, and pagination. | authz_personas=[statement_org_operators, statement_driver] | () -> (StatementsListRes)
6521
+
6522
+ </dd>
6523
+ </dl>
6524
+ </dd>
6525
+ </dl>
6526
+
6527
+ #### 🔌 Usage
6528
+
6529
+ <dl>
6530
+ <dd>
6531
+
6532
+ <dl>
6533
+ <dd>
6534
+
6535
+ ```typescript
6536
+ await client.billing.statements.listV1({
6537
+ sort_by: "amount",
6538
+ sort_order: "asc",
6539
+ page: 1,
6540
+ page_size: 1,
6541
+ filter_settlement_type: "stripe_connect",
6542
+ filter_payment_origin_org_id: "filter_payment_origin_org_id",
6543
+ filter_payment_destination_org_id: "filter_payment_destination_org_id",
6544
+ filter_owned_by_org_id: "filter_owned_by_org_id",
6545
+ filter_staged_at_timestamp_gte: "2024-01-15T09:30:00Z",
6546
+ filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
6547
+ filter_opened_at_timestamp_gte: "2024-01-15T09:30:00Z",
6548
+ filter_opened_at_timestamp_lte: "2024-01-15T09:30:00Z",
6549
+ filter_paid_at_timestamp_gte: "2024-01-15T09:30:00Z",
6550
+ filter_paid_at_timestamp_lte: "2024-01-15T09:30:00Z",
6551
+ });
6552
+ ```
6553
+
6554
+ </dd>
6555
+ </dl>
6556
+ </dd>
6557
+ </dl>
6558
+
6559
+ #### ⚙️ Parameters
6560
+
6561
+ <dl>
6562
+ <dd>
6563
+
6564
+ <dl>
6565
+ <dd>
6566
+
6567
+ **request:** `Chrt.billing.StatementsListV1Request`
6568
+
6569
+ </dd>
6570
+ </dl>
6571
+
6572
+ <dl>
6573
+ <dd>
6574
+
6575
+ **requestOptions:** `Statements.RequestOptions`
6576
+
6577
+ </dd>
6578
+ </dl>
6579
+ </dd>
6580
+ </dl>
6581
+
6582
+ </dd>
6583
+ </dl>
6584
+ </details>
6585
+
6586
+ <details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">createV1</a>({ ...params }) -> Chrt.Statement1</code></summary>
6587
+ <dl>
6588
+ <dd>
6589
+
6590
+ #### 📝 Description
6591
+
6592
+ <dl>
6593
+ <dd>
6594
+
6595
+ <dl>
6596
+ <dd>
6597
+
6598
+ Creates a new statement without LIG IDs, starting in STAGED status. Requires payment vector, origin, and destination. | authz: org_type=[courier, forwarder], min_org_role=operator | (CreateStatementReq) -> (Statement1)
6599
+
6600
+ </dd>
6601
+ </dl>
6602
+ </dd>
6603
+ </dl>
6604
+
6605
+ #### 🔌 Usage
6606
+
6607
+ <dl>
6608
+ <dd>
6609
+
6610
+ <dl>
6611
+ <dd>
6612
+
6613
+ ```typescript
6614
+ await client.billing.statements.createV1({
6615
+ payment_vector_type: "shipper_pay_forwarder",
6616
+ settlement_type: "stripe_connect",
6617
+ });
6618
+ ```
6619
+
6620
+ </dd>
6621
+ </dl>
6622
+ </dd>
6623
+ </dl>
6624
+
6625
+ #### ⚙️ Parameters
6626
+
6627
+ <dl>
6628
+ <dd>
6629
+
6630
+ <dl>
6631
+ <dd>
6632
+
6633
+ **request:** `Chrt.billing.CreateStatementReq`
6634
+
6635
+ </dd>
6636
+ </dl>
6637
+
6638
+ <dl>
6639
+ <dd>
6640
+
6641
+ **requestOptions:** `Statements.RequestOptions`
6642
+
6643
+ </dd>
6644
+ </dl>
6645
+ </dd>
6646
+ </dl>
6647
+
6648
+ </dd>
6649
+ </dl>
6650
+ </details>
6651
+
6652
+ <details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">deleteV1</a>(statementId) -> boolean</code></summary>
6653
+ <dl>
6654
+ <dd>
6655
+
6656
+ #### 📝 Description
6657
+
6658
+ <dl>
6659
+ <dd>
6660
+
6661
+ <dl>
6662
+ <dd>
6663
+
6664
+ Deletes a statement. Only allowed if statement has no LineItemGroup IDs. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators] | () -> (bool)
6665
+
6666
+ </dd>
6667
+ </dl>
6668
+ </dd>
6669
+ </dl>
6670
+
6671
+ #### 🔌 Usage
6672
+
6673
+ <dl>
6674
+ <dd>
6675
+
6676
+ <dl>
6677
+ <dd>
6678
+
6679
+ ```typescript
6680
+ await client.billing.statements.deleteV1("statement_id");
6681
+ ```
6682
+
6683
+ </dd>
6684
+ </dl>
6685
+ </dd>
6686
+ </dl>
6687
+
6688
+ #### ⚙️ Parameters
6689
+
6690
+ <dl>
6691
+ <dd>
6692
+
6693
+ <dl>
6694
+ <dd>
6695
+
6696
+ **statementId:** `string`
6697
+
6698
+ </dd>
6699
+ </dl>
6700
+
6701
+ <dl>
6702
+ <dd>
6703
+
6704
+ **requestOptions:** `Statements.RequestOptions`
6705
+
6706
+ </dd>
6707
+ </dl>
6708
+ </dd>
6709
+ </dl>
6710
+
6711
+ </dd>
6712
+ </dl>
6713
+ </details>
6714
+
6715
+ <details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">updateSettlementTypeV1</a>(statementId, { ...params }) -> Chrt.Statement1</code></summary>
6716
+ <dl>
6717
+ <dd>
6718
+
6719
+ #### 📝 Description
6720
+
6721
+ <dl>
6722
+ <dd>
6723
+
6724
+ <dl>
6725
+ <dd>
6726
+
6727
+ Updates the settlement type of a statement. Statement must be in STAGED status. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators], statement_status=STAGED | (SettlementTypeEnum1) -> (Statement1)
6728
+
6729
+ </dd>
6730
+ </dl>
6731
+ </dd>
6732
+ </dl>
6733
+
6734
+ #### 🔌 Usage
6735
+
6736
+ <dl>
6737
+ <dd>
6738
+
6739
+ <dl>
6740
+ <dd>
6741
+
6742
+ ```typescript
6743
+ await client.billing.statements.updateSettlementTypeV1("statement_id", {
6744
+ settlement_type: "stripe_connect",
6745
+ });
6746
+ ```
6747
+
6748
+ </dd>
6749
+ </dl>
6750
+ </dd>
6751
+ </dl>
6752
+
6753
+ #### ⚙️ Parameters
6754
+
6755
+ <dl>
6756
+ <dd>
6757
+
6758
+ <dl>
6759
+ <dd>
6760
+
6761
+ **statementId:** `string`
6762
+
6763
+ </dd>
6764
+ </dl>
6765
+
6766
+ <dl>
6767
+ <dd>
6768
+
6769
+ **request:** `Chrt.billing.BodyStatementsPatchUpdateSettlementTypeV1BillingUpdateSettlementTypeV1StatementIdPatch`
6770
+
6771
+ </dd>
6772
+ </dl>
6773
+
6774
+ <dl>
6775
+ <dd>
6776
+
6777
+ **requestOptions:** `Statements.RequestOptions`
6778
+
6779
+ </dd>
6780
+ </dl>
6781
+ </dd>
6782
+ </dl>
6783
+
6784
+ </dd>
6785
+ </dl>
6786
+ </details>
6787
+
6788
+ <details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">updateOffChrtSettlementStateV1</a>(statementId, { ...params }) -> Chrt.Statement1</code></summary>
6789
+ <dl>
6790
+ <dd>
6791
+
6792
+ #### 📝 Description
6793
+
6794
+ <dl>
6795
+ <dd>
6796
+
6797
+ <dl>
6798
+ <dd>
6799
+
6800
+ Updates the status of an off-CHRT settlement statement. Used to manually transition OFF_CHRT statements between STAGED, OPEN, PAID, and VOID. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators] | (StatementStatusEnum1) -> (Statement1)
6801
+
6802
+ </dd>
6803
+ </dl>
6804
+ </dd>
6805
+ </dl>
6806
+
6807
+ #### 🔌 Usage
6808
+
6809
+ <dl>
6810
+ <dd>
6811
+
6812
+ <dl>
6813
+ <dd>
6814
+
6815
+ ```typescript
6816
+ await client.billing.statements.updateOffChrtSettlementStateV1("statement_id", {
6817
+ new_status: "staged",
6818
+ });
6819
+ ```
6820
+
6821
+ </dd>
6822
+ </dl>
6823
+ </dd>
6824
+ </dl>
6825
+
6826
+ #### ⚙️ Parameters
6827
+
6828
+ <dl>
6829
+ <dd>
6830
+
6831
+ <dl>
6832
+ <dd>
6833
+
6834
+ **statementId:** `string`
6835
+
6836
+ </dd>
6837
+ </dl>
6838
+
6839
+ <dl>
6840
+ <dd>
6841
+
6842
+ **request:** `Chrt.billing.BodyStatementsPatchUpdateOffChrtSettlementStateV1BillingUpdateOffChrtSettlementStateV1StatementIdPatch`
6843
+
6844
+ </dd>
6845
+ </dl>
6846
+
6847
+ <dl>
6848
+ <dd>
6849
+
6850
+ **requestOptions:** `Statements.RequestOptions`
6851
+
6852
+ </dd>
6853
+ </dl>
6854
+ </dd>
6855
+ </dl>
6856
+
6857
+ </dd>
6858
+ </dl>
6859
+ </details>
6860
+
6861
+ <details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">openInvoiceV1</a>(statementId, { ...params }) -> Chrt.Statement1</code></summary>
6862
+ <dl>
6863
+ <dd>
6864
+
6865
+ #### 📝 Description
6866
+
6867
+ <dl>
6868
+ <dd>
6869
+
6870
+ <dl>
6871
+ <dd>
6872
+
6873
+ Opens a Stripe Connect invoice for a statement and attempt to send via email. Org must have a Stripe Connect account. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators], statement_status=STAGED, line_item_groups_status=FINALIZED | (OpenInvoiceReq) -> (Statement1)
6874
+
6875
+ </dd>
6876
+ </dl>
6877
+ </dd>
6878
+ </dl>
6879
+
6880
+ #### 🔌 Usage
6881
+
6882
+ <dl>
6883
+ <dd>
6884
+
6885
+ <dl>
6886
+ <dd>
6887
+
6888
+ ```typescript
6889
+ await client.billing.statements.openInvoiceV1("statement_id");
6890
+ ```
6891
+
6892
+ </dd>
6893
+ </dl>
6894
+ </dd>
6895
+ </dl>
6896
+
6897
+ #### ⚙️ Parameters
6898
+
6899
+ <dl>
6900
+ <dd>
6901
+
6902
+ <dl>
6903
+ <dd>
6904
+
6905
+ **statementId:** `string`
6906
+
6907
+ </dd>
6908
+ </dl>
6909
+
6910
+ <dl>
6911
+ <dd>
6912
+
6913
+ **request:** `Chrt.billing.OpenInvoiceReq`
6914
+
6915
+ </dd>
6916
+ </dl>
6917
+
6918
+ <dl>
6919
+ <dd>
6920
+
6921
+ **requestOptions:** `Statements.RequestOptions`
6922
+
6923
+ </dd>
6924
+ </dl>
6925
+ </dd>
6926
+ </dl>
6927
+
6928
+ </dd>
6929
+ </dl>
6930
+ </details>
6931
+
6932
+ <details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">syncInvoiceV1</a>(statementId) -> Chrt.Statement1</code></summary>
6933
+ <dl>
6934
+ <dd>
6935
+
6936
+ #### 📝 Description
6937
+
6938
+ <dl>
6939
+ <dd>
6940
+
6941
+ <dl>
6942
+ <dd>
6943
+
6944
+ Syncs invoice state from Stripe Connect to the Statement and LineItemGroups. The webhook usually keeps invoices up to date, but users can manually trigger a sync. | authz: org_type=[courier, forwarder, shipper], min_org_role=operator, authz_personas=[statement_org_operators] | () -> (Statement1)
6945
+
6946
+ </dd>
6947
+ </dl>
6948
+ </dd>
6949
+ </dl>
6950
+
6951
+ #### 🔌 Usage
6952
+
6953
+ <dl>
6954
+ <dd>
6955
+
6956
+ <dl>
6957
+ <dd>
6958
+
6959
+ ```typescript
6960
+ await client.billing.statements.syncInvoiceV1("statement_id");
6961
+ ```
6962
+
6963
+ </dd>
6964
+ </dl>
6965
+ </dd>
6966
+ </dl>
6967
+
6968
+ #### ⚙️ Parameters
6969
+
6970
+ <dl>
6971
+ <dd>
6972
+
6973
+ <dl>
6974
+ <dd>
6975
+
6976
+ **statementId:** `string`
6977
+
6978
+ </dd>
6979
+ </dl>
6980
+
6981
+ <dl>
6982
+ <dd>
6983
+
6984
+ **requestOptions:** `Statements.RequestOptions`
6985
+
6986
+ </dd>
6987
+ </dl>
6988
+ </dd>
6989
+ </dl>
6990
+
6991
+ </dd>
6992
+ </dl>
6993
+ </details>
6994
+
6995
+ <details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">voidInvoiceV1</a>(statementId) -> Chrt.Statement1</code></summary>
6996
+ <dl>
6997
+ <dd>
6998
+
6999
+ #### 📝 Description
7000
+
7001
+ <dl>
7002
+ <dd>
7003
+
7004
+ <dl>
7005
+ <dd>
7006
+
7007
+ Voids a Stripe Connect invoice. Statement reverts to STAGED and LIGs revert to FINALIZED. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators], statement_status=OPEN | () -> (Statement1)
7008
+
7009
+ </dd>
7010
+ </dl>
7011
+ </dd>
7012
+ </dl>
7013
+
7014
+ #### 🔌 Usage
7015
+
7016
+ <dl>
7017
+ <dd>
7018
+
7019
+ <dl>
7020
+ <dd>
7021
+
7022
+ ```typescript
7023
+ await client.billing.statements.voidInvoiceV1("statement_id");
7024
+ ```
7025
+
7026
+ </dd>
7027
+ </dl>
7028
+ </dd>
7029
+ </dl>
7030
+
7031
+ #### ⚙️ Parameters
7032
+
7033
+ <dl>
7034
+ <dd>
7035
+
7036
+ <dl>
7037
+ <dd>
7038
+
7039
+ **statementId:** `string`
7040
+
7041
+ </dd>
7042
+ </dl>
7043
+
7044
+ <dl>
7045
+ <dd>
7046
+
7047
+ **requestOptions:** `Statements.RequestOptions`
7048
+
7049
+ </dd>
7050
+ </dl>
7051
+ </dd>
7052
+ </dl>
7053
+
7054
+ </dd>
7055
+ </dl>
7056
+ </details>
7057
+
7058
+ ## Billing StripeConnect
7059
+
7060
+ <details><summary><code>client.billing.stripeConnect.<a href="/src/api/resources/billing/resources/stripeConnect/client/Client.ts">createAccountV1</a>() -> Chrt.CreateStripeConnectAccountRes</code></summary>
7061
+ <dl>
7062
+ <dd>
7063
+
7064
+ #### 📝 Description
7065
+
7066
+ <dl>
7067
+ <dd>
7068
+
7069
+ <dl>
7070
+ <dd>
7071
+
7072
+ Creates a Stripe Connect account for the organization to receive payments. Idempotent - returns existing account if already created. | () -> (CreateStripeConnectAccountRes)
7073
+
7074
+ </dd>
7075
+ </dl>
7076
+ </dd>
7077
+ </dl>
7078
+
7079
+ #### 🔌 Usage
7080
+
7081
+ <dl>
7082
+ <dd>
7083
+
7084
+ <dl>
7085
+ <dd>
7086
+
7087
+ ```typescript
7088
+ await client.billing.stripeConnect.createAccountV1();
7089
+ ```
7090
+
7091
+ </dd>
7092
+ </dl>
7093
+ </dd>
7094
+ </dl>
7095
+
7096
+ #### ⚙️ Parameters
7097
+
7098
+ <dl>
7099
+ <dd>
7100
+
7101
+ <dl>
7102
+ <dd>
7103
+
7104
+ **requestOptions:** `StripeConnect.RequestOptions`
7105
+
7106
+ </dd>
7107
+ </dl>
7108
+ </dd>
7109
+ </dl>
7110
+
7111
+ </dd>
7112
+ </dl>
7113
+ </details>
7114
+
7115
+ <details><summary><code>client.billing.stripeConnect.<a href="/src/api/resources/billing/resources/stripeConnect/client/Client.ts">onboardingLinkV1</a>() -> Chrt.StripeConnectAccountOnboardingLinkRes</code></summary>
7116
+ <dl>
7117
+ <dd>
7118
+
7119
+ #### 📝 Description
7120
+
7121
+ <dl>
7122
+ <dd>
7123
+
7124
+ <dl>
7125
+ <dd>
7126
+
7127
+ Creates an onboarding link for a Stripe Connect account. Used to complete or update account setup. | () -> (StripeConnectAccountOnboardingLinkRes)
7128
+
7129
+ </dd>
7130
+ </dl>
7131
+ </dd>
7132
+ </dl>
7133
+
7134
+ #### 🔌 Usage
7135
+
7136
+ <dl>
7137
+ <dd>
7138
+
7139
+ <dl>
7140
+ <dd>
7141
+
7142
+ ```typescript
7143
+ await client.billing.stripeConnect.onboardingLinkV1();
7144
+ ```
7145
+
7146
+ </dd>
7147
+ </dl>
7148
+ </dd>
7149
+ </dl>
7150
+
7151
+ #### ⚙️ Parameters
7152
+
7153
+ <dl>
7154
+ <dd>
7155
+
7156
+ <dl>
7157
+ <dd>
7158
+
7159
+ **requestOptions:** `StripeConnect.RequestOptions`
7160
+
7161
+ </dd>
7162
+ </dl>
7163
+ </dd>
7164
+ </dl>
7165
+
7166
+ </dd>
7167
+ </dl>
7168
+ </details>
7169
+
7170
+ ## Billing LineItemGroups AdHoc
7171
+
7172
+ <details><summary><code>client.billing.lineItemGroups.adHoc.<a href="/src/api/resources/billing/resources/lineItemGroups/resources/adHoc/client/Client.ts">createV1</a>({ ...params }) -> Chrt.LineItemGroup1</code></summary>
7173
+ <dl>
7174
+ <dd>
7175
+
7176
+ #### 📝 Description
7177
+
7178
+ <dl>
7179
+ <dd>
7180
+
7181
+ <dl>
7182
+ <dd>
7183
+
7184
+ Creates an ad-hoc line item group (not associated with a TaskGroup). Starts as ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator | (CreateAdHocLineItemGroupReq) -> (LineItemGroup1)
7185
+
7186
+ </dd>
7187
+ </dl>
7188
+ </dd>
7189
+ </dl>
7190
+
7191
+ #### 🔌 Usage
7192
+
7193
+ <dl>
7194
+ <dd>
7195
+
7196
+ <dl>
7197
+ <dd>
7198
+
7199
+ ```typescript
7200
+ await client.billing.lineItemGroups.adHoc.createV1({
7201
+ payment_vector_type: "shipper_pay_forwarder",
7202
+ settlement_type: "stripe_connect",
7203
+ });
7204
+ ```
7205
+
7206
+ </dd>
7207
+ </dl>
7208
+ </dd>
7209
+ </dl>
7210
+
7211
+ #### ⚙️ Parameters
7212
+
7213
+ <dl>
7214
+ <dd>
7215
+
7216
+ <dl>
7217
+ <dd>
7218
+
7219
+ **request:** `Chrt.billing.lineItemGroups.CreateAdHocLineItemGroupReq`
7220
+
7221
+ </dd>
7222
+ </dl>
7223
+
7224
+ <dl>
7225
+ <dd>
7226
+
7227
+ **requestOptions:** `AdHoc.RequestOptions`
7228
+
7229
+ </dd>
7230
+ </dl>
7231
+ </dd>
7232
+ </dl>
7233
+
7234
+ </dd>
7235
+ </dl>
7236
+ </details>
7237
+
7238
+ <details><summary><code>client.billing.lineItemGroups.adHoc.<a href="/src/api/resources/billing/resources/lineItemGroups/resources/adHoc/client/Client.ts">addLineItemV1</a>(lineItemGroupId, { ...params }) -> Chrt.LineItemGroup1</code></summary>
7239
+ <dl>
7240
+ <dd>
7241
+
7242
+ #### 📝 Description
7243
+
7244
+ <dl>
7245
+ <dd>
7246
+
7247
+ <dl>
7248
+ <dd>
7249
+
7250
+ Adds a line item to an ad-hoc line item group. LIG must be ad-hoc (task_group_id is None) and ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | (LineItemClientCreate1) -> (LineItemGroup1)
7251
+
7252
+ </dd>
7253
+ </dl>
7254
+ </dd>
7255
+ </dl>
7256
+
7257
+ #### 🔌 Usage
7258
+
7259
+ <dl>
7260
+ <dd>
7261
+
7262
+ <dl>
7263
+ <dd>
7264
+
7265
+ ```typescript
7266
+ await client.billing.lineItemGroups.adHoc.addLineItemV1("line_item_group_id", {
7267
+ item: "base_rate",
7268
+ quantity: 1.1,
7269
+ rate: 1.1,
7270
+ });
7271
+ ```
7272
+
7273
+ </dd>
7274
+ </dl>
7275
+ </dd>
7276
+ </dl>
7277
+
7278
+ #### ⚙️ Parameters
7279
+
7280
+ <dl>
7281
+ <dd>
7282
+
7283
+ <dl>
7284
+ <dd>
7285
+
7286
+ **lineItemGroupId:** `string`
7287
+
7288
+ </dd>
7289
+ </dl>
7290
+
7291
+ <dl>
7292
+ <dd>
7293
+
7294
+ **request:** `Chrt.billing.lineItemGroups.LineItemClientCreate1`
7295
+
7296
+ </dd>
7297
+ </dl>
7298
+
7299
+ <dl>
7300
+ <dd>
7301
+
7302
+ **requestOptions:** `AdHoc.RequestOptions`
7303
+
7304
+ </dd>
7305
+ </dl>
7306
+ </dd>
7307
+ </dl>
7308
+
7309
+ </dd>
7310
+ </dl>
7311
+ </details>
7312
+
7313
+ <details><summary><code>client.billing.lineItemGroups.adHoc.<a href="/src/api/resources/billing/resources/lineItemGroups/resources/adHoc/client/Client.ts">removeLineItemV1</a>(lineItemGroupId, { ...params }) -> Chrt.LineItemGroup1</code></summary>
7314
+ <dl>
7315
+ <dd>
7316
+
7317
+ #### 📝 Description
7318
+
7319
+ <dl>
7320
+ <dd>
7321
+
7322
+ <dl>
7323
+ <dd>
7324
+
7325
+ Removes a line item from an ad-hoc line item group. LIG must be ad-hoc (task_group_id is None) and ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | (line_item_uuid_str) -> (LineItemGroup1)
7326
+
7327
+ </dd>
7328
+ </dl>
7329
+ </dd>
7330
+ </dl>
7331
+
7332
+ #### 🔌 Usage
7333
+
7334
+ <dl>
7335
+ <dd>
7336
+
7337
+ <dl>
7338
+ <dd>
7339
+
7340
+ ```typescript
7341
+ await client.billing.lineItemGroups.adHoc.removeLineItemV1("line_item_group_id", {
7342
+ line_item_uuid_str: "line_item_uuid_str",
7343
+ });
7344
+ ```
7345
+
7346
+ </dd>
7347
+ </dl>
7348
+ </dd>
7349
+ </dl>
7350
+
7351
+ #### ⚙️ Parameters
7352
+
7353
+ <dl>
7354
+ <dd>
7355
+
7356
+ <dl>
7357
+ <dd>
7358
+
7359
+ **lineItemGroupId:** `string`
6241
7360
 
6242
7361
  </dd>
6243
7362
  </dl>
@@ -6245,7 +7364,7 @@ await client.billing.rateSheets.updateV1("rate_sheet_id");
6245
7364
  <dl>
6246
7365
  <dd>
6247
7366
 
6248
- **request:** `Chrt.billing.RateSheetClientUpdate1`
7367
+ **request:** `Chrt.billing.lineItemGroups.AdHocRemoveLineItemV1Request`
6249
7368
 
6250
7369
  </dd>
6251
7370
  </dl>
@@ -6253,7 +7372,7 @@ await client.billing.rateSheets.updateV1("rate_sheet_id");
6253
7372
  <dl>
6254
7373
  <dd>
6255
7374
 
6256
- **requestOptions:** `RateSheets.RequestOptions`
7375
+ **requestOptions:** `AdHoc.RequestOptions`
6257
7376
 
6258
7377
  </dd>
6259
7378
  </dl>
@@ -6264,7 +7383,7 @@ await client.billing.rateSheets.updateV1("rate_sheet_id");
6264
7383
  </dl>
6265
7384
  </details>
6266
7385
 
6267
- <details><summary><code>client.billing.rateSheets.<a href="/src/api/resources/billing/resources/rateSheets/client/Client.ts">listByOrgV1</a>({ ...params }) -> Chrt.RateSheetListResponse</code></summary>
7386
+ <details><summary><code>client.billing.lineItemGroups.adHoc.<a href="/src/api/resources/billing/resources/lineItemGroups/resources/adHoc/client/Client.ts">deleteV1</a>(lineItemGroupId) -> boolean</code></summary>
6268
7387
  <dl>
6269
7388
  <dd>
6270
7389
 
@@ -6276,7 +7395,7 @@ await client.billing.rateSheets.updateV1("rate_sheet_id");
6276
7395
  <dl>
6277
7396
  <dd>
6278
7397
 
6279
- Lists rate sheets for the caller's organization with filtering, sorting, and pagination. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (RateSheetListResponse)
7398
+ Deletes an ad-hoc line item group. LIG must be ad-hoc (task_group_id is None) and ADJUSTABLE or FINALIZED. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | () -> (bool)
6280
7399
 
6281
7400
  </dd>
6282
7401
  </dl>
@@ -6292,17 +7411,7 @@ Lists rate sheets for the caller's organization with filtering, sorting, and pag
6292
7411
  <dd>
6293
7412
 
6294
7413
  ```typescript
6295
- await client.billing.rateSheets.listByOrgV1({
6296
- sort_by: "id",
6297
- sort_order: "ascending",
6298
- page: 1,
6299
- page_size: 1,
6300
- filter_archived: true,
6301
- filter_payment_vector_type: "shipper_pay_forwarder",
6302
- filter_service_type: "on_demand",
6303
- filter_cargo_type: "spare_parts",
6304
- filter_vehicle_type: "sedan",
6305
- });
7414
+ await client.billing.lineItemGroups.adHoc.deleteV1("line_item_group_id");
6306
7415
  ```
6307
7416
 
6308
7417
  </dd>
@@ -6318,7 +7427,7 @@ await client.billing.rateSheets.listByOrgV1({
6318
7427
  <dl>
6319
7428
  <dd>
6320
7429
 
6321
- **request:** `Chrt.billing.RateSheetsListByOrgV1Request`
7430
+ **lineItemGroupId:** `string`
6322
7431
 
6323
7432
  </dd>
6324
7433
  </dl>
@@ -6326,7 +7435,7 @@ await client.billing.rateSheets.listByOrgV1({
6326
7435
  <dl>
6327
7436
  <dd>
6328
7437
 
6329
- **requestOptions:** `RateSheets.RequestOptions`
7438
+ **requestOptions:** `AdHoc.RequestOptions`
6330
7439
 
6331
7440
  </dd>
6332
7441
  </dl>
@@ -6337,7 +7446,9 @@ await client.billing.rateSheets.listByOrgV1({
6337
7446
  </dl>
6338
7447
  </details>
6339
7448
 
6340
- <details><summary><code>client.billing.rateSheets.<a href="/src/api/resources/billing/resources/rateSheets/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
7449
+ ## Billing LineItemGroups Messages
7450
+
7451
+ <details><summary><code>client.billing.lineItemGroups.messages.<a href="/src/api/resources/billing/resources/lineItemGroups/resources/messages/client/Client.ts">addV1</a>(lineItemGroupId, { ...params }) -> boolean</code></summary>
6341
7452
  <dl>
6342
7453
  <dd>
6343
7454
 
@@ -6349,7 +7460,7 @@ await client.billing.rateSheets.listByOrgV1({
6349
7460
  <dl>
6350
7461
  <dd>
6351
7462
 
6352
- Creates a rate sheet. Couriers and forwarders only. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | (RateSheetClientCreate1) -> (PydanticObjectId)
7463
+ Adds a message to a line item group's message log. | authz_personas=[lig_org_operators, lig_driver] | (AddLineItemGroupMessageReq) -> (bool)
6353
7464
 
6354
7465
  </dd>
6355
7466
  </dl>
@@ -6365,10 +7476,8 @@ Creates a rate sheet. Couriers and forwarders only. | authz: allowed_org_types=[
6365
7476
  <dd>
6366
7477
 
6367
7478
  ```typescript
6368
- await client.billing.rateSheets.createV1({
6369
- payment_vector_type: "shipper_pay_forwarder",
6370
- schema_version: 1,
6371
- service_type: "on_demand",
7479
+ await client.billing.lineItemGroups.messages.addV1("line_item_group_id", {
7480
+ message: "message",
6372
7481
  });
6373
7482
  ```
6374
7483
 
@@ -6385,7 +7494,7 @@ await client.billing.rateSheets.createV1({
6385
7494
  <dl>
6386
7495
  <dd>
6387
7496
 
6388
- **request:** `Chrt.billing.RateSheetClientCreate1`
7497
+ **lineItemGroupId:** `string`
6389
7498
 
6390
7499
  </dd>
6391
7500
  </dl>
@@ -6393,7 +7502,15 @@ await client.billing.rateSheets.createV1({
6393
7502
  <dl>
6394
7503
  <dd>
6395
7504
 
6396
- **requestOptions:** `RateSheets.RequestOptions`
7505
+ **request:** `Chrt.billing.lineItemGroups.AddLineItemGroupMessageReq`
7506
+
7507
+ </dd>
7508
+ </dl>
7509
+
7510
+ <dl>
7511
+ <dd>
7512
+
7513
+ **requestOptions:** `Messages.RequestOptions`
6397
7514
 
6398
7515
  </dd>
6399
7516
  </dl>
@@ -6404,7 +7521,9 @@ await client.billing.rateSheets.createV1({
6404
7521
  </dl>
6405
7522
  </details>
6406
7523
 
6407
- <details><summary><code>client.billing.rateSheets.<a href="/src/api/resources/billing/resources/rateSheets/client/Client.ts">archiveV1</a>(rateSheetId, { ...params }) -> boolean</code></summary>
7524
+ ## Billing LineItemGroups S3Objects
7525
+
7526
+ <details><summary><code>client.billing.lineItemGroups.s3Objects.<a href="/src/api/resources/billing/resources/lineItemGroups/resources/s3Objects/client/Client.ts">getS3ObjectMetadataV1</a>(lineItemGroupS3ObjectMetadataId) -> Chrt.LineItemGroupS3ObjectMetadata1</code></summary>
6408
7527
  <dl>
6409
7528
  <dd>
6410
7529
 
@@ -6416,7 +7535,7 @@ await client.billing.rateSheets.createV1({
6416
7535
  <dl>
6417
7536
  <dd>
6418
7537
 
6419
- Archives or unarchives a rate sheet. When archiving, automatically removes the rate sheet from all default assignments (OrgPrivateData, Connections, Drivers). | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (bool)
7538
+ Retrieves the metadata for a line item group S3 object, including blurhash for placeholder loading. | authz_personas=[lig_org_operators, lig_driver] | () -> (LineItemGroupS3ObjectMetadata1)
6420
7539
 
6421
7540
  </dd>
6422
7541
  </dl>
@@ -6432,9 +7551,7 @@ Archives or unarchives a rate sheet. When archiving, automatically removes the r
6432
7551
  <dd>
6433
7552
 
6434
7553
  ```typescript
6435
- await client.billing.rateSheets.archiveV1("rate_sheet_id", {
6436
- archive: true,
6437
- });
7554
+ await client.billing.lineItemGroups.s3Objects.getS3ObjectMetadataV1("line_item_group_s3_object_metadata_id");
6438
7555
  ```
6439
7556
 
6440
7557
  </dd>
@@ -6450,15 +7567,7 @@ await client.billing.rateSheets.archiveV1("rate_sheet_id", {
6450
7567
  <dl>
6451
7568
  <dd>
6452
7569
 
6453
- **rateSheetId:** `string`
6454
-
6455
- </dd>
6456
- </dl>
6457
-
6458
- <dl>
6459
- <dd>
6460
-
6461
- **request:** `Chrt.billing.RateSheetsArchiveV1Request`
7570
+ **lineItemGroupS3ObjectMetadataId:** `string`
6462
7571
 
6463
7572
  </dd>
6464
7573
  </dl>
@@ -6466,7 +7575,7 @@ await client.billing.rateSheets.archiveV1("rate_sheet_id", {
6466
7575
  <dl>
6467
7576
  <dd>
6468
7577
 
6469
- **requestOptions:** `RateSheets.RequestOptions`
7578
+ **requestOptions:** `S3Objects.RequestOptions`
6470
7579
 
6471
7580
  </dd>
6472
7581
  </dl>
@@ -6477,7 +7586,7 @@ await client.billing.rateSheets.archiveV1("rate_sheet_id", {
6477
7586
  </dl>
6478
7587
  </details>
6479
7588
 
6480
- <details><summary><code>client.billing.rateSheets.<a href="/src/api/resources/billing/resources/rateSheets/client/Client.ts">updateOrgDefaultForServiceTypeV1</a>({ ...params }) -> boolean</code></summary>
7589
+ <details><summary><code>client.billing.lineItemGroups.s3Objects.<a href="/src/api/resources/billing/resources/lineItemGroups/resources/s3Objects/client/Client.ts">getV1</a>(lineItemGroupS3ObjectMetadataId) -> core.BinaryResponse</code></summary>
6481
7590
  <dl>
6482
7591
  <dd>
6483
7592
 
@@ -6489,7 +7598,7 @@ await client.billing.rateSheets.archiveV1("rate_sheet_id", {
6489
7598
  <dl>
6490
7599
  <dd>
6491
7600
 
6492
- Sets or clears the org's default rate sheet for a payment vector type and service type. Pass rate_sheet_id to set a default, or omit it to clear the default. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (bool)
7601
+ Streams a line item group S3 object file from storage. | authz_personas=[lig_org_operators, lig_driver] | () -> (binary)
6493
7602
 
6494
7603
  </dd>
6495
7604
  </dl>
@@ -6505,11 +7614,7 @@ Sets or clears the org's default rate sheet for a payment vector type and servic
6505
7614
  <dd>
6506
7615
 
6507
7616
  ```typescript
6508
- await client.billing.rateSheets.updateOrgDefaultForServiceTypeV1({
6509
- payment_vector_type: "shipper_pay_forwarder",
6510
- service_type: "on_demand",
6511
- rate_sheet_id: "rate_sheet_id",
6512
- });
7617
+ await client.billing.lineItemGroups.s3Objects.getV1("line_item_group_s3_object_metadata_id");
6513
7618
  ```
6514
7619
 
6515
7620
  </dd>
@@ -6525,7 +7630,7 @@ await client.billing.rateSheets.updateOrgDefaultForServiceTypeV1({
6525
7630
  <dl>
6526
7631
  <dd>
6527
7632
 
6528
- **request:** `Chrt.billing.RateSheetsUpdateOrgDefaultForServiceTypeV1Request`
7633
+ **lineItemGroupS3ObjectMetadataId:** `string`
6529
7634
 
6530
7635
  </dd>
6531
7636
  </dl>
@@ -6533,7 +7638,7 @@ await client.billing.rateSheets.updateOrgDefaultForServiceTypeV1({
6533
7638
  <dl>
6534
7639
  <dd>
6535
7640
 
6536
- **requestOptions:** `RateSheets.RequestOptions`
7641
+ **requestOptions:** `S3Objects.RequestOptions`
6537
7642
 
6538
7643
  </dd>
6539
7644
  </dl>
@@ -6544,7 +7649,7 @@ await client.billing.rateSheets.updateOrgDefaultForServiceTypeV1({
6544
7649
  </dl>
6545
7650
  </details>
6546
7651
 
6547
- <details><summary><code>client.billing.rateSheets.<a href="/src/api/resources/billing/resources/rateSheets/client/Client.ts">updateDefaultForConnectionV1</a>({ ...params }) -> boolean</code></summary>
7652
+ <details><summary><code>client.billing.lineItemGroups.s3Objects.<a href="/src/api/resources/billing/resources/lineItemGroups/resources/s3Objects/client/Client.ts">addV1</a>(lineItemGroupId, { ...params }) -> boolean</code></summary>
6548
7653
  <dl>
6549
7654
  <dd>
6550
7655
 
@@ -6556,7 +7661,7 @@ await client.billing.rateSheets.updateOrgDefaultForServiceTypeV1({
6556
7661
  <dl>
6557
7662
  <dd>
6558
7663
 
6559
- Sets or clears a rate sheet as the default for a connection. Pass rate_sheet_id to set a default, or omit it to clear the default. One default per service type per connection. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (bool)
7664
+ Uploads an image file to a line item group with automatic blurhash generation. | authz_personas=[lig_org_operators, lig_driver] | (UploadFile) -> (bool)
6560
7665
 
6561
7666
  </dd>
6562
7667
  </dl>
@@ -6572,10 +7677,8 @@ Sets or clears a rate sheet as the default for a connection. Pass rate_sheet_id
6572
7677
  <dd>
6573
7678
 
6574
7679
  ```typescript
6575
- await client.billing.rateSheets.updateDefaultForConnectionV1({
6576
- connection_id: "connection_id",
6577
- service_type: "on_demand",
6578
- rate_sheet_id: "rate_sheet_id",
7680
+ await client.billing.lineItemGroups.s3Objects.addV1("line_item_group_id", {
7681
+ image: fs.createReadStream("/path/to/your/file"),
6579
7682
  });
6580
7683
  ```
6581
7684
 
@@ -6592,7 +7695,7 @@ await client.billing.rateSheets.updateDefaultForConnectionV1({
6592
7695
  <dl>
6593
7696
  <dd>
6594
7697
 
6595
- **request:** `Chrt.billing.RateSheetsUpdateDefaultForConnectionV1Request`
7698
+ **lineItemGroupId:** `string`
6596
7699
 
6597
7700
  </dd>
6598
7701
  </dl>
@@ -6600,7 +7703,15 @@ await client.billing.rateSheets.updateDefaultForConnectionV1({
6600
7703
  <dl>
6601
7704
  <dd>
6602
7705
 
6603
- **requestOptions:** `RateSheets.RequestOptions`
7706
+ **request:** `Chrt.billing.lineItemGroups.BodyLineItemGroupsS3ObjectPostAddV1BillingLineItemGroupsS3ObjectsAddV1LineItemGroupIdPost`
7707
+
7708
+ </dd>
7709
+ </dl>
7710
+
7711
+ <dl>
7712
+ <dd>
7713
+
7714
+ **requestOptions:** `S3Objects.RequestOptions`
6604
7715
 
6605
7716
  </dd>
6606
7717
  </dl>
@@ -6611,7 +7722,7 @@ await client.billing.rateSheets.updateDefaultForConnectionV1({
6611
7722
  </dl>
6612
7723
  </details>
6613
7724
 
6614
- <details><summary><code>client.billing.rateSheets.<a href="/src/api/resources/billing/resources/rateSheets/client/Client.ts">updateDefaultForDriverV1</a>({ ...params }) -> boolean</code></summary>
7725
+ <details><summary><code>client.billing.lineItemGroups.s3Objects.<a href="/src/api/resources/billing/resources/lineItemGroups/resources/s3Objects/client/Client.ts">deleteV1</a>(lineItemGroupS3ObjectMetadataId) -> boolean</code></summary>
6615
7726
  <dl>
6616
7727
  <dd>
6617
7728
 
@@ -6623,7 +7734,7 @@ await client.billing.rateSheets.updateDefaultForConnectionV1({
6623
7734
  <dl>
6624
7735
  <dd>
6625
7736
 
6626
- Sets or clears a rate sheet as the default for a driver. Pass rate_sheet_id to set a default, or omit it to clear the default. One default per service type per driver. | authz: allowed_org_types=[courier, forwarder], min_org_role=operator | () -> (bool)
7737
+ Deletes an S3 object metadata and the associated S3 object from a line item group. | authz_personas=[lig_org_operators, lig_driver] | () -> (bool)
6627
7738
 
6628
7739
  </dd>
6629
7740
  </dl>
@@ -6639,11 +7750,7 @@ Sets or clears a rate sheet as the default for a driver. Pass rate_sheet_id to s
6639
7750
  <dd>
6640
7751
 
6641
7752
  ```typescript
6642
- await client.billing.rateSheets.updateDefaultForDriverV1({
6643
- driver_id: "driver_id",
6644
- service_type: "on_demand",
6645
- rate_sheet_id: "rate_sheet_id",
6646
- });
7753
+ await client.billing.lineItemGroups.s3Objects.deleteV1("line_item_group_s3_object_metadata_id");
6647
7754
  ```
6648
7755
 
6649
7756
  </dd>
@@ -6659,7 +7766,7 @@ await client.billing.rateSheets.updateDefaultForDriverV1({
6659
7766
  <dl>
6660
7767
  <dd>
6661
7768
 
6662
- **request:** `Chrt.billing.RateSheetsUpdateDefaultForDriverV1Request`
7769
+ **lineItemGroupS3ObjectMetadataId:** `string`
6663
7770
 
6664
7771
  </dd>
6665
7772
  </dl>
@@ -6667,7 +7774,7 @@ await client.billing.rateSheets.updateDefaultForDriverV1({
6667
7774
  <dl>
6668
7775
  <dd>
6669
7776
 
6670
- **requestOptions:** `RateSheets.RequestOptions`
7777
+ **requestOptions:** `S3Objects.RequestOptions`
6671
7778
 
6672
7779
  </dd>
6673
7780
  </dl>
@@ -6678,7 +7785,9 @@ await client.billing.rateSheets.updateDefaultForDriverV1({
6678
7785
  </dl>
6679
7786
  </details>
6680
7787
 
6681
- <details><summary><code>client.billing.rateSheets.<a href="/src/api/resources/billing/resources/rateSheets/client/Client.ts">updateDefaultForOffChrtShipperV1</a>({ ...params }) -> boolean</code></summary>
7788
+ ## Connections ConnectionToCourier
7789
+
7790
+ <details><summary><code>client.connections.connectionToCourier.<a href="/src/api/resources/connections/resources/connectionToCourier/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
6682
7791
  <dl>
6683
7792
  <dd>
6684
7793
 
@@ -6690,7 +7799,7 @@ await client.billing.rateSheets.updateDefaultForDriverV1({
6690
7799
  <dl>
6691
7800
  <dd>
6692
7801
 
6693
- Sets or clears a rate sheet as the default for an off-chrt shipper. Pass rate_sheet_id to set a default, or omit it to clear the default. One default per service type per off-chrt shipper. | authz: allowed_org_types=[courier], min_org_role=operator | () -> (bool)
7802
+ Creates a new connection to a courier organization. Shippers and forwarders can initiate connections to couriers. | (CreateConnectionReq) -> (PydanticObjectId)
6694
7803
 
6695
7804
  </dd>
6696
7805
  </dl>
@@ -6706,10 +7815,8 @@ Sets or clears a rate sheet as the default for an off-chrt shipper. Pass rate_sh
6706
7815
  <dd>
6707
7816
 
6708
7817
  ```typescript
6709
- await client.billing.rateSheets.updateDefaultForOffChrtShipperV1({
6710
- off_chrt_shipper_org_id: "off_chrt_shipper_org_id",
6711
- service_type: "on_demand",
6712
- rate_sheet_id: "rate_sheet_id",
7818
+ await client.connections.connectionToCourier.createV1({
7819
+ handle: "handle",
6713
7820
  });
6714
7821
  ```
6715
7822
 
@@ -6726,7 +7833,7 @@ await client.billing.rateSheets.updateDefaultForOffChrtShipperV1({
6726
7833
  <dl>
6727
7834
  <dd>
6728
7835
 
6729
- **request:** `Chrt.billing.RateSheetsUpdateDefaultForOffChrtShipperV1Request`
7836
+ **request:** `Chrt.CreateConnectionReq`
6730
7837
 
6731
7838
  </dd>
6732
7839
  </dl>
@@ -6734,7 +7841,7 @@ await client.billing.rateSheets.updateDefaultForOffChrtShipperV1({
6734
7841
  <dl>
6735
7842
  <dd>
6736
7843
 
6737
- **requestOptions:** `RateSheets.RequestOptions`
7844
+ **requestOptions:** `ConnectionToCourier.RequestOptions`
6738
7845
 
6739
7846
  </dd>
6740
7847
  </dl>
@@ -6745,9 +7852,9 @@ await client.billing.rateSheets.updateDefaultForOffChrtShipperV1({
6745
7852
  </dl>
6746
7853
  </details>
6747
7854
 
6748
- ## Billing Statements
7855
+ ## Connections ConnectionToShipper
6749
7856
 
6750
- <details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">getV1</a>(statementId) -> Chrt.Statement1</code></summary>
7857
+ <details><summary><code>client.connections.connectionToShipper.<a href="/src/api/resources/connections/resources/connectionToShipper/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
6751
7858
  <dl>
6752
7859
  <dd>
6753
7860
 
@@ -6759,7 +7866,7 @@ await client.billing.rateSheets.updateDefaultForOffChrtShipperV1({
6759
7866
  <dl>
6760
7867
  <dd>
6761
7868
 
6762
- Gets a statement by ID. | authz_personas=[statement_org_operators, statement_driver] | () -> (Statement1)
7869
+ Creates a new connection to a shipper organization. Only forwarders can initiate connections to shippers. | (CreateConnectionReq) -> (PydanticObjectId)
6763
7870
 
6764
7871
  </dd>
6765
7872
  </dl>
@@ -6775,7 +7882,9 @@ Gets a statement by ID. | authz_personas=[statement_org_operators, statement_dri
6775
7882
  <dd>
6776
7883
 
6777
7884
  ```typescript
6778
- await client.billing.statements.getV1("statement_id");
7885
+ await client.connections.connectionToShipper.createV1({
7886
+ handle: "handle",
7887
+ });
6779
7888
  ```
6780
7889
 
6781
7890
  </dd>
@@ -6791,7 +7900,7 @@ await client.billing.statements.getV1("statement_id");
6791
7900
  <dl>
6792
7901
  <dd>
6793
7902
 
6794
- **statementId:** `string`
7903
+ **request:** `Chrt.CreateConnectionReq`
6795
7904
 
6796
7905
  </dd>
6797
7906
  </dl>
@@ -6799,7 +7908,7 @@ await client.billing.statements.getV1("statement_id");
6799
7908
  <dl>
6800
7909
  <dd>
6801
7910
 
6802
- **requestOptions:** `Statements.RequestOptions`
7911
+ **requestOptions:** `ConnectionToShipper.RequestOptions`
6803
7912
 
6804
7913
  </dd>
6805
7914
  </dl>
@@ -6810,7 +7919,9 @@ await client.billing.statements.getV1("statement_id");
6810
7919
  </dl>
6811
7920
  </details>
6812
7921
 
6813
- <details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">getByLigIdV1</a>(lineItemGroupId) -> Chrt.Statement1</code></summary>
7922
+ ## Connections ConnectionToForwarder
7923
+
7924
+ <details><summary><code>client.connections.connectionToForwarder.<a href="/src/api/resources/connections/resources/connectionToForwarder/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
6814
7925
  <dl>
6815
7926
  <dd>
6816
7927
 
@@ -6822,7 +7933,7 @@ await client.billing.statements.getV1("statement_id");
6822
7933
  <dl>
6823
7934
  <dd>
6824
7935
 
6825
- Gets a statement by its associated LineItemGroup ID. | authz_personas=[statement_org_operators, statement_driver] | () -> (Statement1)
7936
+ Creates a new connection to a forwarder organization. Only shippers can initiate connections to forwarders. | (CreateConnectionReq) -> (PydanticObjectId)
6826
7937
 
6827
7938
  </dd>
6828
7939
  </dl>
@@ -6838,7 +7949,9 @@ Gets a statement by its associated LineItemGroup ID. | authz_personas=[statement
6838
7949
  <dd>
6839
7950
 
6840
7951
  ```typescript
6841
- await client.billing.statements.getByLigIdV1("line_item_group_id");
7952
+ await client.connections.connectionToForwarder.createV1({
7953
+ handle: "handle",
7954
+ });
6842
7955
  ```
6843
7956
 
6844
7957
  </dd>
@@ -6854,7 +7967,7 @@ await client.billing.statements.getByLigIdV1("line_item_group_id");
6854
7967
  <dl>
6855
7968
  <dd>
6856
7969
 
6857
- **lineItemGroupId:** `string`
7970
+ **request:** `Chrt.CreateConnectionReq`
6858
7971
 
6859
7972
  </dd>
6860
7973
  </dl>
@@ -6862,7 +7975,7 @@ await client.billing.statements.getByLigIdV1("line_item_group_id");
6862
7975
  <dl>
6863
7976
  <dd>
6864
7977
 
6865
- **requestOptions:** `Statements.RequestOptions`
7978
+ **requestOptions:** `ConnectionToForwarder.RequestOptions`
6866
7979
 
6867
7980
  </dd>
6868
7981
  </dl>
@@ -6873,7 +7986,9 @@ await client.billing.statements.getByLigIdV1("line_item_group_id");
6873
7986
  </dl>
6874
7987
  </details>
6875
7988
 
6876
- <details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">expandedRetrieveV1</a>({ ...params }) -> Chrt.StatementExpandedRes</code></summary>
7989
+ ## Notifications AdHoc
7990
+
7991
+ <details><summary><code>client.notifications.adHoc.<a href="/src/api/resources/notifications/resources/adHoc/client/Client.ts">listByOrderIdV1</a>(orderId) -> Chrt.NotificationIntentAdHoc1[]</code></summary>
6877
7992
  <dl>
6878
7993
  <dd>
6879
7994
 
@@ -6885,7 +8000,7 @@ await client.billing.statements.getByLigIdV1("line_item_group_id");
6885
8000
  <dl>
6886
8001
  <dd>
6887
8002
 
6888
- Retrieves a statement with its associated LineItemGroups expanded. | authz_personas=[statement_org_operators, statement_driver] | (StatementExpandedRetrieveReq) -> (StatementExpandedRes)
8003
+ Lists all ad-hoc notification intents for an order. | authz: min_org_role=operator | () -> (list[NotificationIntentAdHoc1])
6889
8004
 
6890
8005
  </dd>
6891
8006
  </dl>
@@ -6901,9 +8016,7 @@ Retrieves a statement with its associated LineItemGroups expanded. | authz_perso
6901
8016
  <dd>
6902
8017
 
6903
8018
  ```typescript
6904
- await client.billing.statements.expandedRetrieveV1({
6905
- statement_id: "statement_id",
6906
- });
8019
+ await client.notifications.adHoc.listByOrderIdV1("order_id");
6907
8020
  ```
6908
8021
 
6909
8022
  </dd>
@@ -6919,7 +8032,7 @@ await client.billing.statements.expandedRetrieveV1({
6919
8032
  <dl>
6920
8033
  <dd>
6921
8034
 
6922
- **request:** `Chrt.billing.StatementExpandedRetrieveReq`
8035
+ **orderId:** `string`
6923
8036
 
6924
8037
  </dd>
6925
8038
  </dl>
@@ -6927,7 +8040,7 @@ await client.billing.statements.expandedRetrieveV1({
6927
8040
  <dl>
6928
8041
  <dd>
6929
8042
 
6930
- **requestOptions:** `Statements.RequestOptions`
8043
+ **requestOptions:** `AdHoc.RequestOptions`
6931
8044
 
6932
8045
  </dd>
6933
8046
  </dl>
@@ -6938,7 +8051,7 @@ await client.billing.statements.expandedRetrieveV1({
6938
8051
  </dl>
6939
8052
  </details>
6940
8053
 
6941
- <details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">listV1</a>({ ...params }) -> Chrt.StatementsListRes</code></summary>
8054
+ <details><summary><code>client.notifications.adHoc.<a href="/src/api/resources/notifications/resources/adHoc/client/Client.ts">createV1</a>(orderId, { ...params }) -> string</code></summary>
6942
8055
  <dl>
6943
8056
  <dd>
6944
8057
 
@@ -6950,7 +8063,7 @@ await client.billing.statements.expandedRetrieveV1({
6950
8063
  <dl>
6951
8064
  <dd>
6952
8065
 
6953
- Lists statements with filtering, sorting, and pagination. | authz_personas=[statement_org_operators, statement_driver] | () -> (StatementsListRes)
8066
+ Creates a new ad-hoc notification intent for an order. | authz: min_org_role=operator | (NotificationIntentAdHocClientCreate1) -> (PydanticObjectId)
6954
8067
 
6955
8068
  </dd>
6956
8069
  </dl>
@@ -6966,21 +8079,9 @@ Lists statements with filtering, sorting, and pagination. | authz_personas=[stat
6966
8079
  <dd>
6967
8080
 
6968
8081
  ```typescript
6969
- await client.billing.statements.listV1({
6970
- sort_by: "amount",
6971
- sort_order: "asc",
6972
- page: 1,
6973
- page_size: 1,
6974
- filter_settlement_type: "stripe_connect",
6975
- filter_payment_origin_org_id: "filter_payment_origin_org_id",
6976
- filter_payment_destination_org_id: "filter_payment_destination_org_id",
6977
- filter_owned_by_org_id: "filter_owned_by_org_id",
6978
- filter_staged_at_timestamp_gte: "2024-01-15T09:30:00Z",
6979
- filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
6980
- filter_opened_at_timestamp_gte: "2024-01-15T09:30:00Z",
6981
- filter_opened_at_timestamp_lte: "2024-01-15T09:30:00Z",
6982
- filter_paid_at_timestamp_gte: "2024-01-15T09:30:00Z",
6983
- filter_paid_at_timestamp_lte: "2024-01-15T09:30:00Z",
8082
+ await client.notifications.adHoc.createV1("order_id", {
8083
+ schema_version: 1,
8084
+ directory_entry_id: "directory_entry_id",
6984
8085
  });
6985
8086
  ```
6986
8087
 
@@ -6997,7 +8098,7 @@ await client.billing.statements.listV1({
6997
8098
  <dl>
6998
8099
  <dd>
6999
8100
 
7000
- **request:** `Chrt.billing.StatementsListV1Request`
8101
+ **orderId:** `string`
7001
8102
 
7002
8103
  </dd>
7003
8104
  </dl>
@@ -7005,7 +8106,15 @@ await client.billing.statements.listV1({
7005
8106
  <dl>
7006
8107
  <dd>
7007
8108
 
7008
- **requestOptions:** `Statements.RequestOptions`
8109
+ **request:** `Chrt.notifications.NotificationIntentAdHocClientCreate1`
8110
+
8111
+ </dd>
8112
+ </dl>
8113
+
8114
+ <dl>
8115
+ <dd>
8116
+
8117
+ **requestOptions:** `AdHoc.RequestOptions`
7009
8118
 
7010
8119
  </dd>
7011
8120
  </dl>
@@ -7016,7 +8125,7 @@ await client.billing.statements.listV1({
7016
8125
  </dl>
7017
8126
  </details>
7018
8127
 
7019
- <details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">createV1</a>({ ...params }) -> Chrt.Statement1</code></summary>
8128
+ <details><summary><code>client.notifications.adHoc.<a href="/src/api/resources/notifications/resources/adHoc/client/Client.ts">deleteV1</a>(adHocId) -> boolean</code></summary>
7020
8129
  <dl>
7021
8130
  <dd>
7022
8131
 
@@ -7028,7 +8137,7 @@ await client.billing.statements.listV1({
7028
8137
  <dl>
7029
8138
  <dd>
7030
8139
 
7031
- Creates a new statement without LIG IDs, starting in STAGED status. Requires payment vector, origin, and destination. | authz: org_type=[courier, forwarder], min_org_role=operator | (CreateStatementReq) -> (Statement1)
8140
+ Deletes an ad-hoc notification intent. | authz: min_org_role=operator | () -> (bool)
7032
8141
 
7033
8142
  </dd>
7034
8143
  </dl>
@@ -7044,10 +8153,7 @@ Creates a new statement without LIG IDs, starting in STAGED status. Requires pay
7044
8153
  <dd>
7045
8154
 
7046
8155
  ```typescript
7047
- await client.billing.statements.createV1({
7048
- payment_vector_type: "shipper_pay_forwarder",
7049
- settlement_type: "stripe_connect",
7050
- });
8156
+ await client.notifications.adHoc.deleteV1("ad_hoc_id");
7051
8157
  ```
7052
8158
 
7053
8159
  </dd>
@@ -7063,7 +8169,7 @@ await client.billing.statements.createV1({
7063
8169
  <dl>
7064
8170
  <dd>
7065
8171
 
7066
- **request:** `Chrt.billing.CreateStatementReq`
8172
+ **adHocId:** `string`
7067
8173
 
7068
8174
  </dd>
7069
8175
  </dl>
@@ -7071,7 +8177,7 @@ await client.billing.statements.createV1({
7071
8177
  <dl>
7072
8178
  <dd>
7073
8179
 
7074
- **requestOptions:** `Statements.RequestOptions`
8180
+ **requestOptions:** `AdHoc.RequestOptions`
7075
8181
 
7076
8182
  </dd>
7077
8183
  </dl>
@@ -7082,7 +8188,9 @@ await client.billing.statements.createV1({
7082
8188
  </dl>
7083
8189
  </details>
7084
8190
 
7085
- <details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">deleteV1</a>(statementId) -> boolean</code></summary>
8191
+ ## Notifications Groups
8192
+
8193
+ <details><summary><code>client.notifications.groups.<a href="/src/api/resources/notifications/resources/groups/client/Client.ts">listByOrgV1</a>() -> Chrt.NotificationGroup1[]</code></summary>
7086
8194
  <dl>
7087
8195
  <dd>
7088
8196
 
@@ -7094,7 +8202,7 @@ await client.billing.statements.createV1({
7094
8202
  <dl>
7095
8203
  <dd>
7096
8204
 
7097
- Deletes a statement. Only allowed if statement has no LineItemGroup IDs. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators] | () -> (bool)
8205
+ Lists all notification groups for the caller's organization. | authz: min_org_role=operator | () -> (list[NotificationGroup1])
7098
8206
 
7099
8207
  </dd>
7100
8208
  </dl>
@@ -7110,7 +8218,7 @@ Deletes a statement. Only allowed if statement has no LineItemGroup IDs. | authz
7110
8218
  <dd>
7111
8219
 
7112
8220
  ```typescript
7113
- await client.billing.statements.deleteV1("statement_id");
8221
+ await client.notifications.groups.listByOrgV1();
7114
8222
  ```
7115
8223
 
7116
8224
  </dd>
@@ -7126,15 +8234,7 @@ await client.billing.statements.deleteV1("statement_id");
7126
8234
  <dl>
7127
8235
  <dd>
7128
8236
 
7129
- **statementId:** `string`
7130
-
7131
- </dd>
7132
- </dl>
7133
-
7134
- <dl>
7135
- <dd>
7136
-
7137
- **requestOptions:** `Statements.RequestOptions`
8237
+ **requestOptions:** `Groups.RequestOptions`
7138
8238
 
7139
8239
  </dd>
7140
8240
  </dl>
@@ -7145,7 +8245,7 @@ await client.billing.statements.deleteV1("statement_id");
7145
8245
  </dl>
7146
8246
  </details>
7147
8247
 
7148
- <details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">updateSettlementTypeV1</a>(statementId, { ...params }) -> Chrt.Statement1</code></summary>
8248
+ <details><summary><code>client.notifications.groups.<a href="/src/api/resources/notifications/resources/groups/client/Client.ts">getForAdministratorV1</a>(groupId) -> Chrt.NotificationGroup1</code></summary>
7149
8249
  <dl>
7150
8250
  <dd>
7151
8251
 
@@ -7157,7 +8257,7 @@ await client.billing.statements.deleteV1("statement_id");
7157
8257
  <dl>
7158
8258
  <dd>
7159
8259
 
7160
- Updates the settlement type of a statement. Statement must be in STAGED status. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators], statement_status=STAGED | (SettlementTypeEnum1) -> (Statement1)
8260
+ Retrieves full notification group details including user membership. | authz: min_org_role=operator | () -> (NotificationGroup1)
7161
8261
 
7162
8262
  </dd>
7163
8263
  </dl>
@@ -7173,9 +8273,7 @@ Updates the settlement type of a statement. Statement must be in STAGED status.
7173
8273
  <dd>
7174
8274
 
7175
8275
  ```typescript
7176
- await client.billing.statements.updateSettlementTypeV1("statement_id", {
7177
- settlement_type: "stripe_connect",
7178
- });
8276
+ await client.notifications.groups.getForAdministratorV1("group_id");
7179
8277
  ```
7180
8278
 
7181
8279
  </dd>
@@ -7191,15 +8289,7 @@ await client.billing.statements.updateSettlementTypeV1("statement_id", {
7191
8289
  <dl>
7192
8290
  <dd>
7193
8291
 
7194
- **statementId:** `string`
7195
-
7196
- </dd>
7197
- </dl>
7198
-
7199
- <dl>
7200
- <dd>
7201
-
7202
- **request:** `Chrt.billing.BodyStatementsPatchUpdateSettlementTypeV1BillingUpdateSettlementTypeV1StatementIdPatch`
8292
+ **groupId:** `string`
7203
8293
 
7204
8294
  </dd>
7205
8295
  </dl>
@@ -7207,7 +8297,7 @@ await client.billing.statements.updateSettlementTypeV1("statement_id", {
7207
8297
  <dl>
7208
8298
  <dd>
7209
8299
 
7210
- **requestOptions:** `Statements.RequestOptions`
8300
+ **requestOptions:** `Groups.RequestOptions`
7211
8301
 
7212
8302
  </dd>
7213
8303
  </dl>
@@ -7218,7 +8308,7 @@ await client.billing.statements.updateSettlementTypeV1("statement_id", {
7218
8308
  </dl>
7219
8309
  </details>
7220
8310
 
7221
- <details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">updateOffChrtSettlementStateV1</a>(statementId, { ...params }) -> Chrt.Statement1</code></summary>
8311
+ <details><summary><code>client.notifications.groups.<a href="/src/api/resources/notifications/resources/groups/client/Client.ts">listByUserV1</a>() -> Chrt.NotificationGroupLimitedForDriver1[]</code></summary>
7222
8312
  <dl>
7223
8313
  <dd>
7224
8314
 
@@ -7230,7 +8320,7 @@ await client.billing.statements.updateSettlementTypeV1("statement_id", {
7230
8320
  <dl>
7231
8321
  <dd>
7232
8322
 
7233
- Updates the status of an off-CHRT settlement statement. Used to manually transition OFF_CHRT statements between STAGED, OPEN, PAID, and VOID. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators] | (StatementStatusEnum1) -> (Statement1)
8323
+ Lists notification groups the caller is a member of. | () -> (list[NotificationGroupLimitedForDriver1])
7234
8324
 
7235
8325
  </dd>
7236
8326
  </dl>
@@ -7246,9 +8336,7 @@ Updates the status of an off-CHRT settlement statement. Used to manually transit
7246
8336
  <dd>
7247
8337
 
7248
8338
  ```typescript
7249
- await client.billing.statements.updateOffChrtSettlementStateV1("statement_id", {
7250
- new_status: "staged",
7251
- });
8339
+ await client.notifications.groups.listByUserV1();
7252
8340
  ```
7253
8341
 
7254
8342
  </dd>
@@ -7264,23 +8352,7 @@ await client.billing.statements.updateOffChrtSettlementStateV1("statement_id", {
7264
8352
  <dl>
7265
8353
  <dd>
7266
8354
 
7267
- **statementId:** `string`
7268
-
7269
- </dd>
7270
- </dl>
7271
-
7272
- <dl>
7273
- <dd>
7274
-
7275
- **request:** `Chrt.billing.BodyStatementsPatchUpdateOffChrtSettlementStateV1BillingUpdateOffChrtSettlementStateV1StatementIdPatch`
7276
-
7277
- </dd>
7278
- </dl>
7279
-
7280
- <dl>
7281
- <dd>
7282
-
7283
- **requestOptions:** `Statements.RequestOptions`
8355
+ **requestOptions:** `Groups.RequestOptions`
7284
8356
 
7285
8357
  </dd>
7286
8358
  </dl>
@@ -7291,7 +8363,7 @@ await client.billing.statements.updateOffChrtSettlementStateV1("statement_id", {
7291
8363
  </dl>
7292
8364
  </details>
7293
8365
 
7294
- <details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">openInvoiceV1</a>(statementId, { ...params }) -> Chrt.Statement1</code></summary>
8366
+ <details><summary><code>client.notifications.groups.<a href="/src/api/resources/notifications/resources/groups/client/Client.ts">getForMemberV1</a>(groupId) -> Chrt.NotificationGroupLimitedForDriver1</code></summary>
7295
8367
  <dl>
7296
8368
  <dd>
7297
8369
 
@@ -7303,7 +8375,7 @@ await client.billing.statements.updateOffChrtSettlementStateV1("statement_id", {
7303
8375
  <dl>
7304
8376
  <dd>
7305
8377
 
7306
- Opens a Stripe Connect invoice for a statement and attempt to send via email. Org must have a Stripe Connect account. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators], statement_status=STAGED, line_item_groups_status=FINALIZED | (OpenInvoiceReq) -> (Statement1)
8378
+ Retrieves limited notification group details for a group the caller is a member of. | () -> (NotificationGroupLimitedForDriver1)
7307
8379
 
7308
8380
  </dd>
7309
8381
  </dl>
@@ -7319,7 +8391,7 @@ Opens a Stripe Connect invoice for a statement and attempt to send via email. Or
7319
8391
  <dd>
7320
8392
 
7321
8393
  ```typescript
7322
- await client.billing.statements.openInvoiceV1("statement_id");
8394
+ await client.notifications.groups.getForMemberV1("group_id");
7323
8395
  ```
7324
8396
 
7325
8397
  </dd>
@@ -7335,15 +8407,7 @@ await client.billing.statements.openInvoiceV1("statement_id");
7335
8407
  <dl>
7336
8408
  <dd>
7337
8409
 
7338
- **statementId:** `string`
7339
-
7340
- </dd>
7341
- </dl>
7342
-
7343
- <dl>
7344
- <dd>
7345
-
7346
- **request:** `Chrt.billing.OpenInvoiceReq`
8410
+ **groupId:** `string`
7347
8411
 
7348
8412
  </dd>
7349
8413
  </dl>
@@ -7351,7 +8415,7 @@ await client.billing.statements.openInvoiceV1("statement_id");
7351
8415
  <dl>
7352
8416
  <dd>
7353
8417
 
7354
- **requestOptions:** `Statements.RequestOptions`
8418
+ **requestOptions:** `Groups.RequestOptions`
7355
8419
 
7356
8420
  </dd>
7357
8421
  </dl>
@@ -7362,7 +8426,7 @@ await client.billing.statements.openInvoiceV1("statement_id");
7362
8426
  </dl>
7363
8427
  </details>
7364
8428
 
7365
- <details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">syncInvoiceV1</a>(statementId) -> Chrt.Statement1</code></summary>
8429
+ <details><summary><code>client.notifications.groups.<a href="/src/api/resources/notifications/resources/groups/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
7366
8430
  <dl>
7367
8431
  <dd>
7368
8432
 
@@ -7374,7 +8438,7 @@ await client.billing.statements.openInvoiceV1("statement_id");
7374
8438
  <dl>
7375
8439
  <dd>
7376
8440
 
7377
- Syncs invoice state from Stripe Connect to the Statement and LineItemGroups. The webhook usually keeps invoices up to date, but users can manually trigger a sync. | authz: org_type=[courier, forwarder, shipper], min_org_role=operator, authz_personas=[statement_org_operators] | () -> (Statement1)
8441
+ Creates a new notification group for the organization. | authz: min_org_role=administrator | (NotificationGroupClientCreate1) -> (PydanticObjectId)
7378
8442
 
7379
8443
  </dd>
7380
8444
  </dl>
@@ -7390,7 +8454,10 @@ Syncs invoice state from Stripe Connect to the Statement and LineItemGroups. The
7390
8454
  <dd>
7391
8455
 
7392
8456
  ```typescript
7393
- await client.billing.statements.syncInvoiceV1("statement_id");
8457
+ await client.notifications.groups.createV1({
8458
+ schema_version: 1,
8459
+ group_name: "group_name",
8460
+ });
7394
8461
  ```
7395
8462
 
7396
8463
  </dd>
@@ -7406,7 +8473,7 @@ await client.billing.statements.syncInvoiceV1("statement_id");
7406
8473
  <dl>
7407
8474
  <dd>
7408
8475
 
7409
- **statementId:** `string`
8476
+ **request:** `Chrt.notifications.NotificationGroupClientCreate1`
7410
8477
 
7411
8478
  </dd>
7412
8479
  </dl>
@@ -7414,7 +8481,7 @@ await client.billing.statements.syncInvoiceV1("statement_id");
7414
8481
  <dl>
7415
8482
  <dd>
7416
8483
 
7417
- **requestOptions:** `Statements.RequestOptions`
8484
+ **requestOptions:** `Groups.RequestOptions`
7418
8485
 
7419
8486
  </dd>
7420
8487
  </dl>
@@ -7425,7 +8492,7 @@ await client.billing.statements.syncInvoiceV1("statement_id");
7425
8492
  </dl>
7426
8493
  </details>
7427
8494
 
7428
- <details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">voidInvoiceV1</a>(statementId) -> Chrt.Statement1</code></summary>
8495
+ <details><summary><code>client.notifications.groups.<a href="/src/api/resources/notifications/resources/groups/client/Client.ts">updateNameV1</a>(groupId, { ...params }) -> boolean</code></summary>
7429
8496
  <dl>
7430
8497
  <dd>
7431
8498
 
@@ -7437,7 +8504,7 @@ await client.billing.statements.syncInvoiceV1("statement_id");
7437
8504
  <dl>
7438
8505
  <dd>
7439
8506
 
7440
- Voids a Stripe Connect invoice. Statement reverts to STAGED and LIGs revert to FINALIZED. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators], statement_status=OPEN | () -> (Statement1)
8507
+ Updates the name of a notification group. | authz: min_org_role=administrator | () -> (bool)
7441
8508
 
7442
8509
  </dd>
7443
8510
  </dl>
@@ -7453,7 +8520,9 @@ Voids a Stripe Connect invoice. Statement reverts to STAGED and LIGs revert to F
7453
8520
  <dd>
7454
8521
 
7455
8522
  ```typescript
7456
- await client.billing.statements.voidInvoiceV1("statement_id");
8523
+ await client.notifications.groups.updateNameV1("group_id", {
8524
+ group_name: "group_name",
8525
+ });
7457
8526
  ```
7458
8527
 
7459
8528
  </dd>
@@ -7469,7 +8538,7 @@ await client.billing.statements.voidInvoiceV1("statement_id");
7469
8538
  <dl>
7470
8539
  <dd>
7471
8540
 
7472
- **statementId:** `string`
8541
+ **groupId:** `string`
7473
8542
 
7474
8543
  </dd>
7475
8544
  </dl>
@@ -7477,7 +8546,15 @@ await client.billing.statements.voidInvoiceV1("statement_id");
7477
8546
  <dl>
7478
8547
  <dd>
7479
8548
 
7480
- **requestOptions:** `Statements.RequestOptions`
8549
+ **request:** `Chrt.notifications.GroupsUpdateNameV1Request`
8550
+
8551
+ </dd>
8552
+ </dl>
8553
+
8554
+ <dl>
8555
+ <dd>
8556
+
8557
+ **requestOptions:** `Groups.RequestOptions`
7481
8558
 
7482
8559
  </dd>
7483
8560
  </dl>
@@ -7488,9 +8565,7 @@ await client.billing.statements.voidInvoiceV1("statement_id");
7488
8565
  </dl>
7489
8566
  </details>
7490
8567
 
7491
- ## Billing StripeConnect
7492
-
7493
- <details><summary><code>client.billing.stripeConnect.<a href="/src/api/resources/billing/resources/stripeConnect/client/Client.ts">createAccountV1</a>() -> Chrt.CreateStripeConnectAccountRes</code></summary>
8568
+ <details><summary><code>client.notifications.groups.<a href="/src/api/resources/notifications/resources/groups/client/Client.ts">addEventV1</a>(groupId, channel, event) -> boolean</code></summary>
7494
8569
  <dl>
7495
8570
  <dd>
7496
8571
 
@@ -7502,7 +8577,7 @@ await client.billing.statements.voidInvoiceV1("statement_id");
7502
8577
  <dl>
7503
8578
  <dd>
7504
8579
 
7505
- Creates a Stripe Connect account for the organization to receive payments. Idempotent - returns existing account if already created. | () -> (CreateStripeConnectAccountRes)
8580
+ Adds a notification event to a channel for a group. | authz: min_org_role=administrator | () -> (bool)
7506
8581
 
7507
8582
  </dd>
7508
8583
  </dl>
@@ -7518,7 +8593,7 @@ Creates a Stripe Connect account for the organization to receive payments. Idemp
7518
8593
  <dd>
7519
8594
 
7520
8595
  ```typescript
7521
- await client.billing.stripeConnect.createAccountV1();
8596
+ await client.notifications.groups.addEventV1("group_id", "email", "shipping.order.staged");
7522
8597
  ```
7523
8598
 
7524
8599
  </dd>
@@ -7534,7 +8609,31 @@ await client.billing.stripeConnect.createAccountV1();
7534
8609
  <dl>
7535
8610
  <dd>
7536
8611
 
7537
- **requestOptions:** `StripeConnect.RequestOptions`
8612
+ **groupId:** `string`
8613
+
8614
+ </dd>
8615
+ </dl>
8616
+
8617
+ <dl>
8618
+ <dd>
8619
+
8620
+ **channel:** `Chrt.NotificationChannelsEnum`
8621
+
8622
+ </dd>
8623
+ </dl>
8624
+
8625
+ <dl>
8626
+ <dd>
8627
+
8628
+ **event:** `Chrt.NotificationEventsForOrgsEnum`
8629
+
8630
+ </dd>
8631
+ </dl>
8632
+
8633
+ <dl>
8634
+ <dd>
8635
+
8636
+ **requestOptions:** `Groups.RequestOptions`
7538
8637
 
7539
8638
  </dd>
7540
8639
  </dl>
@@ -7545,7 +8644,7 @@ await client.billing.stripeConnect.createAccountV1();
7545
8644
  </dl>
7546
8645
  </details>
7547
8646
 
7548
- <details><summary><code>client.billing.stripeConnect.<a href="/src/api/resources/billing/resources/stripeConnect/client/Client.ts">onboardingLinkV1</a>() -> Chrt.StripeConnectAccountOnboardingLinkRes</code></summary>
8647
+ <details><summary><code>client.notifications.groups.<a href="/src/api/resources/notifications/resources/groups/client/Client.ts">removeEventV1</a>(groupId, channel, event) -> boolean</code></summary>
7549
8648
  <dl>
7550
8649
  <dd>
7551
8650
 
@@ -7557,7 +8656,7 @@ await client.billing.stripeConnect.createAccountV1();
7557
8656
  <dl>
7558
8657
  <dd>
7559
8658
 
7560
- Creates an onboarding link for a Stripe Connect account. Used to complete or update account setup. | () -> (StripeConnectAccountOnboardingLinkRes)
8659
+ Removes a notification event from a channel for a group. | authz: min_org_role=administrator | () -> (bool)
7561
8660
 
7562
8661
  </dd>
7563
8662
  </dl>
@@ -7573,7 +8672,7 @@ Creates an onboarding link for a Stripe Connect account. Used to complete or upd
7573
8672
  <dd>
7574
8673
 
7575
8674
  ```typescript
7576
- await client.billing.stripeConnect.onboardingLinkV1();
8675
+ await client.notifications.groups.removeEventV1("group_id", "email", "shipping.order.staged");
7577
8676
  ```
7578
8677
 
7579
8678
  </dd>
@@ -7589,20 +8688,42 @@ await client.billing.stripeConnect.onboardingLinkV1();
7589
8688
  <dl>
7590
8689
  <dd>
7591
8690
 
7592
- **requestOptions:** `StripeConnect.RequestOptions`
8691
+ **groupId:** `string`
7593
8692
 
7594
8693
  </dd>
7595
8694
  </dl>
8695
+
8696
+ <dl>
8697
+ <dd>
8698
+
8699
+ **channel:** `Chrt.NotificationChannelsEnum`
8700
+
7596
8701
  </dd>
7597
8702
  </dl>
7598
8703
 
8704
+ <dl>
8705
+ <dd>
8706
+
8707
+ **event:** `Chrt.NotificationEventsForOrgsEnum`
8708
+
7599
8709
  </dd>
7600
8710
  </dl>
7601
- </details>
7602
8711
 
7603
- ## Billing LineItemGroups AdHoc
8712
+ <dl>
8713
+ <dd>
7604
8714
 
7605
- <details><summary><code>client.billing.lineItemGroups.adHoc.<a href="/src/api/resources/billing/resources/lineItemGroups/resources/adHoc/client/Client.ts">createV1</a>({ ...params }) -> Chrt.LineItemGroup1</code></summary>
8715
+ **requestOptions:** `Groups.RequestOptions`
8716
+
8717
+ </dd>
8718
+ </dl>
8719
+ </dd>
8720
+ </dl>
8721
+
8722
+ </dd>
8723
+ </dl>
8724
+ </details>
8725
+
8726
+ <details><summary><code>client.notifications.groups.<a href="/src/api/resources/notifications/resources/groups/client/Client.ts">addUserV1</a>(groupId, userId) -> boolean</code></summary>
7606
8727
  <dl>
7607
8728
  <dd>
7608
8729
 
@@ -7614,7 +8735,7 @@ await client.billing.stripeConnect.onboardingLinkV1();
7614
8735
  <dl>
7615
8736
  <dd>
7616
8737
 
7617
- Creates an ad-hoc line item group (not associated with a TaskGroup). Starts as ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator | (CreateAdHocLineItemGroupReq) -> (LineItemGroup1)
8738
+ Adds a user to a notification group. | authz: min_org_role=administrator | () -> (bool)
7618
8739
 
7619
8740
  </dd>
7620
8741
  </dl>
@@ -7630,10 +8751,7 @@ Creates an ad-hoc line item group (not associated with a TaskGroup). Starts as A
7630
8751
  <dd>
7631
8752
 
7632
8753
  ```typescript
7633
- await client.billing.lineItemGroups.adHoc.createV1({
7634
- payment_vector_type: "shipper_pay_forwarder",
7635
- settlement_type: "stripe_connect",
7636
- });
8754
+ await client.notifications.groups.addUserV1("group_id", "user_id");
7637
8755
  ```
7638
8756
 
7639
8757
  </dd>
@@ -7649,7 +8767,7 @@ await client.billing.lineItemGroups.adHoc.createV1({
7649
8767
  <dl>
7650
8768
  <dd>
7651
8769
 
7652
- **request:** `Chrt.billing.lineItemGroups.CreateAdHocLineItemGroupReq`
8770
+ **groupId:** `string`
7653
8771
 
7654
8772
  </dd>
7655
8773
  </dl>
@@ -7657,7 +8775,15 @@ await client.billing.lineItemGroups.adHoc.createV1({
7657
8775
  <dl>
7658
8776
  <dd>
7659
8777
 
7660
- **requestOptions:** `AdHoc.RequestOptions`
8778
+ **userId:** `string`
8779
+
8780
+ </dd>
8781
+ </dl>
8782
+
8783
+ <dl>
8784
+ <dd>
8785
+
8786
+ **requestOptions:** `Groups.RequestOptions`
7661
8787
 
7662
8788
  </dd>
7663
8789
  </dl>
@@ -7668,7 +8794,7 @@ await client.billing.lineItemGroups.adHoc.createV1({
7668
8794
  </dl>
7669
8795
  </details>
7670
8796
 
7671
- <details><summary><code>client.billing.lineItemGroups.adHoc.<a href="/src/api/resources/billing/resources/lineItemGroups/resources/adHoc/client/Client.ts">addLineItemV1</a>(lineItemGroupId, { ...params }) -> Chrt.LineItemGroup1</code></summary>
8797
+ <details><summary><code>client.notifications.groups.<a href="/src/api/resources/notifications/resources/groups/client/Client.ts">removeUserV1</a>(groupId, userId) -> boolean</code></summary>
7672
8798
  <dl>
7673
8799
  <dd>
7674
8800
 
@@ -7680,7 +8806,7 @@ await client.billing.lineItemGroups.adHoc.createV1({
7680
8806
  <dl>
7681
8807
  <dd>
7682
8808
 
7683
- Adds a line item to an ad-hoc line item group. LIG must be ad-hoc (task_group_id is None) and ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | (LineItemClientCreate1) -> (LineItemGroup1)
8809
+ Removes a user from a notification group. | authz: min_org_role=administrator | () -> (bool)
7684
8810
 
7685
8811
  </dd>
7686
8812
  </dl>
@@ -7696,11 +8822,7 @@ Adds a line item to an ad-hoc line item group. LIG must be ad-hoc (task_group_id
7696
8822
  <dd>
7697
8823
 
7698
8824
  ```typescript
7699
- await client.billing.lineItemGroups.adHoc.addLineItemV1("line_item_group_id", {
7700
- item: "base_rate",
7701
- quantity: 1.1,
7702
- rate: 1.1,
7703
- });
8825
+ await client.notifications.groups.removeUserV1("group_id", "user_id");
7704
8826
  ```
7705
8827
 
7706
8828
  </dd>
@@ -7716,7 +8838,7 @@ await client.billing.lineItemGroups.adHoc.addLineItemV1("line_item_group_id", {
7716
8838
  <dl>
7717
8839
  <dd>
7718
8840
 
7719
- **lineItemGroupId:** `string`
8841
+ **groupId:** `string`
7720
8842
 
7721
8843
  </dd>
7722
8844
  </dl>
@@ -7724,7 +8846,7 @@ await client.billing.lineItemGroups.adHoc.addLineItemV1("line_item_group_id", {
7724
8846
  <dl>
7725
8847
  <dd>
7726
8848
 
7727
- **request:** `Chrt.billing.lineItemGroups.LineItemClientCreate1`
8849
+ **userId:** `string`
7728
8850
 
7729
8851
  </dd>
7730
8852
  </dl>
@@ -7732,7 +8854,7 @@ await client.billing.lineItemGroups.adHoc.addLineItemV1("line_item_group_id", {
7732
8854
  <dl>
7733
8855
  <dd>
7734
8856
 
7735
- **requestOptions:** `AdHoc.RequestOptions`
8857
+ **requestOptions:** `Groups.RequestOptions`
7736
8858
 
7737
8859
  </dd>
7738
8860
  </dl>
@@ -7743,7 +8865,7 @@ await client.billing.lineItemGroups.adHoc.addLineItemV1("line_item_group_id", {
7743
8865
  </dl>
7744
8866
  </details>
7745
8867
 
7746
- <details><summary><code>client.billing.lineItemGroups.adHoc.<a href="/src/api/resources/billing/resources/lineItemGroups/resources/adHoc/client/Client.ts">removeLineItemV1</a>(lineItemGroupId, { ...params }) -> Chrt.LineItemGroup1</code></summary>
8868
+ <details><summary><code>client.notifications.groups.<a href="/src/api/resources/notifications/resources/groups/client/Client.ts">deleteV1</a>(groupId) -> boolean</code></summary>
7747
8869
  <dl>
7748
8870
  <dd>
7749
8871
 
@@ -7755,7 +8877,7 @@ await client.billing.lineItemGroups.adHoc.addLineItemV1("line_item_group_id", {
7755
8877
  <dl>
7756
8878
  <dd>
7757
8879
 
7758
- Removes a line item from an ad-hoc line item group. LIG must be ad-hoc (task_group_id is None) and ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | (line_item_uuid_str) -> (LineItemGroup1)
8880
+ Deletes a notification group. | authz: min_org_role=administrator | () -> (bool)
7759
8881
 
7760
8882
  </dd>
7761
8883
  </dl>
@@ -7771,9 +8893,7 @@ Removes a line item from an ad-hoc line item group. LIG must be ad-hoc (task_gro
7771
8893
  <dd>
7772
8894
 
7773
8895
  ```typescript
7774
- await client.billing.lineItemGroups.adHoc.removeLineItemV1("line_item_group_id", {
7775
- line_item_uuid_str: "line_item_uuid_str",
7776
- });
8896
+ await client.notifications.groups.deleteV1("group_id");
7777
8897
  ```
7778
8898
 
7779
8899
  </dd>
@@ -7789,15 +8909,7 @@ await client.billing.lineItemGroups.adHoc.removeLineItemV1("line_item_group_id",
7789
8909
  <dl>
7790
8910
  <dd>
7791
8911
 
7792
- **lineItemGroupId:** `string`
7793
-
7794
- </dd>
7795
- </dl>
7796
-
7797
- <dl>
7798
- <dd>
7799
-
7800
- **request:** `Chrt.billing.lineItemGroups.AdHocRemoveLineItemV1Request`
8912
+ **groupId:** `string`
7801
8913
 
7802
8914
  </dd>
7803
8915
  </dl>
@@ -7805,7 +8917,7 @@ await client.billing.lineItemGroups.adHoc.removeLineItemV1("line_item_group_id",
7805
8917
  <dl>
7806
8918
  <dd>
7807
8919
 
7808
- **requestOptions:** `AdHoc.RequestOptions`
8920
+ **requestOptions:** `Groups.RequestOptions`
7809
8921
 
7810
8922
  </dd>
7811
8923
  </dl>
@@ -7816,7 +8928,7 @@ await client.billing.lineItemGroups.adHoc.removeLineItemV1("line_item_group_id",
7816
8928
  </dl>
7817
8929
  </details>
7818
8930
 
7819
- <details><summary><code>client.billing.lineItemGroups.adHoc.<a href="/src/api/resources/billing/resources/lineItemGroups/resources/adHoc/client/Client.ts">deleteV1</a>(lineItemGroupId) -> boolean</code></summary>
8931
+ <details><summary><code>client.notifications.groups.<a href="/src/api/resources/notifications/resources/groups/client/Client.ts">userOptInV1</a>(groupId) -> boolean</code></summary>
7820
8932
  <dl>
7821
8933
  <dd>
7822
8934
 
@@ -7828,7 +8940,7 @@ await client.billing.lineItemGroups.adHoc.removeLineItemV1("line_item_group_id",
7828
8940
  <dl>
7829
8941
  <dd>
7830
8942
 
7831
- Deletes an ad-hoc line item group. LIG must be ad-hoc (task_group_id is None) and ADJUSTABLE or FINALIZED. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | () -> (bool)
8943
+ Opts the caller back into notifications for a group they were opted out of. | () -> (bool)
7832
8944
 
7833
8945
  </dd>
7834
8946
  </dl>
@@ -7844,7 +8956,7 @@ Deletes an ad-hoc line item group. LIG must be ad-hoc (task_group_id is None) an
7844
8956
  <dd>
7845
8957
 
7846
8958
  ```typescript
7847
- await client.billing.lineItemGroups.adHoc.deleteV1("line_item_group_id");
8959
+ await client.notifications.groups.userOptInV1("group_id");
7848
8960
  ```
7849
8961
 
7850
8962
  </dd>
@@ -7860,7 +8972,7 @@ await client.billing.lineItemGroups.adHoc.deleteV1("line_item_group_id");
7860
8972
  <dl>
7861
8973
  <dd>
7862
8974
 
7863
- **lineItemGroupId:** `string`
8975
+ **groupId:** `string`
7864
8976
 
7865
8977
  </dd>
7866
8978
  </dl>
@@ -7868,7 +8980,7 @@ await client.billing.lineItemGroups.adHoc.deleteV1("line_item_group_id");
7868
8980
  <dl>
7869
8981
  <dd>
7870
8982
 
7871
- **requestOptions:** `AdHoc.RequestOptions`
8983
+ **requestOptions:** `Groups.RequestOptions`
7872
8984
 
7873
8985
  </dd>
7874
8986
  </dl>
@@ -7879,9 +8991,7 @@ await client.billing.lineItemGroups.adHoc.deleteV1("line_item_group_id");
7879
8991
  </dl>
7880
8992
  </details>
7881
8993
 
7882
- ## Billing LineItemGroups Messages
7883
-
7884
- <details><summary><code>client.billing.lineItemGroups.messages.<a href="/src/api/resources/billing/resources/lineItemGroups/resources/messages/client/Client.ts">addV1</a>(lineItemGroupId, { ...params }) -> boolean</code></summary>
8994
+ <details><summary><code>client.notifications.groups.<a href="/src/api/resources/notifications/resources/groups/client/Client.ts">userOptOutV1</a>(groupId) -> boolean</code></summary>
7885
8995
  <dl>
7886
8996
  <dd>
7887
8997
 
@@ -7893,7 +9003,7 @@ await client.billing.lineItemGroups.adHoc.deleteV1("line_item_group_id");
7893
9003
  <dl>
7894
9004
  <dd>
7895
9005
 
7896
- Adds a message to a line item group's message log. | authz_personas=[lig_org_operators, lig_driver] | (AddLineItemGroupMessageReq) -> (bool)
9006
+ Opts the caller out of notifications for a group. | () -> (bool)
7897
9007
 
7898
9008
  </dd>
7899
9009
  </dl>
@@ -7909,9 +9019,7 @@ Adds a message to a line item group's message log. | authz_personas=[lig_org_ope
7909
9019
  <dd>
7910
9020
 
7911
9021
  ```typescript
7912
- await client.billing.lineItemGroups.messages.addV1("line_item_group_id", {
7913
- message: "message",
7914
- });
9022
+ await client.notifications.groups.userOptOutV1("group_id");
7915
9023
  ```
7916
9024
 
7917
9025
  </dd>
@@ -7927,15 +9035,7 @@ await client.billing.lineItemGroups.messages.addV1("line_item_group_id", {
7927
9035
  <dl>
7928
9036
  <dd>
7929
9037
 
7930
- **lineItemGroupId:** `string`
7931
-
7932
- </dd>
7933
- </dl>
7934
-
7935
- <dl>
7936
- <dd>
7937
-
7938
- **request:** `Chrt.billing.lineItemGroups.AddLineItemGroupMessageReq`
9038
+ **groupId:** `string`
7939
9039
 
7940
9040
  </dd>
7941
9041
  </dl>
@@ -7943,7 +9043,7 @@ await client.billing.lineItemGroups.messages.addV1("line_item_group_id", {
7943
9043
  <dl>
7944
9044
  <dd>
7945
9045
 
7946
- **requestOptions:** `Messages.RequestOptions`
9046
+ **requestOptions:** `Groups.RequestOptions`
7947
9047
 
7948
9048
  </dd>
7949
9049
  </dl>
@@ -7954,9 +9054,9 @@ await client.billing.lineItemGroups.messages.addV1("line_item_group_id", {
7954
9054
  </dl>
7955
9055
  </details>
7956
9056
 
7957
- ## Billing LineItemGroups S3Objects
9057
+ ## Notifications UserPreferences
7958
9058
 
7959
- <details><summary><code>client.billing.lineItemGroups.s3Objects.<a href="/src/api/resources/billing/resources/lineItemGroups/resources/s3Objects/client/Client.ts">getS3ObjectMetadataV1</a>(lineItemGroupS3ObjectMetadataId) -> Chrt.LineItemGroupS3ObjectMetadata1</code></summary>
9059
+ <details><summary><code>client.notifications.userPreferences.<a href="/src/api/resources/notifications/resources/userPreferences/client/Client.ts">getV1</a>() -> Chrt.NotificationUserPreferences1</code></summary>
7960
9060
  <dl>
7961
9061
  <dd>
7962
9062
 
@@ -7968,7 +9068,7 @@ await client.billing.lineItemGroups.messages.addV1("line_item_group_id", {
7968
9068
  <dl>
7969
9069
  <dd>
7970
9070
 
7971
- Retrieves the metadata for a line item group S3 object, including blurhash for placeholder loading. | authz_personas=[lig_org_operators, lig_driver] | () -> (LineItemGroupS3ObjectMetadata1)
9071
+ Retrieves the caller's notification preferences. | () -> (NotificationUserPreferences1)
7972
9072
 
7973
9073
  </dd>
7974
9074
  </dl>
@@ -7984,7 +9084,7 @@ Retrieves the metadata for a line item group S3 object, including blurhash for p
7984
9084
  <dd>
7985
9085
 
7986
9086
  ```typescript
7987
- await client.billing.lineItemGroups.s3Objects.getS3ObjectMetadataV1("line_item_group_s3_object_metadata_id");
9087
+ await client.notifications.userPreferences.getV1();
7988
9088
  ```
7989
9089
 
7990
9090
  </dd>
@@ -8000,15 +9100,7 @@ await client.billing.lineItemGroups.s3Objects.getS3ObjectMetadataV1("line_item_g
8000
9100
  <dl>
8001
9101
  <dd>
8002
9102
 
8003
- **lineItemGroupS3ObjectMetadataId:** `string`
8004
-
8005
- </dd>
8006
- </dl>
8007
-
8008
- <dl>
8009
- <dd>
8010
-
8011
- **requestOptions:** `S3Objects.RequestOptions`
9103
+ **requestOptions:** `UserPreferences.RequestOptions`
8012
9104
 
8013
9105
  </dd>
8014
9106
  </dl>
@@ -8019,7 +9111,7 @@ await client.billing.lineItemGroups.s3Objects.getS3ObjectMetadataV1("line_item_g
8019
9111
  </dl>
8020
9112
  </details>
8021
9113
 
8022
- <details><summary><code>client.billing.lineItemGroups.s3Objects.<a href="/src/api/resources/billing/resources/lineItemGroups/resources/s3Objects/client/Client.ts">getV1</a>(lineItemGroupS3ObjectMetadataId) -> core.BinaryResponse</code></summary>
9114
+ <details><summary><code>client.notifications.userPreferences.<a href="/src/api/resources/notifications/resources/userPreferences/client/Client.ts">createV1</a>() -> Chrt.NotificationUserPreferences1</code></summary>
8023
9115
  <dl>
8024
9116
  <dd>
8025
9117
 
@@ -8031,7 +9123,7 @@ await client.billing.lineItemGroups.s3Objects.getS3ObjectMetadataV1("line_item_g
8031
9123
  <dl>
8032
9124
  <dd>
8033
9125
 
8034
- Streams a line item group S3 object file from storage. | authz_personas=[lig_org_operators, lig_driver] | () -> (binary)
9126
+ Creates a new notification preferences record for the caller. Returns existing preferences if already created. | () -> (NotificationUserPreferences1)
8035
9127
 
8036
9128
  </dd>
8037
9129
  </dl>
@@ -8047,7 +9139,7 @@ Streams a line item group S3 object file from storage. | authz_personas=[lig_org
8047
9139
  <dd>
8048
9140
 
8049
9141
  ```typescript
8050
- await client.billing.lineItemGroups.s3Objects.getV1("line_item_group_s3_object_metadata_id");
9142
+ await client.notifications.userPreferences.createV1();
8051
9143
  ```
8052
9144
 
8053
9145
  </dd>
@@ -8063,15 +9155,7 @@ await client.billing.lineItemGroups.s3Objects.getV1("line_item_group_s3_object_m
8063
9155
  <dl>
8064
9156
  <dd>
8065
9157
 
8066
- **lineItemGroupS3ObjectMetadataId:** `string`
8067
-
8068
- </dd>
8069
- </dl>
8070
-
8071
- <dl>
8072
- <dd>
8073
-
8074
- **requestOptions:** `S3Objects.RequestOptions`
9158
+ **requestOptions:** `UserPreferences.RequestOptions`
8075
9159
 
8076
9160
  </dd>
8077
9161
  </dl>
@@ -8082,7 +9166,7 @@ await client.billing.lineItemGroups.s3Objects.getV1("line_item_group_s3_object_m
8082
9166
  </dl>
8083
9167
  </details>
8084
9168
 
8085
- <details><summary><code>client.billing.lineItemGroups.s3Objects.<a href="/src/api/resources/billing/resources/lineItemGroups/resources/s3Objects/client/Client.ts">addV1</a>(lineItemGroupId, { ...params }) -> boolean</code></summary>
9169
+ <details><summary><code>client.notifications.userPreferences.<a href="/src/api/resources/notifications/resources/userPreferences/client/Client.ts">updateV1</a>({ ...params }) -> Chrt.NotificationUserPreferences1</code></summary>
8086
9170
  <dl>
8087
9171
  <dd>
8088
9172
 
@@ -8094,7 +9178,7 @@ await client.billing.lineItemGroups.s3Objects.getV1("line_item_group_s3_object_m
8094
9178
  <dl>
8095
9179
  <dd>
8096
9180
 
8097
- Uploads an image file to a line item group with automatic blurhash generation. | authz_personas=[lig_org_operators, lig_driver] | (UploadFile) -> (bool)
9181
+ Updates notification preferences with explicit events, opt-in, or opt-out operations. | (UserNotificationPreferencesUpdateRequest) -> (NotificationUserPreferences1)
8098
9182
 
8099
9183
  </dd>
8100
9184
  </dl>
@@ -8110,9 +9194,7 @@ Uploads an image file to a line item group with automatic blurhash generation. |
8110
9194
  <dd>
8111
9195
 
8112
9196
  ```typescript
8113
- await client.billing.lineItemGroups.s3Objects.addV1("line_item_group_id", {
8114
- image: fs.createReadStream("/path/to/your/file"),
8115
- });
9197
+ await client.notifications.userPreferences.updateV1();
8116
9198
  ```
8117
9199
 
8118
9200
  </dd>
@@ -8128,15 +9210,7 @@ await client.billing.lineItemGroups.s3Objects.addV1("line_item_group_id", {
8128
9210
  <dl>
8129
9211
  <dd>
8130
9212
 
8131
- **lineItemGroupId:** `string`
8132
-
8133
- </dd>
8134
- </dl>
8135
-
8136
- <dl>
8137
- <dd>
8138
-
8139
- **request:** `Chrt.billing.lineItemGroups.BodyLineItemGroupsS3ObjectPostAddV1BillingLineItemGroupsS3ObjectsAddV1LineItemGroupIdPost`
9213
+ **request:** `Chrt.notifications.UserNotificationPreferencesUpdateRequest`
8140
9214
 
8141
9215
  </dd>
8142
9216
  </dl>
@@ -8144,7 +9218,7 @@ await client.billing.lineItemGroups.s3Objects.addV1("line_item_group_id", {
8144
9218
  <dl>
8145
9219
  <dd>
8146
9220
 
8147
- **requestOptions:** `S3Objects.RequestOptions`
9221
+ **requestOptions:** `UserPreferences.RequestOptions`
8148
9222
 
8149
9223
  </dd>
8150
9224
  </dl>
@@ -8155,7 +9229,9 @@ await client.billing.lineItemGroups.s3Objects.addV1("line_item_group_id", {
8155
9229
  </dl>
8156
9230
  </details>
8157
9231
 
8158
- <details><summary><code>client.billing.lineItemGroups.s3Objects.<a href="/src/api/resources/billing/resources/lineItemGroups/resources/s3Objects/client/Client.ts">deleteV1</a>(lineItemGroupS3ObjectMetadataId) -> boolean</code></summary>
9232
+ ## Notifications WebhookSetup
9233
+
9234
+ <details><summary><code>client.notifications.webhookSetup.<a href="/src/api/resources/notifications/resources/webhookSetup/client/Client.ts">createAppV1</a>() -> boolean</code></summary>
8159
9235
  <dl>
8160
9236
  <dd>
8161
9237
 
@@ -8167,7 +9243,7 @@ await client.billing.lineItemGroups.s3Objects.addV1("line_item_group_id", {
8167
9243
  <dl>
8168
9244
  <dd>
8169
9245
 
8170
- Deletes an S3 object metadata and the associated S3 object from a line item group. | authz_personas=[lig_org_operators, lig_driver] | () -> (bool)
9246
+ Creates a Svix consumer application for the organization. Each org needs one app, then endpoints can be added and configured via the app portal. Idempotent - returns True if already created. | authz: min_org_role=administrator | () -> (bool)
8171
9247
 
8172
9248
  </dd>
8173
9249
  </dl>
@@ -8183,7 +9259,7 @@ Deletes an S3 object metadata and the associated S3 object from a line item grou
8183
9259
  <dd>
8184
9260
 
8185
9261
  ```typescript
8186
- await client.billing.lineItemGroups.s3Objects.deleteV1("line_item_group_s3_object_metadata_id");
9262
+ await client.notifications.webhookSetup.createAppV1();
8187
9263
  ```
8188
9264
 
8189
9265
  </dd>
@@ -8199,15 +9275,7 @@ await client.billing.lineItemGroups.s3Objects.deleteV1("line_item_group_s3_objec
8199
9275
  <dl>
8200
9276
  <dd>
8201
9277
 
8202
- **lineItemGroupS3ObjectMetadataId:** `string`
8203
-
8204
- </dd>
8205
- </dl>
8206
-
8207
- <dl>
8208
- <dd>
8209
-
8210
- **requestOptions:** `S3Objects.RequestOptions`
9278
+ **requestOptions:** `WebhookSetup.RequestOptions`
8211
9279
 
8212
9280
  </dd>
8213
9281
  </dl>
@@ -8218,9 +9286,7 @@ await client.billing.lineItemGroups.s3Objects.deleteV1("line_item_group_s3_objec
8218
9286
  </dl>
8219
9287
  </details>
8220
9288
 
8221
- ## Connections ConnectionToCourier
8222
-
8223
- <details><summary><code>client.connections.connectionToCourier.<a href="/src/api/resources/connections/resources/connectionToCourier/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
9289
+ <details><summary><code>client.notifications.webhookSetup.<a href="/src/api/resources/notifications/resources/webhookSetup/client/Client.ts">appPortalAccessV1</a>() -> Chrt.WebhookAppPortalAccessRes</code></summary>
8224
9290
  <dl>
8225
9291
  <dd>
8226
9292
 
@@ -8232,7 +9298,7 @@ await client.billing.lineItemGroups.s3Objects.deleteV1("line_item_group_s3_objec
8232
9298
  <dl>
8233
9299
  <dd>
8234
9300
 
8235
- Creates a new connection to a courier organization. Shippers and forwarders can initiate connections to couriers. | (CreateConnectionReq) -> (PydanticObjectId)
9301
+ Returns a 1-day magic link URL to access the Svix App Portal. The link contains a one-time token - request a fresh link for each portal session. Admins/owners get full access, operators get read-only. | authz: min_org_role=operator | () -> (WebhookAppPortalAccessRes)
8236
9302
 
8237
9303
  </dd>
8238
9304
  </dl>
@@ -8248,9 +9314,7 @@ Creates a new connection to a courier organization. Shippers and forwarders can
8248
9314
  <dd>
8249
9315
 
8250
9316
  ```typescript
8251
- await client.connections.connectionToCourier.createV1({
8252
- handle: "handle",
8253
- });
9317
+ await client.notifications.webhookSetup.appPortalAccessV1();
8254
9318
  ```
8255
9319
 
8256
9320
  </dd>
@@ -8266,15 +9330,7 @@ await client.connections.connectionToCourier.createV1({
8266
9330
  <dl>
8267
9331
  <dd>
8268
9332
 
8269
- **request:** `Chrt.CreateConnectionReq`
8270
-
8271
- </dd>
8272
- </dl>
8273
-
8274
- <dl>
8275
- <dd>
8276
-
8277
- **requestOptions:** `ConnectionToCourier.RequestOptions`
9333
+ **requestOptions:** `WebhookSetup.RequestOptions`
8278
9334
 
8279
9335
  </dd>
8280
9336
  </dl>
@@ -8285,9 +9341,7 @@ await client.connections.connectionToCourier.createV1({
8285
9341
  </dl>
8286
9342
  </details>
8287
9343
 
8288
- ## Connections ConnectionToShipper
8289
-
8290
- <details><summary><code>client.connections.connectionToShipper.<a href="/src/api/resources/connections/resources/connectionToShipper/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
9344
+ <details><summary><code>client.notifications.webhookSetup.<a href="/src/api/resources/notifications/resources/webhookSetup/client/Client.ts">turnOnV1</a>() -> boolean</code></summary>
8291
9345
  <dl>
8292
9346
  <dd>
8293
9347
 
@@ -8299,7 +9353,7 @@ await client.connections.connectionToCourier.createV1({
8299
9353
  <dl>
8300
9354
  <dd>
8301
9355
 
8302
- Creates a new connection to a shipper organization. Only forwarders can initiate connections to shippers. | (CreateConnectionReq) -> (PydanticObjectId)
9356
+ Enables webhook notifications for the organization. Idempotent. | authz: min_org_role=administrator | () -> (bool)
8303
9357
 
8304
9358
  </dd>
8305
9359
  </dl>
@@ -8315,9 +9369,7 @@ Creates a new connection to a shipper organization. Only forwarders can initiate
8315
9369
  <dd>
8316
9370
 
8317
9371
  ```typescript
8318
- await client.connections.connectionToShipper.createV1({
8319
- handle: "handle",
8320
- });
9372
+ await client.notifications.webhookSetup.turnOnV1();
8321
9373
  ```
8322
9374
 
8323
9375
  </dd>
@@ -8333,15 +9385,7 @@ await client.connections.connectionToShipper.createV1({
8333
9385
  <dl>
8334
9386
  <dd>
8335
9387
 
8336
- **request:** `Chrt.CreateConnectionReq`
8337
-
8338
- </dd>
8339
- </dl>
8340
-
8341
- <dl>
8342
- <dd>
8343
-
8344
- **requestOptions:** `ConnectionToShipper.RequestOptions`
9388
+ **requestOptions:** `WebhookSetup.RequestOptions`
8345
9389
 
8346
9390
  </dd>
8347
9391
  </dl>
@@ -8352,9 +9396,7 @@ await client.connections.connectionToShipper.createV1({
8352
9396
  </dl>
8353
9397
  </details>
8354
9398
 
8355
- ## Connections ConnectionToForwarder
8356
-
8357
- <details><summary><code>client.connections.connectionToForwarder.<a href="/src/api/resources/connections/resources/connectionToForwarder/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
9399
+ <details><summary><code>client.notifications.webhookSetup.<a href="/src/api/resources/notifications/resources/webhookSetup/client/Client.ts">turnOffV1</a>() -> boolean</code></summary>
8358
9400
  <dl>
8359
9401
  <dd>
8360
9402
 
@@ -8366,7 +9408,7 @@ await client.connections.connectionToShipper.createV1({
8366
9408
  <dl>
8367
9409
  <dd>
8368
9410
 
8369
- Creates a new connection to a forwarder organization. Only shippers can initiate connections to forwarders. | (CreateConnectionReq) -> (PydanticObjectId)
9411
+ Disables webhook notifications for the organization. Idempotent. | authz: min_org_role=administrator | () -> (bool)
8370
9412
 
8371
9413
  </dd>
8372
9414
  </dl>
@@ -8382,9 +9424,7 @@ Creates a new connection to a forwarder organization. Only shippers can initiate
8382
9424
  <dd>
8383
9425
 
8384
9426
  ```typescript
8385
- await client.connections.connectionToForwarder.createV1({
8386
- handle: "handle",
8387
- });
9427
+ await client.notifications.webhookSetup.turnOffV1();
8388
9428
  ```
8389
9429
 
8390
9430
  </dd>
@@ -8400,15 +9440,7 @@ await client.connections.connectionToForwarder.createV1({
8400
9440
  <dl>
8401
9441
  <dd>
8402
9442
 
8403
- **request:** `Chrt.CreateConnectionReq`
8404
-
8405
- </dd>
8406
- </dl>
8407
-
8408
- <dl>
8409
- <dd>
8410
-
8411
- **requestOptions:** `ConnectionToForwarder.RequestOptions`
9443
+ **requestOptions:** `WebhookSetup.RequestOptions`
8412
9444
 
8413
9445
  </dd>
8414
9446
  </dl>