@chrt-inc/typescript-sdk 1.658.0 → 1.659.0

package/reference.md

@@ -86,6 +86,7 @@ Lists all members of the caller's organization with their roles and details. Sup
 
 ```typescript
 await client.orgs.listMembersV1({
+    filter_role: ["owner"],
     sort_by: "first_name",
     sort_order: "asc",
     page: 1,
@@ -480,6 +481,7 @@ await client.billing.billingLedgers.listV1({
     sort_order: "asc",
     page: 1,
     page_size: 1,
+    filter_status: ["active"],
     filter_task_group_type: "chrt_ground_provider",
     filter_payment_origin_org_id: "filter_payment_origin_org_id",
     filter_payment_destination_org_id: "filter_payment_destination_org_id",
@@ -817,6 +819,7 @@ await client.billing.billingLedgerPeriods.listV1({
     page_size: 1,
     filter_billing_ledger_id: "filter_billing_ledger_id",
     filter_owned_by_org_id: "filter_owned_by_org_id",
+    filter_status: ["open"],
     filter_statement_id: "filter_statement_id",
     filter_attached_to_statement: true,
     filter_period_end_at_timestamp_before: "2024-01-15T09:30:00Z",
@@ -1129,6 +1132,69 @@ await client.billing.lineItemGroups.getByIdV1("id");
 </dl>
 </details>
 
+<details><summary><code>client.billing.lineItemGroups.<a href="/src/api/resources/billing/resources/lineItemGroups/client/Client.ts">getLineItemsV1</a>(lineItemGroupId) -> Chrt.LineItemGroupLineItemsRes</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieves all LineItems referenced by a LineItemGroup the caller can access. | authz_personas=[lig_org_operators, lig_driver] | () -> (LineItemGroupLineItemsRes)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.billing.lineItemGroups.getLineItemsV1("line_item_group_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**lineItemGroupId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `LineItemGroups.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.billing.lineItemGroups.<a href="/src/api/resources/billing/resources/lineItemGroups/client/Client.ts">listV1</a>({ ...params }) -> Chrt.LineItemGroupListRes</code></summary>
 <dl>
 <dd>
