@chrt-inc/typescript-sdk 1.302.0 → 1.303.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.
- package/README.md +29 -8
- package/dist/cjs/Client.d.ts +3 -0
- package/dist/cjs/Client.js +25 -20
- package/dist/cjs/api/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/index.js +3 -1
- package/dist/cjs/api/resources/orderDrafts/client/Client.d.ts +100 -0
- package/dist/cjs/api/resources/orderDrafts/client/Client.js +332 -0
- package/dist/cjs/api/resources/orderDrafts/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/orderDrafts/client/index.js +17 -0
- package/dist/cjs/api/resources/orderDrafts/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/orderDrafts/index.d.ts +2 -0
- package/dist/cjs/api/resources/orderDrafts/index.js +18 -0
- package/dist/cjs/api/resources/orderDrafts/resources/cargo/client/Client.d.ts +99 -0
- package/dist/cjs/api/resources/orderDrafts/resources/cargo/client/Client.js +326 -0
- package/dist/cjs/api/resources/orderDrafts/resources/cargo/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/orderDrafts/resources/cargo/client/index.js +17 -0
- package/dist/cjs/api/resources/{orders/resources/draft/client/requests/OrderDraftCreateCargoReq.d.ts → orderDrafts/resources/cargo/client/requests/OrderDraftAddCargoReq.d.ts} +1 -1
- package/dist/cjs/api/resources/orderDrafts/resources/cargo/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/orderDrafts/resources/cargo/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/orderDrafts/resources/cargo/index.d.ts +1 -0
- package/dist/cjs/api/resources/orderDrafts/resources/cargo/index.js +17 -0
- package/dist/cjs/api/resources/orderDrafts/resources/index.d.ts +8 -0
- package/dist/cjs/api/resources/orderDrafts/resources/index.js +47 -0
- package/dist/cjs/api/resources/orderDrafts/resources/task/client/Client.d.ts +81 -0
- package/dist/cjs/api/resources/orderDrafts/resources/task/client/Client.js +259 -0
- package/dist/cjs/api/resources/orderDrafts/resources/task/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/orderDrafts/resources/task/client/index.js +17 -0
- package/dist/cjs/api/resources/orderDrafts/resources/task/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/orderDrafts/resources/task/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/orderDrafts/resources/task/index.d.ts +1 -0
- package/dist/cjs/api/resources/orderDrafts/resources/task/index.js +17 -0
- package/dist/cjs/api/resources/orderDrafts/resources/taskArtifact/client/Client.d.ts +63 -0
- package/dist/cjs/api/resources/orderDrafts/resources/taskArtifact/client/Client.js +192 -0
- package/dist/cjs/api/resources/orderDrafts/resources/taskArtifact/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/orderDrafts/resources/taskArtifact/client/index.js +17 -0
- package/dist/cjs/api/resources/orderDrafts/resources/taskArtifact/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/orderDrafts/resources/taskArtifact/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/orderDrafts/resources/taskArtifact/index.d.ts +1 -0
- package/dist/cjs/api/resources/orderDrafts/resources/taskArtifact/index.js +17 -0
- package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/client/Client.d.ts +63 -0
- package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/client/Client.js +192 -0
- package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/client/index.js +17 -0
- package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/index.d.ts +1 -0
- package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/index.js +17 -0
- package/dist/cjs/api/resources/orders/resources/draft/client/Client.d.ts +0 -238
- package/dist/cjs/api/resources/orders/resources/draft/client/Client.js +0 -997
- package/dist/cjs/api/resources/orders/resources/draft/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/orders/resources/draft/client/index.js +0 -15
- package/dist/cjs/api/resources/orders/resources/draft/resources/expanded/client/Client.js +4 -4
- package/dist/cjs/api/resources/orders/resources/index.d.ts +0 -1
- package/dist/cjs/api/resources/orders/resources/index.js +0 -1
- package/dist/cjs/api/resources/payments/client/Client.d.ts +20 -20
- package/dist/cjs/api/resources/payments/client/Client.js +83 -83
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.d.mts +3 -0
- package/dist/esm/Client.mjs +7 -2
- package/dist/esm/api/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/index.mjs +2 -0
- package/dist/esm/api/resources/orderDrafts/client/Client.d.mts +100 -0
- package/dist/esm/api/resources/orderDrafts/client/Client.mjs +295 -0
- package/dist/esm/api/resources/orderDrafts/client/index.d.mts +2 -0
- package/dist/esm/api/resources/orderDrafts/client/index.mjs +1 -0
- package/dist/esm/api/resources/orderDrafts/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/orderDrafts/index.d.mts +2 -0
- package/dist/esm/api/resources/orderDrafts/index.mjs +2 -0
- package/dist/esm/api/resources/orderDrafts/resources/cargo/client/Client.d.mts +99 -0
- package/dist/esm/api/resources/orderDrafts/resources/cargo/client/Client.mjs +289 -0
- package/dist/esm/api/resources/orderDrafts/resources/cargo/client/index.d.mts +2 -0
- package/dist/esm/api/resources/orderDrafts/resources/cargo/client/index.mjs +1 -0
- package/dist/esm/api/resources/{orders/resources/draft/client/requests/OrderDraftCreateCargoReq.d.mts → orderDrafts/resources/cargo/client/requests/OrderDraftAddCargoReq.d.mts} +1 -1
- package/dist/esm/api/resources/orderDrafts/resources/cargo/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/orderDrafts/resources/cargo/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/orderDrafts/resources/cargo/index.d.mts +1 -0
- package/dist/esm/api/resources/orderDrafts/resources/cargo/index.mjs +1 -0
- package/dist/esm/api/resources/orderDrafts/resources/index.d.mts +8 -0
- package/dist/esm/api/resources/orderDrafts/resources/index.mjs +8 -0
- package/dist/esm/api/resources/orderDrafts/resources/task/client/Client.d.mts +81 -0
- package/dist/esm/api/resources/orderDrafts/resources/task/client/Client.mjs +222 -0
- package/dist/esm/api/resources/orderDrafts/resources/task/client/index.d.mts +2 -0
- package/dist/esm/api/resources/orderDrafts/resources/task/client/index.mjs +1 -0
- package/dist/esm/api/resources/orderDrafts/resources/task/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/orderDrafts/resources/task/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/orderDrafts/resources/task/index.d.mts +1 -0
- package/dist/esm/api/resources/orderDrafts/resources/task/index.mjs +1 -0
- package/dist/esm/api/resources/orderDrafts/resources/taskArtifact/client/Client.d.mts +63 -0
- package/dist/esm/api/resources/orderDrafts/resources/taskArtifact/client/Client.mjs +155 -0
- package/dist/esm/api/resources/orderDrafts/resources/taskArtifact/client/index.d.mts +2 -0
- package/dist/esm/api/resources/orderDrafts/resources/taskArtifact/client/index.mjs +1 -0
- package/dist/esm/api/resources/orderDrafts/resources/taskArtifact/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/orderDrafts/resources/taskArtifact/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/orderDrafts/resources/taskArtifact/index.d.mts +1 -0
- package/dist/esm/api/resources/orderDrafts/resources/taskArtifact/index.mjs +1 -0
- package/dist/esm/api/resources/orderDrafts/resources/taskGroup/client/Client.d.mts +63 -0
- package/dist/esm/api/resources/orderDrafts/resources/taskGroup/client/Client.mjs +155 -0
- package/dist/esm/api/resources/orderDrafts/resources/taskGroup/client/index.d.mts +2 -0
- package/dist/esm/api/resources/orderDrafts/resources/taskGroup/client/index.mjs +1 -0
- package/dist/esm/api/resources/orderDrafts/resources/taskGroup/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/orderDrafts/resources/taskGroup/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/orderDrafts/resources/taskGroup/index.d.mts +1 -0
- package/dist/esm/api/resources/orderDrafts/resources/taskGroup/index.mjs +1 -0
- package/dist/esm/api/resources/orders/resources/draft/client/Client.d.mts +0 -238
- package/dist/esm/api/resources/orders/resources/draft/client/Client.mjs +0 -964
- package/dist/esm/api/resources/orders/resources/draft/client/index.d.mts +0 -1
- package/dist/esm/api/resources/orders/resources/draft/client/index.mjs +1 -1
- package/dist/esm/api/resources/orders/resources/draft/resources/expanded/client/Client.mjs +4 -4
- package/dist/esm/api/resources/orders/resources/index.d.mts +0 -1
- package/dist/esm/api/resources/orders/resources/index.mjs +0 -1
- package/dist/esm/api/resources/payments/client/Client.d.mts +20 -20
- package/dist/esm/api/resources/payments/client/Client.mjs +83 -83
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +511 -503
- package/dist/cjs/api/resources/orders/resources/draft/client/requests/index.d.ts +0 -9
- package/dist/esm/api/resources/orders/resources/draft/client/requests/index.d.mts +0 -9
- /package/dist/cjs/api/resources/{orders/resources/draft → orderDrafts}/client/requests/OrdersDraftUpdateReq.d.ts +0 -0
- /package/dist/cjs/api/resources/{orders/resources/draft → orderDrafts}/client/requests/OrdersDraftUpdateReq.js +0 -0
- /package/dist/cjs/api/resources/{orders/resources/draft → orderDrafts}/client/requests/OrdersNewDraftReq.d.ts +0 -0
- /package/dist/cjs/api/resources/{orders/resources/draft → orderDrafts}/client/requests/OrdersNewDraftReq.js +0 -0
- /package/dist/cjs/api/resources/{orders/resources/draft → orderDrafts}/client/requests/index.js +0 -0
- /package/dist/cjs/api/resources/{orders/resources/draft/client/requests/OrderDraftAddTaskArtifactReq.js → orderDrafts/resources/cargo/client/requests/OrderDraftAddCargoReq.js} +0 -0
- /package/dist/cjs/api/resources/{orders/resources/draft → orderDrafts/resources/cargo}/client/requests/OrderDraftAssociateCargoWithTaskReq.d.ts +0 -0
- /package/dist/cjs/api/resources/{orders/resources/draft → orderDrafts/resources/cargo}/client/requests/OrderDraftAssociateCargoWithTaskReq.js +0 -0
- /package/dist/cjs/api/resources/{orders/resources/draft → orderDrafts/resources/cargo}/client/requests/OrderDraftUpdateCargoReq.d.ts +0 -0
- /package/dist/cjs/api/resources/{orders/resources/draft → orderDrafts/resources/cargo}/client/requests/OrderDraftUpdateCargoReq.js +0 -0
- /package/dist/cjs/api/resources/{orders/resources/draft → orderDrafts/resources/task}/client/requests/OrderDraftAddTaskReqV1.d.ts +0 -0
- /package/dist/cjs/api/resources/{orders/resources/draft → orderDrafts/resources/task}/client/requests/OrderDraftAddTaskReqV1.js +0 -0
- /package/dist/cjs/api/resources/{orders/resources/draft → orderDrafts/resources/task}/client/requests/OrderDraftUpdateTaskReq.d.ts +0 -0
- /package/dist/cjs/api/resources/{orders/resources/draft → orderDrafts/resources/task}/client/requests/OrderDraftUpdateTaskReq.js +0 -0
- /package/dist/cjs/api/resources/{orders/resources/draft → orderDrafts/resources/taskArtifact}/client/requests/OrderDraftAddTaskArtifactReq.d.ts +0 -0
- /package/dist/cjs/api/resources/{orders/resources/draft/client/requests/OrderDraftAddTaskGroupReq.js → orderDrafts/resources/taskArtifact/client/requests/OrderDraftAddTaskArtifactReq.js} +0 -0
- /package/dist/cjs/api/resources/{orders/resources/draft → orderDrafts/resources/taskGroup}/client/requests/OrderDraftAddTaskGroupReq.d.ts +0 -0
- /package/dist/cjs/api/resources/{orders/resources/draft/client/requests/OrderDraftCreateCargoReq.js → orderDrafts/resources/taskGroup/client/requests/OrderDraftAddTaskGroupReq.js} +0 -0
- /package/dist/esm/api/resources/{orders/resources/draft → orderDrafts}/client/requests/OrdersDraftUpdateReq.d.mts +0 -0
- /package/dist/esm/api/resources/{orders/resources/draft → orderDrafts}/client/requests/OrdersDraftUpdateReq.mjs +0 -0
- /package/dist/esm/api/resources/{orders/resources/draft → orderDrafts}/client/requests/OrdersNewDraftReq.d.mts +0 -0
- /package/dist/esm/api/resources/{orders/resources/draft → orderDrafts}/client/requests/OrdersNewDraftReq.mjs +0 -0
- /package/dist/esm/api/resources/{orders/resources/draft → orderDrafts}/client/requests/index.mjs +0 -0
- /package/dist/esm/api/resources/{orders/resources/draft/client/requests/OrderDraftAddTaskArtifactReq.mjs → orderDrafts/resources/cargo/client/requests/OrderDraftAddCargoReq.mjs} +0 -0
- /package/dist/esm/api/resources/{orders/resources/draft → orderDrafts/resources/cargo}/client/requests/OrderDraftAssociateCargoWithTaskReq.d.mts +0 -0
- /package/dist/esm/api/resources/{orders/resources/draft → orderDrafts/resources/cargo}/client/requests/OrderDraftAssociateCargoWithTaskReq.mjs +0 -0
- /package/dist/esm/api/resources/{orders/resources/draft → orderDrafts/resources/cargo}/client/requests/OrderDraftUpdateCargoReq.d.mts +0 -0
- /package/dist/esm/api/resources/{orders/resources/draft → orderDrafts/resources/cargo}/client/requests/OrderDraftUpdateCargoReq.mjs +0 -0
- /package/dist/esm/api/resources/{orders/resources/draft → orderDrafts/resources/task}/client/requests/OrderDraftAddTaskReqV1.d.mts +0 -0
- /package/dist/esm/api/resources/{orders/resources/draft → orderDrafts/resources/task}/client/requests/OrderDraftAddTaskReqV1.mjs +0 -0
- /package/dist/esm/api/resources/{orders/resources/draft → orderDrafts/resources/task}/client/requests/OrderDraftUpdateTaskReq.d.mts +0 -0
- /package/dist/esm/api/resources/{orders/resources/draft → orderDrafts/resources/task}/client/requests/OrderDraftUpdateTaskReq.mjs +0 -0
- /package/dist/esm/api/resources/{orders/resources/draft → orderDrafts/resources/taskArtifact}/client/requests/OrderDraftAddTaskArtifactReq.d.mts +0 -0
- /package/dist/esm/api/resources/{orders/resources/draft/client/requests/OrderDraftAddTaskGroupReq.mjs → orderDrafts/resources/taskArtifact/client/requests/OrderDraftAddTaskArtifactReq.mjs} +0 -0
- /package/dist/esm/api/resources/{orders/resources/draft → orderDrafts/resources/taskGroup}/client/requests/OrderDraftAddTaskGroupReq.d.mts +0 -0
- /package/dist/esm/api/resources/{orders/resources/draft/client/requests/OrderDraftCreateCargoReq.mjs → orderDrafts/resources/taskGroup/client/requests/OrderDraftAddTaskGroupReq.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
## Payments
|
|
4
4
|
|
|
5
|
-
<details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">
|
|
5
|
+
<details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">generateInvoiceV1</a>({ ...params }) -> Chrt.GenerateInvoiceRes</code></summary>
|
|
6
6
|
<dl>
|
|
7
7
|
<dd>
|
|
8
8
|
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
<dl>
|
|
15
15
|
<dd>
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
Generates and sends a Stripe invoice for a shipper statement to a courier organization's Connect account. Applies a 10% application fee.
|
|
18
18
|
|
|
19
19
|
</dd>
|
|
20
20
|
</dl>
|
|
@@ -30,7 +30,9 @@ Creates a Stripe Connect account for the organization to receive payments. Idemp
|
|
|
30
30
|
<dd>
|
|
31
31
|
|
|
32
32
|
```typescript
|
|
33
|
-
await client.payments.
|
|
33
|
+
await client.payments.generateInvoiceV1({
|
|
34
|
+
shipper_pay_courier_statement_id: "shipper_pay_courier_statement_id",
|
|
35
|
+
});
|
|
34
36
|
```
|
|
35
37
|
|
|
36
38
|
</dd>
|
|
@@ -46,6 +48,14 @@ await client.payments.createConnectAccountV1();
|
|
|
46
48
|
<dl>
|
|
47
49
|
<dd>
|
|
48
50
|
|
|
51
|
+
**request:** `Chrt.GenerateInvoiceReq`
|
|
52
|
+
|
|
53
|
+
</dd>
|
|
54
|
+
</dl>
|
|
55
|
+
|
|
56
|
+
<dl>
|
|
57
|
+
<dd>
|
|
58
|
+
|
|
49
59
|
**requestOptions:** `Payments.RequestOptions`
|
|
50
60
|
|
|
51
61
|
</dd>
|
|
@@ -57,7 +67,7 @@ await client.payments.createConnectAccountV1();
|
|
|
57
67
|
</dl>
|
|
58
68
|
</details>
|
|
59
69
|
|
|
60
|
-
<details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">
|
|
70
|
+
<details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">createCheckoutSessionV1</a>({ ...params }) -> Chrt.CreateCheckoutSessionRes</code></summary>
|
|
61
71
|
<dl>
|
|
62
72
|
<dd>
|
|
63
73
|
|
|
@@ -69,7 +79,7 @@ await client.payments.createConnectAccountV1();
|
|
|
69
79
|
<dl>
|
|
70
80
|
<dd>
|
|
71
81
|
|
|
72
|
-
Creates
|
|
82
|
+
Creates a Stripe checkout session for a subscription with pricing based on the selected plan.
|
|
73
83
|
|
|
74
84
|
</dd>
|
|
75
85
|
</dl>
|
|
@@ -85,7 +95,9 @@ Creates an onboarding link for a Stripe Connect account. Used to complete or upd
|
|
|
85
95
|
<dd>
|
|
86
96
|
|
|
87
97
|
```typescript
|
|
88
|
-
await client.payments.
|
|
98
|
+
await client.payments.createCheckoutSessionV1({
|
|
99
|
+
price_name: "courier_ops_100_usd_per_month",
|
|
100
|
+
});
|
|
89
101
|
```
|
|
90
102
|
|
|
91
103
|
</dd>
|
|
@@ -101,6 +113,14 @@ await client.payments.createConnectAccountLinkV1();
|
|
|
101
113
|
<dl>
|
|
102
114
|
<dd>
|
|
103
115
|
|
|
116
|
+
**request:** `Chrt.CreateCheckoutSessionReq`
|
|
117
|
+
|
|
118
|
+
</dd>
|
|
119
|
+
</dl>
|
|
120
|
+
|
|
121
|
+
<dl>
|
|
122
|
+
<dd>
|
|
123
|
+
|
|
104
124
|
**requestOptions:** `Payments.RequestOptions`
|
|
105
125
|
|
|
106
126
|
</dd>
|
|
@@ -112,7 +132,7 @@ await client.payments.createConnectAccountLinkV1();
|
|
|
112
132
|
</dl>
|
|
113
133
|
</details>
|
|
114
134
|
|
|
115
|
-
<details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">
|
|
135
|
+
<details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">syncStripeToClerkV1</a>() -> boolean</code></summary>
|
|
116
136
|
<dl>
|
|
117
137
|
<dd>
|
|
118
138
|
|
|
@@ -124,7 +144,7 @@ await client.payments.createConnectAccountLinkV1();
|
|
|
124
144
|
<dl>
|
|
125
145
|
<dd>
|
|
126
146
|
|
|
127
|
-
|
|
147
|
+
Synchronizes subscription data from Stripe to the authentication service for the current user.
|
|
128
148
|
|
|
129
149
|
</dd>
|
|
130
150
|
</dl>
|
|
@@ -140,9 +160,7 @@ Generates and sends a Stripe invoice for a shipper statement to a courier organi
|
|
|
140
160
|
<dd>
|
|
141
161
|
|
|
142
162
|
```typescript
|
|
143
|
-
await client.payments.
|
|
144
|
-
shipper_pay_courier_statement_id: "shipper_pay_courier_statement_id",
|
|
145
|
-
});
|
|
163
|
+
await client.payments.syncStripeToClerkV1();
|
|
146
164
|
```
|
|
147
165
|
|
|
148
166
|
</dd>
|
|
@@ -158,14 +176,6 @@ await client.payments.generateInvoiceV1({
|
|
|
158
176
|
<dl>
|
|
159
177
|
<dd>
|
|
160
178
|
|
|
161
|
-
**request:** `Chrt.GenerateInvoiceReq`
|
|
162
|
-
|
|
163
|
-
</dd>
|
|
164
|
-
</dl>
|
|
165
|
-
|
|
166
|
-
<dl>
|
|
167
|
-
<dd>
|
|
168
|
-
|
|
169
179
|
**requestOptions:** `Payments.RequestOptions`
|
|
170
180
|
|
|
171
181
|
</dd>
|
|
@@ -177,7 +187,7 @@ await client.payments.generateInvoiceV1({
|
|
|
177
187
|
</dl>
|
|
178
188
|
</details>
|
|
179
189
|
|
|
180
|
-
<details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">
|
|
190
|
+
<details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">createConnectAccountV1</a>() -> Chrt.CreateConnectAccountRes</code></summary>
|
|
181
191
|
<dl>
|
|
182
192
|
<dd>
|
|
183
193
|
|
|
@@ -189,7 +199,7 @@ await client.payments.generateInvoiceV1({
|
|
|
189
199
|
<dl>
|
|
190
200
|
<dd>
|
|
191
201
|
|
|
192
|
-
Creates a Stripe
|
|
202
|
+
Creates a Stripe Connect account for the organization to receive payments. Idempotent - returns existing account if already created.
|
|
193
203
|
|
|
194
204
|
</dd>
|
|
195
205
|
</dl>
|
|
@@ -205,9 +215,7 @@ Creates a Stripe checkout session for a subscription with pricing based on the s
|
|
|
205
215
|
<dd>
|
|
206
216
|
|
|
207
217
|
```typescript
|
|
208
|
-
await client.payments.
|
|
209
|
-
price_name: "courier_ops_100_usd_per_month",
|
|
210
|
-
});
|
|
218
|
+
await client.payments.createConnectAccountV1();
|
|
211
219
|
```
|
|
212
220
|
|
|
213
221
|
</dd>
|
|
@@ -223,14 +231,6 @@ await client.payments.createCheckoutSessionV1({
|
|
|
223
231
|
<dl>
|
|
224
232
|
<dd>
|
|
225
233
|
|
|
226
|
-
**request:** `Chrt.CreateCheckoutSessionReq`
|
|
227
|
-
|
|
228
|
-
</dd>
|
|
229
|
-
</dl>
|
|
230
|
-
|
|
231
|
-
<dl>
|
|
232
|
-
<dd>
|
|
233
|
-
|
|
234
234
|
**requestOptions:** `Payments.RequestOptions`
|
|
235
235
|
|
|
236
236
|
</dd>
|
|
@@ -242,7 +242,7 @@ await client.payments.createCheckoutSessionV1({
|
|
|
242
242
|
</dl>
|
|
243
243
|
</details>
|
|
244
244
|
|
|
245
|
-
<details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">
|
|
245
|
+
<details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">createConnectAccountLinkV1</a>() -> Chrt.CreateConnectAccountLinkRes</code></summary>
|
|
246
246
|
<dl>
|
|
247
247
|
<dd>
|
|
248
248
|
|
|
@@ -254,7 +254,7 @@ await client.payments.createCheckoutSessionV1({
|
|
|
254
254
|
<dl>
|
|
255
255
|
<dd>
|
|
256
256
|
|
|
257
|
-
|
|
257
|
+
Creates an onboarding link for a Stripe Connect account. Used to complete or update account setup.
|
|
258
258
|
|
|
259
259
|
</dd>
|
|
260
260
|
</dl>
|
|
@@ -270,7 +270,7 @@ Synchronizes subscription data from Stripe to the authentication service for the
|
|
|
270
270
|
<dd>
|
|
271
271
|
|
|
272
272
|
```typescript
|
|
273
|
-
await client.payments.
|
|
273
|
+
await client.payments.createConnectAccountLinkV1();
|
|
274
274
|
```
|
|
275
275
|
|
|
276
276
|
</dd>
|
|
@@ -5497,9 +5497,9 @@ await client.orders.stageV1("order_id");
|
|
|
5497
5497
|
</dl>
|
|
5498
5498
|
</details>
|
|
5499
5499
|
|
|
5500
|
-
##
|
|
5500
|
+
## OrderDrafts
|
|
5501
5501
|
|
|
5502
|
-
<details><summary><code>client.
|
|
5502
|
+
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">newV1</a>({ ...params }) -> Chrt.OrdersNewDraftRes</code></summary>
|
|
5503
5503
|
<dl>
|
|
5504
5504
|
<dd>
|
|
5505
5505
|
|
|
@@ -5511,7 +5511,7 @@ await client.orders.stageV1("order_id");
|
|
|
5511
5511
|
<dl>
|
|
5512
5512
|
<dd>
|
|
5513
5513
|
|
|
5514
|
-
|
|
5514
|
+
Creates a new draft order with org assignments based on caller's organization type.
|
|
5515
5515
|
|
|
5516
5516
|
</dd>
|
|
5517
5517
|
</dl>
|
|
@@ -5527,9 +5527,7 @@ Updates task group driver assignments by adding or removing drivers.
|
|
|
5527
5527
|
<dd>
|
|
5528
5528
|
|
|
5529
5529
|
```typescript
|
|
5530
|
-
await client.
|
|
5531
|
-
task_group_id: "task_group_id",
|
|
5532
|
-
});
|
|
5530
|
+
await client.orderDrafts.newV1();
|
|
5533
5531
|
```
|
|
5534
5532
|
|
|
5535
5533
|
</dd>
|
|
@@ -5545,7 +5543,7 @@ await client.taskGroups.updateV1({
|
|
|
5545
5543
|
<dl>
|
|
5546
5544
|
<dd>
|
|
5547
5545
|
|
|
5548
|
-
**request:** `Chrt.
|
|
5546
|
+
**request:** `Chrt.OrdersNewDraftReq`
|
|
5549
5547
|
|
|
5550
5548
|
</dd>
|
|
5551
5549
|
</dl>
|
|
@@ -5553,7 +5551,7 @@ await client.taskGroups.updateV1({
|
|
|
5553
5551
|
<dl>
|
|
5554
5552
|
<dd>
|
|
5555
5553
|
|
|
5556
|
-
**requestOptions:** `
|
|
5554
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
5557
5555
|
|
|
5558
5556
|
</dd>
|
|
5559
5557
|
</dl>
|
|
@@ -5564,7 +5562,7 @@ await client.taskGroups.updateV1({
|
|
|
5564
5562
|
</dl>
|
|
5565
5563
|
</details>
|
|
5566
5564
|
|
|
5567
|
-
<details><summary><code>client.
|
|
5565
|
+
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">updateV1</a>({ ...params }) -> Chrt.OrdersDraftUpdateRes</code></summary>
|
|
5568
5566
|
<dl>
|
|
5569
5567
|
<dd>
|
|
5570
5568
|
|
|
@@ -5576,7 +5574,7 @@ await client.taskGroups.updateV1({
|
|
|
5576
5574
|
<dl>
|
|
5577
5575
|
<dd>
|
|
5578
5576
|
|
|
5579
|
-
|
|
5577
|
+
Updates forwarder and/or shipper org assignments for a draft order
|
|
5580
5578
|
|
|
5581
5579
|
</dd>
|
|
5582
5580
|
</dl>
|
|
@@ -5592,7 +5590,9 @@ Starts a task group by changing its status to in-progress and updating the order
|
|
|
5592
5590
|
<dd>
|
|
5593
5591
|
|
|
5594
5592
|
```typescript
|
|
5595
|
-
await client.
|
|
5593
|
+
await client.orderDrafts.updateV1({
|
|
5594
|
+
order_id: "order_id",
|
|
5595
|
+
});
|
|
5596
5596
|
```
|
|
5597
5597
|
|
|
5598
5598
|
</dd>
|
|
@@ -5608,7 +5608,7 @@ await client.taskGroups.startV1("task_group_id");
|
|
|
5608
5608
|
<dl>
|
|
5609
5609
|
<dd>
|
|
5610
5610
|
|
|
5611
|
-
**
|
|
5611
|
+
**request:** `Chrt.OrdersDraftUpdateReq`
|
|
5612
5612
|
|
|
5613
5613
|
</dd>
|
|
5614
5614
|
</dl>
|
|
@@ -5616,7 +5616,7 @@ await client.taskGroups.startV1("task_group_id");
|
|
|
5616
5616
|
<dl>
|
|
5617
5617
|
<dd>
|
|
5618
5618
|
|
|
5619
|
-
**requestOptions:** `
|
|
5619
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
5620
5620
|
|
|
5621
5621
|
</dd>
|
|
5622
5622
|
</dl>
|
|
@@ -5627,7 +5627,7 @@ await client.taskGroups.startV1("task_group_id");
|
|
|
5627
5627
|
</dl>
|
|
5628
5628
|
</details>
|
|
5629
5629
|
|
|
5630
|
-
<details><summary><code>client.
|
|
5630
|
+
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">deleteV1</a>(orderId) -> boolean</code></summary>
|
|
5631
5631
|
<dl>
|
|
5632
5632
|
<dd>
|
|
5633
5633
|
|
|
@@ -5639,7 +5639,7 @@ await client.taskGroups.startV1("task_group_id");
|
|
|
5639
5639
|
<dl>
|
|
5640
5640
|
<dd>
|
|
5641
5641
|
|
|
5642
|
-
|
|
5642
|
+
Deletes a draft order and all associated entities
|
|
5643
5643
|
|
|
5644
5644
|
</dd>
|
|
5645
5645
|
</dl>
|
|
@@ -5655,10 +5655,7 @@ Toggles the pause status of an in-progress task group.
|
|
|
5655
5655
|
<dd>
|
|
5656
5656
|
|
|
5657
5657
|
```typescript
|
|
5658
|
-
await client.
|
|
5659
|
-
task_group_id: "task_group_id",
|
|
5660
|
-
paused: true,
|
|
5661
|
-
});
|
|
5658
|
+
await client.orderDrafts.deleteV1("order_id");
|
|
5662
5659
|
```
|
|
5663
5660
|
|
|
5664
5661
|
</dd>
|
|
@@ -5674,15 +5671,7 @@ await client.taskGroups.togglePauseV1("id", {
|
|
|
5674
5671
|
<dl>
|
|
5675
5672
|
<dd>
|
|
5676
5673
|
|
|
5677
|
-
**
|
|
5678
|
-
|
|
5679
|
-
</dd>
|
|
5680
|
-
</dl>
|
|
5681
|
-
|
|
5682
|
-
<dl>
|
|
5683
|
-
<dd>
|
|
5684
|
-
|
|
5685
|
-
**request:** `Chrt.SetTaskGroupPauseReq`
|
|
5674
|
+
**orderId:** `string`
|
|
5686
5675
|
|
|
5687
5676
|
</dd>
|
|
5688
5677
|
</dl>
|
|
@@ -5690,7 +5679,7 @@ await client.taskGroups.togglePauseV1("id", {
|
|
|
5690
5679
|
<dl>
|
|
5691
5680
|
<dd>
|
|
5692
5681
|
|
|
5693
|
-
**requestOptions:** `
|
|
5682
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
5694
5683
|
|
|
5695
5684
|
</dd>
|
|
5696
5685
|
</dl>
|
|
@@ -5701,9 +5690,7 @@ await client.taskGroups.togglePauseV1("id", {
|
|
|
5701
5690
|
</dl>
|
|
5702
5691
|
</details>
|
|
5703
5692
|
|
|
5704
|
-
|
|
5705
|
-
|
|
5706
|
-
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">getByJwtUserIdV1</a>() -> Chrt.ShipperContact1</code></summary>
|
|
5693
|
+
<details><summary><code>client.orderDrafts.<a href="/src/api/resources/orderDrafts/client/Client.ts">validateV1</a>(orderId) -> boolean</code></summary>
|
|
5707
5694
|
<dl>
|
|
5708
5695
|
<dd>
|
|
5709
5696
|
|
|
@@ -5715,7 +5702,7 @@ await client.taskGroups.togglePauseV1("id", {
|
|
|
5715
5702
|
<dl>
|
|
5716
5703
|
<dd>
|
|
5717
5704
|
|
|
5718
|
-
|
|
5705
|
+
Checks whether the draft order satisfies all requirements to move into staging.
|
|
5719
5706
|
|
|
5720
5707
|
</dd>
|
|
5721
5708
|
</dl>
|
|
@@ -5731,7 +5718,7 @@ Retrieves the authenticated user's own shipper contact information.
|
|
|
5731
5718
|
<dd>
|
|
5732
5719
|
|
|
5733
5720
|
```typescript
|
|
5734
|
-
await client.
|
|
5721
|
+
await client.orderDrafts.validateV1("order_id");
|
|
5735
5722
|
```
|
|
5736
5723
|
|
|
5737
5724
|
</dd>
|
|
@@ -5747,7 +5734,15 @@ await client.shipperContactInfo.getByJwtUserIdV1();
|
|
|
5747
5734
|
<dl>
|
|
5748
5735
|
<dd>
|
|
5749
5736
|
|
|
5750
|
-
**
|
|
5737
|
+
**orderId:** `string`
|
|
5738
|
+
|
|
5739
|
+
</dd>
|
|
5740
|
+
</dl>
|
|
5741
|
+
|
|
5742
|
+
<dl>
|
|
5743
|
+
<dd>
|
|
5744
|
+
|
|
5745
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
5751
5746
|
|
|
5752
5747
|
</dd>
|
|
5753
5748
|
</dl>
|
|
@@ -5758,7 +5753,9 @@ await client.shipperContactInfo.getByJwtUserIdV1();
|
|
|
5758
5753
|
</dl>
|
|
5759
5754
|
</details>
|
|
5760
5755
|
|
|
5761
|
-
|
|
5756
|
+
## TaskGroups
|
|
5757
|
+
|
|
5758
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
|
|
5762
5759
|
<dl>
|
|
5763
5760
|
<dd>
|
|
5764
5761
|
|
|
@@ -5770,7 +5767,7 @@ await client.shipperContactInfo.getByJwtUserIdV1();
|
|
|
5770
5767
|
<dl>
|
|
5771
5768
|
<dd>
|
|
5772
5769
|
|
|
5773
|
-
|
|
5770
|
+
Updates task group driver assignments by adding or removing drivers.
|
|
5774
5771
|
|
|
5775
5772
|
</dd>
|
|
5776
5773
|
</dl>
|
|
@@ -5786,7 +5783,9 @@ Lists all shipper contacts created by the authenticated organization.
|
|
|
5786
5783
|
<dd>
|
|
5787
5784
|
|
|
5788
5785
|
```typescript
|
|
5789
|
-
await client.
|
|
5786
|
+
await client.taskGroups.updateV1({
|
|
5787
|
+
task_group_id: "task_group_id",
|
|
5788
|
+
});
|
|
5790
5789
|
```
|
|
5791
5790
|
|
|
5792
5791
|
</dd>
|
|
@@ -5802,7 +5801,15 @@ await client.shipperContactInfo.listByJwtOrgIdV1();
|
|
|
5802
5801
|
<dl>
|
|
5803
5802
|
<dd>
|
|
5804
5803
|
|
|
5805
|
-
**
|
|
5804
|
+
**request:** `Chrt.UpdateTaskGroupReq`
|
|
5805
|
+
|
|
5806
|
+
</dd>
|
|
5807
|
+
</dl>
|
|
5808
|
+
|
|
5809
|
+
<dl>
|
|
5810
|
+
<dd>
|
|
5811
|
+
|
|
5812
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
5806
5813
|
|
|
5807
5814
|
</dd>
|
|
5808
5815
|
</dl>
|
|
@@ -5813,7 +5820,7 @@ await client.shipperContactInfo.listByJwtOrgIdV1();
|
|
|
5813
5820
|
</dl>
|
|
5814
5821
|
</details>
|
|
5815
5822
|
|
|
5816
|
-
<details><summary><code>client.
|
|
5823
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">startV1</a>(taskGroupId) -> boolean</code></summary>
|
|
5817
5824
|
<dl>
|
|
5818
5825
|
<dd>
|
|
5819
5826
|
|
|
@@ -5825,7 +5832,7 @@ await client.shipperContactInfo.listByJwtOrgIdV1();
|
|
|
5825
5832
|
<dl>
|
|
5826
5833
|
<dd>
|
|
5827
5834
|
|
|
5828
|
-
|
|
5835
|
+
Starts a task group by changing its status to in-progress and updating the order status. Only authorized personas (task_group_driver or task_group_courier_org_administrator) can start a task group.
|
|
5829
5836
|
|
|
5830
5837
|
</dd>
|
|
5831
5838
|
</dl>
|
|
@@ -5841,7 +5848,7 @@ Lists all shipper contacts accessible to the courier organization for a specific
|
|
|
5841
5848
|
<dd>
|
|
5842
5849
|
|
|
5843
5850
|
```typescript
|
|
5844
|
-
await client.
|
|
5851
|
+
await client.taskGroups.startV1("task_group_id");
|
|
5845
5852
|
```
|
|
5846
5853
|
|
|
5847
5854
|
</dd>
|
|
@@ -5857,7 +5864,7 @@ await client.shipperContactInfo.listCourierContactsByShipperOrgIdV1("shipper_org
|
|
|
5857
5864
|
<dl>
|
|
5858
5865
|
<dd>
|
|
5859
5866
|
|
|
5860
|
-
**
|
|
5867
|
+
**taskGroupId:** `string`
|
|
5861
5868
|
|
|
5862
5869
|
</dd>
|
|
5863
5870
|
</dl>
|
|
@@ -5865,7 +5872,7 @@ await client.shipperContactInfo.listCourierContactsByShipperOrgIdV1("shipper_org
|
|
|
5865
5872
|
<dl>
|
|
5866
5873
|
<dd>
|
|
5867
5874
|
|
|
5868
|
-
**requestOptions:** `
|
|
5875
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
5869
5876
|
|
|
5870
5877
|
</dd>
|
|
5871
5878
|
</dl>
|
|
@@ -5876,7 +5883,7 @@ await client.shipperContactInfo.listCourierContactsByShipperOrgIdV1("shipper_org
|
|
|
5876
5883
|
</dl>
|
|
5877
5884
|
</details>
|
|
5878
5885
|
|
|
5879
|
-
<details><summary><code>client.
|
|
5886
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">togglePauseV1</a>(id, { ...params }) -> boolean</code></summary>
|
|
5880
5887
|
<dl>
|
|
5881
5888
|
<dd>
|
|
5882
5889
|
|
|
@@ -5888,7 +5895,7 @@ await client.shipperContactInfo.listCourierContactsByShipperOrgIdV1("shipper_org
|
|
|
5888
5895
|
<dl>
|
|
5889
5896
|
<dd>
|
|
5890
5897
|
|
|
5891
|
-
|
|
5898
|
+
Toggles the pause status of an in-progress task group.
|
|
5892
5899
|
|
|
5893
5900
|
</dd>
|
|
5894
5901
|
</dl>
|
|
@@ -5904,7 +5911,10 @@ Lists all shipper contacts for a specific off-platform shipper connection.
|
|
|
5904
5911
|
<dd>
|
|
5905
5912
|
|
|
5906
5913
|
```typescript
|
|
5907
|
-
await client.
|
|
5914
|
+
await client.taskGroups.togglePauseV1("id", {
|
|
5915
|
+
task_group_id: "task_group_id",
|
|
5916
|
+
paused: true,
|
|
5917
|
+
});
|
|
5908
5918
|
```
|
|
5909
5919
|
|
|
5910
5920
|
</dd>
|
|
@@ -5920,7 +5930,7 @@ await client.shipperContactInfo.listByOffChrtShipperOrgIdV1("off_chrt_shipper_or
|
|
|
5920
5930
|
<dl>
|
|
5921
5931
|
<dd>
|
|
5922
5932
|
|
|
5923
|
-
**
|
|
5933
|
+
**id:** `string`
|
|
5924
5934
|
|
|
5925
5935
|
</dd>
|
|
5926
5936
|
</dl>
|
|
@@ -5928,7 +5938,15 @@ await client.shipperContactInfo.listByOffChrtShipperOrgIdV1("off_chrt_shipper_or
|
|
|
5928
5938
|
<dl>
|
|
5929
5939
|
<dd>
|
|
5930
5940
|
|
|
5931
|
-
**
|
|
5941
|
+
**request:** `Chrt.SetTaskGroupPauseReq`
|
|
5942
|
+
|
|
5943
|
+
</dd>
|
|
5944
|
+
</dl>
|
|
5945
|
+
|
|
5946
|
+
<dl>
|
|
5947
|
+
<dd>
|
|
5948
|
+
|
|
5949
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
5932
5950
|
|
|
5933
5951
|
</dd>
|
|
5934
5952
|
</dl>
|
|
@@ -5939,7 +5957,9 @@ await client.shipperContactInfo.listByOffChrtShipperOrgIdV1("off_chrt_shipper_or
|
|
|
5939
5957
|
</dl>
|
|
5940
5958
|
</details>
|
|
5941
5959
|
|
|
5942
|
-
|
|
5960
|
+
## ShipperContactInfo
|
|
5961
|
+
|
|
5962
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">getByJwtUserIdV1</a>() -> Chrt.ShipperContact1</code></summary>
|
|
5943
5963
|
<dl>
|
|
5944
5964
|
<dd>
|
|
5945
5965
|
|
|
@@ -5951,7 +5971,7 @@ await client.shipperContactInfo.listByOffChrtShipperOrgIdV1("off_chrt_shipper_or
|
|
|
5951
5971
|
<dl>
|
|
5952
5972
|
<dd>
|
|
5953
5973
|
|
|
5954
|
-
Retrieves
|
|
5974
|
+
Retrieves the authenticated user's own shipper contact information.
|
|
5955
5975
|
|
|
5956
5976
|
</dd>
|
|
5957
5977
|
</dl>
|
|
@@ -5967,7 +5987,7 @@ Retrieves a specific shipper contact by ID if authorized to access it.
|
|
|
5967
5987
|
<dd>
|
|
5968
5988
|
|
|
5969
5989
|
```typescript
|
|
5970
|
-
await client.shipperContactInfo.
|
|
5990
|
+
await client.shipperContactInfo.getByJwtUserIdV1();
|
|
5971
5991
|
```
|
|
5972
5992
|
|
|
5973
5993
|
</dd>
|
|
@@ -5983,14 +6003,6 @@ await client.shipperContactInfo.getByIdV1("id");
|
|
|
5983
6003
|
<dl>
|
|
5984
6004
|
<dd>
|
|
5985
6005
|
|
|
5986
|
-
**id:** `string`
|
|
5987
|
-
|
|
5988
|
-
</dd>
|
|
5989
|
-
</dl>
|
|
5990
|
-
|
|
5991
|
-
<dl>
|
|
5992
|
-
<dd>
|
|
5993
|
-
|
|
5994
6006
|
**requestOptions:** `ShipperContactInfo.RequestOptions`
|
|
5995
6007
|
|
|
5996
6008
|
</dd>
|
|
@@ -6002,7 +6014,7 @@ await client.shipperContactInfo.getByIdV1("id");
|
|
|
6002
6014
|
</dl>
|
|
6003
6015
|
</details>
|
|
6004
6016
|
|
|
6005
|
-
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">
|
|
6017
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">listByJwtOrgIdV1</a>() -> Chrt.ShipperContact1[]</code></summary>
|
|
6006
6018
|
<dl>
|
|
6007
6019
|
<dd>
|
|
6008
6020
|
|
|
@@ -6014,7 +6026,7 @@ await client.shipperContactInfo.getByIdV1("id");
|
|
|
6014
6026
|
<dl>
|
|
6015
6027
|
<dd>
|
|
6016
6028
|
|
|
6017
|
-
|
|
6029
|
+
Lists all shipper contacts created by the authenticated organization.
|
|
6018
6030
|
|
|
6019
6031
|
</dd>
|
|
6020
6032
|
</dl>
|
|
@@ -6030,9 +6042,7 @@ Creates contact information for an on-platform shipper organization or user.
|
|
|
6030
6042
|
<dd>
|
|
6031
6043
|
|
|
6032
6044
|
```typescript
|
|
6033
|
-
await client.shipperContactInfo.
|
|
6034
|
-
schema_version: 1,
|
|
6035
|
-
});
|
|
6045
|
+
await client.shipperContactInfo.listByJwtOrgIdV1();
|
|
6036
6046
|
```
|
|
6037
6047
|
|
|
6038
6048
|
</dd>
|
|
@@ -6048,14 +6058,6 @@ await client.shipperContactInfo.createOnPlatformV1({
|
|
|
6048
6058
|
<dl>
|
|
6049
6059
|
<dd>
|
|
6050
6060
|
|
|
6051
|
-
**request:** `Chrt.ShipperContactClientCreate1`
|
|
6052
|
-
|
|
6053
|
-
</dd>
|
|
6054
|
-
</dl>
|
|
6055
|
-
|
|
6056
|
-
<dl>
|
|
6057
|
-
<dd>
|
|
6058
|
-
|
|
6059
6061
|
**requestOptions:** `ShipperContactInfo.RequestOptions`
|
|
6060
6062
|
|
|
6061
6063
|
</dd>
|
|
@@ -6067,7 +6069,7 @@ await client.shipperContactInfo.createOnPlatformV1({
|
|
|
6067
6069
|
</dl>
|
|
6068
6070
|
</details>
|
|
6069
6071
|
|
|
6070
|
-
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">
|
|
6072
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">listCourierContactsByShipperOrgIdV1</a>(shipperOrgId) -> Chrt.ShipperContact1[]</code></summary>
|
|
6071
6073
|
<dl>
|
|
6072
6074
|
<dd>
|
|
6073
6075
|
|
|
@@ -6079,7 +6081,7 @@ await client.shipperContactInfo.createOnPlatformV1({
|
|
|
6079
6081
|
<dl>
|
|
6080
6082
|
<dd>
|
|
6081
6083
|
|
|
6082
|
-
|
|
6084
|
+
Lists all shipper contacts accessible to the courier organization for a specific on-platform shipper.
|
|
6083
6085
|
|
|
6084
6086
|
</dd>
|
|
6085
6087
|
</dl>
|
|
@@ -6095,9 +6097,7 @@ Creates contact information for an off-platform shipper using connection info.
|
|
|
6095
6097
|
<dd>
|
|
6096
6098
|
|
|
6097
6099
|
```typescript
|
|
6098
|
-
await client.shipperContactInfo.
|
|
6099
|
-
schema_version: 1,
|
|
6100
|
-
});
|
|
6100
|
+
await client.shipperContactInfo.listCourierContactsByShipperOrgIdV1("shipper_org_id");
|
|
6101
6101
|
```
|
|
6102
6102
|
|
|
6103
6103
|
</dd>
|
|
@@ -6113,7 +6113,7 @@ await client.shipperContactInfo.createOffPlatformV1({
|
|
|
6113
6113
|
<dl>
|
|
6114
6114
|
<dd>
|
|
6115
6115
|
|
|
6116
|
-
**
|
|
6116
|
+
**shipperOrgId:** `string`
|
|
6117
6117
|
|
|
6118
6118
|
</dd>
|
|
6119
6119
|
</dl>
|
|
@@ -6132,7 +6132,7 @@ await client.shipperContactInfo.createOffPlatformV1({
|
|
|
6132
6132
|
</dl>
|
|
6133
6133
|
</details>
|
|
6134
6134
|
|
|
6135
|
-
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">
|
|
6135
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">listByOffChrtShipperOrgIdV1</a>(offChrtShipperOrgId) -> Chrt.ShipperContact1[]</code></summary>
|
|
6136
6136
|
<dl>
|
|
6137
6137
|
<dd>
|
|
6138
6138
|
|
|
@@ -6144,7 +6144,7 @@ await client.shipperContactInfo.createOffPlatformV1({
|
|
|
6144
6144
|
<dl>
|
|
6145
6145
|
<dd>
|
|
6146
6146
|
|
|
6147
|
-
|
|
6147
|
+
Lists all shipper contacts for a specific off-platform shipper connection.
|
|
6148
6148
|
|
|
6149
6149
|
</dd>
|
|
6150
6150
|
</dl>
|
|
@@ -6160,7 +6160,7 @@ Updates existing shipper contact information owned by the authenticated organiza
|
|
|
6160
6160
|
<dd>
|
|
6161
6161
|
|
|
6162
6162
|
```typescript
|
|
6163
|
-
await client.shipperContactInfo.
|
|
6163
|
+
await client.shipperContactInfo.listByOffChrtShipperOrgIdV1("off_chrt_shipper_org_id");
|
|
6164
6164
|
```
|
|
6165
6165
|
|
|
6166
6166
|
</dd>
|
|
@@ -6176,15 +6176,7 @@ await client.shipperContactInfo.updateV1("shipper_contact_info_id");
|
|
|
6176
6176
|
<dl>
|
|
6177
6177
|
<dd>
|
|
6178
6178
|
|
|
6179
|
-
**
|
|
6180
|
-
|
|
6181
|
-
</dd>
|
|
6182
|
-
</dl>
|
|
6183
|
-
|
|
6184
|
-
<dl>
|
|
6185
|
-
<dd>
|
|
6186
|
-
|
|
6187
|
-
**request:** `Chrt.ShipperContactClientUpdate1`
|
|
6179
|
+
**offChrtShipperOrgId:** `string`
|
|
6188
6180
|
|
|
6189
6181
|
</dd>
|
|
6190
6182
|
</dl>
|
|
@@ -6203,7 +6195,7 @@ await client.shipperContactInfo.updateV1("shipper_contact_info_id");
|
|
|
6203
6195
|
</dl>
|
|
6204
6196
|
</details>
|
|
6205
6197
|
|
|
6206
|
-
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">
|
|
6198
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">getByIdV1</a>(id) -> Chrt.ShipperContact1</code></summary>
|
|
6207
6199
|
<dl>
|
|
6208
6200
|
<dd>
|
|
6209
6201
|
|
|
@@ -6215,7 +6207,7 @@ await client.shipperContactInfo.updateV1("shipper_contact_info_id");
|
|
|
6215
6207
|
<dl>
|
|
6216
6208
|
<dd>
|
|
6217
6209
|
|
|
6218
|
-
|
|
6210
|
+
Retrieves a specific shipper contact by ID if authorized to access it.
|
|
6219
6211
|
|
|
6220
6212
|
</dd>
|
|
6221
6213
|
</dl>
|
|
@@ -6231,7 +6223,7 @@ Deletes shipper contact information owned by the authenticated organization.
|
|
|
6231
6223
|
<dd>
|
|
6232
6224
|
|
|
6233
6225
|
```typescript
|
|
6234
|
-
await client.shipperContactInfo.
|
|
6226
|
+
await client.shipperContactInfo.getByIdV1("id");
|
|
6235
6227
|
```
|
|
6236
6228
|
|
|
6237
6229
|
</dd>
|
|
@@ -6266,9 +6258,7 @@ await client.shipperContactInfo.deleteByIdV1("id");
|
|
|
6266
6258
|
</dl>
|
|
6267
6259
|
</details>
|
|
6268
6260
|
|
|
6269
|
-
|
|
6270
|
-
|
|
6271
|
-
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getInfoV1</a>() -> unknown</code></summary>
|
|
6261
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">createOnPlatformV1</a>({ ...params }) -> string</code></summary>
|
|
6272
6262
|
<dl>
|
|
6273
6263
|
<dd>
|
|
6274
6264
|
|
|
@@ -6280,7 +6270,7 @@ await client.shipperContactInfo.deleteByIdV1("id");
|
|
|
6280
6270
|
<dl>
|
|
6281
6271
|
<dd>
|
|
6282
6272
|
|
|
6283
|
-
|
|
6273
|
+
Creates contact information for an on-platform shipper organization or user.
|
|
6284
6274
|
|
|
6285
6275
|
</dd>
|
|
6286
6276
|
</dl>
|
|
@@ -6296,7 +6286,9 @@ Retrieves basic organization information from the authentication service.
|
|
|
6296
6286
|
<dd>
|
|
6297
6287
|
|
|
6298
6288
|
```typescript
|
|
6299
|
-
await client.
|
|
6289
|
+
await client.shipperContactInfo.createOnPlatformV1({
|
|
6290
|
+
schema_version: 1,
|
|
6291
|
+
});
|
|
6300
6292
|
```
|
|
6301
6293
|
|
|
6302
6294
|
</dd>
|
|
@@ -6312,7 +6304,15 @@ await client.orgs.getInfoV1();
|
|
|
6312
6304
|
<dl>
|
|
6313
6305
|
<dd>
|
|
6314
6306
|
|
|
6315
|
-
**
|
|
6307
|
+
**request:** `Chrt.ShipperContactClientCreate1`
|
|
6308
|
+
|
|
6309
|
+
</dd>
|
|
6310
|
+
</dl>
|
|
6311
|
+
|
|
6312
|
+
<dl>
|
|
6313
|
+
<dd>
|
|
6314
|
+
|
|
6315
|
+
**requestOptions:** `ShipperContactInfo.RequestOptions`
|
|
6316
6316
|
|
|
6317
6317
|
</dd>
|
|
6318
6318
|
</dl>
|
|
@@ -6323,7 +6323,7 @@ await client.orgs.getInfoV1();
|
|
|
6323
6323
|
</dl>
|
|
6324
6324
|
</details>
|
|
6325
6325
|
|
|
6326
|
-
<details><summary><code>client.
|
|
6326
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">createOffPlatformV1</a>({ ...params }) -> string</code></summary>
|
|
6327
6327
|
<dl>
|
|
6328
6328
|
<dd>
|
|
6329
6329
|
|
|
@@ -6335,7 +6335,7 @@ await client.orgs.getInfoV1();
|
|
|
6335
6335
|
<dl>
|
|
6336
6336
|
<dd>
|
|
6337
6337
|
|
|
6338
|
-
|
|
6338
|
+
Creates contact information for an off-platform shipper using connection info.
|
|
6339
6339
|
|
|
6340
6340
|
</dd>
|
|
6341
6341
|
</dl>
|
|
@@ -6351,7 +6351,9 @@ Lists all members of the authenticated organization with their roles and details
|
|
|
6351
6351
|
<dd>
|
|
6352
6352
|
|
|
6353
6353
|
```typescript
|
|
6354
|
-
await client.
|
|
6354
|
+
await client.shipperContactInfo.createOffPlatformV1({
|
|
6355
|
+
schema_version: 1,
|
|
6356
|
+
});
|
|
6355
6357
|
```
|
|
6356
6358
|
|
|
6357
6359
|
</dd>
|
|
@@ -6367,7 +6369,15 @@ await client.orgs.listMembersV1();
|
|
|
6367
6369
|
<dl>
|
|
6368
6370
|
<dd>
|
|
6369
6371
|
|
|
6370
|
-
**
|
|
6372
|
+
**request:** `Chrt.ShipperContactClientCreate1`
|
|
6373
|
+
|
|
6374
|
+
</dd>
|
|
6375
|
+
</dl>
|
|
6376
|
+
|
|
6377
|
+
<dl>
|
|
6378
|
+
<dd>
|
|
6379
|
+
|
|
6380
|
+
**requestOptions:** `ShipperContactInfo.RequestOptions`
|
|
6371
6381
|
|
|
6372
6382
|
</dd>
|
|
6373
6383
|
</dl>
|
|
@@ -6378,7 +6388,7 @@ await client.orgs.listMembersV1();
|
|
|
6378
6388
|
</dl>
|
|
6379
6389
|
</details>
|
|
6380
6390
|
|
|
6381
|
-
<details><summary><code>client.
|
|
6391
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">updateV1</a>(shipperContactInfoId, { ...params }) -> boolean</code></summary>
|
|
6382
6392
|
<dl>
|
|
6383
6393
|
<dd>
|
|
6384
6394
|
|
|
@@ -6390,7 +6400,7 @@ await client.orgs.listMembersV1();
|
|
|
6390
6400
|
<dl>
|
|
6391
6401
|
<dd>
|
|
6392
6402
|
|
|
6393
|
-
|
|
6403
|
+
Updates existing shipper contact information owned by the authenticated organization.
|
|
6394
6404
|
|
|
6395
6405
|
</dd>
|
|
6396
6406
|
</dl>
|
|
@@ -6406,7 +6416,7 @@ Retrieves public organization data for the authenticated organization.
|
|
|
6406
6416
|
<dd>
|
|
6407
6417
|
|
|
6408
6418
|
```typescript
|
|
6409
|
-
await client.
|
|
6419
|
+
await client.shipperContactInfo.updateV1("shipper_contact_info_id");
|
|
6410
6420
|
```
|
|
6411
6421
|
|
|
6412
6422
|
</dd>
|
|
@@ -6422,7 +6432,23 @@ await client.orgs.getOrgPublicDataV1();
|
|
|
6422
6432
|
<dl>
|
|
6423
6433
|
<dd>
|
|
6424
6434
|
|
|
6425
|
-
**
|
|
6435
|
+
**shipperContactInfoId:** `string`
|
|
6436
|
+
|
|
6437
|
+
</dd>
|
|
6438
|
+
</dl>
|
|
6439
|
+
|
|
6440
|
+
<dl>
|
|
6441
|
+
<dd>
|
|
6442
|
+
|
|
6443
|
+
**request:** `Chrt.ShipperContactClientUpdate1`
|
|
6444
|
+
|
|
6445
|
+
</dd>
|
|
6446
|
+
</dl>
|
|
6447
|
+
|
|
6448
|
+
<dl>
|
|
6449
|
+
<dd>
|
|
6450
|
+
|
|
6451
|
+
**requestOptions:** `ShipperContactInfo.RequestOptions`
|
|
6426
6452
|
|
|
6427
6453
|
</dd>
|
|
6428
6454
|
</dl>
|
|
@@ -6433,7 +6459,7 @@ await client.orgs.getOrgPublicDataV1();
|
|
|
6433
6459
|
</dl>
|
|
6434
6460
|
</details>
|
|
6435
6461
|
|
|
6436
|
-
<details><summary><code>client.
|
|
6462
|
+
<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">deleteByIdV1</a>(id) -> boolean</code></summary>
|
|
6437
6463
|
<dl>
|
|
6438
6464
|
<dd>
|
|
6439
6465
|
|
|
@@ -6445,7 +6471,7 @@ await client.orgs.getOrgPublicDataV1();
|
|
|
6445
6471
|
<dl>
|
|
6446
6472
|
<dd>
|
|
6447
6473
|
|
|
6448
|
-
|
|
6474
|
+
Deletes shipper contact information owned by the authenticated organization.
|
|
6449
6475
|
|
|
6450
6476
|
</dd>
|
|
6451
6477
|
</dl>
|
|
@@ -6461,9 +6487,7 @@ Creates an org_public_data document for the authenticated organization.
|
|
|
6461
6487
|
<dd>
|
|
6462
6488
|
|
|
6463
6489
|
```typescript
|
|
6464
|
-
await client.
|
|
6465
|
-
org_type: "courier",
|
|
6466
|
-
});
|
|
6490
|
+
await client.shipperContactInfo.deleteByIdV1("id");
|
|
6467
6491
|
```
|
|
6468
6492
|
|
|
6469
6493
|
</dd>
|
|
@@ -6479,7 +6503,7 @@ await client.orgs.createOrgPublicDataV1({
|
|
|
6479
6503
|
<dl>
|
|
6480
6504
|
<dd>
|
|
6481
6505
|
|
|
6482
|
-
**
|
|
6506
|
+
**id:** `string`
|
|
6483
6507
|
|
|
6484
6508
|
</dd>
|
|
6485
6509
|
</dl>
|
|
@@ -6487,7 +6511,7 @@ await client.orgs.createOrgPublicDataV1({
|
|
|
6487
6511
|
<dl>
|
|
6488
6512
|
<dd>
|
|
6489
6513
|
|
|
6490
|
-
**requestOptions:** `
|
|
6514
|
+
**requestOptions:** `ShipperContactInfo.RequestOptions`
|
|
6491
6515
|
|
|
6492
6516
|
</dd>
|
|
6493
6517
|
</dl>
|
|
@@ -6498,7 +6522,9 @@ await client.orgs.createOrgPublicDataV1({
|
|
|
6498
6522
|
</dl>
|
|
6499
6523
|
</details>
|
|
6500
6524
|
|
|
6501
|
-
|
|
6525
|
+
## Orgs
|
|
6526
|
+
|
|
6527
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getInfoV1</a>() -> unknown</code></summary>
|
|
6502
6528
|
<dl>
|
|
6503
6529
|
<dd>
|
|
6504
6530
|
|
|
@@ -6510,7 +6536,7 @@ await client.orgs.createOrgPublicDataV1({
|
|
|
6510
6536
|
<dl>
|
|
6511
6537
|
<dd>
|
|
6512
6538
|
|
|
6513
|
-
|
|
6539
|
+
Retrieves basic organization information from the authentication service.
|
|
6514
6540
|
|
|
6515
6541
|
</dd>
|
|
6516
6542
|
</dl>
|
|
@@ -6526,7 +6552,7 @@ Updates the handle and/or company_name for the authenticated organization.
|
|
|
6526
6552
|
<dd>
|
|
6527
6553
|
|
|
6528
6554
|
```typescript
|
|
6529
|
-
await client.orgs.
|
|
6555
|
+
await client.orgs.getInfoV1();
|
|
6530
6556
|
```
|
|
6531
6557
|
|
|
6532
6558
|
</dd>
|
|
@@ -6542,14 +6568,6 @@ await client.orgs.updateOrgPublicDataV1();
|
|
|
6542
6568
|
<dl>
|
|
6543
6569
|
<dd>
|
|
6544
6570
|
|
|
6545
|
-
**request:** `Chrt.UpdateOrgPublicDataReq`
|
|
6546
|
-
|
|
6547
|
-
</dd>
|
|
6548
|
-
</dl>
|
|
6549
|
-
|
|
6550
|
-
<dl>
|
|
6551
|
-
<dd>
|
|
6552
|
-
|
|
6553
6571
|
**requestOptions:** `Orgs.RequestOptions`
|
|
6554
6572
|
|
|
6555
6573
|
</dd>
|
|
@@ -6561,7 +6579,7 @@ await client.orgs.updateOrgPublicDataV1();
|
|
|
6561
6579
|
</dl>
|
|
6562
6580
|
</details>
|
|
6563
6581
|
|
|
6564
|
-
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">
|
|
6582
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">listMembersV1</a>() -> Chrt.OrgMemberDetails[]</code></summary>
|
|
6565
6583
|
<dl>
|
|
6566
6584
|
<dd>
|
|
6567
6585
|
|
|
@@ -6573,7 +6591,7 @@ await client.orgs.updateOrgPublicDataV1();
|
|
|
6573
6591
|
<dl>
|
|
6574
6592
|
<dd>
|
|
6575
6593
|
|
|
6576
|
-
|
|
6594
|
+
Lists all members of the authenticated organization with their roles and details.
|
|
6577
6595
|
|
|
6578
6596
|
</dd>
|
|
6579
6597
|
</dl>
|
|
@@ -6589,7 +6607,7 @@ Retrieves public organization data for a specific organization by ID.
|
|
|
6589
6607
|
<dd>
|
|
6590
6608
|
|
|
6591
6609
|
```typescript
|
|
6592
|
-
await client.orgs.
|
|
6610
|
+
await client.orgs.listMembersV1();
|
|
6593
6611
|
```
|
|
6594
6612
|
|
|
6595
6613
|
</dd>
|
|
@@ -6605,14 +6623,6 @@ await client.orgs.getOrgPublicDataByOrgIdV1("org_id");
|
|
|
6605
6623
|
<dl>
|
|
6606
6624
|
<dd>
|
|
6607
6625
|
|
|
6608
|
-
**orgId:** `string`
|
|
6609
|
-
|
|
6610
|
-
</dd>
|
|
6611
|
-
</dl>
|
|
6612
|
-
|
|
6613
|
-
<dl>
|
|
6614
|
-
<dd>
|
|
6615
|
-
|
|
6616
6626
|
**requestOptions:** `Orgs.RequestOptions`
|
|
6617
6627
|
|
|
6618
6628
|
</dd>
|
|
@@ -6624,7 +6634,7 @@ await client.orgs.getOrgPublicDataByOrgIdV1("org_id");
|
|
|
6624
6634
|
</dl>
|
|
6625
6635
|
</details>
|
|
6626
6636
|
|
|
6627
|
-
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">
|
|
6637
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getOrgPublicDataV1</a>() -> Chrt.OrgPublicData1</code></summary>
|
|
6628
6638
|
<dl>
|
|
6629
6639
|
<dd>
|
|
6630
6640
|
|
|
@@ -6636,7 +6646,7 @@ await client.orgs.getOrgPublicDataByOrgIdV1("org_id");
|
|
|
6636
6646
|
<dl>
|
|
6637
6647
|
<dd>
|
|
6638
6648
|
|
|
6639
|
-
|
|
6649
|
+
Retrieves public organization data for the authenticated organization.
|
|
6640
6650
|
|
|
6641
6651
|
</dd>
|
|
6642
6652
|
</dl>
|
|
@@ -6652,7 +6662,7 @@ Returns True when the provided handle is available, otherwise False.
|
|
|
6652
6662
|
<dd>
|
|
6653
6663
|
|
|
6654
6664
|
```typescript
|
|
6655
|
-
await client.orgs.
|
|
6665
|
+
await client.orgs.getOrgPublicDataV1();
|
|
6656
6666
|
```
|
|
6657
6667
|
|
|
6658
6668
|
</dd>
|
|
@@ -6668,14 +6678,6 @@ await client.orgs.getOrgPublicDataHandleAvailabilityV1("handle");
|
|
|
6668
6678
|
<dl>
|
|
6669
6679
|
<dd>
|
|
6670
6680
|
|
|
6671
|
-
**handle:** `string`
|
|
6672
|
-
|
|
6673
|
-
</dd>
|
|
6674
|
-
</dl>
|
|
6675
|
-
|
|
6676
|
-
<dl>
|
|
6677
|
-
<dd>
|
|
6678
|
-
|
|
6679
6681
|
**requestOptions:** `Orgs.RequestOptions`
|
|
6680
6682
|
|
|
6681
6683
|
</dd>
|
|
@@ -6687,9 +6689,7 @@ await client.orgs.getOrgPublicDataHandleAvailabilityV1("handle");
|
|
|
6687
6689
|
</dl>
|
|
6688
6690
|
</details>
|
|
6689
6691
|
|
|
6690
|
-
|
|
6691
|
-
|
|
6692
|
-
<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">pingAuthd</a>() -> Record<string, string></code></summary>
|
|
6692
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">createOrgPublicDataV1</a>({ ...params }) -> string</code></summary>
|
|
6693
6693
|
<dl>
|
|
6694
6694
|
<dd>
|
|
6695
6695
|
|
|
@@ -6701,7 +6701,7 @@ await client.orgs.getOrgPublicDataHandleAvailabilityV1("handle");
|
|
|
6701
6701
|
<dl>
|
|
6702
6702
|
<dd>
|
|
6703
6703
|
|
|
6704
|
-
|
|
6704
|
+
Creates an org_public_data document for the authenticated organization.
|
|
6705
6705
|
|
|
6706
6706
|
</dd>
|
|
6707
6707
|
</dl>
|
|
@@ -6717,7 +6717,9 @@ Test endpoint for authenticated requests that requires valid authentication toke
|
|
|
6717
6717
|
<dd>
|
|
6718
6718
|
|
|
6719
6719
|
```typescript
|
|
6720
|
-
await client.
|
|
6720
|
+
await client.orgs.createOrgPublicDataV1({
|
|
6721
|
+
org_type: "courier",
|
|
6722
|
+
});
|
|
6721
6723
|
```
|
|
6722
6724
|
|
|
6723
6725
|
</dd>
|
|
@@ -6733,7 +6735,15 @@ await client.root.pingAuthd();
|
|
|
6733
6735
|
<dl>
|
|
6734
6736
|
<dd>
|
|
6735
6737
|
|
|
6736
|
-
**
|
|
6738
|
+
**request:** `Chrt.CreateOrgPublicDataReq`
|
|
6739
|
+
|
|
6740
|
+
</dd>
|
|
6741
|
+
</dl>
|
|
6742
|
+
|
|
6743
|
+
<dl>
|
|
6744
|
+
<dd>
|
|
6745
|
+
|
|
6746
|
+
**requestOptions:** `Orgs.RequestOptions`
|
|
6737
6747
|
|
|
6738
6748
|
</dd>
|
|
6739
6749
|
</dl>
|
|
@@ -6744,7 +6754,7 @@ await client.root.pingAuthd();
|
|
|
6744
6754
|
</dl>
|
|
6745
6755
|
</details>
|
|
6746
6756
|
|
|
6747
|
-
<details><summary><code>client.
|
|
6757
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">updateOrgPublicDataV1</a>({ ...params }) -> boolean</code></summary>
|
|
6748
6758
|
<dl>
|
|
6749
6759
|
<dd>
|
|
6750
6760
|
|
|
@@ -6756,7 +6766,7 @@ await client.root.pingAuthd();
|
|
|
6756
6766
|
<dl>
|
|
6757
6767
|
<dd>
|
|
6758
6768
|
|
|
6759
|
-
|
|
6769
|
+
Updates the handle and/or company_name for the authenticated organization.
|
|
6760
6770
|
|
|
6761
6771
|
</dd>
|
|
6762
6772
|
</dl>
|
|
@@ -6772,7 +6782,7 @@ Test endpoint for optionally authenticated requests that works with or without a
|
|
|
6772
6782
|
<dd>
|
|
6773
6783
|
|
|
6774
6784
|
```typescript
|
|
6775
|
-
await client.
|
|
6785
|
+
await client.orgs.updateOrgPublicDataV1();
|
|
6776
6786
|
```
|
|
6777
6787
|
|
|
6778
6788
|
</dd>
|
|
@@ -6788,7 +6798,15 @@ await client.root.pingOptionallyAuthd();
|
|
|
6788
6798
|
<dl>
|
|
6789
6799
|
<dd>
|
|
6790
6800
|
|
|
6791
|
-
**
|
|
6801
|
+
**request:** `Chrt.UpdateOrgPublicDataReq`
|
|
6802
|
+
|
|
6803
|
+
</dd>
|
|
6804
|
+
</dl>
|
|
6805
|
+
|
|
6806
|
+
<dl>
|
|
6807
|
+
<dd>
|
|
6808
|
+
|
|
6809
|
+
**requestOptions:** `Orgs.RequestOptions`
|
|
6792
6810
|
|
|
6793
6811
|
</dd>
|
|
6794
6812
|
</dl>
|
|
@@ -6799,7 +6817,7 @@ await client.root.pingOptionallyAuthd();
|
|
|
6799
6817
|
</dl>
|
|
6800
6818
|
</details>
|
|
6801
6819
|
|
|
6802
|
-
<details><summary><code>client.
|
|
6820
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getOrgPublicDataByOrgIdV1</a>(orgId) -> Chrt.OrgPublicData1</code></summary>
|
|
6803
6821
|
<dl>
|
|
6804
6822
|
<dd>
|
|
6805
6823
|
|
|
@@ -6811,7 +6829,7 @@ await client.root.pingOptionallyAuthd();
|
|
|
6811
6829
|
<dl>
|
|
6812
6830
|
<dd>
|
|
6813
6831
|
|
|
6814
|
-
|
|
6832
|
+
Retrieves public organization data for a specific organization by ID.
|
|
6815
6833
|
|
|
6816
6834
|
</dd>
|
|
6817
6835
|
</dl>
|
|
@@ -6827,7 +6845,7 @@ Returns a greeting message to verify the API is accessible.
|
|
|
6827
6845
|
<dd>
|
|
6828
6846
|
|
|
6829
6847
|
```typescript
|
|
6830
|
-
await client.
|
|
6848
|
+
await client.orgs.getOrgPublicDataByOrgIdV1("org_id");
|
|
6831
6849
|
```
|
|
6832
6850
|
|
|
6833
6851
|
</dd>
|
|
@@ -6843,7 +6861,15 @@ await client.root.pingUnauthd();
|
|
|
6843
6861
|
<dl>
|
|
6844
6862
|
<dd>
|
|
6845
6863
|
|
|
6846
|
-
**
|
|
6864
|
+
**orgId:** `string`
|
|
6865
|
+
|
|
6866
|
+
</dd>
|
|
6867
|
+
</dl>
|
|
6868
|
+
|
|
6869
|
+
<dl>
|
|
6870
|
+
<dd>
|
|
6871
|
+
|
|
6872
|
+
**requestOptions:** `Orgs.RequestOptions`
|
|
6847
6873
|
|
|
6848
6874
|
</dd>
|
|
6849
6875
|
</dl>
|
|
@@ -6854,7 +6880,7 @@ await client.root.pingUnauthd();
|
|
|
6854
6880
|
</dl>
|
|
6855
6881
|
</details>
|
|
6856
6882
|
|
|
6857
|
-
<details><summary><code>client.
|
|
6883
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getOrgPublicDataHandleAvailabilityV1</a>(handle) -> boolean</code></summary>
|
|
6858
6884
|
<dl>
|
|
6859
6885
|
<dd>
|
|
6860
6886
|
|
|
@@ -6866,7 +6892,7 @@ await client.root.pingUnauthd();
|
|
|
6866
6892
|
<dl>
|
|
6867
6893
|
<dd>
|
|
6868
6894
|
|
|
6869
|
-
Returns
|
|
6895
|
+
Returns True when the provided handle is available, otherwise False.
|
|
6870
6896
|
|
|
6871
6897
|
</dd>
|
|
6872
6898
|
</dl>
|
|
@@ -6882,7 +6908,7 @@ Returns a health status message used for monitoring system availability and upti
|
|
|
6882
6908
|
<dd>
|
|
6883
6909
|
|
|
6884
6910
|
```typescript
|
|
6885
|
-
await client.
|
|
6911
|
+
await client.orgs.getOrgPublicDataHandleAvailabilityV1("handle");
|
|
6886
6912
|
```
|
|
6887
6913
|
|
|
6888
6914
|
</dd>
|
|
@@ -6898,7 +6924,15 @@ await client.root.health();
|
|
|
6898
6924
|
<dl>
|
|
6899
6925
|
<dd>
|
|
6900
6926
|
|
|
6901
|
-
**
|
|
6927
|
+
**handle:** `string`
|
|
6928
|
+
|
|
6929
|
+
</dd>
|
|
6930
|
+
</dl>
|
|
6931
|
+
|
|
6932
|
+
<dl>
|
|
6933
|
+
<dd>
|
|
6934
|
+
|
|
6935
|
+
**requestOptions:** `Orgs.RequestOptions`
|
|
6902
6936
|
|
|
6903
6937
|
</dd>
|
|
6904
6938
|
</dl>
|
|
@@ -6909,7 +6943,9 @@ await client.root.health();
|
|
|
6909
6943
|
</dl>
|
|
6910
6944
|
</details>
|
|
6911
6945
|
|
|
6912
|
-
|
|
6946
|
+
## Root
|
|
6947
|
+
|
|
6948
|
+
<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">pingAuthd</a>() -> Record<string, string></code></summary>
|
|
6913
6949
|
<dl>
|
|
6914
6950
|
<dd>
|
|
6915
6951
|
|
|
@@ -6921,7 +6957,7 @@ await client.root.health();
|
|
|
6921
6957
|
<dl>
|
|
6922
6958
|
<dd>
|
|
6923
6959
|
|
|
6924
|
-
Test endpoint
|
|
6960
|
+
Test endpoint for authenticated requests that requires valid authentication tokens.
|
|
6925
6961
|
|
|
6926
6962
|
</dd>
|
|
6927
6963
|
</dl>
|
|
@@ -6937,7 +6973,7 @@ Test endpoint that intentionally fails for error handling validation and monitor
|
|
|
6937
6973
|
<dd>
|
|
6938
6974
|
|
|
6939
6975
|
```typescript
|
|
6940
|
-
await client.root.
|
|
6976
|
+
await client.root.pingAuthd();
|
|
6941
6977
|
```
|
|
6942
6978
|
|
|
6943
6979
|
</dd>
|
|
@@ -6964,9 +7000,7 @@ await client.root.failure();
|
|
|
6964
7000
|
</dl>
|
|
6965
7001
|
</details>
|
|
6966
7002
|
|
|
6967
|
-
|
|
6968
|
-
|
|
6969
|
-
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">getPublicDataV1</a>() -> Chrt.UserPublicData1</code></summary>
|
|
7003
|
+
<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">pingOptionallyAuthd</a>() -> unknown</code></summary>
|
|
6970
7004
|
<dl>
|
|
6971
7005
|
<dd>
|
|
6972
7006
|
|
|
@@ -6978,7 +7012,7 @@ await client.root.failure();
|
|
|
6978
7012
|
<dl>
|
|
6979
7013
|
<dd>
|
|
6980
7014
|
|
|
6981
|
-
|
|
7015
|
+
Test endpoint for optionally authenticated requests that works with or without authentication.
|
|
6982
7016
|
|
|
6983
7017
|
</dd>
|
|
6984
7018
|
</dl>
|
|
@@ -6994,7 +7028,7 @@ Retrieves public user data for the authenticated user, including email, notes, a
|
|
|
6994
7028
|
<dd>
|
|
6995
7029
|
|
|
6996
7030
|
```typescript
|
|
6997
|
-
await client.
|
|
7031
|
+
await client.root.pingOptionallyAuthd();
|
|
6998
7032
|
```
|
|
6999
7033
|
|
|
7000
7034
|
</dd>
|
|
@@ -7010,7 +7044,7 @@ await client.users.getPublicDataV1();
|
|
|
7010
7044
|
<dl>
|
|
7011
7045
|
<dd>
|
|
7012
7046
|
|
|
7013
|
-
**requestOptions:** `
|
|
7047
|
+
**requestOptions:** `Root.RequestOptions`
|
|
7014
7048
|
|
|
7015
7049
|
</dd>
|
|
7016
7050
|
</dl>
|
|
@@ -7021,9 +7055,7 @@ await client.users.getPublicDataV1();
|
|
|
7021
7055
|
</dl>
|
|
7022
7056
|
</details>
|
|
7023
7057
|
|
|
7024
|
-
|
|
7025
|
-
|
|
7026
|
-
<details><summary><code>client.utils.<a href="/src/api/resources/utils/client/Client.ts">getTimezoneV1</a>({ ...params }) -> Chrt.TimezoneResponse</code></summary>
|
|
7058
|
+
<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">pingUnauthd</a>() -> unknown</code></summary>
|
|
7027
7059
|
<dl>
|
|
7028
7060
|
<dd>
|
|
7029
7061
|
|
|
@@ -7035,7 +7067,7 @@ await client.users.getPublicDataV1();
|
|
|
7035
7067
|
<dl>
|
|
7036
7068
|
<dd>
|
|
7037
7069
|
|
|
7038
|
-
Returns
|
|
7070
|
+
Returns a greeting message to verify the API is accessible.
|
|
7039
7071
|
|
|
7040
7072
|
</dd>
|
|
7041
7073
|
</dl>
|
|
@@ -7051,10 +7083,7 @@ Returns the IANA timezone identifier (e.g., 'America/Los_Angeles') for the given
|
|
|
7051
7083
|
<dd>
|
|
7052
7084
|
|
|
7053
7085
|
```typescript
|
|
7054
|
-
await client.
|
|
7055
|
-
lat: 37.7749,
|
|
7056
|
-
lng: -122.4194,
|
|
7057
|
-
});
|
|
7086
|
+
await client.root.pingUnauthd();
|
|
7058
7087
|
```
|
|
7059
7088
|
|
|
7060
7089
|
</dd>
|
|
@@ -7070,15 +7099,7 @@ await client.utils.getTimezoneV1({
|
|
|
7070
7099
|
<dl>
|
|
7071
7100
|
<dd>
|
|
7072
7101
|
|
|
7073
|
-
**
|
|
7074
|
-
|
|
7075
|
-
</dd>
|
|
7076
|
-
</dl>
|
|
7077
|
-
|
|
7078
|
-
<dl>
|
|
7079
|
-
<dd>
|
|
7080
|
-
|
|
7081
|
-
**requestOptions:** `Utils.RequestOptions`
|
|
7102
|
+
**requestOptions:** `Root.RequestOptions`
|
|
7082
7103
|
|
|
7083
7104
|
</dd>
|
|
7084
7105
|
</dl>
|
|
@@ -7089,9 +7110,7 @@ await client.utils.getTimezoneV1({
|
|
|
7089
7110
|
</dl>
|
|
7090
7111
|
</details>
|
|
7091
7112
|
|
|
7092
|
-
|
|
7093
|
-
|
|
7094
|
-
<details><summary><code>client.connections.connectionToCourier.<a href="/src/api/resources/connections/resources/connectionToCourier/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
7113
|
+
<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">health</a>() -> unknown</code></summary>
|
|
7095
7114
|
<dl>
|
|
7096
7115
|
<dd>
|
|
7097
7116
|
|
|
@@ -7103,7 +7122,7 @@ await client.utils.getTimezoneV1({
|
|
|
7103
7122
|
<dl>
|
|
7104
7123
|
<dd>
|
|
7105
7124
|
|
|
7106
|
-
|
|
7125
|
+
Returns a health status message used for monitoring system availability and uptime.
|
|
7107
7126
|
|
|
7108
7127
|
</dd>
|
|
7109
7128
|
</dl>
|
|
@@ -7119,9 +7138,7 @@ Creates a new connection to a courier organization. Shippers and forwarders can
|
|
|
7119
7138
|
<dd>
|
|
7120
7139
|
|
|
7121
7140
|
```typescript
|
|
7122
|
-
await client.
|
|
7123
|
-
handle: "handle",
|
|
7124
|
-
});
|
|
7141
|
+
await client.root.health();
|
|
7125
7142
|
```
|
|
7126
7143
|
|
|
7127
7144
|
</dd>
|
|
@@ -7137,15 +7154,7 @@ await client.connections.connectionToCourier.createV1({
|
|
|
7137
7154
|
<dl>
|
|
7138
7155
|
<dd>
|
|
7139
7156
|
|
|
7140
|
-
**
|
|
7141
|
-
|
|
7142
|
-
</dd>
|
|
7143
|
-
</dl>
|
|
7144
|
-
|
|
7145
|
-
<dl>
|
|
7146
|
-
<dd>
|
|
7147
|
-
|
|
7148
|
-
**requestOptions:** `ConnectionToCourier.RequestOptions`
|
|
7157
|
+
**requestOptions:** `Root.RequestOptions`
|
|
7149
7158
|
|
|
7150
7159
|
</dd>
|
|
7151
7160
|
</dl>
|
|
@@ -7156,9 +7165,7 @@ await client.connections.connectionToCourier.createV1({
|
|
|
7156
7165
|
</dl>
|
|
7157
7166
|
</details>
|
|
7158
7167
|
|
|
7159
|
-
|
|
7160
|
-
|
|
7161
|
-
<details><summary><code>client.connections.connectionToShipper.<a href="/src/api/resources/connections/resources/connectionToShipper/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
7168
|
+
<details><summary><code>client.root.<a href="/src/api/resources/root/client/Client.ts">failure</a>() -> unknown</code></summary>
|
|
7162
7169
|
<dl>
|
|
7163
7170
|
<dd>
|
|
7164
7171
|
|
|
@@ -7170,7 +7177,7 @@ await client.connections.connectionToCourier.createV1({
|
|
|
7170
7177
|
<dl>
|
|
7171
7178
|
<dd>
|
|
7172
7179
|
|
|
7173
|
-
|
|
7180
|
+
Test endpoint that intentionally fails for error handling validation and monitoring purposes.
|
|
7174
7181
|
|
|
7175
7182
|
</dd>
|
|
7176
7183
|
</dl>
|
|
@@ -7186,9 +7193,7 @@ Creates a new connection to a shipper organization. Only forwarders can initiate
|
|
|
7186
7193
|
<dd>
|
|
7187
7194
|
|
|
7188
7195
|
```typescript
|
|
7189
|
-
await client.
|
|
7190
|
-
handle: "handle",
|
|
7191
|
-
});
|
|
7196
|
+
await client.root.failure();
|
|
7192
7197
|
```
|
|
7193
7198
|
|
|
7194
7199
|
</dd>
|
|
@@ -7204,15 +7209,7 @@ await client.connections.connectionToShipper.createV1({
|
|
|
7204
7209
|
<dl>
|
|
7205
7210
|
<dd>
|
|
7206
7211
|
|
|
7207
|
-
**
|
|
7208
|
-
|
|
7209
|
-
</dd>
|
|
7210
|
-
</dl>
|
|
7211
|
-
|
|
7212
|
-
<dl>
|
|
7213
|
-
<dd>
|
|
7214
|
-
|
|
7215
|
-
**requestOptions:** `ConnectionToShipper.RequestOptions`
|
|
7212
|
+
**requestOptions:** `Root.RequestOptions`
|
|
7216
7213
|
|
|
7217
7214
|
</dd>
|
|
7218
7215
|
</dl>
|
|
@@ -7223,9 +7220,9 @@ await client.connections.connectionToShipper.createV1({
|
|
|
7223
7220
|
</dl>
|
|
7224
7221
|
</details>
|
|
7225
7222
|
|
|
7226
|
-
##
|
|
7223
|
+
## Users
|
|
7227
7224
|
|
|
7228
|
-
<details><summary><code>client.
|
|
7225
|
+
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">getPublicDataV1</a>() -> Chrt.UserPublicData1</code></summary>
|
|
7229
7226
|
<dl>
|
|
7230
7227
|
<dd>
|
|
7231
7228
|
|
|
@@ -7237,7 +7234,7 @@ await client.connections.connectionToShipper.createV1({
|
|
|
7237
7234
|
<dl>
|
|
7238
7235
|
<dd>
|
|
7239
7236
|
|
|
7240
|
-
|
|
7237
|
+
Retrieves public user data for the authenticated user, including email, notes, and Stripe customer information.
|
|
7241
7238
|
|
|
7242
7239
|
</dd>
|
|
7243
7240
|
</dl>
|
|
@@ -7253,9 +7250,7 @@ Creates a new connection to a forwarder organization. Only shippers can initiate
|
|
|
7253
7250
|
<dd>
|
|
7254
7251
|
|
|
7255
7252
|
```typescript
|
|
7256
|
-
await client.
|
|
7257
|
-
handle: "handle",
|
|
7258
|
-
});
|
|
7253
|
+
await client.users.getPublicDataV1();
|
|
7259
7254
|
```
|
|
7260
7255
|
|
|
7261
7256
|
</dd>
|
|
@@ -7271,15 +7266,7 @@ await client.connections.connectionToForwarder.createV1({
|
|
|
7271
7266
|
<dl>
|
|
7272
7267
|
<dd>
|
|
7273
7268
|
|
|
7274
|
-
**
|
|
7275
|
-
|
|
7276
|
-
</dd>
|
|
7277
|
-
</dl>
|
|
7278
|
-
|
|
7279
|
-
<dl>
|
|
7280
|
-
<dd>
|
|
7281
|
-
|
|
7282
|
-
**requestOptions:** `ConnectionToForwarder.RequestOptions`
|
|
7269
|
+
**requestOptions:** `Users.RequestOptions`
|
|
7283
7270
|
|
|
7284
7271
|
</dd>
|
|
7285
7272
|
</dl>
|
|
@@ -7290,9 +7277,9 @@ await client.connections.connectionToForwarder.createV1({
|
|
|
7290
7277
|
</dl>
|
|
7291
7278
|
</details>
|
|
7292
7279
|
|
|
7293
|
-
##
|
|
7280
|
+
## Utils
|
|
7294
7281
|
|
|
7295
|
-
<details><summary><code>client.
|
|
7282
|
+
<details><summary><code>client.utils.<a href="/src/api/resources/utils/client/Client.ts">getTimezoneV1</a>({ ...params }) -> Chrt.TimezoneResponse</code></summary>
|
|
7296
7283
|
<dl>
|
|
7297
7284
|
<dd>
|
|
7298
7285
|
|
|
@@ -7304,7 +7291,7 @@ await client.connections.connectionToForwarder.createV1({
|
|
|
7304
7291
|
<dl>
|
|
7305
7292
|
<dd>
|
|
7306
7293
|
|
|
7307
|
-
|
|
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.
|
|
7308
7295
|
|
|
7309
7296
|
</dd>
|
|
7310
7297
|
</dl>
|
|
@@ -7320,15 +7307,9 @@ Adds additional line items to an existing courier driver line item group.
|
|
|
7320
7307
|
<dd>
|
|
7321
7308
|
|
|
7322
7309
|
```typescript
|
|
7323
|
-
await client.
|
|
7324
|
-
|
|
7325
|
-
|
|
7326
|
-
schema_version: 1,
|
|
7327
|
-
item: "base_rate",
|
|
7328
|
-
quantity: 1.1,
|
|
7329
|
-
rate: 1.1,
|
|
7330
|
-
},
|
|
7331
|
-
],
|
|
7310
|
+
await client.utils.getTimezoneV1({
|
|
7311
|
+
lat: 37.7749,
|
|
7312
|
+
lng: -122.4194,
|
|
7332
7313
|
});
|
|
7333
7314
|
```
|
|
7334
7315
|
|
|
@@ -7345,15 +7326,7 @@ await client.courierPayDriverLineItemGroups.addLineItems.byIdV1("id", {
|
|
|
7345
7326
|
<dl>
|
|
7346
7327
|
<dd>
|
|
7347
7328
|
|
|
7348
|
-
**
|
|
7349
|
-
|
|
7350
|
-
</dd>
|
|
7351
|
-
</dl>
|
|
7352
|
-
|
|
7353
|
-
<dl>
|
|
7354
|
-
<dd>
|
|
7355
|
-
|
|
7356
|
-
**request:** `Chrt.courierPayDriverLineItemGroups.CourierPayDriverLineItemGroupAddLineItemsReq`
|
|
7329
|
+
**request:** `Chrt.UtilsGetTimezoneV1Request`
|
|
7357
7330
|
|
|
7358
7331
|
</dd>
|
|
7359
7332
|
</dl>
|
|
@@ -7361,7 +7334,7 @@ await client.courierPayDriverLineItemGroups.addLineItems.byIdV1("id", {
|
|
|
7361
7334
|
<dl>
|
|
7362
7335
|
<dd>
|
|
7363
7336
|
|
|
7364
|
-
**requestOptions:** `
|
|
7337
|
+
**requestOptions:** `Utils.RequestOptions`
|
|
7365
7338
|
|
|
7366
7339
|
</dd>
|
|
7367
7340
|
</dl>
|
|
@@ -7372,9 +7345,9 @@ await client.courierPayDriverLineItemGroups.addLineItems.byIdV1("id", {
|
|
|
7372
7345
|
</dl>
|
|
7373
7346
|
</details>
|
|
7374
7347
|
|
|
7375
|
-
##
|
|
7348
|
+
## Connections ConnectionToCourier
|
|
7376
7349
|
|
|
7377
|
-
<details><summary><code>client.
|
|
7350
|
+
<details><summary><code>client.connections.connectionToCourier.<a href="/src/api/resources/connections/resources/connectionToCourier/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
7378
7351
|
<dl>
|
|
7379
7352
|
<dd>
|
|
7380
7353
|
|
|
@@ -7386,7 +7359,7 @@ await client.courierPayDriverLineItemGroups.addLineItems.byIdV1("id", {
|
|
|
7386
7359
|
<dl>
|
|
7387
7360
|
<dd>
|
|
7388
7361
|
|
|
7389
|
-
|
|
7362
|
+
Creates a new connection to a courier organization. Shippers and forwarders can initiate connections to couriers.
|
|
7390
7363
|
|
|
7391
7364
|
</dd>
|
|
7392
7365
|
</dl>
|
|
@@ -7402,8 +7375,8 @@ Removes specific line items from a courier driver line item group by their UUID
|
|
|
7402
7375
|
<dd>
|
|
7403
7376
|
|
|
7404
7377
|
```typescript
|
|
7405
|
-
await client.
|
|
7406
|
-
|
|
7378
|
+
await client.connections.connectionToCourier.createV1({
|
|
7379
|
+
handle: "handle",
|
|
7407
7380
|
});
|
|
7408
7381
|
```
|
|
7409
7382
|
|
|
@@ -7420,15 +7393,7 @@ await client.courierPayDriverLineItemGroups.removeLineItems.byIdV1("id", {
|
|
|
7420
7393
|
<dl>
|
|
7421
7394
|
<dd>
|
|
7422
7395
|
|
|
7423
|
-
**
|
|
7424
|
-
|
|
7425
|
-
</dd>
|
|
7426
|
-
</dl>
|
|
7427
|
-
|
|
7428
|
-
<dl>
|
|
7429
|
-
<dd>
|
|
7430
|
-
|
|
7431
|
-
**request:** `Chrt.courierPayDriverLineItemGroups.CourierPayDriverLineItemGroupRemoveLineItemsReq`
|
|
7396
|
+
**request:** `Chrt.CreateConnectionReq`
|
|
7432
7397
|
|
|
7433
7398
|
</dd>
|
|
7434
7399
|
</dl>
|
|
@@ -7436,7 +7401,7 @@ await client.courierPayDriverLineItemGroups.removeLineItems.byIdV1("id", {
|
|
|
7436
7401
|
<dl>
|
|
7437
7402
|
<dd>
|
|
7438
7403
|
|
|
7439
|
-
**requestOptions:** `
|
|
7404
|
+
**requestOptions:** `ConnectionToCourier.RequestOptions`
|
|
7440
7405
|
|
|
7441
7406
|
</dd>
|
|
7442
7407
|
</dl>
|
|
@@ -7447,9 +7412,9 @@ await client.courierPayDriverLineItemGroups.removeLineItems.byIdV1("id", {
|
|
|
7447
7412
|
</dl>
|
|
7448
7413
|
</details>
|
|
7449
7414
|
|
|
7450
|
-
##
|
|
7415
|
+
## Connections ConnectionToShipper
|
|
7451
7416
|
|
|
7452
|
-
<details><summary><code>client.
|
|
7417
|
+
<details><summary><code>client.connections.connectionToShipper.<a href="/src/api/resources/connections/resources/connectionToShipper/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
7453
7418
|
<dl>
|
|
7454
7419
|
<dd>
|
|
7455
7420
|
|
|
@@ -7461,7 +7426,7 @@ await client.courierPayDriverLineItemGroups.removeLineItems.byIdV1("id", {
|
|
|
7461
7426
|
<dl>
|
|
7462
7427
|
<dd>
|
|
7463
7428
|
|
|
7464
|
-
|
|
7429
|
+
Creates a new connection to a shipper organization. Only forwarders can initiate connections to shippers.
|
|
7465
7430
|
|
|
7466
7431
|
</dd>
|
|
7467
7432
|
</dl>
|
|
@@ -7477,7 +7442,9 @@ Retrieves notification preferences for the authenticated shipper organization.
|
|
|
7477
7442
|
<dd>
|
|
7478
7443
|
|
|
7479
7444
|
```typescript
|
|
7480
|
-
await client.
|
|
7445
|
+
await client.connections.connectionToShipper.createV1({
|
|
7446
|
+
handle: "handle",
|
|
7447
|
+
});
|
|
7481
7448
|
```
|
|
7482
7449
|
|
|
7483
7450
|
</dd>
|
|
@@ -7493,7 +7460,15 @@ await client.notifications.shipper.getPreferencesV1();
|
|
|
7493
7460
|
<dl>
|
|
7494
7461
|
<dd>
|
|
7495
7462
|
|
|
7496
|
-
**
|
|
7463
|
+
**request:** `Chrt.CreateConnectionReq`
|
|
7464
|
+
|
|
7465
|
+
</dd>
|
|
7466
|
+
</dl>
|
|
7467
|
+
|
|
7468
|
+
<dl>
|
|
7469
|
+
<dd>
|
|
7470
|
+
|
|
7471
|
+
**requestOptions:** `ConnectionToShipper.RequestOptions`
|
|
7497
7472
|
|
|
7498
7473
|
</dd>
|
|
7499
7474
|
</dl>
|
|
@@ -7504,7 +7479,9 @@ await client.notifications.shipper.getPreferencesV1();
|
|
|
7504
7479
|
</dl>
|
|
7505
7480
|
</details>
|
|
7506
7481
|
|
|
7507
|
-
|
|
7482
|
+
## Connections ConnectionToForwarder
|
|
7483
|
+
|
|
7484
|
+
<details><summary><code>client.connections.connectionToForwarder.<a href="/src/api/resources/connections/resources/connectionToForwarder/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
7508
7485
|
<dl>
|
|
7509
7486
|
<dd>
|
|
7510
7487
|
|
|
@@ -7516,7 +7493,7 @@ await client.notifications.shipper.getPreferencesV1();
|
|
|
7516
7493
|
<dl>
|
|
7517
7494
|
<dd>
|
|
7518
7495
|
|
|
7519
|
-
Creates
|
|
7496
|
+
Creates a new connection to a forwarder organization. Only shippers can initiate connections to forwarders.
|
|
7520
7497
|
|
|
7521
7498
|
</dd>
|
|
7522
7499
|
</dl>
|
|
@@ -7532,8 +7509,8 @@ Creates or updates notification preferences for the authenticated shipper organi
|
|
|
7532
7509
|
<dd>
|
|
7533
7510
|
|
|
7534
7511
|
```typescript
|
|
7535
|
-
await client.
|
|
7536
|
-
|
|
7512
|
+
await client.connections.connectionToForwarder.createV1({
|
|
7513
|
+
handle: "handle",
|
|
7537
7514
|
});
|
|
7538
7515
|
```
|
|
7539
7516
|
|
|
@@ -7550,7 +7527,7 @@ await client.notifications.shipper.upsertPreferencesV1({
|
|
|
7550
7527
|
<dl>
|
|
7551
7528
|
<dd>
|
|
7552
7529
|
|
|
7553
|
-
**request:** `Chrt.
|
|
7530
|
+
**request:** `Chrt.CreateConnectionReq`
|
|
7554
7531
|
|
|
7555
7532
|
</dd>
|
|
7556
7533
|
</dl>
|
|
@@ -7558,7 +7535,7 @@ await client.notifications.shipper.upsertPreferencesV1({
|
|
|
7558
7535
|
<dl>
|
|
7559
7536
|
<dd>
|
|
7560
7537
|
|
|
7561
|
-
**requestOptions:** `
|
|
7538
|
+
**requestOptions:** `ConnectionToForwarder.RequestOptions`
|
|
7562
7539
|
|
|
7563
7540
|
</dd>
|
|
7564
7541
|
</dl>
|
|
@@ -7569,9 +7546,9 @@ await client.notifications.shipper.upsertPreferencesV1({
|
|
|
7569
7546
|
</dl>
|
|
7570
7547
|
</details>
|
|
7571
7548
|
|
|
7572
|
-
##
|
|
7549
|
+
## CourierPayDriverLineItemGroups AddLineItems
|
|
7573
7550
|
|
|
7574
|
-
<details><summary><code>client.
|
|
7551
|
+
<details><summary><code>client.courierPayDriverLineItemGroups.addLineItems.<a href="/src/api/resources/courierPayDriverLineItemGroups/resources/addLineItems/client/Client.ts">byIdV1</a>(id, { ...params }) -> Chrt.CourierPayDriverLineItemGroup1</code></summary>
|
|
7575
7552
|
<dl>
|
|
7576
7553
|
<dd>
|
|
7577
7554
|
|
|
@@ -7583,7 +7560,7 @@ await client.notifications.shipper.upsertPreferencesV1({
|
|
|
7583
7560
|
<dl>
|
|
7584
7561
|
<dd>
|
|
7585
7562
|
|
|
7586
|
-
|
|
7563
|
+
Adds additional line items to an existing courier driver line item group.
|
|
7587
7564
|
|
|
7588
7565
|
</dd>
|
|
7589
7566
|
</dl>
|
|
@@ -7599,7 +7576,16 @@ Retrieves notification preferences for the authenticated courier organization.
|
|
|
7599
7576
|
<dd>
|
|
7600
7577
|
|
|
7601
7578
|
```typescript
|
|
7602
|
-
await client.
|
|
7579
|
+
await client.courierPayDriverLineItemGroups.addLineItems.byIdV1("id", {
|
|
7580
|
+
line_items: [
|
|
7581
|
+
{
|
|
7582
|
+
schema_version: 1,
|
|
7583
|
+
item: "base_rate",
|
|
7584
|
+
quantity: 1.1,
|
|
7585
|
+
rate: 1.1,
|
|
7586
|
+
},
|
|
7587
|
+
],
|
|
7588
|
+
});
|
|
7603
7589
|
```
|
|
7604
7590
|
|
|
7605
7591
|
</dd>
|
|
@@ -7615,7 +7601,23 @@ await client.notifications.courier.getPreferencesV1();
|
|
|
7615
7601
|
<dl>
|
|
7616
7602
|
<dd>
|
|
7617
7603
|
|
|
7618
|
-
**
|
|
7604
|
+
**id:** `string`
|
|
7605
|
+
|
|
7606
|
+
</dd>
|
|
7607
|
+
</dl>
|
|
7608
|
+
|
|
7609
|
+
<dl>
|
|
7610
|
+
<dd>
|
|
7611
|
+
|
|
7612
|
+
**request:** `Chrt.courierPayDriverLineItemGroups.CourierPayDriverLineItemGroupAddLineItemsReq`
|
|
7613
|
+
|
|
7614
|
+
</dd>
|
|
7615
|
+
</dl>
|
|
7616
|
+
|
|
7617
|
+
<dl>
|
|
7618
|
+
<dd>
|
|
7619
|
+
|
|
7620
|
+
**requestOptions:** `AddLineItems.RequestOptions`
|
|
7619
7621
|
|
|
7620
7622
|
</dd>
|
|
7621
7623
|
</dl>
|
|
@@ -7626,7 +7628,9 @@ await client.notifications.courier.getPreferencesV1();
|
|
|
7626
7628
|
</dl>
|
|
7627
7629
|
</details>
|
|
7628
7630
|
|
|
7629
|
-
|
|
7631
|
+
## CourierPayDriverLineItemGroups RemoveLineItems
|
|
7632
|
+
|
|
7633
|
+
<details><summary><code>client.courierPayDriverLineItemGroups.removeLineItems.<a href="/src/api/resources/courierPayDriverLineItemGroups/resources/removeLineItems/client/Client.ts">byIdV1</a>(id, { ...params }) -> Chrt.CourierPayDriverLineItemGroup1</code></summary>
|
|
7630
7634
|
<dl>
|
|
7631
7635
|
<dd>
|
|
7632
7636
|
|
|
@@ -7638,7 +7642,7 @@ await client.notifications.courier.getPreferencesV1();
|
|
|
7638
7642
|
<dl>
|
|
7639
7643
|
<dd>
|
|
7640
7644
|
|
|
7641
|
-
|
|
7645
|
+
Removes specific line items from a courier driver line item group by their UUID identifiers.
|
|
7642
7646
|
|
|
7643
7647
|
</dd>
|
|
7644
7648
|
</dl>
|
|
@@ -7654,8 +7658,8 @@ Creates or updates notification preferences for the authenticated courier organi
|
|
|
7654
7658
|
<dd>
|
|
7655
7659
|
|
|
7656
7660
|
```typescript
|
|
7657
|
-
await client.
|
|
7658
|
-
|
|
7661
|
+
await client.courierPayDriverLineItemGroups.removeLineItems.byIdV1("id", {
|
|
7662
|
+
line_item_uuid_strs: ["line_item_uuid_strs"],
|
|
7659
7663
|
});
|
|
7660
7664
|
```
|
|
7661
7665
|
|
|
@@ -7672,7 +7676,7 @@ await client.notifications.courier.upsertPreferencesV1({
|
|
|
7672
7676
|
<dl>
|
|
7673
7677
|
<dd>
|
|
7674
7678
|
|
|
7675
|
-
**
|
|
7679
|
+
**id:** `string`
|
|
7676
7680
|
|
|
7677
7681
|
</dd>
|
|
7678
7682
|
</dl>
|
|
@@ -7680,7 +7684,15 @@ await client.notifications.courier.upsertPreferencesV1({
|
|
|
7680
7684
|
<dl>
|
|
7681
7685
|
<dd>
|
|
7682
7686
|
|
|
7683
|
-
**
|
|
7687
|
+
**request:** `Chrt.courierPayDriverLineItemGroups.CourierPayDriverLineItemGroupRemoveLineItemsReq`
|
|
7688
|
+
|
|
7689
|
+
</dd>
|
|
7690
|
+
</dl>
|
|
7691
|
+
|
|
7692
|
+
<dl>
|
|
7693
|
+
<dd>
|
|
7694
|
+
|
|
7695
|
+
**requestOptions:** `RemoveLineItems.RequestOptions`
|
|
7684
7696
|
|
|
7685
7697
|
</dd>
|
|
7686
7698
|
</dl>
|
|
@@ -7691,9 +7703,9 @@ await client.notifications.courier.upsertPreferencesV1({
|
|
|
7691
7703
|
</dl>
|
|
7692
7704
|
</details>
|
|
7693
7705
|
|
|
7694
|
-
##
|
|
7706
|
+
## Notifications Shipper
|
|
7695
7707
|
|
|
7696
|
-
<details><summary><code>client.
|
|
7708
|
+
<details><summary><code>client.notifications.shipper.<a href="/src/api/resources/notifications/resources/shipper/client/Client.ts">getPreferencesV1</a>() -> Chrt.ShipperNotificationPreferences1</code></summary>
|
|
7697
7709
|
<dl>
|
|
7698
7710
|
<dd>
|
|
7699
7711
|
|
|
@@ -7705,7 +7717,7 @@ await client.notifications.courier.upsertPreferencesV1({
|
|
|
7705
7717
|
<dl>
|
|
7706
7718
|
<dd>
|
|
7707
7719
|
|
|
7708
|
-
|
|
7720
|
+
Retrieves notification preferences for the authenticated shipper organization.
|
|
7709
7721
|
|
|
7710
7722
|
</dd>
|
|
7711
7723
|
</dl>
|
|
@@ -7721,7 +7733,7 @@ Fetches a single order for the shipper organization with optional expanded relat
|
|
|
7721
7733
|
<dd>
|
|
7722
7734
|
|
|
7723
7735
|
```typescript
|
|
7724
|
-
await client.
|
|
7736
|
+
await client.notifications.shipper.getPreferencesV1();
|
|
7725
7737
|
```
|
|
7726
7738
|
|
|
7727
7739
|
</dd>
|
|
@@ -7737,23 +7749,7 @@ await client.orders.expanded.postForShipperByOrderIdV1("order_id_or_short_id", {
|
|
|
7737
7749
|
<dl>
|
|
7738
7750
|
<dd>
|
|
7739
7751
|
|
|
7740
|
-
**
|
|
7741
|
-
|
|
7742
|
-
</dd>
|
|
7743
|
-
</dl>
|
|
7744
|
-
|
|
7745
|
-
<dl>
|
|
7746
|
-
<dd>
|
|
7747
|
-
|
|
7748
|
-
**request:** `Chrt.OrderExpandedForShipperReq`
|
|
7749
|
-
|
|
7750
|
-
</dd>
|
|
7751
|
-
</dl>
|
|
7752
|
-
|
|
7753
|
-
<dl>
|
|
7754
|
-
<dd>
|
|
7755
|
-
|
|
7756
|
-
**requestOptions:** `Expanded.RequestOptions`
|
|
7752
|
+
**requestOptions:** `Shipper.RequestOptions`
|
|
7757
7753
|
|
|
7758
7754
|
</dd>
|
|
7759
7755
|
</dl>
|
|
@@ -7764,7 +7760,7 @@ await client.orders.expanded.postForShipperByOrderIdV1("order_id_or_short_id", {
|
|
|
7764
7760
|
</dl>
|
|
7765
7761
|
</details>
|
|
7766
7762
|
|
|
7767
|
-
<details><summary><code>client.
|
|
7763
|
+
<details><summary><code>client.notifications.shipper.<a href="/src/api/resources/notifications/resources/shipper/client/Client.ts">upsertPreferencesV1</a>({ ...params }) -> string</code></summary>
|
|
7768
7764
|
<dl>
|
|
7769
7765
|
<dd>
|
|
7770
7766
|
|
|
@@ -7776,7 +7772,7 @@ await client.orders.expanded.postForShipperByOrderIdV1("order_id_or_short_id", {
|
|
|
7776
7772
|
<dl>
|
|
7777
7773
|
<dd>
|
|
7778
7774
|
|
|
7779
|
-
|
|
7775
|
+
Creates or updates notification preferences for the authenticated shipper organization.
|
|
7780
7776
|
|
|
7781
7777
|
</dd>
|
|
7782
7778
|
</dl>
|
|
@@ -7792,7 +7788,9 @@ Fetches a single order for the organization that created it with optional expand
|
|
|
7792
7788
|
<dd>
|
|
7793
7789
|
|
|
7794
7790
|
```typescript
|
|
7795
|
-
await client.
|
|
7791
|
+
await client.notifications.shipper.upsertPreferencesV1({
|
|
7792
|
+
schema_version: 1,
|
|
7793
|
+
});
|
|
7796
7794
|
```
|
|
7797
7795
|
|
|
7798
7796
|
</dd>
|
|
@@ -7808,15 +7806,7 @@ await client.orders.expanded.postForOrderCreatorByOrderIdV1("order_id_or_short_i
|
|
|
7808
7806
|
<dl>
|
|
7809
7807
|
<dd>
|
|
7810
7808
|
|
|
7811
|
-
**
|
|
7812
|
-
|
|
7813
|
-
</dd>
|
|
7814
|
-
</dl>
|
|
7815
|
-
|
|
7816
|
-
<dl>
|
|
7817
|
-
<dd>
|
|
7818
|
-
|
|
7819
|
-
**request:** `Chrt.OrderExpandedForOrderCreatorReq`
|
|
7809
|
+
**request:** `Chrt.notifications.ShipperNotificationPreferencesClientCreate1`
|
|
7820
7810
|
|
|
7821
7811
|
</dd>
|
|
7822
7812
|
</dl>
|
|
@@ -7824,7 +7814,7 @@ await client.orders.expanded.postForOrderCreatorByOrderIdV1("order_id_or_short_i
|
|
|
7824
7814
|
<dl>
|
|
7825
7815
|
<dd>
|
|
7826
7816
|
|
|
7827
|
-
**requestOptions:** `
|
|
7817
|
+
**requestOptions:** `Shipper.RequestOptions`
|
|
7828
7818
|
|
|
7829
7819
|
</dd>
|
|
7830
7820
|
</dl>
|
|
@@ -7835,9 +7825,9 @@ await client.orders.expanded.postForOrderCreatorByOrderIdV1("order_id_or_short_i
|
|
|
7835
7825
|
</dl>
|
|
7836
7826
|
</details>
|
|
7837
7827
|
|
|
7838
|
-
##
|
|
7828
|
+
## Notifications Courier
|
|
7839
7829
|
|
|
7840
|
-
<details><summary><code>client.
|
|
7830
|
+
<details><summary><code>client.notifications.courier.<a href="/src/api/resources/notifications/resources/courier/client/Client.ts">getPreferencesV1</a>() -> Chrt.CourierNotificationPreferences1</code></summary>
|
|
7841
7831
|
<dl>
|
|
7842
7832
|
<dd>
|
|
7843
7833
|
|
|
@@ -7849,7 +7839,7 @@ await client.orders.expanded.postForOrderCreatorByOrderIdV1("order_id_or_short_i
|
|
|
7849
7839
|
<dl>
|
|
7850
7840
|
<dd>
|
|
7851
7841
|
|
|
7852
|
-
Retrieves
|
|
7842
|
+
Retrieves notification preferences for the authenticated courier organization.
|
|
7853
7843
|
|
|
7854
7844
|
</dd>
|
|
7855
7845
|
</dl>
|
|
@@ -7865,16 +7855,7 @@ Retrieves orders expanded list for the shipper organization with optional filter
|
|
|
7865
7855
|
<dd>
|
|
7866
7856
|
|
|
7867
7857
|
```typescript
|
|
7868
|
-
await client.
|
|
7869
|
-
page: 1,
|
|
7870
|
-
page_size: 1,
|
|
7871
|
-
sort_by: "draft_started_at",
|
|
7872
|
-
sort_order: "asc",
|
|
7873
|
-
filter_draft_started_at_gte: "2024-01-15T09:30:00Z",
|
|
7874
|
-
filter_draft_started_at_lte: "2024-01-15T09:30:00Z",
|
|
7875
|
-
filter_order_cancelled: true,
|
|
7876
|
-
body: {},
|
|
7877
|
-
});
|
|
7858
|
+
await client.notifications.courier.getPreferencesV1();
|
|
7878
7859
|
```
|
|
7879
7860
|
|
|
7880
7861
|
</dd>
|
|
@@ -7890,15 +7871,7 @@ await client.orders.expandedList.postShipperExpandedListV1({
|
|
|
7890
7871
|
<dl>
|
|
7891
7872
|
<dd>
|
|
7892
7873
|
|
|
7893
|
-
**
|
|
7894
|
-
|
|
7895
|
-
</dd>
|
|
7896
|
-
</dl>
|
|
7897
|
-
|
|
7898
|
-
<dl>
|
|
7899
|
-
<dd>
|
|
7900
|
-
|
|
7901
|
-
**requestOptions:** `ExpandedList.RequestOptions`
|
|
7874
|
+
**requestOptions:** `Courier.RequestOptions`
|
|
7902
7875
|
|
|
7903
7876
|
</dd>
|
|
7904
7877
|
</dl>
|
|
@@ -7909,7 +7882,7 @@ await client.orders.expandedList.postShipperExpandedListV1({
|
|
|
7909
7882
|
</dl>
|
|
7910
7883
|
</details>
|
|
7911
7884
|
|
|
7912
|
-
<details><summary><code>client.
|
|
7885
|
+
<details><summary><code>client.notifications.courier.<a href="/src/api/resources/notifications/resources/courier/client/Client.ts">upsertPreferencesV1</a>({ ...params }) -> string</code></summary>
|
|
7913
7886
|
<dl>
|
|
7914
7887
|
<dd>
|
|
7915
7888
|
|
|
@@ -7921,7 +7894,7 @@ await client.orders.expandedList.postShipperExpandedListV1({
|
|
|
7921
7894
|
<dl>
|
|
7922
7895
|
<dd>
|
|
7923
7896
|
|
|
7924
|
-
|
|
7897
|
+
Creates or updates notification preferences for the authenticated courier organization.
|
|
7925
7898
|
|
|
7926
7899
|
</dd>
|
|
7927
7900
|
</dl>
|
|
@@ -7937,15 +7910,8 @@ Retrieves orders expanded list for order creator org with optional filters, ship
|
|
|
7937
7910
|
<dd>
|
|
7938
7911
|
|
|
7939
7912
|
```typescript
|
|
7940
|
-
await client.
|
|
7941
|
-
|
|
7942
|
-
page_size: 1,
|
|
7943
|
-
sort_by: "draft_started_at",
|
|
7944
|
-
sort_order: "asc",
|
|
7945
|
-
filter_draft_started_at_gte: "2024-01-15T09:30:00Z",
|
|
7946
|
-
filter_draft_started_at_lte: "2024-01-15T09:30:00Z",
|
|
7947
|
-
filter_order_cancelled: true,
|
|
7948
|
-
body: {},
|
|
7913
|
+
await client.notifications.courier.upsertPreferencesV1({
|
|
7914
|
+
schema_version: 1,
|
|
7949
7915
|
});
|
|
7950
7916
|
```
|
|
7951
7917
|
|
|
@@ -7962,7 +7928,7 @@ await client.orders.expandedList.postOrderCreatorExpandedListV1({
|
|
|
7962
7928
|
<dl>
|
|
7963
7929
|
<dd>
|
|
7964
7930
|
|
|
7965
|
-
**request:** `Chrt.
|
|
7931
|
+
**request:** `Chrt.notifications.CourierNotificationPreferencesClientCreate1`
|
|
7966
7932
|
|
|
7967
7933
|
</dd>
|
|
7968
7934
|
</dl>
|
|
@@ -7970,7 +7936,7 @@ await client.orders.expandedList.postOrderCreatorExpandedListV1({
|
|
|
7970
7936
|
<dl>
|
|
7971
7937
|
<dd>
|
|
7972
7938
|
|
|
7973
|
-
**requestOptions:** `
|
|
7939
|
+
**requestOptions:** `Courier.RequestOptions`
|
|
7974
7940
|
|
|
7975
7941
|
</dd>
|
|
7976
7942
|
</dl>
|
|
@@ -7981,9 +7947,9 @@ await client.orders.expandedList.postOrderCreatorExpandedListV1({
|
|
|
7981
7947
|
</dl>
|
|
7982
7948
|
</details>
|
|
7983
7949
|
|
|
7984
|
-
##
|
|
7950
|
+
## OrderDrafts TaskGroup
|
|
7985
7951
|
|
|
7986
|
-
<details><summary><code>client.
|
|
7952
|
+
<details><summary><code>client.orderDrafts.taskGroup.<a href="/src/api/resources/orderDrafts/resources/taskGroup/client/Client.ts">addV1</a>({ ...params }) -> string</code></summary>
|
|
7987
7953
|
<dl>
|
|
7988
7954
|
<dd>
|
|
7989
7955
|
|
|
@@ -7995,7 +7961,7 @@ await client.orders.expandedList.postOrderCreatorExpandedListV1({
|
|
|
7995
7961
|
<dl>
|
|
7996
7962
|
<dd>
|
|
7997
7963
|
|
|
7998
|
-
|
|
7964
|
+
Adds a task group to an existing order draft. Validates order is in DRAFT status and owned by caller.
|
|
7999
7965
|
|
|
8000
7966
|
</dd>
|
|
8001
7967
|
</dl>
|
|
@@ -8011,7 +7977,10 @@ Creates a new draft order with org assignments based on caller's organization ty
|
|
|
8011
7977
|
<dd>
|
|
8012
7978
|
|
|
8013
7979
|
```typescript
|
|
8014
|
-
await client.
|
|
7980
|
+
await client.orderDrafts.taskGroup.addV1({
|
|
7981
|
+
task_group_type: "chrt_ground_courier",
|
|
7982
|
+
order_id: "order_id",
|
|
7983
|
+
});
|
|
8015
7984
|
```
|
|
8016
7985
|
|
|
8017
7986
|
</dd>
|
|
@@ -8027,7 +7996,7 @@ await client.orders.draft.newV1();
|
|
|
8027
7996
|
<dl>
|
|
8028
7997
|
<dd>
|
|
8029
7998
|
|
|
8030
|
-
**request:** `Chrt.
|
|
7999
|
+
**request:** `Chrt.orderDrafts.OrderDraftAddTaskGroupReq`
|
|
8031
8000
|
|
|
8032
8001
|
</dd>
|
|
8033
8002
|
</dl>
|
|
@@ -8035,7 +8004,7 @@ await client.orders.draft.newV1();
|
|
|
8035
8004
|
<dl>
|
|
8036
8005
|
<dd>
|
|
8037
8006
|
|
|
8038
|
-
**requestOptions:** `
|
|
8007
|
+
**requestOptions:** `TaskGroup.RequestOptions`
|
|
8039
8008
|
|
|
8040
8009
|
</dd>
|
|
8041
8010
|
</dl>
|
|
@@ -8046,7 +8015,7 @@ await client.orders.draft.newV1();
|
|
|
8046
8015
|
</dl>
|
|
8047
8016
|
</details>
|
|
8048
8017
|
|
|
8049
|
-
<details><summary><code>client.
|
|
8018
|
+
<details><summary><code>client.orderDrafts.taskGroup.<a href="/src/api/resources/orderDrafts/resources/taskGroup/client/Client.ts">deleteV1</a>(taskGroupId) -> boolean</code></summary>
|
|
8050
8019
|
<dl>
|
|
8051
8020
|
<dd>
|
|
8052
8021
|
|
|
@@ -8058,7 +8027,7 @@ await client.orders.draft.newV1();
|
|
|
8058
8027
|
<dl>
|
|
8059
8028
|
<dd>
|
|
8060
8029
|
|
|
8061
|
-
|
|
8030
|
+
Deletes a task group and all associated entities (tasks, task artifacts, S3 metadata). The task group must belong to a DRAFT order.
|
|
8062
8031
|
|
|
8063
8032
|
</dd>
|
|
8064
8033
|
</dl>
|
|
@@ -8074,9 +8043,7 @@ Updates forwarder and/or shipper org assignments for a draft order
|
|
|
8074
8043
|
<dd>
|
|
8075
8044
|
|
|
8076
8045
|
```typescript
|
|
8077
|
-
await client.
|
|
8078
|
-
order_id: "order_id",
|
|
8079
|
-
});
|
|
8046
|
+
await client.orderDrafts.taskGroup.deleteV1("task_group_id");
|
|
8080
8047
|
```
|
|
8081
8048
|
|
|
8082
8049
|
</dd>
|
|
@@ -8092,7 +8059,7 @@ await client.orders.draft.updateV1({
|
|
|
8092
8059
|
<dl>
|
|
8093
8060
|
<dd>
|
|
8094
8061
|
|
|
8095
|
-
**
|
|
8062
|
+
**taskGroupId:** `string`
|
|
8096
8063
|
|
|
8097
8064
|
</dd>
|
|
8098
8065
|
</dl>
|
|
@@ -8100,7 +8067,7 @@ await client.orders.draft.updateV1({
|
|
|
8100
8067
|
<dl>
|
|
8101
8068
|
<dd>
|
|
8102
8069
|
|
|
8103
|
-
**requestOptions:** `
|
|
8070
|
+
**requestOptions:** `TaskGroup.RequestOptions`
|
|
8104
8071
|
|
|
8105
8072
|
</dd>
|
|
8106
8073
|
</dl>
|
|
@@ -8111,7 +8078,9 @@ await client.orders.draft.updateV1({
|
|
|
8111
8078
|
</dl>
|
|
8112
8079
|
</details>
|
|
8113
8080
|
|
|
8114
|
-
|
|
8081
|
+
## OrderDrafts Task
|
|
8082
|
+
|
|
8083
|
+
<details><summary><code>client.orderDrafts.task.<a href="/src/api/resources/orderDrafts/resources/task/client/Client.ts">addV1</a>({ ...params }) -> string</code></summary>
|
|
8115
8084
|
<dl>
|
|
8116
8085
|
<dd>
|
|
8117
8086
|
|
|
@@ -8123,7 +8092,7 @@ await client.orders.draft.updateV1({
|
|
|
8123
8092
|
<dl>
|
|
8124
8093
|
<dd>
|
|
8125
8094
|
|
|
8126
|
-
|
|
8095
|
+
Adds a task to an existing task group in a draft order. Validates order is in DRAFT status and task action type matches task group type.
|
|
8127
8096
|
|
|
8128
8097
|
</dd>
|
|
8129
8098
|
</dl>
|
|
@@ -8139,7 +8108,12 @@ Deletes a draft order and all associated entities
|
|
|
8139
8108
|
<dd>
|
|
8140
8109
|
|
|
8141
8110
|
```typescript
|
|
8142
|
-
await client.
|
|
8111
|
+
await client.orderDrafts.task.addV1({
|
|
8112
|
+
task_group_id: "task_group_id",
|
|
8113
|
+
task: {
|
|
8114
|
+
schema_version: 1,
|
|
8115
|
+
},
|
|
8116
|
+
});
|
|
8143
8117
|
```
|
|
8144
8118
|
|
|
8145
8119
|
</dd>
|
|
@@ -8155,7 +8129,7 @@ await client.orders.draft.deleteV1("order_id");
|
|
|
8155
8129
|
<dl>
|
|
8156
8130
|
<dd>
|
|
8157
8131
|
|
|
8158
|
-
**
|
|
8132
|
+
**request:** `Chrt.orderDrafts.OrderDraftAddTaskReqV1`
|
|
8159
8133
|
|
|
8160
8134
|
</dd>
|
|
8161
8135
|
</dl>
|
|
@@ -8163,7 +8137,7 @@ await client.orders.draft.deleteV1("order_id");
|
|
|
8163
8137
|
<dl>
|
|
8164
8138
|
<dd>
|
|
8165
8139
|
|
|
8166
|
-
**requestOptions:** `
|
|
8140
|
+
**requestOptions:** `Task.RequestOptions`
|
|
8167
8141
|
|
|
8168
8142
|
</dd>
|
|
8169
8143
|
</dl>
|
|
@@ -8174,7 +8148,7 @@ await client.orders.draft.deleteV1("order_id");
|
|
|
8174
8148
|
</dl>
|
|
8175
8149
|
</details>
|
|
8176
8150
|
|
|
8177
|
-
<details><summary><code>client.
|
|
8151
|
+
<details><summary><code>client.orderDrafts.task.<a href="/src/api/resources/orderDrafts/resources/task/client/Client.ts">updateV1</a>({ ...params }) -> string</code></summary>
|
|
8178
8152
|
<dl>
|
|
8179
8153
|
<dd>
|
|
8180
8154
|
|
|
@@ -8186,7 +8160,7 @@ await client.orders.draft.deleteV1("order_id");
|
|
|
8186
8160
|
<dl>
|
|
8187
8161
|
<dd>
|
|
8188
8162
|
|
|
8189
|
-
|
|
8163
|
+
Updates a task in an existing draft order
|
|
8190
8164
|
|
|
8191
8165
|
</dd>
|
|
8192
8166
|
</dl>
|
|
@@ -8202,9 +8176,9 @@ Adds a task group to an existing draft order. Validates order is in DRAFT status
|
|
|
8202
8176
|
<dd>
|
|
8203
8177
|
|
|
8204
8178
|
```typescript
|
|
8205
|
-
await client.
|
|
8206
|
-
|
|
8207
|
-
|
|
8179
|
+
await client.orderDrafts.task.updateV1({
|
|
8180
|
+
task_id: "task_id",
|
|
8181
|
+
task_update: {},
|
|
8208
8182
|
});
|
|
8209
8183
|
```
|
|
8210
8184
|
|
|
@@ -8221,7 +8195,7 @@ await client.orders.draft.addTaskGroupV1({
|
|
|
8221
8195
|
<dl>
|
|
8222
8196
|
<dd>
|
|
8223
8197
|
|
|
8224
|
-
**request:** `Chrt.
|
|
8198
|
+
**request:** `Chrt.orderDrafts.OrderDraftUpdateTaskReq`
|
|
8225
8199
|
|
|
8226
8200
|
</dd>
|
|
8227
8201
|
</dl>
|
|
@@ -8229,7 +8203,7 @@ await client.orders.draft.addTaskGroupV1({
|
|
|
8229
8203
|
<dl>
|
|
8230
8204
|
<dd>
|
|
8231
8205
|
|
|
8232
|
-
**requestOptions:** `
|
|
8206
|
+
**requestOptions:** `Task.RequestOptions`
|
|
8233
8207
|
|
|
8234
8208
|
</dd>
|
|
8235
8209
|
</dl>
|
|
@@ -8240,7 +8214,7 @@ await client.orders.draft.addTaskGroupV1({
|
|
|
8240
8214
|
</dl>
|
|
8241
8215
|
</details>
|
|
8242
8216
|
|
|
8243
|
-
<details><summary><code>client.
|
|
8217
|
+
<details><summary><code>client.orderDrafts.task.<a href="/src/api/resources/orderDrafts/resources/task/client/Client.ts">deleteV1</a>(taskId) -> boolean</code></summary>
|
|
8244
8218
|
<dl>
|
|
8245
8219
|
<dd>
|
|
8246
8220
|
|
|
@@ -8252,7 +8226,7 @@ await client.orders.draft.addTaskGroupV1({
|
|
|
8252
8226
|
<dl>
|
|
8253
8227
|
<dd>
|
|
8254
8228
|
|
|
8255
|
-
Deletes a task
|
|
8229
|
+
Deletes a task from a draft order, including all task artifacts. Cargo is preserved. Task is removed from task group.
|
|
8256
8230
|
|
|
8257
8231
|
</dd>
|
|
8258
8232
|
</dl>
|
|
@@ -8268,7 +8242,7 @@ Deletes a task group and all associated entities (tasks, task artifacts, S3 meta
|
|
|
8268
8242
|
<dd>
|
|
8269
8243
|
|
|
8270
8244
|
```typescript
|
|
8271
|
-
await client.
|
|
8245
|
+
await client.orderDrafts.task.deleteV1("task_id");
|
|
8272
8246
|
```
|
|
8273
8247
|
|
|
8274
8248
|
</dd>
|
|
@@ -8284,7 +8258,7 @@ await client.orders.draft.deleteTaskGroupV1("task_group_id");
|
|
|
8284
8258
|
<dl>
|
|
8285
8259
|
<dd>
|
|
8286
8260
|
|
|
8287
|
-
**
|
|
8261
|
+
**taskId:** `string`
|
|
8288
8262
|
|
|
8289
8263
|
</dd>
|
|
8290
8264
|
</dl>
|
|
@@ -8292,7 +8266,7 @@ await client.orders.draft.deleteTaskGroupV1("task_group_id");
|
|
|
8292
8266
|
<dl>
|
|
8293
8267
|
<dd>
|
|
8294
8268
|
|
|
8295
|
-
**requestOptions:** `
|
|
8269
|
+
**requestOptions:** `Task.RequestOptions`
|
|
8296
8270
|
|
|
8297
8271
|
</dd>
|
|
8298
8272
|
</dl>
|
|
@@ -8303,7 +8277,9 @@ await client.orders.draft.deleteTaskGroupV1("task_group_id");
|
|
|
8303
8277
|
</dl>
|
|
8304
8278
|
</details>
|
|
8305
8279
|
|
|
8306
|
-
|
|
8280
|
+
## OrderDrafts TaskArtifact
|
|
8281
|
+
|
|
8282
|
+
<details><summary><code>client.orderDrafts.taskArtifact.<a href="/src/api/resources/orderDrafts/resources/taskArtifact/client/Client.ts">addV1</a>({ ...params }) -> string</code></summary>
|
|
8307
8283
|
<dl>
|
|
8308
8284
|
<dd>
|
|
8309
8285
|
|
|
@@ -8315,7 +8291,7 @@ await client.orders.draft.deleteTaskGroupV1("task_group_id");
|
|
|
8315
8291
|
<dl>
|
|
8316
8292
|
<dd>
|
|
8317
8293
|
|
|
8318
|
-
Adds a task to an existing task
|
|
8294
|
+
Adds a task artifact to an existing task in a draft order.
|
|
8319
8295
|
|
|
8320
8296
|
</dd>
|
|
8321
8297
|
</dl>
|
|
@@ -8331,11 +8307,9 @@ Adds a task to an existing task group in a draft order. Validates order is in DR
|
|
|
8331
8307
|
<dd>
|
|
8332
8308
|
|
|
8333
8309
|
```typescript
|
|
8334
|
-
await client.
|
|
8335
|
-
|
|
8336
|
-
|
|
8337
|
-
schema_version: 1,
|
|
8338
|
-
},
|
|
8310
|
+
await client.orderDrafts.taskArtifact.addV1({
|
|
8311
|
+
task_id: "task_id",
|
|
8312
|
+
task_artifact_type: "image",
|
|
8339
8313
|
});
|
|
8340
8314
|
```
|
|
8341
8315
|
|
|
@@ -8352,7 +8326,7 @@ await client.orders.draft.addTaskV1({
|
|
|
8352
8326
|
<dl>
|
|
8353
8327
|
<dd>
|
|
8354
8328
|
|
|
8355
|
-
**request:** `Chrt.
|
|
8329
|
+
**request:** `Chrt.orderDrafts.OrderDraftAddTaskArtifactReq`
|
|
8356
8330
|
|
|
8357
8331
|
</dd>
|
|
8358
8332
|
</dl>
|
|
@@ -8360,7 +8334,7 @@ await client.orders.draft.addTaskV1({
|
|
|
8360
8334
|
<dl>
|
|
8361
8335
|
<dd>
|
|
8362
8336
|
|
|
8363
|
-
**requestOptions:** `
|
|
8337
|
+
**requestOptions:** `TaskArtifact.RequestOptions`
|
|
8364
8338
|
|
|
8365
8339
|
</dd>
|
|
8366
8340
|
</dl>
|
|
@@ -8371,7 +8345,7 @@ await client.orders.draft.addTaskV1({
|
|
|
8371
8345
|
</dl>
|
|
8372
8346
|
</details>
|
|
8373
8347
|
|
|
8374
|
-
<details><summary><code>client.
|
|
8348
|
+
<details><summary><code>client.orderDrafts.taskArtifact.<a href="/src/api/resources/orderDrafts/resources/taskArtifact/client/Client.ts">deleteV1</a>(taskArtifactId) -> boolean</code></summary>
|
|
8375
8349
|
<dl>
|
|
8376
8350
|
<dd>
|
|
8377
8351
|
|
|
@@ -8383,7 +8357,7 @@ await client.orders.draft.addTaskV1({
|
|
|
8383
8357
|
<dl>
|
|
8384
8358
|
<dd>
|
|
8385
8359
|
|
|
8386
|
-
|
|
8360
|
+
Deletes a task artifact from a draft order and removes it from the associated task.
|
|
8387
8361
|
|
|
8388
8362
|
</dd>
|
|
8389
8363
|
</dl>
|
|
@@ -8399,10 +8373,7 @@ Updates a task in an existing draft order
|
|
|
8399
8373
|
<dd>
|
|
8400
8374
|
|
|
8401
8375
|
```typescript
|
|
8402
|
-
await client.
|
|
8403
|
-
task_id: "task_id",
|
|
8404
|
-
task_update: {},
|
|
8405
|
-
});
|
|
8376
|
+
await client.orderDrafts.taskArtifact.deleteV1("task_artifact_id");
|
|
8406
8377
|
```
|
|
8407
8378
|
|
|
8408
8379
|
</dd>
|
|
@@ -8418,7 +8389,7 @@ await client.orders.draft.updateTaskV1({
|
|
|
8418
8389
|
<dl>
|
|
8419
8390
|
<dd>
|
|
8420
8391
|
|
|
8421
|
-
**
|
|
8392
|
+
**taskArtifactId:** `string`
|
|
8422
8393
|
|
|
8423
8394
|
</dd>
|
|
8424
8395
|
</dl>
|
|
@@ -8426,7 +8397,7 @@ await client.orders.draft.updateTaskV1({
|
|
|
8426
8397
|
<dl>
|
|
8427
8398
|
<dd>
|
|
8428
8399
|
|
|
8429
|
-
**requestOptions:** `
|
|
8400
|
+
**requestOptions:** `TaskArtifact.RequestOptions`
|
|
8430
8401
|
|
|
8431
8402
|
</dd>
|
|
8432
8403
|
</dl>
|
|
@@ -8437,7 +8408,9 @@ await client.orders.draft.updateTaskV1({
|
|
|
8437
8408
|
</dl>
|
|
8438
8409
|
</details>
|
|
8439
8410
|
|
|
8440
|
-
|
|
8411
|
+
## OrderDrafts Cargo
|
|
8412
|
+
|
|
8413
|
+
<details><summary><code>client.orderDrafts.cargo.<a href="/src/api/resources/orderDrafts/resources/cargo/client/Client.ts">addV1</a>({ ...params }) -> string</code></summary>
|
|
8441
8414
|
<dl>
|
|
8442
8415
|
<dd>
|
|
8443
8416
|
|
|
@@ -8449,7 +8422,7 @@ await client.orders.draft.updateTaskV1({
|
|
|
8449
8422
|
<dl>
|
|
8450
8423
|
<dd>
|
|
8451
8424
|
|
|
8452
|
-
|
|
8425
|
+
Adds a cargo item to an existing draft order. Validates order is in DRAFT status and owned by caller.
|
|
8453
8426
|
|
|
8454
8427
|
</dd>
|
|
8455
8428
|
</dl>
|
|
@@ -8465,7 +8438,13 @@ Deletes a task from a draft order, including all task artifacts. Cargo is preser
|
|
|
8465
8438
|
<dd>
|
|
8466
8439
|
|
|
8467
8440
|
```typescript
|
|
8468
|
-
await client.
|
|
8441
|
+
await client.orderDrafts.cargo.addV1({
|
|
8442
|
+
order_id: "order_id",
|
|
8443
|
+
cargo: {
|
|
8444
|
+
schema_version: 1,
|
|
8445
|
+
cargo_type: "spare_parts",
|
|
8446
|
+
},
|
|
8447
|
+
});
|
|
8469
8448
|
```
|
|
8470
8449
|
|
|
8471
8450
|
</dd>
|
|
@@ -8481,7 +8460,7 @@ await client.orders.draft.deleteTaskV1("task_id");
|
|
|
8481
8460
|
<dl>
|
|
8482
8461
|
<dd>
|
|
8483
8462
|
|
|
8484
|
-
**
|
|
8463
|
+
**request:** `Chrt.orderDrafts.OrderDraftAddCargoReq`
|
|
8485
8464
|
|
|
8486
8465
|
</dd>
|
|
8487
8466
|
</dl>
|
|
@@ -8489,7 +8468,7 @@ await client.orders.draft.deleteTaskV1("task_id");
|
|
|
8489
8468
|
<dl>
|
|
8490
8469
|
<dd>
|
|
8491
8470
|
|
|
8492
|
-
**requestOptions:** `
|
|
8471
|
+
**requestOptions:** `Cargo.RequestOptions`
|
|
8493
8472
|
|
|
8494
8473
|
</dd>
|
|
8495
8474
|
</dl>
|
|
@@ -8500,7 +8479,7 @@ await client.orders.draft.deleteTaskV1("task_id");
|
|
|
8500
8479
|
</dl>
|
|
8501
8480
|
</details>
|
|
8502
8481
|
|
|
8503
|
-
<details><summary><code>client.
|
|
8482
|
+
<details><summary><code>client.orderDrafts.cargo.<a href="/src/api/resources/orderDrafts/resources/cargo/client/Client.ts">associateWithTaskV1</a>({ ...params }) -> boolean</code></summary>
|
|
8504
8483
|
<dl>
|
|
8505
8484
|
<dd>
|
|
8506
8485
|
|
|
@@ -8512,7 +8491,7 @@ await client.orders.draft.deleteTaskV1("task_id");
|
|
|
8512
8491
|
<dl>
|
|
8513
8492
|
<dd>
|
|
8514
8493
|
|
|
8515
|
-
|
|
8494
|
+
Associates existing cargo with a task in a draft order.
|
|
8516
8495
|
|
|
8517
8496
|
</dd>
|
|
8518
8497
|
</dl>
|
|
@@ -8528,9 +8507,10 @@ Adds a task artifact to an existing task in a draft order.
|
|
|
8528
8507
|
<dd>
|
|
8529
8508
|
|
|
8530
8509
|
```typescript
|
|
8531
|
-
await client.
|
|
8510
|
+
await client.orderDrafts.cargo.associateWithTaskV1({
|
|
8511
|
+
order_id: "order_id",
|
|
8532
8512
|
task_id: "task_id",
|
|
8533
|
-
|
|
8513
|
+
cargo_id: "cargo_id",
|
|
8534
8514
|
});
|
|
8535
8515
|
```
|
|
8536
8516
|
|
|
@@ -8547,7 +8527,7 @@ await client.orders.draft.addTaskArtifactV1({
|
|
|
8547
8527
|
<dl>
|
|
8548
8528
|
<dd>
|
|
8549
8529
|
|
|
8550
|
-
**request:** `Chrt.
|
|
8530
|
+
**request:** `Chrt.orderDrafts.OrderDraftAssociateCargoWithTaskReq`
|
|
8551
8531
|
|
|
8552
8532
|
</dd>
|
|
8553
8533
|
</dl>
|
|
@@ -8555,7 +8535,7 @@ await client.orders.draft.addTaskArtifactV1({
|
|
|
8555
8535
|
<dl>
|
|
8556
8536
|
<dd>
|
|
8557
8537
|
|
|
8558
|
-
**requestOptions:** `
|
|
8538
|
+
**requestOptions:** `Cargo.RequestOptions`
|
|
8559
8539
|
|
|
8560
8540
|
</dd>
|
|
8561
8541
|
</dl>
|
|
@@ -8566,7 +8546,7 @@ await client.orders.draft.addTaskArtifactV1({
|
|
|
8566
8546
|
</dl>
|
|
8567
8547
|
</details>
|
|
8568
8548
|
|
|
8569
|
-
<details><summary><code>client.
|
|
8549
|
+
<details><summary><code>client.orderDrafts.cargo.<a href="/src/api/resources/orderDrafts/resources/cargo/client/Client.ts">updateV1</a>({ ...params }) -> string</code></summary>
|
|
8570
8550
|
<dl>
|
|
8571
8551
|
<dd>
|
|
8572
8552
|
|
|
@@ -8578,7 +8558,7 @@ await client.orders.draft.addTaskArtifactV1({
|
|
|
8578
8558
|
<dl>
|
|
8579
8559
|
<dd>
|
|
8580
8560
|
|
|
8581
|
-
|
|
8561
|
+
Updates a cargo item in an existing draft order. Validates order is in DRAFT status and owned by caller.
|
|
8582
8562
|
|
|
8583
8563
|
</dd>
|
|
8584
8564
|
</dl>
|
|
@@ -8594,7 +8574,10 @@ Deletes a task artifact from a draft order and removes it from the associated ta
|
|
|
8594
8574
|
<dd>
|
|
8595
8575
|
|
|
8596
8576
|
```typescript
|
|
8597
|
-
await client.
|
|
8577
|
+
await client.orderDrafts.cargo.updateV1({
|
|
8578
|
+
cargo_id: "cargo_id",
|
|
8579
|
+
cargo_update: {},
|
|
8580
|
+
});
|
|
8598
8581
|
```
|
|
8599
8582
|
|
|
8600
8583
|
</dd>
|
|
@@ -8610,7 +8593,7 @@ await client.orders.draft.deleteTaskArtifactV1("task_artifact_id");
|
|
|
8610
8593
|
<dl>
|
|
8611
8594
|
<dd>
|
|
8612
8595
|
|
|
8613
|
-
**
|
|
8596
|
+
**request:** `Chrt.orderDrafts.OrderDraftUpdateCargoReq`
|
|
8614
8597
|
|
|
8615
8598
|
</dd>
|
|
8616
8599
|
</dl>
|
|
@@ -8618,7 +8601,7 @@ await client.orders.draft.deleteTaskArtifactV1("task_artifact_id");
|
|
|
8618
8601
|
<dl>
|
|
8619
8602
|
<dd>
|
|
8620
8603
|
|
|
8621
|
-
**requestOptions:** `
|
|
8604
|
+
**requestOptions:** `Cargo.RequestOptions`
|
|
8622
8605
|
|
|
8623
8606
|
</dd>
|
|
8624
8607
|
</dl>
|
|
@@ -8629,7 +8612,7 @@ await client.orders.draft.deleteTaskArtifactV1("task_artifact_id");
|
|
|
8629
8612
|
</dl>
|
|
8630
8613
|
</details>
|
|
8631
8614
|
|
|
8632
|
-
<details><summary><code>client.
|
|
8615
|
+
<details><summary><code>client.orderDrafts.cargo.<a href="/src/api/resources/orderDrafts/resources/cargo/client/Client.ts">deleteV1</a>(cargoId) -> boolean</code></summary>
|
|
8633
8616
|
<dl>
|
|
8634
8617
|
<dd>
|
|
8635
8618
|
|
|
@@ -8641,7 +8624,7 @@ await client.orders.draft.deleteTaskArtifactV1("task_artifact_id");
|
|
|
8641
8624
|
<dl>
|
|
8642
8625
|
<dd>
|
|
8643
8626
|
|
|
8644
|
-
|
|
8627
|
+
Deletes a cargo item from a draft order and removes references from associated tasks
|
|
8645
8628
|
|
|
8646
8629
|
</dd>
|
|
8647
8630
|
</dl>
|
|
@@ -8657,13 +8640,7 @@ Creates a cargo item in an existing draft order. Validates order is in DRAFT sta
|
|
|
8657
8640
|
<dd>
|
|
8658
8641
|
|
|
8659
8642
|
```typescript
|
|
8660
|
-
await client.
|
|
8661
|
-
order_id: "order_id",
|
|
8662
|
-
cargo: {
|
|
8663
|
-
schema_version: 1,
|
|
8664
|
-
cargo_type: "spare_parts",
|
|
8665
|
-
},
|
|
8666
|
-
});
|
|
8643
|
+
await client.orderDrafts.cargo.deleteV1("cargo_id");
|
|
8667
8644
|
```
|
|
8668
8645
|
|
|
8669
8646
|
</dd>
|
|
@@ -8679,7 +8656,7 @@ await client.orders.draft.createCargoV1({
|
|
|
8679
8656
|
<dl>
|
|
8680
8657
|
<dd>
|
|
8681
8658
|
|
|
8682
|
-
**
|
|
8659
|
+
**cargoId:** `string`
|
|
8683
8660
|
|
|
8684
8661
|
</dd>
|
|
8685
8662
|
</dl>
|
|
@@ -8687,7 +8664,7 @@ await client.orders.draft.createCargoV1({
|
|
|
8687
8664
|
<dl>
|
|
8688
8665
|
<dd>
|
|
8689
8666
|
|
|
8690
|
-
**requestOptions:** `
|
|
8667
|
+
**requestOptions:** `Cargo.RequestOptions`
|
|
8691
8668
|
|
|
8692
8669
|
</dd>
|
|
8693
8670
|
</dl>
|
|
@@ -8698,7 +8675,9 @@ await client.orders.draft.createCargoV1({
|
|
|
8698
8675
|
</dl>
|
|
8699
8676
|
</details>
|
|
8700
8677
|
|
|
8701
|
-
|
|
8678
|
+
## Orders Expanded
|
|
8679
|
+
|
|
8680
|
+
<details><summary><code>client.orders.expanded.<a href="/src/api/resources/orders/resources/expanded/client/Client.ts">postForShipperByOrderIdV1</a>(orderIdOrShortId, { ...params }) -> Chrt.OrderExpandedForShipper</code></summary>
|
|
8702
8681
|
<dl>
|
|
8703
8682
|
<dd>
|
|
8704
8683
|
|
|
@@ -8710,7 +8689,7 @@ await client.orders.draft.createCargoV1({
|
|
|
8710
8689
|
<dl>
|
|
8711
8690
|
<dd>
|
|
8712
8691
|
|
|
8713
|
-
|
|
8692
|
+
Fetches a single order for the shipper organization with optional expanded related data.
|
|
8714
8693
|
|
|
8715
8694
|
</dd>
|
|
8716
8695
|
</dl>
|
|
@@ -8726,11 +8705,7 @@ Associates existing cargo with a task in a draft order.
|
|
|
8726
8705
|
<dd>
|
|
8727
8706
|
|
|
8728
8707
|
```typescript
|
|
8729
|
-
await client.orders.
|
|
8730
|
-
order_id: "order_id",
|
|
8731
|
-
task_id: "task_id",
|
|
8732
|
-
cargo_id: "cargo_id",
|
|
8733
|
-
});
|
|
8708
|
+
await client.orders.expanded.postForShipperByOrderIdV1("order_id_or_short_id", {});
|
|
8734
8709
|
```
|
|
8735
8710
|
|
|
8736
8711
|
</dd>
|
|
@@ -8746,7 +8721,15 @@ await client.orders.draft.associateCargoWithTaskV1({
|
|
|
8746
8721
|
<dl>
|
|
8747
8722
|
<dd>
|
|
8748
8723
|
|
|
8749
|
-
**
|
|
8724
|
+
**orderIdOrShortId:** `string`
|
|
8725
|
+
|
|
8726
|
+
</dd>
|
|
8727
|
+
</dl>
|
|
8728
|
+
|
|
8729
|
+
<dl>
|
|
8730
|
+
<dd>
|
|
8731
|
+
|
|
8732
|
+
**request:** `Chrt.OrderExpandedForShipperReq`
|
|
8750
8733
|
|
|
8751
8734
|
</dd>
|
|
8752
8735
|
</dl>
|
|
@@ -8754,7 +8737,7 @@ await client.orders.draft.associateCargoWithTaskV1({
|
|
|
8754
8737
|
<dl>
|
|
8755
8738
|
<dd>
|
|
8756
8739
|
|
|
8757
|
-
**requestOptions:** `
|
|
8740
|
+
**requestOptions:** `Expanded.RequestOptions`
|
|
8758
8741
|
|
|
8759
8742
|
</dd>
|
|
8760
8743
|
</dl>
|
|
@@ -8765,7 +8748,7 @@ await client.orders.draft.associateCargoWithTaskV1({
|
|
|
8765
8748
|
</dl>
|
|
8766
8749
|
</details>
|
|
8767
8750
|
|
|
8768
|
-
<details><summary><code>client.orders.
|
|
8751
|
+
<details><summary><code>client.orders.expanded.<a href="/src/api/resources/orders/resources/expanded/client/Client.ts">postForOrderCreatorByOrderIdV1</a>(orderIdOrShortId, { ...params }) -> Chrt.OrderExpandedForOrderCreator</code></summary>
|
|
8769
8752
|
<dl>
|
|
8770
8753
|
<dd>
|
|
8771
8754
|
|
|
@@ -8777,7 +8760,7 @@ await client.orders.draft.associateCargoWithTaskV1({
|
|
|
8777
8760
|
<dl>
|
|
8778
8761
|
<dd>
|
|
8779
8762
|
|
|
8780
|
-
|
|
8763
|
+
Fetches a single order for the organization that created it with optional expanded related data.
|
|
8781
8764
|
|
|
8782
8765
|
</dd>
|
|
8783
8766
|
</dl>
|
|
@@ -8793,10 +8776,7 @@ Updates a cargo item in an existing draft order. Validates order is in DRAFT sta
|
|
|
8793
8776
|
<dd>
|
|
8794
8777
|
|
|
8795
8778
|
```typescript
|
|
8796
|
-
await client.orders.
|
|
8797
|
-
cargo_id: "cargo_id",
|
|
8798
|
-
cargo_update: {},
|
|
8799
|
-
});
|
|
8779
|
+
await client.orders.expanded.postForOrderCreatorByOrderIdV1("order_id_or_short_id", {});
|
|
8800
8780
|
```
|
|
8801
8781
|
|
|
8802
8782
|
</dd>
|
|
@@ -8812,7 +8792,15 @@ await client.orders.draft.updateCargoV1({
|
|
|
8812
8792
|
<dl>
|
|
8813
8793
|
<dd>
|
|
8814
8794
|
|
|
8815
|
-
**
|
|
8795
|
+
**orderIdOrShortId:** `string`
|
|
8796
|
+
|
|
8797
|
+
</dd>
|
|
8798
|
+
</dl>
|
|
8799
|
+
|
|
8800
|
+
<dl>
|
|
8801
|
+
<dd>
|
|
8802
|
+
|
|
8803
|
+
**request:** `Chrt.OrderExpandedForOrderCreatorReq`
|
|
8816
8804
|
|
|
8817
8805
|
</dd>
|
|
8818
8806
|
</dl>
|
|
@@ -8820,7 +8808,7 @@ await client.orders.draft.updateCargoV1({
|
|
|
8820
8808
|
<dl>
|
|
8821
8809
|
<dd>
|
|
8822
8810
|
|
|
8823
|
-
**requestOptions:** `
|
|
8811
|
+
**requestOptions:** `Expanded.RequestOptions`
|
|
8824
8812
|
|
|
8825
8813
|
</dd>
|
|
8826
8814
|
</dl>
|
|
@@ -8831,7 +8819,9 @@ await client.orders.draft.updateCargoV1({
|
|
|
8831
8819
|
</dl>
|
|
8832
8820
|
</details>
|
|
8833
8821
|
|
|
8834
|
-
|
|
8822
|
+
## Orders ExpandedList
|
|
8823
|
+
|
|
8824
|
+
<details><summary><code>client.orders.expandedList.<a href="/src/api/resources/orders/resources/expandedList/client/Client.ts">postShipperExpandedListV1</a>({ ...params }) -> Chrt.OrdersExpandedForShipperRes</code></summary>
|
|
8835
8825
|
<dl>
|
|
8836
8826
|
<dd>
|
|
8837
8827
|
|
|
@@ -8843,7 +8833,7 @@ await client.orders.draft.updateCargoV1({
|
|
|
8843
8833
|
<dl>
|
|
8844
8834
|
<dd>
|
|
8845
8835
|
|
|
8846
|
-
|
|
8836
|
+
Retrieves orders expanded list for the shipper organization with optional filters and related data.
|
|
8847
8837
|
|
|
8848
8838
|
</dd>
|
|
8849
8839
|
</dl>
|
|
@@ -8859,7 +8849,16 @@ Deletes a cargo item from a draft order and removes references from associated t
|
|
|
8859
8849
|
<dd>
|
|
8860
8850
|
|
|
8861
8851
|
```typescript
|
|
8862
|
-
await client.orders.
|
|
8852
|
+
await client.orders.expandedList.postShipperExpandedListV1({
|
|
8853
|
+
page: 1,
|
|
8854
|
+
page_size: 1,
|
|
8855
|
+
sort_by: "draft_started_at",
|
|
8856
|
+
sort_order: "asc",
|
|
8857
|
+
filter_draft_started_at_gte: "2024-01-15T09:30:00Z",
|
|
8858
|
+
filter_draft_started_at_lte: "2024-01-15T09:30:00Z",
|
|
8859
|
+
filter_order_cancelled: true,
|
|
8860
|
+
body: {},
|
|
8861
|
+
});
|
|
8863
8862
|
```
|
|
8864
8863
|
|
|
8865
8864
|
</dd>
|
|
@@ -8875,7 +8874,7 @@ await client.orders.draft.deleteCargoV1("cargo_id");
|
|
|
8875
8874
|
<dl>
|
|
8876
8875
|
<dd>
|
|
8877
8876
|
|
|
8878
|
-
**
|
|
8877
|
+
**request:** `Chrt.orders.ExpandedListPostShipperExpandedListV1Request`
|
|
8879
8878
|
|
|
8880
8879
|
</dd>
|
|
8881
8880
|
</dl>
|
|
@@ -8883,7 +8882,7 @@ await client.orders.draft.deleteCargoV1("cargo_id");
|
|
|
8883
8882
|
<dl>
|
|
8884
8883
|
<dd>
|
|
8885
8884
|
|
|
8886
|
-
**requestOptions:** `
|
|
8885
|
+
**requestOptions:** `ExpandedList.RequestOptions`
|
|
8887
8886
|
|
|
8888
8887
|
</dd>
|
|
8889
8888
|
</dl>
|
|
@@ -8894,7 +8893,7 @@ await client.orders.draft.deleteCargoV1("cargo_id");
|
|
|
8894
8893
|
</dl>
|
|
8895
8894
|
</details>
|
|
8896
8895
|
|
|
8897
|
-
<details><summary><code>client.orders.
|
|
8896
|
+
<details><summary><code>client.orders.expandedList.<a href="/src/api/resources/orders/resources/expandedList/client/Client.ts">postOrderCreatorExpandedListV1</a>({ ...params }) -> Chrt.OrdersExpandedForOrderCreatorRes</code></summary>
|
|
8898
8897
|
<dl>
|
|
8899
8898
|
<dd>
|
|
8900
8899
|
|
|
@@ -8906,7 +8905,7 @@ await client.orders.draft.deleteCargoV1("cargo_id");
|
|
|
8906
8905
|
<dl>
|
|
8907
8906
|
<dd>
|
|
8908
8907
|
|
|
8909
|
-
|
|
8908
|
+
Retrieves orders expanded list for order creator org with optional filters, shipper includes, and exclusions.
|
|
8910
8909
|
|
|
8911
8910
|
</dd>
|
|
8912
8911
|
</dl>
|
|
@@ -8922,7 +8921,16 @@ Checks whether the draft order satisfies all requirements to move into staging.
|
|
|
8922
8921
|
<dd>
|
|
8923
8922
|
|
|
8924
8923
|
```typescript
|
|
8925
|
-
await client.orders.
|
|
8924
|
+
await client.orders.expandedList.postOrderCreatorExpandedListV1({
|
|
8925
|
+
page: 1,
|
|
8926
|
+
page_size: 1,
|
|
8927
|
+
sort_by: "draft_started_at",
|
|
8928
|
+
sort_order: "asc",
|
|
8929
|
+
filter_draft_started_at_gte: "2024-01-15T09:30:00Z",
|
|
8930
|
+
filter_draft_started_at_lte: "2024-01-15T09:30:00Z",
|
|
8931
|
+
filter_order_cancelled: true,
|
|
8932
|
+
body: {},
|
|
8933
|
+
});
|
|
8926
8934
|
```
|
|
8927
8935
|
|
|
8928
8936
|
</dd>
|
|
@@ -8938,7 +8946,7 @@ await client.orders.draft.getDraftValidateV1("order_id");
|
|
|
8938
8946
|
<dl>
|
|
8939
8947
|
<dd>
|
|
8940
8948
|
|
|
8941
|
-
**
|
|
8949
|
+
**request:** `Chrt.orders.ExpandedListPostOrderCreatorExpandedListV1Request`
|
|
8942
8950
|
|
|
8943
8951
|
</dd>
|
|
8944
8952
|
</dl>
|
|
@@ -8946,7 +8954,7 @@ await client.orders.draft.getDraftValidateV1("order_id");
|
|
|
8946
8954
|
<dl>
|
|
8947
8955
|
<dd>
|
|
8948
8956
|
|
|
8949
|
-
**requestOptions:** `
|
|
8957
|
+
**requestOptions:** `ExpandedList.RequestOptions`
|
|
8950
8958
|
|
|
8951
8959
|
</dd>
|
|
8952
8960
|
</dl>
|