@chrt-inc/typescript-sdk 0.0.189 → 0.0.195

package/reference.md

@@ -1036,9 +1036,9 @@ await client.milestones.addToTask({
 </dl>
 </details>
 
-## OffChrtShipperOrgConnectionInfo
+## OffChrtShipperOrgInfo
 
-<details><summary><code>client.offChrtShipperOrgConnectionInfo.<a href="/src/api/resources/offChrtShipperOrgConnectionInfo/client/Client.ts">create</a>({ ...params }) -> string</code></summary>
+<details><summary><code>client.offChrtShipperOrgInfo.<a href="/src/api/resources/offChrtShipperOrgInfo/client/Client.ts">create</a>({ ...params }) -> string</code></summary>
 <dl>
 <dd>
 
@@ -1066,7 +1066,7 @@ Creates connection information for working with off-platform shipper organizatio
 <dd>
 
 ```typescript
-await client.offChrtShipperOrgConnectionInfo.create({
+await client.offChrtShipperOrgInfo.create({
     schema_version: 1,
     email_address_primary: "email_address_primary",
 });
@@ -1085,7 +1085,7 @@ await client.offChrtShipperOrgConnectionInfo.create({
 <dl>
 <dd>
 
-**request:** `Chrt.OffChrtShipperOrgConnectionInfoClientCreate1`
+**request:** `Chrt.OffChrtShipperOrgInfoClientCreate1`
 
 </dd>
 </dl>
@@ -1093,7 +1093,7 @@ await client.offChrtShipperOrgConnectionInfo.create({
 <dl>
 <dd>
 
-**requestOptions:** `OffChrtShipperOrgConnectionInfo.RequestOptions`
+**requestOptions:** `OffChrtShipperOrgInfo.RequestOptions`
 
 </dd>
 </dl>
@@ -1104,7 +1104,7 @@ await client.offChrtShipperOrgConnectionInfo.create({
 </dl>
 </details>
 
-<details><summary><code>client.offChrtShipperOrgConnectionInfo.<a href="/src/api/resources/offChrtShipperOrgConnectionInfo/client/Client.ts">list</a>() -> Chrt.OffChrtShipperOrgConnectionInfo1[]</code></summary>
+<details><summary><code>client.offChrtShipperOrgInfo.<a href="/src/api/resources/offChrtShipperOrgInfo/client/Client.ts">list</a>() -> Chrt.OffChrtShipperOrgInfo1[]</code></summary>
 <dl>
 <dd>
 
@@ -1132,7 +1132,7 @@ Lists all off-platform shipper connections created by the authenticated organiza
 <dd>
 
 ```typescript
-await client.offChrtShipperOrgConnectionInfo.list();
+await client.offChrtShipperOrgInfo.list();
 ```
 
 </dd>
@@ -1148,7 +1148,7 @@ await client.offChrtShipperOrgConnectionInfo.list();
 <dl>
 <dd>
 
-**requestOptions:** `OffChrtShipperOrgConnectionInfo.RequestOptions`
+**requestOptions:** `OffChrtShipperOrgInfo.RequestOptions`
 
 </dd>
 </dl>
@@ -1159,7 +1159,7 @@ await client.offChrtShipperOrgConnectionInfo.list();
 </dl>
 </details>
 
-<details><summary><code>client.offChrtShipperOrgConnectionInfo.<a href="/src/api/resources/offChrtShipperOrgConnectionInfo/client/Client.ts">getById</a>(id) -> Chrt.OffChrtShipperOrgConnectionInfo1</code></summary>
+<details><summary><code>client.offChrtShipperOrgInfo.<a href="/src/api/resources/offChrtShipperOrgInfo/client/Client.ts">getById</a>(id) -> Chrt.OffChrtShipperOrgInfo1</code></summary>
 <dl>
 <dd>
 
@@ -1187,7 +1187,7 @@ Retrieves specific off-platform shipper connection information by ID.
 <dd>
 
 ```typescript
-await client.offChrtShipperOrgConnectionInfo.getById("id");
+await client.offChrtShipperOrgInfo.getById("id");
 ```
 
 </dd>
@@ -1211,7 +1211,7 @@ await client.offChrtShipperOrgConnectionInfo.getById("id");
 <dl>
 <dd>
 
-**requestOptions:** `OffChrtShipperOrgConnectionInfo.RequestOptions`
+**requestOptions:** `OffChrtShipperOrgInfo.RequestOptions`
 
 </dd>
 </dl>
@@ -1222,7 +1222,7 @@ await client.offChrtShipperOrgConnectionInfo.getById("id");
 </dl>
 </details>
 
-<details><summary><code>client.offChrtShipperOrgConnectionInfo.<a href="/src/api/resources/offChrtShipperOrgConnectionInfo/client/Client.ts">updateById</a>(id, { ...params }) -> boolean</code></summary>
+<details><summary><code>client.offChrtShipperOrgInfo.<a href="/src/api/resources/offChrtShipperOrgInfo/client/Client.ts">updateById</a>(id, { ...params }) -> boolean</code></summary>
 <dl>
 <dd>
 
@@ -1250,7 +1250,7 @@ Updates existing off-platform shipper connection information owned by the authen
 <dd>
 
 ```typescript
-await client.offChrtShipperOrgConnectionInfo.updateById("id");
+await client.offChrtShipperOrgInfo.updateById("id");
 ```
 
 </dd>
@@ -1274,7 +1274,7 @@ await client.offChrtShipperOrgConnectionInfo.updateById("id");
 <dl>
 <dd>
 
-**request:** `Chrt.OffChrtShipperOrgConnectionInfoClientUpdate1`
+**request:** `Chrt.OffChrtShipperOrgInfoClientUpdate1`
 
 </dd>
 </dl>
@@ -1282,7 +1282,7 @@ await client.offChrtShipperOrgConnectionInfo.updateById("id");
 <dl>
 <dd>
 
-**requestOptions:** `OffChrtShipperOrgConnectionInfo.RequestOptions`
+**requestOptions:** `OffChrtShipperOrgInfo.RequestOptions`
 
 </dd>
 </dl>
@@ -2326,9 +2326,731 @@ await client.courierPayDriverRateSheets.listByDriverId("driver_id");
 </dl>
 </details>
 
+## ShipperPayCourierRateSheets
+
+<details><summary><code>client.shipperPayCourierRateSheets.<a href="/src/api/resources/shipperPayCourierRateSheets/client/Client.ts">listByCourierOrgId</a>() -> Chrt.ShipperPayCourierRateSheet1[]</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Lists all rate sheets created by the authenticated courier organization.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shipperPayCourierRateSheets.listByCourierOrgId();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `ShipperPayCourierRateSheets.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.shipperPayCourierRateSheets.<a href="/src/api/resources/shipperPayCourierRateSheets/client/Client.ts">create</a>({ ...params }) -> string</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Creates a new rate sheet for a courier to charge shippers.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shipperPayCourierRateSheets.create({
+    schema_version: 1,
+    base_mileage_distance_miles: 1.1,
+    base_mileage_rate_usd_per_instance: 1.1,
+    additional_mileage_rate_usd_per_mile: 1.1,
+    long_distance_surcharge_miles_before_surcharge: 1.1,
+    long_distance_surcharge_rate_usd_per_mile: 1.1,
+    fuel_surchage_rate_usd_per_mile: 1.1,
+    wait_time_before_charge_minutes: 1.1,
+    wait_time_rate_usd_per_minute: 1.1,
+    extra_stop_rate_usd: 1.1,
+    dangerous_goods_rate_usd_per_instance: 1.1,
+    after_hours: 1.1,
+    weekend: 1.1,
+    holiday: 1.1,
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.ShipperPayCourierRateSheetClientCreate1`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ShipperPayCourierRateSheets.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.shipperPayCourierRateSheets.<a href="/src/api/resources/shipperPayCourierRateSheets/client/Client.ts">get</a>(id) -> Chrt.ShipperPayCourierRateSheet1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieves a single rate sheet by its ID (courier access only).
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shipperPayCourierRateSheets.get("id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ShipperPayCourierRateSheets.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.shipperPayCourierRateSheets.<a href="/src/api/resources/shipperPayCourierRateSheets/client/Client.ts">deleteById</a>(id) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Deletes a rate sheet owned by the authenticated courier organization.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shipperPayCourierRateSheets.deleteById("id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ShipperPayCourierRateSheets.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.shipperPayCourierRateSheets.<a href="/src/api/resources/shipperPayCourierRateSheets/client/Client.ts">updateById</a>(id, { ...params }) -> Chrt.ShipperPayCourierRateSheet1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Updates an existing rate sheet owned by the authenticated courier organization.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shipperPayCourierRateSheets.updateById("id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Chrt.ShipperPayCourierRateSheetClientUpdate1`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ShipperPayCourierRateSheets.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## CourierPayDriverLineItemGroup
 
-<details><summary><code>client.courierPayDriverLineItemGroup.<a href="/src/api/resources/courierPayDriverLineItemGroup/client/Client.ts">preview</a>({ ...params }) -> Chrt.CourierPayDriverLineItemGroupClientCreate1</code></summary>
+<details><summary><code>client.courierPayDriverLineItemGroup.<a href="/src/api/resources/courierPayDriverLineItemGroup/client/Client.ts">preview</a>({ ...params }) -> Chrt.CourierPayDriverLineItemGroupPreviewRes</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Previews calculated line items for a driver based on rate sheet and task group without creating the group.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.courierPayDriverLineItemGroup.preview({
+    courier_pay_driver_rate_sheet_id: "courier_pay_driver_rate_sheet_id",
+    task_group_id: "task_group_id",
+    driver_id: "driver_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.CourierPayDriverLineItemGroupPreviewReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `CourierPayDriverLineItemGroup.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.courierPayDriverLineItemGroup.<a href="/src/api/resources/courierPayDriverLineItemGroup/client/Client.ts">getById</a>(id) -> Chrt.CourierPayDriverLineItemGroup1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieves a courier driver line item group by its ID.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.courierPayDriverLineItemGroup.getById("id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `CourierPayDriverLineItemGroup.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.courierPayDriverLineItemGroup.<a href="/src/api/resources/courierPayDriverLineItemGroup/client/Client.ts">byTaskGroupId</a>(taskGroupId) -> Chrt.CourierPayDriverLineItemGroup1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieves a courier driver line item group by its associated task group ID.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.courierPayDriverLineItemGroup.byTaskGroupId("task_group_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**taskGroupId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `CourierPayDriverLineItemGroup.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.courierPayDriverLineItemGroup.<a href="/src/api/resources/courierPayDriverLineItemGroup/client/Client.ts">create</a>({ ...params }) -> string</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Creates a courier driver line item group by calculating items from rate sheet and task group.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.courierPayDriverLineItemGroup.create({
+    courier_pay_driver_rate_sheet_id: "courier_pay_driver_rate_sheet_id",
+    task_group_id: "task_group_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.CourierPayDriverLineItemGroupCreateReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `CourierPayDriverLineItemGroup.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## ShipperPayCourierLineItemGroup
+
+<details><summary><code>client.shipperPayCourierLineItemGroup.<a href="/src/api/resources/shipperPayCourierLineItemGroup/client/Client.ts">preview</a>({ ...params }) -> Chrt.ShipperPayCourierLineItemGroupServerCreate1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Previews calculated line items for a shipper pay courier based on rate sheet and task group without creating the group.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shipperPayCourierLineItemGroup.preview({
+    shipper_pay_courier_rate_sheet_id: "shipper_pay_courier_rate_sheet_id",
+    task_group_id: "task_group_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.ShipperPayCourierLineItemGroupPreviewReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ShipperPayCourierLineItemGroup.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.shipperPayCourierLineItemGroup.<a href="/src/api/resources/shipperPayCourierLineItemGroup/client/Client.ts">getById</a>(id) -> Chrt.ShipperPayCourierLineItemGroup1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieves a shipper pay courier line item group by its ID.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shipperPayCourierLineItemGroup.getById("id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ShipperPayCourierLineItemGroup.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.shipperPayCourierLineItemGroup.<a href="/src/api/resources/shipperPayCourierLineItemGroup/client/Client.ts">byTaskGroupId</a>(taskGroupId) -> Chrt.ShipperPayCourierLineItemGroup1</code></summary>
 <dl>
 <dd>
 
@@ -2340,7 +3062,7 @@ await client.courierPayDriverRateSheets.listByDriverId("driver_id");
 <dl>
 <dd>
 
-Previews calculated line items for a driver based on rate sheet and task group without creating the group.
+Retrieves a shipper pay courier line item group by its associated task group ID.
 
 </dd>
 </dl>
@@ -2356,10 +3078,72 @@ Previews calculated line items for a driver based on rate sheet and task group w
 <dd>
 
 ```typescript
-await client.courierPayDriverLineItemGroup.preview({
-    courier_pay_driver_rate_sheet_id: "courier_pay_driver_rate_sheet_id",
+await client.shipperPayCourierLineItemGroup.byTaskGroupId("task_group_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**taskGroupId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ShipperPayCourierLineItemGroup.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.shipperPayCourierLineItemGroup.<a href="/src/api/resources/shipperPayCourierLineItemGroup/client/Client.ts">create</a>({ ...params }) -> string</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Creates a shipper pay courier line item group by calculating items from rate sheet and task group.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shipperPayCourierLineItemGroup.create({
+    shipper_pay_courier_rate_sheet_id: "shipper_pay_courier_rate_sheet_id",
     task_group_id: "task_group_id",
-    driver_id: "driver_id",
 });
 ```
 
@@ -2376,15 +3160,200 @@ await client.courierPayDriverLineItemGroup.preview({
 <dl>
 <dd>
 
-**request:** `Chrt.CourierPayDriverLineItemGroupPreviewReq`
-
-</dd>
-</dl>
-
+**request:** `Chrt.ShipperPayCourierLineItemGroupCreateReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ShipperPayCourierLineItemGroup.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## ShipperPayCourierPayments
+
+<details><summary><code>client.shipperPayCourierPayments.<a href="/src/api/resources/shipperPayCourierPayments/client/Client.ts">getByOrderIdOrShortId</a>(orderIdOrShortId) -> Chrt.GetShipperPayCourierPaymentsRes</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieves all shipper-to-courier payments for a specific order by ID or short ID.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shipperPayCourierPayments.getByOrderIdOrShortId("order_id_or_short_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**orderIdOrShortId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ShipperPayCourierPayments.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.shipperPayCourierPayments.<a href="/src/api/resources/shipperPayCourierPayments/client/Client.ts">create</a>({ ...params }) -> string</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Create a shipper-to-courier payment record based on all task groups in an order
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shipperPayCourierPayments.create({
+    order_id_or_short_id: "order_id_or_short_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.CreateShipperPayCourierPaymentReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ShipperPayCourierPayments.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.shipperPayCourierPayments.<a href="/src/api/resources/shipperPayCourierPayments/client/Client.ts">listByShipperOrg</a>() -> Chrt.GetShipperPayCourierPaymentsForShipperRes</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieves all shipper-to-courier payments for the authenticated shipper organization.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shipperPayCourierPayments.listByShipperOrg();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
 <dl>
 <dd>
 
-**requestOptions:** `CourierPayDriverLineItemGroup.RequestOptions`
+**requestOptions:** `ShipperPayCourierPayments.RequestOptions`
 
 </dd>
 </dl>
@@ -2395,7 +3364,7 @@ await client.courierPayDriverLineItemGroup.preview({
 </dl>
 </details>
 
-<details><summary><code>client.courierPayDriverLineItemGroup.<a href="/src/api/resources/courierPayDriverLineItemGroup/client/Client.ts">getById</a>(id) -> Chrt.CourierPayDriverLineItemGroup1</code></summary>
+<details><summary><code>client.shipperPayCourierPayments.<a href="/src/api/resources/shipperPayCourierPayments/client/Client.ts">listByShipperOrgAndStatus</a>(paymentStatus) -> Chrt.GetShipperPayCourierPaymentsForShipperRes</code></summary>
 <dl>
 <dd>
 
@@ -2407,7 +3376,7 @@ await client.courierPayDriverLineItemGroup.preview({
 <dl>
 <dd>
 
-Retrieves a courier driver line item group by its ID.
+Retrieves shipper-to-courier payments for the authenticated shipper organization filtered by payment status.
 
 </dd>
 </dl>
@@ -2423,7 +3392,7 @@ Retrieves a courier driver line item group by its ID.
 <dd>
 
 ```typescript
-await client.courierPayDriverLineItemGroup.getById("id");
+await client.shipperPayCourierPayments.listByShipperOrgAndStatus("pending");
 ```
 
 </dd>
@@ -2439,7 +3408,7 @@ await client.courierPayDriverLineItemGroup.getById("id");
 <dl>
 <dd>
 
-**id:** `string`
+**paymentStatus:** `Chrt.PaymentStatusEnum`
 
 </dd>
 </dl>
@@ -2447,7 +3416,7 @@ await client.courierPayDriverLineItemGroup.getById("id");
 <dl>
 <dd>
 
-**requestOptions:** `CourierPayDriverLineItemGroup.RequestOptions`
+**requestOptions:** `ShipperPayCourierPayments.RequestOptions`
 
 </dd>
 </dl>
@@ -2458,7 +3427,7 @@ await client.courierPayDriverLineItemGroup.getById("id");
 </dl>
 </details>
 
-<details><summary><code>client.courierPayDriverLineItemGroup.<a href="/src/api/resources/courierPayDriverLineItemGroup/client/Client.ts">byTaskGroupId</a>(taskGroupId) -> Chrt.CourierPayDriverLineItemGroup1</code></summary>
+<details><summary><code>client.shipperPayCourierPayments.<a href="/src/api/resources/shipperPayCourierPayments/client/Client.ts">preview</a>({ ...params }) -> Chrt.PaymentPreviewResponse</code></summary>
 <dl>
 <dd>
 
@@ -2470,7 +3439,7 @@ await client.courierPayDriverLineItemGroup.getById("id");
 <dl>
 <dd>
 
-Retrieves a courier driver line item group by its associated task group ID.
+Preview a shipper-to-courier payment showing task groups, line item groups, total amount, and readiness status
 
 </dd>
 </dl>
@@ -2486,7 +3455,9 @@ Retrieves a courier driver line item group by its associated task group ID.
 <dd>
 
 ```typescript
-await client.courierPayDriverLineItemGroup.byTaskGroupId("task_group_id");
+await client.shipperPayCourierPayments.preview({
+    order_id_or_short_id: "order_id_or_short_id",
+});
 ```
 
 </dd>
@@ -2502,7 +3473,7 @@ await client.courierPayDriverLineItemGroup.byTaskGroupId("task_group_id");
 <dl>
 <dd>
 
-**taskGroupId:** `string`
+**request:** `Chrt.CreateShipperPayCourierPaymentReq`
 
 </dd>
 </dl>
@@ -2510,7 +3481,7 @@ await client.courierPayDriverLineItemGroup.byTaskGroupId("task_group_id");
 <dl>
 <dd>
 
-**requestOptions:** `CourierPayDriverLineItemGroup.RequestOptions`
+**requestOptions:** `ShipperPayCourierPayments.RequestOptions`
 
 </dd>
 </dl>
@@ -2521,7 +3492,9 @@ await client.courierPayDriverLineItemGroup.byTaskGroupId("task_group_id");
 </dl>
 </details>
 
-<details><summary><code>client.courierPayDriverLineItemGroup.<a href="/src/api/resources/courierPayDriverLineItemGroup/client/Client.ts">create</a>({ ...params }) -> string</code></summary>
+## CourierPayDriverPayouts
+
+<details><summary><code>client.courierPayDriverPayouts.<a href="/src/api/resources/courierPayDriverPayouts/client/Client.ts">getById</a>(id) -> unknown</code></summary>
 <dl>
 <dd>
 
@@ -2533,7 +3506,7 @@ await client.courierPayDriverLineItemGroup.byTaskGroupId("task_group_id");
 <dl>
 <dd>
 
-Creates a courier driver line item group by calculating items from rate sheet and task group.
+Retrieves a specific courier driver payout by ID for the authenticated organization.
 
 </dd>
 </dl>
@@ -2549,10 +3522,7 @@ Creates a courier driver line item group by calculating items from rate sheet an
 <dd>
 
 ```typescript
-await client.courierPayDriverLineItemGroup.create({
-    courier_pay_driver_rate_sheet_id: "courier_pay_driver_rate_sheet_id",
-    task_group_id: "task_group_id",
-});
+await client.courierPayDriverPayouts.getById("id");
 ```
 
 </dd>
@@ -2568,7 +3538,7 @@ await client.courierPayDriverLineItemGroup.create({
 <dl>
 <dd>
 
-**request:** `Chrt.CourierPayDriverLineItemGroupCreateReq`
+**id:** `string`
 
 </dd>
 </dl>
@@ -2576,7 +3546,7 @@ await client.courierPayDriverLineItemGroup.create({
 <dl>
 <dd>
 
-**requestOptions:** `CourierPayDriverLineItemGroup.RequestOptions`
+**requestOptions:** `CourierPayDriverPayouts.RequestOptions`
 
 </dd>
 </dl>
@@ -2587,9 +3557,7 @@ await client.courierPayDriverLineItemGroup.create({
 </dl>
 </details>
 
-## CourierPayDriverPayouts
-
-<details><summary><code>client.courierPayDriverPayouts.<a href="/src/api/resources/courierPayDriverPayouts/client/Client.ts">getById</a>(id) -> unknown</code></summary>
+<details><summary><code>client.courierPayDriverPayouts.<a href="/src/api/resources/courierPayDriverPayouts/client/Client.ts">listByDriverId</a>(driverId) -> unknown</code></summary>
 <dl>
 <dd>
 
@@ -2601,7 +3569,7 @@ await client.courierPayDriverLineItemGroup.create({
 <dl>
 <dd>
 
-Retrieves a specific courier driver payout by ID for the authenticated organization.
+Lists all payouts for a specific driver within the authenticated organization.
 
 </dd>
 </dl>
@@ -2617,7 +3585,7 @@ Retrieves a specific courier driver payout by ID for the authenticated organizat
 <dd>
 
 ```typescript
-await client.courierPayDriverPayouts.getById("id");
+await client.courierPayDriverPayouts.listByDriverId("driver_id");
 ```
 
 </dd>
@@ -2633,7 +3601,7 @@ await client.courierPayDriverPayouts.getById("id");
 <dl>
 <dd>
 
-**id:** `string`
+**driverId:** `string`
 
 </dd>
 </dl>
@@ -2652,7 +3620,7 @@ await client.courierPayDriverPayouts.getById("id");
 </dl>
 </details>
 
-<details><summary><code>client.courierPayDriverPayouts.<a href="/src/api/resources/courierPayDriverPayouts/client/Client.ts">listByDriverId</a>(driverId) -> unknown</code></summary>
+<details><summary><code>client.courierPayDriverPayouts.<a href="/src/api/resources/courierPayDriverPayouts/client/Client.ts">create</a>({ ...params }) -> string</code></summary>
 <dl>
 <dd>
 
@@ -2664,7 +3632,7 @@ await client.courierPayDriverPayouts.getById("id");
 <dl>
 <dd>
 
-Lists all payouts for a specific driver within the authenticated organization.
+Creates a new driver payout from selected line item groups.
 
 </dd>
 </dl>
@@ -2680,7 +3648,10 @@ Lists all payouts for a specific driver within the authenticated organization.
 <dd>
 
 ```typescript
-await client.courierPayDriverPayouts.listByDriverId("driver_id");
+await client.courierPayDriverPayouts.create({
+    schema_version: 1,
+    courier_pay_driver_line_item_group_ids: ["courier_pay_driver_line_item_group_ids"],
+});
 ```
 
 </dd>
@@ -2696,7 +3667,7 @@ await client.courierPayDriverPayouts.listByDriverId("driver_id");
 <dl>
 <dd>
 
-**driverId:** `string`
+**request:** `Chrt.CourierPayDriverPayoutClientCreate1`
 
 </dd>
 </dl>
@@ -2715,7 +3686,7 @@ await client.courierPayDriverPayouts.listByDriverId("driver_id");
 </dl>
 </details>
 
-<details><summary><code>client.courierPayDriverPayouts.<a href="/src/api/resources/courierPayDriverPayouts/client/Client.ts">create</a>({ ...params }) -> string</code></summary>
+<details><summary><code>client.courierPayDriverPayouts.<a href="/src/api/resources/courierPayDriverPayouts/client/Client.ts">updateStatus</a>(id, { ...params }) -> Chrt.CourierPayDriverPayout1</code></summary>
 <dl>
 <dd>
 
@@ -2727,7 +3698,7 @@ await client.courierPayDriverPayouts.listByDriverId("driver_id");
 <dl>
 <dd>
 
-Creates a new driver payout from selected line item groups.
+Updates the status of a courier driver payout with proper validation.
 
 </dd>
 </dl>
@@ -2743,10 +3714,7 @@ Creates a new driver payout from selected line item groups.
 <dd>
 
 ```typescript
-await client.courierPayDriverPayouts.create({
-    schema_version: 1,
-    line_item_group_ids: ["line_item_group_ids"],
-});
+await client.courierPayDriverPayouts.updateStatus("id");
 ```
 
 </dd>
@@ -2762,7 +3730,15 @@ await client.courierPayDriverPayouts.create({
 <dl>
 <dd>
 
-**request:** `Chrt.CourierPayDriverPayoutClientCreate1`
+**id:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Chrt.CourierPayDriverPayoutClientUpdate1`
 
 </dd>
 </dl>
@@ -3379,7 +4355,7 @@ await client.shipperContactInfo.listCourierContactsByShipperOrgId("shipper_org_i
 </dl>
 </details>
 
-<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">listByOffChrtShipperOrgConnectionInfoId</a>(offChrtShipperOrgConnectionInfoId) -> Chrt.ShipperContactInfo1[]</code></summary>
+<details><summary><code>client.shipperContactInfo.<a href="/src/api/resources/shipperContactInfo/client/Client.ts">listByOffChrtShipperOrgInfoId</a>(offChrtShipperOrgInfoId) -> Chrt.ShipperContactInfo1[]</code></summary>
 <dl>
 <dd>
 
@@ -3407,7 +4383,7 @@ Lists all shipper contacts for a specific off-platform shipper connection.
 <dd>
 
 ```typescript
-await client.shipperContactInfo.listByOffChrtShipperOrgConnectionInfoId("off_chrt_shipper_org_connection_info_id");
+await client.shipperContactInfo.listByOffChrtShipperOrgInfoId("off_chrt_shipper_org_info_id");
 ```
 
 </dd>
@@ -3423,7 +4399,7 @@ await client.shipperContactInfo.listByOffChrtShipperOrgConnectionInfoId("off_chr
 <dl>
 <dd>
 
-**offChrtShipperOrgConnectionInfoId:** `string`
+**offChrtShipperOrgInfoId:** `string`
 
 </dd>
 </dl>
@@ -4435,7 +5411,7 @@ await client.payments.createCheckoutSession({
 </dl>
 </details>
 
-<details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">createConnectAccount</a>() -> Chrt.CreateConnectAccountRes</code></summary>
+<details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">syncStripeToClerk</a>() -> boolean</code></summary>
 <dl>
 <dd>
 
@@ -4447,7 +5423,7 @@ await client.payments.createCheckoutSession({
 <dl>
 <dd>
 
-Create a Stripe Connect account for receiving payments
+Synchronizes subscription data from Stripe to the authentication service for the current user.
 
 </dd>
 </dl>
@@ -4463,7 +5439,7 @@ Create a Stripe Connect account for receiving payments
 <dd>
 
 ```typescript
-await client.payments.createConnectAccount();
+await client.payments.syncStripeToClerk();
 ```
 
 </dd>
@@ -4490,7 +5466,7 @@ await client.payments.createConnectAccount();
 </dl>
 </details>
 
-<details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">createConnectAccountLink</a>({ ...params }) -> Chrt.CreateConnectAccountLinkRes</code></summary>
+<details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">createConnectAccount</a>() -> Chrt.CreateConnectAccountRes</code></summary>
 <dl>
 <dd>
 
@@ -4502,7 +5478,7 @@ await client.payments.createConnectAccount();
 <dl>
 <dd>
 
-Create an onboarding link for a Stripe Connect account
+Create a Stripe Connect account for the organization to receive payments
 
 </dd>
 </dl>
@@ -4518,9 +5494,7 @@ Create an onboarding link for a Stripe Connect account
 <dd>
 
 ```typescript
-await client.payments.createConnectAccountLink({
-    account_id: "account_id",
-});
+await client.payments.createConnectAccount();
 ```
 
 </dd>
@@ -4536,14 +5510,6 @@ await client.payments.createConnectAccountLink({
 <dl>
 <dd>
 
-**request:** `Chrt.CreateConnectAccountLinkReq`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
 **requestOptions:** `Payments.RequestOptions`
 
 </dd>
@@ -4555,7 +5521,7 @@ await client.payments.createConnectAccountLink({
 </dl>
 </details>
 
-<details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">createDirectCharge</a>({ ...params }) -> Chrt.CreateDirectChargeRes</code></summary>
+<details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">createConnectAccountLink</a>() -> Chrt.CreateConnectAccountLinkRes</code></summary>
 <dl>
 <dd>
 
@@ -4567,7 +5533,7 @@ await client.payments.createConnectAccountLink({
 <dl>
 <dd>
 
-Create a direct charge checkout session to a Connect account
+Create an onboarding link for a Stripe Connect account
 
 </dd>
 </dl>
@@ -4583,10 +5549,7 @@ Create a direct charge checkout session to a Connect account
 <dd>
 
 ```typescript
-await client.payments.createDirectCharge({
-    amount: 1,
-    connect_account_id: "connect_account_id",
-});
+await client.payments.createConnectAccountLink();
 ```
 
 </dd>
@@ -4602,14 +5565,6 @@ await client.payments.createDirectCharge({
 <dl>
 <dd>
 
-**request:** `Chrt.CreateDirectChargeReq`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
 **requestOptions:** `Payments.RequestOptions`
 
 </dd>
@@ -4621,7 +5576,7 @@ await client.payments.createDirectCharge({
 </dl>
 </details>
 
-<details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">syncStripeToClerk</a>() -> boolean</code></summary>
+<details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">generateInvoice</a>({ ...params }) -> Chrt.GenerateInvoiceRes</code></summary>
 <dl>
 <dd>
 
@@ -4633,7 +5588,7 @@ await client.payments.createDirectCharge({
 <dl>
 <dd>
 
-Synchronizes subscription data from Stripe to the authentication service for the current user.
+Generates an invoice for a direct charge payment.
 
 </dd>
 </dl>
@@ -4649,7 +5604,9 @@ Synchronizes subscription data from Stripe to the authentication service for the
 <dd>
 
 ```typescript
-await client.payments.syncStripeToClerk();
+await client.payments.generateInvoice({
+    shipper_pay_courier_payment_id: "shipper_pay_courier_payment_id",
+});
 ```
 
 </dd>
@@ -4665,6 +5622,14 @@ await client.payments.syncStripeToClerk();
 <dl>
 <dd>
 
+**request:** `Chrt.GenerateInvoiceReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **requestOptions:** `Payments.RequestOptions`
 
 </dd>
@@ -5110,7 +6075,7 @@ Adds additional line items to an existing courier driver line item group.
 await client.courierPayDriverLineItemGroup.addLineItems.byId("id", {
     line_items: [
         {
-            created_at: "2024-01-15T09:30:00Z",
+            schema_version: 1,
             item: "base_rate",
             quantity: 1.1,
             rate: 1.1,
@@ -5190,14 +6155,7 @@ Removes specific line items from a courier driver line item group by exact match
 
 ```typescript
 await client.courierPayDriverLineItemGroup.removeLineItems.byId("id", {
-    line_items: [
-        {
-            created_at: "2024-01-15T09:30:00Z",
-            item: "base_rate",
-            quantity: 1.1,
-            rate: 1.1,
-        },
-    ],
+    line_item_uuid_strs: ["line_item_uuid_strs"],
 });
 ```
 
@@ -6235,6 +7193,163 @@ await client.orgConnectionInfos.courier.update();
 </dl>
 </details>
 
+## ShipperPayCourierLineItemGroup AddLineItems
+
+<details><summary><code>client.shipperPayCourierLineItemGroup.addLineItems.<a href="/src/api/resources/shipperPayCourierLineItemGroup/resources/addLineItems/client/Client.ts">byId</a>(id, { ...params }) -> Chrt.ShipperPayCourierLineItemGroup1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Adds additional line items to an existing shipper pay courier line item group.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shipperPayCourierLineItemGroup.addLineItems.byId("id", {
+    line_items: [
+        {
+            schema_version: 1,
+            item: "base_rate",
+            quantity: 1.1,
+            rate: 1.1,
+        },
+    ],
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Chrt.shipperPayCourierLineItemGroup.ShipperPayCourierLineItemGroupAddLineItemsReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AddLineItems.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## ShipperPayCourierLineItemGroup RemoveLineItems
+
+<details><summary><code>client.shipperPayCourierLineItemGroup.removeLineItems.<a href="/src/api/resources/shipperPayCourierLineItemGroup/resources/removeLineItems/client/Client.ts">byId</a>(id, { ...params }) -> Chrt.ShipperPayCourierLineItemGroup1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Removes specific line items from a shipper pay courier line item group by exact match.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.shipperPayCourierLineItemGroup.removeLineItems.byId("id", {
+    line_item_uuid_strs: ["line_item_uuid_strs"],
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Chrt.shipperPayCourierLineItemGroup.ShipperPayCourierLineItemGroupRemoveLineItemsReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `RemoveLineItems.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## TaskGroups Full
 
 <details><summary><code>client.taskGroups.full.<a href="/src/api/resources/taskGroups/resources/full/client/Client.ts">listByCourierOrgId</a>() -> Chrt.MultipleTaskGroupsDetailsResponse</code></summary>