@chrt-inc/typescript-sdk 1.881.0 → 1.887.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 +114 -0
- package/dist/cjs/api/resources/orgs/resources/{offChrtVendor → accounts}/client/Client.js +84 -55
- package/dist/cjs/api/resources/orgs/resources/accounts/client/requests/AccountClientCreate1.d.ts +19 -0
- package/dist/cjs/api/resources/orgs/resources/accounts/client/requests/AccountClientUpdate1.d.ts +13 -0
- package/dist/cjs/api/resources/orgs/resources/accounts/client/requests/AccountsListV1Request.d.ts +30 -0
- package/dist/cjs/api/resources/orgs/resources/accounts/client/requests/AccountsTypeaheadV1Request.d.ts +16 -0
- package/dist/cjs/api/resources/orgs/resources/accounts/client/requests/index.d.ts +4 -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 +36 -4
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForCoordinatorOperatorsV1Request.d.ts +5 -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 +5 -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} +6 -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/{DirectoryEntrySortByEnum.d.ts → AccountTypeaheadFieldEnum.d.ts} +1 -1
- package/dist/cjs/api/types/AccountTypeaheadResult.d.ts +8 -0
- package/dist/cjs/api/types/AccountTypeaheadResult.js +5 -0
- package/dist/cjs/api/types/AccountTypeaheadValue.d.ts +7 -0
- package/dist/cjs/api/types/AccountTypeaheadValue.js +5 -0
- package/dist/cjs/api/types/{DirectoryEntry1.d.ts → Contact1.d.ts} +6 -7
- package/dist/cjs/api/types/Contact1.js +5 -0
- package/dist/cjs/api/types/{DirectoryEntryListRes.d.ts → ContactListRes.d.ts} +2 -2
- package/dist/cjs/api/types/ContactListRes.js +5 -0
- 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/NotificationEventsForAdHocEnum.d.ts +1 -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 +9 -5
- package/dist/cjs/api/types/index.js +9 -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 +114 -0
- package/dist/esm/api/resources/orgs/resources/{offChrtVendor → accounts}/client/Client.mjs +82 -53
- package/dist/esm/api/resources/orgs/resources/accounts/client/requests/AccountClientCreate1.d.mts +19 -0
- package/dist/esm/api/resources/orgs/resources/accounts/client/requests/AccountClientUpdate1.d.mts +13 -0
- package/dist/esm/api/resources/orgs/resources/accounts/client/requests/AccountsListV1Request.d.mts +30 -0
- package/dist/esm/api/resources/orgs/resources/accounts/client/requests/AccountsTypeaheadV1Request.d.mts +16 -0
- package/dist/esm/api/resources/orgs/resources/accounts/client/requests/index.d.mts +4 -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 +36 -4
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForCoordinatorOperatorsV1Request.d.mts +5 -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 +5 -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} +6 -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/AccountTypeaheadFieldEnum.d.mts +4 -0
- package/dist/esm/api/types/AccountTypeaheadResult.d.mts +8 -0
- package/dist/esm/api/types/AccountTypeaheadResult.mjs +4 -0
- package/dist/esm/api/types/AccountTypeaheadValue.d.mts +7 -0
- package/dist/esm/api/types/AccountTypeaheadValue.mjs +4 -0
- package/dist/esm/api/types/{DirectoryEntry1.d.mts → Contact1.d.mts} +6 -7
- package/dist/esm/api/types/Contact1.mjs +4 -0
- package/dist/esm/api/types/{DirectoryEntryListRes.d.mts → ContactListRes.d.mts} +2 -2
- package/dist/esm/api/types/ContactListRes.mjs +4 -0
- 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/NotificationEventsForAdHocEnum.d.mts +1 -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 +9 -5
- package/dist/esm/api/types/index.mjs +9 -5
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +388 -233
- 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/OffChrtVendorClientCreate1.d.ts +0 -15
- package/dist/cjs/api/resources/orgs/resources/offChrtVendor/client/requests/OffChrtVendorClientUpdate1.d.ts +0 -12
- 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/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/OffChrtVendorClientCreate1.d.mts +0 -15
- package/dist/esm/api/resources/orgs/resources/offChrtVendor/client/requests/OffChrtVendorClientUpdate1.d.mts +0 -12
- 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/{offChrtVendor/client/requests/OffChrtVendorClientCreate1.js → accounts/client/requests/AccountsTypeaheadV1Request.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/OffChrtVendorClientUpdate1.js → contacts/client/requests/ContactClientCreate1.js} +0 -0
- /package/dist/cjs/api/resources/orgs/resources/{offChrtVendor/client/requests/OffChrtVendorListV1Request.js → contacts/client/requests/ContactClientUpdate1.js} +0 -0
- /package/dist/cjs/api/{types/DirectoryEntry1.js → resources/orgs/resources/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/{DirectoryEntryListRes.js → Account1.js} +0 -0
- /package/dist/cjs/api/types/{DirectoryEntrySortByEnum.js → AccountListRes.js} +0 -0
- /package/dist/cjs/api/types/{OffChrtVendor1.js → AccountSortByEnum.js} +0 -0
- /package/dist/cjs/api/types/{OffChrtVendorListRes.js → AccountTypeaheadFieldEnum.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/{offChrtVendor/client/requests/OffChrtVendorClientCreate1.mjs → accounts/client/requests/AccountsTypeaheadV1Request.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/OffChrtVendorClientUpdate1.mjs → contacts/client/requests/ContactClientCreate1.mjs} +0 -0
- /package/dist/esm/api/resources/orgs/resources/{offChrtVendor/client/requests/OffChrtVendorListV1Request.mjs → contacts/client/requests/ContactClientUpdate1.mjs} +0 -0
- /package/dist/esm/api/{types/DirectoryEntry1.mjs → resources/orgs/resources/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/{DirectoryEntryListRes.mjs → Account1.mjs} +0 -0
- /package/dist/esm/api/types/{DirectoryEntrySortByEnum.mjs → AccountListRes.mjs} +0 -0
- /package/dist/esm/api/types/{OffChrtVendor1.mjs → AccountSortByEnum.mjs} +0 -0
- /package/dist/esm/api/types/{OffChrtVendorListRes.mjs → AccountTypeaheadFieldEnum.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 with a name unique to its associated shipper. Optional location may be set at creation. | 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, name search, sorting, and pagination. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (AccountListRes)
|
|
14026
14026
|
|
|
14027
14027
|
</dd>
|
|
14028
14028
|
</dl>
|
|
@@ -14038,7 +14038,15 @@ 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
|
+
search: "search",
|
|
14043
|
+
filter_org_id: "filter_org_id",
|
|
14044
|
+
filter_off_chrt_org_data_id: "filter_off_chrt_org_data_id",
|
|
14045
|
+
sort_by: "name",
|
|
14046
|
+
sort_order: "asc",
|
|
14047
|
+
page: 1,
|
|
14048
|
+
page_size: 1,
|
|
14049
|
+
});
|
|
14042
14050
|
```
|
|
14043
14051
|
|
|
14044
14052
|
</dd>
|
|
@@ -14054,7 +14062,15 @@ await client.orgs.complianceDocuments.listV1();
|
|
|
14054
14062
|
<dl>
|
|
14055
14063
|
<dd>
|
|
14056
14064
|
|
|
14057
|
-
**
|
|
14065
|
+
**request:** `Chrt.orgs.AccountsListV1Request`
|
|
14066
|
+
|
|
14067
|
+
</dd>
|
|
14068
|
+
</dl>
|
|
14069
|
+
|
|
14070
|
+
<dl>
|
|
14071
|
+
<dd>
|
|
14072
|
+
|
|
14073
|
+
**requestOptions:** `Accounts.RequestOptions`
|
|
14058
14074
|
|
|
14059
14075
|
</dd>
|
|
14060
14076
|
</dl>
|
|
@@ -14065,7 +14081,7 @@ await client.orgs.complianceDocuments.listV1();
|
|
|
14065
14081
|
</dl>
|
|
14066
14082
|
</details>
|
|
14067
14083
|
|
|
14068
|
-
<details><summary><code>client.orgs.
|
|
14084
|
+
<details><summary><code>client.orgs.accounts.<a href="/src/api/resources/orgs/resources/accounts/client/Client.ts">typeaheadV1</a>({ ...params }) -> Chrt.AccountTypeaheadResult[]</code></summary>
|
|
14069
14085
|
<dl>
|
|
14070
14086
|
<dd>
|
|
14071
14087
|
|
|
@@ -14077,7 +14093,7 @@ await client.orgs.complianceDocuments.listV1();
|
|
|
14077
14093
|
<dl>
|
|
14078
14094
|
<dd>
|
|
14079
14095
|
|
|
14080
|
-
|
|
14096
|
+
Returns distinct coordinator-created shipper account names matching the query, with matching account IDs. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (list[AccountTypeaheadResult])
|
|
14081
14097
|
|
|
14082
14098
|
</dd>
|
|
14083
14099
|
</dl>
|
|
@@ -14093,7 +14109,10 @@ Updates an organization compliance document for the caller's provider organizati
|
|
|
14093
14109
|
<dd>
|
|
14094
14110
|
|
|
14095
14111
|
```typescript
|
|
14096
|
-
await client.orgs.
|
|
14112
|
+
await client.orgs.accounts.typeaheadV1({
|
|
14113
|
+
query: "query",
|
|
14114
|
+
limit: 1,
|
|
14115
|
+
});
|
|
14097
14116
|
```
|
|
14098
14117
|
|
|
14099
14118
|
</dd>
|
|
@@ -14109,7 +14128,7 @@ await client.orgs.complianceDocuments.updateV1("org_compliance_document_id");
|
|
|
14109
14128
|
<dl>
|
|
14110
14129
|
<dd>
|
|
14111
14130
|
|
|
14112
|
-
**
|
|
14131
|
+
**request:** `Chrt.orgs.AccountsTypeaheadV1Request`
|
|
14113
14132
|
|
|
14114
14133
|
</dd>
|
|
14115
14134
|
</dl>
|
|
@@ -14117,15 +14136,7 @@ await client.orgs.complianceDocuments.updateV1("org_compliance_document_id");
|
|
|
14117
14136
|
<dl>
|
|
14118
14137
|
<dd>
|
|
14119
14138
|
|
|
14120
|
-
**
|
|
14121
|
-
|
|
14122
|
-
</dd>
|
|
14123
|
-
</dl>
|
|
14124
|
-
|
|
14125
|
-
<dl>
|
|
14126
|
-
<dd>
|
|
14127
|
-
|
|
14128
|
-
**requestOptions:** `ComplianceDocuments.RequestOptions`
|
|
14139
|
+
**requestOptions:** `Accounts.RequestOptions`
|
|
14129
14140
|
|
|
14130
14141
|
</dd>
|
|
14131
14142
|
</dl>
|
|
@@ -14136,7 +14147,7 @@ await client.orgs.complianceDocuments.updateV1("org_compliance_document_id");
|
|
|
14136
14147
|
</dl>
|
|
14137
14148
|
</details>
|
|
14138
14149
|
|
|
14139
|
-
<details><summary><code>client.orgs.
|
|
14150
|
+
<details><summary><code>client.orgs.accounts.<a href="/src/api/resources/orgs/resources/accounts/client/Client.ts">updateV1</a>(accountId, { ...params }) -> boolean</code></summary>
|
|
14140
14151
|
<dl>
|
|
14141
14152
|
<dd>
|
|
14142
14153
|
|
|
@@ -14148,7 +14159,7 @@ await client.orgs.complianceDocuments.updateV1("org_compliance_document_id");
|
|
|
14148
14159
|
<dl>
|
|
14149
14160
|
<dd>
|
|
14150
14161
|
|
|
14151
|
-
|
|
14162
|
+
Updates a coordinator-created shipper account name and optional location while preserving per-shipper name uniqueness. | authz: allowed_org_types=[provider], min_org_role=operator | (AccountClientUpdate1) -> (bool)
|
|
14152
14163
|
|
|
14153
14164
|
</dd>
|
|
14154
14165
|
</dl>
|
|
@@ -14164,7 +14175,7 @@ Retrieves one compliance document for the caller's provider organization. | auth
|
|
|
14164
14175
|
<dd>
|
|
14165
14176
|
|
|
14166
14177
|
```typescript
|
|
14167
|
-
await client.orgs.
|
|
14178
|
+
await client.orgs.accounts.updateV1("account_id");
|
|
14168
14179
|
```
|
|
14169
14180
|
|
|
14170
14181
|
</dd>
|
|
@@ -14180,7 +14191,7 @@ await client.orgs.complianceDocuments.getV1("org_compliance_document_id");
|
|
|
14180
14191
|
<dl>
|
|
14181
14192
|
<dd>
|
|
14182
14193
|
|
|
14183
|
-
**
|
|
14194
|
+
**accountId:** `string`
|
|
14184
14195
|
|
|
14185
14196
|
</dd>
|
|
14186
14197
|
</dl>
|
|
@@ -14188,7 +14199,15 @@ await client.orgs.complianceDocuments.getV1("org_compliance_document_id");
|
|
|
14188
14199
|
<dl>
|
|
14189
14200
|
<dd>
|
|
14190
14201
|
|
|
14191
|
-
**
|
|
14202
|
+
**request:** `Chrt.orgs.AccountClientUpdate1`
|
|
14203
|
+
|
|
14204
|
+
</dd>
|
|
14205
|
+
</dl>
|
|
14206
|
+
|
|
14207
|
+
<dl>
|
|
14208
|
+
<dd>
|
|
14209
|
+
|
|
14210
|
+
**requestOptions:** `Accounts.RequestOptions`
|
|
14192
14211
|
|
|
14193
14212
|
</dd>
|
|
14194
14213
|
</dl>
|
|
@@ -14199,9 +14218,7 @@ await client.orgs.complianceDocuments.getV1("org_compliance_document_id");
|
|
|
14199
14218
|
</dl>
|
|
14200
14219
|
</details>
|
|
14201
14220
|
|
|
14202
|
-
|
|
14203
|
-
|
|
14204
|
-
<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>
|
|
14221
|
+
<details><summary><code>client.orgs.accounts.<a href="/src/api/resources/orgs/resources/accounts/client/Client.ts">getV1</a>(accountId) -> Chrt.Account1</code></summary>
|
|
14205
14222
|
<dl>
|
|
14206
14223
|
<dd>
|
|
14207
14224
|
|
|
@@ -14213,7 +14230,7 @@ await client.orgs.complianceDocuments.getV1("org_compliance_document_id");
|
|
|
14213
14230
|
<dl>
|
|
14214
14231
|
<dd>
|
|
14215
14232
|
|
|
14216
|
-
|
|
14233
|
+
Retrieves a coordinator-created shipper account. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (Account1)
|
|
14217
14234
|
|
|
14218
14235
|
</dd>
|
|
14219
14236
|
</dl>
|
|
@@ -14229,7 +14246,7 @@ Gets the connection between caller's org and the org with the specified handle.
|
|
|
14229
14246
|
<dd>
|
|
14230
14247
|
|
|
14231
14248
|
```typescript
|
|
14232
|
-
await client.orgs.
|
|
14249
|
+
await client.orgs.accounts.getV1("account_id");
|
|
14233
14250
|
```
|
|
14234
14251
|
|
|
14235
14252
|
</dd>
|
|
@@ -14245,7 +14262,7 @@ await client.orgs.connections.getByHandleV1("handle");
|
|
|
14245
14262
|
<dl>
|
|
14246
14263
|
<dd>
|
|
14247
14264
|
|
|
14248
|
-
**
|
|
14265
|
+
**accountId:** `string`
|
|
14249
14266
|
|
|
14250
14267
|
</dd>
|
|
14251
14268
|
</dl>
|
|
@@ -14253,7 +14270,7 @@ await client.orgs.connections.getByHandleV1("handle");
|
|
|
14253
14270
|
<dl>
|
|
14254
14271
|
<dd>
|
|
14255
14272
|
|
|
14256
|
-
**requestOptions:** `
|
|
14273
|
+
**requestOptions:** `Accounts.RequestOptions`
|
|
14257
14274
|
|
|
14258
14275
|
</dd>
|
|
14259
14276
|
</dl>
|
|
@@ -14264,7 +14281,9 @@ await client.orgs.connections.getByHandleV1("handle");
|
|
|
14264
14281
|
</dl>
|
|
14265
14282
|
</details>
|
|
14266
14283
|
|
|
14267
|
-
|
|
14284
|
+
## Orgs ComplianceDocuments
|
|
14285
|
+
|
|
14286
|
+
<details><summary><code>client.orgs.complianceDocuments.<a href="/src/api/resources/orgs/resources/complianceDocuments/client/Client.ts">createV1</a>({ ...params }) -> Chrt.OrgComplianceDocument1</code></summary>
|
|
14268
14287
|
<dl>
|
|
14269
14288
|
<dd>
|
|
14270
14289
|
|
|
@@ -14276,7 +14295,7 @@ await client.orgs.connections.getByHandleV1("handle");
|
|
|
14276
14295
|
<dl>
|
|
14277
14296
|
<dd>
|
|
14278
14297
|
|
|
14279
|
-
|
|
14298
|
+
Creates a compliance document record for the caller's provider organization. | authz: allowed_org_types=[provider], min_org_role=administrator | (OrgComplianceDocumentClientCreate1) -> (OrgComplianceDocument1)
|
|
14280
14299
|
|
|
14281
14300
|
</dd>
|
|
14282
14301
|
</dl>
|
|
@@ -14292,12 +14311,9 @@ Lists the caller's coordinator connections with filtering, pagination, and ident
|
|
|
14292
14311
|
<dd>
|
|
14293
14312
|
|
|
14294
14313
|
```typescript
|
|
14295
|
-
await client.orgs.
|
|
14296
|
-
|
|
14297
|
-
|
|
14298
|
-
page_size: 1,
|
|
14299
|
-
filter_auto_assign_enabled: true,
|
|
14300
|
-
filter_connected: true,
|
|
14314
|
+
await client.orgs.complianceDocuments.createV1({
|
|
14315
|
+
document_type: "security_threat_assessment",
|
|
14316
|
+
schema_version: 1,
|
|
14301
14317
|
});
|
|
14302
14318
|
```
|
|
14303
14319
|
|
|
@@ -14314,7 +14330,7 @@ await client.orgs.connections.listCoordinatorsForExecutorV1({
|
|
|
14314
14330
|
<dl>
|
|
14315
14331
|
<dd>
|
|
14316
14332
|
|
|
14317
|
-
**request:** `Chrt.orgs.
|
|
14333
|
+
**request:** `Chrt.orgs.OrgComplianceDocumentClientCreate1`
|
|
14318
14334
|
|
|
14319
14335
|
</dd>
|
|
14320
14336
|
</dl>
|
|
@@ -14322,7 +14338,7 @@ await client.orgs.connections.listCoordinatorsForExecutorV1({
|
|
|
14322
14338
|
<dl>
|
|
14323
14339
|
<dd>
|
|
14324
14340
|
|
|
14325
|
-
**requestOptions:** `
|
|
14341
|
+
**requestOptions:** `ComplianceDocuments.RequestOptions`
|
|
14326
14342
|
|
|
14327
14343
|
</dd>
|
|
14328
14344
|
</dl>
|
|
@@ -14333,7 +14349,7 @@ await client.orgs.connections.listCoordinatorsForExecutorV1({
|
|
|
14333
14349
|
</dl>
|
|
14334
14350
|
</details>
|
|
14335
14351
|
|
|
14336
|
-
<details><summary><code>client.orgs.
|
|
14352
|
+
<details><summary><code>client.orgs.complianceDocuments.<a href="/src/api/resources/orgs/resources/complianceDocuments/client/Client.ts">listV1</a>() -> Chrt.OrgComplianceDocument1[]</code></summary>
|
|
14337
14353
|
<dl>
|
|
14338
14354
|
<dd>
|
|
14339
14355
|
|
|
@@ -14345,7 +14361,7 @@ await client.orgs.connections.listCoordinatorsForExecutorV1({
|
|
|
14345
14361
|
<dl>
|
|
14346
14362
|
<dd>
|
|
14347
14363
|
|
|
14348
|
-
Lists the caller's
|
|
14364
|
+
Lists compliance documents for the caller's provider organization. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (list[OrgComplianceDocument1])
|
|
14349
14365
|
|
|
14350
14366
|
</dd>
|
|
14351
14367
|
</dl>
|
|
@@ -14361,12 +14377,7 @@ Lists the caller's coordinator connections with filtering, pagination, and ident
|
|
|
14361
14377
|
<dd>
|
|
14362
14378
|
|
|
14363
14379
|
```typescript
|
|
14364
|
-
await client.orgs.
|
|
14365
|
-
search: "search",
|
|
14366
|
-
page: 1,
|
|
14367
|
-
page_size: 1,
|
|
14368
|
-
filter_connected: true,
|
|
14369
|
-
});
|
|
14380
|
+
await client.orgs.complianceDocuments.listV1();
|
|
14370
14381
|
```
|
|
14371
14382
|
|
|
14372
14383
|
</dd>
|
|
@@ -14382,15 +14393,7 @@ await client.orgs.connections.listCoordinatorsForShipperV1({
|
|
|
14382
14393
|
<dl>
|
|
14383
14394
|
<dd>
|
|
14384
14395
|
|
|
14385
|
-
**
|
|
14386
|
-
|
|
14387
|
-
</dd>
|
|
14388
|
-
</dl>
|
|
14389
|
-
|
|
14390
|
-
<dl>
|
|
14391
|
-
<dd>
|
|
14392
|
-
|
|
14393
|
-
**requestOptions:** `Connections.RequestOptions`
|
|
14396
|
+
**requestOptions:** `ComplianceDocuments.RequestOptions`
|
|
14394
14397
|
|
|
14395
14398
|
</dd>
|
|
14396
14399
|
</dl>
|
|
@@ -14401,7 +14404,7 @@ await client.orgs.connections.listCoordinatorsForShipperV1({
|
|
|
14401
14404
|
</dl>
|
|
14402
14405
|
</details>
|
|
14403
14406
|
|
|
14404
|
-
<details><summary><code>client.orgs.
|
|
14407
|
+
<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>
|
|
14405
14408
|
<dl>
|
|
14406
14409
|
<dd>
|
|
14407
14410
|
|
|
@@ -14413,7 +14416,7 @@ await client.orgs.connections.listCoordinatorsForShipperV1({
|
|
|
14413
14416
|
<dl>
|
|
14414
14417
|
<dd>
|
|
14415
14418
|
|
|
14416
|
-
|
|
14419
|
+
Updates an organization compliance document for the caller's provider organization. | authz: allowed_org_types=[provider], min_org_role=administrator | (OrgComplianceDocumentClientUpdate1) -> (OrgComplianceDocument1)
|
|
14417
14420
|
|
|
14418
14421
|
</dd>
|
|
14419
14422
|
</dl>
|
|
@@ -14429,9 +14432,7 @@ Creates a shipper-coordinator or coordinator-executor connection to an on-CHRT p
|
|
|
14429
14432
|
<dd>
|
|
14430
14433
|
|
|
14431
14434
|
```typescript
|
|
14432
|
-
await client.orgs.
|
|
14433
|
-
handle: "handle",
|
|
14434
|
-
});
|
|
14435
|
+
await client.orgs.complianceDocuments.updateV1("org_compliance_document_id");
|
|
14435
14436
|
```
|
|
14436
14437
|
|
|
14437
14438
|
</dd>
|
|
@@ -14447,7 +14448,7 @@ await client.orgs.connections.createConnectionToProviderV1({
|
|
|
14447
14448
|
<dl>
|
|
14448
14449
|
<dd>
|
|
14449
14450
|
|
|
14450
|
-
**
|
|
14451
|
+
**orgComplianceDocumentId:** `string`
|
|
14451
14452
|
|
|
14452
14453
|
</dd>
|
|
14453
14454
|
</dl>
|
|
@@ -14455,7 +14456,15 @@ await client.orgs.connections.createConnectionToProviderV1({
|
|
|
14455
14456
|
<dl>
|
|
14456
14457
|
<dd>
|
|
14457
14458
|
|
|
14458
|
-
**
|
|
14459
|
+
**request:** `Chrt.orgs.OrgComplianceDocumentClientUpdate1`
|
|
14460
|
+
|
|
14461
|
+
</dd>
|
|
14462
|
+
</dl>
|
|
14463
|
+
|
|
14464
|
+
<dl>
|
|
14465
|
+
<dd>
|
|
14466
|
+
|
|
14467
|
+
**requestOptions:** `ComplianceDocuments.RequestOptions`
|
|
14459
14468
|
|
|
14460
14469
|
</dd>
|
|
14461
14470
|
</dl>
|
|
@@ -14466,7 +14475,7 @@ await client.orgs.connections.createConnectionToProviderV1({
|
|
|
14466
14475
|
</dl>
|
|
14467
14476
|
</details>
|
|
14468
14477
|
|
|
14469
|
-
<details><summary><code>client.orgs.
|
|
14478
|
+
<details><summary><code>client.orgs.complianceDocuments.<a href="/src/api/resources/orgs/resources/complianceDocuments/client/Client.ts">getV1</a>(orgComplianceDocumentId) -> Chrt.OrgComplianceDocument1</code></summary>
|
|
14470
14479
|
<dl>
|
|
14471
14480
|
<dd>
|
|
14472
14481
|
|
|
@@ -14478,7 +14487,7 @@ await client.orgs.connections.createConnectionToProviderV1({
|
|
|
14478
14487
|
<dl>
|
|
14479
14488
|
<dd>
|
|
14480
14489
|
|
|
14481
|
-
|
|
14490
|
+
Retrieves one compliance document for the caller's provider organization. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (OrgComplianceDocument1)
|
|
14482
14491
|
|
|
14483
14492
|
</dd>
|
|
14484
14493
|
</dl>
|
|
@@ -14494,9 +14503,7 @@ Creates a shipper-coordinator connection to an on-CHRT shipper. | authz: allowed
|
|
|
14494
14503
|
<dd>
|
|
14495
14504
|
|
|
14496
14505
|
```typescript
|
|
14497
|
-
await client.orgs.
|
|
14498
|
-
handle: "handle",
|
|
14499
|
-
});
|
|
14506
|
+
await client.orgs.complianceDocuments.getV1("org_compliance_document_id");
|
|
14500
14507
|
```
|
|
14501
14508
|
|
|
14502
14509
|
</dd>
|
|
@@ -14512,7 +14519,7 @@ await client.orgs.connections.createConnectionToShipperV1({
|
|
|
14512
14519
|
<dl>
|
|
14513
14520
|
<dd>
|
|
14514
14521
|
|
|
14515
|
-
**
|
|
14522
|
+
**orgComplianceDocumentId:** `string`
|
|
14516
14523
|
|
|
14517
14524
|
</dd>
|
|
14518
14525
|
</dl>
|
|
@@ -14520,7 +14527,7 @@ await client.orgs.connections.createConnectionToShipperV1({
|
|
|
14520
14527
|
<dl>
|
|
14521
14528
|
<dd>
|
|
14522
14529
|
|
|
14523
|
-
**requestOptions:** `
|
|
14530
|
+
**requestOptions:** `ComplianceDocuments.RequestOptions`
|
|
14524
14531
|
|
|
14525
14532
|
</dd>
|
|
14526
14533
|
</dl>
|
|
@@ -14531,7 +14538,9 @@ await client.orgs.connections.createConnectionToShipperV1({
|
|
|
14531
14538
|
</dl>
|
|
14532
14539
|
</details>
|
|
14533
14540
|
|
|
14534
|
-
|
|
14541
|
+
## Orgs Connections
|
|
14542
|
+
|
|
14543
|
+
<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>
|
|
14535
14544
|
<dl>
|
|
14536
14545
|
<dd>
|
|
14537
14546
|
|
|
@@ -14543,7 +14552,7 @@ await client.orgs.connections.createConnectionToShipperV1({
|
|
|
14543
14552
|
<dl>
|
|
14544
14553
|
<dd>
|
|
14545
14554
|
|
|
14546
|
-
|
|
14555
|
+
Gets the connection between caller's org and the org with the specified handle. | () -> (ShipperCoordinatorConnection1 | CoordinatorExecutorConnection1 | None)
|
|
14547
14556
|
|
|
14548
14557
|
</dd>
|
|
14549
14558
|
</dl>
|
|
@@ -14559,14 +14568,7 @@ Lists the caller's executor connections nearest to a location, with filtering an
|
|
|
14559
14568
|
<dd>
|
|
14560
14569
|
|
|
14561
14570
|
```typescript
|
|
14562
|
-
await client.orgs.connections.
|
|
14563
|
-
near_latitude: 1.1,
|
|
14564
|
-
near_longitude: 1.1,
|
|
14565
|
-
page: 1,
|
|
14566
|
-
page_size: 1,
|
|
14567
|
-
filter_auto_assign_enabled: true,
|
|
14568
|
-
filter_connected: true,
|
|
14569
|
-
});
|
|
14571
|
+
await client.orgs.connections.getByHandleV1("handle");
|
|
14570
14572
|
```
|
|
14571
14573
|
|
|
14572
14574
|
</dd>
|
|
@@ -14582,7 +14584,7 @@ await client.orgs.connections.listExecutorsGeoSearchForCoordinatorV1({
|
|
|
14582
14584
|
<dl>
|
|
14583
14585
|
<dd>
|
|
14584
14586
|
|
|
14585
|
-
**
|
|
14587
|
+
**handle:** `string`
|
|
14586
14588
|
|
|
14587
14589
|
</dd>
|
|
14588
14590
|
</dl>
|
|
@@ -14601,7 +14603,7 @@ await client.orgs.connections.listExecutorsGeoSearchForCoordinatorV1({
|
|
|
14601
14603
|
</dl>
|
|
14602
14604
|
</details>
|
|
14603
14605
|
|
|
14604
|
-
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">
|
|
14606
|
+
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">listCoordinatorsForExecutorV1</a>({ ...params }) -> Chrt.CoordinatorExecutorConnectionsForExecutorListRes</code></summary>
|
|
14605
14607
|
<dl>
|
|
14606
14608
|
<dd>
|
|
14607
14609
|
|
|
@@ -14613,7 +14615,7 @@ await client.orgs.connections.listExecutorsGeoSearchForCoordinatorV1({
|
|
|
14613
14615
|
<dl>
|
|
14614
14616
|
<dd>
|
|
14615
14617
|
|
|
14616
|
-
Lists the caller's
|
|
14618
|
+
Lists the caller's coordinator connections with filtering, pagination, and identity search. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (CoordinatorExecutorConnectionsForExecutorListRes)
|
|
14617
14619
|
|
|
14618
14620
|
</dd>
|
|
14619
14621
|
</dl>
|
|
@@ -14629,7 +14631,7 @@ Lists the caller's executor connections with filtering, pagination, and identity
|
|
|
14629
14631
|
<dd>
|
|
14630
14632
|
|
|
14631
14633
|
```typescript
|
|
14632
|
-
await client.orgs.connections.
|
|
14634
|
+
await client.orgs.connections.listCoordinatorsForExecutorV1({
|
|
14633
14635
|
search: "search",
|
|
14634
14636
|
page: 1,
|
|
14635
14637
|
page_size: 1,
|
|
@@ -14651,7 +14653,7 @@ await client.orgs.connections.listExecutorsForCoordinatorV1({
|
|
|
14651
14653
|
<dl>
|
|
14652
14654
|
<dd>
|
|
14653
14655
|
|
|
14654
|
-
**request:** `Chrt.orgs.
|
|
14656
|
+
**request:** `Chrt.orgs.ConnectionsListCoordinatorsForExecutorV1Request`
|
|
14655
14657
|
|
|
14656
14658
|
</dd>
|
|
14657
14659
|
</dl>
|
|
@@ -14670,7 +14672,7 @@ await client.orgs.connections.listExecutorsForCoordinatorV1({
|
|
|
14670
14672
|
</dl>
|
|
14671
14673
|
</details>
|
|
14672
14674
|
|
|
14673
|
-
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">
|
|
14675
|
+
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">listCoordinatorsForShipperV1</a>({ ...params }) -> Chrt.ShipperCoordinatorConnectionsForShipperListRes</code></summary>
|
|
14674
14676
|
<dl>
|
|
14675
14677
|
<dd>
|
|
14676
14678
|
|
|
@@ -14682,7 +14684,7 @@ await client.orgs.connections.listExecutorsForCoordinatorV1({
|
|
|
14682
14684
|
<dl>
|
|
14683
14685
|
<dd>
|
|
14684
14686
|
|
|
14685
|
-
|
|
14687
|
+
Lists the caller's coordinator connections with filtering, pagination, and identity search. | authz: allowed_org_types=[shipper] | () -> (ShipperCoordinatorConnectionsForShipperListRes)
|
|
14686
14688
|
|
|
14687
14689
|
</dd>
|
|
14688
14690
|
</dl>
|
|
@@ -14698,8 +14700,11 @@ Sets an executor's consent to direct task-group assignment. | authz: allowed_org
|
|
|
14698
14700
|
<dd>
|
|
14699
14701
|
|
|
14700
14702
|
```typescript
|
|
14701
|
-
await client.orgs.connections.
|
|
14702
|
-
|
|
14703
|
+
await client.orgs.connections.listCoordinatorsForShipperV1({
|
|
14704
|
+
search: "search",
|
|
14705
|
+
page: 1,
|
|
14706
|
+
page_size: 1,
|
|
14707
|
+
filter_connected: true,
|
|
14703
14708
|
});
|
|
14704
14709
|
```
|
|
14705
14710
|
|
|
@@ -14716,15 +14721,7 @@ await client.orgs.connections.setCoordinatorExecutorAutoAssignV1("connection_id"
|
|
|
14716
14721
|
<dl>
|
|
14717
14722
|
<dd>
|
|
14718
14723
|
|
|
14719
|
-
**
|
|
14720
|
-
|
|
14721
|
-
</dd>
|
|
14722
|
-
</dl>
|
|
14723
|
-
|
|
14724
|
-
<dl>
|
|
14725
|
-
<dd>
|
|
14726
|
-
|
|
14727
|
-
**request:** `Chrt.orgs.CoordinatorExecutorUpdateAutoAssignReq`
|
|
14724
|
+
**request:** `Chrt.orgs.ConnectionsListCoordinatorsForShipperV1Request`
|
|
14728
14725
|
|
|
14729
14726
|
</dd>
|
|
14730
14727
|
</dl>
|
|
@@ -14743,7 +14740,7 @@ await client.orgs.connections.setCoordinatorExecutorAutoAssignV1("connection_id"
|
|
|
14743
14740
|
</dl>
|
|
14744
14741
|
</details>
|
|
14745
14742
|
|
|
14746
|
-
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">
|
|
14743
|
+
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">createConnectionToProviderV1</a>({ ...params }) -> string</code></summary>
|
|
14747
14744
|
<dl>
|
|
14748
14745
|
<dd>
|
|
14749
14746
|
|
|
@@ -14755,7 +14752,7 @@ await client.orgs.connections.setCoordinatorExecutorAutoAssignV1("connection_id"
|
|
|
14755
14752
|
<dl>
|
|
14756
14753
|
<dd>
|
|
14757
14754
|
|
|
14758
|
-
|
|
14755
|
+
Creates a shipper-coordinator or coordinator-executor connection to an on-CHRT provider. | (CreateConnectionReq) -> (PydanticObjectId)
|
|
14759
14756
|
|
|
14760
14757
|
</dd>
|
|
14761
14758
|
</dl>
|
|
@@ -14771,7 +14768,9 @@ Sets or clears the coordinator's default department for a shipper-coordinator co
|
|
|
14771
14768
|
<dd>
|
|
14772
14769
|
|
|
14773
14770
|
```typescript
|
|
14774
|
-
await client.orgs.connections.
|
|
14771
|
+
await client.orgs.connections.createConnectionToProviderV1({
|
|
14772
|
+
handle: "handle",
|
|
14773
|
+
});
|
|
14775
14774
|
```
|
|
14776
14775
|
|
|
14777
14776
|
</dd>
|
|
@@ -14787,15 +14786,7 @@ await client.orgs.connections.setShipperCoordinatorDefaultDepartmentV1("connecti
|
|
|
14787
14786
|
<dl>
|
|
14788
14787
|
<dd>
|
|
14789
14788
|
|
|
14790
|
-
**
|
|
14791
|
-
|
|
14792
|
-
</dd>
|
|
14793
|
-
</dl>
|
|
14794
|
-
|
|
14795
|
-
<dl>
|
|
14796
|
-
<dd>
|
|
14797
|
-
|
|
14798
|
-
**request:** `Chrt.orgs.ShipperCoordinatorConnectionClientUpdate1`
|
|
14789
|
+
**request:** `Chrt.CreateConnectionReq`
|
|
14799
14790
|
|
|
14800
14791
|
</dd>
|
|
14801
14792
|
</dl>
|
|
@@ -14814,7 +14805,7 @@ await client.orgs.connections.setShipperCoordinatorDefaultDepartmentV1("connecti
|
|
|
14814
14805
|
</dl>
|
|
14815
14806
|
</details>
|
|
14816
14807
|
|
|
14817
|
-
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">
|
|
14808
|
+
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">createConnectionToShipperV1</a>({ ...params }) -> string</code></summary>
|
|
14818
14809
|
<dl>
|
|
14819
14810
|
<dd>
|
|
14820
14811
|
|
|
@@ -14826,7 +14817,7 @@ await client.orgs.connections.setShipperCoordinatorDefaultDepartmentV1("connecti
|
|
|
14826
14817
|
<dl>
|
|
14827
14818
|
<dd>
|
|
14828
14819
|
|
|
14829
|
-
|
|
14820
|
+
Creates a shipper-coordinator connection to an on-CHRT shipper. | authz: allowed_org_types=[provider] | (CreateConnectionReq) -> (PydanticObjectId)
|
|
14830
14821
|
|
|
14831
14822
|
</dd>
|
|
14832
14823
|
</dl>
|
|
@@ -14842,11 +14833,8 @@ Lists the caller's shipper connections with filtering, pagination, and identity
|
|
|
14842
14833
|
<dd>
|
|
14843
14834
|
|
|
14844
14835
|
```typescript
|
|
14845
|
-
await client.orgs.connections.
|
|
14846
|
-
|
|
14847
|
-
page: 1,
|
|
14848
|
-
page_size: 1,
|
|
14849
|
-
filter_connected: true,
|
|
14836
|
+
await client.orgs.connections.createConnectionToShipperV1({
|
|
14837
|
+
handle: "handle",
|
|
14850
14838
|
});
|
|
14851
14839
|
```
|
|
14852
14840
|
|
|
@@ -14863,7 +14851,7 @@ await client.orgs.connections.listShippersForCoordinatorV1({
|
|
|
14863
14851
|
<dl>
|
|
14864
14852
|
<dd>
|
|
14865
14853
|
|
|
14866
|
-
**request:** `Chrt.
|
|
14854
|
+
**request:** `Chrt.CreateConnectionReq`
|
|
14867
14855
|
|
|
14868
14856
|
</dd>
|
|
14869
14857
|
</dl>
|
|
@@ -14882,9 +14870,7 @@ await client.orgs.connections.listShippersForCoordinatorV1({
|
|
|
14882
14870
|
</dl>
|
|
14883
14871
|
</details>
|
|
14884
14872
|
|
|
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>
|
|
14873
|
+
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">listExecutorsGeoSearchForCoordinatorV1</a>({ ...params }) -> Chrt.CoordinatorExecutorConnectionsForCoordinatorGeoSearchListRes</code></summary>
|
|
14888
14874
|
<dl>
|
|
14889
14875
|
<dd>
|
|
14890
14876
|
|
|
@@ -14896,7 +14882,7 @@ await client.orgs.connections.listShippersForCoordinatorV1({
|
|
|
14896
14882
|
<dl>
|
|
14897
14883
|
<dd>
|
|
14898
14884
|
|
|
14899
|
-
|
|
14885
|
+
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)
|
|
14900
14886
|
|
|
14901
14887
|
</dd>
|
|
14902
14888
|
</dl>
|
|
@@ -14912,9 +14898,13 @@ Creates an organization-owned directory entry. | authz: min_org_role=operator |
|
|
|
14912
14898
|
<dd>
|
|
14913
14899
|
|
|
14914
14900
|
```typescript
|
|
14915
|
-
await client.orgs.
|
|
14916
|
-
|
|
14917
|
-
|
|
14901
|
+
await client.orgs.connections.listExecutorsGeoSearchForCoordinatorV1({
|
|
14902
|
+
near_latitude: 1.1,
|
|
14903
|
+
near_longitude: 1.1,
|
|
14904
|
+
page: 1,
|
|
14905
|
+
page_size: 1,
|
|
14906
|
+
filter_auto_assign_enabled: true,
|
|
14907
|
+
filter_connected: true,
|
|
14918
14908
|
});
|
|
14919
14909
|
```
|
|
14920
14910
|
|
|
@@ -14931,7 +14921,7 @@ await client.orgs.directoryEntries.createV1({
|
|
|
14931
14921
|
<dl>
|
|
14932
14922
|
<dd>
|
|
14933
14923
|
|
|
14934
|
-
**request:** `Chrt.orgs.
|
|
14924
|
+
**request:** `Chrt.orgs.ConnectionsListExecutorsGeoSearchForCoordinatorV1Request`
|
|
14935
14925
|
|
|
14936
14926
|
</dd>
|
|
14937
14927
|
</dl>
|
|
@@ -14939,7 +14929,7 @@ await client.orgs.directoryEntries.createV1({
|
|
|
14939
14929
|
<dl>
|
|
14940
14930
|
<dd>
|
|
14941
14931
|
|
|
14942
|
-
**requestOptions:** `
|
|
14932
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
14943
14933
|
|
|
14944
14934
|
</dd>
|
|
14945
14935
|
</dl>
|
|
@@ -14950,7 +14940,7 @@ await client.orgs.directoryEntries.createV1({
|
|
|
14950
14940
|
</dl>
|
|
14951
14941
|
</details>
|
|
14952
14942
|
|
|
14953
|
-
<details><summary><code>client.orgs.
|
|
14943
|
+
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">listExecutorsForCoordinatorV1</a>({ ...params }) -> Chrt.CoordinatorExecutorConnectionsForCoordinatorListRes</code></summary>
|
|
14954
14944
|
<dl>
|
|
14955
14945
|
<dd>
|
|
14956
14946
|
|
|
@@ -14962,7 +14952,7 @@ await client.orgs.directoryEntries.createV1({
|
|
|
14962
14952
|
<dl>
|
|
14963
14953
|
<dd>
|
|
14964
14954
|
|
|
14965
|
-
|
|
14955
|
+
Lists the caller's executor connections with filtering, pagination, and identity search. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (CoordinatorExecutorConnectionsForCoordinatorListRes)
|
|
14966
14956
|
|
|
14967
14957
|
</dd>
|
|
14968
14958
|
</dl>
|
|
@@ -14978,7 +14968,13 @@ Deletes an organization-owned directory entry. | authz: min_org_role=operator |
|
|
|
14978
14968
|
<dd>
|
|
14979
14969
|
|
|
14980
14970
|
```typescript
|
|
14981
|
-
await client.orgs.
|
|
14971
|
+
await client.orgs.connections.listExecutorsForCoordinatorV1({
|
|
14972
|
+
search: "search",
|
|
14973
|
+
page: 1,
|
|
14974
|
+
page_size: 1,
|
|
14975
|
+
filter_auto_assign_enabled: true,
|
|
14976
|
+
filter_connected: true,
|
|
14977
|
+
});
|
|
14982
14978
|
```
|
|
14983
14979
|
|
|
14984
14980
|
</dd>
|
|
@@ -14994,7 +14990,7 @@ await client.orgs.directoryEntries.deleteV1("directory_entry_id");
|
|
|
14994
14990
|
<dl>
|
|
14995
14991
|
<dd>
|
|
14996
14992
|
|
|
14997
|
-
**
|
|
14993
|
+
**request:** `Chrt.orgs.ConnectionsListExecutorsForCoordinatorV1Request`
|
|
14998
14994
|
|
|
14999
14995
|
</dd>
|
|
15000
14996
|
</dl>
|
|
@@ -15002,7 +14998,7 @@ await client.orgs.directoryEntries.deleteV1("directory_entry_id");
|
|
|
15002
14998
|
<dl>
|
|
15003
14999
|
<dd>
|
|
15004
15000
|
|
|
15005
|
-
**requestOptions:** `
|
|
15001
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
15006
15002
|
|
|
15007
15003
|
</dd>
|
|
15008
15004
|
</dl>
|
|
@@ -15013,7 +15009,7 @@ await client.orgs.directoryEntries.deleteV1("directory_entry_id");
|
|
|
15013
15009
|
</dl>
|
|
15014
15010
|
</details>
|
|
15015
15011
|
|
|
15016
|
-
<details><summary><code>client.orgs.
|
|
15012
|
+
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">setCoordinatorExecutorAutoAssignV1</a>(connectionId, { ...params }) -> boolean</code></summary>
|
|
15017
15013
|
<dl>
|
|
15018
15014
|
<dd>
|
|
15019
15015
|
|
|
@@ -15025,7 +15021,7 @@ await client.orgs.directoryEntries.deleteV1("directory_entry_id");
|
|
|
15025
15021
|
<dl>
|
|
15026
15022
|
<dd>
|
|
15027
15023
|
|
|
15028
|
-
|
|
15024
|
+
Sets an executor's consent to direct task-group assignment. | authz: allowed_org_types=[provider], min_org_role=administrator | (CoordinatorExecutorUpdateAutoAssignReq) -> (bool)
|
|
15029
15025
|
|
|
15030
15026
|
</dd>
|
|
15031
15027
|
</dl>
|
|
@@ -15041,14 +15037,8 @@ Lists organization-owned directory entries with association filters and search.
|
|
|
15041
15037
|
<dd>
|
|
15042
15038
|
|
|
15043
15039
|
```typescript
|
|
15044
|
-
await client.orgs.
|
|
15045
|
-
|
|
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,
|
|
15040
|
+
await client.orgs.connections.setCoordinatorExecutorAutoAssignV1("connection_id", {
|
|
15041
|
+
auto_assign_enabled: true,
|
|
15052
15042
|
});
|
|
15053
15043
|
```
|
|
15054
15044
|
|
|
@@ -15065,7 +15055,7 @@ await client.orgs.directoryEntries.listV1({
|
|
|
15065
15055
|
<dl>
|
|
15066
15056
|
<dd>
|
|
15067
15057
|
|
|
15068
|
-
**
|
|
15058
|
+
**connectionId:** `string`
|
|
15069
15059
|
|
|
15070
15060
|
</dd>
|
|
15071
15061
|
</dl>
|
|
@@ -15073,7 +15063,15 @@ await client.orgs.directoryEntries.listV1({
|
|
|
15073
15063
|
<dl>
|
|
15074
15064
|
<dd>
|
|
15075
15065
|
|
|
15076
|
-
**
|
|
15066
|
+
**request:** `Chrt.orgs.CoordinatorExecutorUpdateAutoAssignReq`
|
|
15067
|
+
|
|
15068
|
+
</dd>
|
|
15069
|
+
</dl>
|
|
15070
|
+
|
|
15071
|
+
<dl>
|
|
15072
|
+
<dd>
|
|
15073
|
+
|
|
15074
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
15077
15075
|
|
|
15078
15076
|
</dd>
|
|
15079
15077
|
</dl>
|
|
@@ -15084,7 +15082,7 @@ await client.orgs.directoryEntries.listV1({
|
|
|
15084
15082
|
</dl>
|
|
15085
15083
|
</details>
|
|
15086
15084
|
|
|
15087
|
-
<details><summary><code>client.orgs.
|
|
15085
|
+
<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
15086
|
<dl>
|
|
15089
15087
|
<dd>
|
|
15090
15088
|
|
|
@@ -15096,7 +15094,7 @@ await client.orgs.directoryEntries.listV1({
|
|
|
15096
15094
|
<dl>
|
|
15097
15095
|
<dd>
|
|
15098
15096
|
|
|
15099
|
-
|
|
15097
|
+
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
15098
|
|
|
15101
15099
|
</dd>
|
|
15102
15100
|
</dl>
|
|
@@ -15112,7 +15110,7 @@ Updates an organization-owned directory entry. | authz: min_org_role=operator |
|
|
|
15112
15110
|
<dd>
|
|
15113
15111
|
|
|
15114
15112
|
```typescript
|
|
15115
|
-
await client.orgs.
|
|
15113
|
+
await client.orgs.connections.setShipperCoordinatorDefaultDepartmentV1("connection_id");
|
|
15116
15114
|
```
|
|
15117
15115
|
|
|
15118
15116
|
</dd>
|
|
@@ -15128,7 +15126,7 @@ await client.orgs.directoryEntries.updateV1("directory_entry_id");
|
|
|
15128
15126
|
<dl>
|
|
15129
15127
|
<dd>
|
|
15130
15128
|
|
|
15131
|
-
**
|
|
15129
|
+
**connectionId:** `string`
|
|
15132
15130
|
|
|
15133
15131
|
</dd>
|
|
15134
15132
|
</dl>
|
|
@@ -15136,7 +15134,7 @@ await client.orgs.directoryEntries.updateV1("directory_entry_id");
|
|
|
15136
15134
|
<dl>
|
|
15137
15135
|
<dd>
|
|
15138
15136
|
|
|
15139
|
-
**request:** `Chrt.orgs.
|
|
15137
|
+
**request:** `Chrt.orgs.ShipperCoordinatorConnectionClientUpdate1`
|
|
15140
15138
|
|
|
15141
15139
|
</dd>
|
|
15142
15140
|
</dl>
|
|
@@ -15144,7 +15142,7 @@ await client.orgs.directoryEntries.updateV1("directory_entry_id");
|
|
|
15144
15142
|
<dl>
|
|
15145
15143
|
<dd>
|
|
15146
15144
|
|
|
15147
|
-
**requestOptions:** `
|
|
15145
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
15148
15146
|
|
|
15149
15147
|
</dd>
|
|
15150
15148
|
</dl>
|
|
@@ -15155,7 +15153,7 @@ await client.orgs.directoryEntries.updateV1("directory_entry_id");
|
|
|
15155
15153
|
</dl>
|
|
15156
15154
|
</details>
|
|
15157
15155
|
|
|
15158
|
-
<details><summary><code>client.orgs.
|
|
15156
|
+
<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
15157
|
<dl>
|
|
15160
15158
|
<dd>
|
|
15161
15159
|
|
|
@@ -15167,7 +15165,7 @@ await client.orgs.directoryEntries.updateV1("directory_entry_id");
|
|
|
15167
15165
|
<dl>
|
|
15168
15166
|
<dd>
|
|
15169
15167
|
|
|
15170
|
-
|
|
15168
|
+
Lists the caller's shipper connections with filtering, pagination, and identity search. | authz: allowed_org_types=[provider] | () -> (ShipperCoordinatorConnectionsForCoordinatorListRes)
|
|
15171
15169
|
|
|
15172
15170
|
</dd>
|
|
15173
15171
|
</dl>
|
|
@@ -15183,7 +15181,12 @@ Retrieves an organization-owned directory entry. | authz: min_org_role=operator
|
|
|
15183
15181
|
<dd>
|
|
15184
15182
|
|
|
15185
15183
|
```typescript
|
|
15186
|
-
await client.orgs.
|
|
15184
|
+
await client.orgs.connections.listShippersForCoordinatorV1({
|
|
15185
|
+
search: "search",
|
|
15186
|
+
page: 1,
|
|
15187
|
+
page_size: 1,
|
|
15188
|
+
filter_connected: true,
|
|
15189
|
+
});
|
|
15187
15190
|
```
|
|
15188
15191
|
|
|
15189
15192
|
</dd>
|
|
@@ -15199,7 +15202,7 @@ await client.orgs.directoryEntries.getV1("directory_entry_id");
|
|
|
15199
15202
|
<dl>
|
|
15200
15203
|
<dd>
|
|
15201
15204
|
|
|
15202
|
-
**
|
|
15205
|
+
**request:** `Chrt.orgs.ConnectionsListShippersForCoordinatorV1Request`
|
|
15203
15206
|
|
|
15204
15207
|
</dd>
|
|
15205
15208
|
</dl>
|
|
@@ -15207,7 +15210,7 @@ await client.orgs.directoryEntries.getV1("directory_entry_id");
|
|
|
15207
15210
|
<dl>
|
|
15208
15211
|
<dd>
|
|
15209
15212
|
|
|
15210
|
-
**requestOptions:** `
|
|
15213
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
15211
15214
|
|
|
15212
15215
|
</dd>
|
|
15213
15216
|
</dl>
|
|
@@ -15218,9 +15221,9 @@ await client.orgs.directoryEntries.getV1("directory_entry_id");
|
|
|
15218
15221
|
</dl>
|
|
15219
15222
|
</details>
|
|
15220
15223
|
|
|
15221
|
-
## Orgs
|
|
15224
|
+
## Orgs Contacts
|
|
15222
15225
|
|
|
15223
|
-
<details><summary><code>client.orgs.
|
|
15226
|
+
<details><summary><code>client.orgs.contacts.<a href="/src/api/resources/orgs/resources/contacts/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
15224
15227
|
<dl>
|
|
15225
15228
|
<dd>
|
|
15226
15229
|
|
|
@@ -15232,7 +15235,7 @@ await client.orgs.directoryEntries.getV1("directory_entry_id");
|
|
|
15232
15235
|
<dl>
|
|
15233
15236
|
<dd>
|
|
15234
15237
|
|
|
15235
|
-
|
|
15238
|
+
Creates an organization-created contact. | authz: min_org_role=operator | (ContactClientCreate1) -> (PydanticObjectId)
|
|
15236
15239
|
|
|
15237
15240
|
</dd>
|
|
15238
15241
|
</dl>
|
|
@@ -15248,12 +15251,9 @@ Atomically creates owner-scoped off-CHRT organization data and its shipper-coord
|
|
|
15248
15251
|
<dd>
|
|
15249
15252
|
|
|
15250
15253
|
```typescript
|
|
15251
|
-
await client.orgs.
|
|
15252
|
-
|
|
15253
|
-
|
|
15254
|
-
org_type: "provider",
|
|
15255
|
-
schema_version: 1,
|
|
15256
|
-
},
|
|
15254
|
+
await client.orgs.contacts.createV1({
|
|
15255
|
+
name: "name",
|
|
15256
|
+
schema_version: 1,
|
|
15257
15257
|
});
|
|
15258
15258
|
```
|
|
15259
15259
|
|
|
@@ -15270,7 +15270,7 @@ await client.orgs.offChrtOrgData.createV1({
|
|
|
15270
15270
|
<dl>
|
|
15271
15271
|
<dd>
|
|
15272
15272
|
|
|
15273
|
-
**request:** `Chrt.orgs.
|
|
15273
|
+
**request:** `Chrt.orgs.ContactClientCreate1`
|
|
15274
15274
|
|
|
15275
15275
|
</dd>
|
|
15276
15276
|
</dl>
|
|
@@ -15278,7 +15278,7 @@ await client.orgs.offChrtOrgData.createV1({
|
|
|
15278
15278
|
<dl>
|
|
15279
15279
|
<dd>
|
|
15280
15280
|
|
|
15281
|
-
**requestOptions:** `
|
|
15281
|
+
**requestOptions:** `Contacts.RequestOptions`
|
|
15282
15282
|
|
|
15283
15283
|
</dd>
|
|
15284
15284
|
</dl>
|
|
@@ -15289,7 +15289,7 @@ await client.orgs.offChrtOrgData.createV1({
|
|
|
15289
15289
|
</dl>
|
|
15290
15290
|
</details>
|
|
15291
15291
|
|
|
15292
|
-
<details><summary><code>client.orgs.
|
|
15292
|
+
<details><summary><code>client.orgs.contacts.<a href="/src/api/resources/orgs/resources/contacts/client/Client.ts">deleteV1</a>(contactId) -> boolean</code></summary>
|
|
15293
15293
|
<dl>
|
|
15294
15294
|
<dd>
|
|
15295
15295
|
|
|
@@ -15301,7 +15301,7 @@ await client.orgs.offChrtOrgData.createV1({
|
|
|
15301
15301
|
<dl>
|
|
15302
15302
|
<dd>
|
|
15303
15303
|
|
|
15304
|
-
|
|
15304
|
+
Deletes an organization-created contact. | authz: min_org_role=operator | () -> (bool)
|
|
15305
15305
|
|
|
15306
15306
|
</dd>
|
|
15307
15307
|
</dl>
|
|
@@ -15317,14 +15317,7 @@ Lists off-CHRT organization data owned by the caller with optional organization-
|
|
|
15317
15317
|
<dd>
|
|
15318
15318
|
|
|
15319
15319
|
```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
|
-
});
|
|
15320
|
+
await client.orgs.contacts.deleteV1("contact_id");
|
|
15328
15321
|
```
|
|
15329
15322
|
|
|
15330
15323
|
</dd>
|
|
@@ -15340,7 +15333,7 @@ await client.orgs.offChrtOrgData.listV1({
|
|
|
15340
15333
|
<dl>
|
|
15341
15334
|
<dd>
|
|
15342
15335
|
|
|
15343
|
-
**
|
|
15336
|
+
**contactId:** `string`
|
|
15344
15337
|
|
|
15345
15338
|
</dd>
|
|
15346
15339
|
</dl>
|
|
@@ -15348,7 +15341,7 @@ await client.orgs.offChrtOrgData.listV1({
|
|
|
15348
15341
|
<dl>
|
|
15349
15342
|
<dd>
|
|
15350
15343
|
|
|
15351
|
-
**requestOptions:** `
|
|
15344
|
+
**requestOptions:** `Contacts.RequestOptions`
|
|
15352
15345
|
|
|
15353
15346
|
</dd>
|
|
15354
15347
|
</dl>
|
|
@@ -15359,7 +15352,7 @@ await client.orgs.offChrtOrgData.listV1({
|
|
|
15359
15352
|
</dl>
|
|
15360
15353
|
</details>
|
|
15361
15354
|
|
|
15362
|
-
<details><summary><code>client.orgs.
|
|
15355
|
+
<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
15356
|
<dl>
|
|
15364
15357
|
<dd>
|
|
15365
15358
|
|
|
@@ -15371,7 +15364,7 @@ await client.orgs.offChrtOrgData.listV1({
|
|
|
15371
15364
|
<dl>
|
|
15372
15365
|
<dd>
|
|
15373
15366
|
|
|
15374
|
-
|
|
15367
|
+
Lists organization-created contacts with association filters and search. | authz: min_org_role=operator | () -> (ContactListRes)
|
|
15375
15368
|
|
|
15376
15369
|
</dd>
|
|
15377
15370
|
</dl>
|
|
@@ -15387,7 +15380,16 @@ Gets owner-scoped off-CHRT organization data by ID. | authz: allowed_org_types=[
|
|
|
15387
15380
|
<dd>
|
|
15388
15381
|
|
|
15389
15382
|
```typescript
|
|
15390
|
-
await client.orgs.
|
|
15383
|
+
await client.orgs.contacts.listV1({
|
|
15384
|
+
search: "search",
|
|
15385
|
+
filter_org_id: "filter_org_id",
|
|
15386
|
+
filter_off_chrt_org_data_id: "filter_off_chrt_org_data_id",
|
|
15387
|
+
filter_account_id: "filter_account_id",
|
|
15388
|
+
sort_by: "name",
|
|
15389
|
+
sort_order: "asc",
|
|
15390
|
+
page: 1,
|
|
15391
|
+
page_size: 1,
|
|
15392
|
+
});
|
|
15391
15393
|
```
|
|
15392
15394
|
|
|
15393
15395
|
</dd>
|
|
@@ -15403,7 +15405,7 @@ await client.orgs.offChrtOrgData.getByIdV1("off_chrt_org_data_id");
|
|
|
15403
15405
|
<dl>
|
|
15404
15406
|
<dd>
|
|
15405
15407
|
|
|
15406
|
-
**
|
|
15408
|
+
**request:** `Chrt.orgs.ContactsListV1Request`
|
|
15407
15409
|
|
|
15408
15410
|
</dd>
|
|
15409
15411
|
</dl>
|
|
@@ -15411,7 +15413,7 @@ await client.orgs.offChrtOrgData.getByIdV1("off_chrt_org_data_id");
|
|
|
15411
15413
|
<dl>
|
|
15412
15414
|
<dd>
|
|
15413
15415
|
|
|
15414
|
-
**requestOptions:** `
|
|
15416
|
+
**requestOptions:** `Contacts.RequestOptions`
|
|
15415
15417
|
|
|
15416
15418
|
</dd>
|
|
15417
15419
|
</dl>
|
|
@@ -15422,7 +15424,7 @@ await client.orgs.offChrtOrgData.getByIdV1("off_chrt_org_data_id");
|
|
|
15422
15424
|
</dl>
|
|
15423
15425
|
</details>
|
|
15424
15426
|
|
|
15425
|
-
<details><summary><code>client.orgs.
|
|
15427
|
+
<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
15428
|
<dl>
|
|
15427
15429
|
<dd>
|
|
15428
15430
|
|
|
@@ -15434,7 +15436,7 @@ await client.orgs.offChrtOrgData.getByIdV1("off_chrt_org_data_id");
|
|
|
15434
15436
|
<dl>
|
|
15435
15437
|
<dd>
|
|
15436
15438
|
|
|
15437
|
-
Updates
|
|
15439
|
+
Updates an organization-created contact. | authz: min_org_role=operator | (ContactClientUpdate1) -> (bool)
|
|
15438
15440
|
|
|
15439
15441
|
</dd>
|
|
15440
15442
|
</dl>
|
|
@@ -15450,7 +15452,7 @@ Updates canonical identity fields for owner-scoped off-CHRT organization data. |
|
|
|
15450
15452
|
<dd>
|
|
15451
15453
|
|
|
15452
15454
|
```typescript
|
|
15453
|
-
await client.orgs.
|
|
15455
|
+
await client.orgs.contacts.updateV1("contact_id");
|
|
15454
15456
|
```
|
|
15455
15457
|
|
|
15456
15458
|
</dd>
|
|
@@ -15466,7 +15468,7 @@ await client.orgs.offChrtOrgData.updateByIdV1("off_chrt_org_data_id");
|
|
|
15466
15468
|
<dl>
|
|
15467
15469
|
<dd>
|
|
15468
15470
|
|
|
15469
|
-
**
|
|
15471
|
+
**contactId:** `string`
|
|
15470
15472
|
|
|
15471
15473
|
</dd>
|
|
15472
15474
|
</dl>
|
|
@@ -15474,7 +15476,7 @@ await client.orgs.offChrtOrgData.updateByIdV1("off_chrt_org_data_id");
|
|
|
15474
15476
|
<dl>
|
|
15475
15477
|
<dd>
|
|
15476
15478
|
|
|
15477
|
-
**request:** `Chrt.orgs.
|
|
15479
|
+
**request:** `Chrt.orgs.ContactClientUpdate1`
|
|
15478
15480
|
|
|
15479
15481
|
</dd>
|
|
15480
15482
|
</dl>
|
|
@@ -15482,7 +15484,7 @@ await client.orgs.offChrtOrgData.updateByIdV1("off_chrt_org_data_id");
|
|
|
15482
15484
|
<dl>
|
|
15483
15485
|
<dd>
|
|
15484
15486
|
|
|
15485
|
-
**requestOptions:** `
|
|
15487
|
+
**requestOptions:** `Contacts.RequestOptions`
|
|
15486
15488
|
|
|
15487
15489
|
</dd>
|
|
15488
15490
|
</dl>
|
|
@@ -15493,9 +15495,7 @@ await client.orgs.offChrtOrgData.updateByIdV1("off_chrt_org_data_id");
|
|
|
15493
15495
|
</dl>
|
|
15494
15496
|
</details>
|
|
15495
15497
|
|
|
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>
|
|
15498
|
+
<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
15499
|
<dl>
|
|
15500
15500
|
<dd>
|
|
15501
15501
|
|
|
@@ -15507,7 +15507,7 @@ await client.orgs.offChrtOrgData.updateByIdV1("off_chrt_org_data_id");
|
|
|
15507
15507
|
<dl>
|
|
15508
15508
|
<dd>
|
|
15509
15509
|
|
|
15510
|
-
|
|
15510
|
+
Retrieves an organization-created contact. | authz: min_org_role=operator | () -> (Contact1)
|
|
15511
15511
|
|
|
15512
15512
|
</dd>
|
|
15513
15513
|
</dl>
|
|
@@ -15523,10 +15523,7 @@ Creates an off-platform vendor shell owned by the caller's org. Used as an off-C
|
|
|
15523
15523
|
<dd>
|
|
15524
15524
|
|
|
15525
15525
|
```typescript
|
|
15526
|
-
await client.orgs.
|
|
15527
|
-
name: "name",
|
|
15528
|
-
schema_version: 1,
|
|
15529
|
-
});
|
|
15526
|
+
await client.orgs.contacts.getV1("contact_id");
|
|
15530
15527
|
```
|
|
15531
15528
|
|
|
15532
15529
|
</dd>
|
|
@@ -15542,7 +15539,7 @@ await client.orgs.offChrtVendor.createV1({
|
|
|
15542
15539
|
<dl>
|
|
15543
15540
|
<dd>
|
|
15544
15541
|
|
|
15545
|
-
**
|
|
15542
|
+
**contactId:** `string`
|
|
15546
15543
|
|
|
15547
15544
|
</dd>
|
|
15548
15545
|
</dl>
|
|
@@ -15550,7 +15547,7 @@ await client.orgs.offChrtVendor.createV1({
|
|
|
15550
15547
|
<dl>
|
|
15551
15548
|
<dd>
|
|
15552
15549
|
|
|
15553
|
-
**requestOptions:** `
|
|
15550
|
+
**requestOptions:** `Contacts.RequestOptions`
|
|
15554
15551
|
|
|
15555
15552
|
</dd>
|
|
15556
15553
|
</dl>
|
|
@@ -15561,7 +15558,9 @@ await client.orgs.offChrtVendor.createV1({
|
|
|
15561
15558
|
</dl>
|
|
15562
15559
|
</details>
|
|
15563
15560
|
|
|
15564
|
-
|
|
15561
|
+
## Orgs OffChrtOrgData
|
|
15562
|
+
|
|
15563
|
+
<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
15564
|
<dl>
|
|
15566
15565
|
<dd>
|
|
15567
15566
|
|
|
@@ -15573,7 +15572,7 @@ await client.orgs.offChrtVendor.createV1({
|
|
|
15573
15572
|
<dl>
|
|
15574
15573
|
<dd>
|
|
15575
15574
|
|
|
15576
|
-
|
|
15575
|
+
Creates owner-scoped off-CHRT organization data and, for shippers or providers, its required connection. | authz: allowed_org_types=[provider] | (CreateOffChrtOrgReq) -> (CreateOffChrtOrgRes)
|
|
15577
15576
|
|
|
15578
15577
|
</dd>
|
|
15579
15578
|
</dl>
|
|
@@ -15589,9 +15588,12 @@ Lists all off-chrt vendors created by the caller's organization. Pagination only
|
|
|
15589
15588
|
<dd>
|
|
15590
15589
|
|
|
15591
15590
|
```typescript
|
|
15592
|
-
await client.orgs.
|
|
15593
|
-
|
|
15594
|
-
|
|
15591
|
+
await client.orgs.offChrtOrgData.createV1({
|
|
15592
|
+
off_chrt_org_data: {
|
|
15593
|
+
name: "name",
|
|
15594
|
+
org_type: "provider",
|
|
15595
|
+
schema_version: 1,
|
|
15596
|
+
},
|
|
15595
15597
|
});
|
|
15596
15598
|
```
|
|
15597
15599
|
|
|
@@ -15608,7 +15610,7 @@ await client.orgs.offChrtVendor.listV1({
|
|
|
15608
15610
|
<dl>
|
|
15609
15611
|
<dd>
|
|
15610
15612
|
|
|
15611
|
-
**request:** `Chrt.orgs.
|
|
15613
|
+
**request:** `Chrt.orgs.CreateOffChrtOrgReq`
|
|
15612
15614
|
|
|
15613
15615
|
</dd>
|
|
15614
15616
|
</dl>
|
|
@@ -15616,7 +15618,7 @@ await client.orgs.offChrtVendor.listV1({
|
|
|
15616
15618
|
<dl>
|
|
15617
15619
|
<dd>
|
|
15618
15620
|
|
|
15619
|
-
**requestOptions:** `
|
|
15621
|
+
**requestOptions:** `OffChrtOrgData.RequestOptions`
|
|
15620
15622
|
|
|
15621
15623
|
</dd>
|
|
15622
15624
|
</dl>
|
|
@@ -15627,7 +15629,7 @@ await client.orgs.offChrtVendor.listV1({
|
|
|
15627
15629
|
</dl>
|
|
15628
15630
|
</details>
|
|
15629
15631
|
|
|
15630
|
-
<details><summary><code>client.orgs.
|
|
15632
|
+
<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
15633
|
<dl>
|
|
15632
15634
|
<dd>
|
|
15633
15635
|
|
|
@@ -15639,7 +15641,7 @@ await client.orgs.offChrtVendor.listV1({
|
|
|
15639
15641
|
<dl>
|
|
15640
15642
|
<dd>
|
|
15641
15643
|
|
|
15642
|
-
|
|
15644
|
+
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
15645
|
|
|
15644
15646
|
</dd>
|
|
15645
15647
|
</dl>
|
|
@@ -15655,7 +15657,14 @@ Retrieves a specific off-chrt vendor by ID. Scoped to the caller's org. | () ->
|
|
|
15655
15657
|
<dd>
|
|
15656
15658
|
|
|
15657
15659
|
```typescript
|
|
15658
|
-
await client.orgs.
|
|
15660
|
+
await client.orgs.offChrtOrgData.listV1({
|
|
15661
|
+
search: "search",
|
|
15662
|
+
filter_org_type: "provider",
|
|
15663
|
+
sort_by: "name",
|
|
15664
|
+
sort_order: "asc",
|
|
15665
|
+
page: 1,
|
|
15666
|
+
page_size: 1,
|
|
15667
|
+
});
|
|
15659
15668
|
```
|
|
15660
15669
|
|
|
15661
15670
|
</dd>
|
|
@@ -15671,7 +15680,7 @@ await client.orgs.offChrtVendor.getByIdV1("id");
|
|
|
15671
15680
|
<dl>
|
|
15672
15681
|
<dd>
|
|
15673
15682
|
|
|
15674
|
-
**
|
|
15683
|
+
**request:** `Chrt.orgs.OffChrtOrgDataListV1Request`
|
|
15675
15684
|
|
|
15676
15685
|
</dd>
|
|
15677
15686
|
</dl>
|
|
@@ -15679,7 +15688,7 @@ await client.orgs.offChrtVendor.getByIdV1("id");
|
|
|
15679
15688
|
<dl>
|
|
15680
15689
|
<dd>
|
|
15681
15690
|
|
|
15682
|
-
**requestOptions:** `
|
|
15691
|
+
**requestOptions:** `OffChrtOrgData.RequestOptions`
|
|
15683
15692
|
|
|
15684
15693
|
</dd>
|
|
15685
15694
|
</dl>
|
|
@@ -15690,7 +15699,7 @@ await client.orgs.offChrtVendor.getByIdV1("id");
|
|
|
15690
15699
|
</dl>
|
|
15691
15700
|
</details>
|
|
15692
15701
|
|
|
15693
|
-
<details><summary><code>client.orgs.
|
|
15702
|
+
<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
15703
|
<dl>
|
|
15695
15704
|
<dd>
|
|
15696
15705
|
|
|
@@ -15702,7 +15711,7 @@ await client.orgs.offChrtVendor.getByIdV1("id");
|
|
|
15702
15711
|
<dl>
|
|
15703
15712
|
<dd>
|
|
15704
15713
|
|
|
15705
|
-
|
|
15714
|
+
Gets owner-scoped off-CHRT organization data by ID. | authz: allowed_org_types=[provider] | () -> (OffChrtOrgData1)
|
|
15706
15715
|
|
|
15707
15716
|
</dd>
|
|
15708
15717
|
</dl>
|
|
@@ -15718,7 +15727,7 @@ Deletes an off-chrt vendor owned by the caller's organization. Existing LineItem
|
|
|
15718
15727
|
<dd>
|
|
15719
15728
|
|
|
15720
15729
|
```typescript
|
|
15721
|
-
await client.orgs.
|
|
15730
|
+
await client.orgs.offChrtOrgData.getByIdV1("off_chrt_org_data_id");
|
|
15722
15731
|
```
|
|
15723
15732
|
|
|
15724
15733
|
</dd>
|
|
@@ -15734,7 +15743,7 @@ await client.orgs.offChrtVendor.deleteByIdV1("id");
|
|
|
15734
15743
|
<dl>
|
|
15735
15744
|
<dd>
|
|
15736
15745
|
|
|
15737
|
-
**
|
|
15746
|
+
**offChrtOrgDataId:** `string`
|
|
15738
15747
|
|
|
15739
15748
|
</dd>
|
|
15740
15749
|
</dl>
|
|
@@ -15742,7 +15751,7 @@ await client.orgs.offChrtVendor.deleteByIdV1("id");
|
|
|
15742
15751
|
<dl>
|
|
15743
15752
|
<dd>
|
|
15744
15753
|
|
|
15745
|
-
**requestOptions:** `
|
|
15754
|
+
**requestOptions:** `OffChrtOrgData.RequestOptions`
|
|
15746
15755
|
|
|
15747
15756
|
</dd>
|
|
15748
15757
|
</dl>
|
|
@@ -15753,7 +15762,7 @@ await client.orgs.offChrtVendor.deleteByIdV1("id");
|
|
|
15753
15762
|
</dl>
|
|
15754
15763
|
</details>
|
|
15755
15764
|
|
|
15756
|
-
<details><summary><code>client.orgs.
|
|
15765
|
+
<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
15766
|
<dl>
|
|
15758
15767
|
<dd>
|
|
15759
15768
|
|
|
@@ -15765,7 +15774,7 @@ await client.orgs.offChrtVendor.deleteByIdV1("id");
|
|
|
15765
15774
|
<dl>
|
|
15766
15775
|
<dd>
|
|
15767
15776
|
|
|
15768
|
-
Updates
|
|
15777
|
+
Updates canonical identity fields for owner-scoped off-CHRT organization data. | authz: allowed_org_types=[provider] | (OffChrtOrgDataClientUpdate1) -> (bool)
|
|
15769
15778
|
|
|
15770
15779
|
</dd>
|
|
15771
15780
|
</dl>
|
|
@@ -15781,7 +15790,7 @@ Updates an existing off-chrt vendor owned by the caller's organization. | (OffCh
|
|
|
15781
15790
|
<dd>
|
|
15782
15791
|
|
|
15783
15792
|
```typescript
|
|
15784
|
-
await client.orgs.
|
|
15793
|
+
await client.orgs.offChrtOrgData.updateByIdV1("off_chrt_org_data_id");
|
|
15785
15794
|
```
|
|
15786
15795
|
|
|
15787
15796
|
</dd>
|
|
@@ -15797,7 +15806,7 @@ await client.orgs.offChrtVendor.updateByIdV1("id");
|
|
|
15797
15806
|
<dl>
|
|
15798
15807
|
<dd>
|
|
15799
15808
|
|
|
15800
|
-
**
|
|
15809
|
+
**offChrtOrgDataId:** `string`
|
|
15801
15810
|
|
|
15802
15811
|
</dd>
|
|
15803
15812
|
</dl>
|
|
@@ -15805,7 +15814,7 @@ await client.orgs.offChrtVendor.updateByIdV1("id");
|
|
|
15805
15814
|
<dl>
|
|
15806
15815
|
<dd>
|
|
15807
15816
|
|
|
15808
|
-
**request:** `Chrt.orgs.
|
|
15817
|
+
**request:** `Chrt.orgs.OffChrtOrgDataClientUpdate1`
|
|
15809
15818
|
|
|
15810
15819
|
</dd>
|
|
15811
15820
|
</dl>
|
|
@@ -15813,7 +15822,7 @@ await client.orgs.offChrtVendor.updateByIdV1("id");
|
|
|
15813
15822
|
<dl>
|
|
15814
15823
|
<dd>
|
|
15815
15824
|
|
|
15816
|
-
**requestOptions:** `
|
|
15825
|
+
**requestOptions:** `OffChrtOrgData.RequestOptions`
|
|
15817
15826
|
|
|
15818
15827
|
</dd>
|
|
15819
15828
|
</dl>
|
|
@@ -19523,7 +19532,7 @@ await client.shipping.orderTemplates.listV1({
|
|
|
19523
19532
|
filter_department_id: "filter_department_id",
|
|
19524
19533
|
filter_coordinator_label: "filter_coordinator_label",
|
|
19525
19534
|
filter_driver_id: "filter_driver_id",
|
|
19526
|
-
|
|
19535
|
+
filter_contact_id: "filter_contact_id",
|
|
19527
19536
|
filter_task_lists_to_apply_at_order_creation_task_list_id:
|
|
19528
19537
|
"filter_task_lists_to_apply_at_order_creation_task_list_id",
|
|
19529
19538
|
filter_task_lists_to_apply_at_order_staging_task_list_id:
|
|
@@ -20171,6 +20180,148 @@ await client.shipping.orders.cancelManyV1({
|
|
|
20171
20180
|
</dl>
|
|
20172
20181
|
</details>
|
|
20173
20182
|
|
|
20183
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">addCoordinatorShipperAccountIdV1</a>(orderId, coordinatorShipperAccountId) -> boolean</code></summary>
|
|
20184
|
+
<dl>
|
|
20185
|
+
<dd>
|
|
20186
|
+
|
|
20187
|
+
#### 📝 Description
|
|
20188
|
+
|
|
20189
|
+
<dl>
|
|
20190
|
+
<dd>
|
|
20191
|
+
|
|
20192
|
+
<dl>
|
|
20193
|
+
<dd>
|
|
20194
|
+
|
|
20195
|
+
Adds a coordinator-owned account for the order's shipper. | authz_personas=[coordinator_org_operators] | () -> (bool)
|
|
20196
|
+
|
|
20197
|
+
</dd>
|
|
20198
|
+
</dl>
|
|
20199
|
+
</dd>
|
|
20200
|
+
</dl>
|
|
20201
|
+
|
|
20202
|
+
#### 🔌 Usage
|
|
20203
|
+
|
|
20204
|
+
<dl>
|
|
20205
|
+
<dd>
|
|
20206
|
+
|
|
20207
|
+
<dl>
|
|
20208
|
+
<dd>
|
|
20209
|
+
|
|
20210
|
+
```typescript
|
|
20211
|
+
await client.shipping.orders.addCoordinatorShipperAccountIdV1("order_id", "coordinator_shipper_account_id");
|
|
20212
|
+
```
|
|
20213
|
+
|
|
20214
|
+
</dd>
|
|
20215
|
+
</dl>
|
|
20216
|
+
</dd>
|
|
20217
|
+
</dl>
|
|
20218
|
+
|
|
20219
|
+
#### ⚙️ Parameters
|
|
20220
|
+
|
|
20221
|
+
<dl>
|
|
20222
|
+
<dd>
|
|
20223
|
+
|
|
20224
|
+
<dl>
|
|
20225
|
+
<dd>
|
|
20226
|
+
|
|
20227
|
+
**orderId:** `string`
|
|
20228
|
+
|
|
20229
|
+
</dd>
|
|
20230
|
+
</dl>
|
|
20231
|
+
|
|
20232
|
+
<dl>
|
|
20233
|
+
<dd>
|
|
20234
|
+
|
|
20235
|
+
**coordinatorShipperAccountId:** `string`
|
|
20236
|
+
|
|
20237
|
+
</dd>
|
|
20238
|
+
</dl>
|
|
20239
|
+
|
|
20240
|
+
<dl>
|
|
20241
|
+
<dd>
|
|
20242
|
+
|
|
20243
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
20244
|
+
|
|
20245
|
+
</dd>
|
|
20246
|
+
</dl>
|
|
20247
|
+
</dd>
|
|
20248
|
+
</dl>
|
|
20249
|
+
|
|
20250
|
+
</dd>
|
|
20251
|
+
</dl>
|
|
20252
|
+
</details>
|
|
20253
|
+
|
|
20254
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">removeCoordinatorShipperAccountIdV1</a>(orderId, coordinatorShipperAccountId) -> boolean</code></summary>
|
|
20255
|
+
<dl>
|
|
20256
|
+
<dd>
|
|
20257
|
+
|
|
20258
|
+
#### 📝 Description
|
|
20259
|
+
|
|
20260
|
+
<dl>
|
|
20261
|
+
<dd>
|
|
20262
|
+
|
|
20263
|
+
<dl>
|
|
20264
|
+
<dd>
|
|
20265
|
+
|
|
20266
|
+
Removes a coordinator-owned account for the order's shipper. | authz_personas=[coordinator_org_operators] | () -> (bool)
|
|
20267
|
+
|
|
20268
|
+
</dd>
|
|
20269
|
+
</dl>
|
|
20270
|
+
</dd>
|
|
20271
|
+
</dl>
|
|
20272
|
+
|
|
20273
|
+
#### 🔌 Usage
|
|
20274
|
+
|
|
20275
|
+
<dl>
|
|
20276
|
+
<dd>
|
|
20277
|
+
|
|
20278
|
+
<dl>
|
|
20279
|
+
<dd>
|
|
20280
|
+
|
|
20281
|
+
```typescript
|
|
20282
|
+
await client.shipping.orders.removeCoordinatorShipperAccountIdV1("order_id", "coordinator_shipper_account_id");
|
|
20283
|
+
```
|
|
20284
|
+
|
|
20285
|
+
</dd>
|
|
20286
|
+
</dl>
|
|
20287
|
+
</dd>
|
|
20288
|
+
</dl>
|
|
20289
|
+
|
|
20290
|
+
#### ⚙️ Parameters
|
|
20291
|
+
|
|
20292
|
+
<dl>
|
|
20293
|
+
<dd>
|
|
20294
|
+
|
|
20295
|
+
<dl>
|
|
20296
|
+
<dd>
|
|
20297
|
+
|
|
20298
|
+
**orderId:** `string`
|
|
20299
|
+
|
|
20300
|
+
</dd>
|
|
20301
|
+
</dl>
|
|
20302
|
+
|
|
20303
|
+
<dl>
|
|
20304
|
+
<dd>
|
|
20305
|
+
|
|
20306
|
+
**coordinatorShipperAccountId:** `string`
|
|
20307
|
+
|
|
20308
|
+
</dd>
|
|
20309
|
+
</dl>
|
|
20310
|
+
|
|
20311
|
+
<dl>
|
|
20312
|
+
<dd>
|
|
20313
|
+
|
|
20314
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
20315
|
+
|
|
20316
|
+
</dd>
|
|
20317
|
+
</dl>
|
|
20318
|
+
</dd>
|
|
20319
|
+
</dl>
|
|
20320
|
+
|
|
20321
|
+
</dd>
|
|
20322
|
+
</dl>
|
|
20323
|
+
</details>
|
|
20324
|
+
|
|
20174
20325
|
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">stageV1</a>(orderId) -> boolean</code></summary>
|
|
20175
20326
|
<dl>
|
|
20176
20327
|
<dd>
|
|
@@ -23065,7 +23216,7 @@ await client.shipping.tasks.skipV1("task_id");
|
|
|
23065
23216
|
<dl>
|
|
23066
23217
|
<dd>
|
|
23067
23218
|
|
|
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).
|
|
23219
|
+
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
23220
|
|
|
23070
23221
|
</dd>
|
|
23071
23222
|
</dl>
|
|
@@ -25255,6 +25406,7 @@ await client.shipping.orders.expanded.listForCoordinatorOperatorsV1({
|
|
|
25255
25406
|
page: 1,
|
|
25256
25407
|
page_size: 1,
|
|
25257
25408
|
search: "search",
|
|
25409
|
+
filter_awb_number: "filter_awb_number",
|
|
25258
25410
|
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
25259
25411
|
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
25260
25412
|
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
@@ -25342,6 +25494,7 @@ await client.shipping.orders.expanded.listForExecutorOperatorsV1({
|
|
|
25342
25494
|
page: 1,
|
|
25343
25495
|
page_size: 1,
|
|
25344
25496
|
search: "search",
|
|
25497
|
+
filter_awb_number: "filter_awb_number",
|
|
25345
25498
|
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
25346
25499
|
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
25347
25500
|
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
@@ -25428,6 +25581,7 @@ await client.shipping.orders.expanded.listForProviderOperatorsV1({
|
|
|
25428
25581
|
page: 1,
|
|
25429
25582
|
page_size: 1,
|
|
25430
25583
|
search: "search",
|
|
25584
|
+
filter_awb_number: "filter_awb_number",
|
|
25431
25585
|
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
25432
25586
|
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
25433
25587
|
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
@@ -25516,6 +25670,7 @@ await client.shipping.orders.expanded.listForShipperOperatorsV1({
|
|
|
25516
25670
|
page: 1,
|
|
25517
25671
|
page_size: 1,
|
|
25518
25672
|
search: "search",
|
|
25673
|
+
filter_awb_number: "filter_awb_number",
|
|
25519
25674
|
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
25520
25675
|
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
25521
25676
|
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|