@chrt-inc/typescript-sdk 1.961.0 → 1.962.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/shipping/resources/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/index.js +1 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/orderEvents/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/shipping/resources/orders/resources/orderEvents/client/Client.js +2 -2
- package/dist/cjs/api/resources/shipping/resources/taskArtifacts/client/Client.d.ts +15 -0
- package/dist/cjs/api/resources/shipping/resources/taskArtifacts/client/Client.js +63 -0
- package/dist/cjs/api/resources/shipping/resources/taskArtifacts/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/taskArtifacts/client/index.js +15 -0
- package/dist/cjs/api/resources/shipping/resources/taskArtifacts/client/requests/TaskArtifactCustodyPartiesUpdateReq.d.ts +14 -0
- package/dist/cjs/api/resources/shipping/resources/taskArtifacts/client/requests/TaskArtifactCustodyPartiesUpdateReq.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/taskArtifacts/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/taskArtifacts/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/client/Client.d.ts +14 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/client/Client.js +63 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/client/requests/TaskCustodyPartiesUpdateReq.d.ts +14 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/client/requests/TaskCustodyPartiesUpdateReq.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/users/resources/privateData/client/Client.d.ts +15 -0
- package/dist/cjs/api/resources/users/resources/privateData/client/Client.js +64 -0
- package/dist/cjs/api/resources/users/resources/privateData/client/requests/UserPrivateDataNameUpdateReq.d.ts +12 -0
- package/dist/cjs/api/resources/users/resources/privateData/client/requests/UserPrivateDataNameUpdateReq.js +5 -0
- package/dist/cjs/api/resources/users/resources/privateData/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/types/CustodyParty1.d.ts +10 -0
- package/dist/cjs/api/types/CustodyParty1.js +5 -0
- package/dist/cjs/api/types/CustodyPartyExpanded.d.ts +13 -0
- package/dist/cjs/api/types/CustodyPartyExpanded.js +5 -0
- package/dist/cjs/api/types/OrderEventActionEnum1.d.ts +2 -1
- package/dist/cjs/api/types/OrderEventActionEnum1.js +1 -0
- package/dist/cjs/api/types/OrderEventExpanded1.d.ts +1 -1
- package/dist/cjs/api/types/Task1.d.ts +2 -0
- package/dist/cjs/api/types/TaskArtifact1.d.ts +2 -0
- package/dist/cjs/api/types/TaskExpanded.d.ts +2 -0
- package/dist/cjs/api/types/UserPrivateData1.d.ts +1 -0
- package/dist/cjs/api/types/index.d.ts +2 -0
- package/dist/cjs/api/types/index.js +2 -0
- 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/shipping/resources/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/orderEvents/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/shipping/resources/orders/resources/orderEvents/client/Client.mjs +2 -2
- package/dist/esm/api/resources/shipping/resources/taskArtifacts/client/Client.d.mts +15 -0
- package/dist/esm/api/resources/shipping/resources/taskArtifacts/client/Client.mjs +63 -0
- package/dist/esm/api/resources/shipping/resources/taskArtifacts/client/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/taskArtifacts/client/index.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/taskArtifacts/client/requests/TaskArtifactCustodyPartiesUpdateReq.d.mts +14 -0
- package/dist/esm/api/resources/shipping/resources/taskArtifacts/client/requests/TaskArtifactCustodyPartiesUpdateReq.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/taskArtifacts/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/taskArtifacts/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/tasks/client/Client.d.mts +14 -0
- package/dist/esm/api/resources/shipping/resources/tasks/client/Client.mjs +63 -0
- package/dist/esm/api/resources/shipping/resources/tasks/client/requests/TaskCustodyPartiesUpdateReq.d.mts +14 -0
- package/dist/esm/api/resources/shipping/resources/tasks/client/requests/TaskCustodyPartiesUpdateReq.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/tasks/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/users/resources/privateData/client/Client.d.mts +15 -0
- package/dist/esm/api/resources/users/resources/privateData/client/Client.mjs +64 -0
- package/dist/esm/api/resources/users/resources/privateData/client/requests/UserPrivateDataNameUpdateReq.d.mts +12 -0
- package/dist/esm/api/resources/users/resources/privateData/client/requests/UserPrivateDataNameUpdateReq.mjs +4 -0
- package/dist/esm/api/resources/users/resources/privateData/client/requests/index.d.mts +1 -0
- package/dist/esm/api/types/CustodyParty1.d.mts +10 -0
- package/dist/esm/api/types/CustodyParty1.mjs +4 -0
- package/dist/esm/api/types/CustodyPartyExpanded.d.mts +13 -0
- package/dist/esm/api/types/CustodyPartyExpanded.mjs +4 -0
- package/dist/esm/api/types/OrderEventActionEnum1.d.mts +2 -1
- package/dist/esm/api/types/OrderEventActionEnum1.mjs +1 -0
- package/dist/esm/api/types/OrderEventExpanded1.d.mts +1 -1
- package/dist/esm/api/types/Task1.d.mts +2 -0
- package/dist/esm/api/types/TaskArtifact1.d.mts +2 -0
- package/dist/esm/api/types/TaskExpanded.d.mts +2 -0
- package/dist/esm/api/types/UserPrivateData1.d.mts +1 -0
- package/dist/esm/api/types/index.d.mts +2 -0
- package/dist/esm/api/types/index.mjs +2 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +209 -2
package/reference.md
CHANGED
|
@@ -17877,6 +17877,77 @@ await client.shipping.taskArtifacts.completeV1("task_artifact_id");
|
|
|
17877
17877
|
</dl>
|
|
17878
17878
|
</details>
|
|
17879
17879
|
|
|
17880
|
+
<details><summary><code>client.shipping.taskArtifacts.<a href="/src/api/resources/shipping/resources/taskArtifacts/client/Client.ts">updateCustodyPartiesV1</a>(taskArtifactId, { ...params }) -> boolean</code></summary>
|
|
17881
|
+
<dl>
|
|
17882
|
+
<dd>
|
|
17883
|
+
|
|
17884
|
+
#### 📝 Description
|
|
17885
|
+
|
|
17886
|
+
<dl>
|
|
17887
|
+
<dd>
|
|
17888
|
+
|
|
17889
|
+
<dl>
|
|
17890
|
+
<dd>
|
|
17891
|
+
|
|
17892
|
+
Updates or clears the parties that provided or received cargo for a task artifact. Contact references must belong to the caller's organization. | authz_personas=[draft_creator_org_operator, driver_for_executor, executor_org_operators, coordinator_org_operators] (depending on status) | (TaskArtifactCustodyPartiesUpdateReq) -> (bool)
|
|
17893
|
+
|
|
17894
|
+
</dd>
|
|
17895
|
+
</dl>
|
|
17896
|
+
</dd>
|
|
17897
|
+
</dl>
|
|
17898
|
+
|
|
17899
|
+
#### 🔌 Usage
|
|
17900
|
+
|
|
17901
|
+
<dl>
|
|
17902
|
+
<dd>
|
|
17903
|
+
|
|
17904
|
+
<dl>
|
|
17905
|
+
<dd>
|
|
17906
|
+
|
|
17907
|
+
```typescript
|
|
17908
|
+
await client.shipping.taskArtifacts.updateCustodyPartiesV1("task_artifact_id");
|
|
17909
|
+
```
|
|
17910
|
+
|
|
17911
|
+
</dd>
|
|
17912
|
+
</dl>
|
|
17913
|
+
</dd>
|
|
17914
|
+
</dl>
|
|
17915
|
+
|
|
17916
|
+
#### ⚙️ Parameters
|
|
17917
|
+
|
|
17918
|
+
<dl>
|
|
17919
|
+
<dd>
|
|
17920
|
+
|
|
17921
|
+
<dl>
|
|
17922
|
+
<dd>
|
|
17923
|
+
|
|
17924
|
+
**taskArtifactId:** `string`
|
|
17925
|
+
|
|
17926
|
+
</dd>
|
|
17927
|
+
</dl>
|
|
17928
|
+
|
|
17929
|
+
<dl>
|
|
17930
|
+
<dd>
|
|
17931
|
+
|
|
17932
|
+
**request:** `Chrt.shipping.TaskArtifactCustodyPartiesUpdateReq`
|
|
17933
|
+
|
|
17934
|
+
</dd>
|
|
17935
|
+
</dl>
|
|
17936
|
+
|
|
17937
|
+
<dl>
|
|
17938
|
+
<dd>
|
|
17939
|
+
|
|
17940
|
+
**requestOptions:** `TaskArtifacts.RequestOptions`
|
|
17941
|
+
|
|
17942
|
+
</dd>
|
|
17943
|
+
</dl>
|
|
17944
|
+
</dd>
|
|
17945
|
+
</dl>
|
|
17946
|
+
|
|
17947
|
+
</dd>
|
|
17948
|
+
</dl>
|
|
17949
|
+
</details>
|
|
17950
|
+
|
|
17880
17951
|
<details><summary><code>client.shipping.taskArtifacts.<a href="/src/api/resources/shipping/resources/taskArtifacts/client/Client.ts">skipV1</a>(taskArtifactId) -> boolean</code></summary>
|
|
17881
17952
|
<dl>
|
|
17882
17953
|
<dd>
|
|
@@ -18361,6 +18432,77 @@ await client.shipping.tasks.updateCompletionTimestampV1("task_id", {
|
|
|
18361
18432
|
</dl>
|
|
18362
18433
|
</details>
|
|
18363
18434
|
|
|
18435
|
+
<details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">updateCustodyPartiesV1</a>(taskId, { ...params }) -> boolean</code></summary>
|
|
18436
|
+
<dl>
|
|
18437
|
+
<dd>
|
|
18438
|
+
|
|
18439
|
+
#### 📝 Description
|
|
18440
|
+
|
|
18441
|
+
<dl>
|
|
18442
|
+
<dd>
|
|
18443
|
+
|
|
18444
|
+
<dl>
|
|
18445
|
+
<dd>
|
|
18446
|
+
|
|
18447
|
+
Updates or clears the parties that provided or received cargo for a task. Contact references must belong to the caller's organization. | authz_personas=[draft_creator_org_operator, driver_for_executor, executor_org_operators, coordinator_org_operators] (depending on status) | (TaskCustodyPartiesUpdateReq) -> (bool)
|
|
18448
|
+
|
|
18449
|
+
</dd>
|
|
18450
|
+
</dl>
|
|
18451
|
+
</dd>
|
|
18452
|
+
</dl>
|
|
18453
|
+
|
|
18454
|
+
#### 🔌 Usage
|
|
18455
|
+
|
|
18456
|
+
<dl>
|
|
18457
|
+
<dd>
|
|
18458
|
+
|
|
18459
|
+
<dl>
|
|
18460
|
+
<dd>
|
|
18461
|
+
|
|
18462
|
+
```typescript
|
|
18463
|
+
await client.shipping.tasks.updateCustodyPartiesV1("task_id");
|
|
18464
|
+
```
|
|
18465
|
+
|
|
18466
|
+
</dd>
|
|
18467
|
+
</dl>
|
|
18468
|
+
</dd>
|
|
18469
|
+
</dl>
|
|
18470
|
+
|
|
18471
|
+
#### ⚙️ Parameters
|
|
18472
|
+
|
|
18473
|
+
<dl>
|
|
18474
|
+
<dd>
|
|
18475
|
+
|
|
18476
|
+
<dl>
|
|
18477
|
+
<dd>
|
|
18478
|
+
|
|
18479
|
+
**taskId:** `string`
|
|
18480
|
+
|
|
18481
|
+
</dd>
|
|
18482
|
+
</dl>
|
|
18483
|
+
|
|
18484
|
+
<dl>
|
|
18485
|
+
<dd>
|
|
18486
|
+
|
|
18487
|
+
**request:** `Chrt.shipping.TaskCustodyPartiesUpdateReq`
|
|
18488
|
+
|
|
18489
|
+
</dd>
|
|
18490
|
+
</dl>
|
|
18491
|
+
|
|
18492
|
+
<dl>
|
|
18493
|
+
<dd>
|
|
18494
|
+
|
|
18495
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
18496
|
+
|
|
18497
|
+
</dd>
|
|
18498
|
+
</dl>
|
|
18499
|
+
</dd>
|
|
18500
|
+
</dl>
|
|
18501
|
+
|
|
18502
|
+
</dd>
|
|
18503
|
+
</dl>
|
|
18504
|
+
</details>
|
|
18505
|
+
|
|
18364
18506
|
<details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">locationFromReferenceV1</a>(taskId, { ...params }) -> string</code></summary>
|
|
18365
18507
|
<dl>
|
|
18366
18508
|
<dd>
|
|
@@ -21757,7 +21899,7 @@ await client.shipping.orders.expanded.listForShipperOperatorsV1({
|
|
|
21757
21899
|
<dl>
|
|
21758
21900
|
<dd>
|
|
21759
21901
|
|
|
21760
|
-
Lists event log entries for an order with organization and user
|
|
21902
|
+
Lists event log entries for an order with organization and user display data hydrated, filtering, sorting, and pagination. | authz: min_org_role=administrator | authz_personas=[draft_creator_org_operator, coordinator_org_operators] | () -> (OrderEventListRes)
|
|
21761
21903
|
|
|
21762
21904
|
</dd>
|
|
21763
21905
|
</dl>
|
|
@@ -21838,7 +21980,7 @@ await client.shipping.orders.orderEvents.listV1("order_id", {
|
|
|
21838
21980
|
<dl>
|
|
21839
21981
|
<dd>
|
|
21840
21982
|
|
|
21841
|
-
Retrieves a single order event log entry by its ID with organization and user
|
|
21983
|
+
Retrieves a single order event log entry by its ID with organization and user name hydrated. | authz: min_org_role=administrator | authz_personas=[draft_creator_org_operator, coordinator_org_operators] | () -> (OrderEventExpanded1)
|
|
21842
21984
|
|
|
21843
21985
|
</dd>
|
|
21844
21986
|
</dl>
|
|
@@ -33556,6 +33698,71 @@ await client.users.privateData.upsertFirebaseCloudMessagingTokenV1({
|
|
|
33556
33698
|
</dl>
|
|
33557
33699
|
</details>
|
|
33558
33700
|
|
|
33701
|
+
<details><summary><code>client.users.privateData.<a href="/src/api/resources/users/resources/privateData/client/Client.ts">updateNameV1</a>({ ...params }) -> Chrt.UserPrivateData1</code></summary>
|
|
33702
|
+
<dl>
|
|
33703
|
+
<dd>
|
|
33704
|
+
|
|
33705
|
+
#### 📝 Description
|
|
33706
|
+
|
|
33707
|
+
<dl>
|
|
33708
|
+
<dd>
|
|
33709
|
+
|
|
33710
|
+
<dl>
|
|
33711
|
+
<dd>
|
|
33712
|
+
|
|
33713
|
+
Updates the caller's name in WorkOS and private user data. | (UserPrivateDataNameUpdateReq) -> (UserPrivateData1)
|
|
33714
|
+
|
|
33715
|
+
</dd>
|
|
33716
|
+
</dl>
|
|
33717
|
+
</dd>
|
|
33718
|
+
</dl>
|
|
33719
|
+
|
|
33720
|
+
#### 🔌 Usage
|
|
33721
|
+
|
|
33722
|
+
<dl>
|
|
33723
|
+
<dd>
|
|
33724
|
+
|
|
33725
|
+
<dl>
|
|
33726
|
+
<dd>
|
|
33727
|
+
|
|
33728
|
+
```typescript
|
|
33729
|
+
await client.users.privateData.updateNameV1({
|
|
33730
|
+
name: "name",
|
|
33731
|
+
});
|
|
33732
|
+
```
|
|
33733
|
+
|
|
33734
|
+
</dd>
|
|
33735
|
+
</dl>
|
|
33736
|
+
</dd>
|
|
33737
|
+
</dl>
|
|
33738
|
+
|
|
33739
|
+
#### ⚙️ Parameters
|
|
33740
|
+
|
|
33741
|
+
<dl>
|
|
33742
|
+
<dd>
|
|
33743
|
+
|
|
33744
|
+
<dl>
|
|
33745
|
+
<dd>
|
|
33746
|
+
|
|
33747
|
+
**request:** `Chrt.users.UserPrivateDataNameUpdateReq`
|
|
33748
|
+
|
|
33749
|
+
</dd>
|
|
33750
|
+
</dl>
|
|
33751
|
+
|
|
33752
|
+
<dl>
|
|
33753
|
+
<dd>
|
|
33754
|
+
|
|
33755
|
+
**requestOptions:** `PrivateData.RequestOptions`
|
|
33756
|
+
|
|
33757
|
+
</dd>
|
|
33758
|
+
</dl>
|
|
33759
|
+
</dd>
|
|
33760
|
+
</dl>
|
|
33761
|
+
|
|
33762
|
+
</dd>
|
|
33763
|
+
</dl>
|
|
33764
|
+
</details>
|
|
33765
|
+
|
|
33559
33766
|
<details><summary><code>client.users.privateData.<a href="/src/api/resources/users/resources/privateData/client/Client.ts">getV1</a>() -> Chrt.UserPrivateData1</code></summary>
|
|
33560
33767
|
<dl>
|
|
33561
33768
|
<dd>
|