@chrt-inc/typescript-sdk 1.961.0 → 1.963.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/billingNew/resources/invoices/client/Client.d.ts +3 -0
- package/dist/cjs/api/resources/billingNew/resources/invoices/client/Client.js +5 -0
- package/dist/cjs/api/resources/billingNew/resources/invoices/index.d.ts +1 -0
- package/dist/cjs/api/resources/billingNew/resources/invoices/index.js +1 -0
- package/dist/cjs/api/resources/billingNew/resources/invoices/resources/export/client/Client.d.ts +51 -0
- package/dist/cjs/api/resources/billingNew/resources/invoices/resources/export/client/Client.js +139 -0
- package/dist/cjs/api/resources/billingNew/resources/invoices/resources/export/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/billingNew/resources/invoices/resources/export/client/index.js +17 -0
- package/dist/cjs/api/resources/billingNew/resources/invoices/resources/export/client/requests/ExportListV1Request.d.ts +14 -0
- package/dist/cjs/api/resources/billingNew/resources/invoices/resources/export/client/requests/ExportListV1Request.js +5 -0
- package/dist/cjs/api/resources/billingNew/resources/invoices/resources/export/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/billingNew/resources/invoices/resources/export/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/billingNew/resources/invoices/resources/export/index.d.ts +1 -0
- package/dist/cjs/api/resources/billingNew/resources/invoices/resources/export/index.js +17 -0
- package/dist/cjs/api/resources/billingNew/resources/invoices/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/billingNew/resources/invoices/resources/index.js +41 -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/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/trackingIntegrations/resources/reelables/resources/assets/client/Client.d.ts +26 -0
- package/dist/cjs/api/resources/trackingIntegrations/resources/reelables/resources/assets/client/Client.js +118 -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/InvoiceExportListItem.d.ts +46 -0
- package/dist/cjs/api/types/InvoiceExportListItem.js +5 -0
- package/dist/cjs/api/types/InvoiceExportListRes.d.ts +8 -0
- package/dist/cjs/api/types/InvoiceExportListRes.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/ReelablesAsset1.d.ts +3 -0
- package/dist/cjs/api/types/ReelablesAssetPausedTimeWindow1.d.ts +7 -0
- package/dist/cjs/api/types/ReelablesAssetPausedTimeWindow1.js +5 -0
- package/dist/cjs/api/types/ReelablesDataPointMetadata1.d.ts +1 -0
- 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 +5 -0
- package/dist/cjs/api/types/index.js +5 -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/billingNew/resources/invoices/client/Client.d.mts +3 -0
- package/dist/esm/api/resources/billingNew/resources/invoices/client/Client.mjs +5 -0
- package/dist/esm/api/resources/billingNew/resources/invoices/index.d.mts +1 -0
- package/dist/esm/api/resources/billingNew/resources/invoices/index.mjs +1 -0
- package/dist/esm/api/resources/billingNew/resources/invoices/resources/export/client/Client.d.mts +51 -0
- package/dist/esm/api/resources/billingNew/resources/invoices/resources/export/client/Client.mjs +102 -0
- package/dist/esm/api/resources/billingNew/resources/invoices/resources/export/client/index.d.mts +2 -0
- package/dist/esm/api/resources/billingNew/resources/invoices/resources/export/client/index.mjs +1 -0
- package/dist/esm/api/resources/billingNew/resources/invoices/resources/export/client/requests/ExportListV1Request.d.mts +14 -0
- package/dist/esm/api/resources/billingNew/resources/invoices/resources/export/client/requests/ExportListV1Request.mjs +4 -0
- package/dist/esm/api/resources/billingNew/resources/invoices/resources/export/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/billingNew/resources/invoices/resources/export/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/billingNew/resources/invoices/resources/export/index.d.mts +1 -0
- package/dist/esm/api/resources/billingNew/resources/invoices/resources/export/index.mjs +1 -0
- package/dist/esm/api/resources/billingNew/resources/invoices/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/billingNew/resources/invoices/resources/index.mjs +2 -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/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/trackingIntegrations/resources/reelables/resources/assets/client/Client.d.mts +26 -0
- package/dist/esm/api/resources/trackingIntegrations/resources/reelables/resources/assets/client/Client.mjs +118 -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/InvoiceExportListItem.d.mts +46 -0
- package/dist/esm/api/types/InvoiceExportListItem.mjs +4 -0
- package/dist/esm/api/types/InvoiceExportListRes.d.mts +8 -0
- package/dist/esm/api/types/InvoiceExportListRes.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/ReelablesAsset1.d.mts +3 -0
- package/dist/esm/api/types/ReelablesAssetPausedTimeWindow1.d.mts +7 -0
- package/dist/esm/api/types/ReelablesAssetPausedTimeWindow1.mjs +4 -0
- package/dist/esm/api/types/ReelablesDataPointMetadata1.d.mts +1 -0
- 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 +5 -0
- package/dist/esm/api/types/index.mjs +5 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +411 -2
package/reference.md
CHANGED
|
@@ -3873,6 +3873,82 @@ await client.billingNew.orders.listExpandedForCoordinatorOperatorsV1({
|
|
|
3873
3873
|
</dl>
|
|
3874
3874
|
</details>
|
|
3875
3875
|
|
|
3876
|
+
## BillingNew Invoices Export
|
|
3877
|
+
|
|
3878
|
+
<details><summary><code>client.billingNew.invoices.export.<a href="/src/api/resources/billingNew/resources/invoices/resources/export/client/Client.ts">listV1</a>(invoiceId, { ...params }) -> Chrt.InvoiceExportListRes</code></summary>
|
|
3879
|
+
<dl>
|
|
3880
|
+
<dd>
|
|
3881
|
+
|
|
3882
|
+
#### 📝 Description
|
|
3883
|
+
|
|
3884
|
+
<dl>
|
|
3885
|
+
<dd>
|
|
3886
|
+
|
|
3887
|
+
<dl>
|
|
3888
|
+
<dd>
|
|
3889
|
+
|
|
3890
|
+
Lists up to 1,000 shipment-level export rows for one approved accounts-receivable invoice owned by the caller's organization. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (InvoiceExportListRes)
|
|
3891
|
+
|
|
3892
|
+
</dd>
|
|
3893
|
+
</dl>
|
|
3894
|
+
</dd>
|
|
3895
|
+
</dl>
|
|
3896
|
+
|
|
3897
|
+
#### 🔌 Usage
|
|
3898
|
+
|
|
3899
|
+
<dl>
|
|
3900
|
+
<dd>
|
|
3901
|
+
|
|
3902
|
+
<dl>
|
|
3903
|
+
<dd>
|
|
3904
|
+
|
|
3905
|
+
```typescript
|
|
3906
|
+
await client.billingNew.invoices.export.listV1("invoice_id", {
|
|
3907
|
+
page: 1,
|
|
3908
|
+
page_size: 1,
|
|
3909
|
+
});
|
|
3910
|
+
```
|
|
3911
|
+
|
|
3912
|
+
</dd>
|
|
3913
|
+
</dl>
|
|
3914
|
+
</dd>
|
|
3915
|
+
</dl>
|
|
3916
|
+
|
|
3917
|
+
#### ⚙️ Parameters
|
|
3918
|
+
|
|
3919
|
+
<dl>
|
|
3920
|
+
<dd>
|
|
3921
|
+
|
|
3922
|
+
<dl>
|
|
3923
|
+
<dd>
|
|
3924
|
+
|
|
3925
|
+
**invoiceId:** `string`
|
|
3926
|
+
|
|
3927
|
+
</dd>
|
|
3928
|
+
</dl>
|
|
3929
|
+
|
|
3930
|
+
<dl>
|
|
3931
|
+
<dd>
|
|
3932
|
+
|
|
3933
|
+
**request:** `Chrt.billingNew.invoices.ExportListV1Request`
|
|
3934
|
+
|
|
3935
|
+
</dd>
|
|
3936
|
+
</dl>
|
|
3937
|
+
|
|
3938
|
+
<dl>
|
|
3939
|
+
<dd>
|
|
3940
|
+
|
|
3941
|
+
**requestOptions:** `Export.RequestOptions`
|
|
3942
|
+
|
|
3943
|
+
</dd>
|
|
3944
|
+
</dl>
|
|
3945
|
+
</dd>
|
|
3946
|
+
</dl>
|
|
3947
|
+
|
|
3948
|
+
</dd>
|
|
3949
|
+
</dl>
|
|
3950
|
+
</details>
|
|
3951
|
+
|
|
3876
3952
|
## BillingNew Orders RateSheetLineItems
|
|
3877
3953
|
|
|
3878
3954
|
<details><summary><code>client.billingNew.orders.rateSheetLineItems.<a href="/src/api/resources/billingNew/resources/orders/resources/rateSheetLineItems/client/Client.ts">generateManyV1</a>({ ...params }) -> Chrt.OrderRateSheetLineItemsGenerateManyRes</code></summary>
|
|
@@ -17877,6 +17953,77 @@ await client.shipping.taskArtifacts.completeV1("task_artifact_id");
|
|
|
17877
17953
|
</dl>
|
|
17878
17954
|
</details>
|
|
17879
17955
|
|
|
17956
|
+
<details><summary><code>client.shipping.taskArtifacts.<a href="/src/api/resources/shipping/resources/taskArtifacts/client/Client.ts">updateCustodyPartiesV1</a>(taskArtifactId, { ...params }) -> boolean</code></summary>
|
|
17957
|
+
<dl>
|
|
17958
|
+
<dd>
|
|
17959
|
+
|
|
17960
|
+
#### 📝 Description
|
|
17961
|
+
|
|
17962
|
+
<dl>
|
|
17963
|
+
<dd>
|
|
17964
|
+
|
|
17965
|
+
<dl>
|
|
17966
|
+
<dd>
|
|
17967
|
+
|
|
17968
|
+
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)
|
|
17969
|
+
|
|
17970
|
+
</dd>
|
|
17971
|
+
</dl>
|
|
17972
|
+
</dd>
|
|
17973
|
+
</dl>
|
|
17974
|
+
|
|
17975
|
+
#### 🔌 Usage
|
|
17976
|
+
|
|
17977
|
+
<dl>
|
|
17978
|
+
<dd>
|
|
17979
|
+
|
|
17980
|
+
<dl>
|
|
17981
|
+
<dd>
|
|
17982
|
+
|
|
17983
|
+
```typescript
|
|
17984
|
+
await client.shipping.taskArtifacts.updateCustodyPartiesV1("task_artifact_id");
|
|
17985
|
+
```
|
|
17986
|
+
|
|
17987
|
+
</dd>
|
|
17988
|
+
</dl>
|
|
17989
|
+
</dd>
|
|
17990
|
+
</dl>
|
|
17991
|
+
|
|
17992
|
+
#### ⚙️ Parameters
|
|
17993
|
+
|
|
17994
|
+
<dl>
|
|
17995
|
+
<dd>
|
|
17996
|
+
|
|
17997
|
+
<dl>
|
|
17998
|
+
<dd>
|
|
17999
|
+
|
|
18000
|
+
**taskArtifactId:** `string`
|
|
18001
|
+
|
|
18002
|
+
</dd>
|
|
18003
|
+
</dl>
|
|
18004
|
+
|
|
18005
|
+
<dl>
|
|
18006
|
+
<dd>
|
|
18007
|
+
|
|
18008
|
+
**request:** `Chrt.shipping.TaskArtifactCustodyPartiesUpdateReq`
|
|
18009
|
+
|
|
18010
|
+
</dd>
|
|
18011
|
+
</dl>
|
|
18012
|
+
|
|
18013
|
+
<dl>
|
|
18014
|
+
<dd>
|
|
18015
|
+
|
|
18016
|
+
**requestOptions:** `TaskArtifacts.RequestOptions`
|
|
18017
|
+
|
|
18018
|
+
</dd>
|
|
18019
|
+
</dl>
|
|
18020
|
+
</dd>
|
|
18021
|
+
</dl>
|
|
18022
|
+
|
|
18023
|
+
</dd>
|
|
18024
|
+
</dl>
|
|
18025
|
+
</details>
|
|
18026
|
+
|
|
17880
18027
|
<details><summary><code>client.shipping.taskArtifacts.<a href="/src/api/resources/shipping/resources/taskArtifacts/client/Client.ts">skipV1</a>(taskArtifactId) -> boolean</code></summary>
|
|
17881
18028
|
<dl>
|
|
17882
18029
|
<dd>
|
|
@@ -18361,6 +18508,77 @@ await client.shipping.tasks.updateCompletionTimestampV1("task_id", {
|
|
|
18361
18508
|
</dl>
|
|
18362
18509
|
</details>
|
|
18363
18510
|
|
|
18511
|
+
<details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">updateCustodyPartiesV1</a>(taskId, { ...params }) -> boolean</code></summary>
|
|
18512
|
+
<dl>
|
|
18513
|
+
<dd>
|
|
18514
|
+
|
|
18515
|
+
#### 📝 Description
|
|
18516
|
+
|
|
18517
|
+
<dl>
|
|
18518
|
+
<dd>
|
|
18519
|
+
|
|
18520
|
+
<dl>
|
|
18521
|
+
<dd>
|
|
18522
|
+
|
|
18523
|
+
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)
|
|
18524
|
+
|
|
18525
|
+
</dd>
|
|
18526
|
+
</dl>
|
|
18527
|
+
</dd>
|
|
18528
|
+
</dl>
|
|
18529
|
+
|
|
18530
|
+
#### 🔌 Usage
|
|
18531
|
+
|
|
18532
|
+
<dl>
|
|
18533
|
+
<dd>
|
|
18534
|
+
|
|
18535
|
+
<dl>
|
|
18536
|
+
<dd>
|
|
18537
|
+
|
|
18538
|
+
```typescript
|
|
18539
|
+
await client.shipping.tasks.updateCustodyPartiesV1("task_id");
|
|
18540
|
+
```
|
|
18541
|
+
|
|
18542
|
+
</dd>
|
|
18543
|
+
</dl>
|
|
18544
|
+
</dd>
|
|
18545
|
+
</dl>
|
|
18546
|
+
|
|
18547
|
+
#### ⚙️ Parameters
|
|
18548
|
+
|
|
18549
|
+
<dl>
|
|
18550
|
+
<dd>
|
|
18551
|
+
|
|
18552
|
+
<dl>
|
|
18553
|
+
<dd>
|
|
18554
|
+
|
|
18555
|
+
**taskId:** `string`
|
|
18556
|
+
|
|
18557
|
+
</dd>
|
|
18558
|
+
</dl>
|
|
18559
|
+
|
|
18560
|
+
<dl>
|
|
18561
|
+
<dd>
|
|
18562
|
+
|
|
18563
|
+
**request:** `Chrt.shipping.TaskCustodyPartiesUpdateReq`
|
|
18564
|
+
|
|
18565
|
+
</dd>
|
|
18566
|
+
</dl>
|
|
18567
|
+
|
|
18568
|
+
<dl>
|
|
18569
|
+
<dd>
|
|
18570
|
+
|
|
18571
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
18572
|
+
|
|
18573
|
+
</dd>
|
|
18574
|
+
</dl>
|
|
18575
|
+
</dd>
|
|
18576
|
+
</dl>
|
|
18577
|
+
|
|
18578
|
+
</dd>
|
|
18579
|
+
</dl>
|
|
18580
|
+
</details>
|
|
18581
|
+
|
|
18364
18582
|
<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
18583
|
<dl>
|
|
18366
18584
|
<dd>
|
|
@@ -21757,7 +21975,7 @@ await client.shipping.orders.expanded.listForShipperOperatorsV1({
|
|
|
21757
21975
|
<dl>
|
|
21758
21976
|
<dd>
|
|
21759
21977
|
|
|
21760
|
-
Lists event log entries for an order with organization and user
|
|
21978
|
+
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
21979
|
|
|
21762
21980
|
</dd>
|
|
21763
21981
|
</dl>
|
|
@@ -21838,7 +22056,7 @@ await client.shipping.orders.orderEvents.listV1("order_id", {
|
|
|
21838
22056
|
<dl>
|
|
21839
22057
|
<dd>
|
|
21840
22058
|
|
|
21841
|
-
Retrieves a single order event log entry by its ID with organization and user
|
|
22059
|
+
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
22060
|
|
|
21843
22061
|
</dd>
|
|
21844
22062
|
</dl>
|
|
@@ -32791,6 +33009,132 @@ await client.trackingIntegrations.reelables.assets.listV1({
|
|
|
32791
33009
|
</dl>
|
|
32792
33010
|
</details>
|
|
32793
33011
|
|
|
33012
|
+
<details><summary><code>client.trackingIntegrations.reelables.assets.<a href="/src/api/resources/trackingIntegrations/resources/reelables/resources/assets/client/Client.ts">pauseV1</a>(assetId) -> boolean</code></summary>
|
|
33013
|
+
<dl>
|
|
33014
|
+
<dd>
|
|
33015
|
+
|
|
33016
|
+
#### 📝 Description
|
|
33017
|
+
|
|
33018
|
+
<dl>
|
|
33019
|
+
<dd>
|
|
33020
|
+
|
|
33021
|
+
<dl>
|
|
33022
|
+
<dd>
|
|
33023
|
+
|
|
33024
|
+
Pauses a Reelables asset and opens a new pause time window. | authz: min_org_role=operator | () -> (bool)
|
|
33025
|
+
|
|
33026
|
+
</dd>
|
|
33027
|
+
</dl>
|
|
33028
|
+
</dd>
|
|
33029
|
+
</dl>
|
|
33030
|
+
|
|
33031
|
+
#### 🔌 Usage
|
|
33032
|
+
|
|
33033
|
+
<dl>
|
|
33034
|
+
<dd>
|
|
33035
|
+
|
|
33036
|
+
<dl>
|
|
33037
|
+
<dd>
|
|
33038
|
+
|
|
33039
|
+
```typescript
|
|
33040
|
+
await client.trackingIntegrations.reelables.assets.pauseV1("asset_id");
|
|
33041
|
+
```
|
|
33042
|
+
|
|
33043
|
+
</dd>
|
|
33044
|
+
</dl>
|
|
33045
|
+
</dd>
|
|
33046
|
+
</dl>
|
|
33047
|
+
|
|
33048
|
+
#### ⚙️ Parameters
|
|
33049
|
+
|
|
33050
|
+
<dl>
|
|
33051
|
+
<dd>
|
|
33052
|
+
|
|
33053
|
+
<dl>
|
|
33054
|
+
<dd>
|
|
33055
|
+
|
|
33056
|
+
**assetId:** `string`
|
|
33057
|
+
|
|
33058
|
+
</dd>
|
|
33059
|
+
</dl>
|
|
33060
|
+
|
|
33061
|
+
<dl>
|
|
33062
|
+
<dd>
|
|
33063
|
+
|
|
33064
|
+
**requestOptions:** `Assets.RequestOptions`
|
|
33065
|
+
|
|
33066
|
+
</dd>
|
|
33067
|
+
</dl>
|
|
33068
|
+
</dd>
|
|
33069
|
+
</dl>
|
|
33070
|
+
|
|
33071
|
+
</dd>
|
|
33072
|
+
</dl>
|
|
33073
|
+
</details>
|
|
33074
|
+
|
|
33075
|
+
<details><summary><code>client.trackingIntegrations.reelables.assets.<a href="/src/api/resources/trackingIntegrations/resources/reelables/resources/assets/client/Client.ts">unpauseV1</a>(assetId) -> boolean</code></summary>
|
|
33076
|
+
<dl>
|
|
33077
|
+
<dd>
|
|
33078
|
+
|
|
33079
|
+
#### 📝 Description
|
|
33080
|
+
|
|
33081
|
+
<dl>
|
|
33082
|
+
<dd>
|
|
33083
|
+
|
|
33084
|
+
<dl>
|
|
33085
|
+
<dd>
|
|
33086
|
+
|
|
33087
|
+
Unpauses a Reelables asset and closes the open pause time window. | authz: min_org_role=operator | () -> (bool)
|
|
33088
|
+
|
|
33089
|
+
</dd>
|
|
33090
|
+
</dl>
|
|
33091
|
+
</dd>
|
|
33092
|
+
</dl>
|
|
33093
|
+
|
|
33094
|
+
#### 🔌 Usage
|
|
33095
|
+
|
|
33096
|
+
<dl>
|
|
33097
|
+
<dd>
|
|
33098
|
+
|
|
33099
|
+
<dl>
|
|
33100
|
+
<dd>
|
|
33101
|
+
|
|
33102
|
+
```typescript
|
|
33103
|
+
await client.trackingIntegrations.reelables.assets.unpauseV1("asset_id");
|
|
33104
|
+
```
|
|
33105
|
+
|
|
33106
|
+
</dd>
|
|
33107
|
+
</dl>
|
|
33108
|
+
</dd>
|
|
33109
|
+
</dl>
|
|
33110
|
+
|
|
33111
|
+
#### ⚙️ Parameters
|
|
33112
|
+
|
|
33113
|
+
<dl>
|
|
33114
|
+
<dd>
|
|
33115
|
+
|
|
33116
|
+
<dl>
|
|
33117
|
+
<dd>
|
|
33118
|
+
|
|
33119
|
+
**assetId:** `string`
|
|
33120
|
+
|
|
33121
|
+
</dd>
|
|
33122
|
+
</dl>
|
|
33123
|
+
|
|
33124
|
+
<dl>
|
|
33125
|
+
<dd>
|
|
33126
|
+
|
|
33127
|
+
**requestOptions:** `Assets.RequestOptions`
|
|
33128
|
+
|
|
33129
|
+
</dd>
|
|
33130
|
+
</dl>
|
|
33131
|
+
</dd>
|
|
33132
|
+
</dl>
|
|
33133
|
+
|
|
33134
|
+
</dd>
|
|
33135
|
+
</dl>
|
|
33136
|
+
</details>
|
|
33137
|
+
|
|
32794
33138
|
<details><summary><code>client.trackingIntegrations.reelables.assets.<a href="/src/api/resources/trackingIntegrations/resources/reelables/resources/assets/client/Client.ts">updateV1</a>(assetId, { ...params }) -> Chrt.ReelablesAsset1</code></summary>
|
|
32795
33139
|
<dl>
|
|
32796
33140
|
<dd>
|
|
@@ -33556,6 +33900,71 @@ await client.users.privateData.upsertFirebaseCloudMessagingTokenV1({
|
|
|
33556
33900
|
</dl>
|
|
33557
33901
|
</details>
|
|
33558
33902
|
|
|
33903
|
+
<details><summary><code>client.users.privateData.<a href="/src/api/resources/users/resources/privateData/client/Client.ts">updateNameV1</a>({ ...params }) -> Chrt.UserPrivateData1</code></summary>
|
|
33904
|
+
<dl>
|
|
33905
|
+
<dd>
|
|
33906
|
+
|
|
33907
|
+
#### 📝 Description
|
|
33908
|
+
|
|
33909
|
+
<dl>
|
|
33910
|
+
<dd>
|
|
33911
|
+
|
|
33912
|
+
<dl>
|
|
33913
|
+
<dd>
|
|
33914
|
+
|
|
33915
|
+
Updates the caller's name in WorkOS and private user data. | (UserPrivateDataNameUpdateReq) -> (UserPrivateData1)
|
|
33916
|
+
|
|
33917
|
+
</dd>
|
|
33918
|
+
</dl>
|
|
33919
|
+
</dd>
|
|
33920
|
+
</dl>
|
|
33921
|
+
|
|
33922
|
+
#### 🔌 Usage
|
|
33923
|
+
|
|
33924
|
+
<dl>
|
|
33925
|
+
<dd>
|
|
33926
|
+
|
|
33927
|
+
<dl>
|
|
33928
|
+
<dd>
|
|
33929
|
+
|
|
33930
|
+
```typescript
|
|
33931
|
+
await client.users.privateData.updateNameV1({
|
|
33932
|
+
name: "name",
|
|
33933
|
+
});
|
|
33934
|
+
```
|
|
33935
|
+
|
|
33936
|
+
</dd>
|
|
33937
|
+
</dl>
|
|
33938
|
+
</dd>
|
|
33939
|
+
</dl>
|
|
33940
|
+
|
|
33941
|
+
#### ⚙️ Parameters
|
|
33942
|
+
|
|
33943
|
+
<dl>
|
|
33944
|
+
<dd>
|
|
33945
|
+
|
|
33946
|
+
<dl>
|
|
33947
|
+
<dd>
|
|
33948
|
+
|
|
33949
|
+
**request:** `Chrt.users.UserPrivateDataNameUpdateReq`
|
|
33950
|
+
|
|
33951
|
+
</dd>
|
|
33952
|
+
</dl>
|
|
33953
|
+
|
|
33954
|
+
<dl>
|
|
33955
|
+
<dd>
|
|
33956
|
+
|
|
33957
|
+
**requestOptions:** `PrivateData.RequestOptions`
|
|
33958
|
+
|
|
33959
|
+
</dd>
|
|
33960
|
+
</dl>
|
|
33961
|
+
</dd>
|
|
33962
|
+
</dl>
|
|
33963
|
+
|
|
33964
|
+
</dd>
|
|
33965
|
+
</dl>
|
|
33966
|
+
</details>
|
|
33967
|
+
|
|
33559
33968
|
<details><summary><code>client.users.privateData.<a href="/src/api/resources/users/resources/privateData/client/Client.ts">getV1</a>() -> Chrt.UserPrivateData1</code></summary>
|
|
33560
33969
|
<dl>
|
|
33561
33970
|
<dd>
|