@chrt-inc/typescript-sdk 1.887.0 → 1.888.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/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/orgs/resources/accounts/client/Client.d.ts +1 -0
- package/dist/cjs/api/resources/orgs/resources/accounts/client/Client.js +5 -1
- package/dist/cjs/api/resources/orgs/resources/accounts/client/requests/AccountsListV1Request.d.ts +3 -0
- package/dist/cjs/api/resources/orgs/resources/contacts/client/Client.d.ts +30 -0
- package/dist/cjs/api/resources/orgs/resources/contacts/client/Client.js +125 -0
- package/dist/cjs/api/resources/orgs/resources/contacts/client/requests/ContactAccountAddReq.d.ts +12 -0
- package/dist/cjs/api/resources/orgs/resources/contacts/client/requests/ContactAccountAddReq.js +5 -0
- package/dist/cjs/api/resources/orgs/resources/contacts/client/requests/ContactClientCreate1.d.ts +1 -1
- package/dist/cjs/api/resources/orgs/resources/contacts/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/cargos/client/Client.d.ts +53 -0
- package/dist/cjs/api/resources/shipping/resources/cargos/client/Client.js +200 -0
- package/dist/cjs/api/resources/shipping/resources/cargos/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/cargos/client/index.js +15 -0
- package/dist/cjs/api/resources/shipping/resources/cargos/client/requests/CargoAddToOrderReq.d.ts +18 -0
- package/dist/cjs/api/resources/shipping/resources/cargos/client/requests/CargoAddToOrderReq.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/cargos/client/requests/CargoAssociateWithTaskReq.d.ts +16 -0
- package/dist/cjs/api/resources/shipping/resources/cargos/client/requests/CargoAssociateWithTaskReq.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/cargos/client/requests/CargoUnassociateWithTaskReq.d.ts +16 -0
- package/dist/cjs/api/resources/shipping/resources/cargos/client/requests/CargoUnassociateWithTaskReq.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/cargos/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/shipping/resources/cargos/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shipping/resources/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/index.js +1 -0
- package/dist/cjs/api/types/Contact1.d.ts +1 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/resources/orgs/resources/accounts/client/Client.d.mts +1 -0
- package/dist/esm/api/resources/orgs/resources/accounts/client/Client.mjs +5 -1
- package/dist/esm/api/resources/orgs/resources/accounts/client/requests/AccountsListV1Request.d.mts +3 -0
- package/dist/esm/api/resources/orgs/resources/contacts/client/Client.d.mts +30 -0
- package/dist/esm/api/resources/orgs/resources/contacts/client/Client.mjs +125 -0
- package/dist/esm/api/resources/orgs/resources/contacts/client/requests/ContactAccountAddReq.d.mts +12 -0
- package/dist/esm/api/resources/orgs/resources/contacts/client/requests/ContactAccountAddReq.mjs +4 -0
- package/dist/esm/api/resources/orgs/resources/contacts/client/requests/ContactClientCreate1.d.mts +1 -1
- package/dist/esm/api/resources/orgs/resources/contacts/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/cargos/client/Client.d.mts +53 -0
- package/dist/esm/api/resources/shipping/resources/cargos/client/Client.mjs +200 -0
- package/dist/esm/api/resources/shipping/resources/cargos/client/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/cargos/client/index.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/cargos/client/requests/CargoAddToOrderReq.d.mts +18 -0
- package/dist/esm/api/resources/shipping/resources/cargos/client/requests/CargoAddToOrderReq.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/cargos/client/requests/CargoAssociateWithTaskReq.d.mts +16 -0
- package/dist/esm/api/resources/shipping/resources/cargos/client/requests/CargoAssociateWithTaskReq.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/cargos/client/requests/CargoUnassociateWithTaskReq.d.mts +16 -0
- package/dist/esm/api/resources/shipping/resources/cargos/client/requests/CargoUnassociateWithTaskReq.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/cargos/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/shipping/resources/cargos/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/index.mjs +1 -0
- package/dist/esm/api/types/Contact1.d.mts +1 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +348 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -10,6 +10,7 @@ export * as ordersAndOrderGroups from "./ordersAndOrderGroups/index.mjs";
|
|
|
10
10
|
export * as taskArtifacts from "./taskArtifacts/index.mjs";
|
|
11
11
|
export * as taskGroups from "./taskGroups/index.mjs";
|
|
12
12
|
export * as tasks from "./tasks/index.mjs";
|
|
13
|
+
export * from "./cargos/client/requests/index.mjs";
|
|
13
14
|
export * from "./drivers/client/requests/index.mjs";
|
|
14
15
|
export * from "./orderGroups/client/requests/index.mjs";
|
|
15
16
|
export * from "./orderSchedules/client/requests/index.mjs";
|
|
@@ -10,6 +10,7 @@ export * as ordersAndOrderGroups from "./ordersAndOrderGroups/index.mjs";
|
|
|
10
10
|
export * as taskArtifacts from "./taskArtifacts/index.mjs";
|
|
11
11
|
export * as taskGroups from "./taskGroups/index.mjs";
|
|
12
12
|
export * as tasks from "./tasks/index.mjs";
|
|
13
|
+
export * from "./cargos/client/requests/index.mjs";
|
|
13
14
|
export * from "./drivers/client/requests/index.mjs";
|
|
14
15
|
export * from "./orderGroups/client/requests/index.mjs";
|
|
15
16
|
export * from "./orderSchedules/client/requests/index.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.
|
|
1
|
+
export declare const SDK_VERSION = "1.888.0";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "1.
|
|
1
|
+
export const SDK_VERSION = "1.888.0";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -14040,6 +14040,7 @@ Lists coordinator-created shipper accounts with association filters, name search
|
|
|
14040
14040
|
```typescript
|
|
14041
14041
|
await client.orgs.accounts.listV1({
|
|
14042
14042
|
search: "search",
|
|
14043
|
+
filter_account_id: "filter_account_id",
|
|
14043
14044
|
filter_org_id: "filter_org_id",
|
|
14044
14045
|
filter_off_chrt_org_data_id: "filter_off_chrt_org_data_id",
|
|
14045
14046
|
sort_by: "name",
|
|
@@ -15223,6 +15224,150 @@ await client.orgs.connections.listShippersForCoordinatorV1({
|
|
|
15223
15224
|
|
|
15224
15225
|
## Orgs Contacts
|
|
15225
15226
|
|
|
15227
|
+
<details><summary><code>client.orgs.contacts.<a href="/src/api/resources/orgs/resources/contacts/client/Client.ts">accountAddV1</a>(contactId, { ...params }) -> boolean</code></summary>
|
|
15228
|
+
<dl>
|
|
15229
|
+
<dd>
|
|
15230
|
+
|
|
15231
|
+
#### 📝 Description
|
|
15232
|
+
|
|
15233
|
+
<dl>
|
|
15234
|
+
<dd>
|
|
15235
|
+
|
|
15236
|
+
<dl>
|
|
15237
|
+
<dd>
|
|
15238
|
+
|
|
15239
|
+
Associates an account from the contact's organization. | authz: min_org_role=operator | (ContactAccountAddReq) -> (bool)
|
|
15240
|
+
|
|
15241
|
+
</dd>
|
|
15242
|
+
</dl>
|
|
15243
|
+
</dd>
|
|
15244
|
+
</dl>
|
|
15245
|
+
|
|
15246
|
+
#### 🔌 Usage
|
|
15247
|
+
|
|
15248
|
+
<dl>
|
|
15249
|
+
<dd>
|
|
15250
|
+
|
|
15251
|
+
<dl>
|
|
15252
|
+
<dd>
|
|
15253
|
+
|
|
15254
|
+
```typescript
|
|
15255
|
+
await client.orgs.contacts.accountAddV1("contact_id", {
|
|
15256
|
+
account_id: "account_id",
|
|
15257
|
+
});
|
|
15258
|
+
```
|
|
15259
|
+
|
|
15260
|
+
</dd>
|
|
15261
|
+
</dl>
|
|
15262
|
+
</dd>
|
|
15263
|
+
</dl>
|
|
15264
|
+
|
|
15265
|
+
#### ⚙️ Parameters
|
|
15266
|
+
|
|
15267
|
+
<dl>
|
|
15268
|
+
<dd>
|
|
15269
|
+
|
|
15270
|
+
<dl>
|
|
15271
|
+
<dd>
|
|
15272
|
+
|
|
15273
|
+
**contactId:** `string`
|
|
15274
|
+
|
|
15275
|
+
</dd>
|
|
15276
|
+
</dl>
|
|
15277
|
+
|
|
15278
|
+
<dl>
|
|
15279
|
+
<dd>
|
|
15280
|
+
|
|
15281
|
+
**request:** `Chrt.orgs.ContactAccountAddReq`
|
|
15282
|
+
|
|
15283
|
+
</dd>
|
|
15284
|
+
</dl>
|
|
15285
|
+
|
|
15286
|
+
<dl>
|
|
15287
|
+
<dd>
|
|
15288
|
+
|
|
15289
|
+
**requestOptions:** `Contacts.RequestOptions`
|
|
15290
|
+
|
|
15291
|
+
</dd>
|
|
15292
|
+
</dl>
|
|
15293
|
+
</dd>
|
|
15294
|
+
</dl>
|
|
15295
|
+
|
|
15296
|
+
</dd>
|
|
15297
|
+
</dl>
|
|
15298
|
+
</details>
|
|
15299
|
+
|
|
15300
|
+
<details><summary><code>client.orgs.contacts.<a href="/src/api/resources/orgs/resources/contacts/client/Client.ts">accountRemoveV1</a>(contactId, accountId) -> boolean</code></summary>
|
|
15301
|
+
<dl>
|
|
15302
|
+
<dd>
|
|
15303
|
+
|
|
15304
|
+
#### 📝 Description
|
|
15305
|
+
|
|
15306
|
+
<dl>
|
|
15307
|
+
<dd>
|
|
15308
|
+
|
|
15309
|
+
<dl>
|
|
15310
|
+
<dd>
|
|
15311
|
+
|
|
15312
|
+
Removes an account association from an organization-created contact. | authz: min_org_role=operator | () -> (bool)
|
|
15313
|
+
|
|
15314
|
+
</dd>
|
|
15315
|
+
</dl>
|
|
15316
|
+
</dd>
|
|
15317
|
+
</dl>
|
|
15318
|
+
|
|
15319
|
+
#### 🔌 Usage
|
|
15320
|
+
|
|
15321
|
+
<dl>
|
|
15322
|
+
<dd>
|
|
15323
|
+
|
|
15324
|
+
<dl>
|
|
15325
|
+
<dd>
|
|
15326
|
+
|
|
15327
|
+
```typescript
|
|
15328
|
+
await client.orgs.contacts.accountRemoveV1("contact_id", "account_id");
|
|
15329
|
+
```
|
|
15330
|
+
|
|
15331
|
+
</dd>
|
|
15332
|
+
</dl>
|
|
15333
|
+
</dd>
|
|
15334
|
+
</dl>
|
|
15335
|
+
|
|
15336
|
+
#### ⚙️ Parameters
|
|
15337
|
+
|
|
15338
|
+
<dl>
|
|
15339
|
+
<dd>
|
|
15340
|
+
|
|
15341
|
+
<dl>
|
|
15342
|
+
<dd>
|
|
15343
|
+
|
|
15344
|
+
**contactId:** `string`
|
|
15345
|
+
|
|
15346
|
+
</dd>
|
|
15347
|
+
</dl>
|
|
15348
|
+
|
|
15349
|
+
<dl>
|
|
15350
|
+
<dd>
|
|
15351
|
+
|
|
15352
|
+
**accountId:** `string`
|
|
15353
|
+
|
|
15354
|
+
</dd>
|
|
15355
|
+
</dl>
|
|
15356
|
+
|
|
15357
|
+
<dl>
|
|
15358
|
+
<dd>
|
|
15359
|
+
|
|
15360
|
+
**requestOptions:** `Contacts.RequestOptions`
|
|
15361
|
+
|
|
15362
|
+
</dd>
|
|
15363
|
+
</dl>
|
|
15364
|
+
</dd>
|
|
15365
|
+
</dl>
|
|
15366
|
+
|
|
15367
|
+
</dd>
|
|
15368
|
+
</dl>
|
|
15369
|
+
</details>
|
|
15370
|
+
|
|
15226
15371
|
<details><summary><code>client.orgs.contacts.<a href="/src/api/resources/orgs/resources/contacts/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
15227
15372
|
<dl>
|
|
15228
15373
|
<dd>
|
|
@@ -16732,6 +16877,209 @@ await client.orgs.connections.shippers.typeaheadV1({
|
|
|
16732
16877
|
|
|
16733
16878
|
## Shipping Cargos
|
|
16734
16879
|
|
|
16880
|
+
<details><summary><code>client.shipping.cargos.<a href="/src/api/resources/shipping/resources/cargos/client/Client.ts">addV1</a>({ ...params }) -> string</code></summary>
|
|
16881
|
+
<dl>
|
|
16882
|
+
<dd>
|
|
16883
|
+
|
|
16884
|
+
#### 📝 Description
|
|
16885
|
+
|
|
16886
|
+
<dl>
|
|
16887
|
+
<dd>
|
|
16888
|
+
|
|
16889
|
+
<dl>
|
|
16890
|
+
<dd>
|
|
16891
|
+
|
|
16892
|
+
Adds cargo to a non-DRAFT order. Cargo added to a terminal order starts terminal; otherwise it starts STAGED. | authz_personas=[coordinator_org_operators] | (CargoAddToOrderReq) -> (PydanticObjectId)
|
|
16893
|
+
|
|
16894
|
+
</dd>
|
|
16895
|
+
</dl>
|
|
16896
|
+
</dd>
|
|
16897
|
+
</dl>
|
|
16898
|
+
|
|
16899
|
+
#### 🔌 Usage
|
|
16900
|
+
|
|
16901
|
+
<dl>
|
|
16902
|
+
<dd>
|
|
16903
|
+
|
|
16904
|
+
<dl>
|
|
16905
|
+
<dd>
|
|
16906
|
+
|
|
16907
|
+
```typescript
|
|
16908
|
+
await client.shipping.cargos.addV1({
|
|
16909
|
+
cargo: {
|
|
16910
|
+
cargo_type: "spare_parts",
|
|
16911
|
+
schema_version: 1,
|
|
16912
|
+
},
|
|
16913
|
+
order_id: "order_id",
|
|
16914
|
+
});
|
|
16915
|
+
```
|
|
16916
|
+
|
|
16917
|
+
</dd>
|
|
16918
|
+
</dl>
|
|
16919
|
+
</dd>
|
|
16920
|
+
</dl>
|
|
16921
|
+
|
|
16922
|
+
#### ⚙️ Parameters
|
|
16923
|
+
|
|
16924
|
+
<dl>
|
|
16925
|
+
<dd>
|
|
16926
|
+
|
|
16927
|
+
<dl>
|
|
16928
|
+
<dd>
|
|
16929
|
+
|
|
16930
|
+
**request:** `Chrt.shipping.CargoAddToOrderReq`
|
|
16931
|
+
|
|
16932
|
+
</dd>
|
|
16933
|
+
</dl>
|
|
16934
|
+
|
|
16935
|
+
<dl>
|
|
16936
|
+
<dd>
|
|
16937
|
+
|
|
16938
|
+
**requestOptions:** `Cargos.RequestOptions`
|
|
16939
|
+
|
|
16940
|
+
</dd>
|
|
16941
|
+
</dl>
|
|
16942
|
+
</dd>
|
|
16943
|
+
</dl>
|
|
16944
|
+
|
|
16945
|
+
</dd>
|
|
16946
|
+
</dl>
|
|
16947
|
+
</details>
|
|
16948
|
+
|
|
16949
|
+
<details><summary><code>client.shipping.cargos.<a href="/src/api/resources/shipping/resources/cargos/client/Client.ts">associateWithTaskV1</a>({ ...params }) -> boolean</code></summary>
|
|
16950
|
+
<dl>
|
|
16951
|
+
<dd>
|
|
16952
|
+
|
|
16953
|
+
#### 📝 Description
|
|
16954
|
+
|
|
16955
|
+
<dl>
|
|
16956
|
+
<dd>
|
|
16957
|
+
|
|
16958
|
+
<dl>
|
|
16959
|
+
<dd>
|
|
16960
|
+
|
|
16961
|
+
Associates cargo with a task on a non-DRAFT order, then derives cargo status from all associated tasks in the order's task sequence. | authz_personas=[coordinator_org_operators] | (CargoAssociateWithTaskReq) -> (bool)
|
|
16962
|
+
|
|
16963
|
+
</dd>
|
|
16964
|
+
</dl>
|
|
16965
|
+
</dd>
|
|
16966
|
+
</dl>
|
|
16967
|
+
|
|
16968
|
+
#### 🔌 Usage
|
|
16969
|
+
|
|
16970
|
+
<dl>
|
|
16971
|
+
<dd>
|
|
16972
|
+
|
|
16973
|
+
<dl>
|
|
16974
|
+
<dd>
|
|
16975
|
+
|
|
16976
|
+
```typescript
|
|
16977
|
+
await client.shipping.cargos.associateWithTaskV1({
|
|
16978
|
+
cargo_id: "cargo_id",
|
|
16979
|
+
order_id: "order_id",
|
|
16980
|
+
task_id: "task_id",
|
|
16981
|
+
});
|
|
16982
|
+
```
|
|
16983
|
+
|
|
16984
|
+
</dd>
|
|
16985
|
+
</dl>
|
|
16986
|
+
</dd>
|
|
16987
|
+
</dl>
|
|
16988
|
+
|
|
16989
|
+
#### ⚙️ Parameters
|
|
16990
|
+
|
|
16991
|
+
<dl>
|
|
16992
|
+
<dd>
|
|
16993
|
+
|
|
16994
|
+
<dl>
|
|
16995
|
+
<dd>
|
|
16996
|
+
|
|
16997
|
+
**request:** `Chrt.shipping.CargoAssociateWithTaskReq`
|
|
16998
|
+
|
|
16999
|
+
</dd>
|
|
17000
|
+
</dl>
|
|
17001
|
+
|
|
17002
|
+
<dl>
|
|
17003
|
+
<dd>
|
|
17004
|
+
|
|
17005
|
+
**requestOptions:** `Cargos.RequestOptions`
|
|
17006
|
+
|
|
17007
|
+
</dd>
|
|
17008
|
+
</dl>
|
|
17009
|
+
</dd>
|
|
17010
|
+
</dl>
|
|
17011
|
+
|
|
17012
|
+
</dd>
|
|
17013
|
+
</dl>
|
|
17014
|
+
</details>
|
|
17015
|
+
|
|
17016
|
+
<details><summary><code>client.shipping.cargos.<a href="/src/api/resources/shipping/resources/cargos/client/Client.ts">unassociateWithTaskV1</a>({ ...params }) -> boolean</code></summary>
|
|
17017
|
+
<dl>
|
|
17018
|
+
<dd>
|
|
17019
|
+
|
|
17020
|
+
#### 📝 Description
|
|
17021
|
+
|
|
17022
|
+
<dl>
|
|
17023
|
+
<dd>
|
|
17024
|
+
|
|
17025
|
+
<dl>
|
|
17026
|
+
<dd>
|
|
17027
|
+
|
|
17028
|
+
Removes a cargo association from a task on a non-DRAFT order, then derives cargo status from the remaining associated tasks in the order's task sequence. | authz_personas=[coordinator_org_operators] | (CargoUnassociateWithTaskReq) -> (bool)
|
|
17029
|
+
|
|
17030
|
+
</dd>
|
|
17031
|
+
</dl>
|
|
17032
|
+
</dd>
|
|
17033
|
+
</dl>
|
|
17034
|
+
|
|
17035
|
+
#### 🔌 Usage
|
|
17036
|
+
|
|
17037
|
+
<dl>
|
|
17038
|
+
<dd>
|
|
17039
|
+
|
|
17040
|
+
<dl>
|
|
17041
|
+
<dd>
|
|
17042
|
+
|
|
17043
|
+
```typescript
|
|
17044
|
+
await client.shipping.cargos.unassociateWithTaskV1({
|
|
17045
|
+
cargo_id: "cargo_id",
|
|
17046
|
+
order_id: "order_id",
|
|
17047
|
+
task_id: "task_id",
|
|
17048
|
+
});
|
|
17049
|
+
```
|
|
17050
|
+
|
|
17051
|
+
</dd>
|
|
17052
|
+
</dl>
|
|
17053
|
+
</dd>
|
|
17054
|
+
</dl>
|
|
17055
|
+
|
|
17056
|
+
#### ⚙️ Parameters
|
|
17057
|
+
|
|
17058
|
+
<dl>
|
|
17059
|
+
<dd>
|
|
17060
|
+
|
|
17061
|
+
<dl>
|
|
17062
|
+
<dd>
|
|
17063
|
+
|
|
17064
|
+
**request:** `Chrt.shipping.CargoUnassociateWithTaskReq`
|
|
17065
|
+
|
|
17066
|
+
</dd>
|
|
17067
|
+
</dl>
|
|
17068
|
+
|
|
17069
|
+
<dl>
|
|
17070
|
+
<dd>
|
|
17071
|
+
|
|
17072
|
+
**requestOptions:** `Cargos.RequestOptions`
|
|
17073
|
+
|
|
17074
|
+
</dd>
|
|
17075
|
+
</dl>
|
|
17076
|
+
</dd>
|
|
17077
|
+
</dl>
|
|
17078
|
+
|
|
17079
|
+
</dd>
|
|
17080
|
+
</dl>
|
|
17081
|
+
</details>
|
|
17082
|
+
|
|
16735
17083
|
<details><summary><code>client.shipping.cargos.<a href="/src/api/resources/shipping/resources/cargos/client/Client.ts">updateV1</a>(cargoId, { ...params }) -> string</code></summary>
|
|
16736
17084
|
<dl>
|
|
16737
17085
|
<dd>
|