@chrt-inc/typescript-sdk 1.303.0 → 1.304.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 (163) hide show
  1. package/README.md +0 -604
  2. package/dist/cjs/Client.js +2 -2
  3. package/dist/cjs/api/resources/connections/client/Client.d.ts +3 -3
  4. package/dist/cjs/api/resources/connections/client/Client.js +3 -3
  5. package/dist/cjs/api/resources/connections/resources/connectionToCourier/client/Client.d.ts +1 -1
  6. package/dist/cjs/api/resources/connections/resources/connectionToCourier/client/Client.js +1 -1
  7. package/dist/cjs/api/resources/connections/resources/connectionToForwarder/client/Client.d.ts +1 -1
  8. package/dist/cjs/api/resources/connections/resources/connectionToForwarder/client/Client.js +1 -1
  9. package/dist/cjs/api/resources/connections/resources/connectionToShipper/client/Client.d.ts +1 -1
  10. package/dist/cjs/api/resources/connections/resources/connectionToShipper/client/Client.js +1 -1
  11. package/dist/cjs/api/resources/dev/client/Client.d.ts +9 -9
  12. package/dist/cjs/api/resources/dev/client/Client.js +9 -9
  13. package/dist/cjs/api/resources/notifications/resources/courier/client/Client.d.ts +2 -2
  14. package/dist/cjs/api/resources/notifications/resources/courier/client/Client.js +2 -2
  15. package/dist/cjs/api/resources/notifications/resources/shipper/client/Client.d.ts +2 -2
  16. package/dist/cjs/api/resources/notifications/resources/shipper/client/Client.js +2 -2
  17. package/dist/cjs/api/resources/orderDrafts/client/Client.d.ts +27 -0
  18. package/dist/cjs/api/resources/orderDrafts/client/Client.js +125 -0
  19. package/dist/cjs/api/resources/orderDrafts/client/requests/index.d.ts +2 -0
  20. package/dist/cjs/api/resources/orders/client/Client.d.ts +0 -3
  21. package/dist/cjs/api/resources/orders/client/Client.js +0 -5
  22. package/dist/cjs/api/resources/orders/resources/index.d.ts +0 -1
  23. package/dist/cjs/api/resources/orders/resources/index.js +1 -2
  24. package/dist/cjs/api/resources/orgConnectionInfos/resources/courier/client/Client.d.ts +3 -3
  25. package/dist/cjs/api/resources/orgConnectionInfos/resources/courier/client/Client.js +3 -3
  26. package/dist/cjs/api/resources/orgConnectionInfos/resources/shipper/client/Client.d.ts +3 -3
  27. package/dist/cjs/api/resources/orgConnectionInfos/resources/shipper/client/Client.js +3 -3
  28. package/dist/cjs/api/resources/orgProfiles/client/Client.d.ts +7 -7
  29. package/dist/cjs/api/resources/orgProfiles/client/Client.js +7 -7
  30. package/dist/cjs/api/resources/orgs/client/Client.d.ts +8 -8
  31. package/dist/cjs/api/resources/orgs/client/Client.js +7 -7
  32. package/dist/cjs/api/resources/root/client/Client.d.ts +8 -8
  33. package/dist/cjs/api/resources/root/client/Client.js +5 -5
  34. package/dist/cjs/api/resources/taskArtifactNotifications/client/Client.d.ts +2 -2
  35. package/dist/cjs/api/resources/taskArtifactNotifications/client/Client.js +2 -2
  36. package/dist/cjs/api/resources/tracking/resources/cargoByDevice/client/Client.d.ts +1 -1
  37. package/dist/cjs/api/resources/tracking/resources/cargoByDevice/client/Client.js +1 -1
  38. package/dist/cjs/api/resources/tracking/resources/cargoByDriver/client/Client.d.ts +1 -1
  39. package/dist/cjs/api/resources/tracking/resources/cargoByDriver/client/Client.js +1 -1
  40. package/dist/cjs/api/resources/tracking/resources/devices/client/Client.d.ts +7 -7
  41. package/dist/cjs/api/resources/tracking/resources/devices/client/Client.js +7 -7
  42. package/dist/cjs/api/resources/tracking/resources/driver/client/Client.d.ts +2 -2
  43. package/dist/cjs/api/resources/tracking/resources/driver/client/Client.js +1 -1
  44. package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/Client.d.ts +14 -14
  45. package/dist/cjs/api/resources/tracking/resources/sessionByDevice/client/Client.js +14 -14
  46. package/dist/cjs/api/resources/tracking/resources/taskGroupByDriver/client/Client.d.ts +1 -1
  47. package/dist/cjs/api/resources/tracking/resources/taskGroupByDriver/client/Client.js +1 -1
  48. package/dist/cjs/api/resources/users/client/Client.d.ts +1 -1
  49. package/dist/cjs/api/resources/users/client/Client.js +1 -1
  50. package/dist/cjs/api/resources/utils/client/Client.d.ts +1 -1
  51. package/dist/cjs/api/resources/utils/client/Client.js +1 -1
  52. package/dist/cjs/api/types/Cargo1.d.ts +1 -1
  53. package/dist/cjs/api/types/CargoClientCreate1.d.ts +1 -1
  54. package/dist/cjs/api/types/CargoClientUpdate1.d.ts +1 -1
  55. package/dist/{esm/api/types/DriverUpdateResp.d.mts → cjs/api/types/DriverUpdateRes.d.ts} +1 -1
  56. package/dist/cjs/api/types/TaskClientUpdate1.d.ts +0 -1
  57. package/dist/cjs/api/types/index.d.ts +1 -1
  58. package/dist/cjs/api/types/index.js +1 -1
  59. package/dist/cjs/version.d.ts +1 -1
  60. package/dist/cjs/version.js +1 -1
  61. package/dist/esm/Client.mjs +2 -2
  62. package/dist/esm/api/resources/connections/client/Client.d.mts +3 -3
  63. package/dist/esm/api/resources/connections/client/Client.mjs +3 -3
  64. package/dist/esm/api/resources/connections/resources/connectionToCourier/client/Client.d.mts +1 -1
  65. package/dist/esm/api/resources/connections/resources/connectionToCourier/client/Client.mjs +1 -1
  66. package/dist/esm/api/resources/connections/resources/connectionToForwarder/client/Client.d.mts +1 -1
  67. package/dist/esm/api/resources/connections/resources/connectionToForwarder/client/Client.mjs +1 -1
  68. package/dist/esm/api/resources/connections/resources/connectionToShipper/client/Client.d.mts +1 -1
  69. package/dist/esm/api/resources/connections/resources/connectionToShipper/client/Client.mjs +1 -1
  70. package/dist/esm/api/resources/dev/client/Client.d.mts +9 -9
  71. package/dist/esm/api/resources/dev/client/Client.mjs +9 -9
  72. package/dist/esm/api/resources/notifications/resources/courier/client/Client.d.mts +2 -2
  73. package/dist/esm/api/resources/notifications/resources/courier/client/Client.mjs +2 -2
  74. package/dist/esm/api/resources/notifications/resources/shipper/client/Client.d.mts +2 -2
  75. package/dist/esm/api/resources/notifications/resources/shipper/client/Client.mjs +2 -2
  76. package/dist/esm/api/resources/orderDrafts/client/Client.d.mts +27 -0
  77. package/dist/esm/api/resources/orderDrafts/client/Client.mjs +125 -0
  78. package/dist/esm/api/resources/orderDrafts/client/requests/index.d.mts +2 -0
  79. package/dist/esm/api/resources/orders/client/Client.d.mts +0 -3
  80. package/dist/esm/api/resources/orders/client/Client.mjs +0 -5
  81. package/dist/esm/api/resources/orders/resources/index.d.mts +0 -1
  82. package/dist/esm/api/resources/orders/resources/index.mjs +0 -1
  83. package/dist/esm/api/resources/orgConnectionInfos/resources/courier/client/Client.d.mts +3 -3
  84. package/dist/esm/api/resources/orgConnectionInfos/resources/courier/client/Client.mjs +3 -3
  85. package/dist/esm/api/resources/orgConnectionInfos/resources/shipper/client/Client.d.mts +3 -3
  86. package/dist/esm/api/resources/orgConnectionInfos/resources/shipper/client/Client.mjs +3 -3
  87. package/dist/esm/api/resources/orgProfiles/client/Client.d.mts +7 -7
  88. package/dist/esm/api/resources/orgProfiles/client/Client.mjs +7 -7
  89. package/dist/esm/api/resources/orgs/client/Client.d.mts +8 -8
  90. package/dist/esm/api/resources/orgs/client/Client.mjs +7 -7
  91. package/dist/esm/api/resources/root/client/Client.d.mts +8 -8
  92. package/dist/esm/api/resources/root/client/Client.mjs +5 -5
  93. package/dist/esm/api/resources/taskArtifactNotifications/client/Client.d.mts +2 -2
  94. package/dist/esm/api/resources/taskArtifactNotifications/client/Client.mjs +2 -2
  95. package/dist/esm/api/resources/tracking/resources/cargoByDevice/client/Client.d.mts +1 -1
  96. package/dist/esm/api/resources/tracking/resources/cargoByDevice/client/Client.mjs +1 -1
  97. package/dist/esm/api/resources/tracking/resources/cargoByDriver/client/Client.d.mts +1 -1
  98. package/dist/esm/api/resources/tracking/resources/cargoByDriver/client/Client.mjs +1 -1
  99. package/dist/esm/api/resources/tracking/resources/devices/client/Client.d.mts +7 -7
  100. package/dist/esm/api/resources/tracking/resources/devices/client/Client.mjs +7 -7
  101. package/dist/esm/api/resources/tracking/resources/driver/client/Client.d.mts +2 -2
  102. package/dist/esm/api/resources/tracking/resources/driver/client/Client.mjs +1 -1
  103. package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/Client.d.mts +14 -14
  104. package/dist/esm/api/resources/tracking/resources/sessionByDevice/client/Client.mjs +14 -14
  105. package/dist/esm/api/resources/tracking/resources/taskGroupByDriver/client/Client.d.mts +1 -1
  106. package/dist/esm/api/resources/tracking/resources/taskGroupByDriver/client/Client.mjs +1 -1
  107. package/dist/esm/api/resources/users/client/Client.d.mts +1 -1
  108. package/dist/esm/api/resources/users/client/Client.mjs +1 -1
  109. package/dist/esm/api/resources/utils/client/Client.d.mts +1 -1
  110. package/dist/esm/api/resources/utils/client/Client.mjs +1 -1
  111. package/dist/esm/api/types/Cargo1.d.mts +1 -1
  112. package/dist/esm/api/types/CargoClientCreate1.d.mts +1 -1
  113. package/dist/esm/api/types/CargoClientUpdate1.d.mts +1 -1
  114. package/dist/{cjs/api/types/DriverUpdateResp.d.ts → esm/api/types/DriverUpdateRes.d.mts} +1 -1
  115. package/dist/esm/api/types/TaskClientUpdate1.d.mts +0 -1
  116. package/dist/esm/api/types/index.d.mts +1 -1
  117. package/dist/esm/api/types/index.mjs +1 -1
  118. package/dist/esm/version.d.mts +1 -1
  119. package/dist/esm/version.mjs +1 -1
  120. package/package.json +1 -1
  121. package/reference.md +212 -214
  122. package/dist/cjs/api/resources/orders/resources/draft/client/Client.d.ts +0 -23
  123. package/dist/cjs/api/resources/orders/resources/draft/client/Client.js +0 -17
  124. package/dist/cjs/api/resources/orders/resources/draft/client/index.d.ts +0 -1
  125. package/dist/cjs/api/resources/orders/resources/draft/client/index.js +0 -2
  126. package/dist/cjs/api/resources/orders/resources/draft/index.d.ts +0 -2
  127. package/dist/cjs/api/resources/orders/resources/draft/index.js +0 -18
  128. package/dist/cjs/api/resources/orders/resources/draft/resources/expanded/client/Client.d.ts +0 -61
  129. package/dist/cjs/api/resources/orders/resources/draft/resources/expanded/client/Client.js +0 -193
  130. package/dist/cjs/api/resources/orders/resources/draft/resources/expanded/client/index.d.ts +0 -2
  131. package/dist/cjs/api/resources/orders/resources/draft/resources/expanded/client/index.js +0 -17
  132. package/dist/cjs/api/resources/orders/resources/draft/resources/expanded/client/requests/index.d.ts +0 -2
  133. package/dist/cjs/api/resources/orders/resources/draft/resources/expanded/client/requests/index.js +0 -2
  134. package/dist/cjs/api/resources/orders/resources/draft/resources/expanded/index.d.ts +0 -1
  135. package/dist/cjs/api/resources/orders/resources/draft/resources/expanded/index.js +0 -17
  136. package/dist/cjs/api/resources/orders/resources/draft/resources/index.d.ts +0 -2
  137. package/dist/cjs/api/resources/orders/resources/draft/resources/index.js +0 -41
  138. package/dist/esm/api/resources/orders/resources/draft/client/Client.d.mts +0 -23
  139. package/dist/esm/api/resources/orders/resources/draft/client/Client.mjs +0 -13
  140. package/dist/esm/api/resources/orders/resources/draft/client/index.d.mts +0 -1
  141. package/dist/esm/api/resources/orders/resources/draft/client/index.mjs +0 -1
  142. package/dist/esm/api/resources/orders/resources/draft/index.d.mts +0 -2
  143. package/dist/esm/api/resources/orders/resources/draft/index.mjs +0 -2
  144. package/dist/esm/api/resources/orders/resources/draft/resources/expanded/client/Client.d.mts +0 -61
  145. package/dist/esm/api/resources/orders/resources/draft/resources/expanded/client/Client.mjs +0 -156
  146. package/dist/esm/api/resources/orders/resources/draft/resources/expanded/client/index.d.mts +0 -2
  147. package/dist/esm/api/resources/orders/resources/draft/resources/expanded/client/index.mjs +0 -1
  148. package/dist/esm/api/resources/orders/resources/draft/resources/expanded/client/requests/index.d.mts +0 -2
  149. package/dist/esm/api/resources/orders/resources/draft/resources/expanded/client/requests/index.mjs +0 -1
  150. package/dist/esm/api/resources/orders/resources/draft/resources/expanded/index.d.mts +0 -1
  151. package/dist/esm/api/resources/orders/resources/draft/resources/expanded/index.mjs +0 -1
  152. package/dist/esm/api/resources/orders/resources/draft/resources/index.d.mts +0 -2
  153. package/dist/esm/api/resources/orders/resources/draft/resources/index.mjs +0 -2
  154. /package/dist/cjs/api/resources/{orders/resources/draft/resources/expanded → orderDrafts}/client/requests/OrderDraftExpandedListReq.d.ts +0 -0
  155. /package/dist/cjs/api/resources/{orders/resources/draft/resources/expanded → orderDrafts}/client/requests/OrderDraftExpandedListReq.js +0 -0
  156. /package/dist/cjs/api/resources/{orders/resources/draft/resources/expanded → orderDrafts}/client/requests/OrderDraftExpandedReq.d.ts +0 -0
  157. /package/dist/cjs/api/resources/{orders/resources/draft/resources/expanded → orderDrafts}/client/requests/OrderDraftExpandedReq.js +0 -0
  158. /package/dist/cjs/api/types/{DriverUpdateResp.js → DriverUpdateRes.js} +0 -0
  159. /package/dist/esm/api/resources/{orders/resources/draft/resources/expanded → orderDrafts}/client/requests/OrderDraftExpandedListReq.d.mts +0 -0
  160. /package/dist/esm/api/resources/{orders/resources/draft/resources/expanded → orderDrafts}/client/requests/OrderDraftExpandedListReq.mjs +0 -0
  161. /package/dist/esm/api/resources/{orders/resources/draft/resources/expanded → orderDrafts}/client/requests/OrderDraftExpandedReq.d.mts +0 -0
  162. /package/dist/esm/api/resources/{orders/resources/draft/resources/expanded → orderDrafts}/client/requests/OrderDraftExpandedReq.mjs +0 -0
  163. /package/dist/esm/api/types/{DriverUpdateResp.mjs → DriverUpdateRes.mjs} +0 -0