@@ -1161,6 +1227,7 @@ await client.billing.lineItemGroups.listV1({
     sort_order: "asc",
     page: 1,
     page_size: 1,
+    filter_status: ["staged"],
     filter_task_group_id: "filter_task_group_id",
     filter_order_id: "filter_order_id",
     filter_order_short_id: "filter_order_short_id",
@@ -4196,6 +4263,7 @@ await client.billing.statements.listV1({
     sort_order: "asc",
     page: 1,
     page_size: 1,
+    filter_status: ["staged"],
     filter_settlement_type: "stripe_connect",
     filter_order_id: "filter_order_id",
     filter_order_short_id: "filter_order_short_id",
@@ -4280,6 +4348,7 @@ await client.billing.statements.expandedListV1({
     sort_order: "asc",
     page: 1,
     page_size: 1,
+    filter_status: ["staged"],
     filter_settlement_type: "stripe_connect",
     filter_order_id: "filter_order_id",
     filter_order_short_id: "filter_order_short_id",
@@ -5768,6 +5837,270 @@ await client.billing.lineItemGroups.s3Objects.deleteV1("line_item_group_s3_objec
 </dl>
 </details>
 
+## Billing LineItems S3Objects
+
+<details><summary><code>client.billing.lineItems.s3Objects.<a href="/src/api/resources/billing/resources/lineItems/resources/s3Objects/client/Client.ts">getS3ObjectMetadataV1</a>(lineItemS3ObjectMetadataId) -> Chrt.LineItemS3ObjectMetadata1</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieves metadata for a line item S3 object. | authz_personas=[lig_org_operators, lig_driver] | () -> (LineItemS3ObjectMetadata1)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.billing.lineItems.s3Objects.getS3ObjectMetadataV1("line_item_s3_object_metadata_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**lineItemS3ObjectMetadataId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `S3Objects.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.billing.lineItems.s3Objects.<a href="/src/api/resources/billing/resources/lineItems/resources/s3Objects/client/Client.ts">getV1</a>(lineItemS3ObjectMetadataId) -> core.BinaryResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Streams a line item S3 object file from storage. | authz_personas=[lig_org_operators, lig_driver] | () -> (binary)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.billing.lineItems.s3Objects.getV1("line_item_s3_object_metadata_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**lineItemS3ObjectMetadataId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `S3Objects.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.billing.lineItems.s3Objects.<a href="/src/api/resources/billing/resources/lineItems/resources/s3Objects/client/Client.ts">addV1</a>(lineItemId, { ...params }) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Uploads a file to a line item. Automatic blurhash generation for images. | authz_personas=[lig_org_operators, lig_driver] | (UploadFile) -> (bool)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.billing.lineItems.s3Objects.addV1("line_item_id", {
+    file: fs.createReadStream("/path/to/your/file"),
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**lineItemId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Chrt.billing.lineItems.BodyLineItemsS3ObjectPostAddV1BillingLineItemsS3ObjectsAddV1LineItemIdPost`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `S3Objects.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.billing.lineItems.s3Objects.<a href="/src/api/resources/billing/resources/lineItems/resources/s3Objects/client/Client.ts">deleteV1</a>(lineItemS3ObjectMetadataId) -> boolean</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Deletes an S3 object metadata and the associated S3 object from a line item. | authz_personas=[lig_org_operators, lig_driver] | () -> (bool)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.billing.lineItems.s3Objects.deleteV1("line_item_s3_object_metadata_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**lineItemS3ObjectMetadataId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `S3Objects.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Integrations AirWaybills
 
 <details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">createV1</a>({ ...params }) -> Chrt.ChampAirWaybill1</code></summary>
@@ -6652,6 +6985,8 @@ await client.listing.listings.listByOrgV1({
     sort_order: "asc",
     page: 1,
     page_size: 1,
+    filter_status: ["open"],
+    filter_type: ["dispatch"],
     filter_task_group_id: "filter_task_group_id",
     filter_order_id: "filter_order_id",
     filter_created_by_org_id: "filter_created_by_org_id",
@@ -6728,6 +7063,8 @@ await client.listing.listings.listForProviderBidderV1({
     sort_order: "asc",
     page: 1,
     page_size: 1,
+    filter_status: ["open"],
+    filter_type: ["dispatch"],
     filter_task_group_id: "filter_task_group_id",
     filter_order_id: "filter_order_id",
     filter_created_by_org_id: "filter_created_by_org_id",
@@ -6804,6 +7141,8 @@ await client.listing.listings.listForDriverBidderV1({
     sort_order: "asc",
     page: 1,
     page_size: 1,
+    filter_status: ["open"],
+    filter_type: ["dispatch"],
     filter_task_group_id: "filter_task_group_id",
     filter_order_id: "filter_order_id",
     filter_created_by_org_id: "filter_created_by_org_id",
@@ -8397,6 +8736,7 @@ await client.listing.bidThreads.listForListingV1("listing_id", {
     sort_order: "asc",
     page: 1,
     page_size: 1,
+    filter_status: ["open"],
     filter_listing_id: "filter_listing_id",
     filter_bidder_provider_org_id: "filter_bidder_provider_org_id",
     filter_bidder_driver_id: "filter_bidder_driver_id",
@@ -8480,6 +8820,7 @@ await client.listing.bidThreads.listForBidderV1({
     sort_order: "asc",
     page: 1,
     page_size: 1,
+    filter_status: ["open"],
     filter_listing_id: "filter_listing_id",
     filter_bidder_provider_org_id: "filter_bidder_provider_org_id",
     filter_bidder_driver_id: "filter_bidder_driver_id",
@@ -10468,6 +10809,8 @@ await client.operations.cases.listV1({
     sort_order: "asc",
     page: 1,
     page_size: 1,
+    filter_status: ["open"],
+    filter_department_id: ["filter_department_id"],
     filter_assigned_operator_user_id: "filter_assigned_operator_user_id",
     filter_needs_action: true,
     filter_unassigned: true,
@@ -10957,6 +11300,7 @@ await client.operations.departments.listV1({
     sort_order: "asc",
     page: 1,
     page_size: 1,
+    filter_department: ["automotive"],
 });
 ```
 
@@ -13728,6 +14072,7 @@ Lists all organization members paired with their driver information if they are
 ```typescript
 await client.shipping.drivers.listOrgMembersAndDriversV1({
     search: "search",
+    filter_role: ["owner"],
     filter_available_according_to_driver: true,
     filter_available_according_to_operators: true,
     sort_by: "first_name",
@@ -15144,6 +15489,8 @@ await client.shipping.orderSchedules.listV1({
     sort_order: "asc",
     page: 1,
     page_size: 1,
+    filter_status: ["draft"],
+    filter_orchestrator_schedule_status: ["not_created"],
     filter_owned_by_user_id: "filter_owned_by_user_id",
     filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
     filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
@@ -19287,6 +19634,7 @@ await client.shipping.orders.expanded.listForCoordinatorOperatorsV1({
     page: 1,
     page_size: 1,
     search: "search",
+    filter_status: ["draft"],
     filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
     filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
     filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
@@ -19373,6 +19721,7 @@ await client.shipping.orders.expanded.listForShipperOperatorsV1({
     page: 1,
     page_size: 1,
     search: "search",
+    filter_status: ["draft"],
     filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
     filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
     filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
@@ -20466,6 +20815,7 @@ await client.shipping.taskGroups.expanded.listForExecutorOperatorsV1({
     page: 1,
     page_size: 1,
     search: "search",
+    filter_status: ["draft"],
     filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
     filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
     filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
@@ -20553,6 +20903,7 @@ await client.shipping.taskGroups.expanded.listForDriverForExecutorV1({
     page: 1,
     page_size: 1,
     search: "search",
+    filter_status: ["draft"],
     filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
     filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
     filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",