@chrt-inc/typescript-sdk 1.661.0 → 1.662.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/billing/resources/billingLedgerPeriods/client/Client.d.ts +1 -0
- package/dist/cjs/api/resources/billing/resources/billingLedgerPeriods/client/Client.js +1 -0
- package/dist/cjs/api/resources/billing/resources/billingLedgerPeriods/client/requests/BillingLedgerPeriodsListV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/billing/resources/billingLedgers/client/Client.d.ts +2 -1
- package/dist/cjs/api/resources/billing/resources/billingLedgers/client/Client.js +2 -1
- package/dist/cjs/api/resources/billing/resources/billingLedgers/client/requests/BillingLedgerClientCreate1.d.ts +1 -0
- package/dist/cjs/api/resources/billing/resources/billingLedgers/client/requests/BillingLedgerClientUpdate1.d.ts +2 -0
- package/dist/cjs/api/resources/billing/resources/billingLedgers/client/requests/BillingLedgersListV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/Client.d.ts +1 -0
- package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/Client.js +1 -0
- package/dist/cjs/api/resources/billing/resources/lineItemGroups/client/requests/LineItemGroupsListV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/billing/resources/statements/client/Client.d.ts +2 -0
- package/dist/cjs/api/resources/billing/resources/statements/client/Client.js +2 -0
- package/dist/cjs/api/resources/billing/resources/statements/client/requests/StatementsExpandedListV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/billing/resources/statements/client/requests/StatementsListV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/listing/resources/bidThreads/client/Client.d.ts +2 -0
- package/dist/cjs/api/resources/listing/resources/bidThreads/client/Client.js +2 -0
- package/dist/cjs/api/resources/listing/resources/bidThreads/client/requests/BidThreadsListForBidderV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/listing/resources/bidThreads/client/requests/BidThreadsListForListingV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/listing/resources/listings/client/Client.d.ts +6 -0
- package/dist/cjs/api/resources/listing/resources/listings/client/Client.js +6 -0
- package/dist/cjs/api/resources/listing/resources/listings/client/requests/ListingsListByOrgV1Request.d.ts +2 -0
- package/dist/cjs/api/resources/listing/resources/listings/client/requests/ListingsListForDriverBidderV1Request.d.ts +2 -0
- package/dist/cjs/api/resources/listing/resources/listings/client/requests/ListingsListForProviderBidderV1Request.d.ts +2 -0
- package/dist/cjs/api/resources/operations/resources/cases/client/Client.d.ts +77 -0
- package/dist/cjs/api/resources/operations/resources/cases/client/Client.js +315 -0
- package/dist/cjs/api/resources/operations/resources/cases/client/requests/CaseNeedsActionReq.d.ts +12 -0
- package/dist/cjs/api/resources/operations/resources/cases/client/requests/CaseStatusReq.d.ts +13 -0
- package/dist/cjs/api/resources/operations/resources/cases/client/requests/CaseStatusReq.js +5 -0
- package/dist/cjs/api/resources/operations/resources/cases/client/requests/CasesListV1Request.d.ts +2 -0
- package/dist/cjs/api/resources/operations/resources/cases/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/operations/resources/cases/index.d.ts +1 -0
- package/dist/cjs/api/resources/operations/resources/cases/index.js +1 -0
- package/dist/cjs/api/resources/operations/resources/cases/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/operations/resources/cases/resources/index.js +41 -0
- package/dist/cjs/api/resources/operations/resources/cases/resources/s3Objects/client/Client.d.ts +83 -0
- package/dist/cjs/api/resources/operations/resources/cases/resources/s3Objects/client/Client.js +308 -0
- package/dist/cjs/api/resources/operations/resources/cases/resources/s3Objects/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/operations/resources/cases/resources/s3Objects/client/index.js +17 -0
- package/dist/cjs/api/resources/operations/resources/cases/resources/s3Objects/client/requests/BodyPostCasesS3ObjectsAddV1OperationsCasesS3ObjectsAddV1CaseIdPost.d.ts +13 -0
- package/dist/cjs/api/resources/operations/resources/cases/resources/s3Objects/client/requests/BodyPostCasesS3ObjectsAddV1OperationsCasesS3ObjectsAddV1CaseIdPost.js +5 -0
- package/dist/cjs/api/resources/operations/resources/cases/resources/s3Objects/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/operations/resources/cases/resources/s3Objects/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/operations/resources/cases/resources/s3Objects/index.d.ts +1 -0
- package/dist/cjs/api/resources/operations/resources/cases/resources/s3Objects/index.js +17 -0
- package/dist/cjs/api/resources/operations/resources/departments/client/Client.d.ts +2 -1
- package/dist/cjs/api/resources/operations/resources/departments/client/Client.js +2 -1
- package/dist/cjs/api/resources/operations/resources/departments/client/requests/DepartmentsListV1Request.d.ts +2 -1
- package/dist/cjs/api/resources/orgs/client/Client.d.ts +2 -1
- package/dist/cjs/api/resources/orgs/client/Client.js +2 -1
- package/dist/cjs/api/resources/orgs/client/requests/OrgsListMembersV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/orgs/resources/orgProfiles/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/orgs/resources/orgProfiles/client/Client.js +1 -1
- package/dist/cjs/api/resources/shipping/resources/drivers/client/Client.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/client/Client.js +1 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/client/requests/DriversListOrgMembersAndDriversV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/Client.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/Client.js +2 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/requests/OrderSchedulesListV1Request.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/Client.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/Client.js +2 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForCoordinatorOperatorsV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForShipperOperatorsV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/taskGroups/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/taskGroups/client/Client.js +1 -1
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.js +2 -0
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForDriverForExecutorV1Request.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForExecutorOperatorsV1Request.d.ts +1 -0
- package/dist/cjs/api/types/BillingLedger1.d.ts +1 -0
- package/dist/cjs/api/types/Caller.d.ts +4 -3
- package/dist/cjs/api/types/CallerCredentialTypeEnum.d.ts +2 -2
- package/dist/cjs/api/types/CallerCredentialTypeEnum.js +1 -1
- package/dist/cjs/api/types/Case1.d.ts +4 -0
- package/dist/cjs/api/types/CaseMessage1.d.ts +1 -0
- package/dist/cjs/api/types/CaseS3ObjectMetadata1.d.ts +19 -0
- package/dist/cjs/api/types/CaseS3ObjectMetadata1.js +5 -0
- package/dist/cjs/api/types/InternalDelegationTokenReq.d.ts +9 -0
- package/dist/cjs/api/types/InternalDelegationTokenReq.js +5 -0
- package/dist/cjs/api/types/InternalDelegationTokenRes.d.ts +6 -0
- package/dist/cjs/api/types/InternalDelegationTokenRes.js +5 -0
- package/dist/cjs/api/types/OrgInfoResponse.d.ts +5 -5
- package/dist/cjs/api/types/OrgPrivateData1.d.ts +1 -0
- package/dist/cjs/api/types/OrgRoleEnum.d.ts +7 -13
- package/dist/cjs/api/types/OrgRoleEnum.js +2 -2
- package/dist/cjs/api/types/UserPrivateData1.d.ts +1 -0
- package/dist/cjs/api/types/WorkflowActorContext.d.ts +14 -0
- package/dist/cjs/api/types/WorkflowActorContext.js +5 -0
- package/dist/cjs/api/types/index.d.ts +4 -1
- package/dist/cjs/api/types/index.js +4 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/resources/billing/resources/billingLedgerPeriods/client/Client.d.mts +1 -0
- package/dist/esm/api/resources/billing/resources/billingLedgerPeriods/client/Client.mjs +1 -0
- package/dist/esm/api/resources/billing/resources/billingLedgerPeriods/client/requests/BillingLedgerPeriodsListV1Request.d.mts +1 -0
- package/dist/esm/api/resources/billing/resources/billingLedgers/client/Client.d.mts +2 -1
- package/dist/esm/api/resources/billing/resources/billingLedgers/client/Client.mjs +2 -1
- package/dist/esm/api/resources/billing/resources/billingLedgers/client/requests/BillingLedgerClientCreate1.d.mts +1 -0
- package/dist/esm/api/resources/billing/resources/billingLedgers/client/requests/BillingLedgerClientUpdate1.d.mts +2 -0
- package/dist/esm/api/resources/billing/resources/billingLedgers/client/requests/BillingLedgersListV1Request.d.mts +1 -0
- package/dist/esm/api/resources/billing/resources/lineItemGroups/client/Client.d.mts +1 -0
- package/dist/esm/api/resources/billing/resources/lineItemGroups/client/Client.mjs +1 -0
- package/dist/esm/api/resources/billing/resources/lineItemGroups/client/requests/LineItemGroupsListV1Request.d.mts +1 -0
- package/dist/esm/api/resources/billing/resources/statements/client/Client.d.mts +2 -0
- package/dist/esm/api/resources/billing/resources/statements/client/Client.mjs +2 -0
- package/dist/esm/api/resources/billing/resources/statements/client/requests/StatementsExpandedListV1Request.d.mts +1 -0
- package/dist/esm/api/resources/billing/resources/statements/client/requests/StatementsListV1Request.d.mts +1 -0
- package/dist/esm/api/resources/listing/resources/bidThreads/client/Client.d.mts +2 -0
- package/dist/esm/api/resources/listing/resources/bidThreads/client/Client.mjs +2 -0
- package/dist/esm/api/resources/listing/resources/bidThreads/client/requests/BidThreadsListForBidderV1Request.d.mts +1 -0
- package/dist/esm/api/resources/listing/resources/bidThreads/client/requests/BidThreadsListForListingV1Request.d.mts +1 -0
- package/dist/esm/api/resources/listing/resources/listings/client/Client.d.mts +6 -0
- package/dist/esm/api/resources/listing/resources/listings/client/Client.mjs +6 -0
- package/dist/esm/api/resources/listing/resources/listings/client/requests/ListingsListByOrgV1Request.d.mts +2 -0
- package/dist/esm/api/resources/listing/resources/listings/client/requests/ListingsListForDriverBidderV1Request.d.mts +2 -0
- package/dist/esm/api/resources/listing/resources/listings/client/requests/ListingsListForProviderBidderV1Request.d.mts +2 -0
- package/dist/esm/api/resources/operations/resources/cases/client/Client.d.mts +77 -0
- package/dist/esm/api/resources/operations/resources/cases/client/Client.mjs +315 -0
- package/dist/esm/api/resources/operations/resources/cases/client/requests/CaseNeedsActionReq.d.mts +12 -0
- package/dist/esm/api/resources/operations/resources/cases/client/requests/CaseStatusReq.d.mts +13 -0
- package/dist/esm/api/resources/operations/resources/cases/client/requests/CaseStatusReq.mjs +4 -0
- package/dist/esm/api/resources/operations/resources/cases/client/requests/CasesListV1Request.d.mts +2 -0
- package/dist/esm/api/resources/operations/resources/cases/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/operations/resources/cases/index.d.mts +1 -0
- package/dist/esm/api/resources/operations/resources/cases/index.mjs +1 -0
- package/dist/esm/api/resources/operations/resources/cases/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/operations/resources/cases/resources/index.mjs +2 -0
- package/dist/esm/api/resources/operations/resources/cases/resources/s3Objects/client/Client.d.mts +83 -0
- package/dist/esm/api/resources/operations/resources/cases/resources/s3Objects/client/Client.mjs +271 -0
- package/dist/esm/api/resources/operations/resources/cases/resources/s3Objects/client/index.d.mts +2 -0
- package/dist/esm/api/resources/operations/resources/cases/resources/s3Objects/client/index.mjs +1 -0
- package/dist/esm/api/resources/operations/resources/cases/resources/s3Objects/client/requests/BodyPostCasesS3ObjectsAddV1OperationsCasesS3ObjectsAddV1CaseIdPost.d.mts +13 -0
- package/dist/esm/api/resources/operations/resources/cases/resources/s3Objects/client/requests/BodyPostCasesS3ObjectsAddV1OperationsCasesS3ObjectsAddV1CaseIdPost.mjs +4 -0
- package/dist/esm/api/resources/operations/resources/cases/resources/s3Objects/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/operations/resources/cases/resources/s3Objects/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/operations/resources/cases/resources/s3Objects/index.d.mts +1 -0
- package/dist/esm/api/resources/operations/resources/cases/resources/s3Objects/index.mjs +1 -0
- package/dist/esm/api/resources/operations/resources/departments/client/Client.d.mts +2 -1
- package/dist/esm/api/resources/operations/resources/departments/client/Client.mjs +2 -1
- package/dist/esm/api/resources/operations/resources/departments/client/requests/DepartmentsListV1Request.d.mts +2 -1
- package/dist/esm/api/resources/orgs/client/Client.d.mts +2 -1
- package/dist/esm/api/resources/orgs/client/Client.mjs +2 -1
- package/dist/esm/api/resources/orgs/client/requests/OrgsListMembersV1Request.d.mts +1 -0
- package/dist/esm/api/resources/orgs/resources/orgProfiles/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/orgs/resources/orgProfiles/client/Client.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/drivers/client/Client.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/drivers/client/Client.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/drivers/client/requests/DriversListOrgMembersAndDriversV1Request.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/client/Client.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/client/Client.mjs +2 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/client/requests/OrderSchedulesListV1Request.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.mjs +2 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForCoordinatorOperatorsV1Request.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForShipperOperatorsV1Request.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/taskGroups/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/client/Client.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.mjs +2 -0
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForDriverForExecutorV1Request.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForExecutorOperatorsV1Request.d.mts +1 -0
- package/dist/esm/api/types/BillingLedger1.d.mts +1 -0
- package/dist/esm/api/types/Caller.d.mts +4 -3
- package/dist/esm/api/types/CallerCredentialTypeEnum.d.mts +2 -2
- package/dist/esm/api/types/CallerCredentialTypeEnum.mjs +1 -1
- package/dist/esm/api/types/Case1.d.mts +4 -0
- package/dist/esm/api/types/CaseMessage1.d.mts +1 -0
- package/dist/esm/api/types/CaseS3ObjectMetadata1.d.mts +19 -0
- package/dist/esm/api/types/CaseS3ObjectMetadata1.mjs +4 -0
- package/dist/esm/api/types/InternalDelegationTokenReq.d.mts +9 -0
- package/dist/esm/api/types/InternalDelegationTokenReq.mjs +4 -0
- package/dist/esm/api/types/InternalDelegationTokenRes.d.mts +6 -0
- package/dist/esm/api/types/InternalDelegationTokenRes.mjs +4 -0
- package/dist/esm/api/types/OrgInfoResponse.d.mts +5 -5
- package/dist/esm/api/types/OrgPrivateData1.d.mts +1 -0
- package/dist/esm/api/types/OrgRoleEnum.d.mts +7 -13
- package/dist/esm/api/types/OrgRoleEnum.mjs +2 -2
- package/dist/esm/api/types/UserPrivateData1.d.mts +1 -0
- package/dist/esm/api/types/WorkflowActorContext.d.mts +14 -0
- package/dist/esm/api/types/WorkflowActorContext.mjs +4 -0
- package/dist/esm/api/types/index.d.mts +4 -1
- package/dist/esm/api/types/index.mjs +4 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +694 -63
- package/dist/cjs/api/types/ClerkOrgData.d.ts +0 -12
- package/dist/esm/api/types/ClerkOrgData.d.mts +0 -12
- /package/dist/cjs/api/{types/ClerkOrgData.js → resources/operations/resources/cases/client/requests/CaseNeedsActionReq.js} +0 -0
- /package/dist/esm/api/{types/ClerkOrgData.mjs → resources/operations/resources/cases/client/requests/CaseNeedsActionReq.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -86,6 +86,7 @@ Lists all members of the caller's organization with their roles and details. Sup
|
|
|
86
86
|
|
|
87
87
|
```typescript
|
|
88
88
|
await client.orgs.listMembersV1({
|
|
89
|
+
filter_role: ["owner"],
|
|
89
90
|
sort_by: "first_name",
|
|
90
91
|
sort_order: "asc",
|
|
91
92
|
page: 1,
|
|
@@ -138,7 +139,7 @@ await client.orgs.listMembersV1({
|
|
|
138
139
|
<dl>
|
|
139
140
|
<dd>
|
|
140
141
|
|
|
141
|
-
Single onboarding entry point. Sets `org_type` in
|
|
142
|
+
Single onboarding entry point. Sets `org_type` in WorkOS JWT 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)
|
|
142
143
|
|
|
143
144
|
</dd>
|
|
144
145
|
</dl>
|
|
@@ -480,6 +481,7 @@ await client.billing.billingLedgers.listV1({
|
|
|
480
481
|
sort_order: "asc",
|
|
481
482
|
page: 1,
|
|
482
483
|
page_size: 1,
|
|
484
|
+
filter_status: ["active"],
|
|
483
485
|
filter_task_group_type: "chrt_ground_provider",
|
|
484
486
|
filter_payment_origin_org_id: "filter_payment_origin_org_id",
|
|
485
487
|
filter_payment_destination_org_id: "filter_payment_destination_org_id",
|
|
@@ -595,7 +597,7 @@ await client.billing.billingLedgers.createV1({
|
|
|
595
597
|
<dl>
|
|
596
598
|
<dd>
|
|
597
599
|
|
|
598
|
-
Updates a billing ledger's `comments`. Cycle and rate are per-period values supplied at `billing_ledger_periods/open/v1` time; the ledger does not carry them. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[billing_ledger_owner_operators] | (BillingLedgerClientUpdate1) -> (bool)
|
|
600
|
+
Updates a billing ledger's `name` and `comments`. Cycle and rate are per-period values supplied at `billing_ledger_periods/open/v1` time; the ledger does not carry them. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[billing_ledger_owner_operators] | (BillingLedgerClientUpdate1) -> (bool)
|
|
599
601
|
|
|
600
602
|
</dd>
|
|
601
603
|
</dl>
|
|
@@ -817,6 +819,7 @@ await client.billing.billingLedgerPeriods.listV1({
|
|
|
817
819
|
page_size: 1,
|
|
818
820
|
filter_billing_ledger_id: "filter_billing_ledger_id",
|
|
819
821
|
filter_owned_by_org_id: "filter_owned_by_org_id",
|
|
822
|
+
filter_status: ["open"],
|
|
820
823
|
filter_statement_id: "filter_statement_id",
|
|
821
824
|
filter_attached_to_statement: true,
|
|
822
825
|
filter_period_end_at_timestamp_before: "2024-01-15T09:30:00Z",
|
|
@@ -1224,6 +1227,7 @@ await client.billing.lineItemGroups.listV1({
|
|
|
1224
1227
|
sort_order: "asc",
|
|
1225
1228
|
page: 1,
|
|
1226
1229
|
page_size: 1,
|
|
1230
|
+
filter_status: ["staged"],
|
|
1227
1231
|
filter_task_group_id: "filter_task_group_id",
|
|
1228
1232
|
filter_order_id: "filter_order_id",
|
|
1229
1233
|
filter_order_short_id: "filter_order_short_id",
|
|
@@ -4259,6 +4263,7 @@ await client.billing.statements.listV1({
|
|
|
4259
4263
|
sort_order: "asc",
|
|
4260
4264
|
page: 1,
|
|
4261
4265
|
page_size: 1,
|
|
4266
|
+
filter_status: ["staged"],
|
|
4262
4267
|
filter_settlement_type: "stripe_connect",
|
|
4263
4268
|
filter_order_id: "filter_order_id",
|
|
4264
4269
|
filter_order_short_id: "filter_order_short_id",
|
|
@@ -4343,6 +4348,7 @@ await client.billing.statements.expandedListV1({
|
|
|
4343
4348
|
sort_order: "asc",
|
|
4344
4349
|
page: 1,
|
|
4345
4350
|
page_size: 1,
|
|
4351
|
+
filter_status: ["staged"],
|
|
4346
4352
|
filter_settlement_type: "stripe_connect",
|
|
4347
4353
|
filter_order_id: "filter_order_id",
|
|
4348
4354
|
filter_order_short_id: "filter_order_short_id",
|
|
@@ -6979,6 +6985,8 @@ await client.listing.listings.listByOrgV1({
|
|
|
6979
6985
|
sort_order: "asc",
|
|
6980
6986
|
page: 1,
|
|
6981
6987
|
page_size: 1,
|
|
6988
|
+
filter_status: ["open"],
|
|
6989
|
+
filter_type: ["dispatch"],
|
|
6982
6990
|
filter_task_group_id: "filter_task_group_id",
|
|
6983
6991
|
filter_order_id: "filter_order_id",
|
|
6984
6992
|
filter_created_by_org_id: "filter_created_by_org_id",
|
|
@@ -7055,6 +7063,8 @@ await client.listing.listings.listForProviderBidderV1({
|
|
|
7055
7063
|
sort_order: "asc",
|
|
7056
7064
|
page: 1,
|
|
7057
7065
|
page_size: 1,
|
|
7066
|
+
filter_status: ["open"],
|
|
7067
|
+
filter_type: ["dispatch"],
|
|
7058
7068
|
filter_task_group_id: "filter_task_group_id",
|
|
7059
7069
|
filter_order_id: "filter_order_id",
|
|
7060
7070
|
filter_created_by_org_id: "filter_created_by_org_id",
|
|
@@ -7131,6 +7141,8 @@ await client.listing.listings.listForDriverBidderV1({
|
|
|
7131
7141
|
sort_order: "asc",
|
|
7132
7142
|
page: 1,
|
|
7133
7143
|
page_size: 1,
|
|
7144
|
+
filter_status: ["open"],
|
|
7145
|
+
filter_type: ["dispatch"],
|
|
7134
7146
|
filter_task_group_id: "filter_task_group_id",
|
|
7135
7147
|
filter_order_id: "filter_order_id",
|
|
7136
7148
|
filter_created_by_org_id: "filter_created_by_org_id",
|
|
@@ -8724,6 +8736,7 @@ await client.listing.bidThreads.listForListingV1("listing_id", {
|
|
|
8724
8736
|
sort_order: "asc",
|
|
8725
8737
|
page: 1,
|
|
8726
8738
|
page_size: 1,
|
|
8739
|
+
filter_status: ["open"],
|
|
8727
8740
|
filter_listing_id: "filter_listing_id",
|
|
8728
8741
|
filter_bidder_provider_org_id: "filter_bidder_provider_org_id",
|
|
8729
8742
|
filter_bidder_driver_id: "filter_bidder_driver_id",
|
|
@@ -8807,6 +8820,7 @@ await client.listing.bidThreads.listForBidderV1({
|
|
|
8807
8820
|
sort_order: "asc",
|
|
8808
8821
|
page: 1,
|
|
8809
8822
|
page_size: 1,
|
|
8823
|
+
filter_status: ["open"],
|
|
8810
8824
|
filter_listing_id: "filter_listing_id",
|
|
8811
8825
|
filter_bidder_provider_org_id: "filter_bidder_provider_org_id",
|
|
8812
8826
|
filter_bidder_driver_id: "filter_bidder_driver_id",
|
|
@@ -10795,6 +10809,8 @@ await client.operations.cases.listV1({
|
|
|
10795
10809
|
sort_order: "asc",
|
|
10796
10810
|
page: 1,
|
|
10797
10811
|
page_size: 1,
|
|
10812
|
+
filter_status: ["open"],
|
|
10813
|
+
filter_department_id: ["filter_department_id"],
|
|
10798
10814
|
filter_assigned_operator_user_id: "filter_assigned_operator_user_id",
|
|
10799
10815
|
filter_needs_action: true,
|
|
10800
10816
|
filter_unassigned: true,
|
|
@@ -11030,7 +11046,7 @@ await client.operations.cases.getByOrderV1("order_id");
|
|
|
11030
11046
|
</dl>
|
|
11031
11047
|
</details>
|
|
11032
11048
|
|
|
11033
|
-
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">
|
|
11049
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">getByOrderRefV1</a>(orderRef) -> Chrt.Case1</code></summary>
|
|
11034
11050
|
<dl>
|
|
11035
11051
|
<dd>
|
|
11036
11052
|
|
|
@@ -11042,7 +11058,7 @@ await client.operations.cases.getByOrderV1("order_id");
|
|
|
11042
11058
|
<dl>
|
|
11043
11059
|
<dd>
|
|
11044
11060
|
|
|
11045
|
-
|
|
11061
|
+
Retrieves the case for a given order ID, short ID, or off-chrt reference ID. | authz: min_org_role=operator | () -> (Case1)
|
|
11046
11062
|
|
|
11047
11063
|
</dd>
|
|
11048
11064
|
</dl>
|
|
@@ -11058,9 +11074,7 @@ Adds operator(s) to a case. | authz: min_org_role=operator | (CaseAssignReq) ->
|
|
|
11058
11074
|
<dd>
|
|
11059
11075
|
|
|
11060
11076
|
```typescript
|
|
11061
|
-
await client.operations.cases.
|
|
11062
|
-
operator_user_ids: ["operator_user_ids"],
|
|
11063
|
-
});
|
|
11077
|
+
await client.operations.cases.getByOrderRefV1("order_ref");
|
|
11064
11078
|
```
|
|
11065
11079
|
|
|
11066
11080
|
</dd>
|
|
@@ -11076,7 +11090,7 @@ await client.operations.cases.assignV1("case_id", {
|
|
|
11076
11090
|
<dl>
|
|
11077
11091
|
<dd>
|
|
11078
11092
|
|
|
11079
|
-
**
|
|
11093
|
+
**orderRef:** `string` — Order ID, short ID, or off-chrt reference ID
|
|
11080
11094
|
|
|
11081
11095
|
</dd>
|
|
11082
11096
|
</dl>
|
|
@@ -11084,7 +11098,62 @@ await client.operations.cases.assignV1("case_id", {
|
|
|
11084
11098
|
<dl>
|
|
11085
11099
|
<dd>
|
|
11086
11100
|
|
|
11087
|
-
**
|
|
11101
|
+
**requestOptions:** `Cases.RequestOptions`
|
|
11102
|
+
|
|
11103
|
+
</dd>
|
|
11104
|
+
</dl>
|
|
11105
|
+
</dd>
|
|
11106
|
+
</dl>
|
|
11107
|
+
|
|
11108
|
+
</dd>
|
|
11109
|
+
</dl>
|
|
11110
|
+
</details>
|
|
11111
|
+
|
|
11112
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">getByOrderShortIdV1</a>(orderShortId) -> Chrt.Case1</code></summary>
|
|
11113
|
+
<dl>
|
|
11114
|
+
<dd>
|
|
11115
|
+
|
|
11116
|
+
#### 📝 Description
|
|
11117
|
+
|
|
11118
|
+
<dl>
|
|
11119
|
+
<dd>
|
|
11120
|
+
|
|
11121
|
+
<dl>
|
|
11122
|
+
<dd>
|
|
11123
|
+
|
|
11124
|
+
Retrieves the case for a given order short ID. | authz: min_org_role=operator | () -> (Case1)
|
|
11125
|
+
|
|
11126
|
+
</dd>
|
|
11127
|
+
</dl>
|
|
11128
|
+
</dd>
|
|
11129
|
+
</dl>
|
|
11130
|
+
|
|
11131
|
+
#### 🔌 Usage
|
|
11132
|
+
|
|
11133
|
+
<dl>
|
|
11134
|
+
<dd>
|
|
11135
|
+
|
|
11136
|
+
<dl>
|
|
11137
|
+
<dd>
|
|
11138
|
+
|
|
11139
|
+
```typescript
|
|
11140
|
+
await client.operations.cases.getByOrderShortIdV1("order_short_id");
|
|
11141
|
+
```
|
|
11142
|
+
|
|
11143
|
+
</dd>
|
|
11144
|
+
</dl>
|
|
11145
|
+
</dd>
|
|
11146
|
+
</dl>
|
|
11147
|
+
|
|
11148
|
+
#### ⚙️ Parameters
|
|
11149
|
+
|
|
11150
|
+
<dl>
|
|
11151
|
+
<dd>
|
|
11152
|
+
|
|
11153
|
+
<dl>
|
|
11154
|
+
<dd>
|
|
11155
|
+
|
|
11156
|
+
**orderShortId:** `string`
|
|
11088
11157
|
|
|
11089
11158
|
</dd>
|
|
11090
11159
|
</dl>
|
|
@@ -11103,7 +11172,7 @@ await client.operations.cases.assignV1("case_id", {
|
|
|
11103
11172
|
</dl>
|
|
11104
11173
|
</details>
|
|
11105
11174
|
|
|
11106
|
-
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">
|
|
11175
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">updateNeedsActionV1</a>(caseId, { ...params }) -> boolean</code></summary>
|
|
11107
11176
|
<dl>
|
|
11108
11177
|
<dd>
|
|
11109
11178
|
|
|
@@ -11115,7 +11184,7 @@ await client.operations.cases.assignV1("case_id", {
|
|
|
11115
11184
|
<dl>
|
|
11116
11185
|
<dd>
|
|
11117
11186
|
|
|
11118
|
-
|
|
11187
|
+
Updates whether a case needs action. | authz: min_org_role=operator | (CaseNeedsActionReq) -> (bool)
|
|
11119
11188
|
|
|
11120
11189
|
</dd>
|
|
11121
11190
|
</dl>
|
|
@@ -11131,8 +11200,8 @@ Removes operator(s) from a case. | authz: min_org_role=operator | (CaseUnassignR
|
|
|
11131
11200
|
<dd>
|
|
11132
11201
|
|
|
11133
11202
|
```typescript
|
|
11134
|
-
await client.operations.cases.
|
|
11135
|
-
|
|
11203
|
+
await client.operations.cases.updateNeedsActionV1("case_id", {
|
|
11204
|
+
needs_action: true,
|
|
11136
11205
|
});
|
|
11137
11206
|
```
|
|
11138
11207
|
|
|
@@ -11157,7 +11226,7 @@ await client.operations.cases.unassignV1("case_id", {
|
|
|
11157
11226
|
<dl>
|
|
11158
11227
|
<dd>
|
|
11159
11228
|
|
|
11160
|
-
**request:** `Chrt.operations.
|
|
11229
|
+
**request:** `Chrt.operations.CaseNeedsActionReq`
|
|
11161
11230
|
|
|
11162
11231
|
</dd>
|
|
11163
11232
|
</dl>
|
|
@@ -11176,7 +11245,7 @@ await client.operations.cases.unassignV1("case_id", {
|
|
|
11176
11245
|
</dl>
|
|
11177
11246
|
</details>
|
|
11178
11247
|
|
|
11179
|
-
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">
|
|
11248
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">updateStatusV1</a>(caseId, { ...params }) -> boolean</code></summary>
|
|
11180
11249
|
<dl>
|
|
11181
11250
|
<dd>
|
|
11182
11251
|
|
|
@@ -11188,7 +11257,7 @@ await client.operations.cases.unassignV1("case_id", {
|
|
|
11188
11257
|
<dl>
|
|
11189
11258
|
<dd>
|
|
11190
11259
|
|
|
11191
|
-
|
|
11260
|
+
Updates a case's status. Closing a case also clears needs_action. | authz: min_org_role=operator | (CaseStatusReq) -> (bool)
|
|
11192
11261
|
|
|
11193
11262
|
</dd>
|
|
11194
11263
|
</dl>
|
|
@@ -11204,8 +11273,8 @@ Appends a message to a case. | authz: min_org_role=operator | (CaseAddMessageReq
|
|
|
11204
11273
|
<dd>
|
|
11205
11274
|
|
|
11206
11275
|
```typescript
|
|
11207
|
-
await client.operations.cases.
|
|
11208
|
-
|
|
11276
|
+
await client.operations.cases.updateStatusV1("case_id", {
|
|
11277
|
+
status: "open",
|
|
11209
11278
|
});
|
|
11210
11279
|
```
|
|
11211
11280
|
|
|
@@ -11230,7 +11299,7 @@ await client.operations.cases.addMessageV1("case_id", {
|
|
|
11230
11299
|
<dl>
|
|
11231
11300
|
<dd>
|
|
11232
11301
|
|
|
11233
|
-
**request:** `Chrt.operations.
|
|
11302
|
+
**request:** `Chrt.operations.CaseStatusReq`
|
|
11234
11303
|
|
|
11235
11304
|
</dd>
|
|
11236
11305
|
</dl>
|
|
@@ -11249,9 +11318,7 @@ await client.operations.cases.addMessageV1("case_id", {
|
|
|
11249
11318
|
</dl>
|
|
11250
11319
|
</details>
|
|
11251
11320
|
|
|
11252
|
-
|
|
11253
|
-
|
|
11254
|
-
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">listV1</a>({ ...params }) -> Chrt.DepartmentListRes</code></summary>
|
|
11321
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">assignV1</a>(caseId, { ...params }) -> boolean</code></summary>
|
|
11255
11322
|
<dl>
|
|
11256
11323
|
<dd>
|
|
11257
11324
|
|
|
@@ -11263,7 +11330,7 @@ await client.operations.cases.addMessageV1("case_id", {
|
|
|
11263
11330
|
<dl>
|
|
11264
11331
|
<dd>
|
|
11265
11332
|
|
|
11266
|
-
|
|
11333
|
+
Adds operator(s) to a case. | authz: min_org_role=operator | (CaseAssignReq) -> (bool)
|
|
11267
11334
|
|
|
11268
11335
|
</dd>
|
|
11269
11336
|
</dl>
|
|
@@ -11279,11 +11346,8 @@ Lists department configurations for the caller's organization. | authz: min_org_
|
|
|
11279
11346
|
<dd>
|
|
11280
11347
|
|
|
11281
11348
|
```typescript
|
|
11282
|
-
await client.operations.
|
|
11283
|
-
|
|
11284
|
-
sort_order: "asc",
|
|
11285
|
-
page: 1,
|
|
11286
|
-
page_size: 1,
|
|
11349
|
+
await client.operations.cases.assignV1("case_id", {
|
|
11350
|
+
operator_user_ids: ["operator_user_ids"],
|
|
11287
11351
|
});
|
|
11288
11352
|
```
|
|
11289
11353
|
|
|
@@ -11300,7 +11364,7 @@ await client.operations.departments.listV1({
|
|
|
11300
11364
|
<dl>
|
|
11301
11365
|
<dd>
|
|
11302
11366
|
|
|
11303
|
-
**
|
|
11367
|
+
**caseId:** `string`
|
|
11304
11368
|
|
|
11305
11369
|
</dd>
|
|
11306
11370
|
</dl>
|
|
@@ -11308,7 +11372,15 @@ await client.operations.departments.listV1({
|
|
|
11308
11372
|
<dl>
|
|
11309
11373
|
<dd>
|
|
11310
11374
|
|
|
11311
|
-
**
|
|
11375
|
+
**request:** `Chrt.operations.CaseAssignReq`
|
|
11376
|
+
|
|
11377
|
+
</dd>
|
|
11378
|
+
</dl>
|
|
11379
|
+
|
|
11380
|
+
<dl>
|
|
11381
|
+
<dd>
|
|
11382
|
+
|
|
11383
|
+
**requestOptions:** `Cases.RequestOptions`
|
|
11312
11384
|
|
|
11313
11385
|
</dd>
|
|
11314
11386
|
</dl>
|
|
@@ -11319,7 +11391,7 @@ await client.operations.departments.listV1({
|
|
|
11319
11391
|
</dl>
|
|
11320
11392
|
</details>
|
|
11321
11393
|
|
|
11322
|
-
<details><summary><code>client.operations.
|
|
11394
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">unassignV1</a>(caseId, { ...params }) -> boolean</code></summary>
|
|
11323
11395
|
<dl>
|
|
11324
11396
|
<dd>
|
|
11325
11397
|
|
|
@@ -11331,7 +11403,7 @@ await client.operations.departments.listV1({
|
|
|
11331
11403
|
<dl>
|
|
11332
11404
|
<dd>
|
|
11333
11405
|
|
|
11334
|
-
|
|
11406
|
+
Removes operator(s) from a case. | authz: min_org_role=operator | (CaseUnassignReq) -> (bool)
|
|
11335
11407
|
|
|
11336
11408
|
</dd>
|
|
11337
11409
|
</dl>
|
|
@@ -11347,7 +11419,9 @@ Retrieves a single department configuration. | authz: min_org_role=operator | ()
|
|
|
11347
11419
|
<dd>
|
|
11348
11420
|
|
|
11349
11421
|
```typescript
|
|
11350
|
-
await client.operations.
|
|
11422
|
+
await client.operations.cases.unassignV1("case_id", {
|
|
11423
|
+
operator_user_ids: ["operator_user_ids"],
|
|
11424
|
+
});
|
|
11351
11425
|
```
|
|
11352
11426
|
|
|
11353
11427
|
</dd>
|
|
@@ -11363,7 +11437,7 @@ await client.operations.departments.getV1("department_id");
|
|
|
11363
11437
|
<dl>
|
|
11364
11438
|
<dd>
|
|
11365
11439
|
|
|
11366
|
-
**
|
|
11440
|
+
**caseId:** `string`
|
|
11367
11441
|
|
|
11368
11442
|
</dd>
|
|
11369
11443
|
</dl>
|
|
@@ -11371,7 +11445,15 @@ await client.operations.departments.getV1("department_id");
|
|
|
11371
11445
|
<dl>
|
|
11372
11446
|
<dd>
|
|
11373
11447
|
|
|
11374
|
-
**
|
|
11448
|
+
**request:** `Chrt.operations.CaseUnassignReq`
|
|
11449
|
+
|
|
11450
|
+
</dd>
|
|
11451
|
+
</dl>
|
|
11452
|
+
|
|
11453
|
+
<dl>
|
|
11454
|
+
<dd>
|
|
11455
|
+
|
|
11456
|
+
**requestOptions:** `Cases.RequestOptions`
|
|
11375
11457
|
|
|
11376
11458
|
</dd>
|
|
11377
11459
|
</dl>
|
|
@@ -11382,7 +11464,7 @@ await client.operations.departments.getV1("department_id");
|
|
|
11382
11464
|
</dl>
|
|
11383
11465
|
</details>
|
|
11384
11466
|
|
|
11385
|
-
<details><summary><code>client.operations.
|
|
11467
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">addMessageV1</a>(caseId, { ...params }) -> boolean</code></summary>
|
|
11386
11468
|
<dl>
|
|
11387
11469
|
<dd>
|
|
11388
11470
|
|
|
@@ -11394,7 +11476,7 @@ await client.operations.departments.getV1("department_id");
|
|
|
11394
11476
|
<dl>
|
|
11395
11477
|
<dd>
|
|
11396
11478
|
|
|
11397
|
-
|
|
11479
|
+
Appends a message to a case. | authz: min_org_role=operator | (CaseAddMessageReq) -> (bool)
|
|
11398
11480
|
|
|
11399
11481
|
</dd>
|
|
11400
11482
|
</dl>
|
|
@@ -11410,7 +11492,9 @@ Deletes a department configuration. | authz: min_org_role=administrator | () ->
|
|
|
11410
11492
|
<dd>
|
|
11411
11493
|
|
|
11412
11494
|
```typescript
|
|
11413
|
-
await client.operations.
|
|
11495
|
+
await client.operations.cases.addMessageV1("case_id", {
|
|
11496
|
+
message: "message",
|
|
11497
|
+
});
|
|
11414
11498
|
```
|
|
11415
11499
|
|
|
11416
11500
|
</dd>
|
|
@@ -11426,7 +11510,7 @@ await client.operations.departments.deleteV1("department_id");
|
|
|
11426
11510
|
<dl>
|
|
11427
11511
|
<dd>
|
|
11428
11512
|
|
|
11429
|
-
**
|
|
11513
|
+
**caseId:** `string`
|
|
11430
11514
|
|
|
11431
11515
|
</dd>
|
|
11432
11516
|
</dl>
|
|
@@ -11434,7 +11518,15 @@ await client.operations.departments.deleteV1("department_id");
|
|
|
11434
11518
|
<dl>
|
|
11435
11519
|
<dd>
|
|
11436
11520
|
|
|
11437
|
-
**
|
|
11521
|
+
**request:** `Chrt.operations.CaseAddMessageReq`
|
|
11522
|
+
|
|
11523
|
+
</dd>
|
|
11524
|
+
</dl>
|
|
11525
|
+
|
|
11526
|
+
<dl>
|
|
11527
|
+
<dd>
|
|
11528
|
+
|
|
11529
|
+
**requestOptions:** `Cases.RequestOptions`
|
|
11438
11530
|
|
|
11439
11531
|
</dd>
|
|
11440
11532
|
</dl>
|
|
@@ -11445,7 +11537,7 @@ await client.operations.departments.deleteV1("department_id");
|
|
|
11445
11537
|
</dl>
|
|
11446
11538
|
</details>
|
|
11447
11539
|
|
|
11448
|
-
<details><summary><code>client.operations.
|
|
11540
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">deleteMessageV1</a>(caseId, messageId) -> boolean</code></summary>
|
|
11449
11541
|
<dl>
|
|
11450
11542
|
<dd>
|
|
11451
11543
|
|
|
@@ -11457,7 +11549,7 @@ await client.operations.departments.deleteV1("department_id");
|
|
|
11457
11549
|
<dl>
|
|
11458
11550
|
<dd>
|
|
11459
11551
|
|
|
11460
|
-
|
|
11552
|
+
Deletes a message from a case. | authz: min_org_role=operator | () -> (bool)
|
|
11461
11553
|
|
|
11462
11554
|
</dd>
|
|
11463
11555
|
</dl>
|
|
@@ -11473,7 +11565,7 @@ Updates a department configuration. | authz: min_org_role=administrator | (Depar
|
|
|
11473
11565
|
<dd>
|
|
11474
11566
|
|
|
11475
11567
|
```typescript
|
|
11476
|
-
await client.operations.
|
|
11568
|
+
await client.operations.cases.deleteMessageV1("case_id", "message_id");
|
|
11477
11569
|
```
|
|
11478
11570
|
|
|
11479
11571
|
</dd>
|
|
@@ -11489,7 +11581,7 @@ await client.operations.departments.updateV1("department_id");
|
|
|
11489
11581
|
<dl>
|
|
11490
11582
|
<dd>
|
|
11491
11583
|
|
|
11492
|
-
**
|
|
11584
|
+
**caseId:** `string`
|
|
11493
11585
|
|
|
11494
11586
|
</dd>
|
|
11495
11587
|
</dl>
|
|
@@ -11497,7 +11589,7 @@ await client.operations.departments.updateV1("department_id");
|
|
|
11497
11589
|
<dl>
|
|
11498
11590
|
<dd>
|
|
11499
11591
|
|
|
11500
|
-
**
|
|
11592
|
+
**messageId:** `string`
|
|
11501
11593
|
|
|
11502
11594
|
</dd>
|
|
11503
11595
|
</dl>
|
|
@@ -11505,7 +11597,7 @@ await client.operations.departments.updateV1("department_id");
|
|
|
11505
11597
|
<dl>
|
|
11506
11598
|
<dd>
|
|
11507
11599
|
|
|
11508
|
-
**requestOptions:** `
|
|
11600
|
+
**requestOptions:** `Cases.RequestOptions`
|
|
11509
11601
|
|
|
11510
11602
|
</dd>
|
|
11511
11603
|
</dl>
|
|
@@ -11516,7 +11608,9 @@ await client.operations.departments.updateV1("department_id");
|
|
|
11516
11608
|
</dl>
|
|
11517
11609
|
</details>
|
|
11518
11610
|
|
|
11519
|
-
|
|
11611
|
+
## Operations Departments
|
|
11612
|
+
|
|
11613
|
+
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">listV1</a>({ ...params }) -> Chrt.DepartmentListRes</code></summary>
|
|
11520
11614
|
<dl>
|
|
11521
11615
|
<dd>
|
|
11522
11616
|
|
|
@@ -11528,7 +11622,7 @@ await client.operations.departments.updateV1("department_id");
|
|
|
11528
11622
|
<dl>
|
|
11529
11623
|
<dd>
|
|
11530
11624
|
|
|
11531
|
-
|
|
11625
|
+
Lists department configurations for the caller's organization. | authz: min_org_role=operator | () -> (DepartmentListRes)
|
|
11532
11626
|
|
|
11533
11627
|
</dd>
|
|
11534
11628
|
</dl>
|
|
@@ -11544,10 +11638,12 @@ Creates a new department configuration for the caller's organization. | authz: m
|
|
|
11544
11638
|
<dd>
|
|
11545
11639
|
|
|
11546
11640
|
```typescript
|
|
11547
|
-
await client.operations.departments.
|
|
11548
|
-
|
|
11549
|
-
|
|
11550
|
-
|
|
11641
|
+
await client.operations.departments.listV1({
|
|
11642
|
+
sort_by: "created_at",
|
|
11643
|
+
sort_order: "asc",
|
|
11644
|
+
page: 1,
|
|
11645
|
+
page_size: 1,
|
|
11646
|
+
filter_department: ["automotive"],
|
|
11551
11647
|
});
|
|
11552
11648
|
```
|
|
11553
11649
|
|
|
@@ -11564,7 +11660,7 @@ await client.operations.departments.createV1({
|
|
|
11564
11660
|
<dl>
|
|
11565
11661
|
<dd>
|
|
11566
11662
|
|
|
11567
|
-
**request:** `Chrt.operations.
|
|
11663
|
+
**request:** `Chrt.operations.DepartmentsListV1Request`
|
|
11568
11664
|
|
|
11569
11665
|
</dd>
|
|
11570
11666
|
</dl>
|
|
@@ -11583,7 +11679,7 @@ await client.operations.departments.createV1({
|
|
|
11583
11679
|
</dl>
|
|
11584
11680
|
</details>
|
|
11585
11681
|
|
|
11586
|
-
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">
|
|
11682
|
+
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">getV1</a>(departmentId) -> Chrt.Department1</code></summary>
|
|
11587
11683
|
<dl>
|
|
11588
11684
|
<dd>
|
|
11589
11685
|
|
|
@@ -11595,7 +11691,7 @@ await client.operations.departments.createV1({
|
|
|
11595
11691
|
<dl>
|
|
11596
11692
|
<dd>
|
|
11597
11693
|
|
|
11598
|
-
|
|
11694
|
+
Retrieves a single department configuration. | authz: min_org_role=operator | () -> (Department1)
|
|
11599
11695
|
|
|
11600
11696
|
</dd>
|
|
11601
11697
|
</dl>
|
|
@@ -11611,7 +11707,7 @@ Adds an operator to a department. | authz: min_org_role=administrator | () -> (b
|
|
|
11611
11707
|
<dd>
|
|
11612
11708
|
|
|
11613
11709
|
```typescript
|
|
11614
|
-
await client.operations.departments.
|
|
11710
|
+
await client.operations.departments.getV1("department_id");
|
|
11615
11711
|
```
|
|
11616
11712
|
|
|
11617
11713
|
</dd>
|
|
@@ -11635,7 +11731,62 @@ await client.operations.departments.addOperatorV1("department_id", "user_id");
|
|
|
11635
11731
|
<dl>
|
|
11636
11732
|
<dd>
|
|
11637
11733
|
|
|
11638
|
-
**
|
|
11734
|
+
**requestOptions:** `Departments.RequestOptions`
|
|
11735
|
+
|
|
11736
|
+
</dd>
|
|
11737
|
+
</dl>
|
|
11738
|
+
</dd>
|
|
11739
|
+
</dl>
|
|
11740
|
+
|
|
11741
|
+
</dd>
|
|
11742
|
+
</dl>
|
|
11743
|
+
</details>
|
|
11744
|
+
|
|
11745
|
+
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">deleteV1</a>(departmentId) -> boolean</code></summary>
|
|
11746
|
+
<dl>
|
|
11747
|
+
<dd>
|
|
11748
|
+
|
|
11749
|
+
#### 📝 Description
|
|
11750
|
+
|
|
11751
|
+
<dl>
|
|
11752
|
+
<dd>
|
|
11753
|
+
|
|
11754
|
+
<dl>
|
|
11755
|
+
<dd>
|
|
11756
|
+
|
|
11757
|
+
Deletes a department configuration. | authz: min_org_role=administrator | () -> (bool)
|
|
11758
|
+
|
|
11759
|
+
</dd>
|
|
11760
|
+
</dl>
|
|
11761
|
+
</dd>
|
|
11762
|
+
</dl>
|
|
11763
|
+
|
|
11764
|
+
#### 🔌 Usage
|
|
11765
|
+
|
|
11766
|
+
<dl>
|
|
11767
|
+
<dd>
|
|
11768
|
+
|
|
11769
|
+
<dl>
|
|
11770
|
+
<dd>
|
|
11771
|
+
|
|
11772
|
+
```typescript
|
|
11773
|
+
await client.operations.departments.deleteV1("department_id");
|
|
11774
|
+
```
|
|
11775
|
+
|
|
11776
|
+
</dd>
|
|
11777
|
+
</dl>
|
|
11778
|
+
</dd>
|
|
11779
|
+
</dl>
|
|
11780
|
+
|
|
11781
|
+
#### ⚙️ Parameters
|
|
11782
|
+
|
|
11783
|
+
<dl>
|
|
11784
|
+
<dd>
|
|
11785
|
+
|
|
11786
|
+
<dl>
|
|
11787
|
+
<dd>
|
|
11788
|
+
|
|
11789
|
+
**departmentId:** `string`
|
|
11639
11790
|
|
|
11640
11791
|
</dd>
|
|
11641
11792
|
</dl>
|
|
@@ -11654,7 +11805,7 @@ await client.operations.departments.addOperatorV1("department_id", "user_id");
|
|
|
11654
11805
|
</dl>
|
|
11655
11806
|
</details>
|
|
11656
11807
|
|
|
11657
|
-
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">
|
|
11808
|
+
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">updateV1</a>(departmentId, { ...params }) -> boolean</code></summary>
|
|
11658
11809
|
<dl>
|
|
11659
11810
|
<dd>
|
|
11660
11811
|
|
|
@@ -11666,7 +11817,7 @@ await client.operations.departments.addOperatorV1("department_id", "user_id");
|
|
|
11666
11817
|
<dl>
|
|
11667
11818
|
<dd>
|
|
11668
11819
|
|
|
11669
|
-
|
|
11820
|
+
Updates a department configuration. | authz: min_org_role=administrator | (DepartmentClientUpdate1) -> (bool)
|
|
11670
11821
|
|
|
11671
11822
|
</dd>
|
|
11672
11823
|
</dl>
|
|
@@ -11682,7 +11833,7 @@ Removes an operator from a department. | authz: min_org_role=administrator | ()
|
|
|
11682
11833
|
<dd>
|
|
11683
11834
|
|
|
11684
11835
|
```typescript
|
|
11685
|
-
await client.operations.departments.
|
|
11836
|
+
await client.operations.departments.updateV1("department_id");
|
|
11686
11837
|
```
|
|
11687
11838
|
|
|
11688
11839
|
</dd>
|
|
@@ -11706,7 +11857,7 @@ await client.operations.departments.removeOperatorV1("department_id", "user_id")
|
|
|
11706
11857
|
<dl>
|
|
11707
11858
|
<dd>
|
|
11708
11859
|
|
|
11709
|
-
**
|
|
11860
|
+
**request:** `Chrt.operations.DepartmentClientUpdate1`
|
|
11710
11861
|
|
|
11711
11862
|
</dd>
|
|
11712
11863
|
</dl>
|
|
@@ -11725,6 +11876,479 @@ await client.operations.departments.removeOperatorV1("department_id", "user_id")
|
|
|
11725
11876
|
</dl>
|
|
11726
11877
|
</details>
|
|
11727
11878
|
|
|
11879
|
+
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
11880
|
+
<dl>
|
|
11881
|
+
<dd>
|
|
11882
|
+
|
|
11883
|
+
#### 📝 Description
|
|
11884
|
+
|
|
11885
|
+
<dl>
|
|
11886
|
+
<dd>
|
|
11887
|
+
|
|
11888
|
+
<dl>
|
|
11889
|
+
<dd>
|
|
11890
|
+
|
|
11891
|
+
Creates a new department configuration for the caller's organization. | authz: min_org_role=administrator | (DepartmentClientCreate1) -> (PydanticObjectId)
|
|
11892
|
+
|
|
11893
|
+
</dd>
|
|
11894
|
+
</dl>
|
|
11895
|
+
</dd>
|
|
11896
|
+
</dl>
|
|
11897
|
+
|
|
11898
|
+
#### 🔌 Usage
|
|
11899
|
+
|
|
11900
|
+
<dl>
|
|
11901
|
+
<dd>
|
|
11902
|
+
|
|
11903
|
+
<dl>
|
|
11904
|
+
<dd>
|
|
11905
|
+
|
|
11906
|
+
```typescript
|
|
11907
|
+
await client.operations.departments.createV1({
|
|
11908
|
+
schema_version: 1,
|
|
11909
|
+
name: "name",
|
|
11910
|
+
department: "automotive",
|
|
11911
|
+
});
|
|
11912
|
+
```
|
|
11913
|
+
|
|
11914
|
+
</dd>
|
|
11915
|
+
</dl>
|
|
11916
|
+
</dd>
|
|
11917
|
+
</dl>
|
|
11918
|
+
|
|
11919
|
+
#### ⚙️ Parameters
|
|
11920
|
+
|
|
11921
|
+
<dl>
|
|
11922
|
+
<dd>
|
|
11923
|
+
|
|
11924
|
+
<dl>
|
|
11925
|
+
<dd>
|
|
11926
|
+
|
|
11927
|
+
**request:** `Chrt.operations.DepartmentClientCreate1`
|
|
11928
|
+
|
|
11929
|
+
</dd>
|
|
11930
|
+
</dl>
|
|
11931
|
+
|
|
11932
|
+
<dl>
|
|
11933
|
+
<dd>
|
|
11934
|
+
|
|
11935
|
+
**requestOptions:** `Departments.RequestOptions`
|
|
11936
|
+
|
|
11937
|
+
</dd>
|
|
11938
|
+
</dl>
|
|
11939
|
+
</dd>
|
|
11940
|
+
</dl>
|
|
11941
|
+
|
|
11942
|
+
</dd>
|
|
11943
|
+
</dl>
|
|
11944
|
+
</details>
|
|
11945
|
+
|
|
11946
|
+
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">addOperatorV1</a>(departmentId, userId) -> boolean</code></summary>
|
|
11947
|
+
<dl>
|
|
11948
|
+
<dd>
|
|
11949
|
+
|
|
11950
|
+
#### 📝 Description
|
|
11951
|
+
|
|
11952
|
+
<dl>
|
|
11953
|
+
<dd>
|
|
11954
|
+
|
|
11955
|
+
<dl>
|
|
11956
|
+
<dd>
|
|
11957
|
+
|
|
11958
|
+
Adds an operator to a department. | authz: min_org_role=administrator | () -> (bool)
|
|
11959
|
+
|
|
11960
|
+
</dd>
|
|
11961
|
+
</dl>
|
|
11962
|
+
</dd>
|
|
11963
|
+
</dl>
|
|
11964
|
+
|
|
11965
|
+
#### 🔌 Usage
|
|
11966
|
+
|
|
11967
|
+
<dl>
|
|
11968
|
+
<dd>
|
|
11969
|
+
|
|
11970
|
+
<dl>
|
|
11971
|
+
<dd>
|
|
11972
|
+
|
|
11973
|
+
```typescript
|
|
11974
|
+
await client.operations.departments.addOperatorV1("department_id", "user_id");
|
|
11975
|
+
```
|
|
11976
|
+
|
|
11977
|
+
</dd>
|
|
11978
|
+
</dl>
|
|
11979
|
+
</dd>
|
|
11980
|
+
</dl>
|
|
11981
|
+
|
|
11982
|
+
#### ⚙️ Parameters
|
|
11983
|
+
|
|
11984
|
+
<dl>
|
|
11985
|
+
<dd>
|
|
11986
|
+
|
|
11987
|
+
<dl>
|
|
11988
|
+
<dd>
|
|
11989
|
+
|
|
11990
|
+
**departmentId:** `string`
|
|
11991
|
+
|
|
11992
|
+
</dd>
|
|
11993
|
+
</dl>
|
|
11994
|
+
|
|
11995
|
+
<dl>
|
|
11996
|
+
<dd>
|
|
11997
|
+
|
|
11998
|
+
**userId:** `string`
|
|
11999
|
+
|
|
12000
|
+
</dd>
|
|
12001
|
+
</dl>
|
|
12002
|
+
|
|
12003
|
+
<dl>
|
|
12004
|
+
<dd>
|
|
12005
|
+
|
|
12006
|
+
**requestOptions:** `Departments.RequestOptions`
|
|
12007
|
+
|
|
12008
|
+
</dd>
|
|
12009
|
+
</dl>
|
|
12010
|
+
</dd>
|
|
12011
|
+
</dl>
|
|
12012
|
+
|
|
12013
|
+
</dd>
|
|
12014
|
+
</dl>
|
|
12015
|
+
</details>
|
|
12016
|
+
|
|
12017
|
+
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">removeOperatorV1</a>(departmentId, userId) -> boolean</code></summary>
|
|
12018
|
+
<dl>
|
|
12019
|
+
<dd>
|
|
12020
|
+
|
|
12021
|
+
#### 📝 Description
|
|
12022
|
+
|
|
12023
|
+
<dl>
|
|
12024
|
+
<dd>
|
|
12025
|
+
|
|
12026
|
+
<dl>
|
|
12027
|
+
<dd>
|
|
12028
|
+
|
|
12029
|
+
Removes an operator from a department. | authz: min_org_role=administrator | () -> (bool)
|
|
12030
|
+
|
|
12031
|
+
</dd>
|
|
12032
|
+
</dl>
|
|
12033
|
+
</dd>
|
|
12034
|
+
</dl>
|
|
12035
|
+
|
|
12036
|
+
#### 🔌 Usage
|
|
12037
|
+
|
|
12038
|
+
<dl>
|
|
12039
|
+
<dd>
|
|
12040
|
+
|
|
12041
|
+
<dl>
|
|
12042
|
+
<dd>
|
|
12043
|
+
|
|
12044
|
+
```typescript
|
|
12045
|
+
await client.operations.departments.removeOperatorV1("department_id", "user_id");
|
|
12046
|
+
```
|
|
12047
|
+
|
|
12048
|
+
</dd>
|
|
12049
|
+
</dl>
|
|
12050
|
+
</dd>
|
|
12051
|
+
</dl>
|
|
12052
|
+
|
|
12053
|
+
#### ⚙️ Parameters
|
|
12054
|
+
|
|
12055
|
+
<dl>
|
|
12056
|
+
<dd>
|
|
12057
|
+
|
|
12058
|
+
<dl>
|
|
12059
|
+
<dd>
|
|
12060
|
+
|
|
12061
|
+
**departmentId:** `string`
|
|
12062
|
+
|
|
12063
|
+
</dd>
|
|
12064
|
+
</dl>
|
|
12065
|
+
|
|
12066
|
+
<dl>
|
|
12067
|
+
<dd>
|
|
12068
|
+
|
|
12069
|
+
**userId:** `string`
|
|
12070
|
+
|
|
12071
|
+
</dd>
|
|
12072
|
+
</dl>
|
|
12073
|
+
|
|
12074
|
+
<dl>
|
|
12075
|
+
<dd>
|
|
12076
|
+
|
|
12077
|
+
**requestOptions:** `Departments.RequestOptions`
|
|
12078
|
+
|
|
12079
|
+
</dd>
|
|
12080
|
+
</dl>
|
|
12081
|
+
</dd>
|
|
12082
|
+
</dl>
|
|
12083
|
+
|
|
12084
|
+
</dd>
|
|
12085
|
+
</dl>
|
|
12086
|
+
</details>
|
|
12087
|
+
|
|
12088
|
+
## Operations Cases S3Objects
|
|
12089
|
+
|
|
12090
|
+
<details><summary><code>client.operations.cases.s3Objects.<a href="/src/api/resources/operations/resources/cases/resources/s3Objects/client/Client.ts">getS3ObjectMetadataV1</a>(caseS3ObjectMetadataId) -> Chrt.CaseS3ObjectMetadata1</code></summary>
|
|
12091
|
+
<dl>
|
|
12092
|
+
<dd>
|
|
12093
|
+
|
|
12094
|
+
#### 📝 Description
|
|
12095
|
+
|
|
12096
|
+
<dl>
|
|
12097
|
+
<dd>
|
|
12098
|
+
|
|
12099
|
+
<dl>
|
|
12100
|
+
<dd>
|
|
12101
|
+
|
|
12102
|
+
Retrieves metadata for a case S3 object. | authz: min_org_role=operator | () -> (CaseS3ObjectMetadata1)
|
|
12103
|
+
|
|
12104
|
+
</dd>
|
|
12105
|
+
</dl>
|
|
12106
|
+
</dd>
|
|
12107
|
+
</dl>
|
|
12108
|
+
|
|
12109
|
+
#### 🔌 Usage
|
|
12110
|
+
|
|
12111
|
+
<dl>
|
|
12112
|
+
<dd>
|
|
12113
|
+
|
|
12114
|
+
<dl>
|
|
12115
|
+
<dd>
|
|
12116
|
+
|
|
12117
|
+
```typescript
|
|
12118
|
+
await client.operations.cases.s3Objects.getS3ObjectMetadataV1("case_s3_object_metadata_id");
|
|
12119
|
+
```
|
|
12120
|
+
|
|
12121
|
+
</dd>
|
|
12122
|
+
</dl>
|
|
12123
|
+
</dd>
|
|
12124
|
+
</dl>
|
|
12125
|
+
|
|
12126
|
+
#### ⚙️ Parameters
|
|
12127
|
+
|
|
12128
|
+
<dl>
|
|
12129
|
+
<dd>
|
|
12130
|
+
|
|
12131
|
+
<dl>
|
|
12132
|
+
<dd>
|
|
12133
|
+
|
|
12134
|
+
**caseS3ObjectMetadataId:** `string`
|
|
12135
|
+
|
|
12136
|
+
</dd>
|
|
12137
|
+
</dl>
|
|
12138
|
+
|
|
12139
|
+
<dl>
|
|
12140
|
+
<dd>
|
|
12141
|
+
|
|
12142
|
+
**requestOptions:** `S3Objects.RequestOptions`
|
|
12143
|
+
|
|
12144
|
+
</dd>
|
|
12145
|
+
</dl>
|
|
12146
|
+
</dd>
|
|
12147
|
+
</dl>
|
|
12148
|
+
|
|
12149
|
+
</dd>
|
|
12150
|
+
</dl>
|
|
12151
|
+
</details>
|
|
12152
|
+
|
|
12153
|
+
<details><summary><code>client.operations.cases.s3Objects.<a href="/src/api/resources/operations/resources/cases/resources/s3Objects/client/Client.ts">getV1</a>(caseS3ObjectMetadataId) -> core.BinaryResponse</code></summary>
|
|
12154
|
+
<dl>
|
|
12155
|
+
<dd>
|
|
12156
|
+
|
|
12157
|
+
#### 📝 Description
|
|
12158
|
+
|
|
12159
|
+
<dl>
|
|
12160
|
+
<dd>
|
|
12161
|
+
|
|
12162
|
+
<dl>
|
|
12163
|
+
<dd>
|
|
12164
|
+
|
|
12165
|
+
Streams a case S3 object file from storage. | authz: min_org_role=operator | () -> (binary)
|
|
12166
|
+
|
|
12167
|
+
</dd>
|
|
12168
|
+
</dl>
|
|
12169
|
+
</dd>
|
|
12170
|
+
</dl>
|
|
12171
|
+
|
|
12172
|
+
#### 🔌 Usage
|
|
12173
|
+
|
|
12174
|
+
<dl>
|
|
12175
|
+
<dd>
|
|
12176
|
+
|
|
12177
|
+
<dl>
|
|
12178
|
+
<dd>
|
|
12179
|
+
|
|
12180
|
+
```typescript
|
|
12181
|
+
await client.operations.cases.s3Objects.getV1("case_s3_object_metadata_id");
|
|
12182
|
+
```
|
|
12183
|
+
|
|
12184
|
+
</dd>
|
|
12185
|
+
</dl>
|
|
12186
|
+
</dd>
|
|
12187
|
+
</dl>
|
|
12188
|
+
|
|
12189
|
+
#### ⚙️ Parameters
|
|
12190
|
+
|
|
12191
|
+
<dl>
|
|
12192
|
+
<dd>
|
|
12193
|
+
|
|
12194
|
+
<dl>
|
|
12195
|
+
<dd>
|
|
12196
|
+
|
|
12197
|
+
**caseS3ObjectMetadataId:** `string`
|
|
12198
|
+
|
|
12199
|
+
</dd>
|
|
12200
|
+
</dl>
|
|
12201
|
+
|
|
12202
|
+
<dl>
|
|
12203
|
+
<dd>
|
|
12204
|
+
|
|
12205
|
+
**requestOptions:** `S3Objects.RequestOptions`
|
|
12206
|
+
|
|
12207
|
+
</dd>
|
|
12208
|
+
</dl>
|
|
12209
|
+
</dd>
|
|
12210
|
+
</dl>
|
|
12211
|
+
|
|
12212
|
+
</dd>
|
|
12213
|
+
</dl>
|
|
12214
|
+
</details>
|
|
12215
|
+
|
|
12216
|
+
<details><summary><code>client.operations.cases.s3Objects.<a href="/src/api/resources/operations/resources/cases/resources/s3Objects/client/Client.ts">addV1</a>(caseId, { ...params }) -> boolean</code></summary>
|
|
12217
|
+
<dl>
|
|
12218
|
+
<dd>
|
|
12219
|
+
|
|
12220
|
+
#### 📝 Description
|
|
12221
|
+
|
|
12222
|
+
<dl>
|
|
12223
|
+
<dd>
|
|
12224
|
+
|
|
12225
|
+
<dl>
|
|
12226
|
+
<dd>
|
|
12227
|
+
|
|
12228
|
+
Uploads a file to a case. Automatic blurhash generation for images. | authz: min_org_role=operator | (UploadFile) -> (bool)
|
|
12229
|
+
|
|
12230
|
+
</dd>
|
|
12231
|
+
</dl>
|
|
12232
|
+
</dd>
|
|
12233
|
+
</dl>
|
|
12234
|
+
|
|
12235
|
+
#### 🔌 Usage
|
|
12236
|
+
|
|
12237
|
+
<dl>
|
|
12238
|
+
<dd>
|
|
12239
|
+
|
|
12240
|
+
<dl>
|
|
12241
|
+
<dd>
|
|
12242
|
+
|
|
12243
|
+
```typescript
|
|
12244
|
+
await client.operations.cases.s3Objects.addV1("case_id", {
|
|
12245
|
+
file: fs.createReadStream("/path/to/your/file"),
|
|
12246
|
+
});
|
|
12247
|
+
```
|
|
12248
|
+
|
|
12249
|
+
</dd>
|
|
12250
|
+
</dl>
|
|
12251
|
+
</dd>
|
|
12252
|
+
</dl>
|
|
12253
|
+
|
|
12254
|
+
#### ⚙️ Parameters
|
|
12255
|
+
|
|
12256
|
+
<dl>
|
|
12257
|
+
<dd>
|
|
12258
|
+
|
|
12259
|
+
<dl>
|
|
12260
|
+
<dd>
|
|
12261
|
+
|
|
12262
|
+
**caseId:** `string`
|
|
12263
|
+
|
|
12264
|
+
</dd>
|
|
12265
|
+
</dl>
|
|
12266
|
+
|
|
12267
|
+
<dl>
|
|
12268
|
+
<dd>
|
|
12269
|
+
|
|
12270
|
+
**request:** `Chrt.operations.cases.BodyPostCasesS3ObjectsAddV1OperationsCasesS3ObjectsAddV1CaseIdPost`
|
|
12271
|
+
|
|
12272
|
+
</dd>
|
|
12273
|
+
</dl>
|
|
12274
|
+
|
|
12275
|
+
<dl>
|
|
12276
|
+
<dd>
|
|
12277
|
+
|
|
12278
|
+
**requestOptions:** `S3Objects.RequestOptions`
|
|
12279
|
+
|
|
12280
|
+
</dd>
|
|
12281
|
+
</dl>
|
|
12282
|
+
</dd>
|
|
12283
|
+
</dl>
|
|
12284
|
+
|
|
12285
|
+
</dd>
|
|
12286
|
+
</dl>
|
|
12287
|
+
</details>
|
|
12288
|
+
|
|
12289
|
+
<details><summary><code>client.operations.cases.s3Objects.<a href="/src/api/resources/operations/resources/cases/resources/s3Objects/client/Client.ts">deleteV1</a>(caseS3ObjectMetadataId) -> boolean</code></summary>
|
|
12290
|
+
<dl>
|
|
12291
|
+
<dd>
|
|
12292
|
+
|
|
12293
|
+
#### 📝 Description
|
|
12294
|
+
|
|
12295
|
+
<dl>
|
|
12296
|
+
<dd>
|
|
12297
|
+
|
|
12298
|
+
<dl>
|
|
12299
|
+
<dd>
|
|
12300
|
+
|
|
12301
|
+
Deletes an S3 object metadata and the associated S3 object from a case. Only the uploader or an operator from the uploading org can delete. | () -> (bool)
|
|
12302
|
+
|
|
12303
|
+
</dd>
|
|
12304
|
+
</dl>
|
|
12305
|
+
</dd>
|
|
12306
|
+
</dl>
|
|
12307
|
+
|
|
12308
|
+
#### 🔌 Usage
|
|
12309
|
+
|
|
12310
|
+
<dl>
|
|
12311
|
+
<dd>
|
|
12312
|
+
|
|
12313
|
+
<dl>
|
|
12314
|
+
<dd>
|
|
12315
|
+
|
|
12316
|
+
```typescript
|
|
12317
|
+
await client.operations.cases.s3Objects.deleteV1("case_s3_object_metadata_id");
|
|
12318
|
+
```
|
|
12319
|
+
|
|
12320
|
+
</dd>
|
|
12321
|
+
</dl>
|
|
12322
|
+
</dd>
|
|
12323
|
+
</dl>
|
|
12324
|
+
|
|
12325
|
+
#### ⚙️ Parameters
|
|
12326
|
+
|
|
12327
|
+
<dl>
|
|
12328
|
+
<dd>
|
|
12329
|
+
|
|
12330
|
+
<dl>
|
|
12331
|
+
<dd>
|
|
12332
|
+
|
|
12333
|
+
**caseS3ObjectMetadataId:** `string`
|
|
12334
|
+
|
|
12335
|
+
</dd>
|
|
12336
|
+
</dl>
|
|
12337
|
+
|
|
12338
|
+
<dl>
|
|
12339
|
+
<dd>
|
|
12340
|
+
|
|
12341
|
+
**requestOptions:** `S3Objects.RequestOptions`
|
|
12342
|
+
|
|
12343
|
+
</dd>
|
|
12344
|
+
</dl>
|
|
12345
|
+
</dd>
|
|
12346
|
+
</dl>
|
|
12347
|
+
|
|
12348
|
+
</dd>
|
|
12349
|
+
</dl>
|
|
12350
|
+
</details>
|
|
12351
|
+
|
|
11728
12352
|
## Orgs Connections
|
|
11729
12353
|
|
|
11730
12354
|
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">listShippersV1</a>({ ...params }) -> Chrt.ShipperConnectionListRes</code></summary>
|
|
@@ -13181,7 +13805,7 @@ await client.orgs.orgProfiles.getByHandleV1("handle");
|
|
|
13181
13805
|
<dl>
|
|
13182
13806
|
<dd>
|
|
13183
13807
|
|
|
13184
|
-
Returns the organization avatar image URL from
|
|
13808
|
+
Returns the organization avatar image URL from WorkOS or a placeholder if not found. | () -> (str)
|
|
13185
13809
|
|
|
13186
13810
|
</dd>
|
|
13187
13811
|
</dl>
|
|
@@ -14055,6 +14679,7 @@ Lists all organization members paired with their driver information if they are
|
|
|
14055
14679
|
```typescript
|
|
14056
14680
|
await client.shipping.drivers.listOrgMembersAndDriversV1({
|
|
14057
14681
|
search: "search",
|
|
14682
|
+
filter_role: ["owner"],
|
|
14058
14683
|
filter_available_according_to_driver: true,
|
|
14059
14684
|
filter_available_according_to_operators: true,
|
|
14060
14685
|
sort_by: "first_name",
|
|
@@ -15471,6 +16096,8 @@ await client.shipping.orderSchedules.listV1({
|
|
|
15471
16096
|
sort_order: "asc",
|
|
15472
16097
|
page: 1,
|
|
15473
16098
|
page_size: 1,
|
|
16099
|
+
filter_status: ["draft"],
|
|
16100
|
+
filter_orchestrator_schedule_status: ["not_created"],
|
|
15474
16101
|
filter_owned_by_user_id: "filter_owned_by_user_id",
|
|
15475
16102
|
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
15476
16103
|
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
@@ -17534,7 +18161,7 @@ await client.shipping.taskGroups.detachLigFromProviderPayDriverV1("task_group_id
|
|
|
17534
18161
|
<dl>
|
|
17535
18162
|
<dd>
|
|
17536
18163
|
|
|
17537
|
-
Preview the LineItem materialization that would result from applying a rate sheet to the SPP vector of the named TaskGroup. Returns the resolved rate sheet, materialized LineItems (NOT inserted), the pre-adjustment total, and the requested parties (shipper -> coordinator). Auto-resolves the rate sheet via RateSheetMapping1 for the requested shipper unless body.rate_sheet_id is provided. No DB writes — operator can iterate freely. To commit, call from_rate_sheet/create_for_shipper_pay_provider/v1 then attach_lig_to_shipper_pay_provider/v1. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (TaskGroupQuoteForShipperPayProviderClientReq) -> (TaskGroupQuoteResp)
|
|
18164
|
+
Preview the LineItem materialization that would result from applying a rate sheet to the SPP vector of the named TaskGroup. Returns the resolved rate sheet, materialized LineItems (NOT inserted), the pre-adjustment total, and the requested parties (shipper -> coordinator). Auto-resolves the rate sheet via RateSheetMapping1 for the requested shipper unless body.rate_sheet_id is provided. No DB writes — operator can iterate freely. To commit, call from_rate_sheet/create_for_shipper_pay_provider/v1 then attach_lig_to_shipper_pay_provider/v1. | authz: allowed_org_types=[provider, shipper], min_org_role=operator, authz_personas=[task_group_coordinator_operators, shipper_org_operators] | (TaskGroupQuoteForShipperPayProviderClientReq) -> (TaskGroupQuoteResp)
|
|
17538
18165
|
|
|
17539
18166
|
</dd>
|
|
17540
18167
|
</dl>
|
|
@@ -19614,6 +20241,7 @@ await client.shipping.orders.expanded.listForCoordinatorOperatorsV1({
|
|
|
19614
20241
|
page: 1,
|
|
19615
20242
|
page_size: 1,
|
|
19616
20243
|
search: "search",
|
|
20244
|
+
filter_status: ["draft"],
|
|
19617
20245
|
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
19618
20246
|
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
19619
20247
|
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
@@ -19700,6 +20328,7 @@ await client.shipping.orders.expanded.listForShipperOperatorsV1({
|
|
|
19700
20328
|
page: 1,
|
|
19701
20329
|
page_size: 1,
|
|
19702
20330
|
search: "search",
|
|
20331
|
+
filter_status: ["draft"],
|
|
19703
20332
|
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
19704
20333
|
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
19705
20334
|
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
@@ -20793,6 +21422,7 @@ await client.shipping.taskGroups.expanded.listForExecutorOperatorsV1({
|
|
|
20793
21422
|
page: 1,
|
|
20794
21423
|
page_size: 1,
|
|
20795
21424
|
search: "search",
|
|
21425
|
+
filter_status: ["draft"],
|
|
20796
21426
|
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
20797
21427
|
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
20798
21428
|
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
@@ -20880,6 +21510,7 @@ await client.shipping.taskGroups.expanded.listForDriverForExecutorV1({
|
|
|
20880
21510
|
page: 1,
|
|
20881
21511
|
page_size: 1,
|
|
20882
21512
|
search: "search",
|
|
21513
|
+
filter_status: ["draft"],
|
|
20883
21514
|
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
20884
21515
|
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
20885
21516
|
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|