package/reference.md CHANGED
@@ -3062,7 +3062,7 @@ await client.shipperPayCourierStatements.previewV1({
3062
3062
  <dl>
3063
3063
  <dd>
3064
3064
 
3065
- Lists shipper organizations based on the authenticated organization type. Couriers see connected shippers, forwarders see connected shippers.
3065
+ Lists shipper organizations based on the authenticated organization type. Couriers see connected shippers, forwarders see connected shippers. | () -> (list[ShipperConnectionRes])
3066
3066
 
3067
3067
  </dd>
3068
3068
  </dl>
@@ -3117,7 +3117,7 @@ await client.connections.listShippersV1();
3117
3117
  <dl>
3118
3118
  <dd>
3119
3119
 
3120
- Lists courier organizations based on the authenticated organization type. Shippers see connected couriers, forwarders see connected couriers.
3120
+ Lists courier organizations based on the authenticated organization type. Shippers see connected couriers, forwarders see connected couriers. | () -> (list[CourierConnectionRes])
3121
3121
 
3122
3122
  </dd>
3123
3123
  </dl>
@@ -3172,7 +3172,7 @@ await client.connections.listCouriersV1();
3172
3172
  <dl>
3173
3173
  <dd>
3174
3174
 
3175
- Lists forwarder organizations based on the authenticated organization type. Shippers see connected forwarders, couriers see connected forwarders.
3175
+ Lists forwarder organizations based on the authenticated organization type. Shippers see connected forwarders, couriers see connected forwarders. | () -> (list[ForwarderConnectionRes])
3176
3176
 
3177
3177
  </dd>
3178
3178
  </dl>
@@ -3229,7 +3229,7 @@ await client.connections.listForwardersV1();
3229
3229
  <dl>
3230
3230
  <dd>
3231
3231
 
3232
- Retrieves the courier or forwarder organization profile for the authenticated organization.
3232
+ Retrieves the courier or forwarder organization profile for the authenticated organization. | () -> (OrgProfileRes1)
3233
3233
 
3234
3234
  </dd>
3235
3235
  </dl>
@@ -3284,7 +3284,7 @@ await client.orgProfiles.getV1();
3284
3284
  <dl>
3285
3285
  <dd>
3286
3286
 
3287
- Creates a new courier organization profile. Fails if a profile already exists for the organization.
3287
+ Creates a new courier organization profile. Fails if a profile already exists for the organization. | (CourierOrgProfileClientCreate1) -> (PydanticObjectId)
3288
3288
 
3289
3289
  </dd>
3290
3290
  </dl>
@@ -3352,7 +3352,7 @@ await client.orgProfiles.createCourierV1({
3352
3352
  <dl>
3353
3353
  <dd>
3354
3354
 
3355
- Creates a new forwarder organization profile. Fails if a profile already exists for the organization.
3355
+ Creates a new forwarder organization profile. Fails if a profile already exists for the organization. | (ForwarderOrgProfileClientCreate1) -> (PydanticObjectId)
3356
3356
 
3357
3357
  </dd>
3358
3358
  </dl>
@@ -3420,7 +3420,7 @@ await client.orgProfiles.createForwarderV1({
3420
3420
  <dl>
3421
3421
  <dd>
3422
3422
 
3423
- Updates an existing courier organization profile. Can update one or more fields.
3423
+ Updates an existing courier organization profile. Can update one or more fields. | (CourierOrgProfileClientUpdate1) -> (bool)
3424
3424
 
3425
3425
  </dd>
3426
3426
  </dl>
@@ -3483,7 +3483,7 @@ await client.orgProfiles.updateCourierV1();
3483
3483
  <dl>
3484
3484
  <dd>
3485
3485
 
3486
- Updates an existing forwarder organization profile. Can update one or more fields.
3486
+ Updates an existing forwarder organization profile. Can update one or more fields. | (ForwarderOrgProfileClientUpdate1) -> (bool)
3487
3487
 
3488
3488
  </dd>
3489
3489
  </dl>
@@ -3546,7 +3546,7 @@ await client.orgProfiles.updateForwarderV1();
3546
3546
  <dl>
3547
3547
  <dd>
3548
3548
 
3549
- Retrieves a courier or forwarder organization profile using the organization's handle for public profile viewing.
3549
+ Retrieves a courier or forwarder organization profile using the organization's handle for public profile viewing. | () -> (OrgProfileRes1)
3550
3550
 
3551
3551
  </dd>
3552
3552
  </dl>
@@ -3609,7 +3609,7 @@ await client.orgProfiles.getByHandleV1("handle");
3609
3609
  <dl>
3610
3610
  <dd>
3611
3611
 
3612
- Returns the organization avatar image URL from Clerk or a placeholder if not found.
3612
+ Returns the organization avatar image URL from Clerk or a placeholder if not found. | () -> (str)
3613
3613
 
3614
3614
  </dd>
3615
3615
  </dl>
@@ -3674,7 +3674,7 @@ await client.orgProfiles.getAvatarV1("handle");
3674
3674
  <dl>
3675
3675
  <dd>
3676
3676
 
3677
- Experimental endpoint for running AI agentic workflows. Returns the authenticated user's ID for testing purposes.
3677
+ Experimental endpoint for running AI agentic workflows. Returns the authenticated user's ID for testing purposes. | () -> (str)
3678
3678
 
3679
3679
  </dd>
3680
3680
  </dl>
@@ -3729,7 +3729,7 @@ await client.dev.getAgentV1();
3729
3729
  <dl>
3730
3730
  <dd>
3731
3731
 
3732
- (DEPRECATED) Extracts and returns the user ID from the authenticated request's JWT token.
3732
+ (DEPRECATED) Extracts and returns the user ID from the authenticated request's JWT token. | () -> (str)
3733
3733
 
3734
3734
  </dd>
3735
3735
  </dl>
@@ -3784,7 +3784,7 @@ await client.dev.getUserIdV1();
3784
3784
  <dl>
3785
3785
  <dd>
3786
3786
 
3787
- Extracts and returns the user ID from the authenticated request's JWT token.
3787
+ Extracts and returns the user ID from the authenticated request's JWT token. | () -> (str)
3788
3788
 
3789
3789
  </dd>
3790
3790
  </dl>
@@ -3839,7 +3839,7 @@ await client.dev.getUserIdV2();
3839
3839
  <dl>
3840
3840
  <dd>
3841
3841
 
3842
- Returns the complete decoded JWT token information for development purposes.
3842
+ Returns the complete decoded JWT token information for development purposes. | () -> (DecodedJWTWithOrgAndUserId)
3843
3843
 
3844
3844
  </dd>
3845
3845
  </dl>
@@ -3894,7 +3894,7 @@ await client.dev.getDecodedJwtV1();
3894
3894
  <dl>
3895
3895
  <dd>
3896
3896
 
3897
- Retrieves the primary email address for the authenticated user from the authentication service.
3897
+ Retrieves the primary email address for the authenticated user from the authentication service. | () -> (str)
3898
3898
 
3899
3899
  </dd>
3900
3900
  </dl>
@@ -3949,7 +3949,7 @@ await client.dev.getEmailV1();
3949
3949
  <dl>
3950
3950
  <dd>
3951
3951
 
3952
- Experimental endpoint for running durable execution workflows. Returns the authenticated user's ID for testing purposes.
3952
+ Experimental endpoint for running durable execution workflows. Returns the authenticated user's ID for testing purposes. | () -> (dict[str, Any])
3953
3953
 
3954
3954
  </dd>
3955
3955
  </dl>
@@ -4004,7 +4004,7 @@ await client.dev.getDurableV1();
4004
4004
  <dl>
4005
4005
  <dd>
4006
4006
 
4007
- Development template endpoint that returns the authenticated user's ID for testing.
4007
+ Development template endpoint that returns the authenticated user's ID for testing. | () -> (str)
4008
4008
 
4009
4009
  </dd>
4010
4010
  </dl>
@@ -4059,7 +4059,7 @@ await client.dev.getTemplateV1();
4059
4059
  <dl>
4060
4060
  <dd>
4061
4061
 
4062
- Development template endpoint that demonstrates transaction handling and request mirroring.
4062
+ Development template endpoint that demonstrates transaction handling and request mirroring. | (TemplateReq) -> (TemplateRes)
4063
4063
 
4064
4064
  </dd>
4065
4065
  </dl>
@@ -4126,7 +4126,7 @@ await client.dev.createTemplateV1({
4126
4126
  <dl>
4127
4127
  <dd>
4128
4128
 
4129
- Returns the current GitHub PR number and commit hash for the deployment.
4129
+ Returns the current GitHub PR number and commit hash for the deployment. | () -> (dict[str, str])
4130
4130
 
4131
4131
  </dd>
4132
4132
  </dl>
@@ -4183,7 +4183,7 @@ await client.dev.getGitInfoV1();
4183
4183
  <dl>
4184
4184
  <dd>
4185
4185
 
4186
- Retrieves task_artifact notification preferences for the authenticated organization.
4186
+ Retrieves task_artifact notification preferences for the authenticated organization. | () -> (TaskArtifactNotificationPreferences1)
4187
4187
 
4188
4188
  </dd>
4189
4189
  </dl>
@@ -4238,7 +4238,7 @@ await client.taskArtifactNotifications.getPreferencesV1();
4238
4238
  <dl>
4239
4239
  <dd>
4240
4240
 
4241
- Creates or updates task_artifact notification preferences for the authenticated organization.
4241
+ Creates or updates task_artifact notification preferences for the authenticated organization. | (TaskArtifactNotificationPreferencesClientCreate1) -> (PydanticObjectId)
4242
4242
 
4243
4243
  </dd>
4244
4244
  </dl>
@@ -5690,6 +5690,140 @@ await client.orderDrafts.deleteV1("order_id");
5690
5690
  </dl>
5691
5691
  </details>
5692
5692
 
5693
+ <details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">expandedV1</a>(orderIdOrShortId, { ...params }) -> Chrt.OrderDraftExpandedRes</code></summary>
5694
+ <dl>
5695
+ <dd>
5696
+
5697
+ #### 📝 Description
5698
+
5699
+ <dl>
5700
+ <dd>
5701
+
5702
+ <dl>
5703
+ <dd>
5704
+
5705
+ Fetches a single draft order with optional expanded related data. Only the creator of the draft order can access it.
5706
+
5707
+ </dd>
5708
+ </dl>
5709
+ </dd>
5710
+ </dl>
5711
+
5712
+ #### 🔌 Usage
5713
+
5714
+ <dl>
5715
+ <dd>
5716
+
5717
+ <dl>
5718
+ <dd>
5719
+
5720
+ ```typescript
5721
+ await client.orderDrafts.expandedV1("order_id_or_short_id");
5722
+ ```
5723
+
5724
+ </dd>
5725
+ </dl>
5726
+ </dd>
5727
+ </dl>
5728
+
5729
+ #### ⚙️ Parameters
5730
+
5731
+ <dl>
5732
+ <dd>
5733
+
5734
+ <dl>
5735
+ <dd>
5736
+
5737
+ **orderIdOrShortId:** `string`
5738
+
5739
+ </dd>
5740
+ </dl>
5741
+
5742
+ <dl>
5743
+ <dd>
5744
+
5745
+ **request:** `Chrt.OrderDraftExpandedReq`
5746
+
5747
+ </dd>
5748
+ </dl>
5749
+
5750
+ <dl>
5751
+ <dd>
5752
+
5753
+ **requestOptions:** `OrderDrafts.RequestOptions`
5754
+
5755
+ </dd>
5756
+ </dl>
5757
+ </dd>
5758
+ </dl>
5759
+
5760
+ </dd>
5761
+ </dl>
5762
+ </details>
5763
+
5764
+ <details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">expandedListV1</a>({ ...params }) -> Chrt.OrderDraftExpandedListRes</code></summary>
5765
+ <dl>
5766
+ <dd>
5767
+
5768
+ #### 📝 Description
5769
+
5770
+ <dl>
5771
+ <dd>
5772
+
5773
+ <dl>
5774
+ <dd>
5775
+
5776
+ Lists all draft orders created by the authenticated user with optional expanded related data.
5777
+
5778
+ </dd>
5779
+ </dl>
5780
+ </dd>
5781
+ </dl>
5782
+
5783
+ #### 🔌 Usage
5784
+
5785
+ <dl>
5786
+ <dd>
5787
+
5788
+ <dl>
5789
+ <dd>
5790
+
5791
+ ```typescript
5792
+ await client.orderDrafts.expandedListV1();
5793
+ ```
5794
+
5795
+ </dd>
5796
+ </dl>
5797
+ </dd>
5798
+ </dl>
5799
+
5800
+ #### ⚙️ Parameters
5801
+
5802
+ <dl>
5803
+ <dd>
5804
+
5805
+ <dl>
5806
+ <dd>
5807
+
5808
+ **request:** `Chrt.OrderDraftExpandedListReq`
5809
+
5810
+ </dd>
5811
+ </dl>
5812
+
5813
+ <dl>
5814
+ <dd>
5815
+
5816
+ **requestOptions:** `OrderDrafts.RequestOptions`
5817
+
5818
+ </dd>
5819
+ </dl>
5820
+ </dd>
5821
+ </dl>
5822
+
5823
+ </dd>
5824
+ </dl>
5825
+ </details>
5826
+
5693
5827
  <details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">validateV1</a>(orderId) -> boolean</code></summary>
5694
5828
  <dl>
5695
5829
  <dd>
@@ -6524,7 +6658,7 @@ await client.shipperContactInfo.deleteByIdV1("id");
6524
6658
 
6525
6659
  ## Orgs
6526
6660
 
6527
- <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getInfoV1</a>() -> unknown</code></summary>
6661
+ <details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getInfoV1</a>() -> Record<string, unknown></code></summary>
6528
6662
  <dl>
6529
6663
  <dd>
6530
6664
 
@@ -6536,7 +6670,7 @@ await client.shipperContactInfo.deleteByIdV1("id");
6536
6670
  <dl>
6537
6671
  <dd>
6538
6672
 
6539
- Retrieves basic organization information from the authentication service.
6673
+ Retrieves basic organization information from the authentication service. | () -> (dict)
6540
6674
 
6541
6675
  </dd>
6542
6676
  </dl>
@@ -6591,7 +6725,7 @@ await client.orgs.getInfoV1();
6591
6725
  <dl>
6592
6726
  <dd>
6593
6727
 
6594
- Lists all members of the authenticated organization with their roles and details.
6728
+ Lists all members of the authenticated organization with their roles and details. | () -> (list[OrgMemberDetails])
6595
6729
 
6596
6730
  </dd>
6597
6731
  </dl>
@@ -6646,7 +6780,7 @@ await client.orgs.listMembersV1();
6646
6780
  <dl>
6647
6781
  <dd>
6648
6782
 
6649
- Retrieves public organization data for the authenticated organization.
6783
+ Retrieves public organization data for the authenticated organization. | () -> (OrgPublicData1)
6650
6784
 
6651
6785
  </dd>
6652
6786
  </dl>
@@ -6701,7 +6835,7 @@ await client.orgs.getOrgPublicDataV1();
6701
6835
  <dl>
6702
6836
  <dd>
6703
6837
 
6704
- Creates an org_public_data document for the authenticated organization.
6838
+ Creates an org_public_data document for the authenticated organization. | (CreateOrgPublicDataReq) -> (PydanticObjectId)
6705
6839
 
6706
6840
  </dd>
6707
6841
  </dl>
@@ -6766,7 +6900,7 @@ await client.orgs.createOrgPublicDataV1({
6766
6900
  <dl>
6767
6901
  <dd>
6768
6902
 
6769
- Updates the handle and/or company_name for the authenticated organization.
6903
+ Updates the handle and/or company_name for the authenticated organization. | (UpdateOrgPublicDataReq) -> (bool)
6770
6904
 
6771
6905
  </dd>
6772
6906
  </dl>
@@ -6829,7 +6963,7 @@ await client.orgs.updateOrgPublicDataV1();
6829
6963
  <dl>
6830
6964
  <dd>
6831
6965
 
6832
- Retrieves public organization data for a specific organization by ID.
6966
+ Retrieves public organization data for a specific organization by ID. | () -> (OrgPublicData1)
6833
6967
 
6834
6968
  </dd>
6835
6969
  </dl>
@@ -6892,7 +7026,7 @@ await client.orgs.getOrgPublicDataByOrgIdV1("org_id");
6892
7026
  <dl>
6893
7027
  <dd>
6894
7028
 
6895
- Returns True when the provided handle is available, otherwise False.
7029
+ Returns True when the provided handle is available, otherwise False. | () -> (bool)
6896
7030
 
6897
7031
  </dd>
6898
7032
  </dl>
@@ -6957,7 +7091,7 @@ await client.orgs.getOrgPublicDataHandleAvailabilityV1("handle");
6957
7091
  <dl>
6958
7092
  <dd>
6959
7093
 
6960
- Test endpoint for authenticated requests that requires valid authentication tokens.
7094
+ Test endpoint for authenticated requests that requires valid authentication tokens. | () -> (dict[str, str])
6961
7095
 
6962
7096
  </dd>
6963
7097
  </dl>
@@ -7000,7 +7134,7 @@ await client.root.pingAuthd();
7000
7134
  </dl>
7001
7135
  </details>
7002
7136
 
7003
- <details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">pingOptionallyAuthd</a>() -> unknown</code></summary>
7137
+ <details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">pingOptionallyAuthd</a>() -> Record<string, unknown></code></summary>
7004
7138
  <dl>
7005
7139
  <dd>
7006
7140
 
@@ -7012,7 +7146,7 @@ await client.root.pingAuthd();
7012
7146
  <dl>
7013
7147
  <dd>
7014
7148
 
7015
- Test endpoint for optionally authenticated requests that works with or without authentication.
7149
+ Test endpoint for optionally authenticated requests that works with or without authentication. | () -> (dict)
7016
7150
 
7017
7151
  </dd>
7018
7152
  </dl>
@@ -7055,7 +7189,7 @@ await client.root.pingOptionallyAuthd();
7055
7189
  </dl>
7056
7190
  </details>
7057
7191
 
7058
- <details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">pingUnauthd</a>() -> unknown</code></summary>
7192
+ <details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">pingUnauthd</a>() -> Record<string, unknown></code></summary>
7059
7193
  <dl>
7060
7194
  <dd>
7061
7195
 
@@ -7067,7 +7201,7 @@ await client.root.pingOptionallyAuthd();
7067
7201
  <dl>
7068
7202
  <dd>
7069
7203
 
7070
- Returns a greeting message to verify the API is accessible.
7204
+ Returns a greeting message to verify the API is accessible. | () -> (dict)
7071
7205
 
7072
7206
  </dd>
7073
7207
  </dl>
@@ -7110,7 +7244,7 @@ await client.root.pingUnauthd();
7110
7244
  </dl>
7111
7245
  </details>
7112
7246
 
7113
- <details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">health</a>() -> unknown</code></summary>
7247
+ <details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">health</a>() -> Record<string, unknown></code></summary>
7114
7248
  <dl>
7115
7249
  <dd>
7116
7250
 
@@ -7122,7 +7256,7 @@ await client.root.pingUnauthd();
7122
7256
  <dl>
7123
7257
  <dd>
7124
7258
 
7125
- Returns a health status message used for monitoring system availability and uptime.
7259
+ Returns a health status message used for monitoring system availability and uptime. | () -> (dict)
7126
7260
 
7127
7261
  </dd>
7128
7262
  </dl>
@@ -7177,7 +7311,7 @@ await client.root.health();
7177
7311
  <dl>
7178
7312
  <dd>
7179
7313
 
7180
- Test endpoint that intentionally fails for error handling validation and monitoring purposes.
7314
+ Test endpoint that intentionally fails for error handling validation and monitoring purposes. | () -> (None)
7181
7315
 
7182
7316
  </dd>
7183
7317
  </dl>
@@ -7234,7 +7368,7 @@ await client.root.failure();
7234
7368
  <dl>
7235
7369
  <dd>
7236
7370
 
7237
- Retrieves public user data for the authenticated user, including email, notes, and Stripe customer information.
7371
+ Retrieves public user data for the authenticated user, including email, notes, and Stripe customer information. | () -> (UserPublicData1)
7238
7372
 
7239
7373
  </dd>
7240
7374
  </dl>
@@ -7291,7 +7425,7 @@ await client.users.getPublicDataV1();
7291
7425
  <dl>
7292
7426
  <dd>
7293
7427
 
7294
- Returns the IANA timezone identifier (e.g., 'America/Los_Angeles') for the given latitude and longitude coordinates. Falls back to closest timezone if the point is in the ocean or at an edge.
7428
+ Returns the IANA timezone identifier (e.g., 'America/Los_Angeles') for the given latitude and longitude coordinates. Falls back to closest timezone if the point is in the ocean or at an edge. | () -> (TimezoneResponse)
7295
7429
 
7296
7430
  </dd>
7297
7431
  </dl>
@@ -7359,7 +7493,7 @@ await client.utils.getTimezoneV1({
7359
7493
  <dl>
7360
7494
  <dd>
7361
7495
 
7362
- Creates a new connection to a courier organization. Shippers and forwarders can initiate connections to couriers.
7496
+ Creates a new connection to a courier organization. Shippers and forwarders can initiate connections to couriers. | (CreateConnectionReq) -> (PydanticObjectId)
7363
7497
 
7364
7498
  </dd>
7365
7499
  </dl>
@@ -7426,7 +7560,7 @@ await client.connections.connectionToCourier.createV1({
7426
7560
  <dl>
7427
7561
  <dd>
7428
7562
 
7429
- Creates a new connection to a shipper organization. Only forwarders can initiate connections to shippers.
7563
+ Creates a new connection to a shipper organization. Only forwarders can initiate connections to shippers. | (CreateConnectionReq) -> (PydanticObjectId)
7430
7564
 
7431
7565
  </dd>
7432
7566
  </dl>
@@ -7493,7 +7627,7 @@ await client.connections.connectionToShipper.createV1({
7493
7627
  <dl>
7494
7628
  <dd>
7495
7629
 
7496
- Creates a new connection to a forwarder organization. Only shippers can initiate connections to forwarders.
7630
+ Creates a new connection to a forwarder organization. Only shippers can initiate connections to forwarders. | (CreateConnectionReq) -> (PydanticObjectId)
7497
7631
 
7498
7632
  </dd>
7499
7633
  </dl>
@@ -7717,7 +7851,7 @@ await client.courierPayDriverLineItemGroups.removeLineItems.byIdV1("id", {
7717
7851
  <dl>
7718
7852
  <dd>
7719
7853
 
7720
- Retrieves notification preferences for the authenticated shipper organization.
7854
+ Retrieves notification preferences for the authenticated shipper organization. | () -> (ShipperNotificationPreferences1)
7721
7855
 
7722
7856
  </dd>
7723
7857
  </dl>
@@ -7772,7 +7906,7 @@ await client.notifications.shipper.getPreferencesV1();
7772
7906
  <dl>
7773
7907
  <dd>
7774
7908
 
7775
- Creates or updates notification preferences for the authenticated shipper organization.
7909
+ Creates or updates notification preferences for the authenticated shipper organization. | (ShipperNotificationPreferencesClientCreate1) -> (PydanticObjectId)
7776
7910
 
7777
7911
  </dd>
7778
7912
  </dl>
@@ -7839,7 +7973,7 @@ await client.notifications.shipper.upsertPreferencesV1({
7839
7973
  <dl>
7840
7974
  <dd>
7841
7975
 
7842
- Retrieves notification preferences for the authenticated courier organization.
7976
+ Retrieves notification preferences for the authenticated courier organization. | () -> (CourierNotificationPreferences1)
7843
7977
 
7844
7978
  </dd>
7845
7979
  </dl>
@@ -7894,7 +8028,7 @@ await client.notifications.courier.getPreferencesV1();
7894
8028
  <dl>
7895
8029
  <dd>
7896
8030
 
7897
- Creates or updates notification preferences for the authenticated courier organization.
8031
+ Creates or updates notification preferences for the authenticated courier organization. | (CourierNotificationPreferencesClientCreate1) -> (PydanticObjectId)
7898
8032
 
7899
8033
  </dd>
7900
8034
  </dl>
@@ -8965,142 +9099,6 @@ await client.orders.expandedList.postOrderCreatorExpandedListV1({
8965
9099
  </dl>
8966
9100
  </details>
8967
9101
 
8968
- ## Orders Draft Expanded
8969
-
8970
- <details><summary><code>client.orders.draft.expanded.<a href="/src/api/resources/orders/resources/draft/resources/expanded/client/Client.ts">postExpandedV1</a>(orderIdOrShortId, { ...params }) -> Chrt.OrderDraftExpandedRes</code></summary>
8971
- <dl>
8972
- <dd>
8973
-
8974
- #### 📝 Description
8975
-
8976
- <dl>
8977
- <dd>
8978
-
8979
- <dl>
8980
- <dd>
8981
-
8982
- Fetches a single draft order with optional expanded related data. Only the creator of the draft order can access it.
8983
-
8984
- </dd>
8985
- </dl>
8986
- </dd>
8987
- </dl>
8988
-
8989
- #### 🔌 Usage
8990
-
8991
- <dl>
8992
- <dd>
8993
-
8994
- <dl>
8995
- <dd>
8996
-
8997
- ```typescript
8998
- await client.orders.draft.expanded.postExpandedV1("order_id_or_short_id");
8999
- ```
9000
-
9001
- </dd>
9002
- </dl>
9003
- </dd>
9004
- </dl>
9005
-
9006
- #### ⚙️ Parameters
9007
-
9008
- <dl>
9009
- <dd>
9010
-
9011
- <dl>
9012
- <dd>
9013
-
9014
- **orderIdOrShortId:** `string`
9015
-
9016
- </dd>
9017
- </dl>
9018
-
9019
- <dl>
9020
- <dd>
9021
-
9022
- **request:** `Chrt.orders.draft.OrderDraftExpandedReq`
9023
-
9024
- </dd>
9025
- </dl>
9026
-
9027
- <dl>
9028
- <dd>
9029
-
9030
- **requestOptions:** `Expanded.RequestOptions`
9031
-
9032
- </dd>
9033
- </dl>
9034
- </dd>
9035
- </dl>
9036
-
9037
- </dd>
9038
- </dl>
9039
- </details>
9040
-
9041
- <details><summary><code>client.orders.draft.expanded.<a href="/src/api/resources/orders/resources/draft/resources/expanded/client/Client.ts">postExpandedListV1</a>({ ...params }) -> Chrt.OrderDraftExpandedListRes</code></summary>
9042
- <dl>
9043
- <dd>
9044
-
9045
- #### 📝 Description
9046
-
9047
- <dl>
9048
- <dd>
9049
-
9050
- <dl>
9051
- <dd>
9052
-
9053
- Lists all draft orders created by the authenticated user with optional expanded related data.
9054
-
9055
- </dd>
9056
- </dl>
9057
- </dd>
9058
- </dl>
9059
-
9060
- #### 🔌 Usage
9061
-
9062
- <dl>
9063
- <dd>
9064
-
9065
- <dl>
9066
- <dd>
9067
-
9068
- ```typescript
9069
- await client.orders.draft.expanded.postExpandedListV1();
9070
- ```
9071
-
9072
- </dd>
9073
- </dl>
9074
- </dd>
9075
- </dl>
9076
-
9077
- #### ⚙️ Parameters
9078
-
9079
- <dl>
9080
- <dd>
9081
-
9082
- <dl>
9083
- <dd>
9084
-
9085
- **request:** `Chrt.orders.draft.OrderDraftExpandedListReq`
9086
-
9087
- </dd>
9088
- </dl>
9089
-
9090
- <dl>
9091
- <dd>
9092
-
9093
- **requestOptions:** `Expanded.RequestOptions`
9094
-
9095
- </dd>
9096
- </dl>
9097
- </dd>
9098
- </dl>
9099
-
9100
- </dd>
9101
- </dl>
9102
- </details>
9103
-
9104
9102
  ## OrgConnectionInfos Shipper
9105
9103
 
9106
9104
  <details><summary><code>client.orgConnectionInfos.shipper.<a href="/src/api/resources/orgConnectionInfos/resources/shipper/client/Client.ts">getV1</a>() -> Chrt.ShipperOrgInfoForConnections1</code></summary>
@@ -9115,7 +9113,7 @@ await client.orders.draft.expanded.postExpandedListV1();
9115
9113
  <dl>
9116
9114
  <dd>
9117
9115
 
9118
- Retrieves shipper organization connection information for the authenticated organization.
9116
+ Retrieves shipper organization connection information for the authenticated organization. | () -> (ShipperOrgInfoForConnections1)
9119
9117
 
9120
9118
  </dd>
9121
9119
  </dl>
@@ -9170,7 +9168,7 @@ await client.orgConnectionInfos.shipper.getV1();
9170
9168
  <dl>
9171
9169
  <dd>
9172
9170
 
9173
- Creates shipper organization connection information. Fails if already exists.
9171
+ Creates shipper organization connection information. Fails if already exists. | (ShipperOrgInfoForConnectionsClientCreate1) -> (PydanticObjectId)
9174
9172
 
9175
9173
  </dd>
9176
9174
  </dl>
@@ -9236,7 +9234,7 @@ await client.orgConnectionInfos.shipper.createV1({
9236
9234
  <dl>
9237
9235
  <dd>
9238
9236
 
9239
- Updates existing shipper organization connection information.
9237
+ Updates existing shipper organization connection information. | (ShipperOrgInfoForConnectionsClientUpdate1) -> (bool)
9240
9238
 
9241
9239
  </dd>
9242
9240
  </dl>
@@ -9301,7 +9299,7 @@ await client.orgConnectionInfos.shipper.updateV1();
9301
9299
  <dl>
9302
9300
  <dd>
9303
9301
 
9304
- Retrieves courier organization connection information for the authenticated organization.
9302
+ Retrieves courier organization connection information for the authenticated organization. | () -> (CourierOrgInfoForConnections1)
9305
9303
 
9306
9304
  </dd>
9307
9305
  </dl>
@@ -9356,7 +9354,7 @@ await client.orgConnectionInfos.courier.getV1();
9356
9354
  <dl>
9357
9355
  <dd>
9358
9356
 
9359
- Creates courier organization connection information. Fails if already exists.
9357
+ Creates courier organization connection information. Fails if already exists. | (CourierOrgInfoForConnectionsClientCreate1) -> (PydanticObjectId)
9360
9358
 
9361
9359
  </dd>
9362
9360
  </dl>
@@ -9422,7 +9420,7 @@ await client.orgConnectionInfos.courier.createV1({
9422
9420
  <dl>
9423
9421
  <dd>
9424
9422
 
9425
- Updates existing courier organization connection information.
9423
+ Updates existing courier organization connection information. | (CourierOrgInfoForConnectionsClientUpdate1) -> (bool)
9426
9424
 
9427
9425
  </dd>
9428
9426
  </dl>
@@ -10523,7 +10521,7 @@ await client.taskGroups.expandedList.forCourierDriverV1({
10523
10521
  <dl>
10524
10522
  <dd>
10525
10523
 
10526
- Returns the most recent device location data point for cargo within a task group. Access granted to courier or shipper organization.
10524
+ Returns the most recent device location data point for cargo within a task group. Access granted to courier or shipper organization. | () -> (TrackingCargoByDeviceDataPoint1 | None)
10527
10525
 
10528
10526
  </dd>
10529
10527
  </dl>
@@ -10591,7 +10589,7 @@ await client.tracking.cargoByDevice.lastSeenV1({
10591
10589
  <dl>
10592
10590
  <dd>
10593
10591
 
10594
- Returns the most recent driver location data point for cargo within a task group. Access granted to courier or shipper organization. Data written by the driver update endpoint.
10592
+ Returns the most recent driver location data point for cargo within a task group. Access granted to courier or shipper organization. Data written by the driver update endpoint. | () -> (TrackingCargoByDriverDataPoint1 | None)
10595
10593
 
10596
10594
  </dd>
10597
10595
  </dl>
@@ -10659,7 +10657,7 @@ await client.tracking.cargoByDriver.lastSeenV1({
10659
10657
  <dl>
10660
10658
  <dd>
10661
10659
 
10662
- Registers a tracking device to the authenticated user's organization. If device is already registered to a different organization, registration is blocked.
10660
+ Registers a tracking device to the authenticated user's organization. If device is already registered to a different organization, registration is blocked. | (DevicesRegisterToOrgReq1) -> (PydanticObjectId)
10663
10661
 
10664
10662
  </dd>
10665
10663
  </dl>
@@ -10724,7 +10722,7 @@ await client.tracking.devices.registerToOrgV1({
10724
10722
  <dl>
10725
10723
  <dd>
10726
10724
 
10727
- Updates a device's type and/or comments. Can update one or both fields, or delete them by setting delete flags.
10725
+ Updates a device's type and/or comments. Can update one or both fields, or delete them by setting delete flags. | (DevicesUpdateRequest1) -> (bool)
10728
10726
 
10729
10727
  </dd>
10730
10728
  </dl>
@@ -10787,7 +10785,7 @@ await client.tracking.devices.updateV1();
10787
10785
  <dl>
10788
10786
  <dd>
10789
10787
 
10790
- Deletes a device by ID or MAC address. Device must be unlinked from any session or cargo before deletion.
10788
+ Deletes a device by ID or MAC address. Device must be unlinked from any session or cargo before deletion. | () -> (bool)
10791
10789
 
10792
10790
  </dd>
10793
10791
  </dl>
@@ -10853,7 +10851,7 @@ await client.tracking.devices.deleteV1({
10853
10851
  <dl>
10854
10852
  <dd>
10855
10853
 
10856
- Retrieves a single device by its MAC address or ID. Access restricted to the device's organization.
10854
+ Retrieves a single device by its MAC address or ID. Access restricted to the device's organization. | () -> (Device1)
10857
10855
 
10858
10856
  </dd>
10859
10857
  </dl>
@@ -10919,7 +10917,7 @@ await client.tracking.devices.getV1({
10919
10917
  <dl>
10920
10918
  <dd>
10921
10919
 
10922
- Returns all tracking devices registered to the authenticated user's organization.
10920
+ Returns all tracking devices registered to the authenticated user's organization. | () -> (list[Device1])
10923
10921
 
10924
10922
  </dd>
10925
10923
  </dl>
@@ -10974,7 +10972,7 @@ await client.tracking.devices.listV1();
10974
10972
  <dl>
10975
10973
  <dd>
10976
10974
 
10977
- Links a device to cargo with bidirectional references. Device must not already be linked to a session or different cargo.
10975
+ Links a device to cargo with bidirectional references. Device must not already be linked to a session or different cargo. | () -> (bool)
10978
10976
 
10979
10977
  </dd>
10980
10978
  </dl>
@@ -11040,7 +11038,7 @@ await client.tracking.devices.linkToCargoV1({
11040
11038
  <dl>
11041
11039
  <dd>
11042
11040
 
11043
- Unlinks a device from its linked cargo, removing the bidirectional reference. Returns false if device is not linked to any cargo.
11041
+ Unlinks a device from its linked cargo, removing the bidirectional reference. Returns false if device is not linked to any cargo. | () -> (bool)
11044
11042
 
11045
11043
  </dd>
11046
11044
  </dl>
@@ -11095,7 +11093,7 @@ await client.tracking.devices.unlinkFromCargoV1({
11095
11093
 
11096
11094
  ## Tracking Driver
11097
11095
 
11098
- <details><summary><code>client.tracking.driver.<a href="/src/api/resources/tracking/resources/driver/client/Client.ts">updateV1</a>({ ...params }) -> Chrt.DriverUpdateResp</code></summary>
11096
+ <details><summary><code>client.tracking.driver.<a href="/src/api/resources/tracking/resources/driver/client/Client.ts">updateV1</a>({ ...params }) -> Chrt.DriverUpdateRes</code></summary>
11099
11097
  <dl>
11100
11098
  <dd>
11101
11099
 
@@ -11107,7 +11105,7 @@ await client.tracking.devices.unlinkFromCargoV1({
11107
11105
  <dl>
11108
11106
  <dd>
11109
11107
 
11110
- Records driver location updates for a task group. Automatically writes to task group tracking if IN_PROGRESS and cargo tracking if IN_TRANSIT. Updates driver's last seen timestamp and location.
11108
+ Records driver location updates for a task group. Automatically writes to task group tracking if IN_PROGRESS and cargo tracking if IN_TRANSIT. Updates driver's last seen timestamp and location. | (DriverUpdateReq) -> (DriverUpdateRes)
11111
11109
 
11112
11110
  </dd>
11113
11111
  </dl>
@@ -11187,7 +11185,7 @@ await client.tracking.driver.updateV1({
11187
11185
  <dl>
11188
11186
  <dd>
11189
11187
 
11190
- Returns all tracking sessions for the authenticated user's organization.
11188
+ Returns all tracking sessions for the authenticated user's organization. | () -> (list[Session1])
11191
11189
 
11192
11190
  </dd>
11193
11191
  </dl>
@@ -11242,7 +11240,7 @@ await client.tracking.sessionByDevice.listV1();
11242
11240
  <dl>
11243
11241
  <dd>
11244
11242
 
11245
- Retrieves a single session by its ID. Access restricted to the session's organization.
11243
+ Retrieves a single session by its ID. Access restricted to the session's organization. | () -> (Session1)
11246
11244
 
11247
11245
  </dd>
11248
11246
  </dl>
@@ -11307,7 +11305,7 @@ await client.tracking.sessionByDevice.getV1({
11307
11305
  <dl>
11308
11306
  <dd>
11309
11307
 
11310
- Returns the most recent data point for a session, excluding outliers. Access restricted to the session's organization.
11308
+ Returns the most recent data point for a session, excluding outliers. Access restricted to the session's organization. | () -> (TrackingSessionByDeviceDataPoint1 | None)
11311
11309
 
11312
11310
  </dd>
11313
11311
  </dl>
@@ -11372,7 +11370,7 @@ await client.tracking.sessionByDevice.lastSeenV1({
11372
11370
  <dl>
11373
11371
  <dd>
11374
11372
 
11375
- Returns up to the specified number of data points for a session, intelligently sampled across the time range. Excludes outliers.
11373
+ Returns up to the specified number of data points for a session, intelligently sampled across the time range. Excludes outliers. | () -> (list[TrackingSessionByDeviceDataPoint1])
11376
11374
 
11377
11375
  </dd>
11378
11376
  </dl>
@@ -11438,7 +11436,7 @@ await client.tracking.sessionByDevice.dataPointsV1({
11438
11436
  <dl>
11439
11437
  <dd>
11440
11438
 
11441
- Creates a new tracking session for a device and links the device to it. The device must be registered to the caller's organization.
11439
+ Creates a new tracking session for a device and links the device to it. The device must be registered to the caller's organization. | (SessionByDeviceCreateSessionRequest1) -> (PydanticObjectId)
11442
11440
 
11443
11441
  </dd>
11444
11442
  </dl>
@@ -11503,7 +11501,7 @@ await client.tracking.sessionByDevice.createSessionV1({
11503
11501
  <dl>
11504
11502
  <dd>
11505
11503
 
11506
- Updates a session's comments and/or public visibility status. Can update one or both fields.
11504
+ Updates a session's comments and/or public visibility status. Can update one or both fields. | (SessionByDeviceUpdateRequest1) -> (bool)
11507
11505
 
11508
11506
  </dd>
11509
11507
  </dl>
@@ -11568,7 +11566,7 @@ await client.tracking.sessionByDevice.updateV1({
11568
11566
  <dl>
11569
11567
  <dd>
11570
11568
 
11571
- Starts location recording for a session by setting recording status to true. Sets the recording initiated timestamp on first start.
11569
+ Starts location recording for a session by setting recording status to true. Sets the recording initiated timestamp on first start. | () -> (bool)
11572
11570
 
11573
11571
  </dd>
11574
11572
  </dl>
@@ -11633,7 +11631,7 @@ await client.tracking.sessionByDevice.startV1({
11633
11631
  <dl>
11634
11632
  <dd>
11635
11633
 
11636
- Pauses location recording for a session by setting recording status to false. Device remains linked to the session.
11634
+ Pauses location recording for a session by setting recording status to false. Device remains linked to the session. | () -> (bool)
11637
11635
 
11638
11636
  </dd>
11639
11637
  </dl>
@@ -11698,7 +11696,7 @@ await client.tracking.sessionByDevice.pauseRecordingV1({
11698
11696
  <dl>
11699
11697
  <dd>
11700
11698
 
11701
- Resumes location recording for a session by setting recording status to true.
11699
+ Resumes location recording for a session by setting recording status to true. | () -> (bool)
11702
11700
 
11703
11701
  </dd>
11704
11702
  </dl>
@@ -11763,7 +11761,7 @@ await client.tracking.sessionByDevice.resumeRecordingV1({
11763
11761
  <dl>
11764
11762
  <dd>
11765
11763
 
11766
- Terminates a session by setting recording to false and marking it as terminated. Unlinks the device from the session.
11764
+ Terminates a session by setting recording to false and marking it as terminated. Unlinks the device from the session. | () -> (bool)
11767
11765
 
11768
11766
  </dd>
11769
11767
  </dl>
@@ -11828,7 +11826,7 @@ await client.tracking.sessionByDevice.terminateV1({
11828
11826
  <dl>
11829
11827
  <dd>
11830
11828
 
11831
- Marks data points as outliers or non-outliers. Uses atomic delete and reinsert strategy for time-series collection updates.
11829
+ Marks data points as outliers or non-outliers. Uses atomic delete and reinsert strategy for time-series collection updates. | (SessionByDeviceMarkOutliersRequest1) -> (SessionByDeviceMarkOutliersResponse1)
11832
11830
 
11833
11831
  </dd>
11834
11832
  </dl>
@@ -11894,7 +11892,7 @@ await client.tracking.sessionByDevice.outlierV1({
11894
11892
  <dl>
11895
11893
  <dd>
11896
11894
 
11897
- Deletes a terminated session and all its associated timeseries data points. Only sessions marked as terminated can be deleted.
11895
+ Deletes a terminated session and all its associated timeseries data points. Only sessions marked as terminated can be deleted. | () -> (SessionByDeviceDeleteResponse1)
11898
11896
 
11899
11897
  </dd>
11900
11898
  </dl>
@@ -11959,7 +11957,7 @@ await client.tracking.sessionByDevice.deleteV1({
11959
11957
  <dl>
11960
11958
  <dd>
11961
11959
 
11962
- Returns the most recent data point for a public session, excluding outliers. No authentication required if session has public visibility enabled.
11960
+ Returns the most recent data point for a public session, excluding outliers. No authentication required if session has public visibility enabled. | () -> (TrackingSessionByDeviceDataPoint1 | None)
11963
11961
 
11964
11962
  </dd>
11965
11963
  </dl>
@@ -12024,7 +12022,7 @@ await client.tracking.sessionByDevice.lastSeenPublicV1({
12024
12022
  <dl>
12025
12023
  <dd>
12026
12024
 
12027
- Returns up to the specified number of data points for a public session, intelligently sampled across the time range. Excludes outliers. No authentication required if session has public visibility enabled.
12025
+ Returns up to the specified number of data points for a public session, intelligently sampled across the time range. Excludes outliers. No authentication required if session has public visibility enabled. | () -> (list[TrackingSessionByDeviceDataPoint1])
12028
12026
 
12029
12027
  </dd>
12030
12028
  </dl>
@@ -12092,7 +12090,7 @@ await client.tracking.sessionByDevice.dataPointsPublicV1({
12092
12090
  <dl>
12093
12091
  <dd>
12094
12092
 
12095
- Returns the most recent driver location data point for a task group. Access granted to courier or shipper organization. Data written by the driver update endpoint.
12093
+ Returns the most recent driver location data point for a task group. Access granted to courier or shipper organization. Data written by the driver update endpoint. | () -> (TrackingTaskGroupByDriverDataPoint1 | None)
12096
12094
 
12097
12095
  </dd>
12098
12096
  </dl>