@chrt-inc/typescript-sdk 1.681.0 → 1.685.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 (198) hide show
  1. package/dist/cjs/Client.js +2 -2
  2. package/dist/cjs/api/resources/orgs/client/Client.d.ts +3 -0
  3. package/dist/cjs/api/resources/orgs/client/Client.js +13 -8
  4. package/dist/cjs/api/resources/orgs/resources/complianceDocuments/client/Client.d.ts +76 -0
  5. package/dist/cjs/api/resources/orgs/resources/complianceDocuments/client/Client.js +248 -0
  6. package/dist/cjs/api/resources/orgs/resources/complianceDocuments/client/index.d.ts +2 -0
  7. package/dist/cjs/api/resources/orgs/resources/complianceDocuments/client/index.js +17 -0
  8. package/dist/cjs/api/resources/orgs/resources/complianceDocuments/client/requests/OrgComplianceDocumentClientCreate1.d.ts +17 -0
  9. package/dist/cjs/api/resources/orgs/resources/complianceDocuments/client/requests/index.d.ts +1 -0
  10. package/dist/cjs/api/resources/orgs/resources/complianceDocuments/client/requests/index.js +2 -0
  11. package/dist/cjs/api/resources/orgs/resources/complianceDocuments/index.d.ts +2 -0
  12. package/dist/cjs/api/resources/orgs/resources/complianceDocuments/index.js +18 -0
  13. package/dist/cjs/api/resources/orgs/resources/complianceDocuments/resources/index.d.ts +2 -0
  14. package/dist/cjs/api/resources/orgs/resources/complianceDocuments/resources/index.js +41 -0
  15. package/dist/cjs/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/Client.d.ts +83 -0
  16. package/dist/cjs/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/Client.js +311 -0
  17. package/dist/cjs/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/index.d.ts +2 -0
  18. package/dist/cjs/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/index.js +17 -0
  19. package/dist/cjs/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/requests/BodyPostOrgComplianceDocumentsS3ObjectAddV1OrgsComplianceDocumentsS3ObjectAddV1OrgComplianceDocumentIdPost.d.ts +13 -0
  20. package/dist/cjs/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/requests/BodyPostOrgComplianceDocumentsS3ObjectAddV1OrgsComplianceDocumentsS3ObjectAddV1OrgComplianceDocumentIdPost.js +5 -0
  21. package/dist/cjs/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/requests/index.d.ts +1 -0
  22. package/dist/cjs/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/requests/index.js +2 -0
  23. package/dist/cjs/api/resources/orgs/resources/complianceDocuments/resources/s3Object/index.d.ts +1 -0
  24. package/dist/cjs/api/resources/orgs/resources/complianceDocuments/resources/s3Object/index.js +17 -0
  25. package/dist/cjs/api/resources/orgs/resources/index.d.ts +2 -0
  26. package/dist/cjs/api/resources/orgs/resources/index.js +3 -1
  27. package/dist/cjs/api/resources/shipping/resources/drivers/client/Client.d.ts +3 -0
  28. package/dist/cjs/api/resources/shipping/resources/drivers/client/Client.js +5 -0
  29. package/dist/cjs/api/resources/shipping/resources/drivers/index.d.ts +1 -0
  30. package/dist/cjs/api/resources/shipping/resources/drivers/index.js +1 -0
  31. package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/Client.d.ts +80 -0
  32. package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/Client.js +257 -0
  33. package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/index.d.ts +2 -0
  34. package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/index.js +17 -0
  35. package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/DriverComplianceDocumentClientCreate1.d.ts +17 -0
  36. package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/DriverComplianceDocumentClientCreate1.js +5 -0
  37. package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/index.d.ts +1 -0
  38. package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/index.js +2 -0
  39. package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/index.d.ts +2 -0
  40. package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/index.js +18 -0
  41. package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/index.d.ts +2 -0
  42. package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/index.js +41 -0
  43. package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/Client.d.ts +83 -0
  44. package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/Client.js +311 -0
  45. package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/index.d.ts +2 -0
  46. package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/index.js +17 -0
  47. package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/requests/BodyPostDriverComplianceDocumentsS3ObjectAddV1ShippingDriversComplianceDocumentsS3ObjectAddV1DriverComplianceDocumentIdPost.d.ts +13 -0
  48. package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/requests/BodyPostDriverComplianceDocumentsS3ObjectAddV1ShippingDriversComplianceDocumentsS3ObjectAddV1DriverComplianceDocumentIdPost.js +5 -0
  49. package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/requests/index.d.ts +1 -0
  50. package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/requests/index.js +2 -0
  51. package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/index.d.ts +1 -0
  52. package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/index.js +17 -0
  53. package/dist/cjs/api/resources/shipping/resources/drivers/resources/index.d.ts +2 -0
  54. package/dist/cjs/api/resources/shipping/resources/drivers/resources/index.js +41 -0
  55. package/dist/cjs/api/resources/shipping/resources/tasks/client/Client.d.ts +1 -1
  56. package/dist/cjs/api/resources/shipping/resources/tasks/client/Client.js +1 -1
  57. package/dist/cjs/api/types/BillingLineItemS3ObjectAddedWebhookPayload.d.ts +14 -0
  58. package/dist/cjs/api/types/BillingLineItemS3ObjectAddedWebhookPayload.js +5 -0
  59. package/dist/cjs/api/types/DateTimeWindow1.d.ts +7 -0
  60. package/dist/cjs/api/types/DateTimeWindow1.js +5 -0
  61. package/dist/cjs/api/types/DriverComplianceDocument1.d.ts +15 -0
  62. package/dist/cjs/api/types/DriverComplianceDocument1.js +5 -0
  63. package/dist/cjs/api/types/DriverComplianceDocumentS3ObjectMetadata1.d.ts +19 -0
  64. package/dist/cjs/api/types/DriverComplianceDocumentS3ObjectMetadata1.js +5 -0
  65. package/dist/cjs/api/types/DriverComplianceDocumentTypeEnum1.d.ts +8 -0
  66. package/dist/cjs/api/types/DriverComplianceDocumentTypeEnum1.js +10 -0
  67. package/dist/cjs/api/types/ListingBidThreadActionAddedWebhookPayload.d.ts +21 -0
  68. package/dist/cjs/api/types/ListingBidThreadActionAddedWebhookPayload.js +5 -0
  69. package/dist/cjs/api/types/NotificationEventsForOrgsEnum.d.ts +8 -2
  70. package/dist/cjs/api/types/NotificationEventsForOrgsEnum.js +7 -1
  71. package/dist/cjs/api/types/NotificationEventsForUsersEnum.d.ts +7 -1
  72. package/dist/cjs/api/types/NotificationEventsForUsersEnum.js +6 -0
  73. package/dist/cjs/api/types/OperationsCaseMessageWebhookPayload.d.ts +15 -0
  74. package/dist/cjs/api/types/OperationsCaseMessageWebhookPayload.js +5 -0
  75. package/dist/cjs/api/types/OperationsCaseS3ObjectAddedWebhookPayload.d.ts +14 -0
  76. package/dist/cjs/api/types/OperationsCaseS3ObjectAddedWebhookPayload.js +5 -0
  77. package/dist/cjs/api/types/OrgComplianceDocument1.d.ts +15 -0
  78. package/dist/cjs/api/types/OrgComplianceDocument1.js +5 -0
  79. package/dist/cjs/api/types/OrgComplianceDocumentS3ObjectMetadata1.d.ts +19 -0
  80. package/dist/cjs/api/types/OrgComplianceDocumentS3ObjectMetadata1.js +5 -0
  81. package/dist/cjs/api/types/OrgComplianceDocumentTypeEnum1.d.ts +8 -0
  82. package/dist/cjs/api/types/OrgComplianceDocumentTypeEnum1.js +10 -0
  83. package/dist/cjs/api/types/ShippingTaskAttemptedWebhookPayload.d.ts +22 -0
  84. package/dist/cjs/api/types/ShippingTaskAttemptedWebhookPayload.js +5 -0
  85. package/dist/cjs/api/types/ShippingTaskExecutorOrgNoteAddedWebhookPayload.d.ts +17 -0
  86. package/dist/cjs/api/types/ShippingTaskExecutorOrgNoteAddedWebhookPayload.js +5 -0
  87. package/dist/cjs/api/types/ShippingTaskGroupProviderAssignedWebhookPayload.d.ts +14 -0
  88. package/dist/cjs/api/types/ShippingTaskGroupProviderAssignedWebhookPayload.js +5 -0
  89. package/dist/cjs/api/types/Task1.d.ts +1 -1
  90. package/dist/cjs/api/types/TaskClientCreate1.d.ts +1 -1
  91. package/dist/cjs/api/types/TaskClientUpdate1.d.ts +1 -1
  92. package/dist/cjs/api/types/TimeWindow1.d.ts +2 -2
  93. package/dist/cjs/api/types/index.d.ts +14 -1
  94. package/dist/cjs/api/types/index.js +14 -1
  95. package/dist/cjs/version.d.ts +1 -1
  96. package/dist/cjs/version.js +1 -1
  97. package/dist/esm/Client.mjs +2 -2
  98. package/dist/esm/api/resources/orgs/client/Client.d.mts +3 -0
  99. package/dist/esm/api/resources/orgs/client/Client.mjs +5 -0
  100. package/dist/esm/api/resources/orgs/resources/complianceDocuments/client/Client.d.mts +76 -0
  101. package/dist/esm/api/resources/orgs/resources/complianceDocuments/client/Client.mjs +211 -0
  102. package/dist/esm/api/resources/orgs/resources/complianceDocuments/client/index.d.mts +2 -0
  103. package/dist/esm/api/resources/orgs/resources/complianceDocuments/client/index.mjs +1 -0
  104. package/dist/esm/api/resources/orgs/resources/complianceDocuments/client/requests/OrgComplianceDocumentClientCreate1.d.mts +17 -0
  105. package/dist/esm/api/resources/orgs/resources/complianceDocuments/client/requests/index.d.mts +1 -0
  106. package/dist/esm/api/resources/orgs/resources/complianceDocuments/client/requests/index.mjs +1 -0
  107. package/dist/esm/api/resources/orgs/resources/complianceDocuments/index.d.mts +2 -0
  108. package/dist/esm/api/resources/orgs/resources/complianceDocuments/index.mjs +2 -0
  109. package/dist/esm/api/resources/orgs/resources/complianceDocuments/resources/index.d.mts +2 -0
  110. package/dist/esm/api/resources/orgs/resources/complianceDocuments/resources/index.mjs +2 -0
  111. package/dist/esm/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/Client.d.mts +83 -0
  112. package/dist/esm/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/Client.mjs +274 -0
  113. package/dist/esm/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/index.d.mts +2 -0
  114. package/dist/esm/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/index.mjs +1 -0
  115. package/dist/esm/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/requests/BodyPostOrgComplianceDocumentsS3ObjectAddV1OrgsComplianceDocumentsS3ObjectAddV1OrgComplianceDocumentIdPost.d.mts +13 -0
  116. package/dist/esm/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/requests/BodyPostOrgComplianceDocumentsS3ObjectAddV1OrgsComplianceDocumentsS3ObjectAddV1OrgComplianceDocumentIdPost.mjs +4 -0
  117. package/dist/esm/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/requests/index.d.mts +1 -0
  118. package/dist/esm/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/requests/index.mjs +1 -0
  119. package/dist/esm/api/resources/orgs/resources/complianceDocuments/resources/s3Object/index.d.mts +1 -0
  120. package/dist/esm/api/resources/orgs/resources/complianceDocuments/resources/s3Object/index.mjs +1 -0
  121. package/dist/esm/api/resources/orgs/resources/index.d.mts +2 -0
  122. package/dist/esm/api/resources/orgs/resources/index.mjs +2 -0
  123. package/dist/esm/api/resources/shipping/resources/drivers/client/Client.d.mts +3 -0
  124. package/dist/esm/api/resources/shipping/resources/drivers/client/Client.mjs +5 -0
  125. package/dist/esm/api/resources/shipping/resources/drivers/index.d.mts +1 -0
  126. package/dist/esm/api/resources/shipping/resources/drivers/index.mjs +1 -0
  127. package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/Client.d.mts +80 -0
  128. package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/Client.mjs +220 -0
  129. package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/index.d.mts +2 -0
  130. package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/index.mjs +1 -0
  131. package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/DriverComplianceDocumentClientCreate1.d.mts +17 -0
  132. package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/DriverComplianceDocumentClientCreate1.mjs +4 -0
  133. package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/index.d.mts +1 -0
  134. package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/index.mjs +1 -0
  135. package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/index.d.mts +2 -0
  136. package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/index.mjs +2 -0
  137. package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/index.d.mts +2 -0
  138. package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/index.mjs +2 -0
  139. package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/Client.d.mts +83 -0
  140. package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/Client.mjs +274 -0
  141. package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/index.d.mts +2 -0
  142. package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/index.mjs +1 -0
  143. package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/requests/BodyPostDriverComplianceDocumentsS3ObjectAddV1ShippingDriversComplianceDocumentsS3ObjectAddV1DriverComplianceDocumentIdPost.d.mts +13 -0
  144. package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/requests/BodyPostDriverComplianceDocumentsS3ObjectAddV1ShippingDriversComplianceDocumentsS3ObjectAddV1DriverComplianceDocumentIdPost.mjs +4 -0
  145. package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/requests/index.d.mts +1 -0
  146. package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/requests/index.mjs +1 -0
  147. package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/index.d.mts +1 -0
  148. package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/index.mjs +1 -0
  149. package/dist/esm/api/resources/shipping/resources/drivers/resources/index.d.mts +2 -0
  150. package/dist/esm/api/resources/shipping/resources/drivers/resources/index.mjs +2 -0
  151. package/dist/esm/api/resources/shipping/resources/tasks/client/Client.d.mts +1 -1
  152. package/dist/esm/api/resources/shipping/resources/tasks/client/Client.mjs +1 -1
  153. package/dist/esm/api/types/BillingLineItemS3ObjectAddedWebhookPayload.d.mts +14 -0
  154. package/dist/esm/api/types/BillingLineItemS3ObjectAddedWebhookPayload.mjs +4 -0
  155. package/dist/esm/api/types/DateTimeWindow1.d.mts +7 -0
  156. package/dist/esm/api/types/DateTimeWindow1.mjs +4 -0
  157. package/dist/esm/api/types/DriverComplianceDocument1.d.mts +15 -0
  158. package/dist/esm/api/types/DriverComplianceDocument1.mjs +4 -0
  159. package/dist/esm/api/types/DriverComplianceDocumentS3ObjectMetadata1.d.mts +19 -0
  160. package/dist/esm/api/types/DriverComplianceDocumentS3ObjectMetadata1.mjs +4 -0
  161. package/dist/esm/api/types/DriverComplianceDocumentTypeEnum1.d.mts +8 -0
  162. package/dist/esm/api/types/DriverComplianceDocumentTypeEnum1.mjs +7 -0
  163. package/dist/esm/api/types/ListingBidThreadActionAddedWebhookPayload.d.mts +21 -0
  164. package/dist/esm/api/types/ListingBidThreadActionAddedWebhookPayload.mjs +4 -0
  165. package/dist/esm/api/types/NotificationEventsForOrgsEnum.d.mts +8 -2
  166. package/dist/esm/api/types/NotificationEventsForOrgsEnum.mjs +7 -1
  167. package/dist/esm/api/types/NotificationEventsForUsersEnum.d.mts +7 -1
  168. package/dist/esm/api/types/NotificationEventsForUsersEnum.mjs +6 -0
  169. package/dist/esm/api/types/OperationsCaseMessageWebhookPayload.d.mts +15 -0
  170. package/dist/esm/api/types/OperationsCaseMessageWebhookPayload.mjs +4 -0
  171. package/dist/esm/api/types/OperationsCaseS3ObjectAddedWebhookPayload.d.mts +14 -0
  172. package/dist/esm/api/types/OperationsCaseS3ObjectAddedWebhookPayload.mjs +4 -0
  173. package/dist/esm/api/types/OrgComplianceDocument1.d.mts +15 -0
  174. package/dist/esm/api/types/OrgComplianceDocument1.mjs +4 -0
  175. package/dist/esm/api/types/OrgComplianceDocumentS3ObjectMetadata1.d.mts +19 -0
  176. package/dist/esm/api/types/OrgComplianceDocumentS3ObjectMetadata1.mjs +4 -0
  177. package/dist/esm/api/types/OrgComplianceDocumentTypeEnum1.d.mts +8 -0
  178. package/dist/esm/api/types/OrgComplianceDocumentTypeEnum1.mjs +7 -0
  179. package/dist/esm/api/types/ShippingTaskAttemptedWebhookPayload.d.mts +22 -0
  180. package/dist/esm/api/types/ShippingTaskAttemptedWebhookPayload.mjs +4 -0
  181. package/dist/esm/api/types/ShippingTaskExecutorOrgNoteAddedWebhookPayload.d.mts +17 -0
  182. package/dist/esm/api/types/ShippingTaskExecutorOrgNoteAddedWebhookPayload.mjs +4 -0
  183. package/dist/esm/api/types/ShippingTaskGroupProviderAssignedWebhookPayload.d.mts +14 -0
  184. package/dist/esm/api/types/ShippingTaskGroupProviderAssignedWebhookPayload.mjs +4 -0
  185. package/dist/esm/api/types/Task1.d.mts +1 -1
  186. package/dist/esm/api/types/TaskClientCreate1.d.mts +1 -1
  187. package/dist/esm/api/types/TaskClientUpdate1.d.mts +1 -1
  188. package/dist/esm/api/types/TimeWindow1.d.mts +2 -2
  189. package/dist/esm/api/types/index.d.mts +14 -1
  190. package/dist/esm/api/types/index.mjs +14 -1
  191. package/dist/esm/version.d.mts +1 -1
  192. package/dist/esm/version.mjs +1 -1
  193. package/package.json +1 -1
  194. package/reference.md +1487 -569
  195. package/dist/cjs/api/types/ShippingTaskGroupCourierOrgAssignedWebhookPayload.d.ts +0 -14
  196. package/dist/esm/api/types/ShippingTaskGroupCourierOrgAssignedWebhookPayload.d.mts +0 -14
  197. /package/dist/cjs/api/{types/ShippingTaskGroupCourierOrgAssignedWebhookPayload.js → resources/orgs/resources/complianceDocuments/client/requests/OrgComplianceDocumentClientCreate1.js} +0 -0
  198. /package/dist/esm/api/{types/ShippingTaskGroupCourierOrgAssignedWebhookPayload.mjs → resources/orgs/resources/complianceDocuments/client/requests/OrgComplianceDocumentClientCreate1.mjs} +0 -0
package/reference.md CHANGED
@@ -13468,9 +13468,9 @@ await client.orgs.offChrtShipperOrg.updateByIdV1("id");
13468
13468
  </dl>
13469
13469
  </details>
13470
13470
 
13471
- ## Orgs PrivateData
13471
+ ## Orgs ComplianceDocuments
13472
13472
 
13473
- <details><summary><code>client.orgs.privateData.<a href="/src/api/resources/orgs/resources/privateData/client/Client.ts">getV1</a>() -> Chrt.OrgPrivateData1</code></summary>
13473
+ <details><summary><code>client.orgs.complianceDocuments.<a href="/src/api/resources/orgs/resources/complianceDocuments/client/Client.ts">listV1</a>() -> Chrt.OrgComplianceDocument1[]</code></summary>
13474
13474
  <dl>
13475
13475
  <dd>
13476
13476
 
@@ -13482,7 +13482,7 @@ await client.orgs.offChrtShipperOrg.updateByIdV1("id");
13482
13482
  <dl>
13483
13483
  <dd>
13484
13484
 
13485
- Retrieves private organization data for the caller's organization. | authz: min_org_role=operator | () -> (OrgPrivateData1)
13485
+ Lists compliance documents for the caller's provider organization. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (list[OrgComplianceDocument1])
13486
13486
 
13487
13487
  </dd>
13488
13488
  </dl>
@@ -13498,7 +13498,7 @@ Retrieves private organization data for the caller's organization. | authz: min_
13498
13498
  <dd>
13499
13499
 
13500
13500
  ```typescript
13501
- await client.orgs.privateData.getV1();
13501
+ await client.orgs.complianceDocuments.listV1();
13502
13502
  ```
13503
13503
 
13504
13504
  </dd>
@@ -13514,7 +13514,7 @@ await client.orgs.privateData.getV1();
13514
13514
  <dl>
13515
13515
  <dd>
13516
13516
 
13517
- **requestOptions:** `PrivateData.RequestOptions`
13517
+ **requestOptions:** `ComplianceDocuments.RequestOptions`
13518
13518
 
13519
13519
  </dd>
13520
13520
  </dl>
@@ -13525,9 +13525,7 @@ await client.orgs.privateData.getV1();
13525
13525
  </dl>
13526
13526
  </details>
13527
13527
 
13528
- ## Orgs OrgProfiles
13529
-
13530
- <details><summary><code>client.orgs.orgProfiles.<a href="/src/api/resources/orgs/resources/orgProfiles/client/Client.ts">getV1</a>() -> Chrt.ProviderOrgProfile1</code></summary>
13528
+ <details><summary><code>client.orgs.complianceDocuments.<a href="/src/api/resources/orgs/resources/complianceDocuments/client/Client.ts">getV1</a>(orgComplianceDocumentId) -> Chrt.OrgComplianceDocument1</code></summary>
13531
13529
  <dl>
13532
13530
  <dd>
13533
13531
 
@@ -13539,7 +13537,7 @@ await client.orgs.privateData.getV1();
13539
13537
  <dl>
13540
13538
  <dd>
13541
13539
 
13542
- Retrieves the provider organization profile for the caller's organization. | () -> (ProviderOrgProfile1)
13540
+ Retrieves one compliance document for the caller's provider organization. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (OrgComplianceDocument1)
13543
13541
 
13544
13542
  </dd>
13545
13543
  </dl>
@@ -13555,7 +13553,7 @@ Retrieves the provider organization profile for the caller's organization. | ()
13555
13553
  <dd>
13556
13554
 
13557
13555
  ```typescript
13558
- await client.orgs.orgProfiles.getV1();
13556
+ await client.orgs.complianceDocuments.getV1("org_compliance_document_id");
13559
13557
  ```
13560
13558
 
13561
13559
  </dd>
@@ -13571,7 +13569,15 @@ await client.orgs.orgProfiles.getV1();
13571
13569
  <dl>
13572
13570
  <dd>
13573
13571
 
13574
- **requestOptions:** `OrgProfiles.RequestOptions`
13572
+ **orgComplianceDocumentId:** `string`
13573
+
13574
+ </dd>
13575
+ </dl>
13576
+
13577
+ <dl>
13578
+ <dd>
13579
+
13580
+ **requestOptions:** `ComplianceDocuments.RequestOptions`
13575
13581
 
13576
13582
  </dd>
13577
13583
  </dl>
@@ -13582,7 +13588,7 @@ await client.orgs.orgProfiles.getV1();
13582
13588
  </dl>
13583
13589
  </details>
13584
13590
 
13585
- <details><summary><code>client.orgs.orgProfiles.<a href="/src/api/resources/orgs/resources/orgProfiles/client/Client.ts">createProviderV1</a>({ ...params }) -> string</code></summary>
13591
+ <details><summary><code>client.orgs.complianceDocuments.<a href="/src/api/resources/orgs/resources/complianceDocuments/client/Client.ts">createV1</a>({ ...params }) -> Chrt.OrgComplianceDocument1</code></summary>
13586
13592
  <dl>
13587
13593
  <dd>
13588
13594
 
@@ -13594,7 +13600,7 @@ await client.orgs.orgProfiles.getV1();
13594
13600
  <dl>
13595
13601
  <dd>
13596
13602
 
13597
- Creates a new provider organization profile. Fails if a profile already exists for the organization. | (ProviderOrgProfileClientCreate1) -> (PydanticObjectId)
13603
+ Creates a compliance document record for the caller's provider organization. | authz: allowed_org_types=[provider], min_org_role=administrator | (OrgComplianceDocumentClientCreate1) -> (OrgComplianceDocument1)
13598
13604
 
13599
13605
  </dd>
13600
13606
  </dl>
@@ -13610,11 +13616,9 @@ Creates a new provider organization profile. Fails if a profile already exists f
13610
13616
  <dd>
13611
13617
 
13612
13618
  ```typescript
13613
- await client.orgs.orgProfiles.createProviderV1({
13619
+ await client.orgs.complianceDocuments.createV1({
13614
13620
  schema_version: 1,
13615
- description: "description",
13616
- email_address_primary: "email_address_primary",
13617
- phone_number_primary: "phone_number_primary",
13621
+ document_type: "security_threat_assessment",
13618
13622
  });
13619
13623
  ```
13620
13624
 
