@chrt-inc/typescript-sdk 1.344.1 → 2.0.0

package/reference.md

@@ -6712,8 +6712,6 @@ await client.billing.statements.listV1({
     filter_opened_at_timestamp_lte: "2024-01-15T09:30:00Z",
     filter_paid_at_timestamp_gte: "2024-01-15T09:30:00Z",
     filter_paid_at_timestamp_lte: "2024-01-15T09:30:00Z",
-    filter_voided_at_timestamp_gte: "2024-01-15T09:30:00Z",
-    filter_voided_at_timestamp_lte: "2024-01-15T09:30:00Z",
 });
 ```
 
@@ -7095,7 +7093,7 @@ await client.billing.statements.openInvoiceV1("statement_id");
 </dl>
 </details>
 
-<details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">syncInvoiceV1</a>(statementId) -> Chrt.SyncInvoiceRes</code></summary>
+<details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">syncInvoiceV1</a>(statementId) -> Chrt.Statement1</code></summary>
 <dl>
 <dd>
 
@@ -7107,7 +7105,7 @@ await client.billing.statements.openInvoiceV1("statement_id");
 <dl>
 <dd>
 
-Syncs invoice state from Stripe to the Statement and LineItemGroups. The webhook usually keeps invoices up to date, but users can manually trigger a sync. | authz: min_org_role=operator | () -> (SyncInvoiceRes)
+Syncs invoice state from Stripe Connect to the Statement and LineItemGroups. The webhook usually keeps invoices up to date, but users can manually trigger a sync. | authz: org_type=[courier, forwarder, shipper], min_org_role=operator, authz_personas=[statement_org_operators] | () -> (Statement1)
 
 </dd>
 </dl>
@@ -7158,7 +7156,7 @@ await client.billing.statements.syncInvoiceV1("statement_id");
 </dl>
 </details>
 
-<details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">cancelInvoiceV1</a>(statementId) -> Chrt.Statement1</code></summary>
+<details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">voidInvoiceV1</a>(statementId) -> Chrt.Statement1</code></summary>
 <dl>
 <dd>
 
@@ -7170,7 +7168,7 @@ await client.billing.statements.syncInvoiceV1("statement_id");
 <dl>
 <dd>
 
-Cancels/voids a Stripe Connect invoice. Statement must be OPEN or VOID. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators], statement_status=OPEN, VOID | () -> (Statement1)
+Voids a Stripe Connect invoice. Statement reverts to STAGED and LIGs revert to FINALIZED. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators], statement_status=OPEN | () -> (Statement1)
 
 </dd>
 </dl>
@@ -7186,7 +7184,7 @@ Cancels/voids a Stripe Connect invoice. Statement must be OPEN or VOID. | authz:
 <dd>
 
 ```typescript
-await client.billing.statements.cancelInvoiceV1("statement_id");
+await client.billing.statements.voidInvoiceV1("statement_id");
 ```
 
 </dd>
@@ -12818,7 +12816,7 @@ await client.tracking.sessions.deleteV1({
 
 ## Tracking SharingSettings
 
-<details><summary><code>client.tracking.sharingSettings.<a href="/src/api/resources/tracking/resources/sharingSettings/client/Client.ts">getSettingsV1</a>(orderIdOrShortId) -> Chrt.TrackingSharingSettingsRes[]</code></summary>
+<details><summary><code>client.tracking.sharingSettings.<a href="/src/api/resources/tracking/resources/sharingSettings/client/Client.ts">taskGroupByDriverSharingSettingsV1</a>({ ...params }) -> Chrt.TaskGroupByDriverSharingSettings1</code></summary>
 <dl>
 <dd>
 
@@ -12830,7 +12828,7 @@ await client.tracking.sessions.deleteV1({
 <dl>
 <dd>
 
-Get all tracking datasets and their sharing settings for a given order. | authz_personas=[shipper_org_operators, forwarder_org_operators, courier_org_operators] | () -> (list[TrackingSharingSettingsRes])
+Updates the sharing settings for a task group by driver tracking dataset. | authz_personas=[forwarder_org_operators, shipper_org_operators, courier_org_operators, courier_driver] | (TaskGroupByDriverSharingSettingsUpdateReq) -> (TaskGroupByDriverSharingSettings1)
 
 </dd>
 </dl>
@@ -12846,7 +12844,11 @@ Get all tracking datasets and their sharing settings for a given order. | authz_
 <dd>
 
 ```typescript
