@chrt-inc/typescript-sdk 1.881.0 → 1.885.0
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/lineItemGroups/client/requests/LineItemGroupAdHocCreateClientReq.d.ts +0 -1
- package/dist/cjs/api/resources/billing/resources/statements/client/requests/StatementCreateClientReq.d.ts +0 -1
- package/dist/cjs/api/resources/notifications/resources/adHoc/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/notifications/resources/adHoc/client/Client.js +2 -2
- package/dist/cjs/api/resources/orgs/client/Client.d.ts +6 -6
- package/dist/cjs/api/resources/orgs/client/Client.js +14 -14
- package/dist/cjs/api/resources/orgs/resources/accounts/client/Client.d.ts +97 -0
- package/dist/cjs/api/resources/orgs/resources/{offChrtVendor → accounts}/client/Client.js +57 -100
- package/dist/{esm/api/resources/orgs/resources/offChrtVendor/client/requests/OffChrtVendorClientCreate1.d.mts → cjs/api/resources/orgs/resources/accounts/client/requests/AccountClientCreate1.d.ts} +4 -2
- package/dist/cjs/api/resources/orgs/resources/{offChrtVendor/client/requests/OffChrtVendorClientUpdate1.d.ts → accounts/client/requests/AccountClientUpdate1.d.ts} +1 -3
- package/dist/cjs/api/resources/orgs/resources/accounts/client/requests/AccountsListV1Request.d.ts +27 -0
- package/dist/cjs/api/resources/orgs/resources/accounts/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/orgs/resources/contacts/client/Client.d.ts +112 -0
- package/dist/cjs/api/resources/orgs/resources/{directoryEntries → contacts}/client/Client.js +55 -51
- package/dist/cjs/api/resources/orgs/resources/{directoryEntries/client/requests/DirectoryEntryClientCreate1.d.ts → contacts/client/requests/ContactClientCreate1.d.ts} +5 -4
- package/dist/cjs/api/resources/orgs/resources/{directoryEntries/client/requests/DirectoryEntryClientUpdate1.d.ts → contacts/client/requests/ContactClientUpdate1.d.ts} +1 -1
- package/dist/cjs/api/resources/orgs/resources/{directoryEntries/client/requests/DirectoryEntriesListV1Request.d.ts → contacts/client/requests/ContactsListV1Request.d.ts} +9 -6
- package/dist/cjs/api/resources/orgs/resources/contacts/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/orgs/resources/index.d.ts +4 -4
- package/dist/cjs/api/resources/orgs/resources/index.js +5 -5
- package/dist/cjs/api/resources/orgs/resources/offChrtOrgData/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/orgs/resources/offChrtOrgData/client/Client.js +1 -1
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/Client.js +4 -4
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateClientCreate1.d.ts +2 -1
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateClientUpdate1.d.ts +2 -1
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplatesListV1Request.d.ts +3 -3
- package/dist/cjs/api/resources/shipping/resources/orders/client/Client.d.ts +28 -0
- package/dist/cjs/api/resources/shipping/resources/orders/client/Client.js +120 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/drafts/client/requests/OrdersOpenDraftReq.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/Client.d.ts +4 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/Client.js +20 -4
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForCoordinatorOperatorsV1Request.d.ts +3 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForExecutorOperatorsV1Request.d.ts +3 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForProviderOperatorsV1Request.d.ts +3 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForShipperOperatorsV1Request.d.ts +3 -0
- package/dist/cjs/api/resources/shipping/resources/tasks/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/tasks/client/Client.js +1 -1
- package/dist/{esm/api/types/OffChrtVendor1.d.mts → cjs/api/types/Account1.d.ts} +4 -2
- package/dist/cjs/api/types/{OffChrtVendorListRes.d.ts → AccountListRes.d.ts} +2 -2
- package/dist/cjs/api/types/AccountSortByEnum.d.ts +4 -0
- package/dist/cjs/api/types/{DirectoryEntry1.d.ts → Contact1.d.ts} +6 -7
- package/dist/cjs/api/types/{DirectoryEntryListRes.d.ts → ContactListRes.d.ts} +2 -2
- package/dist/cjs/api/types/ContactSortByEnum.d.ts +4 -0
- package/dist/cjs/api/types/ContactSortByEnum.js +5 -0
- package/dist/cjs/api/types/CreateOffChrtOrgRes.d.ts +1 -1
- package/dist/cjs/api/types/LineItemGroup1.d.ts +0 -1
- package/dist/cjs/api/types/NotificationIntentAdHoc1.d.ts +1 -1
- package/dist/cjs/api/types/NotificationIntentAdHocClientCreate1.d.ts +1 -1
- package/dist/cjs/api/types/Order1.d.ts +1 -0
- package/dist/cjs/api/types/OrderAndTaskGroupExpandedReq.d.ts +1 -1
- package/dist/cjs/api/types/OrderDraftValidationRequirements.d.ts +1 -0
- package/dist/cjs/api/types/OrderLimitedForCoordinator1.d.ts +1 -0
- package/dist/cjs/api/types/OrderLimitedForProvider1.d.ts +1 -0
- package/dist/cjs/api/types/OrderTemplate1.d.ts +2 -1
- package/dist/cjs/api/types/OrderTemplateCore1.d.ts +2 -1
- package/dist/cjs/api/types/OrderTemplateExpanded1.d.ts +1 -1
- package/dist/cjs/api/types/OrderTemplateReferenceColumnEnum1.d.ts +3 -2
- package/dist/cjs/api/types/OrderTemplateReferenceColumnEnum1.js +2 -1
- package/dist/cjs/api/types/OrderTemplateReferencesExpanded1.d.ts +1 -1
- package/dist/cjs/api/types/OrderTemplateResolvabilityRes.d.ts +2 -1
- package/dist/cjs/api/types/OrgTypeEnum.d.ts +2 -1
- package/dist/cjs/api/types/OrgTypeEnum.js +1 -0
- package/dist/cjs/api/types/Statement1.d.ts +0 -1
- package/dist/cjs/api/types/Task1.d.ts +1 -1
- package/dist/cjs/api/types/TaskClientCreate1.d.ts +1 -1
- package/dist/cjs/api/types/TaskClientUpdate1.d.ts +1 -1
- package/dist/cjs/api/types/TaskExpanded.d.ts +1 -1
- package/dist/cjs/api/types/index.d.ts +6 -5
- package/dist/cjs/api/types/index.js +6 -5
- 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/lineItemGroups/client/requests/LineItemGroupAdHocCreateClientReq.d.mts +0 -1
- package/dist/esm/api/resources/billing/resources/statements/client/requests/StatementCreateClientReq.d.mts +0 -1
- package/dist/esm/api/resources/notifications/resources/adHoc/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/notifications/resources/adHoc/client/Client.mjs +2 -2
- package/dist/esm/api/resources/orgs/client/Client.d.mts +6 -6
- package/dist/esm/api/resources/orgs/client/Client.mjs +8 -8
- package/dist/esm/api/resources/orgs/resources/accounts/client/Client.d.mts +97 -0
- package/dist/esm/api/resources/orgs/resources/{offChrtVendor → accounts}/client/Client.mjs +55 -98
- package/dist/{cjs/api/resources/orgs/resources/offChrtVendor/client/requests/OffChrtVendorClientCreate1.d.ts → esm/api/resources/orgs/resources/accounts/client/requests/AccountClientCreate1.d.mts} +4 -2
- package/dist/esm/api/resources/orgs/resources/{offChrtVendor/client/requests/OffChrtVendorClientUpdate1.d.mts → accounts/client/requests/AccountClientUpdate1.d.mts} +1 -3
- package/dist/esm/api/resources/orgs/resources/accounts/client/requests/AccountsListV1Request.d.mts +27 -0
- package/dist/esm/api/resources/orgs/resources/accounts/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/orgs/resources/contacts/client/Client.d.mts +112 -0
- package/dist/esm/api/resources/orgs/resources/{directoryEntries → contacts}/client/Client.mjs +53 -49
- package/dist/esm/api/resources/orgs/resources/{directoryEntries/client/requests/DirectoryEntryClientCreate1.d.mts → contacts/client/requests/ContactClientCreate1.d.mts} +5 -4
- package/dist/esm/api/resources/orgs/resources/{directoryEntries/client/requests/DirectoryEntryClientUpdate1.d.mts → contacts/client/requests/ContactClientUpdate1.d.mts} +1 -1
- package/dist/esm/api/resources/orgs/resources/{directoryEntries/client/requests/DirectoryEntriesListV1Request.d.mts → contacts/client/requests/ContactsListV1Request.d.mts} +9 -6
- package/dist/esm/api/resources/orgs/resources/contacts/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/orgs/resources/index.d.mts +4 -4
- package/dist/esm/api/resources/orgs/resources/index.mjs +4 -4
- package/dist/esm/api/resources/orgs/resources/offChrtOrgData/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/orgs/resources/offChrtOrgData/client/Client.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/Client.mjs +4 -4
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateClientCreate1.d.mts +2 -1
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateClientUpdate1.d.mts +2 -1
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplatesListV1Request.d.mts +3 -3
- package/dist/esm/api/resources/shipping/resources/orders/client/Client.d.mts +28 -0
- package/dist/esm/api/resources/shipping/resources/orders/client/Client.mjs +120 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/drafts/client/requests/OrdersOpenDraftReq.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.d.mts +4 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.mjs +20 -4
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForCoordinatorOperatorsV1Request.d.mts +3 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForExecutorOperatorsV1Request.d.mts +3 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForProviderOperatorsV1Request.d.mts +3 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForShipperOperatorsV1Request.d.mts +3 -0
- package/dist/esm/api/resources/shipping/resources/tasks/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/tasks/client/Client.mjs +1 -1
- package/dist/{cjs/api/types/OffChrtVendor1.d.ts → esm/api/types/Account1.d.mts} +4 -2
- package/dist/esm/api/types/{OffChrtVendorListRes.d.mts → AccountListRes.d.mts} +2 -2
- package/dist/esm/api/types/AccountSortByEnum.d.mts +4 -0
- package/dist/esm/api/types/{DirectoryEntry1.d.mts → Contact1.d.mts} +6 -7
- package/dist/esm/api/types/{DirectoryEntryListRes.d.mts → ContactListRes.d.mts} +2 -2
- package/dist/esm/api/types/ContactSortByEnum.d.mts +4 -0
- package/dist/esm/api/types/ContactSortByEnum.mjs +4 -0
- package/dist/esm/api/types/CreateOffChrtOrgRes.d.mts +1 -1
- package/dist/esm/api/types/LineItemGroup1.d.mts +0 -1
- package/dist/esm/api/types/NotificationIntentAdHoc1.d.mts +1 -1
- package/dist/esm/api/types/NotificationIntentAdHocClientCreate1.d.mts +1 -1
- package/dist/esm/api/types/Order1.d.mts +1 -0
- package/dist/esm/api/types/OrderAndTaskGroupExpandedReq.d.mts +1 -1
- package/dist/esm/api/types/OrderDraftValidationRequirements.d.mts +1 -0
- package/dist/esm/api/types/OrderLimitedForCoordinator1.d.mts +1 -0
- package/dist/esm/api/types/OrderLimitedForProvider1.d.mts +1 -0
- package/dist/esm/api/types/OrderTemplate1.d.mts +2 -1
- package/dist/esm/api/types/OrderTemplateCore1.d.mts +2 -1
- package/dist/esm/api/types/OrderTemplateExpanded1.d.mts +1 -1
- package/dist/esm/api/types/OrderTemplateReferenceColumnEnum1.d.mts +3 -2
- package/dist/esm/api/types/OrderTemplateReferenceColumnEnum1.mjs +2 -1
- package/dist/esm/api/types/OrderTemplateReferencesExpanded1.d.mts +1 -1
- package/dist/esm/api/types/OrderTemplateResolvabilityRes.d.mts +2 -1
- package/dist/esm/api/types/OrgTypeEnum.d.mts +2 -1
- package/dist/esm/api/types/OrgTypeEnum.mjs +1 -0
- package/dist/esm/api/types/Statement1.d.mts +0 -1
- package/dist/esm/api/types/Task1.d.mts +1 -1
- package/dist/esm/api/types/TaskClientCreate1.d.mts +1 -1
- package/dist/esm/api/types/TaskClientUpdate1.d.mts +1 -1
- package/dist/esm/api/types/TaskExpanded.d.mts +1 -1
- package/dist/esm/api/types/index.d.mts +6 -5
- package/dist/esm/api/types/index.mjs +6 -5
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +358 -270
- package/dist/cjs/api/resources/orgs/resources/directoryEntries/client/Client.d.ts +0 -111
- package/dist/cjs/api/resources/orgs/resources/directoryEntries/client/requests/index.d.ts +0 -3
- package/dist/cjs/api/resources/orgs/resources/offChrtVendor/client/Client.d.ts +0 -106
- package/dist/cjs/api/resources/orgs/resources/offChrtVendor/client/requests/OffChrtVendorListV1Request.d.ts +0 -14
- package/dist/cjs/api/resources/orgs/resources/offChrtVendor/client/requests/index.d.ts +0 -3
- package/dist/cjs/api/types/DirectoryEntrySortByEnum.d.ts +0 -4
- package/dist/esm/api/resources/orgs/resources/directoryEntries/client/Client.d.mts +0 -111
- package/dist/esm/api/resources/orgs/resources/directoryEntries/client/requests/index.d.mts +0 -3
- package/dist/esm/api/resources/orgs/resources/offChrtVendor/client/Client.d.mts +0 -106
- package/dist/esm/api/resources/orgs/resources/offChrtVendor/client/requests/OffChrtVendorListV1Request.d.mts +0 -14
- package/dist/esm/api/resources/orgs/resources/offChrtVendor/client/requests/index.d.mts +0 -3
- package/dist/esm/api/types/DirectoryEntrySortByEnum.d.mts +0 -4
- /package/dist/cjs/api/resources/orgs/resources/{directoryEntries → accounts}/client/index.d.ts +0 -0
- /package/dist/cjs/api/resources/orgs/resources/{directoryEntries → accounts}/client/index.js +0 -0
- /package/dist/cjs/api/resources/orgs/resources/{directoryEntries/client/requests/DirectoryEntriesListV1Request.js → accounts/client/requests/AccountClientCreate1.js} +0 -0
- /package/dist/cjs/api/resources/orgs/resources/{directoryEntries/client/requests/DirectoryEntryClientCreate1.js → accounts/client/requests/AccountClientUpdate1.js} +0 -0
- /package/dist/cjs/api/resources/orgs/resources/{directoryEntries/client/requests/DirectoryEntryClientUpdate1.js → accounts/client/requests/AccountsListV1Request.js} +0 -0
- /package/dist/cjs/api/resources/orgs/resources/{directoryEntries → accounts}/client/requests/index.js +0 -0
- /package/dist/cjs/api/resources/orgs/resources/{directoryEntries → accounts}/index.d.ts +0 -0
- /package/dist/cjs/api/resources/orgs/resources/{directoryEntries → accounts}/index.js +0 -0
- /package/dist/cjs/api/resources/orgs/resources/{offChrtVendor → contacts}/client/index.d.ts +0 -0
- /package/dist/cjs/api/resources/orgs/resources/{offChrtVendor → contacts}/client/index.js +0 -0
- /package/dist/cjs/api/resources/orgs/resources/{offChrtVendor/client/requests/OffChrtVendorClientCreate1.js → contacts/client/requests/ContactClientCreate1.js} +0 -0
- /package/dist/cjs/api/resources/orgs/resources/{offChrtVendor/client/requests/OffChrtVendorClientUpdate1.js → contacts/client/requests/ContactClientUpdate1.js} +0 -0
- /package/dist/cjs/api/resources/orgs/resources/{offChrtVendor/client/requests/OffChrtVendorListV1Request.js → contacts/client/requests/ContactsListV1Request.js} +0 -0
- /package/dist/cjs/api/resources/orgs/resources/{offChrtVendor → contacts}/client/requests/index.js +0 -0
- /package/dist/cjs/api/resources/orgs/resources/{offChrtVendor → contacts}/index.d.ts +0 -0
- /package/dist/cjs/api/resources/orgs/resources/{offChrtVendor → contacts}/index.js +0 -0
- /package/dist/cjs/api/types/{DirectoryEntry1.js → Account1.js} +0 -0
- /package/dist/cjs/api/types/{DirectoryEntryListRes.js → AccountListRes.js} +0 -0
- /package/dist/cjs/api/types/{DirectoryEntrySortByEnum.js → AccountSortByEnum.js} +0 -0
- /package/dist/cjs/api/types/{OffChrtVendor1.js → Contact1.js} +0 -0
- /package/dist/cjs/api/types/{OffChrtVendorListRes.js → ContactListRes.js} +0 -0
- /package/dist/esm/api/resources/orgs/resources/{directoryEntries → accounts}/client/index.d.mts +0 -0
- /package/dist/esm/api/resources/orgs/resources/{directoryEntries → accounts}/client/index.mjs +0 -0
- /package/dist/esm/api/resources/orgs/resources/{directoryEntries/client/requests/DirectoryEntriesListV1Request.mjs → accounts/client/requests/AccountClientCreate1.mjs} +0 -0
- /package/dist/esm/api/resources/orgs/resources/{directoryEntries/client/requests/DirectoryEntryClientCreate1.mjs → accounts/client/requests/AccountClientUpdate1.mjs} +0 -0
- /package/dist/esm/api/resources/orgs/resources/{directoryEntries/client/requests/DirectoryEntryClientUpdate1.mjs → accounts/client/requests/AccountsListV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/orgs/resources/{directoryEntries → accounts}/client/requests/index.mjs +0 -0
- /package/dist/esm/api/resources/orgs/resources/{directoryEntries → accounts}/index.d.mts +0 -0
- /package/dist/esm/api/resources/orgs/resources/{directoryEntries → accounts}/index.mjs +0 -0
- /package/dist/esm/api/resources/orgs/resources/{offChrtVendor → contacts}/client/index.d.mts +0 -0
- /package/dist/esm/api/resources/orgs/resources/{offChrtVendor → contacts}/client/index.mjs +0 -0
- /package/dist/esm/api/resources/orgs/resources/{offChrtVendor/client/requests/OffChrtVendorClientCreate1.mjs → contacts/client/requests/ContactClientCreate1.mjs} +0 -0
- /package/dist/esm/api/resources/orgs/resources/{offChrtVendor/client/requests/OffChrtVendorClientUpdate1.mjs → contacts/client/requests/ContactClientUpdate1.mjs} +0 -0
- /package/dist/esm/api/resources/orgs/resources/{offChrtVendor/client/requests/OffChrtVendorListV1Request.mjs → contacts/client/requests/ContactsListV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/orgs/resources/{offChrtVendor → contacts}/client/requests/index.mjs +0 -0
- /package/dist/esm/api/resources/orgs/resources/{offChrtVendor → contacts}/index.d.mts +0 -0
- /package/dist/esm/api/resources/orgs/resources/{offChrtVendor → contacts}/index.mjs +0 -0
- /package/dist/esm/api/types/{DirectoryEntry1.mjs → Account1.mjs} +0 -0
- /package/dist/esm/api/types/{DirectoryEntryListRes.mjs → AccountListRes.mjs} +0 -0
- /package/dist/esm/api/types/{DirectoryEntrySortByEnum.mjs → AccountSortByEnum.mjs} +0 -0
- /package/dist/esm/api/types/{OffChrtVendor1.mjs → Contact1.mjs} +0 -0
- /package/dist/esm/api/types/{OffChrtVendorListRes.mjs → ContactListRes.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -9755,7 +9755,7 @@ Creates or returns an existing ad-hoc notification intent for an order. | authz:
|
|
|
9755
9755
|
|
|
9756
9756
|
```typescript
|
|
9757
9757
|
await client.notifications.adHoc.createV1("order_id", {
|
|
9758
|
-
|
|
9758
|
+
contact_id: "contact_id",
|
|
9759
9759
|
schema_version: 1,
|
|
9760
9760
|
});
|
|
9761
9761
|
```
|
|
@@ -9829,7 +9829,7 @@ Creates a new ad-hoc notification intent for a tracking session. | authz: min_or
|
|
|
9829
9829
|
|
|
9830
9830
|
```typescript
|
|
9831
9831
|
await client.notifications.adHoc.createForSessionV1("session_id", {
|
|
9832
|
-
|
|
9832
|
+
contact_id: "contact_id",
|
|
9833
9833
|
schema_version: 1,
|
|
9834
9834
|
});
|
|
9835
9835
|
```
|
|
@@ -13942,9 +13942,9 @@ await client.operations.orderInternalMessages.s3Objects.getV1("order_internal_me
|
|
|
13942
13942
|
</dl>
|
|
13943
13943
|
</details>
|
|
13944
13944
|
|
|
13945
|
-
## Orgs
|
|
13945
|
+
## Orgs Accounts
|
|
13946
13946
|
|
|
13947
|
-
<details><summary><code>client.orgs.
|
|
13947
|
+
<details><summary><code>client.orgs.accounts.<a href="/src/api/resources/orgs/resources/accounts/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
13948
13948
|
<dl>
|
|
13949
13949
|
<dd>
|
|
13950
13950
|
|
|
@@ -13956,7 +13956,7 @@ await client.operations.orderInternalMessages.s3Objects.getV1("order_internal_me
|
|
|
13956
13956
|
<dl>
|
|
13957
13957
|
<dd>
|
|
13958
13958
|
|
|
13959
|
-
Creates a
|
|
13959
|
+
Creates a coordinator-private account for a connected on- or off-CHRT shipper. | authz: allowed_org_types=[provider], min_org_role=operator | (AccountClientCreate1) -> (PydanticObjectId)
|
|
13960
13960
|
|
|
13961
13961
|
</dd>
|
|
13962
13962
|
</dl>
|
|
@@ -13972,8 +13972,8 @@ Creates a compliance document record for the caller's provider organization. | a
|
|
|
13972
13972
|
<dd>
|
|
13973
13973
|
|
|
13974
13974
|
```typescript
|
|
13975
|
-
await client.orgs.
|
|
13976
|
-
|
|
13975
|
+
await client.orgs.accounts.createV1({
|
|
13976
|
+
name: "name",
|
|
13977
13977
|
schema_version: 1,
|
|
13978
13978
|
});
|
|
13979
13979
|
```
|
|
@@ -13991,7 +13991,7 @@ await client.orgs.complianceDocuments.createV1({
|
|
|
13991
13991
|
<dl>
|
|
13992
13992
|
<dd>
|
|
13993
13993
|
|
|
13994
|
-
**request:** `Chrt.orgs.
|
|
13994
|
+
**request:** `Chrt.orgs.AccountClientCreate1`
|
|
13995
13995
|
|
|
13996
13996
|
</dd>
|
|
13997
13997
|
</dl>
|
|
@@ -13999,7 +13999,7 @@ await client.orgs.complianceDocuments.createV1({
|
|
|
13999
13999
|
<dl>
|
|
14000
14000
|
<dd>
|
|
14001
14001
|
|
|
14002
|
-
**requestOptions:** `
|
|
14002
|
+
**requestOptions:** `Accounts.RequestOptions`
|
|
14003
14003
|
|
|
14004
14004
|
</dd>
|
|
14005
14005
|
</dl>
|
|
@@ -14010,7 +14010,7 @@ await client.orgs.complianceDocuments.createV1({
|
|
|
14010
14010
|
</dl>
|
|
14011
14011
|
</details>
|
|
14012
14012
|
|
|
14013
|
-
<details><summary><code>client.orgs.
|
|
14013
|
+
<details><summary><code>client.orgs.accounts.<a href="/src/api/resources/orgs/resources/accounts/client/Client.ts">listV1</a>({ ...params }) -> Chrt.AccountListRes</code></summary>
|
|
14014
14014
|
<dl>
|
|
14015
14015
|
<dd>
|
|
14016
14016
|
|
|
@@ -14022,7 +14022,7 @@ await client.orgs.complianceDocuments.createV1({
|
|
|
14022
14022
|
<dl>
|
|
14023
14023
|
<dd>
|
|
14024
14024
|
|
|
14025
|
-
Lists
|
|
14025
|
+
Lists coordinator-created shipper accounts with association filters, sorting, and pagination. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (AccountListRes)
|
|
14026
14026
|
|
|
14027
14027
|
</dd>
|
|
14028
14028
|
</dl>
|
|
@@ -14038,7 +14038,14 @@ Lists compliance documents for the caller's provider organization. | authz: allo
|
|
|
14038
14038
|
<dd>
|
|
14039
14039
|
|
|
14040
14040
|
```typescript
|
|
14041
|
-
await client.orgs.
|
|
14041
|
+
await client.orgs.accounts.listV1({
|
|
14042
|
+
filter_org_id: "filter_org_id",
|
|
14043
|
+
filter_off_chrt_org_data_id: "filter_off_chrt_org_data_id",
|
|
14044
|
+
sort_by: "name",
|
|
14045
|
+
sort_order: "asc",
|
|
14046
|
+
page: 1,
|
|
14047
|
+
page_size: 1,
|
|
14048
|
+
});
|
|
14042
14049
|
```
|
|
14043
14050
|
|
|
14044
14051
|
</dd>
|
|
@@ -14054,7 +14061,15 @@ await client.orgs.complianceDocuments.listV1();
|
|
|
14054
14061
|
<dl>
|
|
14055
14062
|
<dd>
|
|
14056
14063
|
|
|
14057
|
-
**
|
|
14064
|
+
**request:** `Chrt.orgs.AccountsListV1Request`
|
|
14065
|
+
|
|
14066
|
+
</dd>
|
|
14067
|
+
</dl>
|
|
14068
|
+
|
|
14069
|
+
<dl>
|
|
14070
|
+
<dd>
|
|
14071
|
+
|
|
14072
|
+
**requestOptions:** `Accounts.RequestOptions`
|
|
14058
14073
|
|
|
14059
14074
|
</dd>
|
|
14060
14075
|
</dl>
|
|
@@ -14065,7 +14080,7 @@ await client.orgs.complianceDocuments.listV1();
|
|
|
14065
14080
|
</dl>
|
|
14066
14081
|
</details>
|
|
14067
14082
|
|
|
14068
|
-
<details><summary><code>client.orgs.
|
|
14083
|
+
<details><summary><code>client.orgs.accounts.<a href="/src/api/resources/orgs/resources/accounts/client/Client.ts">updateV1</a>(accountId, { ...params }) -> boolean</code></summary>
|
|
14069
14084
|
<dl>
|
|
14070
14085
|
<dd>
|
|
14071
14086
|
|
|
@@ -14077,7 +14092,7 @@ await client.orgs.complianceDocuments.listV1();
|
|
|
14077
14092
|
<dl>
|
|
14078
14093
|
<dd>
|
|
14079
14094
|
|
|
14080
|
-
Updates
|
|
14095
|
+
Updates the name of a coordinator-created shipper account. | authz: allowed_org_types=[provider], min_org_role=operator | (AccountClientUpdate1) -> (bool)
|
|
14081
14096
|
|
|
14082
14097
|
</dd>
|
|
14083
14098
|
</dl>
|
|
@@ -14093,7 +14108,7 @@ Updates an organization compliance document for the caller's provider organizati
|
|
|
14093
14108
|
<dd>
|
|
14094
14109
|
|
|
14095
14110
|
```typescript
|
|
14096
|
-
await client.orgs.
|
|
14111
|
+
await client.orgs.accounts.updateV1("account_id");
|
|
14097
14112
|
```
|
|
14098
14113
|
|
|
14099
14114
|
</dd>
|
|
@@ -14109,7 +14124,7 @@ await client.orgs.complianceDocuments.updateV1("org_compliance_document_id");
|
|
|
14109
14124
|
<dl>
|
|
14110
14125
|
<dd>
|
|
14111
14126
|
|
|
14112
|
-
**
|
|
14127
|
+
**accountId:** `string`
|
|
14113
14128
|
|
|
14114
14129
|
</dd>
|
|
14115
14130
|
</dl>
|
|
@@ -14117,7 +14132,7 @@ await client.orgs.complianceDocuments.updateV1("org_compliance_document_id");
|
|
|
14117
14132
|
<dl>
|
|
14118
14133
|
<dd>
|
|
14119
14134
|
|
|
14120
|
-
**request:** `Chrt.orgs.
|
|
14135
|
+
**request:** `Chrt.orgs.AccountClientUpdate1`
|
|
14121
14136
|
|
|
14122
14137
|
</dd>
|
|
14123
14138
|
</dl>
|
|
@@ -14125,7 +14140,7 @@ await client.orgs.complianceDocuments.updateV1("org_compliance_document_id");
|
|
|
14125
14140
|
<dl>
|
|
14126
14141
|
<dd>
|
|
14127
14142
|
|
|
14128
|
-
**requestOptions:** `
|
|
14143
|
+
**requestOptions:** `Accounts.RequestOptions`
|
|
14129
14144
|
|
|
14130
14145
|
</dd>
|
|
14131
14146
|
</dl>
|
|
@@ -14136,7 +14151,7 @@ await client.orgs.complianceDocuments.updateV1("org_compliance_document_id");
|
|
|
14136
14151
|
</dl>
|
|
14137
14152
|
</details>
|
|
14138
14153
|
|
|
14139
|
-
<details><summary><code>client.orgs.
|
|
14154
|
+
<details><summary><code>client.orgs.accounts.<a href="/src/api/resources/orgs/resources/accounts/client/Client.ts">getV1</a>(accountId) -> Chrt.Account1</code></summary>
|
|
14140
14155
|
<dl>
|
|
14141
14156
|
<dd>
|
|
14142
14157
|
|
|
@@ -14148,7 +14163,7 @@ await client.orgs.complianceDocuments.updateV1("org_compliance_document_id");
|
|
|
14148
14163
|
<dl>
|
|
14149
14164
|
<dd>
|
|
14150
14165
|
|
|
14151
|
-
Retrieves
|
|
14166
|
+
Retrieves a coordinator-created shipper account. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (Account1)
|
|
14152
14167
|
|
|
14153
14168
|
</dd>
|
|
14154
14169
|
</dl>
|
|
@@ -14164,7 +14179,7 @@ Retrieves one compliance document for the caller's provider organization. | auth
|
|
|
14164
14179
|
<dd>
|
|
14165
14180
|
|
|
14166
14181
|
```typescript
|
|
14167
|
-
await client.orgs.
|
|
14182
|
+
await client.orgs.accounts.getV1("account_id");
|
|
14168
14183
|
```
|
|
14169
14184
|
|
|
14170
14185
|
</dd>
|
|
@@ -14180,7 +14195,7 @@ await client.orgs.complianceDocuments.getV1("org_compliance_document_id");
|
|
|
14180
14195
|
<dl>
|
|
14181
14196
|
<dd>
|
|
14182
14197
|
|
|
14183
|
-
**
|
|
14198
|
+
**accountId:** `string`
|
|
14184
14199
|
|
|
14185
14200
|
</dd>
|
|
14186
14201
|
</dl>
|
|
@@ -14188,7 +14203,7 @@ await client.orgs.complianceDocuments.getV1("org_compliance_document_id");
|
|
|
14188
14203
|
<dl>
|
|
14189
14204
|
<dd>
|
|
14190
14205
|
|
|
14191
|
-
**requestOptions:** `
|
|
14206
|
+
**requestOptions:** `Accounts.RequestOptions`
|
|
14192
14207
|
|
|
14193
14208
|
</dd>
|
|
14194
14209
|
</dl>
|
|
@@ -14199,9 +14214,9 @@ await client.orgs.complianceDocuments.getV1("org_compliance_document_id");
|
|
|
14199
14214
|
</dl>
|
|
14200
14215
|
</details>
|
|
14201
14216
|
|
|
14202
|
-
## Orgs
|
|
14217
|
+
## Orgs ComplianceDocuments
|
|
14203
14218
|
|
|
14204
|
-
<details><summary><code>client.orgs.
|
|
14219
|
+
<details><summary><code>client.orgs.complianceDocuments.<a href="/src/api/resources/orgs/resources/complianceDocuments/client/Client.ts">createV1</a>({ ...params }) -> Chrt.OrgComplianceDocument1</code></summary>
|
|
14205
14220
|
<dl>
|
|
14206
14221
|
<dd>
|
|
14207
14222
|
|
|
@@ -14213,7 +14228,7 @@ await client.orgs.complianceDocuments.getV1("org_compliance_document_id");
|
|
|
14213
14228
|
<dl>
|
|
14214
14229
|
<dd>
|
|
14215
14230
|
|
|
14216
|
-
|
|
14231
|
+
Creates a compliance document record for the caller's provider organization. | authz: allowed_org_types=[provider], min_org_role=administrator | (OrgComplianceDocumentClientCreate1) -> (OrgComplianceDocument1)
|
|
14217
14232
|
|
|
14218
14233
|
</dd>
|
|
14219
14234
|
</dl>
|
|
@@ -14229,7 +14244,10 @@ Gets the connection between caller's org and the org with the specified handle.
|
|
|
14229
14244
|
<dd>
|
|
14230
14245
|
|
|
14231
14246
|
```typescript
|
|
14232
|
-
await client.orgs.
|
|
14247
|
+
await client.orgs.complianceDocuments.createV1({
|
|
14248
|
+
document_type: "security_threat_assessment",
|
|
14249
|
+
schema_version: 1,
|
|
14250
|
+
});
|
|
14233
14251
|
```
|
|
14234
14252
|
|
|
14235
14253
|
</dd>
|
|
@@ -14245,7 +14263,7 @@ await client.orgs.connections.getByHandleV1("handle");
|
|
|
14245
14263
|
<dl>
|
|
14246
14264
|
<dd>
|
|
14247
14265
|
|
|
14248
|
-
**
|
|
14266
|
+
**request:** `Chrt.orgs.OrgComplianceDocumentClientCreate1`
|
|
14249
14267
|
|
|
14250
14268
|
</dd>
|
|
14251
14269
|
</dl>
|
|
@@ -14253,7 +14271,7 @@ await client.orgs.connections.getByHandleV1("handle");
|
|
|
14253
14271
|
<dl>
|
|
14254
14272
|
<dd>
|
|
14255
14273
|
|
|
14256
|
-
**requestOptions:** `
|
|
14274
|
+
**requestOptions:** `ComplianceDocuments.RequestOptions`
|
|
14257
14275
|
|
|
14258
14276
|
</dd>
|
|
14259
14277
|
</dl>
|
|
@@ -14264,7 +14282,7 @@ await client.orgs.connections.getByHandleV1("handle");
|
|
|
14264
14282
|
</dl>
|
|
14265
14283
|
</details>
|
|
14266
14284
|
|
|
14267
|
-
<details><summary><code>client.orgs.
|
|
14285
|
+
<details><summary><code>client.orgs.complianceDocuments.<a href="/src/api/resources/orgs/resources/complianceDocuments/client/Client.ts">listV1</a>() -> Chrt.OrgComplianceDocument1[]</code></summary>
|
|
14268
14286
|
<dl>
|
|
14269
14287
|
<dd>
|
|
14270
14288
|
|
|
@@ -14276,7 +14294,7 @@ await client.orgs.connections.getByHandleV1("handle");
|
|
|
14276
14294
|
<dl>
|
|
14277
14295
|
<dd>
|
|
14278
14296
|
|
|
14279
|
-
Lists the caller's
|
|
14297
|
+
Lists compliance documents for the caller's provider organization. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (list[OrgComplianceDocument1])
|
|
14280
14298
|
|
|
14281
14299
|
</dd>
|
|
14282
14300
|
</dl>
|
|
@@ -14292,13 +14310,7 @@ Lists the caller's coordinator connections with filtering, pagination, and ident
|
|
|
14292
14310
|
<dd>
|
|
14293
14311
|
|
|
14294
14312
|
```typescript
|
|
14295
|
-
await client.orgs.
|
|
14296
|
-
search: "search",
|
|
14297
|
-
page: 1,
|
|
14298
|
-
page_size: 1,
|
|
14299
|
-
filter_auto_assign_enabled: true,
|
|
14300
|
-
filter_connected: true,
|
|
14301
|
-
});
|
|
14313
|
+
await client.orgs.complianceDocuments.listV1();
|
|
14302
14314
|
```
|
|
14303
14315
|
|
|
14304
14316
|
</dd>
|
|
@@ -14314,15 +14326,7 @@ await client.orgs.connections.listCoordinatorsForExecutorV1({
|
|
|
14314
14326
|
<dl>
|
|
14315
14327
|
<dd>
|
|
14316
14328
|
|
|
14317
|
-
**
|
|
14318
|
-
|
|
14319
|
-
</dd>
|
|
14320
|
-
</dl>
|
|
14321
|
-
|
|
14322
|
-
<dl>
|
|
14323
|
-
<dd>
|
|
14324
|
-
|
|
14325
|
-
**requestOptions:** `Connections.RequestOptions`
|
|
14329
|
+
**requestOptions:** `ComplianceDocuments.RequestOptions`
|
|
14326
14330
|
|
|
14327
14331
|
</dd>
|
|
14328
14332
|
</dl>
|
|
@@ -14333,7 +14337,7 @@ await client.orgs.connections.listCoordinatorsForExecutorV1({
|
|
|
14333
14337
|
</dl>
|
|
14334
14338
|
</details>
|
|
14335
14339
|
|
|
14336
|
-
<details><summary><code>client.orgs.
|
|
14340
|
+
<details><summary><code>client.orgs.complianceDocuments.<a href="/src/api/resources/orgs/resources/complianceDocuments/client/Client.ts">updateV1</a>(orgComplianceDocumentId, { ...params }) -> Chrt.OrgComplianceDocument1</code></summary>
|
|
14337
14341
|
<dl>
|
|
14338
14342
|
<dd>
|
|
14339
14343
|
|
|
@@ -14345,7 +14349,7 @@ await client.orgs.connections.listCoordinatorsForExecutorV1({
|
|
|
14345
14349
|
<dl>
|
|
14346
14350
|
<dd>
|
|
14347
14351
|
|
|
14348
|
-
|
|
14352
|
+
Updates an organization compliance document for the caller's provider organization. | authz: allowed_org_types=[provider], min_org_role=administrator | (OrgComplianceDocumentClientUpdate1) -> (OrgComplianceDocument1)
|
|
14349
14353
|
|
|
14350
14354
|
</dd>
|
|
14351
14355
|
</dl>
|
|
@@ -14361,12 +14365,7 @@ Lists the caller's coordinator connections with filtering, pagination, and ident
|
|
|
14361
14365
|
<dd>
|
|
14362
14366
|
|
|
14363
14367
|
```typescript
|
|
14364
|
-
await client.orgs.
|
|
14365
|
-
search: "search",
|
|
14366
|
-
page: 1,
|
|
14367
|
-
page_size: 1,
|
|
14368
|
-
filter_connected: true,
|
|
14369
|
-
});
|
|
14368
|
+
await client.orgs.complianceDocuments.updateV1("org_compliance_document_id");
|
|
14370
14369
|
```
|
|
14371
14370
|
|
|
14372
14371
|
</dd>
|
|
@@ -14382,7 +14381,7 @@ await client.orgs.connections.listCoordinatorsForShipperV1({
|
|
|
14382
14381
|
<dl>
|
|
14383
14382
|
<dd>
|
|
14384
14383
|
|
|
14385
|
-
**
|
|
14384
|
+
**orgComplianceDocumentId:** `string`
|
|
14386
14385
|
|
|
14387
14386
|
</dd>
|
|
14388
14387
|
</dl>
|
|
@@ -14390,7 +14389,15 @@ await client.orgs.connections.listCoordinatorsForShipperV1({
|
|
|
14390
14389
|
<dl>
|
|
14391
14390
|
<dd>
|
|
14392
14391
|
|
|
14393
|
-
**
|
|
14392
|
+
**request:** `Chrt.orgs.OrgComplianceDocumentClientUpdate1`
|
|
14393
|
+
|
|
14394
|
+
</dd>
|
|
14395
|
+
</dl>
|
|
14396
|
+
|
|
14397
|
+
<dl>
|
|
14398
|
+
<dd>
|
|
14399
|
+
|
|
14400
|
+
**requestOptions:** `ComplianceDocuments.RequestOptions`
|
|
14394
14401
|
|
|
14395
14402
|
</dd>
|
|
14396
14403
|
</dl>
|
|
@@ -14401,7 +14408,7 @@ await client.orgs.connections.listCoordinatorsForShipperV1({
|
|
|
14401
14408
|
</dl>
|
|
14402
14409
|
</details>
|
|
14403
14410
|
|
|
14404
|
-
<details><summary><code>client.orgs.
|
|
14411
|
+
<details><summary><code>client.orgs.complianceDocuments.<a href="/src/api/resources/orgs/resources/complianceDocuments/client/Client.ts">getV1</a>(orgComplianceDocumentId) -> Chrt.OrgComplianceDocument1</code></summary>
|
|
14405
14412
|
<dl>
|
|
14406
14413
|
<dd>
|
|
14407
14414
|
|
|
@@ -14413,7 +14420,7 @@ await client.orgs.connections.listCoordinatorsForShipperV1({
|
|
|
14413
14420
|
<dl>
|
|
14414
14421
|
<dd>
|
|
14415
14422
|
|
|
14416
|
-
|
|
14423
|
+
Retrieves one compliance document for the caller's provider organization. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (OrgComplianceDocument1)
|
|
14417
14424
|
|
|
14418
14425
|
</dd>
|
|
14419
14426
|
</dl>
|
|
@@ -14429,9 +14436,7 @@ Creates a shipper-coordinator or coordinator-executor connection to an on-CHRT p
|
|
|
14429
14436
|
<dd>
|
|
14430
14437
|
|
|
14431
14438
|
```typescript
|
|
14432
|
-
await client.orgs.
|
|
14433
|
-
handle: "handle",
|
|
14434
|
-
});
|
|
14439
|
+
await client.orgs.complianceDocuments.getV1("org_compliance_document_id");
|
|
14435
14440
|
```
|
|
14436
14441
|
|
|
14437
14442
|
</dd>
|
|
@@ -14447,7 +14452,7 @@ await client.orgs.connections.createConnectionToProviderV1({
|
|
|
14447
14452
|
<dl>
|
|
14448
14453
|
<dd>
|
|
14449
14454
|
|
|
14450
|
-
**
|
|
14455
|
+
**orgComplianceDocumentId:** `string`
|
|
14451
14456
|
|
|
14452
14457
|
</dd>
|
|
14453
14458
|
</dl>
|
|
@@ -14455,7 +14460,7 @@ await client.orgs.connections.createConnectionToProviderV1({
|
|
|
14455
14460
|
<dl>
|
|
14456
14461
|
<dd>
|
|
14457
14462
|
|
|
14458
|
-
**requestOptions:** `
|
|
14463
|
+
**requestOptions:** `ComplianceDocuments.RequestOptions`
|
|
14459
14464
|
|
|
14460
14465
|
</dd>
|
|
14461
14466
|
</dl>
|
|
@@ -14466,7 +14471,9 @@ await client.orgs.connections.createConnectionToProviderV1({
|
|
|
14466
14471
|
</dl>
|
|
14467
14472
|
</details>
|
|
14468
14473
|
|
|
14469
|
-
|
|
14474
|
+
## Orgs Connections
|
|
14475
|
+
|
|
14476
|
+
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">getByHandleV1</a>(handle) -> (Chrt.ConnectionsGetByHandleV1Response | null) | undefined</code></summary>
|
|
14470
14477
|
<dl>
|
|
14471
14478
|
<dd>
|
|
14472
14479
|
|
|
@@ -14478,7 +14485,7 @@ await client.orgs.connections.createConnectionToProviderV1({
|
|
|
14478
14485
|
<dl>
|
|
14479
14486
|
<dd>
|
|
14480
14487
|
|
|
14481
|
-
|
|
14488
|
+
Gets the connection between caller's org and the org with the specified handle. | () -> (ShipperCoordinatorConnection1 | CoordinatorExecutorConnection1 | None)
|
|
14482
14489
|
|
|
14483
14490
|
</dd>
|
|
14484
14491
|
</dl>
|
|
@@ -14494,9 +14501,7 @@ Creates a shipper-coordinator connection to an on-CHRT shipper. | authz: allowed
|
|
|
14494
14501
|
<dd>
|
|
14495
14502
|
|
|
14496
14503
|
```typescript
|
|
14497
|
-
await client.orgs.connections.
|
|
14498
|
-
handle: "handle",
|
|
14499
|
-
});
|
|
14504
|
+
await client.orgs.connections.getByHandleV1("handle");
|
|
14500
14505
|
```
|
|
14501
14506
|
|
|
14502
14507
|
</dd>
|
|
@@ -14512,7 +14517,7 @@ await client.orgs.connections.createConnectionToShipperV1({
|
|
|
14512
14517
|
<dl>
|
|
14513
14518
|
<dd>
|
|
14514
14519
|
|
|
14515
|
-
**
|
|
14520
|
+
**handle:** `string`
|
|
14516
14521
|
|
|
14517
14522
|
</dd>
|
|
14518
14523
|
</dl>
|
|
@@ -14531,7 +14536,7 @@ await client.orgs.connections.createConnectionToShipperV1({
|
|
|
14531
14536
|
</dl>
|
|
14532
14537
|
</details>
|
|
14533
14538
|
|
|
14534
|
-
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">
|
|
14539
|
+
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">listCoordinatorsForExecutorV1</a>({ ...params }) -> Chrt.CoordinatorExecutorConnectionsForExecutorListRes</code></summary>
|
|
14535
14540
|
<dl>
|
|
14536
14541
|
<dd>
|
|
14537
14542
|
|
|
@@ -14543,7 +14548,7 @@ await client.orgs.connections.createConnectionToShipperV1({
|
|
|
14543
14548
|
<dl>
|
|
14544
14549
|
<dd>
|
|
14545
14550
|
|
|
14546
|
-
Lists the caller's
|
|
14551
|
+
Lists the caller's coordinator connections with filtering, pagination, and identity search. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (CoordinatorExecutorConnectionsForExecutorListRes)
|
|
14547
14552
|
|
|
14548
14553
|
</dd>
|
|
14549
14554
|
</dl>
|
|
@@ -14559,9 +14564,8 @@ Lists the caller's executor connections nearest to a location, with filtering an
|
|
|
14559
14564
|
<dd>
|
|
14560
14565
|
|
|
14561
14566
|
```typescript
|
|
14562
|
-
await client.orgs.connections.
|
|
14563
|
-
|
|
14564
|
-
near_longitude: 1.1,
|
|
14567
|
+
await client.orgs.connections.listCoordinatorsForExecutorV1({
|
|
14568
|
+
search: "search",
|
|
14565
14569
|
page: 1,
|
|
14566
14570
|
page_size: 1,
|
|
14567
14571
|
filter_auto_assign_enabled: true,
|
|
@@ -14582,7 +14586,7 @@ await client.orgs.connections.listExecutorsGeoSearchForCoordinatorV1({
|
|
|
14582
14586
|
<dl>
|
|
14583
14587
|
<dd>
|
|
14584
14588
|
|
|
14585
|
-
**request:** `Chrt.orgs.
|
|
14589
|
+
**request:** `Chrt.orgs.ConnectionsListCoordinatorsForExecutorV1Request`
|
|
14586
14590
|
|
|
14587
14591
|
</dd>
|
|
14588
14592
|
</dl>
|
|
@@ -14601,7 +14605,7 @@ await client.orgs.connections.listExecutorsGeoSearchForCoordinatorV1({
|
|
|
14601
14605
|
</dl>
|
|
14602
14606
|
</details>
|
|
14603
14607
|
|
|
14604
|
-
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">
|
|
14608
|
+
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">listCoordinatorsForShipperV1</a>({ ...params }) -> Chrt.ShipperCoordinatorConnectionsForShipperListRes</code></summary>
|
|
14605
14609
|
<dl>
|
|
14606
14610
|
<dd>
|
|
14607
14611
|
|
|
@@ -14613,7 +14617,7 @@ await client.orgs.connections.listExecutorsGeoSearchForCoordinatorV1({
|
|
|
14613
14617
|
<dl>
|
|
14614
14618
|
<dd>
|
|
14615
14619
|
|
|
14616
|
-
Lists the caller's
|
|
14620
|
+
Lists the caller's coordinator connections with filtering, pagination, and identity search. | authz: allowed_org_types=[shipper] | () -> (ShipperCoordinatorConnectionsForShipperListRes)
|
|
14617
14621
|
|
|
14618
14622
|
</dd>
|
|
14619
14623
|
</dl>
|
|
@@ -14629,11 +14633,10 @@ Lists the caller's executor connections with filtering, pagination, and identity
|
|
|
14629
14633
|
<dd>
|
|
14630
14634
|
|
|
14631
14635
|
```typescript
|
|
14632
|
-
await client.orgs.connections.
|
|
14636
|
+
await client.orgs.connections.listCoordinatorsForShipperV1({
|
|
14633
14637
|
search: "search",
|
|
14634
14638
|
page: 1,
|
|
14635
14639
|
page_size: 1,
|
|
14636
|
-
filter_auto_assign_enabled: true,
|
|
14637
14640
|
filter_connected: true,
|
|
14638
14641
|
});
|
|
14639
14642
|
```
|
|
@@ -14651,7 +14654,7 @@ await client.orgs.connections.listExecutorsForCoordinatorV1({
|
|
|
14651
14654
|
<dl>
|
|
14652
14655
|
<dd>
|
|
14653
14656
|
|
|
14654
|
-
**request:** `Chrt.orgs.
|
|
14657
|
+
**request:** `Chrt.orgs.ConnectionsListCoordinatorsForShipperV1Request`
|
|
14655
14658
|
|
|
14656
14659
|
</dd>
|
|
14657
14660
|
</dl>
|
|
@@ -14670,7 +14673,7 @@ await client.orgs.connections.listExecutorsForCoordinatorV1({
|
|
|
14670
14673
|
</dl>
|
|
14671
14674
|
</details>
|
|
14672
14675
|
|
|
14673
|
-
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">
|
|
14676
|
+
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">createConnectionToProviderV1</a>({ ...params }) -> string</code></summary>
|
|
14674
14677
|
<dl>
|
|
14675
14678
|
<dd>
|
|
14676
14679
|
|
|
@@ -14682,7 +14685,7 @@ await client.orgs.connections.listExecutorsForCoordinatorV1({
|
|
|
14682
14685
|
<dl>
|
|
14683
14686
|
<dd>
|
|
14684
14687
|
|
|
14685
|
-
|
|
14688
|
+
Creates a shipper-coordinator or coordinator-executor connection to an on-CHRT provider. | (CreateConnectionReq) -> (PydanticObjectId)
|
|
14686
14689
|
|
|
14687
14690
|
</dd>
|
|
14688
14691
|
</dl>
|
|
@@ -14698,8 +14701,8 @@ Sets an executor's consent to direct task-group assignment. | authz: allowed_org
|
|
|
14698
14701
|
<dd>
|
|
14699
14702
|
|
|
14700
14703
|
```typescript
|
|
14701
|
-
await client.orgs.connections.
|
|
14702
|
-
|
|
14704
|
+
await client.orgs.connections.createConnectionToProviderV1({
|
|
14705
|
+
handle: "handle",
|
|
14703
14706
|
});
|
|
14704
14707
|
```
|
|
14705
14708
|
|
|
@@ -14716,15 +14719,7 @@ await client.orgs.connections.setCoordinatorExecutorAutoAssignV1("connection_id"
|
|
|
14716
14719
|
<dl>
|
|
14717
14720
|
<dd>
|
|
14718
14721
|
|
|
14719
|
-
**
|
|
14720
|
-
|
|
14721
|
-
</dd>
|
|
14722
|
-
</dl>
|
|
14723
|
-
|
|
14724
|
-
<dl>
|
|
14725
|
-
<dd>
|
|
14726
|
-
|
|
14727
|
-
**request:** `Chrt.orgs.CoordinatorExecutorUpdateAutoAssignReq`
|
|
14722
|
+
**request:** `Chrt.CreateConnectionReq`
|
|
14728
14723
|
|
|
14729
14724
|
</dd>
|
|
14730
14725
|
</dl>
|
|
@@ -14743,7 +14738,7 @@ await client.orgs.connections.setCoordinatorExecutorAutoAssignV1("connection_id"
|
|
|
14743
14738
|
</dl>
|
|
14744
14739
|
</details>
|
|
14745
14740
|
|
|
14746
|
-
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">
|
|
14741
|
+
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">createConnectionToShipperV1</a>({ ...params }) -> string</code></summary>
|
|
14747
14742
|
<dl>
|
|
14748
14743
|
<dd>
|
|
14749
14744
|
|
|
@@ -14755,7 +14750,7 @@ await client.orgs.connections.setCoordinatorExecutorAutoAssignV1("connection_id"
|
|
|
14755
14750
|
<dl>
|
|
14756
14751
|
<dd>
|
|
14757
14752
|
|
|
14758
|
-
|
|
14753
|
+
Creates a shipper-coordinator connection to an on-CHRT shipper. | authz: allowed_org_types=[provider] | (CreateConnectionReq) -> (PydanticObjectId)
|
|
14759
14754
|
|
|
14760
14755
|
</dd>
|
|
14761
14756
|
</dl>
|
|
@@ -14771,7 +14766,9 @@ Sets or clears the coordinator's default department for a shipper-coordinator co
|
|
|
14771
14766
|
<dd>
|
|
14772
14767
|
|
|
14773
14768
|
```typescript
|
|
14774
|
-
await client.orgs.connections.
|
|
14769
|
+
await client.orgs.connections.createConnectionToShipperV1({
|
|
14770
|
+
handle: "handle",
|
|
14771
|
+
});
|
|
14775
14772
|
```
|
|
14776
14773
|
|
|
14777
14774
|
</dd>
|
|
@@ -14787,15 +14784,7 @@ await client.orgs.connections.setShipperCoordinatorDefaultDepartmentV1("connecti
|
|
|
14787
14784
|
<dl>
|
|
14788
14785
|
<dd>
|
|
14789
14786
|
|
|
14790
|
-
**
|
|
14791
|
-
|
|
14792
|
-
</dd>
|
|
14793
|
-
</dl>
|
|
14794
|
-
|
|
14795
|
-
<dl>
|
|
14796
|
-
<dd>
|
|
14797
|
-
|
|
14798
|
-
**request:** `Chrt.orgs.ShipperCoordinatorConnectionClientUpdate1`
|
|
14787
|
+
**request:** `Chrt.CreateConnectionReq`
|
|
14799
14788
|
|
|
14800
14789
|
</dd>
|
|
14801
14790
|
</dl>
|
|
@@ -14814,7 +14803,7 @@ await client.orgs.connections.setShipperCoordinatorDefaultDepartmentV1("connecti
|
|
|
14814
14803
|
</dl>
|
|
14815
14804
|
</details>
|
|
14816
14805
|
|
|
14817
|
-
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">
|
|
14806
|
+
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">listExecutorsGeoSearchForCoordinatorV1</a>({ ...params }) -> Chrt.CoordinatorExecutorConnectionsForCoordinatorGeoSearchListRes</code></summary>
|
|
14818
14807
|
<dl>
|
|
14819
14808
|
<dd>
|
|
14820
14809
|
|
|
@@ -14826,7 +14815,7 @@ await client.orgs.connections.setShipperCoordinatorDefaultDepartmentV1("connecti
|
|
|
14826
14815
|
<dl>
|
|
14827
14816
|
<dd>
|
|
14828
14817
|
|
|
14829
|
-
Lists the caller's
|
|
14818
|
+
Lists the caller's executor connections nearest to a location, with filtering and pagination. Executors without registered addresses follow geocoded results. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (CoordinatorExecutorConnectionsForCoordinatorGeoSearchListRes)
|
|
14830
14819
|
|
|
14831
14820
|
</dd>
|
|
14832
14821
|
</dl>
|
|
@@ -14842,10 +14831,12 @@ Lists the caller's shipper connections with filtering, pagination, and identity
|
|
|
14842
14831
|
<dd>
|
|
14843
14832
|
|
|
14844
14833
|
```typescript
|
|
14845
|
-
await client.orgs.connections.
|
|
14846
|
-
|
|
14834
|
+
await client.orgs.connections.listExecutorsGeoSearchForCoordinatorV1({
|
|
14835
|
+
near_latitude: 1.1,
|
|
14836
|
+
near_longitude: 1.1,
|
|
14847
14837
|
page: 1,
|
|
14848
14838
|
page_size: 1,
|
|
14839
|
+
filter_auto_assign_enabled: true,
|
|
14849
14840
|
filter_connected: true,
|
|
14850
14841
|
});
|
|
14851
14842
|
```
|
|
@@ -14863,7 +14854,7 @@ await client.orgs.connections.listShippersForCoordinatorV1({
|
|
|
14863
14854
|
<dl>
|
|
14864
14855
|
<dd>
|
|
14865
14856
|
|
|
14866
|
-
**request:** `Chrt.orgs.
|
|
14857
|
+
**request:** `Chrt.orgs.ConnectionsListExecutorsGeoSearchForCoordinatorV1Request`
|
|
14867
14858
|
|
|
14868
14859
|
</dd>
|
|
14869
14860
|
</dl>
|
|
@@ -14882,9 +14873,7 @@ await client.orgs.connections.listShippersForCoordinatorV1({
|
|
|
14882
14873
|
</dl>
|
|
14883
14874
|
</details>
|
|
14884
14875
|
|
|
14885
|
-
|
|
14886
|
-
|
|
14887
|
-
<details><summary><code>client.orgs.directoryEntries.<a href="/src/api/resources/orgs/resources/directoryEntries/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
14876
|
+
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">listExecutorsForCoordinatorV1</a>({ ...params }) -> Chrt.CoordinatorExecutorConnectionsForCoordinatorListRes</code></summary>
|
|
14888
14877
|
<dl>
|
|
14889
14878
|
<dd>
|
|
14890
14879
|
|
|
@@ -14896,7 +14885,7 @@ await client.orgs.connections.listShippersForCoordinatorV1({
|
|
|
14896
14885
|
<dl>
|
|
14897
14886
|
<dd>
|
|
14898
14887
|
|
|
14899
|
-
|
|
14888
|
+
Lists the caller's executor connections with filtering, pagination, and identity search. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (CoordinatorExecutorConnectionsForCoordinatorListRes)
|
|
14900
14889
|
|
|
14901
14890
|
</dd>
|
|
14902
14891
|
</dl>
|
|
@@ -14912,9 +14901,12 @@ Creates an organization-owned directory entry. | authz: min_org_role=operator |
|
|
|
14912
14901
|
<dd>
|
|
14913
14902
|
|
|
14914
14903
|
```typescript
|
|
14915
|
-
await client.orgs.
|
|
14916
|
-
|
|
14917
|
-
|
|
14904
|
+
await client.orgs.connections.listExecutorsForCoordinatorV1({
|
|
14905
|
+
search: "search",
|
|
14906
|
+
page: 1,
|
|
14907
|
+
page_size: 1,
|
|
14908
|
+
filter_auto_assign_enabled: true,
|
|
14909
|
+
filter_connected: true,
|
|
14918
14910
|
});
|
|
14919
14911
|
```
|
|
14920
14912
|
|
|
@@ -14931,7 +14923,7 @@ await client.orgs.directoryEntries.createV1({
|
|
|
14931
14923
|
<dl>
|
|
14932
14924
|
<dd>
|
|
14933
14925
|
|
|
14934
|
-
**request:** `Chrt.orgs.
|
|
14926
|
+
**request:** `Chrt.orgs.ConnectionsListExecutorsForCoordinatorV1Request`
|
|
14935
14927
|
|
|
14936
14928
|
</dd>
|
|
14937
14929
|
</dl>
|
|
@@ -14939,7 +14931,7 @@ await client.orgs.directoryEntries.createV1({
|
|
|
14939
14931
|
<dl>
|
|
14940
14932
|
<dd>
|
|
14941
14933
|
|
|
14942
|
-
**requestOptions:** `
|
|
14934
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
14943
14935
|
|
|
14944
14936
|
</dd>
|
|
14945
14937
|
</dl>
|
|
@@ -14950,7 +14942,7 @@ await client.orgs.directoryEntries.createV1({
|
|
|
14950
14942
|
</dl>
|
|
14951
14943
|
</details>
|
|
14952
14944
|
|
|
14953
|
-
<details><summary><code>client.orgs.
|
|
14945
|
+
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">setCoordinatorExecutorAutoAssignV1</a>(connectionId, { ...params }) -> boolean</code></summary>
|
|
14954
14946
|
<dl>
|
|
14955
14947
|
<dd>
|
|
14956
14948
|
|
|
@@ -14962,7 +14954,7 @@ await client.orgs.directoryEntries.createV1({
|
|
|
14962
14954
|
<dl>
|
|
14963
14955
|
<dd>
|
|
14964
14956
|
|
|
14965
|
-
|
|
14957
|
+
Sets an executor's consent to direct task-group assignment. | authz: allowed_org_types=[provider], min_org_role=administrator | (CoordinatorExecutorUpdateAutoAssignReq) -> (bool)
|
|
14966
14958
|
|
|
14967
14959
|
</dd>
|
|
14968
14960
|
</dl>
|
|
@@ -14978,7 +14970,9 @@ Deletes an organization-owned directory entry. | authz: min_org_role=operator |
|
|
|
14978
14970
|
<dd>
|
|
14979
14971
|
|
|
14980
14972
|
```typescript
|
|
14981
|
-
await client.orgs.
|
|
14973
|
+
await client.orgs.connections.setCoordinatorExecutorAutoAssignV1("connection_id", {
|
|
14974
|
+
auto_assign_enabled: true,
|
|
14975
|
+
});
|
|
14982
14976
|
```
|
|
14983
14977
|
|
|
14984
14978
|
</dd>
|
|
@@ -14994,78 +14988,15 @@ await client.orgs.directoryEntries.deleteV1("directory_entry_id");
|
|
|
14994
14988
|
<dl>
|
|
14995
14989
|
<dd>
|
|
14996
14990
|
|
|
14997
|
-
**
|
|
14998
|
-
|
|
14999
|
-
</dd>
|
|
15000
|
-
</dl>
|
|
15001
|
-
|
|
15002
|
-
<dl>
|
|
15003
|
-
<dd>
|
|
15004
|
-
|
|
15005
|
-
**requestOptions:** `DirectoryEntries.RequestOptions`
|
|
15006
|
-
|
|
15007
|
-
</dd>
|
|
15008
|
-
</dl>
|
|
15009
|
-
</dd>
|
|
15010
|
-
</dl>
|
|
15011
|
-
|
|
15012
|
-
</dd>
|
|
15013
|
-
</dl>
|
|
15014
|
-
</details>
|
|
15015
|
-
|
|
15016
|
-
<details><summary><code>client.orgs.directoryEntries.<a href="/src/api/resources/orgs/resources/directoryEntries/client/Client.ts">listV1</a>({ ...params }) -> Chrt.DirectoryEntryListRes</code></summary>
|
|
15017
|
-
<dl>
|
|
15018
|
-
<dd>
|
|
15019
|
-
|
|
15020
|
-
#### 📝 Description
|
|
15021
|
-
|
|
15022
|
-
<dl>
|
|
15023
|
-
<dd>
|
|
15024
|
-
|
|
15025
|
-
<dl>
|
|
15026
|
-
<dd>
|
|
15027
|
-
|
|
15028
|
-
Lists organization-owned directory entries with association filters and search. | authz: min_org_role=operator | () -> (DirectoryEntryListRes)
|
|
15029
|
-
|
|
15030
|
-
</dd>
|
|
15031
|
-
</dl>
|
|
15032
|
-
</dd>
|
|
15033
|
-
</dl>
|
|
15034
|
-
|
|
15035
|
-
#### 🔌 Usage
|
|
15036
|
-
|
|
15037
|
-
<dl>
|
|
15038
|
-
<dd>
|
|
15039
|
-
|
|
15040
|
-
<dl>
|
|
15041
|
-
<dd>
|
|
15042
|
-
|
|
15043
|
-
```typescript
|
|
15044
|
-
await client.orgs.directoryEntries.listV1({
|
|
15045
|
-
search: "search",
|
|
15046
|
-
filter_entry_org_id: "filter_entry_org_id",
|
|
15047
|
-
filter_entry_off_chrt_org_data_id: "filter_entry_off_chrt_org_data_id",
|
|
15048
|
-
sort_by: "name",
|
|
15049
|
-
sort_order: "asc",
|
|
15050
|
-
page: 1,
|
|
15051
|
-
page_size: 1,
|
|
15052
|
-
});
|
|
15053
|
-
```
|
|
14991
|
+
**connectionId:** `string`
|
|
15054
14992
|
|
|
15055
|
-
</dd>
|
|
15056
|
-
</dl>
|
|
15057
14993
|
</dd>
|
|
15058
14994
|
</dl>
|
|
15059
14995
|
|
|
15060
|
-
#### ⚙️ Parameters
|
|
15061
|
-
|
|
15062
|
-
<dl>
|
|
15063
|
-
<dd>
|
|
15064
|
-
|
|
15065
14996
|
<dl>
|
|
15066
14997
|
<dd>
|
|
15067
14998
|
|
|
15068
|
-
**request:** `Chrt.orgs.
|
|
14999
|
+
**request:** `Chrt.orgs.CoordinatorExecutorUpdateAutoAssignReq`
|
|
15069
15000
|
|
|
15070
15001
|
</dd>
|
|
15071
15002
|
</dl>
|
|
@@ -15073,7 +15004,7 @@ await client.orgs.directoryEntries.listV1({
|
|
|
15073
15004
|
<dl>
|
|
15074
15005
|
<dd>
|
|
15075
15006
|
|
|
15076
|
-
**requestOptions:** `
|
|
15007
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
15077
15008
|
|
|
15078
15009
|
</dd>
|
|
15079
15010
|
</dl>
|
|
@@ -15084,7 +15015,7 @@ await client.orgs.directoryEntries.listV1({
|
|
|
15084
15015
|
</dl>
|
|
15085
15016
|
</details>
|
|
15086
15017
|
|
|
15087
|
-
<details><summary><code>client.orgs.
|
|
15018
|
+
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">setShipperCoordinatorDefaultDepartmentV1</a>(connectionId, { ...params }) -> boolean</code></summary>
|
|
15088
15019
|
<dl>
|
|
15089
15020
|
<dd>
|
|
15090
15021
|
|
|
@@ -15096,7 +15027,7 @@ await client.orgs.directoryEntries.listV1({
|
|
|
15096
15027
|
<dl>
|
|
15097
15028
|
<dd>
|
|
15098
15029
|
|
|
15099
|
-
|
|
15030
|
+
Sets or clears the coordinator's default department for a shipper-coordinator connection. | authz: allowed_org_types=[provider], min_org_role=operator | (ShipperCoordinatorConnectionClientUpdate1) -> (bool)
|
|
15100
15031
|
|
|
15101
15032
|
</dd>
|
|
15102
15033
|
</dl>
|
|
@@ -15112,7 +15043,7 @@ Updates an organization-owned directory entry. | authz: min_org_role=operator |
|
|
|
15112
15043
|
<dd>
|
|
15113
15044
|
|
|
15114
15045
|
```typescript
|
|
15115
|
-
await client.orgs.
|
|
15046
|
+
await client.orgs.connections.setShipperCoordinatorDefaultDepartmentV1("connection_id");
|
|
15116
15047
|
```
|
|
15117
15048
|
|
|
15118
15049
|
</dd>
|
|
@@ -15128,7 +15059,7 @@ await client.orgs.directoryEntries.updateV1("directory_entry_id");
|
|
|
15128
15059
|
<dl>
|
|
15129
15060
|
<dd>
|
|
15130
15061
|
|
|
15131
|
-
**
|
|
15062
|
+
**connectionId:** `string`
|
|
15132
15063
|
|
|
15133
15064
|
</dd>
|
|
15134
15065
|
</dl>
|
|
@@ -15136,7 +15067,7 @@ await client.orgs.directoryEntries.updateV1("directory_entry_id");
|
|
|
15136
15067
|
<dl>
|
|
15137
15068
|
<dd>
|
|
15138
15069
|
|
|
15139
|
-
**request:** `Chrt.orgs.
|
|
15070
|
+
**request:** `Chrt.orgs.ShipperCoordinatorConnectionClientUpdate1`
|
|
15140
15071
|
|
|
15141
15072
|
</dd>
|
|
15142
15073
|
</dl>
|
|
@@ -15144,7 +15075,7 @@ await client.orgs.directoryEntries.updateV1("directory_entry_id");
|
|
|
15144
15075
|
<dl>
|
|
15145
15076
|
<dd>
|
|
15146
15077
|
|
|
15147
|
-
**requestOptions:** `
|
|
15078
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
15148
15079
|
|
|
15149
15080
|
</dd>
|
|
15150
15081
|
</dl>
|
|
@@ -15155,7 +15086,7 @@ await client.orgs.directoryEntries.updateV1("directory_entry_id");
|
|
|
15155
15086
|
</dl>
|
|
15156
15087
|
</details>
|
|
15157
15088
|
|
|
15158
|
-
<details><summary><code>client.orgs.
|
|
15089
|
+
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">listShippersForCoordinatorV1</a>({ ...params }) -> Chrt.ShipperCoordinatorConnectionsForCoordinatorListRes</code></summary>
|
|
15159
15090
|
<dl>
|
|
15160
15091
|
<dd>
|
|
15161
15092
|
|
|
@@ -15167,7 +15098,7 @@ await client.orgs.directoryEntries.updateV1("directory_entry_id");
|
|
|
15167
15098
|
<dl>
|
|
15168
15099
|
<dd>
|
|
15169
15100
|
|
|
15170
|
-
|
|
15101
|
+
Lists the caller's shipper connections with filtering, pagination, and identity search. | authz: allowed_org_types=[provider] | () -> (ShipperCoordinatorConnectionsForCoordinatorListRes)
|
|
15171
15102
|
|
|
15172
15103
|
</dd>
|
|
15173
15104
|
</dl>
|
|
@@ -15183,7 +15114,12 @@ Retrieves an organization-owned directory entry. | authz: min_org_role=operator
|
|
|
15183
15114
|
<dd>
|
|
15184
15115
|
|
|
15185
15116
|
```typescript
|
|
15186
|
-
await client.orgs.
|
|
15117
|
+
await client.orgs.connections.listShippersForCoordinatorV1({
|
|
15118
|
+
search: "search",
|
|
15119
|
+
page: 1,
|
|
15120
|
+
page_size: 1,
|
|
15121
|
+
filter_connected: true,
|
|
15122
|
+
});
|
|
15187
15123
|
```
|
|
15188
15124
|
|
|
15189
15125
|
</dd>
|
|
@@ -15199,7 +15135,7 @@ await client.orgs.directoryEntries.getV1("directory_entry_id");
|
|
|
15199
15135
|
<dl>
|
|
15200
15136
|
<dd>
|
|
15201
15137
|
|
|
15202
|
-
**
|
|
15138
|
+
**request:** `Chrt.orgs.ConnectionsListShippersForCoordinatorV1Request`
|
|
15203
15139
|
|
|
15204
15140
|
</dd>
|
|
15205
15141
|
</dl>
|
|
@@ -15207,7 +15143,7 @@ await client.orgs.directoryEntries.getV1("directory_entry_id");
|
|
|
15207
15143
|
<dl>
|
|
15208
15144
|
<dd>
|
|
15209
15145
|
|
|
15210
|
-
**requestOptions:** `
|
|
15146
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
15211
15147
|
|
|
15212
15148
|
</dd>
|
|
15213
15149
|
</dl>
|
|
@@ -15218,9 +15154,9 @@ await client.orgs.directoryEntries.getV1("directory_entry_id");
|
|
|
15218
15154
|
</dl>
|
|
15219
15155
|
</details>
|
|
15220
15156
|
|
|
15221
|
-
## Orgs
|
|
15157
|
+
## Orgs Contacts
|
|
15222
15158
|
|
|
15223
|
-
<details><summary><code>client.orgs.
|
|
15159
|
+
<details><summary><code>client.orgs.contacts.<a href="/src/api/resources/orgs/resources/contacts/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
15224
15160
|
<dl>
|
|
15225
15161
|
<dd>
|
|
15226
15162
|
|
|
@@ -15232,7 +15168,7 @@ await client.orgs.directoryEntries.getV1("directory_entry_id");
|
|
|
15232
15168
|
<dl>
|
|
15233
15169
|
<dd>
|
|
15234
15170
|
|
|
15235
|
-
|
|
15171
|
+
Creates an organization-created contact. | authz: min_org_role=operator | (ContactClientCreate1) -> (PydanticObjectId)
|
|
15236
15172
|
|
|
15237
15173
|
</dd>
|
|
15238
15174
|
</dl>
|
|
@@ -15248,12 +15184,9 @@ Atomically creates owner-scoped off-CHRT organization data and its shipper-coord
|
|
|
15248
15184
|
<dd>
|
|
15249
15185
|
|
|
15250
15186
|
```typescript
|
|
15251
|
-
await client.orgs.
|
|
15252
|
-
|
|
15253
|
-
|
|
15254
|
-
org_type: "provider",
|
|
15255
|
-
schema_version: 1,
|
|
15256
|
-
},
|
|
15187
|
+
await client.orgs.contacts.createV1({
|
|
15188
|
+
name: "name",
|
|
15189
|
+
schema_version: 1,
|
|
15257
15190
|
});
|
|
15258
15191
|
```
|
|
15259
15192
|
|
|
@@ -15270,7 +15203,7 @@ await client.orgs.offChrtOrgData.createV1({
|
|
|
15270
15203
|
<dl>
|
|
15271
15204
|
<dd>
|
|
15272
15205
|
|
|
15273
|
-
**request:** `Chrt.orgs.
|
|
15206
|
+
**request:** `Chrt.orgs.ContactClientCreate1`
|
|
15274
15207
|
|
|
15275
15208
|
</dd>
|
|
15276
15209
|
</dl>
|
|
@@ -15278,7 +15211,7 @@ await client.orgs.offChrtOrgData.createV1({
|
|
|
15278
15211
|
<dl>
|
|
15279
15212
|
<dd>
|
|
15280
15213
|
|
|
15281
|
-
**requestOptions:** `
|
|
15214
|
+
**requestOptions:** `Contacts.RequestOptions`
|
|
15282
15215
|
|
|
15283
15216
|
</dd>
|
|
15284
15217
|
</dl>
|
|
@@ -15289,7 +15222,7 @@ await client.orgs.offChrtOrgData.createV1({
|
|
|
15289
15222
|
</dl>
|
|
15290
15223
|
</details>
|
|
15291
15224
|
|
|
15292
|
-
<details><summary><code>client.orgs.
|
|
15225
|
+
<details><summary><code>client.orgs.contacts.<a href="/src/api/resources/orgs/resources/contacts/client/Client.ts">deleteV1</a>(contactId) -> boolean</code></summary>
|
|
15293
15226
|
<dl>
|
|
15294
15227
|
<dd>
|
|
15295
15228
|
|
|
@@ -15301,7 +15234,7 @@ await client.orgs.offChrtOrgData.createV1({
|
|
|
15301
15234
|
<dl>
|
|
15302
15235
|
<dd>
|
|
15303
15236
|
|
|
15304
|
-
|
|
15237
|
+
Deletes an organization-created contact. | authz: min_org_role=operator | () -> (bool)
|
|
15305
15238
|
|
|
15306
15239
|
</dd>
|
|
15307
15240
|
</dl>
|
|
@@ -15317,14 +15250,7 @@ Lists off-CHRT organization data owned by the caller with optional organization-
|
|
|
15317
15250
|
<dd>
|
|
15318
15251
|
|
|
15319
15252
|
```typescript
|
|
15320
|
-
await client.orgs.
|
|
15321
|
-
search: "search",
|
|
15322
|
-
filter_org_type: "provider",
|
|
15323
|
-
sort_by: "name",
|
|
15324
|
-
sort_order: "asc",
|
|
15325
|
-
page: 1,
|
|
15326
|
-
page_size: 1,
|
|
15327
|
-
});
|
|
15253
|
+
await client.orgs.contacts.deleteV1("contact_id");
|
|
15328
15254
|
```
|
|
15329
15255
|
|
|
15330
15256
|
</dd>
|
|
@@ -15340,7 +15266,7 @@ await client.orgs.offChrtOrgData.listV1({
|
|
|
15340
15266
|
<dl>
|
|
15341
15267
|
<dd>
|
|
15342
15268
|
|
|
15343
|
-
**
|
|
15269
|
+
**contactId:** `string`
|
|
15344
15270
|
|
|
15345
15271
|
</dd>
|
|
15346
15272
|
</dl>
|
|
@@ -15348,7 +15274,7 @@ await client.orgs.offChrtOrgData.listV1({
|
|
|
15348
15274
|
<dl>
|
|
15349
15275
|
<dd>
|
|
15350
15276
|
|
|
15351
|
-
**requestOptions:** `
|
|
15277
|
+
**requestOptions:** `Contacts.RequestOptions`
|
|
15352
15278
|
|
|
15353
15279
|
</dd>
|
|
15354
15280
|
</dl>
|
|
@@ -15359,7 +15285,7 @@ await client.orgs.offChrtOrgData.listV1({
|
|
|
15359
15285
|
</dl>
|
|
15360
15286
|
</details>
|
|
15361
15287
|
|
|
15362
|
-
<details><summary><code>client.orgs.
|
|
15288
|
+
<details><summary><code>client.orgs.contacts.<a href="/src/api/resources/orgs/resources/contacts/client/Client.ts">listV1</a>({ ...params }) -> Chrt.ContactListRes</code></summary>
|
|
15363
15289
|
<dl>
|
|
15364
15290
|
<dd>
|
|
15365
15291
|
|
|
@@ -15371,7 +15297,7 @@ await client.orgs.offChrtOrgData.listV1({
|
|
|
15371
15297
|
<dl>
|
|
15372
15298
|
<dd>
|
|
15373
15299
|
|
|
15374
|
-
|
|
15300
|
+
Lists organization-created contacts with association filters and search. | authz: min_org_role=operator | () -> (ContactListRes)
|
|
15375
15301
|
|
|
15376
15302
|
</dd>
|
|
15377
15303
|
</dl>
|
|
@@ -15387,7 +15313,16 @@ Gets owner-scoped off-CHRT organization data by ID. | authz: allowed_org_types=[
|
|
|
15387
15313
|
<dd>
|
|
15388
15314
|
|
|
15389
15315
|
```typescript
|
|
15390
|
-
await client.orgs.
|
|
15316
|
+
await client.orgs.contacts.listV1({
|
|
15317
|
+
search: "search",
|
|
15318
|
+
filter_org_id: "filter_org_id",
|
|
15319
|
+
filter_off_chrt_org_data_id: "filter_off_chrt_org_data_id",
|
|
15320
|
+
filter_account_id: "filter_account_id",
|
|
15321
|
+
sort_by: "name",
|
|
15322
|
+
sort_order: "asc",
|
|
15323
|
+
page: 1,
|
|
15324
|
+
page_size: 1,
|
|
15325
|
+
});
|
|
15391
15326
|
```
|
|
15392
15327
|
|
|
15393
15328
|
</dd>
|
|
@@ -15403,7 +15338,7 @@ await client.orgs.offChrtOrgData.getByIdV1("off_chrt_org_data_id");
|
|
|
15403
15338
|
<dl>
|
|
15404
15339
|
<dd>
|
|
15405
15340
|
|
|
15406
|
-
**
|
|
15341
|
+
**request:** `Chrt.orgs.ContactsListV1Request`
|
|
15407
15342
|
|
|
15408
15343
|
</dd>
|
|
15409
15344
|
</dl>
|
|
@@ -15411,7 +15346,7 @@ await client.orgs.offChrtOrgData.getByIdV1("off_chrt_org_data_id");
|
|
|
15411
15346
|
<dl>
|
|
15412
15347
|
<dd>
|
|
15413
15348
|
|
|
15414
|
-
**requestOptions:** `
|
|
15349
|
+
**requestOptions:** `Contacts.RequestOptions`
|
|
15415
15350
|
|
|
15416
15351
|
</dd>
|
|
15417
15352
|
</dl>
|
|
@@ -15422,7 +15357,7 @@ await client.orgs.offChrtOrgData.getByIdV1("off_chrt_org_data_id");
|
|
|
15422
15357
|
</dl>
|
|
15423
15358
|
</details>
|
|
15424
15359
|
|
|
15425
|
-
<details><summary><code>client.orgs.
|
|
15360
|
+
<details><summary><code>client.orgs.contacts.<a href="/src/api/resources/orgs/resources/contacts/client/Client.ts">updateV1</a>(contactId, { ...params }) -> boolean</code></summary>
|
|
15426
15361
|
<dl>
|
|
15427
15362
|
<dd>
|
|
15428
15363
|
|
|
@@ -15434,7 +15369,7 @@ await client.orgs.offChrtOrgData.getByIdV1("off_chrt_org_data_id");
|
|
|
15434
15369
|
<dl>
|
|
15435
15370
|
<dd>
|
|
15436
15371
|
|
|
15437
|
-
Updates
|
|
15372
|
+
Updates an organization-created contact. | authz: min_org_role=operator | (ContactClientUpdate1) -> (bool)
|
|
15438
15373
|
|
|
15439
15374
|
</dd>
|
|
15440
15375
|
</dl>
|
|
@@ -15450,7 +15385,7 @@ Updates canonical identity fields for owner-scoped off-CHRT organization data. |
|
|
|
15450
15385
|
<dd>
|
|
15451
15386
|
|
|
15452
15387
|
```typescript
|
|
15453
|
-
await client.orgs.
|
|
15388
|
+
await client.orgs.contacts.updateV1("contact_id");
|
|
15454
15389
|
```
|
|
15455
15390
|
|
|
15456
15391
|
</dd>
|
|
@@ -15466,7 +15401,7 @@ await client.orgs.offChrtOrgData.updateByIdV1("off_chrt_org_data_id");
|
|
|
15466
15401
|
<dl>
|
|
15467
15402
|
<dd>
|
|
15468
15403
|
|
|
15469
|
-
**
|
|
15404
|
+
**contactId:** `string`
|
|
15470
15405
|
|
|
15471
15406
|
</dd>
|
|
15472
15407
|
</dl>
|
|
@@ -15474,7 +15409,7 @@ await client.orgs.offChrtOrgData.updateByIdV1("off_chrt_org_data_id");
|
|
|
15474
15409
|
<dl>
|
|
15475
15410
|
<dd>
|
|
15476
15411
|
|
|
15477
|
-
**request:** `Chrt.orgs.
|
|
15412
|
+
**request:** `Chrt.orgs.ContactClientUpdate1`
|
|
15478
15413
|
|
|
15479
15414
|
</dd>
|
|
15480
15415
|
</dl>
|
|
@@ -15482,7 +15417,7 @@ await client.orgs.offChrtOrgData.updateByIdV1("off_chrt_org_data_id");
|
|
|
15482
15417
|
<dl>
|
|
15483
15418
|
<dd>
|
|
15484
15419
|
|
|
15485
|
-
**requestOptions:** `
|
|
15420
|
+
**requestOptions:** `Contacts.RequestOptions`
|
|
15486
15421
|
|
|
15487
15422
|
</dd>
|
|
15488
15423
|
</dl>
|
|
@@ -15493,9 +15428,7 @@ await client.orgs.offChrtOrgData.updateByIdV1("off_chrt_org_data_id");
|
|
|
15493
15428
|
</dl>
|
|
15494
15429
|
</details>
|
|
15495
15430
|
|
|
15496
|
-
|
|
15497
|
-
|
|
15498
|
-
<details><summary><code>client.orgs.offChrtVendor.<a href="/src/api/resources/orgs/resources/offChrtVendor/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
15431
|
+
<details><summary><code>client.orgs.contacts.<a href="/src/api/resources/orgs/resources/contacts/client/Client.ts">getV1</a>(contactId) -> Chrt.Contact1</code></summary>
|
|
15499
15432
|
<dl>
|
|
15500
15433
|
<dd>
|
|
15501
15434
|
|
|
@@ -15507,7 +15440,7 @@ await client.orgs.offChrtOrgData.updateByIdV1("off_chrt_org_data_id");
|
|
|
15507
15440
|
<dl>
|
|
15508
15441
|
<dd>
|
|
15509
15442
|
|
|
15510
|
-
|
|
15443
|
+
Retrieves an organization-created contact. | authz: min_org_role=operator | () -> (Contact1)
|
|
15511
15444
|
|
|
15512
15445
|
</dd>
|
|
15513
15446
|
</dl>
|
|
@@ -15523,10 +15456,7 @@ Creates an off-platform vendor shell owned by the caller's org. Used as an off-C
|
|
|
15523
15456
|
<dd>
|
|
15524
15457
|
|
|
15525
15458
|
```typescript
|
|
15526
|
-
await client.orgs.
|
|
15527
|
-
name: "name",
|
|
15528
|
-
schema_version: 1,
|
|
15529
|
-
});
|
|
15459
|
+
await client.orgs.contacts.getV1("contact_id");
|
|
15530
15460
|
```
|
|
15531
15461
|
|
|
15532
15462
|
</dd>
|
|
@@ -15542,7 +15472,7 @@ await client.orgs.offChrtVendor.createV1({
|
|
|
15542
15472
|
<dl>
|
|
15543
15473
|
<dd>
|
|
15544
15474
|
|
|
15545
|
-
**
|
|
15475
|
+
**contactId:** `string`
|
|
15546
15476
|
|
|
15547
15477
|
</dd>
|
|
15548
15478
|
</dl>
|
|
@@ -15550,7 +15480,7 @@ await client.orgs.offChrtVendor.createV1({
|
|
|
15550
15480
|
<dl>
|
|
15551
15481
|
<dd>
|
|
15552
15482
|
|
|
15553
|
-
**requestOptions:** `
|
|
15483
|
+
**requestOptions:** `Contacts.RequestOptions`
|
|
15554
15484
|
|
|
15555
15485
|
</dd>
|
|
15556
15486
|
</dl>
|
|
@@ -15561,7 +15491,9 @@ await client.orgs.offChrtVendor.createV1({
|
|
|
15561
15491
|
</dl>
|
|
15562
15492
|
</details>
|
|
15563
15493
|
|
|
15564
|
-
|
|
15494
|
+
## Orgs OffChrtOrgData
|
|
15495
|
+
|
|
15496
|
+
<details><summary><code>client.orgs.offChrtOrgData.<a href="/src/api/resources/orgs/resources/offChrtOrgData/client/Client.ts">createV1</a>({ ...params }) -> Chrt.CreateOffChrtOrgRes</code></summary>
|
|
15565
15497
|
<dl>
|
|
15566
15498
|
<dd>
|
|
15567
15499
|
|
|
@@ -15573,7 +15505,7 @@ await client.orgs.offChrtVendor.createV1({
|
|
|
15573
15505
|
<dl>
|
|
15574
15506
|
<dd>
|
|
15575
15507
|
|
|
15576
|
-
|
|
15508
|
+
Creates owner-scoped off-CHRT organization data and, for shippers or providers, its required connection. | authz: allowed_org_types=[provider] | (CreateOffChrtOrgReq) -> (CreateOffChrtOrgRes)
|
|
15577
15509
|
|
|
15578
15510
|
</dd>
|
|
15579
15511
|
</dl>
|
|
@@ -15589,9 +15521,12 @@ Lists all off-chrt vendors created by the caller's organization. Pagination only
|
|
|
15589
15521
|
<dd>
|
|
15590
15522
|
|
|
15591
15523
|
```typescript
|
|
15592
|
-
await client.orgs.
|
|
15593
|
-
|
|
15594
|
-
|
|
15524
|
+
await client.orgs.offChrtOrgData.createV1({
|
|
15525
|
+
off_chrt_org_data: {
|
|
15526
|
+
name: "name",
|
|
15527
|
+
org_type: "provider",
|
|
15528
|
+
schema_version: 1,
|
|
15529
|
+
},
|
|
15595
15530
|
});
|
|
15596
15531
|
```
|
|
15597
15532
|
|
|
@@ -15608,7 +15543,7 @@ await client.orgs.offChrtVendor.listV1({
|
|
|
15608
15543
|
<dl>
|
|
15609
15544
|
<dd>
|
|
15610
15545
|
|
|
15611
|
-
**request:** `Chrt.orgs.
|
|
15546
|
+
**request:** `Chrt.orgs.CreateOffChrtOrgReq`
|
|
15612
15547
|
|
|
15613
15548
|
</dd>
|
|
15614
15549
|
</dl>
|
|
@@ -15616,7 +15551,7 @@ await client.orgs.offChrtVendor.listV1({
|
|
|
15616
15551
|
<dl>
|
|
15617
15552
|
<dd>
|
|
15618
15553
|
|
|
15619
|
-
**requestOptions:** `
|
|
15554
|
+
**requestOptions:** `OffChrtOrgData.RequestOptions`
|
|
15620
15555
|
|
|
15621
15556
|
</dd>
|
|
15622
15557
|
</dl>
|
|
@@ -15627,7 +15562,7 @@ await client.orgs.offChrtVendor.listV1({
|
|
|
15627
15562
|
</dl>
|
|
15628
15563
|
</details>
|
|
15629
15564
|
|
|
15630
|
-
<details><summary><code>client.orgs.
|
|
15565
|
+
<details><summary><code>client.orgs.offChrtOrgData.<a href="/src/api/resources/orgs/resources/offChrtOrgData/client/Client.ts">listV1</a>({ ...params }) -> Chrt.OffChrtOrgDataListRes</code></summary>
|
|
15631
15566
|
<dl>
|
|
15632
15567
|
<dd>
|
|
15633
15568
|
|
|
@@ -15639,7 +15574,7 @@ await client.orgs.offChrtVendor.listV1({
|
|
|
15639
15574
|
<dl>
|
|
15640
15575
|
<dd>
|
|
15641
15576
|
|
|
15642
|
-
|
|
15577
|
+
Lists off-CHRT organization data owned by the caller with optional organization-type filtering, identity search, sorting, and pagination. | authz: allowed_org_types=[provider] | () -> (OffChrtOrgDataListRes)
|
|
15643
15578
|
|
|
15644
15579
|
</dd>
|
|
15645
15580
|
</dl>
|
|
@@ -15655,7 +15590,14 @@ Retrieves a specific off-chrt vendor by ID. Scoped to the caller's org. | () ->
|
|
|
15655
15590
|
<dd>
|
|
15656
15591
|
|
|
15657
15592
|
```typescript
|
|
15658
|
-
await client.orgs.
|
|
15593
|
+
await client.orgs.offChrtOrgData.listV1({
|
|
15594
|
+
search: "search",
|
|
15595
|
+
filter_org_type: "provider",
|
|
15596
|
+
sort_by: "name",
|
|
15597
|
+
sort_order: "asc",
|
|
15598
|
+
page: 1,
|
|
15599
|
+
page_size: 1,
|
|
15600
|
+
});
|
|
15659
15601
|
```
|
|
15660
15602
|
|
|
15661
15603
|
</dd>
|
|
@@ -15671,7 +15613,7 @@ await client.orgs.offChrtVendor.getByIdV1("id");
|
|
|
15671
15613
|
<dl>
|
|
15672
15614
|
<dd>
|
|
15673
15615
|
|
|
15674
|
-
**
|
|
15616
|
+
**request:** `Chrt.orgs.OffChrtOrgDataListV1Request`
|
|
15675
15617
|
|
|
15676
15618
|
</dd>
|
|
15677
15619
|
</dl>
|
|
@@ -15679,7 +15621,7 @@ await client.orgs.offChrtVendor.getByIdV1("id");
|
|
|
15679
15621
|
<dl>
|
|
15680
15622
|
<dd>
|
|
15681
15623
|
|
|
15682
|
-
**requestOptions:** `
|
|
15624
|
+
**requestOptions:** `OffChrtOrgData.RequestOptions`
|
|
15683
15625
|
|
|
15684
15626
|
</dd>
|
|
15685
15627
|
</dl>
|
|
@@ -15690,7 +15632,7 @@ await client.orgs.offChrtVendor.getByIdV1("id");
|
|
|
15690
15632
|
</dl>
|
|
15691
15633
|
</details>
|
|
15692
15634
|
|
|
15693
|
-
<details><summary><code>client.orgs.
|
|
15635
|
+
<details><summary><code>client.orgs.offChrtOrgData.<a href="/src/api/resources/orgs/resources/offChrtOrgData/client/Client.ts">getByIdV1</a>(offChrtOrgDataId) -> Chrt.OffChrtOrgData1</code></summary>
|
|
15694
15636
|
<dl>
|
|
15695
15637
|
<dd>
|
|
15696
15638
|
|
|
@@ -15702,7 +15644,7 @@ await client.orgs.offChrtVendor.getByIdV1("id");
|
|
|
15702
15644
|
<dl>
|
|
15703
15645
|
<dd>
|
|
15704
15646
|
|
|
15705
|
-
|
|
15647
|
+
Gets owner-scoped off-CHRT organization data by ID. | authz: allowed_org_types=[provider] | () -> (OffChrtOrgData1)
|
|
15706
15648
|
|
|
15707
15649
|
</dd>
|
|
15708
15650
|
</dl>
|
|
@@ -15718,7 +15660,7 @@ Deletes an off-chrt vendor owned by the caller's organization. Existing LineItem
|
|
|
15718
15660
|
<dd>
|
|
15719
15661
|
|
|
15720
15662
|
```typescript
|
|
15721
|
-
await client.orgs.
|
|
15663
|
+
await client.orgs.offChrtOrgData.getByIdV1("off_chrt_org_data_id");
|
|
15722
15664
|
```
|
|
15723
15665
|
|
|
15724
15666
|
</dd>
|
|
@@ -15734,7 +15676,7 @@ await client.orgs.offChrtVendor.deleteByIdV1("id");
|
|
|
15734
15676
|
<dl>
|
|
15735
15677
|
<dd>
|
|
15736
15678
|
|
|
15737
|
-
**
|
|
15679
|
+
**offChrtOrgDataId:** `string`
|
|
15738
15680
|
|
|
15739
15681
|
</dd>
|
|
15740
15682
|
</dl>
|
|
@@ -15742,7 +15684,7 @@ await client.orgs.offChrtVendor.deleteByIdV1("id");
|
|
|
15742
15684
|
<dl>
|
|
15743
15685
|
<dd>
|
|
15744
15686
|
|
|
15745
|
-
**requestOptions:** `
|
|
15687
|
+
**requestOptions:** `OffChrtOrgData.RequestOptions`
|
|
15746
15688
|
|
|
15747
15689
|
</dd>
|
|
15748
15690
|
</dl>
|
|
@@ -15753,7 +15695,7 @@ await client.orgs.offChrtVendor.deleteByIdV1("id");
|
|
|
15753
15695
|
</dl>
|
|
15754
15696
|
</details>
|
|
15755
15697
|
|
|
15756
|
-
<details><summary><code>client.orgs.
|
|
15698
|
+
<details><summary><code>client.orgs.offChrtOrgData.<a href="/src/api/resources/orgs/resources/offChrtOrgData/client/Client.ts">updateByIdV1</a>(offChrtOrgDataId, { ...params }) -> boolean</code></summary>
|
|
15757
15699
|
<dl>
|
|
15758
15700
|
<dd>
|
|
15759
15701
|
|
|
@@ -15765,7 +15707,7 @@ await client.orgs.offChrtVendor.deleteByIdV1("id");
|
|
|
15765
15707
|
<dl>
|
|
15766
15708
|
<dd>
|
|
15767
15709
|
|
|
15768
|
-
Updates
|
|
15710
|
+
Updates canonical identity fields for owner-scoped off-CHRT organization data. | authz: allowed_org_types=[provider] | (OffChrtOrgDataClientUpdate1) -> (bool)
|
|
15769
15711
|
|
|
15770
15712
|
</dd>
|
|
15771
15713
|
</dl>
|
|
@@ -15781,7 +15723,7 @@ Updates an existing off-chrt vendor owned by the caller's organization. | (OffCh
|
|
|
15781
15723
|
<dd>
|
|
15782
15724
|
|
|
15783
15725
|
```typescript
|
|
15784
|
-
await client.orgs.
|
|
15726
|
+
await client.orgs.offChrtOrgData.updateByIdV1("off_chrt_org_data_id");
|
|
15785
15727
|
```
|
|
15786
15728
|
|
|
15787
15729
|
</dd>
|
|
@@ -15797,7 +15739,7 @@ await client.orgs.offChrtVendor.updateByIdV1("id");
|
|
|
15797
15739
|
<dl>
|
|
15798
15740
|
<dd>
|
|
15799
15741
|
|
|
15800
|
-
**
|
|
15742
|
+
**offChrtOrgDataId:** `string`
|
|
15801
15743
|
|
|
15802
15744
|
</dd>
|
|
15803
15745
|
</dl>
|
|
@@ -15805,7 +15747,7 @@ await client.orgs.offChrtVendor.updateByIdV1("id");
|
|
|
15805
15747
|
<dl>
|
|
15806
15748
|
<dd>
|
|
15807
15749
|
|
|
15808
|
-
**request:** `Chrt.orgs.
|
|
15750
|
+
**request:** `Chrt.orgs.OffChrtOrgDataClientUpdate1`
|
|
15809
15751
|
|
|
15810
15752
|
</dd>
|
|
15811
15753
|
</dl>
|
|
@@ -15813,7 +15755,7 @@ await client.orgs.offChrtVendor.updateByIdV1("id");
|
|
|
15813
15755
|
<dl>
|
|
15814
15756
|
<dd>
|
|
15815
15757
|
|
|
15816
|
-
**requestOptions:** `
|
|
15758
|
+
**requestOptions:** `OffChrtOrgData.RequestOptions`
|
|
15817
15759
|
|
|
15818
15760
|
</dd>
|
|
15819
15761
|
</dl>
|
|
@@ -19523,7 +19465,7 @@ await client.shipping.orderTemplates.listV1({
|
|
|
19523
19465
|
filter_department_id: "filter_department_id",
|
|
19524
19466
|
filter_coordinator_label: "filter_coordinator_label",
|
|
19525
19467
|
filter_driver_id: "filter_driver_id",
|
|
19526
|
-
|
|
19468
|
+
filter_contact_id: "filter_contact_id",
|
|
19527
19469
|
filter_task_lists_to_apply_at_order_creation_task_list_id:
|
|
19528
19470
|
"filter_task_lists_to_apply_at_order_creation_task_list_id",
|
|
19529
19471
|
filter_task_lists_to_apply_at_order_staging_task_list_id:
|
|
@@ -20171,6 +20113,148 @@ await client.shipping.orders.cancelManyV1({
|
|
|
20171
20113
|
</dl>
|
|
20172
20114
|
</details>
|
|
20173
20115
|
|
|
20116
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">addCoordinatorShipperAccountIdV1</a>(orderId, coordinatorShipperAccountId) -> boolean</code></summary>
|
|
20117
|
+
<dl>
|
|
20118
|
+
<dd>
|
|
20119
|
+
|
|
20120
|
+
#### 📝 Description
|
|
20121
|
+
|
|
20122
|
+
<dl>
|
|
20123
|
+
<dd>
|
|
20124
|
+
|
|
20125
|
+
<dl>
|
|
20126
|
+
<dd>
|
|
20127
|
+
|
|
20128
|
+
Adds a coordinator-owned account for the order's shipper. | authz_personas=[coordinator_org_operators] | () -> (bool)
|
|
20129
|
+
|
|
20130
|
+
</dd>
|
|
20131
|
+
</dl>
|
|
20132
|
+
</dd>
|
|
20133
|
+
</dl>
|
|
20134
|
+
|
|
20135
|
+
#### 🔌 Usage
|
|
20136
|
+
|
|
20137
|
+
<dl>
|
|
20138
|
+
<dd>
|
|
20139
|
+
|
|
20140
|
+
<dl>
|
|
20141
|
+
<dd>
|
|
20142
|
+
|
|
20143
|
+
```typescript
|
|
20144
|
+
await client.shipping.orders.addCoordinatorShipperAccountIdV1("order_id", "coordinator_shipper_account_id");
|
|
20145
|
+
```
|
|
20146
|
+
|
|
20147
|
+
</dd>
|
|
20148
|
+
</dl>
|
|
20149
|
+
</dd>
|
|
20150
|
+
</dl>
|
|
20151
|
+
|
|
20152
|
+
#### ⚙️ Parameters
|
|
20153
|
+
|
|
20154
|
+
<dl>
|
|
20155
|
+
<dd>
|
|
20156
|
+
|
|
20157
|
+
<dl>
|
|
20158
|
+
<dd>
|
|
20159
|
+
|
|
20160
|
+
**orderId:** `string`
|
|
20161
|
+
|
|
20162
|
+
</dd>
|
|
20163
|
+
</dl>
|
|
20164
|
+
|
|
20165
|
+
<dl>
|
|
20166
|
+
<dd>
|
|
20167
|
+
|
|
20168
|
+
**coordinatorShipperAccountId:** `string`
|
|
20169
|
+
|
|
20170
|
+
</dd>
|
|
20171
|
+
</dl>
|
|
20172
|
+
|
|
20173
|
+
<dl>
|
|
20174
|
+
<dd>
|
|
20175
|
+
|
|
20176
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
20177
|
+
|
|
20178
|
+
</dd>
|
|
20179
|
+
</dl>
|
|
20180
|
+
</dd>
|
|
20181
|
+
</dl>
|
|
20182
|
+
|
|
20183
|
+
</dd>
|
|
20184
|
+
</dl>
|
|
20185
|
+
</details>
|
|
20186
|
+
|
|
20187
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">removeCoordinatorShipperAccountIdV1</a>(orderId, coordinatorShipperAccountId) -> boolean</code></summary>
|
|
20188
|
+
<dl>
|
|
20189
|
+
<dd>
|
|
20190
|
+
|
|
20191
|
+
#### 📝 Description
|
|
20192
|
+
|
|
20193
|
+
<dl>
|
|
20194
|
+
<dd>
|
|
20195
|
+
|
|
20196
|
+
<dl>
|
|
20197
|
+
<dd>
|
|
20198
|
+
|
|
20199
|
+
Removes a coordinator-owned account for the order's shipper. | authz_personas=[coordinator_org_operators] | () -> (bool)
|
|
20200
|
+
|
|
20201
|
+
</dd>
|
|
20202
|
+
</dl>
|
|
20203
|
+
</dd>
|
|
20204
|
+
</dl>
|
|
20205
|
+
|
|
20206
|
+
#### 🔌 Usage
|
|
20207
|
+
|
|
20208
|
+
<dl>
|
|
20209
|
+
<dd>
|
|
20210
|
+
|
|
20211
|
+
<dl>
|
|
20212
|
+
<dd>
|
|
20213
|
+
|
|
20214
|
+
```typescript
|
|
20215
|
+
await client.shipping.orders.removeCoordinatorShipperAccountIdV1("order_id", "coordinator_shipper_account_id");
|
|
20216
|
+
```
|
|
20217
|
+
|
|
20218
|
+
</dd>
|
|
20219
|
+
</dl>
|
|
20220
|
+
</dd>
|
|
20221
|
+
</dl>
|
|
20222
|
+
|
|
20223
|
+
#### ⚙️ Parameters
|
|
20224
|
+
|
|
20225
|
+
<dl>
|
|
20226
|
+
<dd>
|
|
20227
|
+
|
|
20228
|
+
<dl>
|
|
20229
|
+
<dd>
|
|
20230
|
+
|
|
20231
|
+
**orderId:** `string`
|
|
20232
|
+
|
|
20233
|
+
</dd>
|
|
20234
|
+
</dl>
|
|
20235
|
+
|
|
20236
|
+
<dl>
|
|
20237
|
+
<dd>
|
|
20238
|
+
|
|
20239
|
+
**coordinatorShipperAccountId:** `string`
|
|
20240
|
+
|
|
20241
|
+
</dd>
|
|
20242
|
+
</dl>
|
|
20243
|
+
|
|
20244
|
+
<dl>
|
|
20245
|
+
<dd>
|
|
20246
|
+
|
|
20247
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
20248
|
+
|
|
20249
|
+
</dd>
|
|
20250
|
+
</dl>
|
|
20251
|
+
</dd>
|
|
20252
|
+
</dl>
|
|
20253
|
+
|
|
20254
|
+
</dd>
|
|
20255
|
+
</dl>
|
|
20256
|
+
</details>
|
|
20257
|
+
|
|
20174
20258
|
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">stageV1</a>(orderId) -> boolean</code></summary>
|
|
20175
20259
|
<dl>
|
|
20176
20260
|
<dd>
|
|
@@ -23065,7 +23149,7 @@ await client.shipping.tasks.skipV1("task_id");
|
|
|
23065
23149
|
<dl>
|
|
23066
23150
|
<dd>
|
|
23067
23151
|
|
|
23068
|
-
Updates a task. Operational fields (location, action, datetime_windows) require STAGED status (lig_owner_operators). order_placer_comments can be edited on any non-DRAFT task (order_creator_org_operators).
|
|
23152
|
+
Updates a task. Operational fields (location, action, datetime_windows) require STAGED status (lig_owner_operators). order_placer_comments can be edited on any non-DRAFT task (order_creator_org_operators). contact_ids can be edited on STAGED/IN_PROGRESS orders for tasks still in STAGED status (order_creator_org_operators OR lig_owner_operators). | (TaskClientUpdate1) -> (PydanticObjectId)
|
|
23069
23153
|
|
|
23070
23154
|
</dd>
|
|
23071
23155
|
</dl>
|
|
@@ -25255,6 +25339,7 @@ await client.shipping.orders.expanded.listForCoordinatorOperatorsV1({
|
|
|
25255
25339
|
page: 1,
|
|
25256
25340
|
page_size: 1,
|
|
25257
25341
|
search: "search",
|
|
25342
|
+
filter_awb_number: "filter_awb_number",
|
|
25258
25343
|
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
25259
25344
|
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
25260
25345
|
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
@@ -25342,6 +25427,7 @@ await client.shipping.orders.expanded.listForExecutorOperatorsV1({
|
|
|
25342
25427
|
page: 1,
|
|
25343
25428
|
page_size: 1,
|
|
25344
25429
|
search: "search",
|
|
25430
|
+
filter_awb_number: "filter_awb_number",
|
|
25345
25431
|
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
25346
25432
|
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
25347
25433
|
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
@@ -25428,6 +25514,7 @@ await client.shipping.orders.expanded.listForProviderOperatorsV1({
|
|
|
25428
25514
|
page: 1,
|
|
25429
25515
|
page_size: 1,
|
|
25430
25516
|
search: "search",
|
|
25517
|
+
filter_awb_number: "filter_awb_number",
|
|
25431
25518
|
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
25432
25519
|
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
25433
25520
|
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
@@ -25516,6 +25603,7 @@ await client.shipping.orders.expanded.listForShipperOperatorsV1({
|
|
|
25516
25603
|
page: 1,
|
|
25517
25604
|
page_size: 1,
|
|
25518
25605
|
search: "search",
|
|
25606
|
+
filter_awb_number: "filter_awb_number",
|
|
25519
25607
|
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
25520
25608
|
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
25521
25609
|
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|