@chrt-inc/typescript-sdk 1.647.0 → 1.652.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,
@@ -126,7 +127,7 @@ await client.orgs.listMembersV1({
 </dl>
 </details>
 
-<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">setOrgTypeV1</a>({ ...params }) -> boolean</code></summary>
+<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">setupOrgV1</a>({ ...params }) -> boolean</code></summary>
 <dl>
 <dd>
 
@@ -138,7 +139,7 @@ await client.orgs.listMembersV1({
 <dl>
 <dd>
 
-Sets the org_type in Clerk's JWT public metadata. Returns True if already set and matching, sets it if not present, or raises exception if conflicting. | (SetOrgTypeReq) -> (bool)
+Single onboarding entry point. Sets `org_type` in Clerk's JWT public metadata (immutable once set) and idempotently creates `org_private_data` + `org_public_data` for the caller's organization. Optional `handle` and `company_name` populate the public doc on first call; later updates go through PATCH /orgs/org_public_data/v1. Returns True on success (including idempotent retries), 400 on org_type conflict or handle collision. | (SetupOrgReq) -> (bool)
 
 </dd>
 </dl>
@@ -154,7 +155,7 @@ Sets the org_type in Clerk's JWT public metadata. Returns True if already set an
 <dd>
 
 ```typescript
-await client.orgs.setOrgTypeV1({
+await client.orgs.setupOrgV1({
     org_type: "provider",
 });
 ```
@@ -172,7 +173,7 @@ await client.orgs.setOrgTypeV1({
 <dl>
 <dd>
 
-**request:** `Chrt.SetOrgTypeReq`
+**request:** `Chrt.SetupOrgReq`
 
 </dd>
 </dl>
@@ -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",
@@ -1161,6 +1164,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",
@@ -3529,6 +3533,82 @@ await client.billing.rateSheetMappings.listV1({
 </dl>
 </details>
 
+<details><summary><code>client.billing.rateSheetMappings.<a href="/src/api/resources/billing/resources/rateSheetMappings/client/Client.ts">listRateSheetIdsByCounterpartyV1</a>(tgType, { ...params }) -> string[]</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Lists rate sheet IDs mapped to a counterparty for the requested task group type. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (list[PydanticObjectId])
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.billing.rateSheetMappings.listRateSheetIdsByCounterpartyV1("chrt_ground_provider", {
+    counterparty_org_id: "counterparty_org_id",
+    counterparty_driver_id: "counterparty_driver_id",
+    counterparty_off_chrt_provider_org_id: "counterparty_off_chrt_provider_org_id",
+    counterparty_off_chrt_shipper_org_id: "counterparty_off_chrt_shipper_org_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**tgType:** `Chrt.TaskGroupTypeEnum1`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Chrt.billing.RateSheetMappingsListRateSheetIdsByCounterpartyV1Request`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `RateSheetMappings.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.billing.rateSheetMappings.<a href="/src/api/resources/billing/resources/rateSheetMappings/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
 <dl>
 <dd>
@@ -4120,6 +4200,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",
@@ -4204,6 +4285,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",
@@ -5132,7 +5214,7 @@ await client.billing.statements.deleteV1("statement_id");
 <dl>
 <dd>
 
-Creates a Stripe checkout session for a subscription with pricing based on the selected plan. | (CreateCheckoutSessionReq) -> (CreateCheckoutSessionRes)
+Creates a Stripe checkout session for a subscription against the Stripe product+price chosen by the frontend. Stripe rejects unknown/archived/mode-mismatched price IDs. Returns 409 `use_create_customer_portal_session` if the org already has an active subscription in Stripe (source of truth -- bypasses any JWT staleness). FE should route those users to POST /billing/create-customer-portal-session/v1 to manage. authz: allowed_org_types=[provider] (shippers cannot subscribe -- they are never gated, paying would be a no-op), min_org_role=administrator (committing the company to recurring charges is a finance decision, not an operator one). | (CreateCheckoutSessionReq) -> (CreateCheckoutSessionRes)
 
 </dd>
 </dl>
@@ -5149,7 +5231,8 @@ Creates a Stripe checkout session for a subscription with pricing based on the s
 
 ```typescript
 await client.billing.stripe.createCheckoutSessionV1({
-    price_name: "courier_ops_100_usd_per_month",
+    product_id: "product_id",
+    price_id: "price_id",
 });
 ```
 
@@ -5185,7 +5268,7 @@ await client.billing.stripe.createCheckoutSessionV1({
 </dl>
 </details>
 
-<details><summary><code>client.billing.stripe.<a href="/src/api/resources/billing/resources/stripe/client/Client.ts">syncStripeToClerkV1</a>() -> boolean</code></summary>
+<details><summary><code>client.billing.stripe.<a href="/src/api/resources/billing/resources/stripe/client/Client.ts">createCustomerPortalSessionV1</a>() -> Chrt.CreateCustomerPortalSessionRes</code></summary>
 <dl>
 <dd>
 
@@ -5197,7 +5280,7 @@ await client.billing.stripe.createCheckoutSessionV1({
 <dl>
 <dd>
 
-Synchronizes subscription data from Stripe to the authentication service for the current user. | () -> (bool)
+Creates a Stripe customer-portal session so the org's admin can self-serve update card / view invoices / cancel subscription. authz: allowed_org_types=[provider], min_org_role=administrator (same gate as create-checkout-session — cancelling/updating-card has the same financial weight as subscribing). Returns 404 `use_create_checkout_session` if the org has no Stripe customer. POST /billing/create-checkout-session/v1 first. | (no body) -> (CreateCustomerPortalSessionRes)
 
 </dd>
 </dl>
@@ -5213,7 +5296,7 @@ Synchronizes subscription data from Stripe to the authentication service for the
 <dd>
 
 ```typescript
-await client.billing.stripe.syncStripeToClerkV1();
+await client.billing.stripe.createCustomerPortalSessionV1();
 ```
 
 </dd>
@@ -6575,6 +6658,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",
@@ -6651,6 +6736,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",
@@ -6727,6 +6814,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",
@@ -8320,6 +8409,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",
@@ -8403,6 +8493,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",
@@ -10391,6 +10482,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,
@@ -10880,6 +10973,7 @@ await client.operations.departments.listV1({
     sort_order: "asc",
     page: 1,
     page_size: 1,
+    filter_department: ["automotive"],
 });
 ```
 
@@ -12885,69 +12979,6 @@ await client.orgs.publicData.getV1();
 </dl>
 </details>
 
-<details><summary><code>client.orgs.publicData.<a href="/src/api/resources/orgs/resources/publicData/client/Client.ts">createV1</a>({ ...params }) -> Chrt.CreateOrgPublicDataRes</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Creates org_public_data and org_private_data documents for the caller's organization using org_type from JWT. | (CreateOrgPublicDataReq) -> (CreateOrgPublicDataRes)
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.orgs.publicData.createV1();
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `Chrt.orgs.CreateOrgPublicDataReq`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `PublicData.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
 <details><summary><code>client.orgs.publicData.<a href="/src/api/resources/orgs/resources/publicData/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
 <dl>
 <dd>
@@ -13714,6 +13745,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",
@@ -15130,6 +15162,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",
@@ -19271,6 +19305,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",
@@ -19357,6 +19392,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",
@@ -20450,6 +20486,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",
@@ -20537,6 +20574,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",

package/dist/cjs/api/resources/orgs/client/requests/SetOrgTypeReq.d.ts

@@ -1,13 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Chrt from "../../../../index.js";
-/**
- * @example
- *     {
- *         org_type: "provider"
- *     }
- */
-export interface SetOrgTypeReq {
-    org_type: Chrt.OrgTypeEnum;
-}

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

@@ -1,7 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface CreateOrgPublicDataRes {
-    org_public_data_inserted_id: string;
-    org_private_data_inserted_id?: string | null;
-}

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

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type PriceNameEnum = "courier_ops_100_usd_per_month" | "courier_ops_500_usd_per_month" | "courier_ops_2500_usd_per_month";
-export declare const PriceNameEnum: {
-    readonly CourierOps100UsdPerMonth: "courier_ops_100_usd_per_month";
-    readonly CourierOps500UsdPerMonth: "courier_ops_500_usd_per_month";
-    readonly CourierOps2500UsdPerMonth: "courier_ops_2500_usd_per_month";
-};

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

@@ -1,11 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PriceNameEnum = void 0;
-exports.PriceNameEnum = {
-    CourierOps100UsdPerMonth: "courier_ops_100_usd_per_month",
-    CourierOps500UsdPerMonth: "courier_ops_500_usd_per_month",
-    CourierOps2500UsdPerMonth: "courier_ops_2500_usd_per_month",
-};

package/dist/esm/api/resources/orgs/client/requests/SetOrgTypeReq.d.mts

@@ -1,13 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Chrt from "../../../../index.mjs";
-/**
- * @example
- *     {
- *         org_type: "provider"
- *     }
- */
-export interface SetOrgTypeReq {
-    org_type: Chrt.OrgTypeEnum;
-}

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

@@ -1,7 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface CreateOrgPublicDataRes {
-    org_public_data_inserted_id: string;
-    org_private_data_inserted_id?: string | null;
-}

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

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type PriceNameEnum = "courier_ops_100_usd_per_month" | "courier_ops_500_usd_per_month" | "courier_ops_2500_usd_per_month";
-export declare const PriceNameEnum: {
-    readonly CourierOps100UsdPerMonth: "courier_ops_100_usd_per_month";
-    readonly CourierOps500UsdPerMonth: "courier_ops_500_usd_per_month";
-    readonly CourierOps2500UsdPerMonth: "courier_ops_2500_usd_per_month";
-};

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

@@ -1,8 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export const PriceNameEnum = {
-    CourierOps100UsdPerMonth: "courier_ops_100_usd_per_month",
-    CourierOps500UsdPerMonth: "courier_ops_500_usd_per_month",
-    CourierOps2500UsdPerMonth: "courier_ops_2500_usd_per_month",
-};