@@ -13631,7 +13635,7 @@ await client.orgs.orgProfiles.createProviderV1({
13631
13635
  <dl>
13632
13636
  <dd>
13633
13637
 
13634
- **request:** `Chrt.orgs.ProviderOrgProfileClientCreate1`
13638
+ **request:** `Chrt.orgs.OrgComplianceDocumentClientCreate1`
13635
13639
 
13636
13640
  </dd>
13637
13641
  </dl>
@@ -13639,7 +13643,7 @@ await client.orgs.orgProfiles.createProviderV1({
13639
13643
  <dl>
13640
13644
  <dd>
13641
13645
 
13642
- **requestOptions:** `OrgProfiles.RequestOptions`
13646
+ **requestOptions:** `ComplianceDocuments.RequestOptions`
13643
13647
 
13644
13648
  </dd>
13645
13649
  </dl>
@@ -13650,7 +13654,9 @@ await client.orgs.orgProfiles.createProviderV1({
13650
13654
  </dl>
13651
13655
  </details>
13652
13656
 
13653
- <details><summary><code>client.orgs.orgProfiles.<a href="/src/api/resources/orgs/resources/orgProfiles/client/Client.ts">updateProviderV1</a>({ ...params }) -> boolean</code></summary>
13657
+ ## Orgs PrivateData
13658
+
13659
+ <details><summary><code>client.orgs.privateData.<a href="/src/api/resources/orgs/resources/privateData/client/Client.ts">getV1</a>() -> Chrt.OrgPrivateData1</code></summary>
13654
13660
  <dl>
13655
13661
  <dd>
13656
13662
 
@@ -13662,7 +13668,7 @@ await client.orgs.orgProfiles.createProviderV1({
13662
13668
  <dl>
13663
13669
  <dd>
13664
13670
 
13665
- Updates an existing provider organization profile. | (ProviderOrgProfileClientUpdate1) -> (bool)
13671
+ Retrieves private organization data for the caller's organization. | authz: min_org_role=operator | () -> (OrgPrivateData1)
13666
13672
 
13667
13673
  </dd>
13668
13674
  </dl>
@@ -13678,7 +13684,7 @@ Updates an existing provider organization profile. | (ProviderOrgProfileClientUp
13678
13684
  <dd>
13679
13685
 
13680
13686
  ```typescript
13681
- await client.orgs.orgProfiles.updateProviderV1();
13687
+ await client.orgs.privateData.getV1();
13682
13688
  ```
13683
13689
 
13684
13690
  </dd>
@@ -13694,15 +13700,7 @@ await client.orgs.orgProfiles.updateProviderV1();
13694
13700
  <dl>
13695
13701
  <dd>
13696
13702
 
13697
- **request:** `Chrt.orgs.ProviderOrgProfileClientUpdate1`
13698
-
13699
- </dd>
13700
- </dl>
13701
-
13702
- <dl>
13703
- <dd>
13704
-
13705
- **requestOptions:** `OrgProfiles.RequestOptions`
13703
+ **requestOptions:** `PrivateData.RequestOptions`
13706
13704
 
13707
13705
  </dd>
13708
13706
  </dl>
@@ -13713,7 +13711,9 @@ await client.orgs.orgProfiles.updateProviderV1();
13713
13711
  </dl>
13714
13712
  </details>
13715
13713
 
13716
- <details><summary><code>client.orgs.orgProfiles.<a href="/src/api/resources/orgs/resources/orgProfiles/client/Client.ts">getByHandleV1</a>(handle) -> Chrt.ProviderOrgProfile1</code></summary>
13714
+ ## Orgs OrgProfiles
13715
+
13716
+ <details><summary><code>client.orgs.orgProfiles.<a href="/src/api/resources/orgs/resources/orgProfiles/client/Client.ts">getV1</a>() -> Chrt.ProviderOrgProfile1</code></summary>
13717
13717
  <dl>
13718
13718
  <dd>
13719
13719
 
@@ -13725,7 +13725,7 @@ await client.orgs.orgProfiles.updateProviderV1();
13725
13725
  <dl>
13726
13726
  <dd>
13727
13727
 
13728
- Retrieves a provider organization profile by handle for public profile viewing. | () -> (ProviderOrgProfile1)
13728
+ Retrieves the provider organization profile for the caller's organization. | () -> (ProviderOrgProfile1)
13729
13729
 
13730
13730
  </dd>
13731
13731
  </dl>
@@ -13741,7 +13741,7 @@ Retrieves a provider organization profile by handle for public profile viewing.
13741
13741
  <dd>
13742
13742
 
13743
13743
  ```typescript
13744
- await client.orgs.orgProfiles.getByHandleV1("handle");
13744
+ await client.orgs.orgProfiles.getV1();
13745
13745
  ```
13746
13746
 
13747
13747
  </dd>
@@ -13757,14 +13757,6 @@ await client.orgs.orgProfiles.getByHandleV1("handle");
13757
13757
  <dl>
13758
13758
  <dd>
13759
13759
 
13760
- **handle:** `string`
13761
-
13762
- </dd>
13763
- </dl>
13764
-
13765
- <dl>
13766
- <dd>
13767
-
13768
13760
  **requestOptions:** `OrgProfiles.RequestOptions`
13769
13761
 
13770
13762
  </dd>
@@ -13776,7 +13768,7 @@ await client.orgs.orgProfiles.getByHandleV1("handle");
13776
13768
  </dl>
13777
13769
  </details>
13778
13770
 
13779
- <details><summary><code>client.orgs.orgProfiles.<a href="/src/api/resources/orgs/resources/orgProfiles/client/Client.ts">getAvatarV1</a>(handle) -> string</code></summary>
13771
+ <details><summary><code>client.orgs.orgProfiles.<a href="/src/api/resources/orgs/resources/orgProfiles/client/Client.ts">createProviderV1</a>({ ...params }) -> string</code></summary>
13780
13772
  <dl>
13781
13773
  <dd>
13782
13774
 
@@ -13788,7 +13780,7 @@ await client.orgs.orgProfiles.getByHandleV1("handle");
13788
13780
  <dl>
13789
13781
  <dd>
13790
13782
 
13791
- Returns the organization avatar image URL from WorkOS or a placeholder if not found. | () -> (str)
13783
+ Creates a new provider organization profile. Fails if a profile already exists for the organization. | (ProviderOrgProfileClientCreate1) -> (PydanticObjectId)
13792
13784
 
13793
13785
  </dd>
13794
13786
  </dl>
@@ -13804,7 +13796,12 @@ Returns the organization avatar image URL from WorkOS or a placeholder if not fo
13804
13796
  <dd>
13805
13797
 
13806
13798
  ```typescript
13807
- await client.orgs.orgProfiles.getAvatarV1("handle");
13799
+ await client.orgs.orgProfiles.createProviderV1({
13800
+ schema_version: 1,
13801
+ description: "description",
13802
+ email_address_primary: "email_address_primary",
13803
+ phone_number_primary: "phone_number_primary",
13804
+ });
13808
13805
  ```
13809
13806
 
13810
13807
  </dd>
@@ -13820,7 +13817,7 @@ await client.orgs.orgProfiles.getAvatarV1("handle");
13820
13817
  <dl>
13821
13818
  <dd>
13822
13819
 
13823
- **handle:** `string`
13820
+ **request:** `Chrt.orgs.ProviderOrgProfileClientCreate1`
13824
13821
 
13825
13822
  </dd>
13826
13823
  </dl>
@@ -13839,9 +13836,7 @@ await client.orgs.orgProfiles.getAvatarV1("handle");
13839
13836
  </dl>
13840
13837
  </details>
13841
13838
 
13842
- ## Orgs PublicData
13843
-
13844
- <details><summary><code>client.orgs.publicData.<a href="/src/api/resources/orgs/resources/publicData/client/Client.ts">getV1</a>() -> Chrt.OrgPublicData1</code></summary>
13839
+ <details><summary><code>client.orgs.orgProfiles.<a href="/src/api/resources/orgs/resources/orgProfiles/client/Client.ts">updateProviderV1</a>({ ...params }) -> boolean</code></summary>
13845
13840
  <dl>
13846
13841
  <dd>
13847
13842
 
@@ -13853,7 +13848,7 @@ await client.orgs.orgProfiles.getAvatarV1("handle");
13853
13848
  <dl>
13854
13849
  <dd>
13855
13850
 
13856
- Retrieves public organization data for the caller's organization. | () -> (OrgPublicData1)
13851
+ Updates an existing provider organization profile. | (ProviderOrgProfileClientUpdate1) -> (bool)
13857
13852
 
13858
13853
  </dd>
13859
13854
  </dl>
@@ -13869,7 +13864,7 @@ Retrieves public organization data for the caller's organization. | () -> (OrgPu
13869
13864
  <dd>
13870
13865
 
13871
13866
  ```typescript
13872
- await client.orgs.publicData.getV1();
13867
+ await client.orgs.orgProfiles.updateProviderV1();
13873
13868
  ```
13874
13869
 
13875
13870
  </dd>
@@ -13885,7 +13880,15 @@ await client.orgs.publicData.getV1();
13885
13880
  <dl>
13886
13881
  <dd>
13887
13882
 
13888
- **requestOptions:** `PublicData.RequestOptions`
13883
+ **request:** `Chrt.orgs.ProviderOrgProfileClientUpdate1`
13884
+
13885
+ </dd>
13886
+ </dl>
13887
+
13888
+ <dl>
13889
+ <dd>
13890
+
13891
+ **requestOptions:** `OrgProfiles.RequestOptions`
13889
13892
 
13890
13893
  </dd>
13891
13894
  </dl>
@@ -13896,7 +13899,7 @@ await client.orgs.publicData.getV1();
13896
13899
  </dl>
13897
13900
  </details>
13898
13901
 
13899
- <details><summary><code>client.orgs.publicData.<a href="/src/api/resources/orgs/resources/publicData/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
13902
+ <details><summary><code>client.orgs.orgProfiles.<a href="/src/api/resources/orgs/resources/orgProfiles/client/Client.ts">getByHandleV1</a>(handle) -> Chrt.ProviderOrgProfile1</code></summary>
13900
13903
  <dl>
13901
13904
  <dd>
13902
13905
 
@@ -13908,7 +13911,7 @@ await client.orgs.publicData.getV1();
13908
13911
  <dl>
13909
13912
  <dd>
13910
13913
 
13911
- Updates the handle and/or company_name for the caller's organization. | (UpdateOrgPublicDataReq) -> (bool)
13914
+ Retrieves a provider organization profile by handle for public profile viewing. | () -> (ProviderOrgProfile1)
13912
13915
 
13913
13916
  </dd>
13914
13917
  </dl>
@@ -13924,7 +13927,7 @@ Updates the handle and/or company_name for the caller's organization. | (UpdateO
13924
13927
  <dd>
13925
13928
 
13926
13929
  ```typescript
13927
- await client.orgs.publicData.updateV1();
13930
+ await client.orgs.orgProfiles.getByHandleV1("handle");
13928
13931
  ```
13929
13932
 
13930
13933
  </dd>
@@ -13940,7 +13943,7 @@ await client.orgs.publicData.updateV1();
13940
13943
  <dl>
13941
13944
  <dd>
13942
13945
 
13943
- **request:** `Chrt.orgs.UpdateOrgPublicDataReq`
13946
+ **handle:** `string`
13944
13947
 
13945
13948
  </dd>
13946
13949
  </dl>
@@ -13948,7 +13951,7 @@ await client.orgs.publicData.updateV1();
13948
13951
  <dl>
13949
13952
  <dd>
13950
13953
 
13951
- **requestOptions:** `PublicData.RequestOptions`
13954
+ **requestOptions:** `OrgProfiles.RequestOptions`
13952
13955
 
13953
13956
  </dd>
13954
13957
  </dl>
@@ -13959,7 +13962,7 @@ await client.orgs.publicData.updateV1();
13959
13962
  </dl>
13960
13963
  </details>
13961
13964
 
13962
- <details><summary><code>client.orgs.publicData.<a href="/src/api/resources/orgs/resources/publicData/client/Client.ts">getByOrgIdV1</a>(orgId) -> Chrt.OrgPublicData1</code></summary>
13965
+ <details><summary><code>client.orgs.orgProfiles.<a href="/src/api/resources/orgs/resources/orgProfiles/client/Client.ts">getAvatarV1</a>(handle) -> string</code></summary>
13963
13966
  <dl>
13964
13967
  <dd>
13965
13968
 
@@ -13971,7 +13974,7 @@ await client.orgs.publicData.updateV1();
13971
13974
  <dl>
13972
13975
  <dd>
13973
13976
 
13974
- Retrieves public organization data for a specific organization by ID. | () -> (OrgPublicData1)
13977
+ Returns the organization avatar image URL from WorkOS or a placeholder if not found. | () -> (str)
13975
13978
 
13976
13979
  </dd>
13977
13980
  </dl>
@@ -13987,7 +13990,7 @@ Retrieves public organization data for a specific organization by ID. | () -> (O
13987
13990
  <dd>
13988
13991
 
13989
13992
  ```typescript
13990
- await client.orgs.publicData.getByOrgIdV1("org_id");
13993
+ await client.orgs.orgProfiles.getAvatarV1("handle");
13991
13994
  ```
13992
13995
 
13993
13996
  </dd>
@@ -14003,7 +14006,7 @@ await client.orgs.publicData.getByOrgIdV1("org_id");
14003
14006
  <dl>
14004
14007
  <dd>
14005
14008
 
14006
- **orgId:** `string`
14009
+ **handle:** `string`
14007
14010
 
14008
14011
  </dd>
14009
14012
  </dl>
@@ -14011,7 +14014,7 @@ await client.orgs.publicData.getByOrgIdV1("org_id");
14011
14014
  <dl>
14012
14015
  <dd>
14013
14016
 
14014
- **requestOptions:** `PublicData.RequestOptions`
14017
+ **requestOptions:** `OrgProfiles.RequestOptions`
14015
14018
 
14016
14019
  </dd>
14017
14020
  </dl>
@@ -14022,7 +14025,9 @@ await client.orgs.publicData.getByOrgIdV1("org_id");
14022
14025
  </dl>
14023
14026
  </details>
14024
14027
 
14025
- <details><summary><code>client.orgs.publicData.<a href="/src/api/resources/orgs/resources/publicData/client/Client.ts">getHandleAvailabilityV1</a>(handle) -> boolean</code></summary>
14028
+ ## Orgs PublicData
14029
+
14030
+ <details><summary><code>client.orgs.publicData.<a href="/src/api/resources/orgs/resources/publicData/client/Client.ts">getV1</a>() -> Chrt.OrgPublicData1</code></summary>
14026
14031
  <dl>
14027
14032
  <dd>
14028
14033
 
@@ -14034,7 +14039,7 @@ await client.orgs.publicData.getByOrgIdV1("org_id");
14034
14039
  <dl>
14035
14040
  <dd>
14036
14041
 
14037
- Returns True when the provided handle is available, otherwise False. | () -> (bool)
14042
+ Retrieves public organization data for the caller's organization. | () -> (OrgPublicData1)
14038
14043
 
14039
14044
  </dd>
14040
14045
  </dl>
@@ -14050,7 +14055,7 @@ Returns True when the provided handle is available, otherwise False. | () -> (bo
14050
14055
  <dd>
14051
14056
 
14052
14057
  ```typescript
14053
- await client.orgs.publicData.getHandleAvailabilityV1("handle");
14058
+ await client.orgs.publicData.getV1();
14054
14059
  ```
14055
14060
 
14056
14061
  </dd>
@@ -14066,14 +14071,6 @@ await client.orgs.publicData.getHandleAvailabilityV1("handle");
14066
14071
  <dl>
14067
14072
  <dd>
14068
14073
 
14069
- **handle:** `string`
14070
-
14071
- </dd>
14072
- </dl>
14073
-
14074
- <dl>
14075
- <dd>
14076
-
14077
14074
  **requestOptions:** `PublicData.RequestOptions`
14078
14075
 
14079
14076
  </dd>
@@ -14085,9 +14082,7 @@ await client.orgs.publicData.getHandleAvailabilityV1("handle");
14085
14082
  </dl>
14086
14083
  </details>
14087
14084
 
14088
- ## Orgs OrgInfoForConnections Shipper
14089
-
14090
- <details><summary><code>client.orgs.orgInfoForConnections.shipper.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/shipper/client/Client.ts">getV1</a>() -> Chrt.ShipperOrgInfoForConnections1</code></summary>
14085
+ <details><summary><code>client.orgs.publicData.<a href="/src/api/resources/orgs/resources/publicData/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
14091
14086
  <dl>
14092
14087
  <dd>
14093
14088
 
@@ -14099,7 +14094,7 @@ await client.orgs.publicData.getHandleAvailabilityV1("handle");
14099
14094
  <dl>
14100
14095
  <dd>
14101
14096
 
14102
- Retrieves shipper organization connection information for the caller's organization. | () -> (ShipperOrgInfoForConnections1)
14097
+ Updates the handle and/or company_name for the caller's organization. | (UpdateOrgPublicDataReq) -> (bool)
14103
14098
 
14104
14099
  </dd>
14105
14100
  </dl>
@@ -14115,7 +14110,7 @@ Retrieves shipper organization connection information for the caller's organizat
14115
14110
  <dd>
14116
14111
 
14117
14112
  ```typescript
14118
- await client.orgs.orgInfoForConnections.shipper.getV1();
14113
+ await client.orgs.publicData.updateV1();
14119
14114
  ```
14120
14115
 
14121
14116
  </dd>
@@ -14131,7 +14126,15 @@ await client.orgs.orgInfoForConnections.shipper.getV1();
14131
14126
  <dl>
14132
14127
  <dd>
14133
14128
 
14134
- **requestOptions:** `Shipper.RequestOptions`
14129
+ **request:** `Chrt.orgs.UpdateOrgPublicDataReq`
14130
+
14131
+ </dd>
14132
+ </dl>
14133
+
14134
+ <dl>
14135
+ <dd>
14136
+
14137
+ **requestOptions:** `PublicData.RequestOptions`
14135
14138
 
14136
14139
  </dd>
14137
14140
  </dl>
@@ -14142,7 +14145,7 @@ await client.orgs.orgInfoForConnections.shipper.getV1();
14142
14145
  </dl>
14143
14146
  </details>
14144
14147
 
14145
- <details><summary><code>client.orgs.orgInfoForConnections.shipper.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/shipper/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
14148
+ <details><summary><code>client.orgs.publicData.<a href="/src/api/resources/orgs/resources/publicData/client/Client.ts">getByOrgIdV1</a>(orgId) -> Chrt.OrgPublicData1</code></summary>
14146
14149
  <dl>
14147
14150
  <dd>
14148
14151
 
@@ -14154,7 +14157,7 @@ await client.orgs.orgInfoForConnections.shipper.getV1();
14154
14157
  <dl>
14155
14158
  <dd>
14156
14159
 
14157
- Creates shipper organization connection information. Fails if already exists. | (ShipperOrgInfoForConnectionsClientCreate1) -> (PydanticObjectId)
14160
+ Retrieves public organization data for a specific organization by ID. | () -> (OrgPublicData1)
14158
14161
 
14159
14162
  </dd>
14160
14163
  </dl>
@@ -14170,10 +14173,7 @@ Creates shipper organization connection information. Fails if already exists. |
14170
14173
  <dd>
14171
14174
 
14172
14175
  ```typescript
14173
- await client.orgs.orgInfoForConnections.shipper.createV1({
14174
- schema_version: 1,
14175
- email_address_primary: "email_address_primary",
14176
- });
14176
+ await client.orgs.publicData.getByOrgIdV1("org_id");
14177
14177
  ```
14178
14178
 
14179
14179
  </dd>
@@ -14189,7 +14189,7 @@ await client.orgs.orgInfoForConnections.shipper.createV1({
14189
14189
  <dl>
14190
14190
  <dd>
14191
14191
 
14192
- **request:** `Chrt.orgs.orgInfoForConnections.ShipperOrgInfoForConnectionsClientCreate1`
14192
+ **orgId:** `string`
14193
14193
 
14194
14194
  </dd>
14195
14195
  </dl>
@@ -14197,7 +14197,7 @@ await client.orgs.orgInfoForConnections.shipper.createV1({
14197
14197
  <dl>
14198
14198
  <dd>
14199
14199
 
14200
- **requestOptions:** `Shipper.RequestOptions`
14200
+ **requestOptions:** `PublicData.RequestOptions`
14201
14201
 
14202
14202
  </dd>
14203
14203
  </dl>
@@ -14208,7 +14208,7 @@ await client.orgs.orgInfoForConnections.shipper.createV1({
14208
14208
  </dl>
14209
14209
  </details>
14210
14210
 
14211
- <details><summary><code>client.orgs.orgInfoForConnections.shipper.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/shipper/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
14211
+ <details><summary><code>client.orgs.publicData.<a href="/src/api/resources/orgs/resources/publicData/client/Client.ts">getHandleAvailabilityV1</a>(handle) -> boolean</code></summary>
14212
14212
  <dl>
14213
14213
  <dd>
14214
14214
 
@@ -14220,7 +14220,7 @@ await client.orgs.orgInfoForConnections.shipper.createV1({
14220
14220
  <dl>
14221
14221
  <dd>
14222
14222
 
14223
- Updates existing shipper organization connection information. | (ShipperOrgInfoForConnectionsClientUpdate1) -> (bool)
14223
+ Returns True when the provided handle is available, otherwise False. | () -> (bool)
14224
14224
 
14225
14225
  </dd>
14226
14226
  </dl>
@@ -14236,7 +14236,7 @@ Updates existing shipper organization connection information. | (ShipperOrgInfoF
14236
14236
  <dd>
14237
14237
 
14238
14238
  ```typescript
14239
- await client.orgs.orgInfoForConnections.shipper.updateV1();
14239
+ await client.orgs.publicData.getHandleAvailabilityV1("handle");
14240
14240
  ```
14241
14241
 
14242
14242
  </dd>
@@ -14252,7 +14252,7 @@ await client.orgs.orgInfoForConnections.shipper.updateV1();
14252
14252
  <dl>
14253
14253
  <dd>
14254
14254
 
14255
- **request:** `Chrt.orgs.orgInfoForConnections.ShipperOrgInfoForConnectionsClientUpdate1`
14255
+ **handle:** `string`
14256
14256
 
14257
14257
  </dd>
14258
14258
  </dl>
@@ -14260,7 +14260,7 @@ await client.orgs.orgInfoForConnections.shipper.updateV1();
14260
14260
  <dl>
14261
14261
  <dd>
14262
14262
 
14263
- **requestOptions:** `Shipper.RequestOptions`
14263
+ **requestOptions:** `PublicData.RequestOptions`
14264
14264
 
14265
14265
  </dd>
14266
14266
  </dl>
@@ -14271,9 +14271,9 @@ await client.orgs.orgInfoForConnections.shipper.updateV1();
14271
14271
  </dl>
14272
14272
  </details>
14273
14273
 
14274
- ## Orgs OrgInfoForConnections Provider
14274
+ ## Orgs ComplianceDocuments S3Object
14275
14275
 
14276
- <details><summary><code>client.orgs.orgInfoForConnections.provider.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/provider/client/Client.ts">getV1</a>() -> Chrt.ProviderOrgInfoForConnections1</code></summary>
14276
+ <details><summary><code>client.orgs.complianceDocuments.s3Object.<a href="/src/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/Client.ts">getS3ObjectMetadataV1</a>(orgComplianceDocumentS3ObjectMetadataId) -> Chrt.OrgComplianceDocumentS3ObjectMetadata1</code></summary>
14277
14277
  <dl>
14278
14278
  <dd>
14279
14279
 
@@ -14285,7 +14285,7 @@ await client.orgs.orgInfoForConnections.shipper.updateV1();
14285
14285
  <dl>
14286
14286
  <dd>
14287
14287
 
14288
- Retrieves provider organization connection information for the caller's organization. | () -> (ProviderOrgInfoForConnections1)
14288
+ Retrieves metadata for an organization compliance document S3 object. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (OrgComplianceDocumentS3ObjectMetadata1)
14289
14289
 
14290
14290
  </dd>
14291
14291
  </dl>
@@ -14301,7 +14301,7 @@ Retrieves provider organization connection information for the caller's organiza
14301
14301
  <dd>
14302
14302
 
14303
14303
  ```typescript
14304
- await client.orgs.orgInfoForConnections.provider.getV1();
14304
+ await client.orgs.complianceDocuments.s3Object.getS3ObjectMetadataV1("org_compliance_document_s3_object_metadata_id");
14305
14305
  ```
14306
14306
 
14307
14307
  </dd>
@@ -14317,7 +14317,15 @@ await client.orgs.orgInfoForConnections.provider.getV1();
14317
14317
  <dl>
14318
14318
  <dd>
14319
14319
 
14320
- **requestOptions:** `Provider.RequestOptions`
14320
+ **orgComplianceDocumentS3ObjectMetadataId:** `string`
14321
+
14322
+ </dd>
14323
+ </dl>
14324
+
14325
+ <dl>
14326
+ <dd>
14327
+
14328
+ **requestOptions:** `S3Object.RequestOptions`
14321
14329
 
14322
14330
  </dd>
14323
14331
  </dl>
@@ -14328,7 +14336,7 @@ await client.orgs.orgInfoForConnections.provider.getV1();
14328
14336
  </dl>
14329
14337
  </details>
14330
14338
 
14331
- <details><summary><code>client.orgs.orgInfoForConnections.provider.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/provider/client/Client.ts">listV1</a>() -> Chrt.ProviderOrgInfoForConnections1[]</code></summary>
14339
+ <details><summary><code>client.orgs.complianceDocuments.s3Object.<a href="/src/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/Client.ts">getV1</a>(orgComplianceDocumentS3ObjectMetadataId) -> core.BinaryResponse</code></summary>
14332
14340
  <dl>
14333
14341
  <dd>
14334
14342
 
@@ -14340,7 +14348,7 @@ await client.orgs.orgInfoForConnections.provider.getV1();
14340
14348
  <dl>
14341
14349
  <dd>
14342
14350
 
14343
- Retrieves list of provider org info documents for providers connected to the caller. Shippers see providers via shipper_provider_connections; providers see other providers via provider_provider_connections (in either direction). | () -> (list[ProviderOrgInfoForConnections1])
14351
+ Streams an organization compliance document S3 object file from storage. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (binary)
14344
14352
 
14345
14353
  </dd>
14346
14354
  </dl>
@@ -14356,7 +14364,7 @@ Retrieves list of provider org info documents for providers connected to the cal
14356
14364
  <dd>
14357
14365
 
14358
14366
  ```typescript
14359
- await client.orgs.orgInfoForConnections.provider.listV1();
14367
+ await client.orgs.complianceDocuments.s3Object.getV1("org_compliance_document_s3_object_metadata_id");
14360
14368
  ```
14361
14369
 
14362
14370
  </dd>
@@ -14372,7 +14380,15 @@ await client.orgs.orgInfoForConnections.provider.listV1();
14372
14380
  <dl>
14373
14381
  <dd>
14374
14382
 
14375
- **requestOptions:** `Provider.RequestOptions`
14383
+ **orgComplianceDocumentS3ObjectMetadataId:** `string`
14384
+
14385
+ </dd>
14386
+ </dl>
14387
+
14388
+ <dl>
14389
+ <dd>
14390
+
14391
+ **requestOptions:** `S3Object.RequestOptions`
14376
14392
 
14377
14393
  </dd>
14378
14394
  </dl>
@@ -14383,7 +14399,7 @@ await client.orgs.orgInfoForConnections.provider.listV1();
14383
14399
  </dl>
14384
14400
  </details>
14385
14401
 
14386
- <details><summary><code>client.orgs.orgInfoForConnections.provider.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/provider/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
14402
+ <details><summary><code>client.orgs.complianceDocuments.s3Object.<a href="/src/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/Client.ts">addV1</a>(orgComplianceDocumentId, { ...params }) -> boolean</code></summary>
14387
14403
  <dl>
14388
14404
  <dd>
14389
14405
 
@@ -14395,7 +14411,7 @@ await client.orgs.orgInfoForConnections.provider.listV1();
14395
14411
  <dl>
14396
14412
  <dd>
14397
14413
 
14398
- Creates provider organization connection information. Fails if already exists. | (ProviderOrgInfoForConnectionsClientCreate1) -> (PydanticObjectId)
14414
+ Uploads a file to an organization compliance document. Automatic blurhash generation for images. | authz: allowed_org_types=[provider], min_org_role=administrator | (UploadFile) -> (bool)
14399
14415
 
14400
14416
  </dd>
14401
14417
  </dl>
@@ -14411,9 +14427,8 @@ Creates provider organization connection information. Fails if already exists. |
14411
14427
  <dd>
14412
14428
 
14413
14429
  ```typescript
14414
- await client.orgs.orgInfoForConnections.provider.createV1({
14415
- schema_version: 1,
14416
- email_address_primary: "email_address_primary",
14430
+ await client.orgs.complianceDocuments.s3Object.addV1("org_compliance_document_id", {
14431
+ file: fs.createReadStream("/path/to/your/file"),
14417
14432
  });
14418
14433
  ```
14419
14434
 
@@ -14430,7 +14445,7 @@ await client.orgs.orgInfoForConnections.provider.createV1({
14430
14445
  <dl>
14431
14446
  <dd>
14432
14447
 
14433
- **request:** `Chrt.orgs.orgInfoForConnections.ProviderOrgInfoForConnectionsClientCreate1`
14448
+ **orgComplianceDocumentId:** `string`
14434
14449
 
14435
14450
  </dd>
14436
14451
  </dl>
@@ -14438,7 +14453,15 @@ await client.orgs.orgInfoForConnections.provider.createV1({
14438
14453
  <dl>
14439
14454
  <dd>
14440
14455
 
14441
- **requestOptions:** `Provider.RequestOptions`
14456
+ **request:** `Chrt.orgs.complianceDocuments.BodyPostOrgComplianceDocumentsS3ObjectAddV1OrgsComplianceDocumentsS3ObjectAddV1OrgComplianceDocumentIdPost`
14457
+
14458
+ </dd>
14459
+ </dl>
14460
+
14461
+ <dl>
14462
+ <dd>
14463
+
14464
+ **requestOptions:** `S3Object.RequestOptions`
14442
14465
 
14443
14466
  </dd>
14444
14467
  </dl>
@@ -14449,7 +14472,7 @@ await client.orgs.orgInfoForConnections.provider.createV1({
14449
14472
  </dl>
14450
14473
  </details>
14451
14474
 
14452
- <details><summary><code>client.orgs.orgInfoForConnections.provider.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/provider/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
14475
+ <details><summary><code>client.orgs.complianceDocuments.s3Object.<a href="/src/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/Client.ts">deleteV1</a>(orgComplianceDocumentS3ObjectMetadataId) -> boolean</code></summary>
14453
14476
  <dl>
14454
14477
  <dd>
14455
14478
 
@@ -14461,7 +14484,7 @@ await client.orgs.orgInfoForConnections.provider.createV1({
14461
14484
  <dl>
14462
14485
  <dd>
14463
14486
 
14464
- Updates existing provider organization connection information. | (ProviderOrgInfoForConnectionsClientUpdate1) -> (bool)
14487
+ Deletes an organization compliance document S3 object and metadata. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (bool)
14465
14488
 
14466
14489
  </dd>
14467
14490
  </dl>
@@ -14477,7 +14500,7 @@ Updates existing provider organization connection information. | (ProviderOrgInf
14477
14500
  <dd>
14478
14501
 
14479
14502
  ```typescript
14480
- await client.orgs.orgInfoForConnections.provider.updateV1();
14503
+ await client.orgs.complianceDocuments.s3Object.deleteV1("org_compliance_document_s3_object_metadata_id");
14481
14504
  ```
14482
14505
 
14483
14506
  </dd>
@@ -14493,7 +14516,7 @@ await client.orgs.orgInfoForConnections.provider.updateV1();
14493
14516
  <dl>
14494
14517
  <dd>
14495
14518
 
14496
- **request:** `Chrt.orgs.orgInfoForConnections.ProviderOrgInfoForConnectionsClientUpdate1`
14519
+ **orgComplianceDocumentS3ObjectMetadataId:** `string`
14497
14520
 
14498
14521
  </dd>
14499
14522
  </dl>
@@ -14501,7 +14524,7 @@ await client.orgs.orgInfoForConnections.provider.updateV1();
14501
14524
  <dl>
14502
14525
  <dd>
14503
14526
 
14504
- **requestOptions:** `Provider.RequestOptions`
14527
+ **requestOptions:** `S3Object.RequestOptions`
14505
14528
 
14506
14529
  </dd>
14507
14530
  </dl>
@@ -14512,9 +14535,9 @@ await client.orgs.orgInfoForConnections.provider.updateV1();
14512
14535
  </dl>
14513
14536
  </details>
14514
14537
 
14515
- ## Shipping Drivers
14538
+ ## Orgs OrgInfoForConnections Shipper
14516
14539
 
14517
- <details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">getForCallerV1</a>() -> Chrt.Driver1</code></summary>
14540
+ <details><summary><code>client.orgs.orgInfoForConnections.shipper.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/shipper/client/Client.ts">getV1</a>() -> Chrt.ShipperOrgInfoForConnections1</code></summary>
14518
14541
  <dl>
14519
14542
  <dd>
14520
14543
 
@@ -14526,7 +14549,7 @@ await client.orgs.orgInfoForConnections.provider.updateV1();
14526
14549
  <dl>
14527
14550
  <dd>
14528
14551
 
14529
- Retrieves driver information for the caller within their organization. | () -> (Driver1)
14552
+ Retrieves shipper organization connection information for the caller's organization. | () -> (ShipperOrgInfoForConnections1)
14530
14553
 
14531
14554
  </dd>
14532
14555
  </dl>
@@ -14542,7 +14565,7 @@ Retrieves driver information for the caller within their organization. | () -> (
14542
14565
  <dd>
14543
14566
 
14544
14567
  ```typescript
14545
- await client.shipping.drivers.getForCallerV1();
14568
+ await client.orgs.orgInfoForConnections.shipper.getV1();
14546
14569
  ```
14547
14570
 
14548
14571
  </dd>
@@ -14558,7 +14581,7 @@ await client.shipping.drivers.getForCallerV1();
14558
14581
  <dl>
14559
14582
  <dd>
14560
14583
 
14561
- **requestOptions:** `Drivers.RequestOptions`
14584
+ **requestOptions:** `Shipper.RequestOptions`
14562
14585
 
14563
14586
  </dd>
14564
14587
  </dl>
@@ -14569,7 +14592,7 @@ await client.shipping.drivers.getForCallerV1();
14569
14592
  </dl>
14570
14593
  </details>
14571
14594
 
14572
- <details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">getByDriverIdV1</a>(driverId) -> Chrt.Driver1</code></summary>
14595
+ <details><summary><code>client.orgs.orgInfoForConnections.shipper.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/shipper/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
14573
14596
  <dl>
14574
14597
  <dd>
14575
14598
 
@@ -14581,7 +14604,7 @@ await client.shipping.drivers.getForCallerV1();
14581
14604
  <dl>
14582
14605
  <dd>
14583
14606
 
14584
- Retrieves detailed driver information by driver ID within the organization. | () -> (Driver1)
14607
+ Creates shipper organization connection information. Fails if already exists. | (ShipperOrgInfoForConnectionsClientCreate1) -> (PydanticObjectId)
14585
14608
 
14586
14609
  </dd>
14587
14610
  </dl>
@@ -14597,7 +14620,10 @@ Retrieves detailed driver information by driver ID within the organization. | ()
14597
14620
  <dd>
14598
14621
 
14599
14622
  ```typescript
14600
- await client.shipping.drivers.getByDriverIdV1("driver_id");
14623
+ await client.orgs.orgInfoForConnections.shipper.createV1({
14624
+ schema_version: 1,
14625
+ email_address_primary: "email_address_primary",
14626
+ });
14601
14627
  ```
14602
14628
 
14603
14629
  </dd>
@@ -14613,7 +14639,7 @@ await client.shipping.drivers.getByDriverIdV1("driver_id");
14613
14639
  <dl>
14614
14640
  <dd>
14615
14641
 
14616
- **driverId:** `string`
14642
+ **request:** `Chrt.orgs.orgInfoForConnections.ShipperOrgInfoForConnectionsClientCreate1`
14617
14643
 
14618
14644
  </dd>
14619
14645
  </dl>
@@ -14621,7 +14647,7 @@ await client.shipping.drivers.getByDriverIdV1("driver_id");
14621
14647
  <dl>
14622
14648
  <dd>
14623
14649
 
14624
- **requestOptions:** `Drivers.RequestOptions`
14650
+ **requestOptions:** `Shipper.RequestOptions`
14625
14651
 
14626
14652
  </dd>
14627
14653
  </dl>
@@ -14632,7 +14658,7 @@ await client.shipping.drivers.getByDriverIdV1("driver_id");
14632
14658
  </dl>
14633
14659
  </details>
14634
14660
 
14635
- <details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">listOrgMembersAndDriversV1</a>({ ...params }) -> Chrt.OrgMembersAndDriversListRes</code></summary>
14661
+ <details><summary><code>client.orgs.orgInfoForConnections.shipper.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/shipper/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
14636
14662
  <dl>
14637
14663
  <dd>
14638
14664
 
@@ -14644,7 +14670,7 @@ await client.shipping.drivers.getByDriverIdV1("driver_id");
14644
14670
  <dl>
14645
14671
  <dd>
14646
14672
 
14647
- Lists all organization members paired with their driver information if they are drivers. Supports search by name, filtering, sorting, and pagination. | () -> (OrgMembersAndDriversListRes)
14673
+ Updates existing shipper organization connection information. | (ShipperOrgInfoForConnectionsClientUpdate1) -> (bool)
14648
14674
 
14649
14675
  </dd>
14650
14676
  </dl>
@@ -14660,15 +14686,7 @@ Lists all organization members paired with their driver information if they are
14660
14686
  <dd>
14661
14687
 
14662
14688
  ```typescript
14663
- await client.shipping.drivers.listOrgMembersAndDriversV1({
14664
- search: "search",
14665
- filter_available_according_to_driver: true,
14666
- filter_available_according_to_operators: true,
14667
- sort_by: "first_name",
14668
- sort_order: "asc",
14669
- page: 1,
14670
- page_size: 1,
14671
- });
14689
+ await client.orgs.orgInfoForConnections.shipper.updateV1();
14672
14690
  ```
14673
14691
 
14674
14692
  </dd>
@@ -14684,7 +14702,7 @@ await client.shipping.drivers.listOrgMembersAndDriversV1({
14684
14702
  <dl>
14685
14703
  <dd>
14686
14704
 
14687
- **request:** `Chrt.shipping.DriversListOrgMembersAndDriversV1Request`
14705
+ **request:** `Chrt.orgs.orgInfoForConnections.ShipperOrgInfoForConnectionsClientUpdate1`
14688
14706
 
14689
14707
  </dd>
14690
14708
  </dl>
@@ -14692,7 +14710,439 @@ await client.shipping.drivers.listOrgMembersAndDriversV1({
14692
14710
  <dl>
14693
14711
  <dd>
14694
14712
 
14695
- **requestOptions:** `Drivers.RequestOptions`
14713
+ **requestOptions:** `Shipper.RequestOptions`
14714
+
14715
+ </dd>
14716
+ </dl>
14717
+ </dd>
14718
+ </dl>
14719
+
14720
+ </dd>
14721
+ </dl>
14722
+ </details>
14723
+
14724
+ ## Orgs OrgInfoForConnections Provider
14725
+
14726
+ <details><summary><code>client.orgs.orgInfoForConnections.provider.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/provider/client/Client.ts">getV1</a>() -> Chrt.ProviderOrgInfoForConnections1</code></summary>
14727
+ <dl>
14728
+ <dd>
14729
+
14730
+ #### 📝 Description
14731
+
14732
+ <dl>
14733
+ <dd>
14734
+
14735
+ <dl>
14736
+ <dd>
14737
+
14738
+ Retrieves provider organization connection information for the caller's organization. | () -> (ProviderOrgInfoForConnections1)
14739
+
14740
+ </dd>
14741
+ </dl>
14742
+ </dd>
14743
+ </dl>
14744
+
14745
+ #### 🔌 Usage
14746
+
14747
+ <dl>
14748
+ <dd>
14749
+
14750
+ <dl>
14751
+ <dd>
14752
+
14753
+ ```typescript
14754
+ await client.orgs.orgInfoForConnections.provider.getV1();
14755
+ ```
14756
+
14757
+ </dd>
14758
+ </dl>
14759
+ </dd>
14760
+ </dl>
14761
+
14762
+ #### ⚙️ Parameters
14763
+
14764
+ <dl>
14765
+ <dd>
14766
+
14767
+ <dl>
14768
+ <dd>
14769
+
14770
+ **requestOptions:** `Provider.RequestOptions`
14771
+
14772
+ </dd>
14773
+ </dl>
14774
+ </dd>
14775
+ </dl>
14776
+
14777
+ </dd>
14778
+ </dl>
14779
+ </details>
14780
+
14781
+ <details><summary><code>client.orgs.orgInfoForConnections.provider.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/provider/client/Client.ts">listV1</a>() -> Chrt.ProviderOrgInfoForConnections1[]</code></summary>
14782
+ <dl>
14783
+ <dd>
14784
+
14785
+ #### 📝 Description
14786
+
14787
+ <dl>
14788
+ <dd>
14789
+
14790
+ <dl>
14791
+ <dd>
14792
+
14793
+ Retrieves list of provider org info documents for providers connected to the caller. Shippers see providers via shipper_provider_connections; providers see other providers via provider_provider_connections (in either direction). | () -> (list[ProviderOrgInfoForConnections1])
14794
+
14795
+ </dd>
14796
+ </dl>
14797
+ </dd>
14798
+ </dl>
14799
+
14800
+ #### 🔌 Usage
14801
+
14802
+ <dl>
14803
+ <dd>
14804
+
14805
+ <dl>
14806
+ <dd>
14807
+
14808
+ ```typescript
14809
+ await client.orgs.orgInfoForConnections.provider.listV1();
14810
+ ```
14811
+
14812
+ </dd>
14813
+ </dl>
14814
+ </dd>
14815
+ </dl>
14816
+
14817
+ #### ⚙️ Parameters
14818
+
14819
+ <dl>
14820
+ <dd>
14821
+
14822
+ <dl>
14823
+ <dd>
14824
+
14825
+ **requestOptions:** `Provider.RequestOptions`
14826
+
14827
+ </dd>
14828
+ </dl>
14829
+ </dd>
14830
+ </dl>
14831
+
14832
+ </dd>
14833
+ </dl>
14834
+ </details>
14835
+
14836
+ <details><summary><code>client.orgs.orgInfoForConnections.provider.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/provider/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
14837
+ <dl>
14838
+ <dd>
14839
+
14840
+ #### 📝 Description
14841
+
14842
+ <dl>
14843
+ <dd>
14844
+
14845
+ <dl>
14846
+ <dd>
14847
+
14848
+ Creates provider organization connection information. Fails if already exists. | (ProviderOrgInfoForConnectionsClientCreate1) -> (PydanticObjectId)
14849
+
14850
+ </dd>
14851
+ </dl>
14852
+ </dd>
14853
+ </dl>
14854
+
14855
+ #### 🔌 Usage
14856
+
14857
+ <dl>
14858
+ <dd>
14859
+
14860
+ <dl>
14861
+ <dd>
14862
+
14863
+ ```typescript
14864
+ await client.orgs.orgInfoForConnections.provider.createV1({
14865
+ schema_version: 1,
14866
+ email_address_primary: "email_address_primary",
14867
+ });
14868
+ ```
14869
+
14870
+ </dd>
14871
+ </dl>
14872
+ </dd>
14873
+ </dl>
14874
+
14875
+ #### ⚙️ Parameters
14876
+
14877
+ <dl>
14878
+ <dd>
14879
+
14880
+ <dl>
14881
+ <dd>
14882
+
14883
+ **request:** `Chrt.orgs.orgInfoForConnections.ProviderOrgInfoForConnectionsClientCreate1`
14884
+
14885
+ </dd>
14886
+ </dl>
14887
+
14888
+ <dl>
14889
+ <dd>
14890
+
14891
+ **requestOptions:** `Provider.RequestOptions`
14892
+
14893
+ </dd>
14894
+ </dl>
14895
+ </dd>
14896
+ </dl>
14897
+
14898
+ </dd>
14899
+ </dl>
14900
+ </details>
14901
+
14902
+ <details><summary><code>client.orgs.orgInfoForConnections.provider.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/provider/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
14903
+ <dl>
14904
+ <dd>
14905
+
14906
+ #### 📝 Description
14907
+
14908
+ <dl>
14909
+ <dd>
14910
+
14911
+ <dl>
14912
+ <dd>
14913
+
14914
+ Updates existing provider organization connection information. | (ProviderOrgInfoForConnectionsClientUpdate1) -> (bool)
14915
+
14916
+ </dd>
14917
+ </dl>
14918
+ </dd>
14919
+ </dl>
14920
+
14921
+ #### 🔌 Usage
14922
+
14923
+ <dl>
14924
+ <dd>
14925
+
14926
+ <dl>
14927
+ <dd>
14928
+
14929
+ ```typescript
14930
+ await client.orgs.orgInfoForConnections.provider.updateV1();
14931
+ ```
14932
+
14933
+ </dd>
14934
+ </dl>
14935
+ </dd>
14936
+ </dl>
14937
+
14938
+ #### ⚙️ Parameters
14939
+
14940
+ <dl>
14941
+ <dd>
14942
+
14943
+ <dl>
14944
+ <dd>
14945
+
14946
+ **request:** `Chrt.orgs.orgInfoForConnections.ProviderOrgInfoForConnectionsClientUpdate1`
14947
+
14948
+ </dd>
14949
+ </dl>
14950
+
14951
+ <dl>
14952
+ <dd>
14953
+
14954
+ **requestOptions:** `Provider.RequestOptions`
14955
+
14956
+ </dd>
14957
+ </dl>
14958
+ </dd>
14959
+ </dl>
14960
+
14961
+ </dd>
14962
+ </dl>
14963
+ </details>
14964
+
14965
+ ## Shipping Drivers
14966
+
14967
+ <details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">getForCallerV1</a>() -> Chrt.Driver1</code></summary>
14968
+ <dl>
14969
+ <dd>
14970
+
14971
+ #### 📝 Description
14972
+
14973
+ <dl>
14974
+ <dd>
14975
+
14976
+ <dl>
14977
+ <dd>
14978
+
14979
+ Retrieves driver information for the caller within their organization. | () -> (Driver1)
14980
+
14981
+ </dd>
14982
+ </dl>
14983
+ </dd>
14984
+ </dl>
14985
+
14986
+ #### 🔌 Usage
14987
+
14988
+ <dl>
14989
+ <dd>
14990
+
14991
+ <dl>
14992
+ <dd>
14993
+
14994
+ ```typescript
14995
+ await client.shipping.drivers.getForCallerV1();
14996
+ ```
14997
+
14998
+ </dd>
14999
+ </dl>
15000
+ </dd>
15001
+ </dl>
15002
+
15003
+ #### ⚙️ Parameters
15004
+
15005
+ <dl>
15006
+ <dd>
15007
+
15008
+ <dl>
15009
+ <dd>
15010
+
15011
+ **requestOptions:** `Drivers.RequestOptions`
15012
+
15013
+ </dd>
15014
+ </dl>
15015
+ </dd>
15016
+ </dl>
15017
+
15018
+ </dd>
15019
+ </dl>
15020
+ </details>
15021
+
15022
+ <details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">getByDriverIdV1</a>(driverId) -> Chrt.Driver1</code></summary>
15023
+ <dl>
15024
+ <dd>
15025
+
15026
+ #### 📝 Description
15027
+
15028
+ <dl>
15029
+ <dd>
15030
+
15031
+ <dl>
15032
+ <dd>
15033
+
15034
+ Retrieves detailed driver information by driver ID within the organization. | () -> (Driver1)
15035
+
15036
+ </dd>
15037
+ </dl>
15038
+ </dd>
15039
+ </dl>
15040
+
15041
+ #### 🔌 Usage
15042
+
15043
+ <dl>
15044
+ <dd>
15045
+
15046
+ <dl>
15047
+ <dd>
15048
+
15049
+ ```typescript
15050
+ await client.shipping.drivers.getByDriverIdV1("driver_id");
15051
+ ```
15052
+
15053
+ </dd>
15054
+ </dl>
15055
+ </dd>
15056
+ </dl>
15057
+
15058
+ #### ⚙️ Parameters
15059
+
15060
+ <dl>
15061
+ <dd>
15062
+
15063
+ <dl>
15064
+ <dd>
15065
+
15066
+ **driverId:** `string`
15067
+
15068
+ </dd>
15069
+ </dl>
15070
+
15071
+ <dl>
15072
+ <dd>
15073
+
15074
+ **requestOptions:** `Drivers.RequestOptions`
15075
+
15076
+ </dd>
15077
+ </dl>
15078
+ </dd>
15079
+ </dl>
15080
+
15081
+ </dd>
15082
+ </dl>
15083
+ </details>
15084
+
15085
+ <details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">listOrgMembersAndDriversV1</a>({ ...params }) -> Chrt.OrgMembersAndDriversListRes</code></summary>
15086
+ <dl>
15087
+ <dd>
15088
+
15089
+ #### 📝 Description
15090
+
15091
+ <dl>
15092
+ <dd>
15093
+
15094
+ <dl>
15095
+ <dd>
15096
+
15097
+ Lists all organization members paired with their driver information if they are drivers. Supports search by name, filtering, sorting, and pagination. | () -> (OrgMembersAndDriversListRes)
15098
+
15099
+ </dd>
15100
+ </dl>
15101
+ </dd>
15102
+ </dl>
15103
+
15104
+ #### 🔌 Usage
15105
+
15106
+ <dl>
15107
+ <dd>
15108
+
15109
+ <dl>
15110
+ <dd>
15111
+
15112
+ ```typescript
15113
+ await client.shipping.drivers.listOrgMembersAndDriversV1({
15114
+ search: "search",
15115
+ filter_available_according_to_driver: true,
15116
+ filter_available_according_to_operators: true,
15117
+ sort_by: "first_name",
15118
+ sort_order: "asc",
15119
+ page: 1,
15120
+ page_size: 1,
15121
+ });
15122
+ ```
15123
+
15124
+ </dd>
15125
+ </dl>
15126
+ </dd>
15127
+ </dl>
15128
+
15129
+ #### ⚙️ Parameters
15130
+
15131
+ <dl>
15132
+ <dd>
15133
+
15134
+ <dl>
15135
+ <dd>
15136
+
15137
+ **request:** `Chrt.shipping.DriversListOrgMembersAndDriversV1Request`
15138
+
15139
+ </dd>
15140
+ </dl>
15141
+
15142
+ <dl>
15143
+ <dd>
15144
+
15145
+ **requestOptions:** `Drivers.RequestOptions`
14696
15146
 
14697
15147
  </dd>
14698
15148
  </dl>
@@ -14715,7 +15165,334 @@ await client.shipping.drivers.listOrgMembersAndDriversV1({
14715
15165
  <dl>
14716
15166
  <dd>
14717
15167
 
14718
- Lists all drivers belonging to the caller's organization with filtering, sorting, pagination, and optional full-text search. | () -> (DriverListRes)
15168
+ Lists all drivers belonging to the caller's organization with filtering, sorting, pagination, and optional full-text search. | () -> (DriverListRes)
15169
+
15170
+ </dd>
15171
+ </dl>
15172
+ </dd>
15173
+ </dl>
15174
+
15175
+ #### 🔌 Usage
15176
+
15177
+ <dl>
15178
+ <dd>
15179
+
15180
+ <dl>
15181
+ <dd>
15182
+
15183
+ ```typescript
15184
+ await client.shipping.drivers.listV1({
15185
+ sort_order: "asc",
15186
+ page: 1,
15187
+ page_size: 1,
15188
+ search: "search",
15189
+ filter_available_according_to_driver: true,
15190
+ filter_available_according_to_operators: true,
15191
+ });
15192
+ ```
15193
+
15194
+ </dd>
15195
+ </dl>
15196
+ </dd>
15197
+ </dl>
15198
+
15199
+ #### ⚙️ Parameters
15200
+
15201
+ <dl>
15202
+ <dd>
15203
+
15204
+ <dl>
15205
+ <dd>
15206
+
15207
+ **request:** `Chrt.shipping.DriversListV1Request`
15208
+
15209
+ </dd>
15210
+ </dl>
15211
+
15212
+ <dl>
15213
+ <dd>
15214
+
15215
+ **requestOptions:** `Drivers.RequestOptions`
15216
+
15217
+ </dd>
15218
+ </dl>
15219
+ </dd>
15220
+ </dl>
15221
+
15222
+ </dd>
15223
+ </dl>
15224
+ </details>
15225
+
15226
+ <details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
15227
+ <dl>
15228
+ <dd>
15229
+
15230
+ #### 📝 Description
15231
+
15232
+ <dl>
15233
+ <dd>
15234
+
15235
+ <dl>
15236
+ <dd>
15237
+
15238
+ Creates a new driver profile for the target user (defaults to caller). Drivers can create themselves; operators+ can create any org member. Provider orgs only. | (DriverClientCreate1) -> (PydanticObjectId)
15239
+
15240
+ </dd>
15241
+ </dl>
15242
+ </dd>
15243
+ </dl>
15244
+
15245
+ #### 🔌 Usage
15246
+
15247
+ <dl>
15248
+ <dd>
15249
+
15250
+ <dl>
15251
+ <dd>
15252
+
15253
+ ```typescript
15254
+ await client.shipping.drivers.createV1({
15255
+ target_user_id: "target_user_id",
15256
+ schema_version: 1,
15257
+ });
15258
+ ```
15259
+
15260
+ </dd>
15261
+ </dl>
15262
+ </dd>
15263
+ </dl>
15264
+
15265
+ #### ⚙️ Parameters
15266
+
15267
+ <dl>
15268
+ <dd>
15269
+
15270
+ <dl>
15271
+ <dd>
15272
+
15273
+ **request:** `Chrt.shipping.DriverClientCreate1`
15274
+
15275
+ </dd>
15276
+ </dl>
15277
+
15278
+ <dl>
15279
+ <dd>
15280
+
15281
+ **requestOptions:** `Drivers.RequestOptions`
15282
+
15283
+ </dd>
15284
+ </dl>
15285
+ </dd>
15286
+ </dl>
15287
+
15288
+ </dd>
15289
+ </dl>
15290
+ </details>
15291
+
15292
+ <details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">updateV1</a>(driverId, { ...params }) -> boolean</code></summary>
15293
+ <dl>
15294
+ <dd>
15295
+
15296
+ #### 📝 Description
15297
+
15298
+ <dl>
15299
+ <dd>
15300
+
15301
+ <dl>
15302
+ <dd>
15303
+
15304
+ Updates driver contact details and vehicle type assignments. Provider orgs only; caller must be the driver (self) or an operator+. | (DriverClientUpdate1) -> (bool)
15305
+
15306
+ </dd>
15307
+ </dl>
15308
+ </dd>
15309
+ </dl>
15310
+
15311
+ #### 🔌 Usage
15312
+
15313
+ <dl>
15314
+ <dd>
15315
+
15316
+ <dl>
15317
+ <dd>
15318
+
15319
+ ```typescript
15320
+ await client.shipping.drivers.updateV1("driver_id");
15321
+ ```
15322
+
15323
+ </dd>
15324
+ </dl>
15325
+ </dd>
15326
+ </dl>
15327
+
15328
+ #### ⚙️ Parameters
15329
+
15330
+ <dl>
15331
+ <dd>
15332
+
15333
+ <dl>
15334
+ <dd>
15335
+
15336
+ **driverId:** `string`
15337
+
15338
+ </dd>
15339
+ </dl>
15340
+
15341
+ <dl>
15342
+ <dd>
15343
+
15344
+ **request:** `Chrt.shipping.DriverClientUpdate1`
15345
+
15346
+ </dd>
15347
+ </dl>
15348
+
15349
+ <dl>
15350
+ <dd>
15351
+
15352
+ **requestOptions:** `Drivers.RequestOptions`
15353
+
15354
+ </dd>
15355
+ </dl>
15356
+ </dd>
15357
+ </dl>
15358
+
15359
+ </dd>
15360
+ </dl>
15361
+ </details>
15362
+
15363
+ <details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">clearLastSeenV1</a>() -> boolean</code></summary>
15364
+ <dl>
15365
+ <dd>
15366
+
15367
+ #### 📝 Description
15368
+
15369
+ <dl>
15370
+ <dd>
15371
+
15372
+ <dl>
15373
+ <dd>
15374
+
15375
+ Clears the driver's last known location and timestamp. | () -> (bool)
15376
+
15377
+ </dd>
15378
+ </dl>
15379
+ </dd>
15380
+ </dl>
15381
+
15382
+ #### 🔌 Usage
15383
+
15384
+ <dl>
15385
+ <dd>
15386
+
15387
+ <dl>
15388
+ <dd>
15389
+
15390
+ ```typescript
15391
+ await client.shipping.drivers.clearLastSeenV1();
15392
+ ```
15393
+
15394
+ </dd>
15395
+ </dl>
15396
+ </dd>
15397
+ </dl>
15398
+
15399
+ #### ⚙️ Parameters
15400
+
15401
+ <dl>
15402
+ <dd>
15403
+
15404
+ <dl>
15405
+ <dd>
15406
+
15407
+ **requestOptions:** `Drivers.RequestOptions`
15408
+
15409
+ </dd>
15410
+ </dl>
15411
+ </dd>
15412
+ </dl>
15413
+
15414
+ </dd>
15415
+ </dl>
15416
+ </details>
15417
+
15418
+ <details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">updateAvailabilityAccordingToDriverV1</a>({ ...params }) -> boolean</code></summary>
15419
+ <dl>
15420
+ <dd>
15421
+
15422
+ #### 📝 Description
15423
+
15424
+ <dl>
15425
+ <dd>
15426
+
15427
+ <dl>
15428
+ <dd>
15429
+
15430
+ Updates the caller's driver availability status. Must have status UNASSIGNED to set availability to False; always allows setting to True. Provider orgs only. | (DriverUpdateAvailabilityReq) -> (bool)
15431
+
15432
+ </dd>
15433
+ </dl>
15434
+ </dd>
15435
+ </dl>
15436
+
15437
+ #### 🔌 Usage
15438
+
15439
+ <dl>
15440
+ <dd>
15441
+
15442
+ <dl>
15443
+ <dd>
15444
+
15445
+ ```typescript
15446
+ await client.shipping.drivers.updateAvailabilityAccordingToDriverV1({
15447
+ available: true,
15448
+ });
15449
+ ```
15450
+
15451
+ </dd>
15452
+ </dl>
15453
+ </dd>
15454
+ </dl>
15455
+
15456
+ #### ⚙️ Parameters
15457
+
15458
+ <dl>
15459
+ <dd>
15460
+
15461
+ <dl>
15462
+ <dd>
15463
+
15464
+ **request:** `Chrt.DriverUpdateAvailabilityReq`
15465
+
15466
+ </dd>
15467
+ </dl>
15468
+
15469
+ <dl>
15470
+ <dd>
15471
+
15472
+ **requestOptions:** `Drivers.RequestOptions`
15473
+
15474
+ </dd>
15475
+ </dl>
15476
+ </dd>
15477
+ </dl>
15478
+
15479
+ </dd>
15480
+ </dl>
15481
+ </details>
15482
+
15483
+ <details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">updateAvailabilityAccordingToOperatorsV1</a>(driverId, { ...params }) -> boolean</code></summary>
15484
+ <dl>
15485
+ <dd>
15486
+
15487
+ #### 📝 Description
15488
+
15489
+ <dl>
15490
+ <dd>
15491
+
15492
+ <dl>
15493
+ <dd>
15494
+
15495
+ Updates a driver's availability status. Must have status UNASSIGNED to set availability to False; always allows setting to True. Provider orgs only, min role: operator. | (DriverUpdateAvailabilityReq) -> (bool)
14719
15496
 
14720
15497
  </dd>
14721
15498
  </dl>
@@ -14731,13 +15508,8 @@ Lists all drivers belonging to the caller's organization with filtering, sorting
14731
15508
  <dd>
14732
15509
 
14733
15510
  ```typescript
14734
- await client.shipping.drivers.listV1({
14735
- sort_order: "asc",
14736
- page: 1,
14737
- page_size: 1,
14738
- search: "search",
14739
- filter_available_according_to_driver: true,
14740
- filter_available_according_to_operators: true,
15511
+ await client.shipping.drivers.updateAvailabilityAccordingToOperatorsV1("driver_id", {
15512
+ available: true,
14741
15513
  });
14742
15514
  ```
14743
15515
 
@@ -14754,7 +15526,15 @@ await client.shipping.drivers.listV1({
14754
15526
  <dl>
14755
15527
  <dd>
14756
15528
 
14757
- **request:** `Chrt.shipping.DriversListV1Request`
15529
+ **driverId:** `string`
15530
+
15531
+ </dd>
15532
+ </dl>
15533
+
15534
+ <dl>
15535
+ <dd>
15536
+
15537
+ **request:** `Chrt.DriverUpdateAvailabilityReq`
14758
15538
 
14759
15539
  </dd>
14760
15540
  </dl>
@@ -14773,7 +15553,7 @@ await client.shipping.drivers.listV1({
14773
15553
  </dl>
14774
15554
  </details>
14775
15555
 
14776
- <details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
15556
+ <details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">updateAutoAssignV1</a>(driverId, { ...params }) -> boolean</code></summary>
14777
15557
  <dl>
14778
15558
  <dd>
14779
15559
 
@@ -14785,7 +15565,7 @@ await client.shipping.drivers.listV1({
14785
15565
  <dl>
14786
15566
  <dd>
14787
15567
 
14788
- Creates a new driver profile for the target user (defaults to caller). Drivers can create themselves; operators+ can create any org member. Provider orgs only. | (DriverClientCreate1) -> (PydanticObjectId)
15568
+ Toggles a driver's `auto_assign_enabled` flag opt-in for direct (non-bidding) task-group assignment. Authorized: the driver themselves OR an operator+ in the driver's org (operators may override the driver's setting). Provider orgs only. | (DriverUpdateAutoAssignReq) -> (bool)
14789
15569
 
14790
15570
  </dd>
14791
15571
  </dl>
@@ -14801,9 +15581,8 @@ Creates a new driver profile for the target user (defaults to caller). Drivers c
14801
15581
  <dd>
14802
15582
 
14803
15583
  ```typescript
14804
- await client.shipping.drivers.createV1({
14805
- target_user_id: "target_user_id",
14806
- schema_version: 1,
15584
+ await client.shipping.drivers.updateAutoAssignV1("driver_id", {
15585
+ auto_assign_enabled: true,
14807
15586
  });
14808
15587
  ```
14809
15588
 
@@ -14820,7 +15599,15 @@ await client.shipping.drivers.createV1({
14820
15599
  <dl>
14821
15600
  <dd>
14822
15601
 
14823
- **request:** `Chrt.shipping.DriverClientCreate1`
15602
+ **driverId:** `string`
15603
+
15604
+ </dd>
15605
+ </dl>
15606
+
15607
+ <dl>
15608
+ <dd>
15609
+
15610
+ **request:** `Chrt.shipping.DriverUpdateAutoAssignReq`
14824
15611
 
14825
15612
  </dd>
14826
15613
  </dl>
@@ -14839,7 +15626,9 @@ await client.shipping.drivers.createV1({
14839
15626
  </dl>
14840
15627
  </details>
14841
15628
 
14842
- <details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">updateV1</a>(driverId, { ...params }) -> boolean</code></summary>
15629
+ ## Shipping Cargos
15630
+
15631
+ <details><summary><code>client.shipping.cargos.<a href="/src/api/resources/shipping/resources/cargos/client/Client.ts">updateV1</a>(cargoId, { ...params }) -> string</code></summary>
14843
15632
  <dl>
14844
15633
  <dd>
14845
15634
 
@@ -14851,7 +15640,7 @@ await client.shipping.drivers.createV1({
14851
15640
  <dl>
14852
15641
  <dd>
14853
15642
 
14854
- Updates driver contact details and vehicle type assignments. Provider orgs only; caller must be the driver (self) or an operator+. | (DriverClientUpdate1) -> (bool)
15643
+ Updates a cargo's details. Cargo must be in STAGED, IN_TRANSIT, DELIVERED, SKIPPED, or EXCEPTION status. | authz_personas=[lig_owner_operators] | (CargoClientUpdate1) -> (PydanticObjectId)
14855
15644
 
14856
15645
  </dd>
14857
15646
  </dl>
@@ -14867,7 +15656,7 @@ Updates driver contact details and vehicle type assignments. Provider orgs only;
14867
15656
  <dd>
14868
15657
 
14869
15658
  ```typescript
14870
- await client.shipping.drivers.updateV1("driver_id");
15659
+ await client.shipping.cargos.updateV1("cargo_id", {});
14871
15660
  ```
14872
15661
 
14873
15662
  </dd>
@@ -14883,7 +15672,7 @@ await client.shipping.drivers.updateV1("driver_id");
14883
15672
  <dl>
14884
15673
  <dd>
14885
15674
 
14886
- **driverId:** `string`
15675
+ **cargoId:** `string`
14887
15676
 
14888
15677
  </dd>
14889
15678
  </dl>
@@ -14891,7 +15680,7 @@ await client.shipping.drivers.updateV1("driver_id");
14891
15680
  <dl>
14892
15681
  <dd>
14893
15682
 
14894
- **request:** `Chrt.shipping.DriverClientUpdate1`
15683
+ **request:** `Chrt.CargoClientUpdate1`
14895
15684
 
14896
15685
  </dd>
14897
15686
  </dl>
@@ -14899,7 +15688,7 @@ await client.shipping.drivers.updateV1("driver_id");
14899
15688
  <dl>
14900
15689
  <dd>
14901
15690
 
14902
- **requestOptions:** `Drivers.RequestOptions`
15691
+ **requestOptions:** `Cargos.RequestOptions`
14903
15692
 
14904
15693
  </dd>
14905
15694
  </dl>
@@ -14910,7 +15699,9 @@ await client.shipping.drivers.updateV1("driver_id");
14910
15699
  </dl>
14911
15700
  </details>
14912
15701
 
14913
- <details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">clearLastSeenV1</a>() -> boolean</code></summary>
15702
+ ## Shipping Flights
15703
+
15704
+ <details><summary><code>client.shipping.flights.<a href="/src/api/resources/shipping/resources/flights/client/Client.ts">getFlightInfoForTaskV1</a>(taskId) -> Chrt.FlightInfoForTaskRes</code></summary>
14914
15705
  <dl>
14915
15706
  <dd>
14916
15707
 
@@ -14922,7 +15713,149 @@ await client.shipping.drivers.updateV1("driver_id");
14922
15713
  <dl>
14923
15714
  <dd>
14924
15715
 
14925
- Clears the driver's last known location and timestamp. | () -> (bool)
15716
+ Returns flight info from an adjacent FLIGHT task group for TENDER_TO_AIRLINE or RECOVER_FROM_AIRLINE tasks. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, shipper_org_operators] | () -> (FlightInfoForTaskRes)
15717
+
15718
+ </dd>
15719
+ </dl>
15720
+ </dd>
15721
+ </dl>
15722
+
15723
+ #### 🔌 Usage
15724
+
15725
+ <dl>
15726
+ <dd>
15727
+
15728
+ <dl>
15729
+ <dd>
15730
+
15731
+ ```typescript
15732
+ await client.shipping.flights.getFlightInfoForTaskV1("task_id");
15733
+ ```
15734
+
15735
+ </dd>
15736
+ </dl>
15737
+ </dd>
15738
+ </dl>
15739
+
15740
+ #### ⚙️ Parameters
15741
+
15742
+ <dl>
15743
+ <dd>
15744
+
15745
+ <dl>
15746
+ <dd>
15747
+
15748
+ **taskId:** `string`
15749
+
15750
+ </dd>
15751
+ </dl>
15752
+
15753
+ <dl>
15754
+ <dd>
15755
+
15756
+ **requestOptions:** `Flights.RequestOptions`
15757
+
15758
+ </dd>
15759
+ </dl>
15760
+ </dd>
15761
+ </dl>
15762
+
15763
+ </dd>
15764
+ </dl>
15765
+ </details>
15766
+
15767
+ ## Shipping TaskArtifacts
15768
+
15769
+ <details><summary><code>client.shipping.taskArtifacts.<a href="/src/api/resources/shipping/resources/taskArtifacts/client/Client.ts">addToTaskV1</a>(taskId, { ...params }) -> string</code></summary>
15770
+ <dl>
15771
+ <dd>
15772
+
15773
+ #### 📝 Description
15774
+
15775
+ <dl>
15776
+ <dd>
15777
+
15778
+ <dl>
15779
+ <dd>
15780
+
15781
+ Adds a new task artifact to a task. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators] | (AddTaskArtifactReq) -> (PydanticObjectId)
15782
+
15783
+ </dd>
15784
+ </dl>
15785
+ </dd>
15786
+ </dl>
15787
+
15788
+ #### 🔌 Usage
15789
+
15790
+ <dl>
15791
+ <dd>
15792
+
15793
+ <dl>
15794
+ <dd>
15795
+
15796
+ ```typescript
15797
+ await client.shipping.taskArtifacts.addToTaskV1("task_id", {
15798
+ task_artifact: {
15799
+ schema_version: 1,
15800
+ type: "image",
15801
+ },
15802
+ status: "draft",
15803
+ });
15804
+ ```
15805
+
15806
+ </dd>
15807
+ </dl>
15808
+ </dd>
15809
+ </dl>
15810
+
15811
+ #### ⚙️ Parameters
15812
+
15813
+ <dl>
15814
+ <dd>
15815
+
15816
+ <dl>
15817
+ <dd>
15818
+
15819
+ **taskId:** `string`
15820
+
15821
+ </dd>
15822
+ </dl>
15823
+
15824
+ <dl>
15825
+ <dd>
15826
+
15827
+ **request:** `Chrt.shipping.AddTaskArtifactReq`
15828
+
15829
+ </dd>
15830
+ </dl>
15831
+
15832
+ <dl>
15833
+ <dd>
15834
+
15835
+ **requestOptions:** `TaskArtifacts.RequestOptions`
15836
+
15837
+ </dd>
15838
+ </dl>
15839
+ </dd>
15840
+ </dl>
15841
+
15842
+ </dd>
15843
+ </dl>
15844
+ </details>
15845
+
15846
+ <details><summary><code>client.shipping.taskArtifacts.<a href="/src/api/resources/shipping/resources/taskArtifacts/client/Client.ts">completeV1</a>(taskArtifactId) -> boolean</code></summary>
15847
+ <dl>
15848
+ <dd>
15849
+
15850
+ #### 📝 Description
15851
+
15852
+ <dl>
15853
+ <dd>
15854
+
15855
+ <dl>
15856
+ <dd>
15857
+
15858
+ Marks a task artifact as COMPLETED. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators] | () -> (bool)
14926
15859
 
14927
15860
  </dd>
14928
15861
  </dl>
@@ -14938,7 +15871,7 @@ Clears the driver's last known location and timestamp. | () -> (bool)
14938
15871
  <dd>
14939
15872
 
14940
15873
  ```typescript
14941
- await client.shipping.drivers.clearLastSeenV1();
15874
+ await client.shipping.taskArtifacts.completeV1("task_artifact_id");
14942
15875
  ```
14943
15876
 
14944
15877
  </dd>
@@ -14954,7 +15887,15 @@ await client.shipping.drivers.clearLastSeenV1();
14954
15887
  <dl>
14955
15888
  <dd>
14956
15889
 
14957
- **requestOptions:** `Drivers.RequestOptions`
15890
+ **taskArtifactId:** `string`
15891
+
15892
+ </dd>
15893
+ </dl>
15894
+
15895
+ <dl>
15896
+ <dd>
15897
+
15898
+ **requestOptions:** `TaskArtifacts.RequestOptions`
14958
15899
 
14959
15900
  </dd>
14960
15901
  </dl>
@@ -14965,7 +15906,7 @@ await client.shipping.drivers.clearLastSeenV1();
14965
15906
  </dl>
14966
15907
  </details>
14967
15908
 
14968
- <details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">updateAvailabilityAccordingToDriverV1</a>({ ...params }) -> boolean</code></summary>
15909
+ <details><summary><code>client.shipping.taskArtifacts.<a href="/src/api/resources/shipping/resources/taskArtifacts/client/Client.ts">skipV1</a>(taskArtifactId) -> boolean</code></summary>
14969
15910
  <dl>
14970
15911
  <dd>
14971
15912
 
@@ -14977,7 +15918,7 @@ await client.shipping.drivers.clearLastSeenV1();
14977
15918
  <dl>
14978
15919
  <dd>
14979
15920
 
14980
- Updates the caller's driver availability status. Must have status UNASSIGNED to set availability to False; always allows setting to True. Provider orgs only. | (DriverUpdateAvailabilityReq) -> (bool)
15921
+ Marks a task artifact as SKIPPED. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators] | () -> (bool)
14981
15922
 
14982
15923
  </dd>
14983
15924
  </dl>
@@ -14993,9 +15934,7 @@ Updates the caller's driver availability status. Must have status UNASSIGNED to
14993
15934
  <dd>
14994
15935
 
14995
15936
  ```typescript
14996
- await client.shipping.drivers.updateAvailabilityAccordingToDriverV1({
14997
- available: true,
14998
- });
15937
+ await client.shipping.taskArtifacts.skipV1("task_artifact_id");
14999
15938
  ```
15000
15939
 
15001
15940
  </dd>
@@ -15011,7 +15950,7 @@ await client.shipping.drivers.updateAvailabilityAccordingToDriverV1({
15011
15950
  <dl>
15012
15951
  <dd>
15013
15952
 
15014
- **request:** `Chrt.DriverUpdateAvailabilityReq`
15953
+ **taskArtifactId:** `string`
15015
15954
 
15016
15955
  </dd>
15017
15956
  </dl>
@@ -15019,7 +15958,7 @@ await client.shipping.drivers.updateAvailabilityAccordingToDriverV1({
15019
15958
  <dl>
15020
15959
  <dd>
15021
15960
 
15022
- **requestOptions:** `Drivers.RequestOptions`
15961
+ **requestOptions:** `TaskArtifacts.RequestOptions`
15023
15962
 
15024
15963
  </dd>
15025
15964
  </dl>
@@ -15030,7 +15969,7 @@ await client.shipping.drivers.updateAvailabilityAccordingToDriverV1({
15030
15969
  </dl>
15031
15970
  </details>
15032
15971
 
15033
- <details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">updateAvailabilityAccordingToOperatorsV1</a>(driverId, { ...params }) -> boolean</code></summary>
15972
+ <details><summary><code>client.shipping.taskArtifacts.<a href="/src/api/resources/shipping/resources/taskArtifacts/client/Client.ts">deleteV1</a>(taskArtifactId) -> boolean</code></summary>
15034
15973
  <dl>
15035
15974
  <dd>
15036
15975
 
@@ -15042,7 +15981,7 @@ await client.shipping.drivers.updateAvailabilityAccordingToDriverV1({
15042
15981
  <dl>
15043
15982
  <dd>
15044
15983
 
15045
- Updates a driver's availability status. Must have status UNASSIGNED to set availability to False; always allows setting to True. Provider orgs only, min role: operator. | (DriverUpdateAvailabilityReq) -> (bool)
15984
+ Deletes a task artifact. | authz_personas=[lig_owner_operators] | () -> (bool)
15046
15985
 
15047
15986
  </dd>
15048
15987
  </dl>
@@ -15058,9 +15997,7 @@ Updates a driver's availability status. Must have status UNASSIGNED to set avail
15058
15997
  <dd>
15059
15998
 
15060
15999
  ```typescript
15061
- await client.shipping.drivers.updateAvailabilityAccordingToOperatorsV1("driver_id", {
15062
- available: true,
15063
- });
16000
+ await client.shipping.taskArtifacts.deleteV1("task_artifact_id");
15064
16001
  ```
15065
16002
 
15066
16003
  </dd>
@@ -15076,15 +16013,7 @@ await client.shipping.drivers.updateAvailabilityAccordingToOperatorsV1("driver_i
15076
16013
  <dl>
15077
16014
  <dd>
15078
16015
 
15079
- **driverId:** `string`
15080
-
15081
- </dd>
15082
- </dl>
15083
-
15084
- <dl>
15085
- <dd>
15086
-
15087
- **request:** `Chrt.DriverUpdateAvailabilityReq`
16016
+ **taskArtifactId:** `string`
15088
16017
 
15089
16018
  </dd>
15090
16019
  </dl>
@@ -15092,7 +16021,7 @@ await client.shipping.drivers.updateAvailabilityAccordingToOperatorsV1("driver_i
15092
16021
  <dl>
15093
16022
  <dd>
15094
16023
 
15095
- **requestOptions:** `Drivers.RequestOptions`
16024
+ **requestOptions:** `TaskArtifacts.RequestOptions`
15096
16025
 
15097
16026
  </dd>
15098
16027
  </dl>
@@ -15103,7 +16032,9 @@ await client.shipping.drivers.updateAvailabilityAccordingToOperatorsV1("driver_i
15103
16032
  </dl>
15104
16033
  </details>
15105
16034
 
15106
- <details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">updateAutoAssignV1</a>(driverId, { ...params }) -> boolean</code></summary>
16035
+ ## Shipping Orders
16036
+
16037
+ <details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">stageV1</a>(orderId) -> boolean</code></summary>
15107
16038
  <dl>
15108
16039
  <dd>
15109
16040
 
@@ -15115,7 +16046,7 @@ await client.shipping.drivers.updateAvailabilityAccordingToOperatorsV1("driver_i
15115
16046
  <dl>
15116
16047
  <dd>
15117
16048
 
15118
- Toggles a driver's `auto_assign_enabled` flag opt-in for direct (non-bidding) task-group assignment. Authorized: the driver themselves OR an operator+ in the driver's org (operators may override the driver's setting). Provider orgs only. | (DriverUpdateAutoAssignReq) -> (bool)
16049
+ Validates a draft order and stages all related entities in a transaction. | () -> (bool)
15119
16050
 
15120
16051
  </dd>
15121
16052
  </dl>
@@ -15131,9 +16062,7 @@ Toggles a driver's `auto_assign_enabled` flag — opt-in for direct (non-bidding
15131
16062
  <dd>
15132
16063
 
15133
16064
  ```typescript
15134
- await client.shipping.drivers.updateAutoAssignV1("driver_id", {
15135
- auto_assign_enabled: true,
15136
- });
16065
+ await client.shipping.orders.stageV1("order_id");
15137
16066
  ```
15138
16067
 
15139
16068
  </dd>
@@ -15149,15 +16078,7 @@ await client.shipping.drivers.updateAutoAssignV1("driver_id", {
15149
16078
  <dl>
15150
16079
  <dd>
15151
16080
 
15152
- **driverId:** `string`
15153
-
15154
- </dd>
15155
- </dl>
15156
-
15157
- <dl>
15158
- <dd>
15159
-
15160
- **request:** `Chrt.shipping.DriverUpdateAutoAssignReq`
16081
+ **orderId:** `string`
15161
16082
 
15162
16083
  </dd>
15163
16084
  </dl>
@@ -15165,7 +16086,7 @@ await client.shipping.drivers.updateAutoAssignV1("driver_id", {
15165
16086
  <dl>
15166
16087
  <dd>
15167
16088
 
15168
- **requestOptions:** `Drivers.RequestOptions`
16089
+ **requestOptions:** `Orders.RequestOptions`
15169
16090
 
15170
16091
  </dd>
15171
16092
  </dl>
@@ -15176,9 +16097,7 @@ await client.shipping.drivers.updateAutoAssignV1("driver_id", {
15176
16097
  </dl>
15177
16098
  </details>
15178
16099
 
15179
- ## Shipping Cargos
15180
-
15181
- <details><summary><code>client.shipping.cargos.<a href="/src/api/resources/shipping/resources/cargos/client/Client.ts">updateV1</a>(cargoId, { ...params }) -> string</code></summary>
16100
+ <details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">updateOffChrtReferenceIdV1</a>(orderId, { ...params }) -> Chrt.OrdersUpdateOffChrtReferenceIdRes</code></summary>
15182
16101
  <dl>
15183
16102
  <dd>
15184
16103
 
@@ -15190,7 +16109,7 @@ await client.shipping.drivers.updateAutoAssignV1("driver_id", {
15190
16109
  <dl>
15191
16110
  <dd>
15192
16111
 
15193
- Updates a cargo's details. Cargo must be in STAGED, IN_TRANSIT, DELIVERED, SKIPPED, or EXCEPTION status. | authz_personas=[lig_owner_operators] | (CargoClientUpdate1) -> (PydanticObjectId)
16112
+ Updates off_chrt_reference_id on a non-draft order. | authz_personas=[order_creator_org_operators] | (OrdersUpdateOffChrtReferenceIdReq) -> (OrdersUpdateOffChrtReferenceIdRes)
15194
16113
 
15195
16114
  </dd>
15196
16115
  </dl>
@@ -15206,7 +16125,7 @@ Updates a cargo's details. Cargo must be in STAGED, IN_TRANSIT, DELIVERED, SKIPP
15206
16125
  <dd>
15207
16126
 
15208
16127
  ```typescript
15209
- await client.shipping.cargos.updateV1("cargo_id", {});
16128
+ await client.shipping.orders.updateOffChrtReferenceIdV1("order_id");
15210
16129
  ```
15211
16130
 
15212
16131
  </dd>
@@ -15222,7 +16141,7 @@ await client.shipping.cargos.updateV1("cargo_id", {});
15222
16141
  <dl>
15223
16142
  <dd>
15224
16143
 
15225
- **cargoId:** `string`
16144
+ **orderId:** `string`
15226
16145
 
15227
16146
  </dd>
15228
16147
  </dl>
@@ -15230,7 +16149,7 @@ await client.shipping.cargos.updateV1("cargo_id", {});
15230
16149
  <dl>
15231
16150
  <dd>
15232
16151
 
15233
- **request:** `Chrt.CargoClientUpdate1`
16152
+ **request:** `Chrt.shipping.OrdersUpdateOffChrtReferenceIdReq`
15234
16153
 
15235
16154
  </dd>
15236
16155
  </dl>
@@ -15238,7 +16157,7 @@ await client.shipping.cargos.updateV1("cargo_id", {});
15238
16157
  <dl>
15239
16158
  <dd>
15240
16159
 
15241
- **requestOptions:** `Cargos.RequestOptions`
16160
+ **requestOptions:** `Orders.RequestOptions`
15242
16161
 
15243
16162
  </dd>
15244
16163
  </dl>
@@ -15249,9 +16168,7 @@ await client.shipping.cargos.updateV1("cargo_id", {});
15249
16168
  </dl>
15250
16169
  </details>
15251
16170
 
15252
- ## Shipping Flights
15253
-
15254
- <details><summary><code>client.shipping.flights.<a href="/src/api/resources/shipping/resources/flights/client/Client.ts">getFlightInfoForTaskV1</a>(taskId) -> Chrt.FlightInfoForTaskRes</code></summary>
16171
+ <details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">cancelV1</a>(orderId) -> boolean</code></summary>
15255
16172
  <dl>
15256
16173
  <dd>
15257
16174
 
@@ -15263,7 +16180,7 @@ await client.shipping.cargos.updateV1("cargo_id", {});
15263
16180
  <dl>
15264
16181
  <dd>
15265
16182
 
15266
- Returns flight info from an adjacent FLIGHT task group for TENDER_TO_AIRLINE or RECOVER_FROM_AIRLINE tasks. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, shipper_org_operators] | () -> (FlightInfoForTaskRes)
16183
+ Cancels an order and all related task groups and tasks in a transaction. | authz_personas=[lig_owner_operators] | () -> (bool)
15267
16184
 
15268
16185
  </dd>
15269
16186
  </dl>
@@ -15279,7 +16196,7 @@ Returns flight info from an adjacent FLIGHT task group for TENDER_TO_AIRLINE or
15279
16196
  <dd>
15280
16197
 
15281
16198
  ```typescript
15282
- await client.shipping.flights.getFlightInfoForTaskV1("task_id");
16199
+ await client.shipping.orders.cancelV1("order_id");
15283
16200
  ```
15284
16201
 
15285
16202
  </dd>
@@ -15295,7 +16212,7 @@ await client.shipping.flights.getFlightInfoForTaskV1("task_id");
15295
16212
  <dl>
15296
16213
  <dd>
15297
16214
 
15298
- **taskId:** `string`
16215
+ **orderId:** `string`
15299
16216
 
15300
16217
  </dd>
15301
16218
  </dl>
@@ -15303,7 +16220,7 @@ await client.shipping.flights.getFlightInfoForTaskV1("task_id");
15303
16220
  <dl>
15304
16221
  <dd>
15305
16222
 
15306
- **requestOptions:** `Flights.RequestOptions`
16223
+ **requestOptions:** `Orders.RequestOptions`
15307
16224
 
15308
16225
  </dd>
15309
16226
  </dl>
@@ -15314,9 +16231,9 @@ await client.shipping.flights.getFlightInfoForTaskV1("task_id");
15314
16231
  </dl>
15315
16232
  </details>
15316
16233
 
15317
- ## Shipping TaskArtifacts
16234
+ ## Shipping OrderDrafts
15318
16235
 
15319
- <details><summary><code>client.shipping.taskArtifacts.<a href="/src/api/resources/shipping/resources/taskArtifacts/client/Client.ts">addToTaskV1</a>(taskId, { ...params }) -> string</code></summary>
16236
+ <details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">newV1</a>({ ...params }) -> Chrt.OrdersNewDraftRes</code></summary>
15320
16237
  <dl>
15321
16238
  <dd>
15322
16239
 
@@ -15328,7 +16245,7 @@ await client.shipping.flights.getFlightInfoForTaskV1("task_id");
15328
16245
  <dl>
15329
16246
  <dd>
15330
16247
 
15331
- Adds a new task artifact to a task. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators] | (AddTaskArtifactReq) -> (PydanticObjectId)
16248
+ Creates a new draft order with org assignments based on caller's organization type. | (OrdersNewDraftReq) -> (OrdersNewDraftRes)
15332
16249
 
15333
16250
  </dd>
15334
16251
  </dl>
@@ -15344,13 +16261,7 @@ Adds a new task artifact to a task. | authz_personas=[driver_for_executor, execu
15344
16261
  <dd>
15345
16262
 
15346
16263
  ```typescript
15347
- await client.shipping.taskArtifacts.addToTaskV1("task_id", {
15348
- task_artifact: {
15349
- schema_version: 1,
15350
- type: "image",
15351
- },
15352
- status: "draft",
15353
- });
16264
+ await client.shipping.orderDrafts.newV1();
15354
16265
  ```
15355
16266
 
15356
16267
  </dd>
@@ -15366,15 +16277,7 @@ await client.shipping.taskArtifacts.addToTaskV1("task_id", {
15366
16277
  <dl>
15367
16278
  <dd>
15368
16279
 
15369
- **taskId:** `string`
15370
-
15371
- </dd>
15372
- </dl>
15373
-
15374
- <dl>
15375
- <dd>
15376
-
15377
- **request:** `Chrt.shipping.AddTaskArtifactReq`
16280
+ **request:** `Chrt.shipping.OrdersNewDraftReq`
15378
16281
 
15379
16282
  </dd>
15380
16283
  </dl>
@@ -15382,7 +16285,7 @@ await client.shipping.taskArtifacts.addToTaskV1("task_id", {
15382
16285
  <dl>
15383
16286
  <dd>
15384
16287
 
15385
- **requestOptions:** `TaskArtifacts.RequestOptions`
16288
+ **requestOptions:** `OrderDrafts.RequestOptions`
15386
16289
 
15387
16290
  </dd>
15388
16291
  </dl>
@@ -15393,7 +16296,7 @@ await client.shipping.taskArtifacts.addToTaskV1("task_id", {
15393
16296
  </dl>
15394
16297
  </details>
15395
16298
 
15396
- <details><summary><code>client.shipping.taskArtifacts.<a href="/src/api/resources/shipping/resources/taskArtifacts/client/Client.ts">completeV1</a>(taskArtifactId) -> boolean</code></summary>
16299
+ <details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">updateV1</a>(orderId, { ...params }) -> Chrt.OrdersDraftUpdateRes</code></summary>
15397
16300
  <dl>
15398
16301
  <dd>
15399
16302
 
@@ -15405,7 +16308,7 @@ await client.shipping.taskArtifacts.addToTaskV1("task_id", {
15405
16308
  <dl>
15406
16309
  <dd>
15407
16310
 
15408
- Marks a task artifact as COMPLETED. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators] | () -> (bool)
16311
+ Updates coordinator and/or shipper org assignments for a draft order. | (OrdersDraftUpdateReq) -> (OrdersDraftUpdateRes)
15409
16312
 
15410
16313
  </dd>
15411
16314
  </dl>
@@ -15421,7 +16324,7 @@ Marks a task artifact as COMPLETED. | authz_personas=[driver_for_executor, execu
15421
16324
  <dd>
15422
16325
 
15423
16326
  ```typescript
15424
- await client.shipping.taskArtifacts.completeV1("task_artifact_id");
16327
+ await client.shipping.orderDrafts.updateV1("order_id");
15425
16328
  ```
15426
16329
 
15427
16330
  </dd>
@@ -15437,7 +16340,7 @@ await client.shipping.taskArtifacts.completeV1("task_artifact_id");
15437
16340
  <dl>
15438
16341
  <dd>
15439
16342
 
15440
- **taskArtifactId:** `string`
16343
+ **orderId:** `string`
15441
16344
 
15442
16345
  </dd>
15443
16346
  </dl>
@@ -15445,7 +16348,15 @@ await client.shipping.taskArtifacts.completeV1("task_artifact_id");
15445
16348
  <dl>
15446
16349
  <dd>
15447
16350
 
15448
- **requestOptions:** `TaskArtifacts.RequestOptions`
16351
+ **request:** `Chrt.shipping.OrdersDraftUpdateReq`
16352
+
16353
+ </dd>
16354
+ </dl>
16355
+
16356
+ <dl>
16357
+ <dd>
16358
+
16359
+ **requestOptions:** `OrderDrafts.RequestOptions`
15449
16360
 
15450
16361
  </dd>
15451
16362
  </dl>
@@ -15456,7 +16367,7 @@ await client.shipping.taskArtifacts.completeV1("task_artifact_id");
15456
16367
  </dl>
15457
16368
  </details>
15458
16369
 
15459
- <details><summary><code>client.shipping.taskArtifacts.<a href="/src/api/resources/shipping/resources/taskArtifacts/client/Client.ts">skipV1</a>(taskArtifactId) -> boolean</code></summary>
16370
+ <details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">deleteV1</a>(orderId) -> boolean</code></summary>
15460
16371
  <dl>
15461
16372
  <dd>
15462
16373
 
@@ -15468,7 +16379,7 @@ await client.shipping.taskArtifacts.completeV1("task_artifact_id");
15468
16379
  <dl>
15469
16380
  <dd>
15470
16381
 
15471
- Marks a task artifact as SKIPPED. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators] | () -> (bool)
16382
+ Deletes a draft order and all associated entities. | () -> (bool)
15472
16383
 
15473
16384
  </dd>
15474
16385
  </dl>
@@ -15484,7 +16395,7 @@ Marks a task artifact as SKIPPED. | authz_personas=[driver_for_executor, executo
15484
16395
  <dd>
15485
16396
 
15486
16397
  ```typescript
15487
- await client.shipping.taskArtifacts.skipV1("task_artifact_id");
16398
+ await client.shipping.orderDrafts.deleteV1("order_id");
15488
16399
  ```
15489
16400
 
15490
16401
  </dd>
@@ -15500,7 +16411,7 @@ await client.shipping.taskArtifacts.skipV1("task_artifact_id");
15500
16411
  <dl>
15501
16412
  <dd>
15502
16413
 
15503
- **taskArtifactId:** `string`
16414
+ **orderId:** `string`
15504
16415
 
15505
16416
  </dd>
15506
16417
  </dl>
@@ -15508,7 +16419,7 @@ await client.shipping.taskArtifacts.skipV1("task_artifact_id");
15508
16419
  <dl>
15509
16420
  <dd>
15510
16421
 
15511
- **requestOptions:** `TaskArtifacts.RequestOptions`
16422
+ **requestOptions:** `OrderDrafts.RequestOptions`
15512
16423
 
15513
16424
  </dd>
15514
16425
  </dl>
@@ -15519,7 +16430,7 @@ await client.shipping.taskArtifacts.skipV1("task_artifact_id");
15519
16430
  </dl>
15520
16431
  </details>
15521
16432
 
15522
- <details><summary><code>client.shipping.taskArtifacts.<a href="/src/api/resources/shipping/resources/taskArtifacts/client/Client.ts">deleteV1</a>(taskArtifactId) -> boolean</code></summary>
16433
+ <details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">validateV1</a>(orderId) -> Chrt.OrderDraftValidationResult</code></summary>
15523
16434
  <dl>
15524
16435
  <dd>
15525
16436
 
@@ -15531,7 +16442,7 @@ await client.shipping.taskArtifacts.skipV1("task_artifact_id");
15531
16442
  <dl>
15532
16443
  <dd>
15533
16444
 
15534
- Deletes a task artifact. | authz_personas=[lig_owner_operators] | () -> (bool)
16445
+ Validates the draft order for staging and returns requirement results. | () -> (OrderDraftValidationResult)
15535
16446
 
15536
16447
  </dd>
15537
16448
  </dl>
@@ -15547,7 +16458,7 @@ Deletes a task artifact. | authz_personas=[lig_owner_operators] | () -> (bool)
15547
16458
  <dd>
15548
16459
 
15549
16460
  ```typescript
15550
- await client.shipping.taskArtifacts.deleteV1("task_artifact_id");
16461
+ await client.shipping.orderDrafts.validateV1("order_id");
15551
16462
  ```
15552
16463
 
15553
16464
  </dd>
@@ -15563,7 +16474,7 @@ await client.shipping.taskArtifacts.deleteV1("task_artifact_id");
15563
16474
  <dl>
15564
16475
  <dd>
15565
16476
 
15566
- **taskArtifactId:** `string`
16477
+ **orderId:** `string`
15567
16478
 
15568
16479
  </dd>
15569
16480
  </dl>
@@ -15571,7 +16482,7 @@ await client.shipping.taskArtifacts.deleteV1("task_artifact_id");
15571
16482
  <dl>
15572
16483
  <dd>
15573
16484
 
15574
- **requestOptions:** `TaskArtifacts.RequestOptions`
16485
+ **requestOptions:** `OrderDrafts.RequestOptions`
15575
16486
 
15576
16487
  </dd>
15577
16488
  </dl>
@@ -15582,9 +16493,9 @@ await client.shipping.taskArtifacts.deleteV1("task_artifact_id");
15582
16493
  </dl>
15583
16494
  </details>
15584
16495
 
15585
- ## Shipping Orders
16496
+ ## Shipping OrderSchedules
15586
16497
 
15587
- <details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">stageV1</a>(orderId) -> boolean</code></summary>
16498
+ <details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">listV1</a>({ ...params }) -> Chrt.OrderScheduleListRes</code></summary>
15588
16499
  <dl>
15589
16500
  <dd>
15590
16501
 
@@ -15596,7 +16507,7 @@ await client.shipping.taskArtifacts.deleteV1("task_artifact_id");
15596
16507
  <dl>
15597
16508
  <dd>
15598
16509
 
15599
- Validates a draft order and stages all related entities in a transaction. | () -> (bool)
16510
+ Lists order schedules for the caller's organization with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (OrderScheduleListRes)
15600
16511
 
15601
16512
  </dd>
15602
16513
  </dl>
@@ -15612,7 +16523,17 @@ Validates a draft order and stages all related entities in a transaction. | () -
15612
16523
  <dd>
15613
16524
 
15614
16525
  ```typescript
15615
- await client.shipping.orders.stageV1("order_id");
16526
+ await client.shipping.orderSchedules.listV1({
16527
+ sort_by: "created_at_timestamp",
16528
+ sort_order: "asc",
16529
+ page: 1,
16530
+ page_size: 1,
16531
+ filter_owned_by_user_id: "filter_owned_by_user_id",
16532
+ filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
16533
+ filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
16534
+ filter_last_edited_at_timestamp_gte: "2024-01-15T09:30:00Z",
16535
+ filter_last_edited_at_timestamp_lte: "2024-01-15T09:30:00Z",
16536
+ });
15616
16537
  ```
15617
16538
 
15618
16539
  </dd>
@@ -15628,7 +16549,7 @@ await client.shipping.orders.stageV1("order_id");
15628
16549
  <dl>
15629
16550
  <dd>
15630
16551
 
15631
- **orderId:** `string`
16552
+ **request:** `Chrt.shipping.OrderSchedulesListV1Request`
15632
16553
 
15633
16554
  </dd>
15634
16555
  </dl>
@@ -15636,7 +16557,7 @@ await client.shipping.orders.stageV1("order_id");
15636
16557
  <dl>
15637
16558
  <dd>
15638
16559
 
15639
- **requestOptions:** `Orders.RequestOptions`
16560
+ **requestOptions:** `OrderSchedules.RequestOptions`
15640
16561
 
15641
16562
  </dd>
15642
16563
  </dl>
@@ -15647,7 +16568,7 @@ await client.shipping.orders.stageV1("order_id");
15647
16568
  </dl>
15648
16569
  </details>
15649
16570
 
15650
- <details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">updateOffChrtReferenceIdV1</a>(orderId, { ...params }) -> Chrt.OrdersUpdateOffChrtReferenceIdRes</code></summary>
16571
+ <details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">getByIdV1</a>(orderScheduleId) -> Chrt.OrderSchedule1</code></summary>
15651
16572
  <dl>
15652
16573
  <dd>
15653
16574
 
@@ -15659,7 +16580,7 @@ await client.shipping.orders.stageV1("order_id");
15659
16580
  <dl>
15660
16581
  <dd>
15661
16582
 
15662
- Updates off_chrt_reference_id on a non-draft order. | authz_personas=[order_creator_org_operators] | (OrdersUpdateOffChrtReferenceIdReq) -> (OrdersUpdateOffChrtReferenceIdRes)
16583
+ Retrieves an order schedule by ID. | authz: min_org_role=operator | () -> (OrderSchedule1)
15663
16584
 
15664
16585
  </dd>
15665
16586
  </dl>
@@ -15675,7 +16596,7 @@ Updates off_chrt_reference_id on a non-draft order. | authz_personas=[order_crea
15675
16596
  <dd>
15676
16597
 
15677
16598
  ```typescript
15678
- await client.shipping.orders.updateOffChrtReferenceIdV1("order_id");
16599
+ await client.shipping.orderSchedules.getByIdV1("order_schedule_id");
15679
16600
  ```
15680
16601
 
15681
16602
  </dd>
@@ -15691,15 +16612,7 @@ await client.shipping.orders.updateOffChrtReferenceIdV1("order_id");
15691
16612
  <dl>
15692
16613
  <dd>
15693
16614
 
15694
- **orderId:** `string`
15695
-
15696
- </dd>
15697
- </dl>
15698
-
15699
- <dl>
15700
- <dd>
15701
-
15702
- **request:** `Chrt.shipping.OrdersUpdateOffChrtReferenceIdReq`
16615
+ **orderScheduleId:** `string`
15703
16616
 
15704
16617
  </dd>
15705
16618
  </dl>
@@ -15707,7 +16620,7 @@ await client.shipping.orders.updateOffChrtReferenceIdV1("order_id");
15707
16620
  <dl>
15708
16621
  <dd>
15709
16622
 
15710
- **requestOptions:** `Orders.RequestOptions`
16623
+ **requestOptions:** `OrderSchedules.RequestOptions`
15711
16624
 
15712
16625
  </dd>
15713
16626
  </dl>
@@ -15718,7 +16631,7 @@ await client.shipping.orders.updateOffChrtReferenceIdV1("order_id");
15718
16631
  </dl>
15719
16632
  </details>
15720
16633
 
15721
- <details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">cancelV1</a>(orderId) -> boolean</code></summary>
16634
+ <details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">aboutV1</a>(orderScheduleId) -> Chrt.OrderScheduleAboutRes</code></summary>
15722
16635
  <dl>
15723
16636
  <dd>
15724
16637
 
@@ -15730,7 +16643,7 @@ await client.shipping.orders.updateOffChrtReferenceIdV1("order_id");
15730
16643
  <dl>
15731
16644
  <dd>
15732
16645
 
15733
- Cancels an order and all related task groups and tasks in a transaction. | authz_personas=[lig_owner_operators] | () -> (bool)
16646
+ Retrieves schedule metadata, generated order count, and live orchestrator status. | authz: min_org_role=operator | () -> (OrderScheduleAboutRes)
15734
16647
 
15735
16648
  </dd>
15736
16649
  </dl>
@@ -15746,7 +16659,7 @@ Cancels an order and all related task groups and tasks in a transaction. | authz
15746
16659
  <dd>
15747
16660
 
15748
16661
  ```typescript
15749
- await client.shipping.orders.cancelV1("order_id");
16662
+ await client.shipping.orderSchedules.aboutV1("order_schedule_id");
15750
16663
  ```
15751
16664
 
15752
16665
  </dd>
@@ -15762,7 +16675,7 @@ await client.shipping.orders.cancelV1("order_id");
15762
16675
  <dl>
15763
16676
  <dd>
15764
16677
 
15765
- **orderId:** `string`
16678
+ **orderScheduleId:** `string`
15766
16679
 
15767
16680
  </dd>
15768
16681
  </dl>
@@ -15770,7 +16683,7 @@ await client.shipping.orders.cancelV1("order_id");
15770
16683
  <dl>
15771
16684
  <dd>
15772
16685
 
15773
- **requestOptions:** `Orders.RequestOptions`
16686
+ **requestOptions:** `OrderSchedules.RequestOptions`
15774
16687
 
15775
16688
  </dd>
15776
16689
  </dl>
@@ -15781,9 +16694,7 @@ await client.shipping.orders.cancelV1("order_id");
15781
16694
  </dl>
15782
16695
  </details>
15783
16696
 
15784
- ## Shipping OrderDrafts
15785
-
15786
- <details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">newV1</a>({ ...params }) -> Chrt.OrdersNewDraftRes</code></summary>
16697
+ <details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">newV1</a>({ ...params }) -> string</code></summary>
15787
16698
  <dl>
15788
16699
  <dd>
15789
16700
 
@@ -15795,7 +16706,7 @@ await client.shipping.orders.cancelV1("order_id");
15795
16706
  <dl>
15796
16707
  <dd>
15797
16708
 
15798
- Creates a new draft order with org assignments based on caller's organization type. | (OrdersNewDraftReq) -> (OrdersNewDraftRes)
16709
+ Creates a new draft order schedule. | authz: min_org_role=operator | (OrderScheduleClientCreate1) -> (PydanticObjectId)
15799
16710
 
15800
16711
  </dd>
15801
16712
  </dl>
@@ -15811,7 +16722,12 @@ Creates a new draft order with org assignments based on caller's organization ty
15811
16722
  <dd>
15812
16723
 
15813
16724
  ```typescript
15814
- await client.shipping.orderDrafts.newV1();
16725
+ await client.shipping.orderSchedules.newV1({
16726
+ schema_version: 1,
16727
+ name: "name",
16728
+ order_manifest: {},
16729
+ schedule_spec: {},
16730
+ });
15815
16731
  ```
15816
16732
 
15817
16733
  </dd>
@@ -15827,7 +16743,7 @@ await client.shipping.orderDrafts.newV1();
15827
16743
  <dl>
15828
16744
  <dd>
15829
16745
 
15830
- **request:** `Chrt.shipping.OrdersNewDraftReq`
16746
+ **request:** `Chrt.shipping.OrderScheduleClientCreate1`
15831
16747
 
15832
16748
  </dd>
15833
16749
  </dl>
@@ -15835,7 +16751,7 @@ await client.shipping.orderDrafts.newV1();
15835
16751
  <dl>
15836
16752
  <dd>
15837
16753
 
15838
- **requestOptions:** `OrderDrafts.RequestOptions`
16754
+ **requestOptions:** `OrderSchedules.RequestOptions`
15839
16755
 
15840
16756
  </dd>
15841
16757
  </dl>
@@ -15846,7 +16762,7 @@ await client.shipping.orderDrafts.newV1();
15846
16762
  </dl>
15847
16763
  </details>
15848
16764
 
15849
- <details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">updateV1</a>(orderId, { ...params }) -> Chrt.OrdersDraftUpdateRes</code></summary>
16765
+ <details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">updateV1</a>(orderScheduleId, { ...params }) -> boolean</code></summary>
15850
16766
  <dl>
15851
16767
  <dd>
15852
16768
 
@@ -15858,7 +16774,7 @@ await client.shipping.orderDrafts.newV1();
15858
16774
  <dl>
15859
16775
  <dd>
15860
16776
 
15861
- Updates coordinator and/or shipper org assignments for a draft order. | (OrdersDraftUpdateReq) -> (OrdersDraftUpdateRes)
16777
+ Updates an order schedule. | authz: min_org_role=operator | (OrderScheduleClientUpdate1) -> (bool)
15862
16778
 
15863
16779
  </dd>
15864
16780
  </dl>
@@ -15874,7 +16790,7 @@ Updates coordinator and/or shipper org assignments for a draft order. | (OrdersD
15874
16790
  <dd>
15875
16791
 
15876
16792
  ```typescript
15877
- await client.shipping.orderDrafts.updateV1("order_id");
16793
+ await client.shipping.orderSchedules.updateV1("order_schedule_id");
15878
16794
  ```
15879
16795
 
15880
16796
  </dd>
@@ -15890,7 +16806,7 @@ await client.shipping.orderDrafts.updateV1("order_id");
15890
16806
  <dl>
15891
16807
  <dd>
15892
16808
 
15893
- **orderId:** `string`
16809
+ **orderScheduleId:** `string`
15894
16810
 
15895
16811
  </dd>
15896
16812
  </dl>
@@ -15898,7 +16814,7 @@ await client.shipping.orderDrafts.updateV1("order_id");
15898
16814
  <dl>
15899
16815
  <dd>
15900
16816
 
15901
- **request:** `Chrt.shipping.OrdersDraftUpdateReq`
16817
+ **request:** `Chrt.shipping.OrderScheduleClientUpdate1`
15902
16818
 
15903
16819
  </dd>
15904
16820
  </dl>
@@ -15906,7 +16822,7 @@ await client.shipping.orderDrafts.updateV1("order_id");
15906
16822
  <dl>
15907
16823
  <dd>
15908
16824
 
15909
- **requestOptions:** `OrderDrafts.RequestOptions`
16825
+ **requestOptions:** `OrderSchedules.RequestOptions`
15910
16826
 
15911
16827
  </dd>
15912
16828
  </dl>
@@ -15917,7 +16833,7 @@ await client.shipping.orderDrafts.updateV1("order_id");
15917
16833
  </dl>
15918
16834
  </details>
15919
16835
 
15920
- <details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">deleteV1</a>(orderId) -> boolean</code></summary>
16836
+ <details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">takeOwnershipV1</a>(orderScheduleId) -> boolean</code></summary>
15921
16837
  <dl>
15922
16838
  <dd>
15923
16839
 
@@ -15929,7 +16845,7 @@ await client.shipping.orderDrafts.updateV1("order_id");
15929
16845
  <dl>
15930
16846
  <dd>
15931
16847
 
15932
- Deletes a draft order and all associated entities. | () -> (bool)
16848
+ Transfers order schedule workflow ownership to the caller. | authz: min_org_role=operator | () -> (bool)
15933
16849
 
15934
16850
  </dd>
15935
16851
  </dl>
@@ -15945,7 +16861,7 @@ Deletes a draft order and all associated entities. | () -> (bool)
15945
16861
  <dd>
15946
16862
 
15947
16863
  ```typescript
15948
- await client.shipping.orderDrafts.deleteV1("order_id");
16864
+ await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id");
15949
16865
  ```
15950
16866
 
15951
16867
  </dd>
@@ -15961,7 +16877,7 @@ await client.shipping.orderDrafts.deleteV1("order_id");
15961
16877
  <dl>
15962
16878
  <dd>
15963
16879
 
15964
- **orderId:** `string`
16880
+ **orderScheduleId:** `string`
15965
16881
 
15966
16882
  </dd>
15967
16883
  </dl>
@@ -15969,7 +16885,7 @@ await client.shipping.orderDrafts.deleteV1("order_id");
15969
16885
  <dl>
15970
16886
  <dd>
15971
16887
 
15972
- **requestOptions:** `OrderDrafts.RequestOptions`
16888
+ **requestOptions:** `OrderSchedules.RequestOptions`
15973
16889
 
15974
16890
  </dd>
15975
16891
  </dl>
@@ -15980,7 +16896,7 @@ await client.shipping.orderDrafts.deleteV1("order_id");
15980
16896
  </dl>
15981
16897
  </details>
15982
16898
 
15983
- <details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">validateV1</a>(orderId) -> Chrt.OrderDraftValidationResult</code></summary>
16899
+ <details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">activateV1</a>(orderScheduleId) -> boolean</code></summary>
15984
16900
  <dl>
15985
16901
  <dd>
15986
16902
 
@@ -15992,7 +16908,7 @@ await client.shipping.orderDrafts.deleteV1("order_id");
15992
16908
  <dl>
15993
16909
  <dd>
15994
16910
 
15995
- Validates the draft order for staging and returns requirement results. | () -> (OrderDraftValidationResult)
16911
+ Validates a draft order schedule, creates its Temporal orchestrator schedule, and activates it. | authz: min_org_role=operator | () -> (bool)
15996
16912
 
15997
16913
  </dd>
15998
16914
  </dl>
@@ -16008,7 +16924,7 @@ Validates the draft order for staging and returns requirement results. | () -> (
16008
16924
  <dd>
16009
16925
 
16010
16926
  ```typescript
16011
- await client.shipping.orderDrafts.validateV1("order_id");
16927
+ await client.shipping.orderSchedules.activateV1("order_schedule_id");
16012
16928
  ```
16013
16929
 
16014
16930
  </dd>
@@ -16024,7 +16940,7 @@ await client.shipping.orderDrafts.validateV1("order_id");
16024
16940
  <dl>
16025
16941
  <dd>
16026
16942
 
16027
- **orderId:** `string`
16943
+ **orderScheduleId:** `string`
16028
16944
 
16029
16945
  </dd>
16030
16946
  </dl>
@@ -16032,7 +16948,7 @@ await client.shipping.orderDrafts.validateV1("order_id");
16032
16948
  <dl>
16033
16949
  <dd>
16034
16950
 
16035
- **requestOptions:** `OrderDrafts.RequestOptions`
16951
+ **requestOptions:** `OrderSchedules.RequestOptions`
16036
16952
 
16037
16953
  </dd>
16038
16954
  </dl>
@@ -16043,9 +16959,7 @@ await client.shipping.orderDrafts.validateV1("order_id");
16043
16959
  </dl>
16044
16960
  </details>
16045
16961
 
16046
- ## Shipping OrderSchedules
16047
-
16048
- <details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">listV1</a>({ ...params }) -> Chrt.OrderScheduleListRes</code></summary>
16962
+ <details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">unpauseV1</a>(orderScheduleId) -> boolean</code></summary>
16049
16963
  <dl>
16050
16964
  <dd>
16051
16965
 
@@ -16057,7 +16971,7 @@ await client.shipping.orderDrafts.validateV1("order_id");
16057
16971
  <dl>
16058
16972
  <dd>
16059
16973
 
16060
- Lists order schedules for the caller's organization with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (OrderScheduleListRes)
16974
+ Unpauses a paused order schedule. | authz: min_org_role=operator | () -> (bool)
16061
16975
 
16062
16976
  </dd>
16063
16977
  </dl>
@@ -16073,17 +16987,7 @@ Lists order schedules for the caller's organization with filtering, sorting, and
16073
16987
  <dd>
16074
16988
 
16075
16989
  ```typescript
16076
- await client.shipping.orderSchedules.listV1({
16077
- sort_by: "created_at_timestamp",
16078
- sort_order: "asc",
16079
- page: 1,
16080
- page_size: 1,
16081
- filter_owned_by_user_id: "filter_owned_by_user_id",
16082
- filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
16083
- filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
16084
- filter_last_edited_at_timestamp_gte: "2024-01-15T09:30:00Z",
16085
- filter_last_edited_at_timestamp_lte: "2024-01-15T09:30:00Z",
16086
- });
16990
+ await client.shipping.orderSchedules.unpauseV1("order_schedule_id");
16087
16991
  ```
16088
16992
 
16089
16993
  </dd>
@@ -16099,7 +17003,7 @@ await client.shipping.orderSchedules.listV1({
16099
17003
  <dl>
16100
17004
  <dd>
16101
17005
 
16102
- **request:** `Chrt.shipping.OrderSchedulesListV1Request`
17006
+ **orderScheduleId:** `string`
16103
17007
 
16104
17008
  </dd>
16105
17009
  </dl>
@@ -16118,7 +17022,7 @@ await client.shipping.orderSchedules.listV1({
16118
17022
  </dl>
16119
17023
  </details>
16120
17024
 
16121
- <details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">getByIdV1</a>(orderScheduleId) -> Chrt.OrderSchedule1</code></summary>
17025
+ <details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">pauseV1</a>(orderScheduleId) -> boolean</code></summary>
16122
17026
  <dl>
16123
17027
  <dd>
16124
17028
 
@@ -16130,7 +17034,7 @@ await client.shipping.orderSchedules.listV1({
16130
17034
  <dl>
16131
17035
  <dd>
16132
17036
 
16133
- Retrieves an order schedule by ID. | authz: min_org_role=operator | () -> (OrderSchedule1)
17037
+ Pauses an active order schedule. | authz: min_org_role=operator | () -> (bool)
16134
17038
 
16135
17039
  </dd>
16136
17040
  </dl>
@@ -16146,7 +17050,7 @@ Retrieves an order schedule by ID. | authz: min_org_role=operator | () -> (Order
16146
17050
  <dd>
16147
17051
 
16148
17052
  ```typescript
16149
- await client.shipping.orderSchedules.getByIdV1("order_schedule_id");
17053
+ await client.shipping.orderSchedules.pauseV1("order_schedule_id");
16150
17054
  ```
16151
17055
 
16152
17056
  </dd>
@@ -16181,7 +17085,7 @@ await client.shipping.orderSchedules.getByIdV1("order_schedule_id");
16181
17085
  </dl>
16182
17086
  </details>
16183
17087
 
16184
- <details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">aboutV1</a>(orderScheduleId) -> Chrt.OrderScheduleAboutRes</code></summary>
17088
+ <details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">archiveV1</a>(orderScheduleId) -> boolean</code></summary>
16185
17089
  <dl>
16186
17090
  <dd>
16187
17091
 
@@ -16193,7 +17097,7 @@ await client.shipping.orderSchedules.getByIdV1("order_schedule_id");
16193
17097
  <dl>
16194
17098
  <dd>
16195
17099
 
16196
- Retrieves schedule metadata, generated order count, and live orchestrator status. | authz: min_org_role=operator | () -> (OrderScheduleAboutRes)
17100
+ Archives an order schedule and prevents future runs. | authz: min_org_role=operator | () -> (bool)
16197
17101
 
16198
17102
  </dd>
16199
17103
  </dl>
@@ -16209,7 +17113,7 @@ Retrieves schedule metadata, generated order count, and live orchestrator status
16209
17113
  <dd>
16210
17114
 
16211
17115
  ```typescript
16212
- await client.shipping.orderSchedules.aboutV1("order_schedule_id");
17116
+ await client.shipping.orderSchedules.archiveV1("order_schedule_id");
16213
17117
  ```
16214
17118
 
16215
17119
  </dd>
@@ -16244,7 +17148,7 @@ await client.shipping.orderSchedules.aboutV1("order_schedule_id");
16244
17148
  </dl>
16245
17149
  </details>
16246
17150
 
16247
- <details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">newV1</a>({ ...params }) -> string</code></summary>
17151
+ <details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">triggerV1</a>(orderScheduleId) -> boolean</code></summary>
16248
17152
  <dl>
16249
17153
  <dd>
16250
17154
 
@@ -16256,7 +17160,7 @@ await client.shipping.orderSchedules.aboutV1("order_schedule_id");
16256
17160
  <dl>
16257
17161
  <dd>
16258
17162
 
16259
- Creates a new draft order schedule. | authz: min_org_role=operator | (OrderScheduleClientCreate1) -> (PydanticObjectId)
17163
+ Triggers an order schedule immediately. | authz: min_org_role=operator | () -> (bool)
16260
17164
 
16261
17165
  </dd>
16262
17166
  </dl>
@@ -16272,12 +17176,7 @@ Creates a new draft order schedule. | authz: min_org_role=operator | (OrderSched
16272
17176
  <dd>
16273
17177
 
16274
17178
  ```typescript
16275
- await client.shipping.orderSchedules.newV1({
16276
- schema_version: 1,
16277
- name: "name",
16278
- order_manifest: {},
16279
- schedule_spec: {},
16280
- });
17179
+ await client.shipping.orderSchedules.triggerV1("order_schedule_id");
16281
17180
  ```
16282
17181
 
16283
17182
  </dd>
@@ -16293,7 +17192,7 @@ await client.shipping.orderSchedules.newV1({
16293
17192
  <dl>
16294
17193
  <dd>
16295
17194
 
16296
- **request:** `Chrt.shipping.OrderScheduleClientCreate1`
17195
+ **orderScheduleId:** `string`
16297
17196
 
16298
17197
  </dd>
16299
17198
  </dl>
@@ -16312,7 +17211,9 @@ await client.shipping.orderSchedules.newV1({
16312
17211
  </dl>
16313
17212
  </details>
16314
17213
 
16315
- <details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">updateV1</a>(orderScheduleId, { ...params }) -> boolean</code></summary>
17214
+ ## Shipping TaskGroups
17215
+
17216
+ <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">startV1</a>(taskGroupId) -> boolean</code></summary>
16316
17217
  <dl>
16317
17218
  <dd>
16318
17219
 
@@ -16324,7 +17225,7 @@ await client.shipping.orderSchedules.newV1({
16324
17225
  <dl>
16325
17226
  <dd>
16326
17227
 
16327
- Updates an order schedule. | authz: min_org_role=operator | (OrderScheduleClientUpdate1) -> (bool)
17228
+ Starts a task group by transitioning it from STAGED to IN_PROGRESS and syncing related order state. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators] | () -> (bool)
16328
17229
 
16329
17230
  </dd>
16330
17231
  </dl>
@@ -16340,7 +17241,7 @@ Updates an order schedule. | authz: min_org_role=operator | (OrderScheduleClient
16340
17241
  <dd>
16341
17242
 
16342
17243
  ```typescript
16343
- await client.shipping.orderSchedules.updateV1("order_schedule_id");
17244
+ await client.shipping.taskGroups.startV1("task_group_id");
16344
17245
  ```
16345
17246
 
16346
17247
  </dd>
@@ -16356,15 +17257,7 @@ await client.shipping.orderSchedules.updateV1("order_schedule_id");
16356
17257
  <dl>
16357
17258
  <dd>
16358
17259
 
16359
- **orderScheduleId:** `string`
16360
-
16361
- </dd>
16362
- </dl>
16363
-
16364
- <dl>
16365
- <dd>
16366
-
16367
- **request:** `Chrt.shipping.OrderScheduleClientUpdate1`
17260
+ **taskGroupId:** `string`
16368
17261
 
16369
17262
  </dd>
16370
17263
  </dl>
@@ -16372,7 +17265,7 @@ await client.shipping.orderSchedules.updateV1("order_schedule_id");
16372
17265
  <dl>
16373
17266
  <dd>
16374
17267
 
16375
- **requestOptions:** `OrderSchedules.RequestOptions`
17268
+ **requestOptions:** `TaskGroups.RequestOptions`
16376
17269
 
16377
17270
  </dd>
16378
17271
  </dl>
@@ -16383,7 +17276,7 @@ await client.shipping.orderSchedules.updateV1("order_schedule_id");
16383
17276
  </dl>
16384
17277
  </details>
16385
17278
 
16386
- <details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">takeOwnershipV1</a>(orderScheduleId) -> boolean</code></summary>
17279
+ <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">setTaskOrderingV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
16387
17280
  <dl>
16388
17281
  <dd>
16389
17282
 
@@ -16395,7 +17288,7 @@ await client.shipping.orderSchedules.updateV1("order_schedule_id");
16395
17288
  <dl>
16396
17289
  <dd>
16397
17290
 
16398
- Transfers order schedule workflow ownership to the caller. | authz: min_org_role=operator | () -> (bool)
17291
+ Sets the ordering of tasks within a task group. Requires complete list of task IDs in desired order. Completed tasks must be before staged tasks. | authz_personas=[lig_owner_operators] | (SetTaskOrderingReq) -> (bool)
16399
17292
 
16400
17293
  </dd>
16401
17294
  </dl>
@@ -16411,7 +17304,9 @@ Transfers order schedule workflow ownership to the caller. | authz: min_org_role
16411
17304
  <dd>
16412
17305
 
16413
17306
  ```typescript
16414
- await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id");
17307
+ await client.shipping.taskGroups.setTaskOrderingV1("task_group_id", {
17308
+ task_ids: ["task_ids"],
17309
+ });
16415
17310
  ```
16416
17311
 
16417
17312
  </dd>
@@ -16427,7 +17322,7 @@ await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id");
16427
17322
  <dl>
16428
17323
  <dd>
16429
17324
 
16430
- **orderScheduleId:** `string`
17325
+ **taskGroupId:** `string`
16431
17326
 
16432
17327
  </dd>
16433
17328
  </dl>
@@ -16435,7 +17330,15 @@ await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id");
16435
17330
  <dl>
16436
17331
  <dd>
16437
17332
 
16438
- **requestOptions:** `OrderSchedules.RequestOptions`
17333
+ **request:** `Chrt.shipping.SetTaskOrderingReq`
17334
+
17335
+ </dd>
17336
+ </dl>
17337
+
17338
+ <dl>
17339
+ <dd>
17340
+
17341
+ **requestOptions:** `TaskGroups.RequestOptions`
16439
17342
 
16440
17343
  </dd>
16441
17344
  </dl>
@@ -16446,7 +17349,7 @@ await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id");
16446
17349
  </dl>
16447
17350
  </details>
16448
17351
 
16449
- <details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">activateV1</a>(orderScheduleId) -> boolean</code></summary>
17352
+ <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">updateDriverV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
16450
17353
  <dl>
16451
17354
  <dd>
16452
17355
 
@@ -16458,7 +17361,7 @@ await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id");
16458
17361
  <dl>
16459
17362
  <dd>
16460
17363
 
16461
- Validates a draft order schedule, creates its Temporal orchestrator schedule, and activates it. | authz: min_org_role=operator | () -> (bool)
17364
+ Assigns or swaps the driver on a task group. Driver must belong to the task group's executor organization. | authz_personas=[executor_org_operators] | (UpdateDriverReq) -> (bool)
16462
17365
 
16463
17366
  </dd>
16464
17367
  </dl>
@@ -16474,7 +17377,9 @@ Validates a draft order schedule, creates its Temporal orchestrator schedule, an
16474
17377
  <dd>
16475
17378
 
16476
17379
  ```typescript
16477
- await client.shipping.orderSchedules.activateV1("order_schedule_id");
17380
+ await client.shipping.taskGroups.updateDriverV1("task_group_id", {
17381
+ driver_id: "driver_id",
17382
+ });
16478
17383
  ```
16479
17384
 
16480
17385
  </dd>
@@ -16490,7 +17395,7 @@ await client.shipping.orderSchedules.activateV1("order_schedule_id");
16490
17395
  <dl>
16491
17396
  <dd>
16492
17397
 
16493
- **orderScheduleId:** `string`
17398
+ **taskGroupId:** `string`
16494
17399
 
16495
17400
  </dd>
16496
17401
  </dl>
@@ -16498,7 +17403,15 @@ await client.shipping.orderSchedules.activateV1("order_schedule_id");
16498
17403
  <dl>
16499
17404
  <dd>
16500
17405
 
16501
- **requestOptions:** `OrderSchedules.RequestOptions`
17406
+ **request:** `Chrt.shipping.UpdateDriverReq`
17407
+
17408
+ </dd>
17409
+ </dl>
17410
+
17411
+ <dl>
17412
+ <dd>
17413
+
17414
+ **requestOptions:** `TaskGroups.RequestOptions`
16502
17415
 
16503
17416
  </dd>
16504
17417
  </dl>
@@ -16509,7 +17422,7 @@ await client.shipping.orderSchedules.activateV1("order_schedule_id");
16509
17422
  </dl>
16510
17423
  </details>
16511
17424
 
16512
- <details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">unpauseV1</a>(orderScheduleId) -> boolean</code></summary>
17425
+ <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">removeDriverV1</a>(taskGroupId) -> boolean</code></summary>
16513
17426
  <dl>
16514
17427
  <dd>
16515
17428
 
@@ -16521,7 +17434,7 @@ await client.shipping.orderSchedules.activateV1("order_schedule_id");
16521
17434
  <dl>
16522
17435
  <dd>
16523
17436
 
16524
- Unpauses a paused order schedule. | authz: min_org_role=operator | () -> (bool)
17437
+ Removes the driver from a task group (sets driver_id to null). Allowed when STAGED or IN_PROGRESS (if no tasks have reached a terminal status). | authz_personas=[executor_org_operators, driver_for_executor] | () -> (bool)
16525
17438
 
16526
17439
  </dd>
16527
17440
  </dl>
@@ -16537,7 +17450,7 @@ Unpauses a paused order schedule. | authz: min_org_role=operator | () -> (bool)
16537
17450
  <dd>
16538
17451
 
16539
17452
  ```typescript
16540
- await client.shipping.orderSchedules.unpauseV1("order_schedule_id");
17453
+ await client.shipping.taskGroups.removeDriverV1("task_group_id");
16541
17454
  ```
16542
17455
 
16543
17456
  </dd>
@@ -16553,7 +17466,7 @@ await client.shipping.orderSchedules.unpauseV1("order_schedule_id");
16553
17466
  <dl>
16554
17467
  <dd>
16555
17468
 
16556
- **orderScheduleId:** `string`
17469
+ **taskGroupId:** `string`
16557
17470
 
16558
17471
  </dd>
16559
17472
  </dl>
@@ -16561,7 +17474,7 @@ await client.shipping.orderSchedules.unpauseV1("order_schedule_id");
16561
17474
  <dl>
16562
17475
  <dd>
16563
17476
 
16564
- **requestOptions:** `OrderSchedules.RequestOptions`
17477
+ **requestOptions:** `TaskGroups.RequestOptions`
16565
17478
 
16566
17479
  </dd>
16567
17480
  </dl>
@@ -16572,7 +17485,7 @@ await client.shipping.orderSchedules.unpauseV1("order_schedule_id");
16572
17485
  </dl>
16573
17486
  </details>
16574
17487
 
16575
- <details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">pauseV1</a>(orderScheduleId) -> boolean</code></summary>
17488
+ <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">addExecutorV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
16576
17489
  <dl>
16577
17490
  <dd>
16578
17491
 
@@ -16584,7 +17497,7 @@ await client.shipping.orderSchedules.unpauseV1("order_schedule_id");
16584
17497
  <dl>
16585
17498
  <dd>
16586
17499
 
16587
- Pauses an active order schedule. | authz: min_org_role=operator | () -> (bool)
17500
+ Assigns an executor organization (on-chrt or off-chrt) to a task group. Coordinator-only. Requires both executor_org_id and off_chrt_executor_org_id to be None (use remove_executor/v1 first to swap). | authz_personas=[coordinator_org_operators] | (AddExecutorReq) -> (bool)
16588
17501
 
16589
17502
  </dd>
16590
17503
  </dl>
@@ -16600,7 +17513,7 @@ Pauses an active order schedule. | authz: min_org_role=operator | () -> (bool)
16600
17513
  <dd>
16601
17514
 
16602
17515
  ```typescript
16603
- await client.shipping.orderSchedules.pauseV1("order_schedule_id");
17516
+ await client.shipping.taskGroups.addExecutorV1("task_group_id");
16604
17517
  ```
16605
17518
 
16606
17519
  </dd>
@@ -16616,7 +17529,7 @@ await client.shipping.orderSchedules.pauseV1("order_schedule_id");
16616
17529
  <dl>
16617
17530
  <dd>
16618
17531
 
16619
- **orderScheduleId:** `string`
17532
+ **taskGroupId:** `string`
16620
17533
 
16621
17534
  </dd>
16622
17535
  </dl>
@@ -16624,7 +17537,15 @@ await client.shipping.orderSchedules.pauseV1("order_schedule_id");
16624
17537
  <dl>
16625
17538
  <dd>
16626
17539
 
16627
- **requestOptions:** `OrderSchedules.RequestOptions`
17540
+ **request:** `Chrt.shipping.AddExecutorReq`
17541
+
17542
+ </dd>
17543
+ </dl>
17544
+
17545
+ <dl>
17546
+ <dd>
17547
+
17548
+ **requestOptions:** `TaskGroups.RequestOptions`
16628
17549
 
16629
17550
  </dd>
16630
17551
  </dl>
@@ -16635,7 +17556,7 @@ await client.shipping.orderSchedules.pauseV1("order_schedule_id");
16635
17556
  </dl>
16636
17557
  </details>
16637
17558
 
16638
- <details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">archiveV1</a>(orderScheduleId) -> boolean</code></summary>
17559
+ <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">removeExecutorV1</a>(taskGroupId) -> boolean</code></summary>
16639
17560
  <dl>
16640
17561
  <dd>
16641
17562
 
@@ -16647,7 +17568,7 @@ await client.shipping.orderSchedules.pauseV1("order_schedule_id");
16647
17568
  <dl>
16648
17569
  <dd>
16649
17570
 
16650
- Archives an order schedule and prevents future runs. | authz: min_org_role=operator | () -> (bool)
17571
+ Clears the executor on a task group along with the assigned driver and all PPP/PPD billing attachments, returning the TG to executor-less state. Coordinator-only. PPP/PPD LineItemGroup1 and BillingLedgerPeriod1 documents stay alive (orphaned-but-alive); the (ex-)executor disposes of them via their own routes. SPP is unaffected. | authz_personas=[coordinator_org_operators] | () -> (bool)
16651
17572
 
16652
17573
  </dd>
16653
17574
  </dl>
@@ -16663,7 +17584,7 @@ Archives an order schedule and prevents future runs. | authz: min_org_role=opera
16663
17584
  <dd>
16664
17585
 
16665
17586
  ```typescript
16666
- await client.shipping.orderSchedules.archiveV1("order_schedule_id");
17587
+ await client.shipping.taskGroups.removeExecutorV1("task_group_id");
16667
17588
  ```
16668
17589
 
16669
17590
  </dd>
@@ -16679,7 +17600,7 @@ await client.shipping.orderSchedules.archiveV1("order_schedule_id");
16679
17600
  <dl>
16680
17601
  <dd>
16681
17602
 
16682
- **orderScheduleId:** `string`
17603
+ **taskGroupId:** `string`
16683
17604
 
16684
17605
  </dd>
16685
17606
  </dl>
@@ -16687,7 +17608,7 @@ await client.shipping.orderSchedules.archiveV1("order_schedule_id");
16687
17608
  <dl>
16688
17609
  <dd>
16689
17610
 
16690
- **requestOptions:** `OrderSchedules.RequestOptions`
17611
+ **requestOptions:** `TaskGroups.RequestOptions`
16691
17612
 
16692
17613
  </dd>
16693
17614
  </dl>
@@ -16698,7 +17619,7 @@ await client.shipping.orderSchedules.archiveV1("order_schedule_id");
16698
17619
  </dl>
16699
17620
  </details>
16700
17621
 
16701
- <details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">triggerV1</a>(orderScheduleId) -> boolean</code></summary>
17622
+ <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">setFlightInfoV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
16702
17623
  <dl>
16703
17624
  <dd>
16704
17625
 
@@ -16710,7 +17631,7 @@ await client.shipping.orderSchedules.archiveV1("order_schedule_id");
16710
17631
  <dl>
16711
17632
  <dd>
16712
17633
 
16713
- Triggers an order schedule immediately. | authz: min_org_role=operator | () -> (bool)
17634
+ Sets the flight number and/or fa_flight_ids on a task group. | authz_personas=[lig_owner_operators] | (SetFlightInfoReq) -> (bool)
16714
17635
 
16715
17636
  </dd>
16716
17637
  </dl>
@@ -16726,7 +17647,7 @@ Triggers an order schedule immediately. | authz: min_org_role=operator | () -> (
16726
17647
  <dd>
16727
17648
 
16728
17649
  ```typescript
16729
- await client.shipping.orderSchedules.triggerV1("order_schedule_id");
17650
+ await client.shipping.taskGroups.setFlightInfoV1("task_group_id", {});
16730
17651
  ```
16731
17652
 
16732
17653
  </dd>
@@ -16742,7 +17663,7 @@ await client.shipping.orderSchedules.triggerV1("order_schedule_id");
16742
17663
  <dl>
16743
17664
  <dd>
16744
17665
 
16745
- **orderScheduleId:** `string`
17666
+ **taskGroupId:** `string`
16746
17667
 
16747
17668
  </dd>
16748
17669
  </dl>
@@ -16750,7 +17671,15 @@ await client.shipping.orderSchedules.triggerV1("order_schedule_id");
16750
17671
  <dl>
16751
17672
  <dd>
16752
17673
 
16753
- **requestOptions:** `OrderSchedules.RequestOptions`
17674
+ **request:** `Chrt.SetFlightInfoReq`
17675
+
17676
+ </dd>
17677
+ </dl>
17678
+
17679
+ <dl>
17680
+ <dd>
17681
+
17682
+ **requestOptions:** `TaskGroups.RequestOptions`
16754
17683
 
16755
17684
  </dd>
16756
17685
  </dl>
@@ -16761,9 +17690,7 @@ await client.shipping.orderSchedules.triggerV1("order_schedule_id");
16761
17690
  </dl>
16762
17691
  </details>
16763
17692
 
16764
- ## Shipping TaskGroups
16765
-
16766
- <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">startV1</a>(taskGroupId) -> boolean</code></summary>
17693
+ <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">addMessageV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
16767
17694
  <dl>
16768
17695
  <dd>
16769
17696
 
@@ -16775,7 +17702,7 @@ await client.shipping.orderSchedules.triggerV1("order_schedule_id");
16775
17702
  <dl>
16776
17703
  <dd>
16777
17704
 
16778
- Starts a task group by transitioning it from STAGED to IN_PROGRESS and syncing related order state. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators] | () -> (bool)
17705
+ Adds a message to a task group's message log. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators, shipper_org_operators] | (AddMessageReq) -> (bool)
16779
17706
 
16780
17707
  </dd>
16781
17708
  </dl>
@@ -16791,7 +17718,9 @@ Starts a task group by transitioning it from STAGED to IN_PROGRESS and syncing r
16791
17718
  <dd>
16792
17719
 
16793
17720
  ```typescript
16794
- await client.shipping.taskGroups.startV1("task_group_id");
17721
+ await client.shipping.taskGroups.addMessageV1("task_group_id", {
17722
+ message: "message",
17723
+ });
16795
17724
  ```
16796
17725
 
16797
17726
  </dd>
@@ -16815,6 +17744,14 @@ await client.shipping.taskGroups.startV1("task_group_id");
16815
17744
  <dl>
16816
17745
  <dd>
16817
17746
 
17747
+ **request:** `Chrt.shipping.AddMessageReq`
17748
+
17749
+ </dd>
17750
+ </dl>
17751
+
17752
+ <dl>
17753
+ <dd>
17754
+
16818
17755
  **requestOptions:** `TaskGroups.RequestOptions`
16819
17756
 
16820
17757
  </dd>
@@ -16826,7 +17763,7 @@ await client.shipping.taskGroups.startV1("task_group_id");
16826
17763
  </dl>
16827
17764
  </details>
16828
17765
 
16829
- <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">setTaskOrderingV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
17766
+ <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">attachBillingLedgerPeriodToShipperPayProviderV1</a>(taskGroupId, { ...params }) -> Chrt.BillingLedgerPeriod1</code></summary>
16830
17767
  <dl>
16831
17768
  <dd>
16832
17769
 
@@ -16838,7 +17775,7 @@ await client.shipping.taskGroups.startV1("task_group_id");
16838
17775
  <dl>
16839
17776
  <dd>
16840
17777
 
16841
- Sets the ordering of tasks within a task group. Requires complete list of task IDs in desired order. Completed tasks must be before staged tasks. | authz_personas=[lig_owner_operators] | (SetTaskOrderingReq) -> (bool)
17778
+ Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's SPP vector. Period parties must match the TG's SPP parties. The SPP vector must have no ledger attached and no rate sheet (rate-sheet/ledger exclusivity). Ad-hoc LIGs without a rate sheet may coexist. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (AttachBillingLedgerPeriodReq) -> (BillingLedgerPeriod1)
16842
17779
 
16843
17780
  </dd>
16844
17781
  </dl>
@@ -16854,8 +17791,8 @@ Sets the ordering of tasks within a task group. Requires complete list of task I
16854
17791
  <dd>
16855
17792
 
16856
17793
  ```typescript
16857
- await client.shipping.taskGroups.setTaskOrderingV1("task_group_id", {
16858
- task_ids: ["task_ids"],
17794
+ await client.shipping.taskGroups.attachBillingLedgerPeriodToShipperPayProviderV1("task_group_id", {
17795
+ billing_ledger_period_id: "billing_ledger_period_id",
16859
17796
  });
16860
17797
  ```
16861
17798
 
@@ -16880,7 +17817,7 @@ await client.shipping.taskGroups.setTaskOrderingV1("task_group_id", {
16880
17817
  <dl>
16881
17818
  <dd>
16882
17819
 
16883
- **request:** `Chrt.shipping.SetTaskOrderingReq`
17820
+ **request:** `Chrt.AttachBillingLedgerPeriodReq`
16884
17821
 
16885
17822
  </dd>
16886
17823
  </dl>
@@ -16899,7 +17836,7 @@ await client.shipping.taskGroups.setTaskOrderingV1("task_group_id", {
16899
17836
  </dl>
16900
17837
  </details>
16901
17838
 
16902
- <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">updateDriverV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
17839
+ <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">attachBillingLedgerPeriodToProviderPayProviderV1</a>(taskGroupId, { ...params }) -> Chrt.BillingLedgerPeriod1</code></summary>
16903
17840
  <dl>
16904
17841
  <dd>
16905
17842
 
@@ -16911,7 +17848,7 @@ await client.shipping.taskGroups.setTaskOrderingV1("task_group_id", {
16911
17848
  <dl>
16912
17849
  <dd>
16913
17850
 
16914
- Assigns or swaps the driver on a task group. Driver must belong to the task group's executor organization. | authz_personas=[executor_org_operators] | (UpdateDriverReq) -> (bool)
17851
+ Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's PPP vector. Period parties must match the TG's PPP parties. The PPP vector must have no ledger attached and no rate sheet (rate-sheet/ledger exclusivity). Ad-hoc LIGs without a rate sheet may coexist. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (AttachBillingLedgerPeriodReq) -> (BillingLedgerPeriod1)
16915
17852
 
16916
17853
  </dd>
16917
17854
  </dl>
@@ -16927,8 +17864,8 @@ Assigns or swaps the driver on a task group. Driver must belong to the task grou
16927
17864
  <dd>
16928
17865
 
16929
17866
  ```typescript
16930
- await client.shipping.taskGroups.updateDriverV1("task_group_id", {
16931
- driver_id: "driver_id",
17867
+ await client.shipping.taskGroups.attachBillingLedgerPeriodToProviderPayProviderV1("task_group_id", {
17868
+ billing_ledger_period_id: "billing_ledger_period_id",
16932
17869
  });
16933
17870
  ```
16934
17871
 
@@ -16953,7 +17890,7 @@ await client.shipping.taskGroups.updateDriverV1("task_group_id", {
16953
17890
  <dl>
16954
17891
  <dd>
16955
17892
 
16956
- **request:** `Chrt.shipping.UpdateDriverReq`
17893
+ **request:** `Chrt.AttachBillingLedgerPeriodReq`
16957
17894
 
16958
17895
  </dd>
16959
17896
  </dl>
@@ -16972,7 +17909,7 @@ await client.shipping.taskGroups.updateDriverV1("task_group_id", {
16972
17909
  </dl>
16973
17910
  </details>
16974
17911
 
16975
- <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">removeDriverV1</a>(taskGroupId) -> boolean</code></summary>
17912
+ <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">attachBillingLedgerPeriodToProviderPayDriverV1</a>(taskGroupId, { ...params }) -> Chrt.BillingLedgerPeriod1</code></summary>
16976
17913
  <dl>
16977
17914
  <dd>
16978
17915
 
@@ -16984,7 +17921,7 @@ await client.shipping.taskGroups.updateDriverV1("task_group_id", {
16984
17921
  <dl>
16985
17922
  <dd>
16986
17923
 
16987
- Removes the driver from a task group (sets driver_id to null). Allowed when STAGED or IN_PROGRESS (if no tasks have reached a terminal status). | authz_personas=[executor_org_operators, driver_for_executor] | () -> (bool)
17924
+ Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's PPD vector. Period parties must match the TG's PPD parties. The PPD vector must have no ledger attached and no rate sheet (rate-sheet/ledger exclusivity). Ad-hoc LIGs without a rate sheet may coexist. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | (AttachBillingLedgerPeriodReq) -> (BillingLedgerPeriod1)
16988
17925
 
16989
17926
  </dd>
16990
17927
  </dl>
@@ -17000,7 +17937,9 @@ Removes the driver from a task group (sets driver_id to null). Allowed when STAG
17000
17937
  <dd>
17001
17938
 
17002
17939
  ```typescript
17003
- await client.shipping.taskGroups.removeDriverV1("task_group_id");
17940
+ await client.shipping.taskGroups.attachBillingLedgerPeriodToProviderPayDriverV1("task_group_id", {
17941
+ billing_ledger_period_id: "billing_ledger_period_id",
17942
+ });
17004
17943
  ```
17005
17944
 
17006
17945
  </dd>
@@ -17024,6 +17963,14 @@ await client.shipping.taskGroups.removeDriverV1("task_group_id");
17024
17963
  <dl>
17025
17964
  <dd>
17026
17965
 
17966
+ **request:** `Chrt.AttachBillingLedgerPeriodReq`
17967
+
17968
+ </dd>
17969
+ </dl>
17970
+
17971
+ <dl>
17972
+ <dd>
17973
+
17027
17974
  **requestOptions:** `TaskGroups.RequestOptions`
17028
17975
 
17029
17976
  </dd>
@@ -17035,7 +17982,7 @@ await client.shipping.taskGroups.removeDriverV1("task_group_id");
17035
17982
  </dl>
17036
17983
  </details>
17037
17984
 
17038
- <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">addExecutorV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
17985
+ <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">detachBillingLedgerPeriodFromShipperPayProviderV1</a>(taskGroupId) -> boolean</code></summary>
17039
17986
  <dl>
17040
17987
  <dd>
17041
17988
 
@@ -17047,7 +17994,7 @@ await client.shipping.taskGroups.removeDriverV1("task_group_id");
17047
17994
  <dl>
17048
17995
  <dd>
17049
17996
 
17050
- Assigns an executor organization (on-chrt or off-chrt) to a task group. Coordinator-only. Requires both executor_org_id and off_chrt_executor_org_id to be None (use remove_executor/v1 first to swap). | authz_personas=[coordinator_org_operators] | (AddExecutorReq) -> (bool)
17997
+ Detaches the SPP billing ledger period from this TaskGroup. Reverses attach_billing_ledger_period_to_shipper_pay_provider/v1. Linked period must be OPEN. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | () -> (bool)
17051
17998
 
17052
17999
  </dd>
17053
18000
  </dl>
@@ -17063,7 +18010,7 @@ Assigns an executor organization (on-chrt or off-chrt) to a task group. Coordina
17063
18010
  <dd>
17064
18011
 
17065
18012
  ```typescript
17066
- await client.shipping.taskGroups.addExecutorV1("task_group_id");
18013
+ await client.shipping.taskGroups.detachBillingLedgerPeriodFromShipperPayProviderV1("task_group_id");
17067
18014
  ```
17068
18015
 
17069
18016
  </dd>
@@ -17087,14 +18034,6 @@ await client.shipping.taskGroups.addExecutorV1("task_group_id");
17087
18034
  <dl>
17088
18035
  <dd>
17089
18036
 
17090
- **request:** `Chrt.shipping.AddExecutorReq`
17091
-
17092
- </dd>
17093
- </dl>
17094
-
17095
- <dl>
17096
- <dd>
17097
-
17098
18037
  **requestOptions:** `TaskGroups.RequestOptions`
17099
18038
 
17100
18039
  </dd>
@@ -17106,7 +18045,7 @@ await client.shipping.taskGroups.addExecutorV1("task_group_id");
17106
18045
  </dl>
17107
18046
  </details>
17108
18047
 
17109
- <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">removeExecutorV1</a>(taskGroupId) -> boolean</code></summary>
18048
+ <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">detachBillingLedgerPeriodFromProviderPayProviderV1</a>(taskGroupId) -> boolean</code></summary>
17110
18049
  <dl>
17111
18050
  <dd>
17112
18051
 
@@ -17118,7 +18057,7 @@ await client.shipping.taskGroups.addExecutorV1("task_group_id");
17118
18057
  <dl>
17119
18058
  <dd>
17120
18059
 
17121
- Clears the executor on a task group along with the assigned driver and all PPP/PPD billing attachments, returning the TG to executor-less state. Coordinator-only. PPP/PPD LineItemGroup1 and BillingLedgerPeriod1 documents stay alive (orphaned-but-alive); the (ex-)executor disposes of them via their own routes. SPP is unaffected. | authz_personas=[coordinator_org_operators] | () -> (bool)
18060
+ Detaches the PPP billing ledger period from this TaskGroup. Reverses attach_billing_ledger_period_to_provider_pay_provider/v1. Linked period must be OPEN. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | () -> (bool)
17122
18061
 
17123
18062
  </dd>
17124
18063
  </dl>
@@ -17134,7 +18073,7 @@ Clears the executor on a task group along with the assigned driver and all PPP/P
17134
18073
  <dd>
17135
18074
 
17136
18075
  ```typescript
17137
- await client.shipping.taskGroups.removeExecutorV1("task_group_id");
18076
+ await client.shipping.taskGroups.detachBillingLedgerPeriodFromProviderPayProviderV1("task_group_id");
17138
18077
  ```
17139
18078
 
17140
18079
  </dd>
@@ -17169,7 +18108,7 @@ await client.shipping.taskGroups.removeExecutorV1("task_group_id");
17169
18108
  </dl>
17170
18109
  </details>
17171
18110
 
17172
- <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">setFlightInfoV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
18111
+ <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">detachBillingLedgerPeriodFromProviderPayDriverV1</a>(taskGroupId) -> boolean</code></summary>
17173
18112
  <dl>
17174
18113
  <dd>
17175
18114
 
@@ -17181,7 +18120,7 @@ await client.shipping.taskGroups.removeExecutorV1("task_group_id");
17181
18120
  <dl>
17182
18121
  <dd>
17183
18122
 
17184
- Sets the flight number and/or fa_flight_ids on a task group. | authz_personas=[lig_owner_operators] | (SetFlightInfoReq) -> (bool)
18123
+ Detaches the PPD billing ledger period from this TaskGroup. Reverses attach_billing_ledger_period_to_provider_pay_driver/v1. Linked period must be OPEN. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | () -> (bool)
17185
18124
 
17186
18125
  </dd>
17187
18126
  </dl>
@@ -17197,7 +18136,7 @@ Sets the flight number and/or fa_flight_ids on a task group. | authz_personas=[l
17197
18136
  <dd>
17198
18137
 
17199
18138
  ```typescript
17200
- await client.shipping.taskGroups.setFlightInfoV1("task_group_id", {});
18139
+ await client.shipping.taskGroups.detachBillingLedgerPeriodFromProviderPayDriverV1("task_group_id");
17201
18140
  ```
17202
18141
 
17203
18142
  </dd>
@@ -17221,14 +18160,6 @@ await client.shipping.taskGroups.setFlightInfoV1("task_group_id", {});
17221
18160
  <dl>
17222
18161
  <dd>
17223
18162
 
17224
- **request:** `Chrt.SetFlightInfoReq`
17225
-
17226
- </dd>
17227
- </dl>
17228
-
17229
- <dl>
17230
- <dd>
17231
-
17232
18163
  **requestOptions:** `TaskGroups.RequestOptions`
17233
18164
 
17234
18165
  </dd>
@@ -17240,7 +18171,7 @@ await client.shipping.taskGroups.setFlightInfoV1("task_group_id", {});
17240
18171
  </dl>
17241
18172
  </details>
17242
18173
 
17243
- <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">addMessageV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
18174
+ <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">attachLigToShipperPayProviderV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
17244
18175
  <dl>
17245
18176
  <dd>
17246
18177
 
@@ -17252,7 +18183,7 @@ await client.shipping.taskGroups.setFlightInfoV1("task_group_id", {});
17252
18183
  <dl>
17253
18184
  <dd>
17254
18185
 
17255
- Adds a message to a task group's message log. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators, shipper_org_operators] | (AddMessageReq) -> (bool)
18186
+ Attaches a STAGED, detached LineItemGroup to the SPP vector AND sets `LineItemGroup1.task_group_id` (one txn). The LIG must have `task_group_id is None`, be owned by the coordinator, and be party-matched to SPP. The SPP vector must have no LIG attached; if the LIG carries `rate_sheet_id`, no billing ledger period may be attached either (rate-sheet/ledger exclusivity). The LIG's `rate_sheet_id` is stamped onto `shipper_pay_provider_rate_sheet_id` as a breadcrumb. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (AttachLigToVectorClientReq) -> (bool)
17256
18187
 
17257
18188
  </dd>
17258
18189
  </dl>
@@ -17268,8 +18199,8 @@ Adds a message to a task group's message log. | authz_personas=[driver_for_execu
17268
18199
  <dd>
17269
18200
 
17270
18201
  ```typescript
17271
- await client.shipping.taskGroups.addMessageV1("task_group_id", {
17272
- message: "message",
18202
+ await client.shipping.taskGroups.attachLigToShipperPayProviderV1("task_group_id", {
18203
+ line_item_group_id: "line_item_group_id",
17273
18204
  });
17274
18205
  ```
17275
18206
 
@@ -17294,7 +18225,7 @@ await client.shipping.taskGroups.addMessageV1("task_group_id", {
17294
18225
  <dl>
17295
18226
  <dd>
17296
18227
 
17297
- **request:** `Chrt.shipping.AddMessageReq`
18228
+ **request:** `Chrt.AttachLigToVectorClientReq`
17298
18229
 
17299
18230
  </dd>
17300
18231
  </dl>
@@ -17313,7 +18244,7 @@ await client.shipping.taskGroups.addMessageV1("task_group_id", {
17313
18244
  </dl>
17314
18245
  </details>
17315
18246
 
17316
- <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">attachBillingLedgerPeriodToShipperPayProviderV1</a>(taskGroupId, { ...params }) -> Chrt.BillingLedgerPeriod1</code></summary>
18247
+ <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">attachLigToProviderPayProviderV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
17317
18248
  <dl>
17318
18249
  <dd>
17319
18250
 
@@ -17325,7 +18256,7 @@ await client.shipping.taskGroups.addMessageV1("task_group_id", {
17325
18256
  <dl>
17326
18257
  <dd>
17327
18258
 
17328
- Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's SPP vector. Period parties must match the TG's SPP parties. The SPP vector must have no ledger attached and no rate sheet (rate-sheet/ledger exclusivity). Ad-hoc LIGs without a rate sheet may coexist. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (AttachBillingLedgerPeriodReq) -> (BillingLedgerPeriod1)
18259
+ Attaches a STAGED, detached LineItemGroup to the PPP vector AND sets `LineItemGroup1.task_group_id` (one txn). The LIG must have `task_group_id is None`, be owned by the coordinator, and be party-matched to PPP. The PPP vector must have no LIG attached; if the LIG carries `rate_sheet_id`, no billing ledger period may be attached either (rate-sheet/ledger exclusivity). The LIG's `rate_sheet_id` is stamped onto `provider_pay_provider_rate_sheet_id` as a breadcrumb. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (AttachLigToVectorClientReq) -> (bool)
17329
18260
 
17330
18261
  </dd>
17331
18262
  </dl>
@@ -17341,8 +18272,8 @@ Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's SPP vec
17341
18272
  <dd>
17342
18273
 
17343
18274
  ```typescript
17344
- await client.shipping.taskGroups.attachBillingLedgerPeriodToShipperPayProviderV1("task_group_id", {
17345
- billing_ledger_period_id: "billing_ledger_period_id",
18275
+ await client.shipping.taskGroups.attachLigToProviderPayProviderV1("task_group_id", {
18276
+ line_item_group_id: "line_item_group_id",
17346
18277
  });
17347
18278
  ```
17348
18279
 
@@ -17367,7 +18298,7 @@ await client.shipping.taskGroups.attachBillingLedgerPeriodToShipperPayProviderV1
17367
18298
  <dl>
17368
18299
  <dd>
17369
18300
 
17370
- **request:** `Chrt.AttachBillingLedgerPeriodReq`
18301
+ **request:** `Chrt.AttachLigToVectorClientReq`
17371
18302
 
17372
18303
  </dd>
17373
18304
  </dl>
@@ -17386,7 +18317,7 @@ await client.shipping.taskGroups.attachBillingLedgerPeriodToShipperPayProviderV1
17386
18317
  </dl>
17387
18318
  </details>
17388
18319
 
17389
- <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">attachBillingLedgerPeriodToProviderPayProviderV1</a>(taskGroupId, { ...params }) -> Chrt.BillingLedgerPeriod1</code></summary>
18320
+ <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">attachLigToProviderPayDriverV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
17390
18321
  <dl>
17391
18322
  <dd>
17392
18323
 
@@ -17398,7 +18329,7 @@ await client.shipping.taskGroups.attachBillingLedgerPeriodToShipperPayProviderV1
17398
18329
  <dl>
17399
18330
  <dd>
17400
18331
 
17401
- Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's PPP vector. Period parties must match the TG's PPP parties. The PPP vector must have no ledger attached and no rate sheet (rate-sheet/ledger exclusivity). Ad-hoc LIGs without a rate sheet may coexist. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (AttachBillingLedgerPeriodReq) -> (BillingLedgerPeriod1)
18332
+ Attaches a STAGED, detached LineItemGroup to the PPD vector AND sets `LineItemGroup1.task_group_id` (one txn). The LIG must have `task_group_id is None`, be owned by the executor, and be party-matched to PPD. The PPD vector must have no LIG attached; if the LIG carries `rate_sheet_id`, no billing ledger period may be attached either (rate-sheet/ledger exclusivity). The LIG's `rate_sheet_id` is stamped onto `provider_pay_driver_rate_sheet_id` as a breadcrumb. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | (AttachLigToVectorClientReq) -> (bool)
17402
18333
 
17403
18334
  </dd>
17404
18335
  </dl>
@@ -17414,8 +18345,8 @@ Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's PPP vec
17414
18345
  <dd>
17415
18346
 
17416
18347
  ```typescript
17417
- await client.shipping.taskGroups.attachBillingLedgerPeriodToProviderPayProviderV1("task_group_id", {
17418
- billing_ledger_period_id: "billing_ledger_period_id",
18348
+ await client.shipping.taskGroups.attachLigToProviderPayDriverV1("task_group_id", {
18349
+ line_item_group_id: "line_item_group_id",
17419
18350
  });
17420
18351
  ```
17421
18352
 
@@ -17440,7 +18371,7 @@ await client.shipping.taskGroups.attachBillingLedgerPeriodToProviderPayProviderV
17440
18371
  <dl>
17441
18372
  <dd>
17442
18373
 
17443
- **request:** `Chrt.AttachBillingLedgerPeriodReq`
18374
+ **request:** `Chrt.AttachLigToVectorClientReq`
17444
18375
 
17445
18376
  </dd>
17446
18377
  </dl>
@@ -17459,7 +18390,7 @@ await client.shipping.taskGroups.attachBillingLedgerPeriodToProviderPayProviderV
17459
18390
  </dl>
17460
18391
  </details>
17461
18392
 
17462
- <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">attachBillingLedgerPeriodToProviderPayDriverV1</a>(taskGroupId, { ...params }) -> Chrt.BillingLedgerPeriod1</code></summary>
18393
+ <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">detachLigFromShipperPayProviderV1</a>(taskGroupId) -> boolean</code></summary>
17463
18394
  <dl>
17464
18395
  <dd>
17465
18396
 
@@ -17471,7 +18402,7 @@ await client.shipping.taskGroups.attachBillingLedgerPeriodToProviderPayProviderV
17471
18402
  <dl>
17472
18403
  <dd>
17473
18404
 
17474
- Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's PPD vector. Period parties must match the TG's PPD parties. The PPD vector must have no ledger attached and no rate sheet (rate-sheet/ledger exclusivity). Ad-hoc LIGs without a rate sheet may coexist. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | (AttachBillingLedgerPeriodReq) -> (BillingLedgerPeriod1)
18405
+ Clears the SPP vector's `_line_item_group_id` and `_rate_sheet_id` AND clears the LIG's `task_group_id` back-ref (one txn). The LIG document and its line items remain alive but fully detached on both sides. The SPP vector must currently have a LIG attached. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | () -> (bool)
17475
18406
 
17476
18407
  </dd>
17477
18408
  </dl>
@@ -17487,9 +18418,7 @@ Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's PPD vec
17487
18418
  <dd>
17488
18419
 
17489
18420
  ```typescript
17490
- await client.shipping.taskGroups.attachBillingLedgerPeriodToProviderPayDriverV1("task_group_id", {
17491
- billing_ledger_period_id: "billing_ledger_period_id",
17492
- });
18421
+ await client.shipping.taskGroups.detachLigFromShipperPayProviderV1("task_group_id");
17493
18422
  ```
17494
18423
 
17495
18424
  </dd>
@@ -17513,14 +18442,6 @@ await client.shipping.taskGroups.attachBillingLedgerPeriodToProviderPayDriverV1(
17513
18442
  <dl>
17514
18443
  <dd>
17515
18444
 
17516
- **request:** `Chrt.AttachBillingLedgerPeriodReq`
17517
-
17518
- </dd>
17519
- </dl>
17520
-
17521
- <dl>
17522
- <dd>
17523
-
17524
18445
  **requestOptions:** `TaskGroups.RequestOptions`
17525
18446
 
17526
18447
  </dd>
@@ -17532,7 +18453,7 @@ await client.shipping.taskGroups.attachBillingLedgerPeriodToProviderPayDriverV1(
17532
18453
  </dl>
17533
18454
  </details>
17534
18455
 
17535
- <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">detachBillingLedgerPeriodFromShipperPayProviderV1</a>(taskGroupId) -> boolean</code></summary>
18456
+ <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">detachLigFromProviderPayProviderV1</a>(taskGroupId) -> boolean</code></summary>
17536
18457
  <dl>
17537
18458
  <dd>
17538
18459
 
@@ -17544,7 +18465,7 @@ await client.shipping.taskGroups.attachBillingLedgerPeriodToProviderPayDriverV1(
17544
18465
  <dl>
17545
18466
  <dd>
17546
18467
 
17547
- Detaches the SPP billing ledger period from this TaskGroup. Reverses attach_billing_ledger_period_to_shipper_pay_provider/v1. Linked period must be OPEN. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | () -> (bool)
18468
+ Clears the PPP vector's `_line_item_group_id` and `_rate_sheet_id` AND clears the LIG's `task_group_id` back-ref (one txn). The LIG document and its line items remain alive but fully detached on both sides. The PPP vector must currently have a LIG attached. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | () -> (bool)
17548
18469
 
17549
18470
  </dd>
17550
18471
  </dl>
@@ -17560,7 +18481,7 @@ Detaches the SPP billing ledger period from this TaskGroup. Reverses attach_bill
17560
18481
  <dd>
17561
18482
 
17562
18483
  ```typescript
17563
- await client.shipping.taskGroups.detachBillingLedgerPeriodFromShipperPayProviderV1("task_group_id");
18484
+ await client.shipping.taskGroups.detachLigFromProviderPayProviderV1("task_group_id");
17564
18485
  ```
17565
18486
 
17566
18487
  </dd>
@@ -17595,7 +18516,7 @@ await client.shipping.taskGroups.detachBillingLedgerPeriodFromShipperPayProvider
17595
18516
  </dl>
17596
18517
  </details>
17597
18518
 
17598
- <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">detachBillingLedgerPeriodFromProviderPayProviderV1</a>(taskGroupId) -> boolean</code></summary>
18519
+ <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">detachLigFromProviderPayDriverV1</a>(taskGroupId) -> boolean</code></summary>
17599
18520
  <dl>
17600
18521
  <dd>
17601
18522
 
@@ -17607,7 +18528,7 @@ await client.shipping.taskGroups.detachBillingLedgerPeriodFromShipperPayProvider
17607
18528
  <dl>
17608
18529
  <dd>
17609
18530
 
17610
- Detaches the PPP billing ledger period from this TaskGroup. Reverses attach_billing_ledger_period_to_provider_pay_provider/v1. Linked period must be OPEN. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | () -> (bool)
18531
+ Clears the PPD vector's `_line_item_group_id` and `_rate_sheet_id` AND clears the LIG's `task_group_id` back-ref (one txn). The LIG document and its line items remain alive but fully detached on both sides. The PPD vector must currently have a LIG attached. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | () -> (bool)
17611
18532
 
17612
18533
  </dd>
17613
18534
  </dl>
@@ -17623,7 +18544,7 @@ Detaches the PPP billing ledger period from this TaskGroup. Reverses attach_bill
17623
18544
  <dd>
17624
18545
 
17625
18546
  ```typescript
17626
- await client.shipping.taskGroups.detachBillingLedgerPeriodFromProviderPayProviderV1("task_group_id");
18547
+ await client.shipping.taskGroups.detachLigFromProviderPayDriverV1("task_group_id");
17627
18548
  ```
17628
18549
 
17629
18550
  </dd>
@@ -17658,7 +18579,7 @@ await client.shipping.taskGroups.detachBillingLedgerPeriodFromProviderPayProvide
17658
18579
  </dl>
17659
18580
  </details>
17660
18581
 
17661
- <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">detachBillingLedgerPeriodFromProviderPayDriverV1</a>(taskGroupId) -> boolean</code></summary>
18582
+ <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">quoteForShipperPayProviderV1</a>(taskGroupId, { ...params }) -> Chrt.TaskGroupQuoteResp</code></summary>
17662
18583
  <dl>
17663
18584
  <dd>
17664
18585
 
@@ -17670,7 +18591,7 @@ await client.shipping.taskGroups.detachBillingLedgerPeriodFromProviderPayProvide
17670
18591
  <dl>
17671
18592
  <dd>
17672
18593
 
17673
- Detaches the PPD billing ledger period from this TaskGroup. Reverses attach_billing_ledger_period_to_provider_pay_driver/v1. Linked period must be OPEN. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | () -> (bool)
18594
+ Preview the LineItem materialization that would result from applying a rate sheet to the SPP vector of the named TaskGroup. Returns the resolved rate sheet, materialized LineItems (NOT inserted), the pre-adjustment total, and the requested parties (shipper -> coordinator). Auto-resolves the rate sheet via RateSheetMapping1 for the requested shipper unless body.rate_sheet_id is provided. No DB writes — operator can iterate freely. To commit, call from_rate_sheet/create_for_shipper_pay_provider/v1 then attach_lig_to_shipper_pay_provider/v1. | authz: allowed_org_types=[provider, shipper], min_org_role=operator, authz_personas=[task_group_coordinator_operators, shipper_org_operators] | (TaskGroupQuoteForShipperPayProviderClientReq) -> (TaskGroupQuoteResp)
17674
18595
 
17675
18596
  </dd>
17676
18597
  </dl>
@@ -17686,7 +18607,7 @@ Detaches the PPD billing ledger period from this TaskGroup. Reverses attach_bill
17686
18607
  <dd>
17687
18608
 
17688
18609
  ```typescript
17689
- await client.shipping.taskGroups.detachBillingLedgerPeriodFromProviderPayDriverV1("task_group_id");
18610
+ await client.shipping.taskGroups.quoteForShipperPayProviderV1("task_group_id");
17690
18611
  ```
17691
18612
 
17692
18613
  </dd>
@@ -17710,6 +18631,14 @@ await client.shipping.taskGroups.detachBillingLedgerPeriodFromProviderPayDriverV
17710
18631
  <dl>
17711
18632
  <dd>
17712
18633
 
18634
+ **request:** `Chrt.shipping.TaskGroupQuoteForShipperPayProviderClientReq`
18635
+
18636
+ </dd>
18637
+ </dl>
18638
+
18639
+ <dl>
18640
+ <dd>
18641
+
17713
18642
  **requestOptions:** `TaskGroups.RequestOptions`
17714
18643
 
17715
18644
  </dd>
@@ -17721,7 +18650,7 @@ await client.shipping.taskGroups.detachBillingLedgerPeriodFromProviderPayDriverV
17721
18650
  </dl>
17722
18651
  </details>
17723
18652
 
17724
- <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">attachLigToShipperPayProviderV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
18653
+ <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">quoteForProviderPayProviderV1</a>(taskGroupId, { ...params }) -> Chrt.TaskGroupQuoteResp</code></summary>
17725
18654
  <dl>
17726
18655
  <dd>
17727
18656
 
@@ -17733,7 +18662,7 @@ await client.shipping.taskGroups.detachBillingLedgerPeriodFromProviderPayDriverV
17733
18662
  <dl>
17734
18663
  <dd>
17735
18664
 
17736
- Attaches a STAGED, detached LineItemGroup to the SPP vector AND sets `LineItemGroup1.task_group_id` (one txn). The LIG must have `task_group_id is None`, be owned by the coordinator, and be party-matched to SPP. The SPP vector must have no LIG attached; if the LIG carries `rate_sheet_id`, no billing ledger period may be attached either (rate-sheet/ledger exclusivity). The LIG's `rate_sheet_id` is stamped onto `shipper_pay_provider_rate_sheet_id` as a breadcrumb. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (AttachLigToVectorClientReq) -> (bool)
18665
+ Preview the LineItem materialization that would result from applying a rate sheet to the PPP vector of the named TaskGroup. Returns the resolved rate sheet, materialized LineItems (NOT inserted), the pre-adjustment total, and the requested parties (coordinator -> executor). Auto-resolves the rate sheet via RateSheetMapping1 for the requested executor unless body.rate_sheet_id is provided. No DB writes operator can iterate freely. To commit, call from_rate_sheet/create_for_provider_pay_provider/v1 then attach_lig_to_provider_pay_provider/v1. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (TaskGroupQuoteForProviderPayProviderClientReq) -> (TaskGroupQuoteResp)
17737
18666
 
17738
18667
  </dd>
17739
18668
  </dl>
@@ -17749,9 +18678,7 @@ Attaches a STAGED, detached LineItemGroup to the SPP vector AND sets `LineItemGr
17749
18678
  <dd>
17750
18679
 
17751
18680
  ```typescript
17752
- await client.shipping.taskGroups.attachLigToShipperPayProviderV1("task_group_id", {
17753
- line_item_group_id: "line_item_group_id",
17754
- });
18681
+ await client.shipping.taskGroups.quoteForProviderPayProviderV1("task_group_id");
17755
18682
  ```
17756
18683
 
17757
18684
  </dd>
@@ -17775,7 +18702,7 @@ await client.shipping.taskGroups.attachLigToShipperPayProviderV1("task_group_id"
17775
18702
  <dl>
17776
18703
  <dd>
17777
18704
 
17778
- **request:** `Chrt.AttachLigToVectorClientReq`
18705
+ **request:** `Chrt.shipping.TaskGroupQuoteForProviderPayProviderClientReq`
17779
18706
 
17780
18707
  </dd>
17781
18708
  </dl>
@@ -17794,7 +18721,7 @@ await client.shipping.taskGroups.attachLigToShipperPayProviderV1("task_group_id"
17794
18721
  </dl>
17795
18722
  </details>
17796
18723
 
17797
- <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">attachLigToProviderPayProviderV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
18724
+ <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">quoteForProviderPayDriverV1</a>(taskGroupId, { ...params }) -> Chrt.TaskGroupQuoteResp</code></summary>
17798
18725
  <dl>
17799
18726
  <dd>
17800
18727
 
@@ -17806,7 +18733,7 @@ await client.shipping.taskGroups.attachLigToShipperPayProviderV1("task_group_id"
17806
18733
  <dl>
17807
18734
  <dd>
17808
18735
 
17809
- Attaches a STAGED, detached LineItemGroup to the PPP vector AND sets `LineItemGroup1.task_group_id` (one txn). The LIG must have `task_group_id is None`, be owned by the coordinator, and be party-matched to PPP. The PPP vector must have no LIG attached; if the LIG carries `rate_sheet_id`, no billing ledger period may be attached either (rate-sheet/ledger exclusivity). The LIG's `rate_sheet_id` is stamped onto `provider_pay_provider_rate_sheet_id` as a breadcrumb. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (AttachLigToVectorClientReq) -> (bool)
18736
+ Preview the LineItem materialization that would result from applying a rate sheet to the PPD vector of the named TaskGroup. Returns the resolved rate sheet, materialized LineItems (NOT inserted), the pre-adjustment total, and the requested parties (executor -> driver). Auto-resolves the rate sheet via RateSheetMapping1 for the requested driver unless body.rate_sheet_id is provided. PPD is on-chrt-executor only TGs with an off-chrt executor are 400'd. No DB writes operator can iterate freely. To commit, call from_rate_sheet/create_for_provider_pay_driver/v1 then attach_lig_to_provider_pay_driver/v1. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | (TaskGroupQuoteForProviderPayDriverClientReq) -> (TaskGroupQuoteResp)
17810
18737
 
17811
18738
  </dd>
17812
18739
  </dl>
@@ -17822,8 +18749,8 @@ Attaches a STAGED, detached LineItemGroup to the PPP vector AND sets `LineItemGr
17822
18749
  <dd>
17823
18750
 
17824
18751
  ```typescript
17825
- await client.shipping.taskGroups.attachLigToProviderPayProviderV1("task_group_id", {
17826
- line_item_group_id: "line_item_group_id",
18752
+ await client.shipping.taskGroups.quoteForProviderPayDriverV1("task_group_id", {
18753
+ driver_id: "driver_id",
17827
18754
  });
17828
18755
  ```
17829
18756
 
@@ -17848,7 +18775,7 @@ await client.shipping.taskGroups.attachLigToProviderPayProviderV1("task_group_id
17848
18775
  <dl>
17849
18776
  <dd>
17850
18777
 
17851
- **request:** `Chrt.AttachLigToVectorClientReq`
18778
+ **request:** `Chrt.shipping.TaskGroupQuoteForProviderPayDriverClientReq`
17852
18779
 
17853
18780
  </dd>
17854
18781
  </dl>
@@ -17867,7 +18794,9 @@ await client.shipping.taskGroups.attachLigToProviderPayProviderV1("task_group_id
17867
18794
  </dl>
17868
18795
  </details>
17869
18796
 
17870
- <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">attachLigToProviderPayDriverV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
18797
+ ## Shipping Tasks
18798
+
18799
+ <details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">addToTaskGroupV1</a>(taskGroupId, { ...params }) -> string</code></summary>
17871
18800
  <dl>
17872
18801
  <dd>
17873
18802
 
@@ -17879,7 +18808,7 @@ await client.shipping.taskGroups.attachLigToProviderPayProviderV1("task_group_id
17879
18808
  <dl>
17880
18809
  <dd>
17881
18810
 
17882
- Attaches a STAGED, detached LineItemGroup to the PPD vector AND sets `LineItemGroup1.task_group_id` (one txn). The LIG must have `task_group_id is None`, be owned by the executor, and be party-matched to PPD. The PPD vector must have no LIG attached; if the LIG carries `rate_sheet_id`, no billing ledger period may be attached either (rate-sheet/ledger exclusivity). The LIG's `rate_sheet_id` is stamped onto `provider_pay_driver_rate_sheet_id` as a breadcrumb. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | (AttachLigToVectorClientReq) -> (bool)
18811
+ Adds a new task to a task group at a specific index. | authz_personas=[lig_owner_operators] | (AddTaskToGroupReq) -> (PydanticObjectId)
17883
18812
 
17884
18813
  </dd>
17885
18814
  </dl>
@@ -17895,8 +18824,12 @@ Attaches a STAGED, detached LineItemGroup to the PPD vector AND sets `LineItemGr
17895
18824
  <dd>
17896
18825
 
17897
18826
  ```typescript
17898
- await client.shipping.taskGroups.attachLigToProviderPayDriverV1("task_group_id", {
17899
- line_item_group_id: "line_item_group_id",
18827
+ await client.shipping.tasks.addToTaskGroupV1("task_group_id", {
18828
+ task: {
18829
+ schema_version: 1,
18830
+ },
18831
+ status: "draft",
18832
+ index: 1,
17900
18833
  });
17901
18834
  ```
17902
18835
 
@@ -17921,7 +18854,7 @@ await client.shipping.taskGroups.attachLigToProviderPayDriverV1("task_group_id",
17921
18854
  <dl>
17922
18855
  <dd>
17923
18856
 
17924
- **request:** `Chrt.AttachLigToVectorClientReq`
18857
+ **request:** `Chrt.shipping.AddTaskToGroupReq`
17925
18858
 
17926
18859
  </dd>
17927
18860
  </dl>
@@ -17929,7 +18862,7 @@ await client.shipping.taskGroups.attachLigToProviderPayDriverV1("task_group_id",
17929
18862
  <dl>
17930
18863
  <dd>
17931
18864
 
17932
- **requestOptions:** `TaskGroups.RequestOptions`
18865
+ **requestOptions:** `Tasks.RequestOptions`
17933
18866
 
17934
18867
  </dd>
17935
18868
  </dl>
@@ -17940,7 +18873,7 @@ await client.shipping.taskGroups.attachLigToProviderPayDriverV1("task_group_id",
17940
18873
  </dl>
17941
18874
  </details>
17942
18875
 
17943
- <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">detachLigFromShipperPayProviderV1</a>(taskGroupId) -> boolean</code></summary>
18876
+ <details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">updateV1</a>(taskId, { ...params }) -> string</code></summary>
17944
18877
  <dl>
17945
18878
  <dd>
17946
18879
 
@@ -17952,7 +18885,7 @@ await client.shipping.taskGroups.attachLigToProviderPayDriverV1("task_group_id",
17952
18885
  <dl>
17953
18886
  <dd>
17954
18887
 
17955
- Clears the SPP vector's `_line_item_group_id` and `_rate_sheet_id` AND clears the LIG's `task_group_id` back-ref (one txn). The LIG document and its line items remain alive but fully detached on both sides. The SPP vector must currently have a LIG attached. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | () -> (bool)
18888
+ Updates a task. Operational fields (location, action, datetime_windows) require STAGED status (lig_owner_operators). order_placer_comments can be edited on any non-DRAFT task (order_creator_org_operators). directory_entry_ids can be edited on STAGED/IN_PROGRESS orders for tasks still in STAGED status (order_creator_org_operators OR lig_owner_operators). | (TaskClientUpdate1) -> (PydanticObjectId)
17956
18889
 
17957
18890
  </dd>
17958
18891
  </dl>
@@ -17968,7 +18901,7 @@ Clears the SPP vector's `_line_item_group_id` and `_rate_sheet_id` AND clears th
17968
18901
  <dd>
17969
18902
 
17970
18903
  ```typescript
17971
- await client.shipping.taskGroups.detachLigFromShipperPayProviderV1("task_group_id");
18904
+ await client.shipping.tasks.updateV1("task_id", {});
17972
18905
  ```
17973
18906
 
17974
18907
  </dd>
@@ -17984,7 +18917,7 @@ await client.shipping.taskGroups.detachLigFromShipperPayProviderV1("task_group_i
17984
18917
  <dl>
17985
18918
  <dd>
17986
18919
 
17987
- **taskGroupId:** `string`
18920
+ **taskId:** `string`
17988
18921
 
17989
18922
  </dd>
17990
18923
  </dl>
@@ -17992,7 +18925,15 @@ await client.shipping.taskGroups.detachLigFromShipperPayProviderV1("task_group_i
17992
18925
  <dl>
17993
18926
  <dd>
17994
18927
 
17995
- **requestOptions:** `TaskGroups.RequestOptions`
18928
+ **request:** `Chrt.TaskClientUpdate1`
18929
+
18930
+ </dd>
18931
+ </dl>
18932
+
18933
+ <dl>
18934
+ <dd>
18935
+
18936
+ **requestOptions:** `Tasks.RequestOptions`
17996
18937
 
17997
18938
  </dd>
17998
18939
  </dl>
@@ -18003,7 +18944,7 @@ await client.shipping.taskGroups.detachLigFromShipperPayProviderV1("task_group_i
18003
18944
  </dl>
18004
18945
  </details>
18005
18946
 
18006
- <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">detachLigFromProviderPayProviderV1</a>(taskGroupId) -> boolean</code></summary>
18947
+ <details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">completeV1</a>(taskId) -> boolean</code></summary>
18007
18948
  <dl>
18008
18949
  <dd>
18009
18950
 
@@ -18015,7 +18956,7 @@ await client.shipping.taskGroups.detachLigFromShipperPayProviderV1("task_group_i
18015
18956
  <dl>
18016
18957
  <dd>
18017
18958
 
18018
- Clears the PPP vector's `_line_item_group_id` and `_rate_sheet_id` AND clears the LIG's `task_group_id` back-ref (one txn). The LIG document and its line items remain alive but fully detached on both sides. The PPP vector must currently have a LIG attached. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | () -> (bool)
18959
+ Marks a task as COMPLETED. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators] (depending on type) | () -> (bool)
18019
18960
 
18020
18961
  </dd>
18021
18962
  </dl>
@@ -18031,7 +18972,7 @@ Clears the PPP vector's `_line_item_group_id` and `_rate_sheet_id` AND clears th
18031
18972
  <dd>
18032
18973
 
18033
18974
  ```typescript
18034
- await client.shipping.taskGroups.detachLigFromProviderPayProviderV1("task_group_id");
18975
+ await client.shipping.tasks.completeV1("task_id");
18035
18976
  ```
18036
18977
 
18037
18978
  </dd>
@@ -18047,7 +18988,7 @@ await client.shipping.taskGroups.detachLigFromProviderPayProviderV1("task_group_
18047
18988
  <dl>
18048
18989
  <dd>
18049
18990
 
18050
- **taskGroupId:** `string`
18991
+ **taskId:** `string`
18051
18992
 
18052
18993
  </dd>
18053
18994
  </dl>
@@ -18055,7 +18996,7 @@ await client.shipping.taskGroups.detachLigFromProviderPayProviderV1("task_group_
18055
18996
  <dl>
18056
18997
  <dd>
18057
18998
 
18058
- **requestOptions:** `TaskGroups.RequestOptions`
18999
+ **requestOptions:** `Tasks.RequestOptions`
18059
19000
 
18060
19001
  </dd>
18061
19002
  </dl>
@@ -18066,7 +19007,7 @@ await client.shipping.taskGroups.detachLigFromProviderPayProviderV1("task_group_
18066
19007
  </dl>
18067
19008
  </details>
18068
19009
 
18069
- <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">detachLigFromProviderPayDriverV1</a>(taskGroupId) -> boolean</code></summary>
19010
+ <details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">skipV1</a>(taskId) -> boolean</code></summary>
18070
19011
  <dl>
18071
19012
  <dd>
18072
19013
 
@@ -18078,7 +19019,7 @@ await client.shipping.taskGroups.detachLigFromProviderPayProviderV1("task_group_
18078
19019
  <dl>
18079
19020
  <dd>
18080
19021
 
18081
- Clears the PPD vector's `_line_item_group_id` and `_rate_sheet_id` AND clears the LIG's `task_group_id` back-ref (one txn). The LIG document and its line items remain alive but fully detached on both sides. The PPD vector must currently have a LIG attached. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | () -> (bool)
19022
+ Marks a task as SKIPPED. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators] (depending on type) | () -> (bool)
18082
19023
 
18083
19024
  </dd>
18084
19025
  </dl>
@@ -18094,7 +19035,7 @@ Clears the PPD vector's `_line_item_group_id` and `_rate_sheet_id` AND clears th
18094
19035
  <dd>
18095
19036
 
18096
19037
  ```typescript
18097
- await client.shipping.taskGroups.detachLigFromProviderPayDriverV1("task_group_id");
19038
+ await client.shipping.tasks.skipV1("task_id");
18098
19039
  ```
18099
19040
 
18100
19041
  </dd>
@@ -18110,7 +19051,7 @@ await client.shipping.taskGroups.detachLigFromProviderPayDriverV1("task_group_id
18110
19051
  <dl>
18111
19052
  <dd>
18112
19053
 
18113
- **taskGroupId:** `string`
19054
+ **taskId:** `string`
18114
19055
 
18115
19056
  </dd>
18116
19057
  </dl>
@@ -18118,7 +19059,7 @@ await client.shipping.taskGroups.detachLigFromProviderPayDriverV1("task_group_id
18118
19059
  <dl>
18119
19060
  <dd>
18120
19061
 
18121
- **requestOptions:** `TaskGroups.RequestOptions`
19062
+ **requestOptions:** `Tasks.RequestOptions`
18122
19063
 
18123
19064
  </dd>
18124
19065
  </dl>
@@ -18129,7 +19070,7 @@ await client.shipping.taskGroups.detachLigFromProviderPayDriverV1("task_group_id
18129
19070
  </dl>
18130
19071
  </details>
18131
19072
 
18132
- <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">quoteForShipperPayProviderV1</a>(taskGroupId, { ...params }) -> Chrt.TaskGroupQuoteResp</code></summary>
19073
+ <details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">attemptV1</a>(taskId) -> boolean</code></summary>
18133
19074
  <dl>
18134
19075
  <dd>
18135
19076
 
@@ -18141,7 +19082,7 @@ await client.shipping.taskGroups.detachLigFromProviderPayDriverV1("task_group_id
18141
19082
  <dl>
18142
19083
  <dd>
18143
19084
 
18144
- Preview the LineItem materialization that would result from applying a rate sheet to the SPP vector of the named TaskGroup. Returns the resolved rate sheet, materialized LineItems (NOT inserted), the pre-adjustment total, and the requested parties (shipper -> coordinator). Auto-resolves the rate sheet via RateSheetMapping1 for the requested shipper unless body.rate_sheet_id is provided. No DB writes — operator can iterate freely. To commit, call from_rate_sheet/create_for_shipper_pay_provider/v1 then attach_lig_to_shipper_pay_provider/v1. | authz: allowed_org_types=[provider, shipper], min_org_role=operator, authz_personas=[task_group_coordinator_operators, shipper_org_operators] | (TaskGroupQuoteForShipperPayProviderClientReq) -> (TaskGroupQuoteResp)
19085
+ Marks a task as ATTEMPT. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators] (depending on type) | () -> (bool)
18145
19086
 
18146
19087
  </dd>
18147
19088
  </dl>
@@ -18157,7 +19098,7 @@ Preview the LineItem materialization that would result from applying a rate shee
18157
19098
  <dd>
18158
19099
 
18159
19100
  ```typescript
18160
- await client.shipping.taskGroups.quoteForShipperPayProviderV1("task_group_id");
19101
+ await client.shipping.tasks.attemptV1("task_id");
18161
19102
  ```
18162
19103
 
18163
19104
  </dd>
@@ -18173,15 +19114,7 @@ await client.shipping.taskGroups.quoteForShipperPayProviderV1("task_group_id");
18173
19114
  <dl>
18174
19115
  <dd>
18175
19116
 
18176
- **taskGroupId:** `string`
18177
-
18178
- </dd>
18179
- </dl>
18180
-
18181
- <dl>
18182
- <dd>
18183
-
18184
- **request:** `Chrt.shipping.TaskGroupQuoteForShipperPayProviderClientReq`
19117
+ **taskId:** `string`
18185
19118
 
18186
19119
  </dd>
18187
19120
  </dl>
@@ -18189,7 +19122,7 @@ await client.shipping.taskGroups.quoteForShipperPayProviderV1("task_group_id");
18189
19122
  <dl>
18190
19123
  <dd>
18191
19124
 
18192
- **requestOptions:** `TaskGroups.RequestOptions`
19125
+ **requestOptions:** `Tasks.RequestOptions`
18193
19126
 
18194
19127
  </dd>
18195
19128
  </dl>
@@ -18200,7 +19133,7 @@ await client.shipping.taskGroups.quoteForShipperPayProviderV1("task_group_id");
18200
19133
  </dl>
18201
19134
  </details>
18202
19135
 
18203
- <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">quoteForProviderPayProviderV1</a>(taskGroupId, { ...params }) -> Chrt.TaskGroupQuoteResp</code></summary>
19136
+ <details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">deleteV1</a>(taskId) -> boolean</code></summary>
18204
19137
  <dl>
18205
19138
  <dd>
18206
19139
 
@@ -18212,7 +19145,7 @@ await client.shipping.taskGroups.quoteForShipperPayProviderV1("task_group_id");
18212
19145
  <dl>
18213
19146
  <dd>
18214
19147
 
18215
- Preview the LineItem materialization that would result from applying a rate sheet to the PPP vector of the named TaskGroup. Returns the resolved rate sheet, materialized LineItems (NOT inserted), the pre-adjustment total, and the requested parties (coordinator -> executor). Auto-resolves the rate sheet via RateSheetMapping1 for the requested executor unless body.rate_sheet_id is provided. No DB writes — operator can iterate freely. To commit, call from_rate_sheet/create_for_provider_pay_provider/v1 then attach_lig_to_provider_pay_provider/v1. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (TaskGroupQuoteForProviderPayProviderClientReq) -> (TaskGroupQuoteResp)
19148
+ Deletes a task. Task must be in STAGED status. | authz_personas=[lig_owner_operators] | () -> (bool)
18216
19149
 
18217
19150
  </dd>
18218
19151
  </dl>
@@ -18228,7 +19161,7 @@ Preview the LineItem materialization that would result from applying a rate shee
18228
19161
  <dd>
18229
19162
 
18230
19163
  ```typescript
18231
- await client.shipping.taskGroups.quoteForProviderPayProviderV1("task_group_id");
19164
+ await client.shipping.tasks.deleteV1("task_id");
18232
19165
  ```
18233
19166
 
18234
19167
  </dd>
@@ -18244,15 +19177,7 @@ await client.shipping.taskGroups.quoteForProviderPayProviderV1("task_group_id");
18244
19177
  <dl>
18245
19178
  <dd>
18246
19179
 
18247
- **taskGroupId:** `string`
18248
-
18249
- </dd>
18250
- </dl>
18251
-
18252
- <dl>
18253
- <dd>
18254
-
18255
- **request:** `Chrt.shipping.TaskGroupQuoteForProviderPayProviderClientReq`
19180
+ **taskId:** `string`
18256
19181
 
18257
19182
  </dd>
18258
19183
  </dl>
@@ -18260,7 +19185,7 @@ await client.shipping.taskGroups.quoteForProviderPayProviderV1("task_group_id");
18260
19185
  <dl>
18261
19186
  <dd>
18262
19187
 
18263
- **requestOptions:** `TaskGroups.RequestOptions`
19188
+ **requestOptions:** `Tasks.RequestOptions`
18264
19189
 
18265
19190
  </dd>
18266
19191
  </dl>
@@ -18271,7 +19196,9 @@ await client.shipping.taskGroups.quoteForProviderPayProviderV1("task_group_id");
18271
19196
  </dl>
18272
19197
  </details>
18273
19198
 
18274
- <details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">quoteForProviderPayDriverV1</a>(taskGroupId, { ...params }) -> Chrt.TaskGroupQuoteResp</code></summary>
19199
+ ## Shipping Drivers ComplianceDocuments
19200
+
19201
+ <details><summary><code>client.shipping.drivers.complianceDocuments.<a href="/src/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/Client.ts">listV1</a>(driverId) -> Chrt.DriverComplianceDocument1[]</code></summary>
18275
19202
  <dl>
18276
19203
  <dd>
18277
19204
 
@@ -18283,7 +19210,7 @@ await client.shipping.taskGroups.quoteForProviderPayProviderV1("task_group_id");
18283
19210
  <dl>
18284
19211
  <dd>
18285
19212
 
18286
- Preview the LineItem materialization that would result from applying a rate sheet to the PPD vector of the named TaskGroup. Returns the resolved rate sheet, materialized LineItems (NOT inserted), the pre-adjustment total, and the requested parties (executor -> driver). Auto-resolves the rate sheet via RateSheetMapping1 for the requested driver unless body.rate_sheet_id is provided. PPD is on-chrt-executor only — TGs with an off-chrt executor are 400'd. No DB writes — operator can iterate freely. To commit, call from_rate_sheet/create_for_provider_pay_driver/v1 then attach_lig_to_provider_pay_driver/v1. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[executor_org_operators] | (TaskGroupQuoteForProviderPayDriverClientReq) -> (TaskGroupQuoteResp)
19213
+ Lists compliance documents for one driver in the caller's provider organization. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (list[DriverComplianceDocument1])
18287
19214
 
18288
19215
  </dd>
18289
19216
  </dl>
@@ -18299,9 +19226,7 @@ Preview the LineItem materialization that would result from applying a rate shee
18299
19226
  <dd>
18300
19227
 
18301
19228
  ```typescript
18302
- await client.shipping.taskGroups.quoteForProviderPayDriverV1("task_group_id", {
18303
- driver_id: "driver_id",
18304
- });
19229
+ await client.shipping.drivers.complianceDocuments.listV1("driver_id");
18305
19230
  ```
18306
19231
 
18307
19232
  </dd>
@@ -18317,15 +19242,7 @@ await client.shipping.taskGroups.quoteForProviderPayDriverV1("task_group_id", {
18317
19242
  <dl>
18318
19243
  <dd>
18319
19244
 
18320
- **taskGroupId:** `string`
18321
-
18322
- </dd>
18323
- </dl>
18324
-
18325
- <dl>
18326
- <dd>
18327
-
18328
- **request:** `Chrt.shipping.TaskGroupQuoteForProviderPayDriverClientReq`
19245
+ **driverId:** `string`
18329
19246
 
18330
19247
  </dd>
18331
19248
  </dl>
@@ -18333,7 +19250,7 @@ await client.shipping.taskGroups.quoteForProviderPayDriverV1("task_group_id", {
18333
19250
  <dl>
18334
19251
  <dd>
18335
19252
 
18336
- **requestOptions:** `TaskGroups.RequestOptions`
19253
+ **requestOptions:** `ComplianceDocuments.RequestOptions`
18337
19254
 
18338
19255
  </dd>
18339
19256
  </dl>
@@ -18344,9 +19261,7 @@ await client.shipping.taskGroups.quoteForProviderPayDriverV1("task_group_id", {
18344
19261
  </dl>
18345
19262
  </details>
18346
19263
 
18347
- ## Shipping Tasks
18348
-
18349
- <details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">addToTaskGroupV1</a>(taskGroupId, { ...params }) -> string</code></summary>
19264
+ <details><summary><code>client.shipping.drivers.complianceDocuments.<a href="/src/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/Client.ts">getV1</a>(driverComplianceDocumentId) -> Chrt.DriverComplianceDocument1</code></summary>
18350
19265
  <dl>
18351
19266
  <dd>
18352
19267
 
@@ -18358,7 +19273,7 @@ await client.shipping.taskGroups.quoteForProviderPayDriverV1("task_group_id", {
18358
19273
  <dl>
18359
19274
  <dd>
18360
19275
 
18361
- Adds a new task to a task group at a specific index. | authz_personas=[lig_owner_operators] | (AddTaskToGroupReq) -> (PydanticObjectId)
19276
+ Retrieves one driver compliance document in the caller's provider organization. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (DriverComplianceDocument1)
18362
19277
 
18363
19278
  </dd>
18364
19279
  </dl>
@@ -18374,13 +19289,7 @@ Adds a new task to a task group at a specific index. | authz_personas=[lig_owner
18374
19289
  <dd>
18375
19290
 
18376
19291
  ```typescript
18377
- await client.shipping.tasks.addToTaskGroupV1("task_group_id", {
18378
- task: {
18379
- schema_version: 1,
18380
- },
18381
- status: "draft",
18382
- index: 1,
18383
- });
19292
+ await client.shipping.drivers.complianceDocuments.getV1("driver_compliance_document_id");
18384
19293
  ```
18385
19294
 
18386
19295
  </dd>
@@ -18396,15 +19305,7 @@ await client.shipping.tasks.addToTaskGroupV1("task_group_id", {
18396
19305
  <dl>
18397
19306
  <dd>
18398
19307
 
18399
- **taskGroupId:** `string`
18400
-
18401
- </dd>
18402
- </dl>
18403
-
18404
- <dl>
18405
- <dd>
18406
-
18407
- **request:** `Chrt.shipping.AddTaskToGroupReq`
19308
+ **driverComplianceDocumentId:** `string`
18408
19309
 
18409
19310
  </dd>
18410
19311
  </dl>
@@ -18412,7 +19313,7 @@ await client.shipping.tasks.addToTaskGroupV1("task_group_id", {
18412
19313
  <dl>
18413
19314
  <dd>
18414
19315
 
18415
- **requestOptions:** `Tasks.RequestOptions`
19316
+ **requestOptions:** `ComplianceDocuments.RequestOptions`
18416
19317
 
18417
19318
  </dd>
18418
19319
  </dl>
@@ -18423,7 +19324,7 @@ await client.shipping.tasks.addToTaskGroupV1("task_group_id", {
18423
19324
  </dl>
18424
19325
  </details>
18425
19326
 
18426
- <details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">updateV1</a>(taskId, { ...params }) -> string</code></summary>
19327
+ <details><summary><code>client.shipping.drivers.complianceDocuments.<a href="/src/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/Client.ts">createV1</a>(driverId, { ...params }) -> Chrt.DriverComplianceDocument1</code></summary>
18427
19328
  <dl>
18428
19329
  <dd>
18429
19330
 
@@ -18435,7 +19336,7 @@ await client.shipping.tasks.addToTaskGroupV1("task_group_id", {
18435
19336
  <dl>
18436
19337
  <dd>
18437
19338
 
18438
- Updates a task. Operational fields (location, action, time_windows) require STAGED status (lig_owner_operators). order_placer_comments can be edited on any non-DRAFT task (order_creator_org_operators). directory_entry_ids can be edited on STAGED/IN_PROGRESS orders for tasks still in STAGED status (order_creator_org_operators OR lig_owner_operators). | (TaskClientUpdate1) -> (PydanticObjectId)
19339
+ Creates a compliance document record for a driver in the caller's provider organization. | authz: allowed_org_types=[provider], min_org_role=administrator | (DriverComplianceDocumentClientCreate1) -> (DriverComplianceDocument1)
18439
19340
 
18440
19341
  </dd>
18441
19342
  </dl>
@@ -18451,7 +19352,10 @@ Updates a task. Operational fields (location, action, time_windows) require STAG
18451
19352
  <dd>
18452
19353
 
18453
19354
  ```typescript
18454
- await client.shipping.tasks.updateV1("task_id", {});
19355
+ await client.shipping.drivers.complianceDocuments.createV1("driver_id", {
19356
+ schema_version: 1,
19357
+ document_type: "drivers_license",
19358
+ });
18455
19359
  ```
18456
19360
 
18457
19361
  </dd>
@@ -18467,7 +19371,7 @@ await client.shipping.tasks.updateV1("task_id", {});
18467
19371
  <dl>
18468
19372
  <dd>
18469
19373
 
18470
- **taskId:** `string`
19374
+ **driverId:** `string`
18471
19375
 
18472
19376
  </dd>
18473
19377
  </dl>
@@ -18475,7 +19379,7 @@ await client.shipping.tasks.updateV1("task_id", {});
18475
19379
  <dl>
18476
19380
  <dd>
18477
19381
 
18478
- **request:** `Chrt.TaskClientUpdate1`
19382
+ **request:** `Chrt.shipping.drivers.DriverComplianceDocumentClientCreate1`
18479
19383
 
18480
19384
  </dd>
18481
19385
  </dl>
@@ -18483,7 +19387,7 @@ await client.shipping.tasks.updateV1("task_id", {});
18483
19387
  <dl>
18484
19388
  <dd>
18485
19389
 
18486
- **requestOptions:** `Tasks.RequestOptions`
19390
+ **requestOptions:** `ComplianceDocuments.RequestOptions`
18487
19391
 
18488
19392
  </dd>
18489
19393
  </dl>
@@ -18494,7 +19398,9 @@ await client.shipping.tasks.updateV1("task_id", {});
18494
19398
  </dl>
18495
19399
  </details>
18496
19400
 
18497
- <details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">completeV1</a>(taskId) -> boolean</code></summary>
19401
+ ## Shipping Drivers ComplianceDocuments S3Object
19402
+
19403
+ <details><summary><code>client.shipping.drivers.complianceDocuments.s3Object.<a href="/src/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/Client.ts">getS3ObjectMetadataV1</a>(driverComplianceDocumentS3ObjectMetadataId) -> Chrt.DriverComplianceDocumentS3ObjectMetadata1</code></summary>
18498
19404
  <dl>
18499
19405
  <dd>
18500
19406
 
@@ -18506,7 +19412,7 @@ await client.shipping.tasks.updateV1("task_id", {});
18506
19412
  <dl>
18507
19413
  <dd>
18508
19414
 
18509
- Marks a task as COMPLETED. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators] (depending on type) | () -> (bool)
19415
+ Retrieves metadata for a driver compliance document S3 object. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (DriverComplianceDocumentS3ObjectMetadata1)
18510
19416
 
18511
19417
  </dd>
18512
19418
  </dl>
@@ -18522,7 +19428,9 @@ Marks a task as COMPLETED. | authz_personas=[driver_for_executor, coordinator_or
18522
19428
  <dd>
18523
19429
 
18524
19430
  ```typescript
18525
- await client.shipping.tasks.completeV1("task_id");
19431
+ await client.shipping.drivers.complianceDocuments.s3Object.getS3ObjectMetadataV1(
19432
+ "driver_compliance_document_s3_object_metadata_id",
19433
+ );
18526
19434
  ```
18527
19435
 
18528
19436
  </dd>
@@ -18538,7 +19446,7 @@ await client.shipping.tasks.completeV1("task_id");
18538
19446
  <dl>
18539
19447
  <dd>
18540
19448
 
18541
- **taskId:** `string`
19449
+ **driverComplianceDocumentS3ObjectMetadataId:** `string`
18542
19450
 
18543
19451
  </dd>
18544
19452
  </dl>
@@ -18546,7 +19454,7 @@ await client.shipping.tasks.completeV1("task_id");
18546
19454
  <dl>
18547
19455
  <dd>
18548
19456
 
18549
- **requestOptions:** `Tasks.RequestOptions`
19457
+ **requestOptions:** `S3Object.RequestOptions`
18550
19458
 
18551
19459
  </dd>
18552
19460
  </dl>
@@ -18557,7 +19465,7 @@ await client.shipping.tasks.completeV1("task_id");
18557
19465
  </dl>
18558
19466
  </details>
18559
19467
 
18560
- <details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">skipV1</a>(taskId) -> boolean</code></summary>
19468
+ <details><summary><code>client.shipping.drivers.complianceDocuments.s3Object.<a href="/src/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/Client.ts">getV1</a>(driverComplianceDocumentS3ObjectMetadataId) -> core.BinaryResponse</code></summary>
18561
19469
  <dl>
18562
19470
  <dd>
18563
19471
 
@@ -18569,7 +19477,7 @@ await client.shipping.tasks.completeV1("task_id");
18569
19477
  <dl>
18570
19478
  <dd>
18571
19479
 
18572
- Marks a task as SKIPPED. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators] (depending on type) | () -> (bool)
19480
+ Streams a driver compliance document S3 object file from storage. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (binary)
18573
19481
 
18574
19482
  </dd>
18575
19483
  </dl>
@@ -18585,7 +19493,7 @@ Marks a task as SKIPPED. | authz_personas=[driver_for_executor, coordinator_org_
18585
19493
  <dd>
18586
19494
 
18587
19495
  ```typescript
18588
- await client.shipping.tasks.skipV1("task_id");
19496
+ await client.shipping.drivers.complianceDocuments.s3Object.getV1("driver_compliance_document_s3_object_metadata_id");
18589
19497
  ```
18590
19498
 
18591
19499
  </dd>
@@ -18601,7 +19509,7 @@ await client.shipping.tasks.skipV1("task_id");
18601
19509
  <dl>
18602
19510
  <dd>
18603
19511
 
18604
- **taskId:** `string`
19512
+ **driverComplianceDocumentS3ObjectMetadataId:** `string`
18605
19513
 
18606
19514
  </dd>
18607
19515
  </dl>
@@ -18609,7 +19517,7 @@ await client.shipping.tasks.skipV1("task_id");
18609
19517
  <dl>
18610
19518
  <dd>
18611
19519
 
18612
- **requestOptions:** `Tasks.RequestOptions`
19520
+ **requestOptions:** `S3Object.RequestOptions`
18613
19521
 
18614
19522
  </dd>
18615
19523
  </dl>
@@ -18620,7 +19528,7 @@ await client.shipping.tasks.skipV1("task_id");
18620
19528
  </dl>
18621
19529
  </details>
18622
19530
 
18623
- <details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">attemptV1</a>(taskId) -> boolean</code></summary>
19531
+ <details><summary><code>client.shipping.drivers.complianceDocuments.s3Object.<a href="/src/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/Client.ts">addV1</a>(driverComplianceDocumentId, { ...params }) -> boolean</code></summary>
18624
19532
  <dl>
18625
19533
  <dd>
18626
19534
 
@@ -18632,7 +19540,7 @@ await client.shipping.tasks.skipV1("task_id");
18632
19540
  <dl>
18633
19541
  <dd>
18634
19542
 
18635
- Marks a task as ATTEMPT. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators] (depending on type) | () -> (bool)
19543
+ Uploads a file to a driver compliance document. Automatic blurhash generation for images. | authz: allowed_org_types=[provider], min_org_role=administrator | (UploadFile) -> (bool)
18636
19544
 
18637
19545
  </dd>
18638
19546
  </dl>
@@ -18648,7 +19556,9 @@ Marks a task as ATTEMPT. | authz_personas=[driver_for_executor, coordinator_org_
18648
19556
  <dd>
18649
19557
 
18650
19558
  ```typescript
18651
- await client.shipping.tasks.attemptV1("task_id");
19559
+ await client.shipping.drivers.complianceDocuments.s3Object.addV1("driver_compliance_document_id", {
19560
+ file: fs.createReadStream("/path/to/your/file"),
19561
+ });
18652
19562
  ```
18653
19563
 
18654
19564
  </dd>
@@ -18664,7 +19574,7 @@ await client.shipping.tasks.attemptV1("task_id");
18664
19574
  <dl>
18665
19575
  <dd>
18666
19576
 
18667
- **taskId:** `string`
19577
+ **driverComplianceDocumentId:** `string`
18668
19578
 
18669
19579
  </dd>
18670
19580
  </dl>
@@ -18672,7 +19582,15 @@ await client.shipping.tasks.attemptV1("task_id");
18672
19582
  <dl>
18673
19583
  <dd>
18674
19584
 
18675
- **requestOptions:** `Tasks.RequestOptions`
19585
+ **request:** `Chrt.shipping.drivers.complianceDocuments.BodyPostDriverComplianceDocumentsS3ObjectAddV1ShippingDriversComplianceDocumentsS3ObjectAddV1DriverComplianceDocumentIdPost`
19586
+
19587
+ </dd>
19588
+ </dl>
19589
+
19590
+ <dl>
19591
+ <dd>
19592
+
19593
+ **requestOptions:** `S3Object.RequestOptions`
18676
19594
 
18677
19595
  </dd>
18678
19596
  </dl>
@@ -18683,7 +19601,7 @@ await client.shipping.tasks.attemptV1("task_id");
18683
19601
  </dl>
18684
19602
  </details>
18685
19603
 
18686
- <details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">deleteV1</a>(taskId) -> boolean</code></summary>
19604
+ <details><summary><code>client.shipping.drivers.complianceDocuments.s3Object.<a href="/src/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/Client.ts">deleteV1</a>(driverComplianceDocumentS3ObjectMetadataId) -> boolean</code></summary>
18687
19605
  <dl>
18688
19606
  <dd>
18689
19607
 
@@ -18695,7 +19613,7 @@ await client.shipping.tasks.attemptV1("task_id");
18695
19613
  <dl>
18696
19614
  <dd>
18697
19615
 
18698
- Deletes a task. Task must be in STAGED status. | authz_personas=[lig_owner_operators] | () -> (bool)
19616
+ Deletes a driver compliance document S3 object and metadata. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (bool)
18699
19617
 
18700
19618
  </dd>
18701
19619
  </dl>
@@ -18711,7 +19629,7 @@ Deletes a task. Task must be in STAGED status. | authz_personas=[lig_owner_opera
18711
19629
  <dd>
18712
19630
 
18713
19631
  ```typescript
18714
- await client.shipping.tasks.deleteV1("task_id");
19632
+ await client.shipping.drivers.complianceDocuments.s3Object.deleteV1("driver_compliance_document_s3_object_metadata_id");
18715
19633
  ```
18716
19634
 
18717
19635
  </dd>
@@ -18727,7 +19645,7 @@ await client.shipping.tasks.deleteV1("task_id");
18727
19645
  <dl>
18728
19646
  <dd>
18729
19647
 
18730
- **taskId:** `string`
19648
+ **driverComplianceDocumentS3ObjectMetadataId:** `string`
18731
19649
 
18732
19650
  </dd>
18733
19651
  </dl>
@@ -18735,7 +19653,7 @@ await client.shipping.tasks.deleteV1("task_id");
18735
19653
  <dl>
18736
19654
  <dd>
18737
19655
 
18738
- **requestOptions:** `Tasks.RequestOptions`
19656
+ **requestOptions:** `S3Object.RequestOptions`
18739
19657
 
18740
19658
  </dd>
18741
19659
  </dl>