-await client.tracking.sharingSettings.getSettingsV1("order_id_or_short_id");
+await client.tracking.sharingSettings.taskGroupByDriverSharingSettingsV1({
+    task_group_id: "task_group_id",
+    driver_id: "driver_id",
+    public: true,
+});
 ```
 
 </dd>
@@ -12862,7 +12864,7 @@ await client.tracking.sharingSettings.getSettingsV1("order_id_or_short_id");
 <dl>
 <dd>
 
-**orderIdOrShortId:** `string`
+**request:** `Chrt.tracking.TaskGroupByDriverSharingSettingsUpdateReq`
 
 </dd>
 </dl>
@@ -12881,7 +12883,7 @@ await client.tracking.sharingSettings.getSettingsV1("order_id_or_short_id");
 </dl>
 </details>
 
-<details><summary><code>client.tracking.sharingSettings.<a href="/src/api/resources/tracking/resources/sharingSettings/client/Client.ts">taskGroupByDriverSharingSettingsV1</a>({ ...params }) -> Chrt.TaskGroupByDriverSharingSettings1</code></summary>
+<details><summary><code>client.tracking.sharingSettings.<a href="/src/api/resources/tracking/resources/sharingSettings/client/Client.ts">cargoByDriverSettingsV1</a>({ ...params }) -> Chrt.CargoByDriverSharingSettings1</code></summary>
 <dl>
 <dd>
 
@@ -12893,7 +12895,7 @@ await client.tracking.sharingSettings.getSettingsV1("order_id_or_short_id");
 <dl>
 <dd>
 
-Updates the sharing settings for a task group by driver tracking dataset. | authz_personas=[forwarder_org_operators, shipper_org_operators, courier_org_operators, courier_driver] | (TaskGroupByDriverSharingSettingsUpdateReq) -> (TaskGroupByDriverSharingSettings1)
+Updates the sharing settings for a cargo by driver tracking dataset. | authz_personas=[forwarder_org_operators, shipper_org_operators, courier_org_operators, courier_driver] | (CargoByDriverSharingSettingsUpdateReq) -> (CargoByDriverSharingSettings1)
 
 </dd>
 </dl>
@@ -12909,8 +12911,9 @@ Updates the sharing settings for a task group by driver tracking dataset. | auth
 <dd>
 
 ```typescript
