@chrt-inc/typescript-sdk 1.526.0 → 1.528.0

package/reference.md

@@ -464,6 +464,7 @@ Lists line item groups for the authenticated courier organization with filtering
 await client.billing.lineItemGroups.listForCourierOrgV1({
     filter_driver_id: "filter_driver_id",
     filter_attached_to_statement: true,
+    filter_order_id: "filter_order_id",
     filter_payment_role: "origin",
     page: 1,
     page_size: 1,
@@ -1693,6 +1694,7 @@ await client.billing.statements.listV1({
     page: 1,
     page_size: 1,
     filter_settlement_type: "stripe_connect",
+    filter_order_id: "filter_order_id",
     filter_payment_origin_org_id: "filter_payment_origin_org_id",
     filter_payment_destination_org_id: "filter_payment_destination_org_id",
     filter_owned_by_org_id: "filter_owned_by_org_id",
@@ -1737,6 +1739,85 @@ await client.billing.statements.listV1({
 </dl>
 </details>
 
+<details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">expandedListV1</a>({ ...params }) -> Chrt.StatementsExpandedListRes</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Lists statements with expanded LIGs and task groups, using filtering, sorting, and pagination. | authz_personas=[statement_org_operators, statement_driver] | () -> (StatementsExpandedListRes)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.billing.statements.expandedListV1({
+    sort_by: "amount",
+    sort_order: "asc",
+    page: 1,
+    page_size: 1,
+    filter_settlement_type: "stripe_connect",
+    filter_order_id: "filter_order_id",
+    filter_payment_origin_org_id: "filter_payment_origin_org_id",
+    filter_payment_destination_org_id: "filter_payment_destination_org_id",
+    filter_owned_by_org_id: "filter_owned_by_org_id",
+    filter_staged_at_timestamp_gte: "2024-01-15T09:30:00Z",
+    filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
+    filter_opened_at_timestamp_gte: "2024-01-15T09:30:00Z",
+    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",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Chrt.billing.StatementsExpandedListV1Request`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Statements.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">createV1</a>({ ...params }) -> Chrt.Statement1</code></summary>
 <dl>
 <dd>
@@ -1920,7 +2001,7 @@ await client.billing.statements.updateSettlementTypeV1("statement_id", {
 <dl>
 <dd>
 
-**request:** `Chrt.billing.BodyStatementsPatchUpdateSettlementTypeV1BillingUpdateSettlementTypeV1StatementIdPatch`
+**request:** `Chrt.billing.BodyStatementsPatchUpdateSettlementTypeV1BillingStatementsUpdateSettlementTypeV1StatementIdPatch`
 
 </dd>
 </dl>
@@ -1993,7 +2074,7 @@ await client.billing.statements.updateOffChrtSettlementStateV1("statement_id", {
 <dl>
 <dd>
 
-**request:** `Chrt.billing.BodyStatementsPatchUpdateOffChrtSettlementStateV1BillingUpdateOffChrtSettlementStateV1StatementIdPatch`
+**request:** `Chrt.billing.BodyStatementsPatchUpdateOffChrtSettlementStateV1BillingStatementsUpdateOffChrtSettlementStateV1StatementIdPatch`
 
 </dd>
 </dl>
@@ -2457,7 +2538,7 @@ await client.billing.stripeConnect.onboardingLinkV1();
 <dl>
 <dd>
 
-Creates an ad-hoc line item group (not associated with a TaskGroup). Starts as ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator | (CreateAdHocLineItemGroupReq) -> (LineItemGroup1)
+Creates an ad-hoc line item group. Optionally associates with a TaskGroup. Starts as ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator | (CreateAdHocLineItemGroupReq) -> (LineItemGroup1)
 
 </dd>
 </dl>
@@ -2523,7 +2604,7 @@ await client.billing.lineItemGroups.adHoc.createV1({
 <dl>
 <dd>
 
-Adds a line item to an ad-hoc line item group. LIG must be ad-hoc (task_group_id is None) and ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | (LineItemClientCreate1) -> (LineItemGroup1)
+Adds a line item to an ad-hoc line item group. LIG must be ad-hoc (is_ad_hoc=True) and ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | (LineItemClientCreate1) -> (LineItemGroup1)
 
 </dd>
 </dl>
@@ -2598,7 +2679,7 @@ await client.billing.lineItemGroups.adHoc.addLineItemV1("line_item_group_id", {
 <dl>
 <dd>
 
-Removes a line item from an ad-hoc line item group. LIG must be ad-hoc (task_group_id is None) and ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | (line_item_uuid_str) -> (LineItemGroup1)
+Removes a line item from an ad-hoc line item group. LIG must be ad-hoc (is_ad_hoc=True) and ADJUSTABLE. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | (line_item_uuid_str) -> (LineItemGroup1)
 
 </dd>
 </dl>
@@ -2671,7 +2752,7 @@ await client.billing.lineItemGroups.adHoc.removeLineItemV1("line_item_group_id",
 <dl>
 <dd>
 
-Deletes an ad-hoc line item group. LIG must be ad-hoc (task_group_id is None) and ADJUSTABLE or FINALIZED. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | () -> (bool)
+Deletes an ad-hoc line item group. LIG must be ad-hoc (is_ad_hoc=True) and ADJUSTABLE or FINALIZED. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators] | () -> (bool)
 
 </dd>
 </dl>
@@ -2722,6 +2803,79 @@ await client.billing.lineItemGroups.adHoc.deleteV1("line_item_group_id");
 </dl>
 </details>
 
+<details><summary><code>client.billing.lineItemGroups.adHoc.<a href="/src/api/resources/billing/resources/lineItemGroups/resources/adHoc/client/Client.ts">setTaskGroupV1</a>(lineItemGroupId, { ...params }) -> Chrt.LineItemGroup1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Sets or updates the task_group_id on an existing ad-hoc LIG, deriving order_id and order_short_id from the task group. If the LIG is on a statement, recalculates the statement's order refs. | org_type=[courier, forwarder], min_org_role=operator, authz_personas=[lig_owner_operators, courier_org_operators, forwarder_org_operators] | (SetAdHocTaskGroupReq) -> (LineItemGroup1)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.billing.lineItemGroups.adHoc.setTaskGroupV1("line_item_group_id", {
+    task_group_id: "task_group_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**lineItemGroupId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Chrt.billing.lineItemGroups.SetAdHocTaskGroupReq`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AdHoc.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Billing LineItemGroups Messages
 
 <details><summary><code>client.billing.lineItemGroups.messages.<a href="/src/api/resources/billing/resources/lineItemGroups/resources/messages/client/Client.ts">addV1</a>(lineItemGroupId, { ...params }) -> boolean</code></summary>