-await client.tracking.sharingSettings.taskGroupByDriverSharingSettingsV1({
+await client.tracking.sharingSettings.cargoByDriverSettingsV1({
     task_group_id: "task_group_id",
+    cargo_id: "cargo_id",
     driver_id: "driver_id",
     public: true,
 });
@@ -12929,7 +12932,7 @@ await client.tracking.sharingSettings.taskGroupByDriverSharingSettingsV1({
 <dl>
 <dd>
 
-**request:** `Chrt.tracking.TaskGroupByDriverSharingSettingsUpdateReq`
+**request:** `Chrt.tracking.CargoByDriverSharingSettingsUpdateReq`
 
 </dd>
 </dl>
@@ -12948,7 +12951,7 @@ await client.tracking.sharingSettings.taskGroupByDriverSharingSettingsV1({
 </dl>
 </details>
 
-<details><summary><code>client.tracking.sharingSettings.<a href="/src/api/resources/tracking/resources/sharingSettings/client/Client.ts">cargoByDriverSettingsV1</a>({ ...params }) -> Chrt.CargoByDriverSharingSettings1</code></summary>
+<details><summary><code>client.tracking.sharingSettings.<a href="/src/api/resources/tracking/resources/sharingSettings/client/Client.ts">cargoByDeviceSettingsV1</a>({ ...params }) -> Chrt.CargoByDeviceSharingSettings1</code></summary>
 <dl>
 <dd>
 
@@ -12960,7 +12963,7 @@ await client.tracking.sharingSettings.taskGroupByDriverSharingSettingsV1({
 <dl>
 <dd>
 
-Updates the sharing settings for a cargo by driver tracking dataset. | authz_personas=[forwarder_org_operators, shipper_org_operators, courier_org_operators, courier_driver] | (CargoByDriverSharingSettingsUpdateReq) -> (CargoByDriverSharingSettings1)
+Updates the sharing settings for a cargo by device tracking dataset. | authz_personas=[forwarder_org_operators, shipper_org_operators, order_creator_org_operators] | (CargoByDeviceSharingSettingsUpdateReq) -> (CargoByDeviceSharingSettings1)
 
 </dd>
 </dl>
@@ -12976,10 +12979,10 @@ Updates the sharing settings for a cargo by driver tracking dataset. | authz_per
 <dd>
 
 ```typescript
-await client.tracking.sharingSettings.cargoByDriverSettingsV1({
+await client.tracking.sharingSettings.cargoByDeviceSettingsV1({
     task_group_id: "task_group_id",
     cargo_id: "cargo_id",
-    driver_id: "driver_id",
+    device_id: "device_id",
     public: true,
 });
 ```
@@ -12997,7 +13000,7 @@ await client.tracking.sharingSettings.cargoByDriverSettingsV1({
 <dl>
 <dd>
 
-**request:** `Chrt.tracking.CargoByDriverSharingSettingsUpdateReq`
+**request:** `Chrt.tracking.CargoByDeviceSharingSettingsUpdateReq`
 
 </dd>
 </dl>
@@ -13016,7 +13019,7 @@ await client.tracking.sharingSettings.cargoByDriverSettingsV1({
 </dl>
 </details>
 
-<details><summary><code>client.tracking.sharingSettings.<a href="/src/api/resources/tracking/resources/sharingSettings/client/Client.ts">cargoByDeviceSettingsV1</a>({ ...params }) -> Chrt.CargoByDeviceSharingSettings1</code></summary>
+<details><summary><code>client.tracking.sharingSettings.<a href="/src/api/resources/tracking/resources/sharingSettings/client/Client.ts">getSettingsV1</a>(orderIdOrShortId) -> Chrt.TrackingSharingSettingsRes[]</code></summary>
 <dl>
 <dd>
 
@@ -13028,7 +13031,7 @@ await client.tracking.sharingSettings.cargoByDriverSettingsV1({
 <dl>
 <dd>
 
-Updates the sharing settings for a cargo by device tracking dataset. | authz_personas=[forwarder_org_operators, shipper_org_operators, order_creator_org_operators] | (CargoByDeviceSharingSettingsUpdateReq) -> (CargoByDeviceSharingSettings1)
+Get all tracking datasets and their sharing settings for a given order. If authenticated, returns datasets the user has direct access to plus public datasets. If unauthenticated, returns only datasets with public=True. | () -> (list[TrackingSharingSettingsRes])
 
 </dd>
 </dl>
@@ -13044,12 +13047,7 @@ Updates the sharing settings for a cargo by device tracking dataset. | authz_per
 <dd>
 
 ```typescript
-await client.tracking.sharingSettings.cargoByDeviceSettingsV1({
-    task_group_id: "task_group_id",
-    cargo_id: "cargo_id",
-    device_id: "device_id",
-    public: true,
-});
+await client.tracking.sharingSettings.getSettingsV1("order_id_or_short_id");
 ```
 
 </dd>
@@ -13065,7 +13063,7 @@ await client.tracking.sharingSettings.cargoByDeviceSettingsV1({
 <dl>
 <dd>
 
-**request:** `Chrt.tracking.CargoByDeviceSharingSettingsUpdateReq`
+**orderIdOrShortId:** `string`
 
 </dd>
 </dl>

package/dist/cjs/api/types/SyncInvoiceRes.d.ts

@@ -1,10 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Chrt from "../index.js";
-export interface SyncInvoiceRes {
-    statement: Chrt.Statement1;
-    /** True if any changes were synced from Stripe */
-    synced: boolean;
-    stripe_invoice_status?: Chrt.StripeConnectInvoiceStatusEnum | null;
-}

package/dist/cjs/api/types/SyncInvoiceRes.js

@@ -1,5 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/esm/api/types/SyncInvoiceRes.d.mts

@@ -1,10 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Chrt from "../index.mjs";
-export interface SyncInvoiceRes {
-    statement: Chrt.Statement1;
-    /** True if any changes were synced from Stripe */
-    synced: boolean;
-    stripe_invoice_status?: Chrt.StripeConnectInvoiceStatusEnum | null;
-}

package/dist/esm/api/types/SyncInvoiceRes.mjs

@@ -1,4 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export {};