@chrt-inc/typescript-sdk 1.1015.0 → 1.1017.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/README.md +10 -13
- package/dist/cjs/Client.d.ts +3 -0
- package/dist/cjs/Client.js +41 -36
- package/dist/cjs/api/resources/agent/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/agent/client/Client.js +3 -3
- package/dist/cjs/api/resources/agent/resources/index.d.ts +1 -2
- package/dist/cjs/api/resources/agent/resources/index.js +2 -6
- package/dist/cjs/api/resources/agent/resources/livekit/client/Client.d.ts +23 -0
- package/dist/cjs/api/resources/agent/resources/livekit/client/Client.js +17 -0
- package/dist/cjs/api/resources/agent/resources/livekit/index.d.ts +2 -0
- package/dist/cjs/api/resources/agent/resources/livekit/index.js +18 -0
- package/dist/cjs/api/resources/agent/resources/livekit/resources/helloWorld/client/Client.d.ts +44 -0
- package/dist/cjs/api/resources/agent/resources/livekit/resources/helloWorld/client/Client.js +118 -0
- package/dist/cjs/api/resources/agent/resources/livekit/resources/helloWorld/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/agent/resources/livekit/resources/helloWorld/client/index.js +2 -0
- package/dist/cjs/api/resources/agent/resources/livekit/resources/index.d.ts +1 -0
- package/dist/cjs/api/resources/agent/resources/livekit/resources/index.js +37 -0
- package/dist/cjs/api/resources/cargoOnFlightIntegrations/resources/cargoai/client/Client.d.ts +51 -0
- package/dist/cjs/api/resources/cargoOnFlightIntegrations/resources/cargoai/client/Client.js +222 -0
- package/dist/cjs/api/resources/cargoOnFlightIntegrations/resources/cargoai/client/requests/CargoOnFlightIntegrationsCargoAiSendAirWaybillReq.d.ts +13 -0
- package/dist/cjs/api/resources/cargoOnFlightIntegrations/resources/cargoai/client/requests/CargoOnFlightIntegrationsCargoAiSimulateAirlineResponseReq.d.ts +13 -0
- package/dist/cjs/api/resources/cargoOnFlightIntegrations/resources/cargoai/client/requests/CargoaiListAirWaybillMessagesV1Request.d.ts +30 -0
- package/dist/cjs/api/resources/cargoOnFlightIntegrations/resources/cargoai/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/chrtGpt/client/Client.d.ts +49 -0
- package/dist/cjs/api/resources/chrtGpt/client/Client.js +132 -0
- package/dist/{esm/api/resources/agent/resources/orderInformation/client/requests/OrderInformationConversationMessageReq.d.mts → cjs/api/resources/chrtGpt/client/requests/ChrtGptMessageReq.d.ts} +3 -1
- package/dist/cjs/api/resources/chrtGpt/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/chrtGpt/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/chrtGpt/index.d.ts +1 -0
- package/dist/cjs/api/resources/chrtGpt/index.js +17 -0
- package/dist/cjs/api/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/index.js +3 -1
- package/dist/cjs/api/resources/shipping/client/Client.d.ts +6 -0
- package/dist/cjs/api/resources/shipping/client/Client.js +28 -18
- package/dist/cjs/api/resources/shipping/resources/cargoOnFlightAirWaybills/client/Client.d.ts +154 -0
- package/dist/cjs/api/resources/shipping/resources/cargoOnFlightAirWaybills/client/Client.js +494 -0
- package/dist/cjs/api/resources/shipping/resources/cargoOnFlightAirWaybills/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/cargoOnFlightAirWaybills/client/index.js +17 -0
- package/dist/cjs/api/resources/shipping/resources/cargoOnFlightAirWaybills/client/requests/CargoOnFlightAirWaybillClientCreate1.d.ts +57 -0
- package/dist/cjs/api/resources/shipping/resources/cargoOnFlightAirWaybills/client/requests/CargoOnFlightAirWaybillClientUpdate1.d.ts +29 -0
- package/dist/cjs/api/resources/shipping/resources/cargoOnFlightAirWaybills/client/requests/CargoOnFlightAirWaybillsListV1Request.d.ts +27 -0
- package/dist/cjs/api/resources/shipping/resources/cargoOnFlightAirWaybills/client/requests/CargoOnFlightAirWaybillsMarkAcceptedReq.d.ts +13 -0
- package/dist/cjs/api/resources/shipping/resources/cargoOnFlightAirWaybills/client/requests/index.d.ts +4 -0
- package/dist/cjs/api/resources/shipping/resources/cargoOnFlightAirWaybills/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shipping/resources/cargoOnFlightAirWaybills/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/cargoOnFlightAirWaybills/index.js +17 -0
- package/dist/cjs/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/client/Client.d.ts +115 -0
- package/dist/cjs/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/client/Client.js +403 -0
- package/dist/cjs/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/client/index.js +17 -0
- package/dist/cjs/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/client/requests/CargoOnFlightHouseAirWaybillClientCreate1.d.ts +29 -0
- package/dist/cjs/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/client/requests/CargoOnFlightHouseAirWaybillClientCreate1.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/client/requests/CargoOnFlightHouseAirWaybillClientUpdate1.d.ts +19 -0
- package/dist/cjs/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/client/requests/CargoOnFlightHouseAirWaybillClientUpdate1.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/client/requests/CargoOnFlightHouseAirWaybillsListV1Request.d.ts +24 -0
- package/dist/cjs/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/client/requests/CargoOnFlightHouseAirWaybillsListV1Request.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/index.js +17 -0
- package/dist/cjs/api/resources/shipping/resources/index.d.ts +4 -0
- package/dist/cjs/api/resources/shipping/resources/index.js +5 -1
- package/dist/cjs/api/resources/shipping/resources/taskArtifacts/resources/s3Object/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/taskArtifacts/resources/s3Object/client/Client.js +1 -1
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.js +10 -1
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForProviderOperatorsV1Request.d.ts +3 -0
- package/dist/cjs/api/resources/utils/resources/dev/client/Client.d.ts +0 -30
- package/dist/cjs/api/resources/utils/resources/dev/client/Client.js +0 -128
- package/dist/cjs/api/resources/utils/resources/dev/client/requests/index.d.ts +0 -2
- package/dist/cjs/api/types/ArchivedModel.d.ts +5 -1
- package/dist/cjs/api/types/ArchivedModel.js +4 -0
- package/dist/cjs/api/types/CallerCredentialTypeEnum.d.ts +2 -1
- package/dist/cjs/api/types/CallerCredentialTypeEnum.js +1 -0
- package/dist/cjs/api/types/CargoAiAirWaybillMessage1.d.ts +24 -0
- package/dist/cjs/api/types/CargoAiAirWaybillMessage1.js +5 -0
- package/dist/cjs/api/types/CargoAiAirWaybillMessageSendStatusEnum1.d.ts +10 -0
- package/dist/cjs/api/types/CargoAiAirWaybillMessageSendStatusEnum1.js +12 -0
- package/dist/cjs/api/types/CargoAiAirWaybillMessageSortByEnum.d.ts +4 -0
- package/dist/cjs/api/types/CargoAiAirWaybillMessageSortByEnum.js +5 -0
- package/dist/cjs/api/types/CargoAiAirWaybillMessageWebhookEvent1.d.ts +12 -0
- package/dist/cjs/api/types/CargoAiAirWaybillMessageWebhookEvent1.js +5 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlAddress1.d.ts +13 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlAddress1.js +5 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlAgent1.d.ts +10 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlAgent1.js +5 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlChargesDeclaration1.d.ts +18 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlChargesDeclaration1.js +13 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlCity1.d.ts +7 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlCity1.js +5 -0
- package/dist/cjs/api/types/{GeographyRes.d.ts → CargoAiFwbAndFhlCode1.d.ts} +2 -2
- package/dist/cjs/api/types/CargoAiFwbAndFhlCode1.js +5 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlCountry1.d.ts +7 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlCountry1.js +5 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlDimension1.d.ts +19 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlDimension1.js +15 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlExecution1.d.ts +9 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlExecution1.js +5 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlHandling1.d.ts +9 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlHandling1.js +5 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlHouse1.d.ts +26 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlHouse1.js +13 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlHouseLocations1.d.ts +8 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlHouseLocations1.js +5 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlOci1.d.ts +8 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlOci1.js +5 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlOciSecurity1.d.ts +22 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlOciSecurity1.js +15 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlOtherCharge1.d.ts +21 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlOtherCharge1.js +17 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlParty1.d.ts +12 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlParty1.js +5 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlRate1.d.ts +19 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlRate1.js +5 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlRequest1.d.ts +24 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlRequest1.js +5 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlRouting1.d.ts +9 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlRouting1.js +5 -0
- package/dist/{esm/api/types/GeographyRes.d.mts → cjs/api/types/CargoAiFwbAndFhlUld1.d.ts} +2 -2
- package/dist/cjs/api/types/CargoAiFwbAndFhlUld1.js +5 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlWeightOrVolume1.d.ts +16 -0
- package/dist/cjs/api/types/CargoAiFwbAndFhlWeightOrVolume1.js +15 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybill1.d.ts +32 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybill1.js +5 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillCarriersExecution1.d.ts +11 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillCarriersExecution1.js +5 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillChargeCodeEnum1.d.ts +34 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillChargeCodeEnum1.js +33 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillChargesDeclaration1.d.ts +16 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillChargesDeclaration1.js +5 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillConsignmentSecurityDeclaration1.d.ts +18 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillConsignmentSecurityDeclaration1.js +5 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillDimension1.d.ts +12 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillDimension1.js +5 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillFwbMessage1.d.ts +17 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillFwbMessage1.js +5 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillListRes.d.ts +8 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillListRes.js +5 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillMessageResponseProvenanceEnum1.d.ts +8 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillMessageResponseProvenanceEnum1.js +10 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillMessageStatusEnum1.d.ts +9 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillMessageStatusEnum1.js +11 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillOtherCharge1.d.ts +13 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillOtherCharge1.js +5 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillOtherChargeEntitlementEnum1.d.ts +8 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillOtherChargeEntitlementEnum1.js +10 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillParty1.d.ts +20 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillParty1.js +5 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillPaymentConditionEnum1.d.ts +8 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillPaymentConditionEnum1.js +10 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillRateClassCodeEnum1.d.ts +22 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillRateClassCodeEnum1.js +21 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillRateLine1.d.ts +21 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillRateLine1.js +5 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillRegulatedEntityCategoryEnum1.d.ts +10 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillRegulatedEntityCategoryEnum1.js +12 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillScreeningExemptionEnum1.d.ts +13 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillScreeningExemptionEnum1.js +15 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillScreeningMethodEnum1.d.ts +17 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillScreeningMethodEnum1.js +19 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillSecurityStatusEnum1.d.ts +10 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillSecurityStatusEnum1.js +12 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillSortByEnum.d.ts +8 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillSortByEnum.js +10 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillsMarkAcceptedRes.d.ts +8 -0
- package/dist/cjs/api/types/CargoOnFlightAirWaybillsMarkAcceptedRes.js +5 -0
- package/dist/cjs/api/types/CargoOnFlightHouseAirWaybill1.d.ts +26 -0
- package/dist/cjs/api/types/CargoOnFlightHouseAirWaybill1.js +5 -0
- package/dist/cjs/api/types/CargoOnFlightHouseAirWaybillFhlMessage1.d.ts +17 -0
- package/dist/cjs/api/types/CargoOnFlightHouseAirWaybillFhlMessage1.js +5 -0
- package/dist/cjs/api/types/CargoOnFlightHouseAirWaybillListRes.d.ts +8 -0
- package/dist/cjs/api/types/CargoOnFlightHouseAirWaybillListRes.js +5 -0
- package/dist/cjs/api/types/CargoOnFlightHouseAirWaybillSortByEnum.d.ts +8 -0
- package/dist/cjs/api/types/CargoOnFlightHouseAirWaybillSortByEnum.js +10 -0
- package/dist/cjs/api/types/CargoOnFlightIntegrationsCargoAiAirWaybillMessageListItem.d.ts +8 -0
- package/dist/cjs/api/types/CargoOnFlightIntegrationsCargoAiAirWaybillMessageListItem.js +5 -0
- package/dist/cjs/api/types/CargoOnFlightIntegrationsCargoAiAirWaybillMessageListRes.d.ts +8 -0
- package/dist/cjs/api/types/CargoOnFlightIntegrationsCargoAiAirWaybillMessageListRes.js +5 -0
- package/dist/cjs/api/types/CargoOnFlightIntegrationsCargoAiAirWaybillsWebhookRes.d.ts +6 -0
- package/dist/cjs/api/types/CargoOnFlightIntegrationsCargoAiAirWaybillsWebhookRes.js +5 -0
- package/dist/cjs/api/types/CargoOnFlightIntegrationsCargoAiSimulateAirlineResponseHouse.d.ts +8 -0
- package/dist/cjs/api/types/CargoOnFlightIntegrationsCargoAiSimulateAirlineResponseHouse.js +5 -0
- package/dist/cjs/api/types/CargoOnFlightIntegrationsCargoAiSimulateAirlineResponseRes.d.ts +8 -0
- package/dist/cjs/api/types/CargoOnFlightIntegrationsCargoAiSimulateAirlineResponseRes.js +5 -0
- package/dist/cjs/api/types/CargoOnFlightIntegrationsCargoAiSimulateAirlineResponseStatusEnum.d.ts +8 -0
- package/dist/cjs/api/types/CargoOnFlightIntegrationsCargoAiSimulateAirlineResponseStatusEnum.js +10 -0
- package/dist/{esm/api/types/OrderInformationConversationRes.d.mts → cjs/api/types/ChrtGptMessageRes.d.ts} +1 -1
- package/dist/cjs/api/types/ChrtGptMessageRes.js +5 -0
- package/dist/cjs/api/types/LiveKitHelloWorldStartRes.d.ts +8 -0
- package/dist/cjs/api/types/LiveKitHelloWorldStartRes.js +5 -0
- package/dist/cjs/api/types/Model.d.ts +7 -4
- package/dist/cjs/api/types/Model.js +6 -3
- package/dist/cjs/api/types/OrderEventActionEnum1.d.ts +10 -1
- package/dist/cjs/api/types/OrderEventActionEnum1.js +9 -0
- package/dist/cjs/api/types/OrderEventEntity1.d.ts +2 -0
- package/dist/cjs/api/types/index.d.ts +58 -3
- package/dist/cjs/api/types/index.js +58 -3
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.d.mts +3 -0
- package/dist/esm/Client.mjs +7 -2
- package/dist/esm/api/resources/agent/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/agent/client/Client.mjs +3 -3
- package/dist/esm/api/resources/agent/resources/index.d.mts +1 -2
- package/dist/esm/api/resources/agent/resources/index.mjs +1 -2
- package/dist/esm/api/resources/agent/resources/livekit/client/Client.d.mts +23 -0
- package/dist/esm/api/resources/agent/resources/livekit/client/Client.mjs +13 -0
- package/dist/esm/api/resources/agent/resources/livekit/client/index.d.mts +1 -0
- package/dist/esm/api/resources/agent/resources/livekit/client/index.mjs +1 -0
- package/dist/esm/api/resources/agent/resources/livekit/index.d.mts +2 -0
- package/dist/esm/api/resources/agent/resources/livekit/index.mjs +2 -0
- package/dist/esm/api/resources/agent/resources/livekit/resources/helloWorld/client/Client.d.mts +44 -0
- package/dist/esm/api/resources/agent/resources/livekit/resources/helloWorld/client/Client.mjs +81 -0
- package/dist/esm/api/resources/agent/resources/livekit/resources/helloWorld/client/index.d.mts +1 -0
- package/dist/esm/api/resources/agent/resources/livekit/resources/helloWorld/client/index.mjs +1 -0
- package/dist/esm/api/resources/agent/resources/livekit/resources/index.d.mts +1 -0
- package/dist/esm/api/resources/agent/resources/livekit/resources/index.mjs +1 -0
- package/dist/esm/api/resources/cargoOnFlightIntegrations/resources/cargoai/client/Client.d.mts +51 -0
- package/dist/esm/api/resources/cargoOnFlightIntegrations/resources/cargoai/client/Client.mjs +222 -0
- package/dist/esm/api/resources/cargoOnFlightIntegrations/resources/cargoai/client/requests/CargoOnFlightIntegrationsCargoAiSendAirWaybillReq.d.mts +13 -0
- package/dist/esm/api/resources/cargoOnFlightIntegrations/resources/cargoai/client/requests/CargoOnFlightIntegrationsCargoAiSimulateAirlineResponseReq.d.mts +13 -0
- package/dist/esm/api/resources/cargoOnFlightIntegrations/resources/cargoai/client/requests/CargoaiListAirWaybillMessagesV1Request.d.mts +30 -0
- package/dist/esm/api/resources/cargoOnFlightIntegrations/resources/cargoai/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/chrtGpt/client/Client.d.mts +49 -0
- package/dist/esm/api/resources/chrtGpt/client/Client.mjs +95 -0
- package/dist/{cjs/api/resources/agent/resources/orderInformation/client/requests/OrderInformationConversationStartReq.d.ts → esm/api/resources/chrtGpt/client/requests/ChrtGptMessageReq.d.mts} +3 -2
- package/dist/esm/api/resources/chrtGpt/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/chrtGpt/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/chrtGpt/index.d.mts +1 -0
- package/dist/esm/api/resources/chrtGpt/index.mjs +1 -0
- package/dist/esm/api/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/index.mjs +2 -0
- package/dist/esm/api/resources/shipping/client/Client.d.mts +6 -0
- package/dist/esm/api/resources/shipping/client/Client.mjs +10 -0
- package/dist/esm/api/resources/shipping/resources/cargoOnFlightAirWaybills/client/Client.d.mts +154 -0
- package/dist/esm/api/resources/shipping/resources/cargoOnFlightAirWaybills/client/Client.mjs +457 -0
- package/dist/esm/api/resources/shipping/resources/cargoOnFlightAirWaybills/client/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/cargoOnFlightAirWaybills/client/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/cargoOnFlightAirWaybills/client/requests/CargoOnFlightAirWaybillClientCreate1.d.mts +57 -0
- package/dist/esm/api/resources/shipping/resources/cargoOnFlightAirWaybills/client/requests/CargoOnFlightAirWaybillClientUpdate1.d.mts +29 -0
- package/dist/esm/api/resources/shipping/resources/cargoOnFlightAirWaybills/client/requests/CargoOnFlightAirWaybillsListV1Request.d.mts +27 -0
- package/dist/esm/api/resources/shipping/resources/cargoOnFlightAirWaybills/client/requests/CargoOnFlightAirWaybillsMarkAcceptedReq.d.mts +13 -0
- package/dist/esm/api/resources/shipping/resources/cargoOnFlightAirWaybills/client/requests/index.d.mts +4 -0
- package/dist/esm/api/resources/shipping/resources/cargoOnFlightAirWaybills/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/cargoOnFlightAirWaybills/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/cargoOnFlightAirWaybills/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/client/Client.d.mts +115 -0
- package/dist/esm/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/client/Client.mjs +366 -0
- package/dist/esm/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/client/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/client/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/client/requests/CargoOnFlightHouseAirWaybillClientCreate1.d.mts +29 -0
- package/dist/esm/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/client/requests/CargoOnFlightHouseAirWaybillClientCreate1.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/client/requests/CargoOnFlightHouseAirWaybillClientUpdate1.d.mts +19 -0
- package/dist/esm/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/client/requests/CargoOnFlightHouseAirWaybillClientUpdate1.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/client/requests/CargoOnFlightHouseAirWaybillsListV1Request.d.mts +24 -0
- package/dist/esm/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/client/requests/CargoOnFlightHouseAirWaybillsListV1Request.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/index.d.mts +4 -0
- package/dist/esm/api/resources/shipping/resources/index.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/s3Object/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/s3Object/client/Client.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.mjs +10 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForProviderOperatorsV1Request.d.mts +3 -0
- package/dist/esm/api/resources/utils/resources/dev/client/Client.d.mts +0 -30
- package/dist/esm/api/resources/utils/resources/dev/client/Client.mjs +0 -128
- package/dist/esm/api/resources/utils/resources/dev/client/requests/index.d.mts +0 -2
- package/dist/esm/api/types/ArchivedModel.d.mts +5 -1
- package/dist/esm/api/types/ArchivedModel.mjs +4 -0
- package/dist/esm/api/types/CallerCredentialTypeEnum.d.mts +2 -1
- package/dist/esm/api/types/CallerCredentialTypeEnum.mjs +1 -0
- package/dist/esm/api/types/CargoAiAirWaybillMessage1.d.mts +24 -0
- package/dist/esm/api/types/CargoAiAirWaybillMessage1.mjs +4 -0
- package/dist/esm/api/types/CargoAiAirWaybillMessageSendStatusEnum1.d.mts +10 -0
- package/dist/esm/api/types/CargoAiAirWaybillMessageSendStatusEnum1.mjs +9 -0
- package/dist/esm/api/types/CargoAiAirWaybillMessageSortByEnum.d.mts +4 -0
- package/dist/esm/api/types/CargoAiAirWaybillMessageSortByEnum.mjs +4 -0
- package/dist/esm/api/types/CargoAiAirWaybillMessageWebhookEvent1.d.mts +12 -0
- package/dist/esm/api/types/CargoAiAirWaybillMessageWebhookEvent1.mjs +4 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlAddress1.d.mts +13 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlAddress1.mjs +4 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlAgent1.d.mts +10 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlAgent1.mjs +4 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlChargesDeclaration1.d.mts +18 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlChargesDeclaration1.mjs +10 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlCity1.d.mts +7 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlCity1.mjs +4 -0
- package/dist/{cjs/api/types/PingOpenAiRes.d.ts → esm/api/types/CargoAiFwbAndFhlCode1.d.mts} +2 -2
- package/dist/esm/api/types/CargoAiFwbAndFhlCode1.mjs +4 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlCountry1.d.mts +7 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlCountry1.mjs +4 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlDimension1.d.mts +19 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlDimension1.mjs +12 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlExecution1.d.mts +9 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlExecution1.mjs +4 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlHandling1.d.mts +9 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlHandling1.mjs +4 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlHouse1.d.mts +26 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlHouse1.mjs +10 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlHouseLocations1.d.mts +8 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlHouseLocations1.mjs +4 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlOci1.d.mts +8 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlOci1.mjs +4 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlOciSecurity1.d.mts +22 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlOciSecurity1.mjs +12 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlOtherCharge1.d.mts +21 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlOtherCharge1.mjs +14 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlParty1.d.mts +12 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlParty1.mjs +4 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlRate1.d.mts +19 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlRate1.mjs +4 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlRequest1.d.mts +24 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlRequest1.mjs +4 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlRouting1.d.mts +9 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlRouting1.mjs +4 -0
- package/dist/esm/api/types/{PingOpenAiRes.d.mts → CargoAiFwbAndFhlUld1.d.mts} +2 -2
- package/dist/esm/api/types/CargoAiFwbAndFhlUld1.mjs +4 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlWeightOrVolume1.d.mts +16 -0
- package/dist/esm/api/types/CargoAiFwbAndFhlWeightOrVolume1.mjs +12 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybill1.d.mts +32 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybill1.mjs +4 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillCarriersExecution1.d.mts +11 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillCarriersExecution1.mjs +4 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillChargeCodeEnum1.d.mts +34 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillChargeCodeEnum1.mjs +30 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillChargesDeclaration1.d.mts +16 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillChargesDeclaration1.mjs +4 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillConsignmentSecurityDeclaration1.d.mts +18 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillConsignmentSecurityDeclaration1.mjs +4 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillDimension1.d.mts +12 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillDimension1.mjs +4 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillFwbMessage1.d.mts +17 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillFwbMessage1.mjs +4 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillListRes.d.mts +8 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillListRes.mjs +4 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillMessageResponseProvenanceEnum1.d.mts +8 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillMessageResponseProvenanceEnum1.mjs +7 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillMessageStatusEnum1.d.mts +9 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillMessageStatusEnum1.mjs +8 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillOtherCharge1.d.mts +13 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillOtherCharge1.mjs +4 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillOtherChargeEntitlementEnum1.d.mts +8 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillOtherChargeEntitlementEnum1.mjs +7 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillParty1.d.mts +20 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillParty1.mjs +4 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillPaymentConditionEnum1.d.mts +8 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillPaymentConditionEnum1.mjs +7 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillRateClassCodeEnum1.d.mts +22 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillRateClassCodeEnum1.mjs +18 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillRateLine1.d.mts +21 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillRateLine1.mjs +4 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillRegulatedEntityCategoryEnum1.d.mts +10 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillRegulatedEntityCategoryEnum1.mjs +9 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillScreeningExemptionEnum1.d.mts +13 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillScreeningExemptionEnum1.mjs +12 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillScreeningMethodEnum1.d.mts +17 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillScreeningMethodEnum1.mjs +16 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillSecurityStatusEnum1.d.mts +10 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillSecurityStatusEnum1.mjs +9 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillSortByEnum.d.mts +8 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillSortByEnum.mjs +7 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillsMarkAcceptedRes.d.mts +8 -0
- package/dist/esm/api/types/CargoOnFlightAirWaybillsMarkAcceptedRes.mjs +4 -0
- package/dist/esm/api/types/CargoOnFlightHouseAirWaybill1.d.mts +26 -0
- package/dist/esm/api/types/CargoOnFlightHouseAirWaybill1.mjs +4 -0
- package/dist/esm/api/types/CargoOnFlightHouseAirWaybillFhlMessage1.d.mts +17 -0
- package/dist/esm/api/types/CargoOnFlightHouseAirWaybillFhlMessage1.mjs +4 -0
- package/dist/esm/api/types/CargoOnFlightHouseAirWaybillListRes.d.mts +8 -0
- package/dist/esm/api/types/CargoOnFlightHouseAirWaybillListRes.mjs +4 -0
- package/dist/esm/api/types/CargoOnFlightHouseAirWaybillSortByEnum.d.mts +8 -0
- package/dist/esm/api/types/CargoOnFlightHouseAirWaybillSortByEnum.mjs +7 -0
- package/dist/esm/api/types/CargoOnFlightIntegrationsCargoAiAirWaybillMessageListItem.d.mts +8 -0
- package/dist/esm/api/types/CargoOnFlightIntegrationsCargoAiAirWaybillMessageListItem.mjs +4 -0
- package/dist/esm/api/types/CargoOnFlightIntegrationsCargoAiAirWaybillMessageListRes.d.mts +8 -0
- package/dist/esm/api/types/CargoOnFlightIntegrationsCargoAiAirWaybillMessageListRes.mjs +4 -0
- package/dist/esm/api/types/CargoOnFlightIntegrationsCargoAiAirWaybillsWebhookRes.d.mts +6 -0
- package/dist/esm/api/types/CargoOnFlightIntegrationsCargoAiAirWaybillsWebhookRes.mjs +4 -0
- package/dist/esm/api/types/CargoOnFlightIntegrationsCargoAiSimulateAirlineResponseHouse.d.mts +8 -0
- package/dist/esm/api/types/CargoOnFlightIntegrationsCargoAiSimulateAirlineResponseHouse.mjs +4 -0
- package/dist/esm/api/types/CargoOnFlightIntegrationsCargoAiSimulateAirlineResponseRes.d.mts +8 -0
- package/dist/esm/api/types/CargoOnFlightIntegrationsCargoAiSimulateAirlineResponseRes.mjs +4 -0
- package/dist/esm/api/types/CargoOnFlightIntegrationsCargoAiSimulateAirlineResponseStatusEnum.d.mts +8 -0
- package/dist/esm/api/types/CargoOnFlightIntegrationsCargoAiSimulateAirlineResponseStatusEnum.mjs +7 -0
- package/dist/{cjs/api/types/OrderInformationConversationRes.d.ts → esm/api/types/ChrtGptMessageRes.d.mts} +1 -1
- package/dist/esm/api/types/ChrtGptMessageRes.mjs +4 -0
- package/dist/esm/api/types/LiveKitHelloWorldStartRes.d.mts +8 -0
- package/dist/esm/api/types/LiveKitHelloWorldStartRes.mjs +4 -0
- package/dist/esm/api/types/Model.d.mts +7 -4
- package/dist/esm/api/types/Model.mjs +6 -3
- package/dist/esm/api/types/OrderEventActionEnum1.d.mts +10 -1
- package/dist/esm/api/types/OrderEventActionEnum1.mjs +9 -0
- package/dist/esm/api/types/OrderEventEntity1.d.mts +2 -0
- package/dist/esm/api/types/index.d.mts +58 -3
- package/dist/esm/api/types/index.mjs +58 -3
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +1445 -668
- package/dist/cjs/api/resources/agent/resources/orderInformation/client/Client.d.ts +0 -79
- package/dist/cjs/api/resources/agent/resources/orderInformation/client/Client.js +0 -260
- package/dist/cjs/api/resources/agent/resources/orderInformation/client/requests/OrderInformationConversationClientUpdate1.d.ts +0 -11
- package/dist/cjs/api/resources/agent/resources/orderInformation/client/requests/OrderInformationConversationMessageReq.d.ts +0 -12
- package/dist/cjs/api/resources/agent/resources/orderInformation/client/requests/index.d.ts +0 -3
- package/dist/cjs/api/resources/utils/resources/dev/client/requests/GeographyReq.d.ts +0 -12
- package/dist/cjs/api/resources/utils/resources/dev/client/requests/PingOpenAiReq.d.ts +0 -12
- package/dist/esm/api/resources/agent/resources/orderInformation/client/Client.d.mts +0 -79
- package/dist/esm/api/resources/agent/resources/orderInformation/client/Client.mjs +0 -223
- package/dist/esm/api/resources/agent/resources/orderInformation/client/requests/OrderInformationConversationClientUpdate1.d.mts +0 -11
- package/dist/esm/api/resources/agent/resources/orderInformation/client/requests/OrderInformationConversationStartReq.d.mts +0 -13
- package/dist/esm/api/resources/agent/resources/orderInformation/client/requests/index.d.mts +0 -3
- package/dist/esm/api/resources/utils/resources/dev/client/requests/GeographyReq.d.mts +0 -12
- package/dist/esm/api/resources/utils/resources/dev/client/requests/PingOpenAiReq.d.mts +0 -12
- /package/dist/{esm/api/resources/agent/resources/orderInformation/client/requests/index.mjs → cjs/api/resources/agent/resources/livekit/client/index.d.ts} +0 -0
- /package/dist/cjs/api/resources/agent/resources/{orderInformation/client/requests → livekit/client}/index.js +0 -0
- /package/dist/cjs/api/resources/agent/resources/{orderInformation → livekit/resources/helloWorld}/index.d.ts +0 -0
- /package/dist/cjs/api/resources/agent/resources/{orderInformation → livekit/resources/helloWorld}/index.js +0 -0
- /package/dist/cjs/api/resources/{agent/resources/orderInformation/client/requests/OrderInformationConversationClientUpdate1.js → cargoOnFlightIntegrations/resources/cargoai/client/requests/CargoOnFlightIntegrationsCargoAiSendAirWaybillReq.js} +0 -0
- /package/dist/cjs/api/resources/{agent/resources/orderInformation/client/requests/OrderInformationConversationMessageReq.js → cargoOnFlightIntegrations/resources/cargoai/client/requests/CargoOnFlightIntegrationsCargoAiSimulateAirlineResponseReq.js} +0 -0
- /package/dist/cjs/api/resources/{agent/resources/orderInformation/client/requests/OrderInformationConversationStartReq.js → cargoOnFlightIntegrations/resources/cargoai/client/requests/CargoaiListAirWaybillMessagesV1Request.js} +0 -0
- /package/dist/cjs/api/resources/{agent/resources/orderInformation → chrtGpt}/client/index.d.ts +0 -0
- /package/dist/cjs/api/resources/{agent/resources/orderInformation → chrtGpt}/client/index.js +0 -0
- /package/dist/cjs/api/resources/{utils/resources/dev/client/requests/GeographyReq.js → chrtGpt/client/requests/ChrtGptMessageReq.js} +0 -0
- /package/dist/cjs/api/resources/{utils/resources/dev/client/requests/PingOpenAiReq.js → shipping/resources/cargoOnFlightAirWaybills/client/requests/CargoOnFlightAirWaybillClientCreate1.js} +0 -0
- /package/dist/cjs/api/{types/GeographyRes.js → resources/shipping/resources/cargoOnFlightAirWaybills/client/requests/CargoOnFlightAirWaybillClientUpdate1.js} +0 -0
- /package/dist/cjs/api/{types/OrderInformationConversationRes.js → resources/shipping/resources/cargoOnFlightAirWaybills/client/requests/CargoOnFlightAirWaybillsListV1Request.js} +0 -0
- /package/dist/cjs/api/{types/PingOpenAiRes.js → resources/shipping/resources/cargoOnFlightAirWaybills/client/requests/CargoOnFlightAirWaybillsMarkAcceptedReq.js} +0 -0
- /package/dist/esm/api/resources/agent/resources/{orderInformation → livekit/resources/helloWorld}/index.d.mts +0 -0
- /package/dist/esm/api/resources/agent/resources/{orderInformation → livekit/resources/helloWorld}/index.mjs +0 -0
- /package/dist/esm/api/resources/{agent/resources/orderInformation/client/requests/OrderInformationConversationClientUpdate1.mjs → cargoOnFlightIntegrations/resources/cargoai/client/requests/CargoOnFlightIntegrationsCargoAiSendAirWaybillReq.mjs} +0 -0
- /package/dist/esm/api/resources/{agent/resources/orderInformation/client/requests/OrderInformationConversationMessageReq.mjs → cargoOnFlightIntegrations/resources/cargoai/client/requests/CargoOnFlightIntegrationsCargoAiSimulateAirlineResponseReq.mjs} +0 -0
- /package/dist/esm/api/resources/{agent/resources/orderInformation/client/requests/OrderInformationConversationStartReq.mjs → cargoOnFlightIntegrations/resources/cargoai/client/requests/CargoaiListAirWaybillMessagesV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/{agent/resources/orderInformation → chrtGpt}/client/index.d.mts +0 -0
- /package/dist/esm/api/resources/{agent/resources/orderInformation → chrtGpt}/client/index.mjs +0 -0
- /package/dist/esm/api/resources/{utils/resources/dev/client/requests/GeographyReq.mjs → chrtGpt/client/requests/ChrtGptMessageReq.mjs} +0 -0
- /package/dist/esm/api/resources/{utils/resources/dev/client/requests/PingOpenAiReq.mjs → shipping/resources/cargoOnFlightAirWaybills/client/requests/CargoOnFlightAirWaybillClientCreate1.mjs} +0 -0
- /package/dist/esm/api/{types/GeographyRes.mjs → resources/shipping/resources/cargoOnFlightAirWaybills/client/requests/CargoOnFlightAirWaybillClientUpdate1.mjs} +0 -0
- /package/dist/esm/api/{types/OrderInformationConversationRes.mjs → resources/shipping/resources/cargoOnFlightAirWaybills/client/requests/CargoOnFlightAirWaybillsListV1Request.mjs} +0 -0
- /package/dist/esm/api/{types/PingOpenAiRes.mjs → resources/shipping/resources/cargoOnFlightAirWaybills/client/requests/CargoOnFlightAirWaybillsMarkAcceptedReq.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -1,5 +1,72 @@
|
|
|
1
1
|
# Reference
|
|
2
2
|
|
|
3
|
+
## ChrtGpt
|
|
4
|
+
|
|
5
|
+
<details><summary><code>client.chrtGpt.<a href="/src/api/resources/chrtGpt/client/Client.ts">messageV1</a>({ ...params }) -> Chrt.ChrtGptMessageRes</code></summary>
|
|
6
|
+
<dl>
|
|
7
|
+
<dd>
|
|
8
|
+
|
|
9
|
+
#### 📝 Description
|
|
10
|
+
|
|
11
|
+
<dl>
|
|
12
|
+
<dd>
|
|
13
|
+
|
|
14
|
+
<dl>
|
|
15
|
+
<dd>
|
|
16
|
+
|
|
17
|
+
Sends a message to ChrtGPT and returns its reply, starting a new conversation when no conversation_id is given. | authz: allowed_org_types=[shipper, provider], min_org_role=operator | (ChrtGPTMessageReq) -> (ChrtGPTMessageRes)
|
|
18
|
+
|
|
19
|
+
</dd>
|
|
20
|
+
</dl>
|
|
21
|
+
</dd>
|
|
22
|
+
</dl>
|
|
23
|
+
|
|
24
|
+
#### 🔌 Usage
|
|
25
|
+
|
|
26
|
+
<dl>
|
|
27
|
+
<dd>
|
|
28
|
+
|
|
29
|
+
<dl>
|
|
30
|
+
<dd>
|
|
31
|
+
|
|
32
|
+
```typescript
|
|
33
|
+
await client.chrtGpt.messageV1({
|
|
34
|
+
message: "message",
|
|
35
|
+
});
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
</dd>
|
|
39
|
+
</dl>
|
|
40
|
+
</dd>
|
|
41
|
+
</dl>
|
|
42
|
+
|
|
43
|
+
#### ⚙️ Parameters
|
|
44
|
+
|
|
45
|
+
<dl>
|
|
46
|
+
<dd>
|
|
47
|
+
|
|
48
|
+
<dl>
|
|
49
|
+
<dd>
|
|
50
|
+
|
|
51
|
+
**request:** `Chrt.ChrtGptMessageReq`
|
|
52
|
+
|
|
53
|
+
</dd>
|
|
54
|
+
</dl>
|
|
55
|
+
|
|
56
|
+
<dl>
|
|
57
|
+
<dd>
|
|
58
|
+
|
|
59
|
+
**requestOptions:** `ChrtGpt.RequestOptions`
|
|
60
|
+
|
|
61
|
+
</dd>
|
|
62
|
+
</dl>
|
|
63
|
+
</dd>
|
|
64
|
+
</dl>
|
|
65
|
+
|
|
66
|
+
</dd>
|
|
67
|
+
</dl>
|
|
68
|
+
</details>
|
|
69
|
+
|
|
3
70
|
## Flights
|
|
4
71
|
|
|
5
72
|
<details><summary><code>client.flights.<a href="/src/api/resources/flights/client/Client.ts">searchConnectionsV1</a>({ ...params }) -> Chrt.FlightConnectionsSearchRes</code></summary>
|
|
@@ -453,147 +520,9 @@ await client.utils.getTimezoneV1({
|
|
|
453
520
|
</dl>
|
|
454
521
|
</details>
|
|
455
522
|
|
|
456
|
-
## Agent
|
|
457
|
-
|
|
458
|
-
<details><summary><code>client.agent.orderInformation.<a href="/src/api/resources/agent/resources/orderInformation/client/Client.ts">messageV1</a>(conversationId, { ...params }) -> Chrt.OrderInformationConversationRes</code></summary>
|
|
459
|
-
<dl>
|
|
460
|
-
<dd>
|
|
461
|
-
|
|
462
|
-
#### 📝 Description
|
|
463
|
-
|
|
464
|
-
<dl>
|
|
465
|
-
<dd>
|
|
466
|
-
|
|
467
|
-
<dl>
|
|
468
|
-
<dd>
|
|
469
|
-
|
|
470
|
-
Adds a message to an existing order-information conversation for its owner. | authz: allowed_org_types=[shipper, provider], min_org_role=operator | (OrderInformationConversationMessageReq) -> (OrderInformationConversationRes)
|
|
471
|
-
|
|
472
|
-
</dd>
|
|
473
|
-
</dl>
|
|
474
|
-
</dd>
|
|
475
|
-
</dl>
|
|
476
|
-
|
|
477
|
-
#### 🔌 Usage
|
|
478
|
-
|
|
479
|
-
<dl>
|
|
480
|
-
<dd>
|
|
481
|
-
|
|
482
|
-
<dl>
|
|
483
|
-
<dd>
|
|
484
|
-
|
|
485
|
-
```typescript
|
|
486
|
-
await client.agent.orderInformation.messageV1("conversation_id", {
|
|
487
|
-
message: "message",
|
|
488
|
-
});
|
|
489
|
-
```
|
|
490
|
-
|
|
491
|
-
</dd>
|
|
492
|
-
</dl>
|
|
493
|
-
</dd>
|
|
494
|
-
</dl>
|
|
495
|
-
|
|
496
|
-
#### ⚙️ Parameters
|
|
497
|
-
|
|
498
|
-
<dl>
|
|
499
|
-
<dd>
|
|
500
|
-
|
|
501
|
-
<dl>
|
|
502
|
-
<dd>
|
|
503
|
-
|
|
504
|
-
**conversationId:** `string`
|
|
505
|
-
|
|
506
|
-
</dd>
|
|
507
|
-
</dl>
|
|
508
|
-
|
|
509
|
-
<dl>
|
|
510
|
-
<dd>
|
|
511
|
-
|
|
512
|
-
**request:** `Chrt.agent.OrderInformationConversationMessageReq`
|
|
513
|
-
|
|
514
|
-
</dd>
|
|
515
|
-
</dl>
|
|
516
|
-
|
|
517
|
-
<dl>
|
|
518
|
-
<dd>
|
|
519
|
-
|
|
520
|
-
**requestOptions:** `OrderInformation.RequestOptions`
|
|
521
|
-
|
|
522
|
-
</dd>
|
|
523
|
-
</dl>
|
|
524
|
-
</dd>
|
|
525
|
-
</dl>
|
|
526
|
-
|
|
527
|
-
</dd>
|
|
528
|
-
</dl>
|
|
529
|
-
</details>
|
|
530
|
-
|
|
531
|
-
<details><summary><code>client.agent.orderInformation.<a href="/src/api/resources/agent/resources/orderInformation/client/Client.ts">startV1</a>({ ...params }) -> Chrt.OrderInformationConversationRes</code></summary>
|
|
532
|
-
<dl>
|
|
533
|
-
<dd>
|
|
534
|
-
|
|
535
|
-
#### 📝 Description
|
|
536
|
-
|
|
537
|
-
<dl>
|
|
538
|
-
<dd>
|
|
539
|
-
|
|
540
|
-
<dl>
|
|
541
|
-
<dd>
|
|
542
|
-
|
|
543
|
-
Starts an order-information conversation for the authenticated operator. | authz: allowed_org_types=[shipper, provider], min_org_role=operator | (OrderInformationConversationStartReq) -> (OrderInformationConversationRes)
|
|
544
|
-
|
|
545
|
-
</dd>
|
|
546
|
-
</dl>
|
|
547
|
-
</dd>
|
|
548
|
-
</dl>
|
|
549
|
-
|
|
550
|
-
#### 🔌 Usage
|
|
551
|
-
|
|
552
|
-
<dl>
|
|
553
|
-
<dd>
|
|
554
|
-
|
|
555
|
-
<dl>
|
|
556
|
-
<dd>
|
|
557
|
-
|
|
558
|
-
```typescript
|
|
559
|
-
await client.agent.orderInformation.startV1({
|
|
560
|
-
message: "message",
|
|
561
|
-
});
|
|
562
|
-
```
|
|
563
|
-
|
|
564
|
-
</dd>
|
|
565
|
-
</dl>
|
|
566
|
-
</dd>
|
|
567
|
-
</dl>
|
|
568
|
-
|
|
569
|
-
#### ⚙️ Parameters
|
|
570
|
-
|
|
571
|
-
<dl>
|
|
572
|
-
<dd>
|
|
573
|
-
|
|
574
|
-
<dl>
|
|
575
|
-
<dd>
|
|
576
|
-
|
|
577
|
-
**request:** `Chrt.agent.OrderInformationConversationStartReq`
|
|
578
|
-
|
|
579
|
-
</dd>
|
|
580
|
-
</dl>
|
|
581
|
-
|
|
582
|
-
<dl>
|
|
583
|
-
<dd>
|
|
584
|
-
|
|
585
|
-
**requestOptions:** `OrderInformation.RequestOptions`
|
|
586
|
-
|
|
587
|
-
</dd>
|
|
588
|
-
</dl>
|
|
589
|
-
</dd>
|
|
590
|
-
</dl>
|
|
591
|
-
|
|
592
|
-
</dd>
|
|
593
|
-
</dl>
|
|
594
|
-
</details>
|
|
523
|
+
## Agent Livekit HelloWorld
|
|
595
524
|
|
|
596
|
-
<details><summary><code>client.agent.
|
|
525
|
+
<details><summary><code>client.agent.livekit.helloWorld.<a href="/src/api/resources/agent/resources/livekit/resources/helloWorld/client/Client.ts">startV1</a>() -> Chrt.LiveKitHelloWorldStartRes</code></summary>
|
|
597
526
|
<dl>
|
|
598
527
|
<dd>
|
|
599
528
|
|
|
@@ -605,7 +534,7 @@ await client.agent.orderInformation.startV1({
|
|
|
605
534
|
<dl>
|
|
606
535
|
<dd>
|
|
607
536
|
|
|
608
|
-
|
|
537
|
+
Creates a LiveKit room token that also dispatches the hello-world voice agent into the room. | () -> (LiveKitHelloWorldStartRes)
|
|
609
538
|
|
|
610
539
|
</dd>
|
|
611
540
|
</dl>
|
|
@@ -621,7 +550,7 @@ Updates an order-information conversation's title for its owner. | authz: allowe
|
|
|
621
550
|
<dd>
|
|
622
551
|
|
|
623
552
|
```typescript
|
|
624
|
-
await client.agent.
|
|
553
|
+
await client.agent.livekit.helloWorld.startV1();
|
|
625
554
|
```
|
|
626
555
|
|
|
627
556
|
</dd>
|
|
@@ -637,23 +566,7 @@ await client.agent.orderInformation.updateV1("conversation_id");
|
|
|
637
566
|
<dl>
|
|
638
567
|
<dd>
|
|
639
568
|
|
|
640
|
-
**
|
|
641
|
-
|
|
642
|
-
</dd>
|
|
643
|
-
</dl>
|
|
644
|
-
|
|
645
|
-
<dl>
|
|
646
|
-
<dd>
|
|
647
|
-
|
|
648
|
-
**request:** `Chrt.agent.OrderInformationConversationClientUpdate1`
|
|
649
|
-
|
|
650
|
-
</dd>
|
|
651
|
-
</dl>
|
|
652
|
-
|
|
653
|
-
<dl>
|
|
654
|
-
<dd>
|
|
655
|
-
|
|
656
|
-
**requestOptions:** `OrderInformation.RequestOptions`
|
|
569
|
+
**requestOptions:** `HelloWorld.RequestOptions`
|
|
657
570
|
|
|
658
571
|
</dd>
|
|
659
572
|
</dl>
|
|
@@ -4719,7 +4632,7 @@ await client.billingNew.taxConfigurations.updateV1("tax_configuration_id");
|
|
|
4719
4632
|
|
|
4720
4633
|
## CargoOnFlightIntegrations Cargoai
|
|
4721
4634
|
|
|
4722
|
-
<details><summary><code>client.cargoOnFlightIntegrations.cargoai.<a href="/src/api/resources/cargoOnFlightIntegrations/resources/cargoai/client/Client.ts">
|
|
4635
|
+
<details><summary><code>client.cargoOnFlightIntegrations.cargoai.<a href="/src/api/resources/cargoOnFlightIntegrations/resources/cargoai/client/Client.ts">listAirWaybillMessagesV1</a>({ ...params }) -> Chrt.CargoOnFlightIntegrationsCargoAiAirWaybillMessageListRes</code></summary>
|
|
4723
4636
|
<dl>
|
|
4724
4637
|
<dd>
|
|
4725
4638
|
|
|
@@ -4731,7 +4644,7 @@ await client.billingNew.taxConfigurations.updateV1("tax_configuration_id");
|
|
|
4731
4644
|
<dl>
|
|
4732
4645
|
<dd>
|
|
4733
4646
|
|
|
4734
|
-
|
|
4647
|
+
Lists what was sent to CargoAi for an air waybill and every airline answer received for each send. | authz_personas=[task_group_coordinator_operators] | () -> (CargoOnFlightIntegrationsCargoAiAirWaybillMessageListRes)
|
|
4735
4648
|
|
|
4736
4649
|
</dd>
|
|
4737
4650
|
</dl>
|
|
@@ -4747,10 +4660,14 @@ Books a draft booking on CargoAi with one result and rate of one of its searches
|
|
|
4747
4660
|
<dd>
|
|
4748
4661
|
|
|
4749
4662
|
```typescript
|
|
4750
|
-
await client.cargoOnFlightIntegrations.cargoai.
|
|
4751
|
-
|
|
4752
|
-
|
|
4753
|
-
|
|
4663
|
+
await client.cargoOnFlightIntegrations.cargoai.listAirWaybillMessagesV1({
|
|
4664
|
+
cargo_on_flight_air_waybill_id: "cargo_on_flight_air_waybill_id",
|
|
4665
|
+
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
4666
|
+
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
4667
|
+
sort_by: "created_at_timestamp",
|
|
4668
|
+
sort_order: "asc",
|
|
4669
|
+
page: 1,
|
|
4670
|
+
page_size: 1,
|
|
4754
4671
|
});
|
|
4755
4672
|
```
|
|
4756
4673
|
|
|
@@ -4767,15 +4684,7 @@ await client.cargoOnFlightIntegrations.cargoai.bookV1("cargo_on_flight_booking_i
|
|
|
4767
4684
|
<dl>
|
|
4768
4685
|
<dd>
|
|
4769
4686
|
|
|
4770
|
-
**
|
|
4771
|
-
|
|
4772
|
-
</dd>
|
|
4773
|
-
</dl>
|
|
4774
|
-
|
|
4775
|
-
<dl>
|
|
4776
|
-
<dd>
|
|
4777
|
-
|
|
4778
|
-
**request:** `Chrt.cargoOnFlightIntegrations.CargoOnFlightIntegrationsCargoAiBookReq`
|
|
4687
|
+
**request:** `Chrt.cargoOnFlightIntegrations.CargoaiListAirWaybillMessagesV1Request`
|
|
4779
4688
|
|
|
4780
4689
|
</dd>
|
|
4781
4690
|
</dl>
|
|
@@ -4794,7 +4703,7 @@ await client.cargoOnFlightIntegrations.cargoai.bookV1("cargo_on_flight_booking_i
|
|
|
4794
4703
|
</dl>
|
|
4795
4704
|
</details>
|
|
4796
4705
|
|
|
4797
|
-
<details><summary><code>client.cargoOnFlightIntegrations.cargoai.<a href="/src/api/resources/cargoOnFlightIntegrations/resources/cargoai/client/Client.ts">
|
|
4706
|
+
<details><summary><code>client.cargoOnFlightIntegrations.cargoai.<a href="/src/api/resources/cargoOnFlightIntegrations/resources/cargoai/client/Client.ts">sendAirWaybillV1</a>(cargoOnFlightAirWaybillId, { ...params }) -> Chrt.CargoAiAirWaybillMessage1</code></summary>
|
|
4798
4707
|
<dl>
|
|
4799
4708
|
<dd>
|
|
4800
4709
|
|
|
@@ -4806,7 +4715,7 @@ await client.cargoOnFlightIntegrations.cargoai.bookV1("cargo_on_flight_booking_i
|
|
|
4806
4715
|
<dl>
|
|
4807
4716
|
<dd>
|
|
4808
4717
|
|
|
4809
|
-
|
|
4718
|
+
Sends an air waybill's FWB and/or the FHL for chosen house air waybills to the airline through CargoAi; the airline answers later. | authz_personas=[task_group_coordinator_operators] | (CargoOnFlightIntegrationsCargoAiSendAirWaybillReq) -> (CargoAiAirWaybillMessage1)
|
|
4810
4719
|
|
|
4811
4720
|
</dd>
|
|
4812
4721
|
</dl>
|
|
@@ -4822,8 +4731,8 @@ Asks CargoAi to cancel a confirmed booking; it is CANCELLATION_REQUESTED until t
|
|
|
4822
4731
|
<dd>
|
|
4823
4732
|
|
|
4824
4733
|
```typescript
|
|
4825
|
-
await client.cargoOnFlightIntegrations.cargoai.
|
|
4826
|
-
|
|
4734
|
+
await client.cargoOnFlightIntegrations.cargoai.sendAirWaybillV1("cargo_on_flight_air_waybill_id", {
|
|
4735
|
+
send_fwb: true,
|
|
4827
4736
|
});
|
|
4828
4737
|
```
|
|
4829
4738
|
|
|
@@ -4840,7 +4749,7 @@ await client.cargoOnFlightIntegrations.cargoai.cancelV1("cargo_on_flight_booking
|
|
|
4840
4749
|
<dl>
|
|
4841
4750
|
<dd>
|
|
4842
4751
|
|
|
4843
|
-
**
|
|
4752
|
+
**cargoOnFlightAirWaybillId:** `string`
|
|
4844
4753
|
|
|
4845
4754
|
</dd>
|
|
4846
4755
|
</dl>
|
|
@@ -4848,7 +4757,7 @@ await client.cargoOnFlightIntegrations.cargoai.cancelV1("cargo_on_flight_booking
|
|
|
4848
4757
|
<dl>
|
|
4849
4758
|
<dd>
|
|
4850
4759
|
|
|
4851
|
-
**request:** `Chrt.cargoOnFlightIntegrations.
|
|
4760
|
+
**request:** `Chrt.cargoOnFlightIntegrations.CargoOnFlightIntegrationsCargoAiSendAirWaybillReq`
|
|
4852
4761
|
|
|
4853
4762
|
</dd>
|
|
4854
4763
|
</dl>
|
|
@@ -4867,7 +4776,7 @@ await client.cargoOnFlightIntegrations.cargoai.cancelV1("cargo_on_flight_booking
|
|
|
4867
4776
|
</dl>
|
|
4868
4777
|
</details>
|
|
4869
4778
|
|
|
4870
|
-
<details><summary><code>client.cargoOnFlightIntegrations.cargoai.<a href="/src/api/resources/cargoOnFlightIntegrations/resources/cargoai/client/Client.ts">
|
|
4779
|
+
<details><summary><code>client.cargoOnFlightIntegrations.cargoai.<a href="/src/api/resources/cargoOnFlightIntegrations/resources/cargoai/client/Client.ts">simulateAirlineResponseV1</a>(cargoOnFlightAirWaybillId, { ...params }) -> Chrt.CargoOnFlightIntegrationsCargoAiSimulateAirlineResponseRes</code></summary>
|
|
4871
4780
|
<dl>
|
|
4872
4781
|
<dd>
|
|
4873
4782
|
|
|
@@ -4879,7 +4788,7 @@ await client.cargoOnFlightIntegrations.cargoai.cancelV1("cargo_on_flight_booking
|
|
|
4879
4788
|
<dl>
|
|
4880
4789
|
<dd>
|
|
4881
4790
|
|
|
4882
|
-
|
|
4791
|
+
For demos and testing: answers a sent FWB and/or the FHLs of chosen house air waybills as the airline would, accepted or rejected, for a demo AWB (prefix 000) whose Mock Airline never answers. | authz_personas=[task_group_coordinator_operators] | (CargoOnFlightIntegrationsCargoAiSimulateAirlineResponseReq) -> (CargoOnFlightIntegrationsCargoAiSimulateAirlineResponseRes)
|
|
4883
4792
|
|
|
4884
4793
|
</dd>
|
|
4885
4794
|
</dl>
|
|
@@ -4895,7 +4804,7 @@ Asks CargoAi for an active booking's current status and AWB and applies them, e.
|
|
|
4895
4804
|
<dd>
|
|
4896
4805
|
|
|
4897
4806
|
```typescript
|
|
4898
|
-
await client.cargoOnFlightIntegrations.cargoai.
|
|
4807
|
+
await client.cargoOnFlightIntegrations.cargoai.simulateAirlineResponseV1("cargo_on_flight_air_waybill_id");
|
|
4899
4808
|
```
|
|
4900
4809
|
|
|
4901
4810
|
</dd>
|
|
@@ -4911,7 +4820,15 @@ await client.cargoOnFlightIntegrations.cargoai.refreshV1("cargo_on_flight_bookin
|
|
|
4911
4820
|
<dl>
|
|
4912
4821
|
<dd>
|
|
4913
4822
|
|
|
4914
|
-
**
|
|
4823
|
+
**cargoOnFlightAirWaybillId:** `string`
|
|
4824
|
+
|
|
4825
|
+
</dd>
|
|
4826
|
+
</dl>
|
|
4827
|
+
|
|
4828
|
+
<dl>
|
|
4829
|
+
<dd>
|
|
4830
|
+
|
|
4831
|
+
**request:** `Chrt.cargoOnFlightIntegrations.CargoOnFlightIntegrationsCargoAiSimulateAirlineResponseReq`
|
|
4915
4832
|
|
|
4916
4833
|
</dd>
|
|
4917
4834
|
</dl>
|
|
@@ -4930,7 +4847,7 @@ await client.cargoOnFlightIntegrations.cargoai.refreshV1("cargo_on_flight_bookin
|
|
|
4930
4847
|
</dl>
|
|
4931
4848
|
</details>
|
|
4932
4849
|
|
|
4933
|
-
<details><summary><code>client.cargoOnFlightIntegrations.cargoai.<a href="/src/api/resources/cargoOnFlightIntegrations/resources/cargoai/client/Client.ts">
|
|
4850
|
+
<details><summary><code>client.cargoOnFlightIntegrations.cargoai.<a href="/src/api/resources/cargoOnFlightIntegrations/resources/cargoai/client/Client.ts">bookV1</a>(cargoOnFlightBookingId, { ...params }) -> Chrt.CargoOnFlightBooking1</code></summary>
|
|
4934
4851
|
<dl>
|
|
4935
4852
|
<dd>
|
|
4936
4853
|
|
|
@@ -4942,7 +4859,7 @@ await client.cargoOnFlightIntegrations.cargoai.refreshV1("cargo_on_flight_bookin
|
|
|
4942
4859
|
<dl>
|
|
4943
4860
|
<dd>
|
|
4944
4861
|
|
|
4945
|
-
|
|
4862
|
+
Books a draft booking on CargoAi with one result and rate of one of its searches, with the user's AWB or one from the airline's stock. | authz_personas=[task_group_coordinator_operators] | (CargoOnFlightIntegrationsCargoAiBookReq) -> (CargoOnFlightBooking1)
|
|
4946
4863
|
|
|
4947
4864
|
</dd>
|
|
4948
4865
|
</dl>
|
|
@@ -4958,7 +4875,11 @@ Collects the remaining CargoAi results of an unfinished search and stores them;
|
|
|
4958
4875
|
<dd>
|
|
4959
4876
|
|
|
4960
4877
|
```typescript
|
|
4961
|
-
await client.cargoOnFlightIntegrations.cargoai.
|
|
4878
|
+
await client.cargoOnFlightIntegrations.cargoai.bookV1("cargo_on_flight_booking_id", {
|
|
4879
|
+
cargo_on_flight_booking_search_id: "cargo_on_flight_booking_search_id",
|
|
4880
|
+
integration_rate_id: "integration_rate_id",
|
|
4881
|
+
integration_result_id: "integration_result_id",
|
|
4882
|
+
});
|
|
4962
4883
|
```
|
|
4963
4884
|
|
|
4964
4885
|
</dd>
|
|
@@ -4974,7 +4895,15 @@ await client.cargoOnFlightIntegrations.cargoai.searchContinueV1("cargo_on_flight
|
|
|
4974
4895
|
<dl>
|
|
4975
4896
|
<dd>
|
|
4976
4897
|
|
|
4977
|
-
**
|
|
4898
|
+
**cargoOnFlightBookingId:** `string`
|
|
4899
|
+
|
|
4900
|
+
</dd>
|
|
4901
|
+
</dl>
|
|
4902
|
+
|
|
4903
|
+
<dl>
|
|
4904
|
+
<dd>
|
|
4905
|
+
|
|
4906
|
+
**request:** `Chrt.cargoOnFlightIntegrations.CargoOnFlightIntegrationsCargoAiBookReq`
|
|
4978
4907
|
|
|
4979
4908
|
</dd>
|
|
4980
4909
|
</dl>
|
|
@@ -4993,7 +4922,7 @@ await client.cargoOnFlightIntegrations.cargoai.searchContinueV1("cargo_on_flight
|
|
|
4993
4922
|
</dl>
|
|
4994
4923
|
</details>
|
|
4995
4924
|
|
|
4996
|
-
<details><summary><code>client.cargoOnFlightIntegrations.cargoai.<a href="/src/api/resources/cargoOnFlightIntegrations/resources/cargoai/client/Client.ts">
|
|
4925
|
+
<details><summary><code>client.cargoOnFlightIntegrations.cargoai.<a href="/src/api/resources/cargoOnFlightIntegrations/resources/cargoai/client/Client.ts">cancelV1</a>(cargoOnFlightBookingId, { ...params }) -> Chrt.CargoOnFlightBooking1</code></summary>
|
|
4997
4926
|
<dl>
|
|
4998
4927
|
<dd>
|
|
4999
4928
|
|
|
@@ -5005,7 +4934,7 @@ await client.cargoOnFlightIntegrations.cargoai.searchContinueV1("cargo_on_flight
|
|
|
5005
4934
|
<dl>
|
|
5006
4935
|
<dd>
|
|
5007
4936
|
|
|
5008
|
-
|
|
4937
|
+
Asks CargoAi to cancel a confirmed booking; it is CANCELLATION_REQUESTED until the airline answers. | authz_personas=[task_group_coordinator_operators] | (CargoOnFlightIntegrationsCargoAiCancelReq) -> (CargoOnFlightBooking1)
|
|
5009
4938
|
|
|
5010
4939
|
</dd>
|
|
5011
4940
|
</dl>
|
|
@@ -5021,12 +4950,8 @@ Starts a CargoAi search for flights with space and rates for a draft booking's c
|
|
|
5021
4950
|
<dd>
|
|
5022
4951
|
|
|
5023
4952
|
```typescript
|
|
5024
|
-
await client.cargoOnFlightIntegrations.cargoai.
|
|
5025
|
-
|
|
5026
|
-
earliest_departure_date: "earliest_departure_date",
|
|
5027
|
-
iata_cass_office_id: "iata_cass_office_id",
|
|
5028
|
-
origin_iata: "origin_iata",
|
|
5029
|
-
schema_version: 1,
|
|
4953
|
+
await client.cargoOnFlightIntegrations.cargoai.cancelV1("cargo_on_flight_booking_id", {
|
|
4954
|
+
cancellation_reason: "cancellation_reason",
|
|
5030
4955
|
});
|
|
5031
4956
|
```
|
|
5032
4957
|
|
|
@@ -5051,7 +4976,7 @@ await client.cargoOnFlightIntegrations.cargoai.searchV1("cargo_on_flight_booking
|
|
|
5051
4976
|
<dl>
|
|
5052
4977
|
<dd>
|
|
5053
4978
|
|
|
5054
|
-
**request:** `Chrt.cargoOnFlightIntegrations.
|
|
4979
|
+
**request:** `Chrt.cargoOnFlightIntegrations.CargoOnFlightIntegrationsCargoAiCancelReq`
|
|
5055
4980
|
|
|
5056
4981
|
</dd>
|
|
5057
4982
|
</dl>
|
|
@@ -5070,9 +4995,70 @@ await client.cargoOnFlightIntegrations.cargoai.searchV1("cargo_on_flight_booking
|
|
|
5070
4995
|
</dl>
|
|
5071
4996
|
</details>
|
|
5072
4997
|
|
|
5073
|
-
|
|
4998
|
+
<details><summary><code>client.cargoOnFlightIntegrations.cargoai.<a href="/src/api/resources/cargoOnFlightIntegrations/resources/cargoai/client/Client.ts">refreshV1</a>(cargoOnFlightBookingId) -> Chrt.CargoOnFlightBooking1</code></summary>
|
|
4999
|
+
<dl>
|
|
5000
|
+
<dd>
|
|
5001
|
+
|
|
5002
|
+
#### 📝 Description
|
|
5003
|
+
|
|
5004
|
+
<dl>
|
|
5005
|
+
<dd>
|
|
5006
|
+
|
|
5007
|
+
<dl>
|
|
5008
|
+
<dd>
|
|
5009
|
+
|
|
5010
|
+
Asks CargoAi for an active booking's current status and AWB and applies them, e.g. when its book answer was lost. | authz_personas=[task_group_coordinator_operators] | () -> (CargoOnFlightBooking1)
|
|
5011
|
+
|
|
5012
|
+
</dd>
|
|
5013
|
+
</dl>
|
|
5014
|
+
</dd>
|
|
5015
|
+
</dl>
|
|
5016
|
+
|
|
5017
|
+
#### 🔌 Usage
|
|
5018
|
+
|
|
5019
|
+
<dl>
|
|
5020
|
+
<dd>
|
|
5021
|
+
|
|
5022
|
+
<dl>
|
|
5023
|
+
<dd>
|
|
5024
|
+
|
|
5025
|
+
```typescript
|
|
5026
|
+
await client.cargoOnFlightIntegrations.cargoai.refreshV1("cargo_on_flight_booking_id");
|
|
5027
|
+
```
|
|
5028
|
+
|
|
5029
|
+
</dd>
|
|
5030
|
+
</dl>
|
|
5031
|
+
</dd>
|
|
5032
|
+
</dl>
|
|
5033
|
+
|
|
5034
|
+
#### ⚙️ Parameters
|
|
5074
5035
|
|
|
5075
|
-
<
|
|
5036
|
+
<dl>
|
|
5037
|
+
<dd>
|
|
5038
|
+
|
|
5039
|
+
<dl>
|
|
5040
|
+
<dd>
|
|
5041
|
+
|
|
5042
|
+
**cargoOnFlightBookingId:** `string`
|
|
5043
|
+
|
|
5044
|
+
</dd>
|
|
5045
|
+
</dl>
|
|
5046
|
+
|
|
5047
|
+
<dl>
|
|
5048
|
+
<dd>
|
|
5049
|
+
|
|
5050
|
+
**requestOptions:** `Cargoai.RequestOptions`
|
|
5051
|
+
|
|
5052
|
+
</dd>
|
|
5053
|
+
</dl>
|
|
5054
|
+
</dd>
|
|
5055
|
+
</dl>
|
|
5056
|
+
|
|
5057
|
+
</dd>
|
|
5058
|
+
</dl>
|
|
5059
|
+
</details>
|
|
5060
|
+
|
|
5061
|
+
<details><summary><code>client.cargoOnFlightIntegrations.cargoai.<a href="/src/api/resources/cargoOnFlightIntegrations/resources/cargoai/client/Client.ts">searchContinueV1</a>(cargoOnFlightBookingSearchId) -> Chrt.CargoOnFlightBookingSearch1</code></summary>
|
|
5076
5062
|
<dl>
|
|
5077
5063
|
<dd>
|
|
5078
5064
|
|
|
@@ -5084,7 +5070,7 @@ await client.cargoOnFlightIntegrations.cargoai.searchV1("cargo_on_flight_booking
|
|
|
5084
5070
|
<dl>
|
|
5085
5071
|
<dd>
|
|
5086
5072
|
|
|
5087
|
-
|
|
5073
|
+
Collects the remaining CargoAi results of an unfinished search and stores them; a completed search is returned as is. | authz_personas=[task_group_coordinator_operators] | () -> (CargoOnFlightBookingSearch1)
|
|
5088
5074
|
|
|
5089
5075
|
</dd>
|
|
5090
5076
|
</dl>
|
|
@@ -5100,7 +5086,7 @@ Retrieves all CHAMP confirmation receipts linked to the air waybill for a task g
|
|
|
5100
5086
|
<dd>
|
|
5101
5087
|
|
|
5102
5088
|
```typescript
|
|
5103
|
-
await client.
|
|
5089
|
+
await client.cargoOnFlightIntegrations.cargoai.searchContinueV1("cargo_on_flight_booking_search_id");
|
|
5104
5090
|
```
|
|
5105
5091
|
|
|
5106
5092
|
</dd>
|
|
@@ -5116,7 +5102,7 @@ await client.integrations.airWaybills.confirmationsV1("task_group_id");
|
|
|
5116
5102
|
<dl>
|
|
5117
5103
|
<dd>
|
|
5118
5104
|
|
|
5119
|
-
**
|
|
5105
|
+
**cargoOnFlightBookingSearchId:** `string`
|
|
5120
5106
|
|
|
5121
5107
|
</dd>
|
|
5122
5108
|
</dl>
|
|
@@ -5124,7 +5110,7 @@ await client.integrations.airWaybills.confirmationsV1("task_group_id");
|
|
|
5124
5110
|
<dl>
|
|
5125
5111
|
<dd>
|
|
5126
5112
|
|
|
5127
|
-
**requestOptions:** `
|
|
5113
|
+
**requestOptions:** `Cargoai.RequestOptions`
|
|
5128
5114
|
|
|
5129
5115
|
</dd>
|
|
5130
5116
|
</dl>
|
|
@@ -5135,7 +5121,7 @@ await client.integrations.airWaybills.confirmationsV1("task_group_id");
|
|
|
5135
5121
|
</dl>
|
|
5136
5122
|
</details>
|
|
5137
5123
|
|
|
5138
|
-
<details><summary><code>client.
|
|
5124
|
+
<details><summary><code>client.cargoOnFlightIntegrations.cargoai.<a href="/src/api/resources/cargoOnFlightIntegrations/resources/cargoai/client/Client.ts">searchV1</a>(cargoOnFlightBookingId, { ...params }) -> Chrt.CargoOnFlightBookingSearch1</code></summary>
|
|
5139
5125
|
<dl>
|
|
5140
5126
|
<dd>
|
|
5141
5127
|
|
|
@@ -5147,7 +5133,7 @@ await client.integrations.airWaybills.confirmationsV1("task_group_id");
|
|
|
5147
5133
|
<dl>
|
|
5148
5134
|
<dd>
|
|
5149
5135
|
|
|
5150
|
-
|
|
5136
|
+
Starts a CargoAi search for flights with space and rates for a draft booking's cargos on a route and date, and stores it. | authz_personas=[task_group_coordinator_operators] | (CargoOnFlightBookingSearchClientCreate1) -> (CargoOnFlightBookingSearch1)
|
|
5151
5137
|
|
|
5152
5138
|
</dd>
|
|
5153
5139
|
</dl>
|
|
@@ -5163,8 +5149,12 @@ Creates a CHAMP air waybill pre-populated from the stored WebCargo booking recor
|
|
|
5163
5149
|
<dd>
|
|
5164
5150
|
|
|
5165
5151
|
```typescript
|
|
5166
|
-
await client.
|
|
5167
|
-
|
|
5152
|
+
await client.cargoOnFlightIntegrations.cargoai.searchV1("cargo_on_flight_booking_id", {
|
|
5153
|
+
destination_iata: "destination_iata",
|
|
5154
|
+
earliest_departure_date: "earliest_departure_date",
|
|
5155
|
+
iata_cass_office_id: "iata_cass_office_id",
|
|
5156
|
+
origin_iata: "origin_iata",
|
|
5157
|
+
schema_version: 1,
|
|
5168
5158
|
});
|
|
5169
5159
|
```
|
|
5170
5160
|
|
|
@@ -5181,7 +5171,7 @@ await client.integrations.airWaybills.createV1({
|
|
|
5181
5171
|
<dl>
|
|
5182
5172
|
<dd>
|
|
5183
5173
|
|
|
5184
|
-
**
|
|
5174
|
+
**cargoOnFlightBookingId:** `string`
|
|
5185
5175
|
|
|
5186
5176
|
</dd>
|
|
5187
5177
|
</dl>
|
|
@@ -5189,7 +5179,15 @@ await client.integrations.airWaybills.createV1({
|
|
|
5189
5179
|
<dl>
|
|
5190
5180
|
<dd>
|
|
5191
5181
|
|
|
5192
|
-
**
|
|
5182
|
+
**request:** `Chrt.cargoOnFlightIntegrations.CargoOnFlightBookingSearchClientCreate1`
|
|
5183
|
+
|
|
5184
|
+
</dd>
|
|
5185
|
+
</dl>
|
|
5186
|
+
|
|
5187
|
+
<dl>
|
|
5188
|
+
<dd>
|
|
5189
|
+
|
|
5190
|
+
**requestOptions:** `Cargoai.RequestOptions`
|
|
5193
5191
|
|
|
5194
5192
|
</dd>
|
|
5195
5193
|
</dl>
|
|
@@ -5200,7 +5198,9 @@ await client.integrations.airWaybills.createV1({
|
|
|
5200
5198
|
</dl>
|
|
5201
5199
|
</details>
|
|
5202
5200
|
|
|
5203
|
-
|
|
5201
|
+
## Integrations AirWaybills
|
|
5202
|
+
|
|
5203
|
+
<details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">confirmationsV1</a>(taskGroupId) -> Chrt.ChampConfirmationReceipt1[]</code></summary>
|
|
5204
5204
|
<dl>
|
|
5205
5205
|
<dd>
|
|
5206
5206
|
|
|
@@ -5212,7 +5212,7 @@ await client.integrations.airWaybills.createV1({
|
|
|
5212
5212
|
<dl>
|
|
5213
5213
|
<dd>
|
|
5214
5214
|
|
|
5215
|
-
Retrieves all CHAMP
|
|
5215
|
+
Retrieves all CHAMP confirmation receipts linked to the air waybill for a task group. | () -> (list[ChampConfirmationReceipt1])
|
|
5216
5216
|
|
|
5217
5217
|
</dd>
|
|
5218
5218
|
</dl>
|
|
@@ -5228,7 +5228,7 @@ Retrieves all CHAMP flight status updates linked to the air waybill for a task g
|
|
|
5228
5228
|
<dd>
|
|
5229
5229
|
|
|
5230
5230
|
```typescript
|
|
5231
|
-
await client.integrations.airWaybills.
|
|
5231
|
+
await client.integrations.airWaybills.confirmationsV1("task_group_id");
|
|
5232
5232
|
```
|
|
5233
5233
|
|
|
5234
5234
|
</dd>
|
|
@@ -5263,7 +5263,7 @@ await client.integrations.airWaybills.flightStatusesV1("task_group_id");
|
|
|
5263
5263
|
</dl>
|
|
5264
5264
|
</details>
|
|
5265
5265
|
|
|
5266
|
-
<details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">
|
|
5266
|
+
<details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">createV1</a>({ ...params }) -> Chrt.ChampAirWaybill1</code></summary>
|
|
5267
5267
|
<dl>
|
|
5268
5268
|
<dd>
|
|
5269
5269
|
|
|
@@ -5275,7 +5275,7 @@ await client.integrations.airWaybills.flightStatusesV1("task_group_id");
|
|
|
5275
5275
|
<dl>
|
|
5276
5276
|
<dd>
|
|
5277
5277
|
|
|
5278
|
-
|
|
5278
|
+
Creates a CHAMP air waybill pre-populated from the stored WebCargo booking record. The booking must be synced first via the webcargo_bookings sync route. Returns 409 if an air waybill already exists for this task group. | (AirWaybillCreateReq) -> (ChampAirWaybill1)
|
|
5279
5279
|
|
|
5280
5280
|
</dd>
|
|
5281
5281
|
</dl>
|
|
@@ -5291,7 +5291,9 @@ Converts a CHAMP air waybill to PDF via CHAMP's conversion API. Requires shipper
|
|
|
5291
5291
|
<dd>
|
|
5292
5292
|
|
|
5293
5293
|
```typescript
|
|
5294
|
-
await client.integrations.airWaybills.
|
|
5294
|
+
await client.integrations.airWaybills.createV1({
|
|
5295
|
+
task_group_id: "task_group_id",
|
|
5296
|
+
});
|
|
5295
5297
|
```
|
|
5296
5298
|
|
|
5297
5299
|
</dd>
|
|
@@ -5307,7 +5309,7 @@ await client.integrations.airWaybills.pdfV1("task_group_id");
|
|
|
5307
5309
|
<dl>
|
|
5308
5310
|
<dd>
|
|
5309
5311
|
|
|
5310
|
-
**
|
|
5312
|
+
**request:** `Chrt.integrations.AirWaybillCreateReq`
|
|
5311
5313
|
|
|
5312
5314
|
</dd>
|
|
5313
5315
|
</dl>
|
|
@@ -5326,7 +5328,7 @@ await client.integrations.airWaybills.pdfV1("task_group_id");
|
|
|
5326
5328
|
</dl>
|
|
5327
5329
|
</details>
|
|
5328
5330
|
|
|
5329
|
-
<details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">
|
|
5331
|
+
<details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">flightStatusesV1</a>(taskGroupId) -> Chrt.ChampFlightStatus1[]</code></summary>
|
|
5330
5332
|
<dl>
|
|
5331
5333
|
<dd>
|
|
5332
5334
|
|
|
@@ -5338,7 +5340,7 @@ await client.integrations.airWaybills.pdfV1("task_group_id");
|
|
|
5338
5340
|
<dl>
|
|
5339
5341
|
<dd>
|
|
5340
5342
|
|
|
5341
|
-
Retrieves
|
|
5343
|
+
Retrieves all CHAMP flight status updates linked to the air waybill for a task group. | () -> (list[ChampFlightStatus1])
|
|
5342
5344
|
|
|
5343
5345
|
</dd>
|
|
5344
5346
|
</dl>
|
|
@@ -5354,7 +5356,7 @@ Retrieves the stored CHAMP air waybill for a task group. | () -> (ChampAirWaybil
|
|
|
5354
5356
|
<dd>
|
|
5355
5357
|
|
|
5356
5358
|
```typescript
|
|
5357
|
-
await client.integrations.airWaybills.
|
|
5359
|
+
await client.integrations.airWaybills.flightStatusesV1("task_group_id");
|
|
5358
5360
|
```
|
|
5359
5361
|
|
|
5360
5362
|
</dd>
|
|
@@ -5389,7 +5391,7 @@ await client.integrations.airWaybills.retrieveV1("task_group_id");
|
|
|
5389
5391
|
</dl>
|
|
5390
5392
|
</details>
|
|
5391
5393
|
|
|
5392
|
-
<details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">
|
|
5394
|
+
<details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">pdfV1</a>(taskGroupId) -> unknown</code></summary>
|
|
5393
5395
|
<dl>
|
|
5394
5396
|
<dd>
|
|
5395
5397
|
|
|
@@ -5401,7 +5403,7 @@ await client.integrations.airWaybills.retrieveV1("task_group_id");
|
|
|
5401
5403
|
<dl>
|
|
5402
5404
|
<dd>
|
|
5403
5405
|
|
|
5404
|
-
|
|
5406
|
+
Converts a CHAMP air waybill to PDF via CHAMP's conversion API. Requires shipper, consignee, and charge_declarations to be filled in. Returns the PDF file as application/pdf. | () -> (PDF binary)
|
|
5405
5407
|
|
|
5406
5408
|
</dd>
|
|
5407
5409
|
</dl>
|
|
@@ -5417,7 +5419,7 @@ Submits a draft CHAMP air waybill to Traxon cargoHUB. Requires shipper, consigne
|
|
|
5417
5419
|
<dd>
|
|
5418
5420
|
|
|
5419
5421
|
```typescript
|
|
5420
|
-
await client.integrations.airWaybills.
|
|
5422
|
+
await client.integrations.airWaybills.pdfV1("task_group_id");
|
|
5421
5423
|
```
|
|
5422
5424
|
|
|
5423
5425
|
</dd>
|
|
@@ -5452,7 +5454,7 @@ await client.integrations.airWaybills.submitV1("task_group_id");
|
|
|
5452
5454
|
</dl>
|
|
5453
5455
|
</details>
|
|
5454
5456
|
|
|
5455
|
-
<details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">
|
|
5457
|
+
<details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">retrieveV1</a>(taskGroupId) -> Chrt.ChampAirWaybill1</code></summary>
|
|
5456
5458
|
<dl>
|
|
5457
5459
|
<dd>
|
|
5458
5460
|
|
|
@@ -5464,7 +5466,7 @@ await client.integrations.airWaybills.submitV1("task_group_id");
|
|
|
5464
5466
|
<dl>
|
|
5465
5467
|
<dd>
|
|
5466
5468
|
|
|
5467
|
-
|
|
5469
|
+
Retrieves the stored CHAMP air waybill for a task group. | () -> (ChampAirWaybill1)
|
|
5468
5470
|
|
|
5469
5471
|
</dd>
|
|
5470
5472
|
</dl>
|
|
@@ -5480,7 +5482,7 @@ Updates fields on an existing CHAMP air waybill. Any editable field can be set
|
|
|
5480
5482
|
<dd>
|
|
5481
5483
|
|
|
5482
5484
|
```typescript
|
|
5483
|
-
await client.integrations.airWaybills.
|
|
5485
|
+
await client.integrations.airWaybills.retrieveV1("task_group_id");
|
|
5484
5486
|
```
|
|
5485
5487
|
|
|
5486
5488
|
</dd>
|
|
@@ -5504,7 +5506,62 @@ await client.integrations.airWaybills.updateV1("task_group_id");
|
|
|
5504
5506
|
<dl>
|
|
5505
5507
|
<dd>
|
|
5506
5508
|
|
|
5507
|
-
**
|
|
5509
|
+
**requestOptions:** `AirWaybills.RequestOptions`
|
|
5510
|
+
|
|
5511
|
+
</dd>
|
|
5512
|
+
</dl>
|
|
5513
|
+
</dd>
|
|
5514
|
+
</dl>
|
|
5515
|
+
|
|
5516
|
+
</dd>
|
|
5517
|
+
</dl>
|
|
5518
|
+
</details>
|
|
5519
|
+
|
|
5520
|
+
<details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">submitV1</a>(taskGroupId) -> Chrt.ChampAirWaybill1</code></summary>
|
|
5521
|
+
<dl>
|
|
5522
|
+
<dd>
|
|
5523
|
+
|
|
5524
|
+
#### 📝 Description
|
|
5525
|
+
|
|
5526
|
+
<dl>
|
|
5527
|
+
<dd>
|
|
5528
|
+
|
|
5529
|
+
<dl>
|
|
5530
|
+
<dd>
|
|
5531
|
+
|
|
5532
|
+
Submits a draft CHAMP air waybill to Traxon cargoHUB. Requires shipper, consignee, and charge_declarations to be filled in. Returns 422 if the AWB is not in draft status or required fields are missing. | () -> (ChampAirWaybill1)
|
|
5533
|
+
|
|
5534
|
+
</dd>
|
|
5535
|
+
</dl>
|
|
5536
|
+
</dd>
|
|
5537
|
+
</dl>
|
|
5538
|
+
|
|
5539
|
+
#### 🔌 Usage
|
|
5540
|
+
|
|
5541
|
+
<dl>
|
|
5542
|
+
<dd>
|
|
5543
|
+
|
|
5544
|
+
<dl>
|
|
5545
|
+
<dd>
|
|
5546
|
+
|
|
5547
|
+
```typescript
|
|
5548
|
+
await client.integrations.airWaybills.submitV1("task_group_id");
|
|
5549
|
+
```
|
|
5550
|
+
|
|
5551
|
+
</dd>
|
|
5552
|
+
</dl>
|
|
5553
|
+
</dd>
|
|
5554
|
+
</dl>
|
|
5555
|
+
|
|
5556
|
+
#### ⚙️ Parameters
|
|
5557
|
+
|
|
5558
|
+
<dl>
|
|
5559
|
+
<dd>
|
|
5560
|
+
|
|
5561
|
+
<dl>
|
|
5562
|
+
<dd>
|
|
5563
|
+
|
|
5564
|
+
**taskGroupId:** `string`
|
|
5508
5565
|
|
|
5509
5566
|
</dd>
|
|
5510
5567
|
</dl>
|
|
@@ -5523,9 +5580,7 @@ await client.integrations.airWaybills.updateV1("task_group_id");
|
|
|
5523
5580
|
</dl>
|
|
5524
5581
|
</details>
|
|
5525
5582
|
|
|
5526
|
-
|
|
5527
|
-
|
|
5528
|
-
<details><summary><code>client.integrations.cargoaiTrackAndTrace.<a href="/src/api/resources/integrations/resources/cargoaiTrackAndTrace/client/Client.ts">subscribeV1</a>({ ...params }) -> Chrt.CargoAiTrackAndTraceSubscription1</code></summary>
|
|
5583
|
+
<details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">updateV1</a>(taskGroupId, { ...params }) -> Chrt.ChampAirWaybill1</code></summary>
|
|
5529
5584
|
<dl>
|
|
5530
5585
|
<dd>
|
|
5531
5586
|
|
|
@@ -5537,7 +5592,7 @@ await client.integrations.airWaybills.updateV1("task_group_id");
|
|
|
5537
5592
|
<dl>
|
|
5538
5593
|
<dd>
|
|
5539
5594
|
|
|
5540
|
-
|
|
5595
|
+
Updates fields on an existing CHAMP air waybill. Any editable field can be set — only fields included in the request body are changed. | (ChampAirWaybillClientUpdate1) -> (ChampAirWaybill1)
|
|
5541
5596
|
|
|
5542
5597
|
</dd>
|
|
5543
5598
|
</dl>
|
|
@@ -5553,9 +5608,7 @@ Starts CargoAi Track & Trace URL + e-mail updates for an AWB (which must already
|
|
|
5553
5608
|
<dd>
|
|
5554
5609
|
|
|
5555
5610
|
```typescript
|
|
5556
|
-
await client.integrations.
|
|
5557
|
-
awb: "awb",
|
|
5558
|
-
});
|
|
5611
|
+
await client.integrations.airWaybills.updateV1("task_group_id");
|
|
5559
5612
|
```
|
|
5560
5613
|
|
|
5561
5614
|
</dd>
|
|
@@ -5571,7 +5624,7 @@ await client.integrations.cargoaiTrackAndTrace.subscribeV1({
|
|
|
5571
5624
|
<dl>
|
|
5572
5625
|
<dd>
|
|
5573
5626
|
|
|
5574
|
-
**
|
|
5627
|
+
**taskGroupId:** `string`
|
|
5575
5628
|
|
|
5576
5629
|
</dd>
|
|
5577
5630
|
</dl>
|
|
@@ -5579,7 +5632,15 @@ await client.integrations.cargoaiTrackAndTrace.subscribeV1({
|
|
|
5579
5632
|
<dl>
|
|
5580
5633
|
<dd>
|
|
5581
5634
|
|
|
5582
|
-
**
|
|
5635
|
+
**request:** `Chrt.integrations.ChampAirWaybillClientUpdate1`
|
|
5636
|
+
|
|
5637
|
+
</dd>
|
|
5638
|
+
</dl>
|
|
5639
|
+
|
|
5640
|
+
<dl>
|
|
5641
|
+
<dd>
|
|
5642
|
+
|
|
5643
|
+
**requestOptions:** `AirWaybills.RequestOptions`
|
|
5583
5644
|
|
|
5584
5645
|
</dd>
|
|
5585
5646
|
</dl>
|
|
@@ -5590,7 +5651,9 @@ await client.integrations.cargoaiTrackAndTrace.subscribeV1({
|
|
|
5590
5651
|
</dl>
|
|
5591
5652
|
</details>
|
|
5592
5653
|
|
|
5593
|
-
|
|
5654
|
+
## Integrations CargoaiTrackAndTrace
|
|
5655
|
+
|
|
5656
|
+
<details><summary><code>client.integrations.cargoaiTrackAndTrace.<a href="/src/api/resources/integrations/resources/cargoaiTrackAndTrace/client/Client.ts">subscribeV1</a>({ ...params }) -> Chrt.CargoAiTrackAndTraceSubscription1</code></summary>
|
|
5594
5657
|
<dl>
|
|
5595
5658
|
<dd>
|
|
5596
5659
|
|
|
@@ -5602,7 +5665,7 @@ await client.integrations.cargoaiTrackAndTrace.subscribeV1({
|
|
|
5602
5665
|
<dl>
|
|
5603
5666
|
<dd>
|
|
5604
5667
|
|
|
5605
|
-
|
|
5668
|
+
Starts CargoAi Track & Trace URL + e-mail updates for an AWB (which must already be recorded on a flight leg). Idempotent: re-subscribing a still-live AWB returns the existing subscription without calling CargoAi again. | authz: order participant operator | (CargoAiTrackAndTraceSubscribeReq) -> (CargoAiTrackAndTraceSubscription1)
|
|
5606
5669
|
|
|
5607
5670
|
</dd>
|
|
5608
5671
|
</dl>
|
|
@@ -5618,7 +5681,9 @@ Retrieves the stored CargoAi tracking subscription for an AWB. | authz: order pa
|
|
|
5618
5681
|
<dd>
|
|
5619
5682
|
|
|
5620
5683
|
```typescript
|
|
5621
|
-
await client.integrations.cargoaiTrackAndTrace.
|
|
5684
|
+
await client.integrations.cargoaiTrackAndTrace.subscribeV1({
|
|
5685
|
+
awb: "awb",
|
|
5686
|
+
});
|
|
5622
5687
|
```
|
|
5623
5688
|
|
|
5624
5689
|
</dd>
|
|
@@ -5634,7 +5699,7 @@ await client.integrations.cargoaiTrackAndTrace.subscriptionV1("awb");
|
|
|
5634
5699
|
<dl>
|
|
5635
5700
|
<dd>
|
|
5636
5701
|
|
|
5637
|
-
**
|
|
5702
|
+
**request:** `Chrt.integrations.CargoAiTrackAndTraceSubscribeReq`
|
|
5638
5703
|
|
|
5639
5704
|
</dd>
|
|
5640
5705
|
</dl>
|
|
@@ -5653,7 +5718,7 @@ await client.integrations.cargoaiTrackAndTrace.subscriptionV1("awb");
|
|
|
5653
5718
|
</dl>
|
|
5654
5719
|
</details>
|
|
5655
5720
|
|
|
5656
|
-
<details><summary><code>client.integrations.cargoaiTrackAndTrace.<a href="/src/api/resources/integrations/resources/cargoaiTrackAndTrace/client/Client.ts">
|
|
5721
|
+
<details><summary><code>client.integrations.cargoaiTrackAndTrace.<a href="/src/api/resources/integrations/resources/cargoaiTrackAndTrace/client/Client.ts">subscriptionV1</a>(awb) -> Chrt.CargoAiTrackAndTraceSubscription1</code></summary>
|
|
5657
5722
|
<dl>
|
|
5658
5723
|
<dd>
|
|
5659
5724
|
|
|
@@ -5665,7 +5730,7 @@ await client.integrations.cargoaiTrackAndTrace.subscriptionV1("awb");
|
|
|
5665
5730
|
<dl>
|
|
5666
5731
|
<dd>
|
|
5667
5732
|
|
|
5668
|
-
|
|
5733
|
+
Retrieves the stored CargoAi tracking subscription for an AWB. | authz: order participant | () -> (CargoAiTrackAndTraceSubscription1)
|
|
5669
5734
|
|
|
5670
5735
|
</dd>
|
|
5671
5736
|
</dl>
|
|
@@ -5681,7 +5746,7 @@ Lists CargoAi tracking subscriptions for the AWBs recorded on a task group. | au
|
|
|
5681
5746
|
<dd>
|
|
5682
5747
|
|
|
5683
5748
|
```typescript
|
|
5684
|
-
await client.integrations.cargoaiTrackAndTrace.
|
|
5749
|
+
await client.integrations.cargoaiTrackAndTrace.subscriptionV1("awb");
|
|
5685
5750
|
```
|
|
5686
5751
|
|
|
5687
5752
|
</dd>
|
|
@@ -5697,7 +5762,7 @@ await client.integrations.cargoaiTrackAndTrace.subscriptionsByTaskGroupV1("task_
|
|
|
5697
5762
|
<dl>
|
|
5698
5763
|
<dd>
|
|
5699
5764
|
|
|
5700
|
-
**
|
|
5765
|
+
**awb:** `string` — IATA Air Waybill number: 3-digit airline prefix + 8-digit serial, e.g. '020-12345678'.
|
|
5701
5766
|
|
|
5702
5767
|
</dd>
|
|
5703
5768
|
</dl>
|
|
@@ -5716,7 +5781,7 @@ await client.integrations.cargoaiTrackAndTrace.subscriptionsByTaskGroupV1("task_
|
|
|
5716
5781
|
</dl>
|
|
5717
5782
|
</details>
|
|
5718
5783
|
|
|
5719
|
-
<details><summary><code>client.integrations.cargoaiTrackAndTrace.<a href="/src/api/resources/integrations/resources/cargoaiTrackAndTrace/client/Client.ts">
|
|
5784
|
+
<details><summary><code>client.integrations.cargoaiTrackAndTrace.<a href="/src/api/resources/integrations/resources/cargoaiTrackAndTrace/client/Client.ts">subscriptionsByTaskGroupV1</a>(taskGroupId) -> Chrt.CargoAiTrackAndTraceSubscription1[]</code></summary>
|
|
5720
5785
|
<dl>
|
|
5721
5786
|
<dd>
|
|
5722
5787
|
|
|
@@ -5728,7 +5793,7 @@ await client.integrations.cargoaiTrackAndTrace.subscriptionsByTaskGroupV1("task_
|
|
|
5728
5793
|
<dl>
|
|
5729
5794
|
<dd>
|
|
5730
5795
|
|
|
5731
|
-
|
|
5796
|
+
Lists CargoAi tracking subscriptions for the AWBs recorded on a task group. | authz: order participant | () -> (list[CargoAiTrackAndTraceSubscription1])
|
|
5732
5797
|
|
|
5733
5798
|
</dd>
|
|
5734
5799
|
</dl>
|
|
@@ -5744,7 +5809,7 @@ Retrieves stored CargoAi tracking updates for an AWB, latest first (the first it
|
|
|
5744
5809
|
<dd>
|
|
5745
5810
|
|
|
5746
5811
|
```typescript
|
|
5747
|
-
await client.integrations.cargoaiTrackAndTrace.
|
|
5812
|
+
await client.integrations.cargoaiTrackAndTrace.subscriptionsByTaskGroupV1("task_group_id");
|
|
5748
5813
|
```
|
|
5749
5814
|
|
|
5750
5815
|
</dd>
|
|
@@ -5760,7 +5825,7 @@ await client.integrations.cargoaiTrackAndTrace.updatesV1("awb");
|
|
|
5760
5825
|
<dl>
|
|
5761
5826
|
<dd>
|
|
5762
5827
|
|
|
5763
|
-
**
|
|
5828
|
+
**taskGroupId:** `string`
|
|
5764
5829
|
|
|
5765
5830
|
</dd>
|
|
5766
5831
|
</dl>
|
|
@@ -5779,9 +5844,7 @@ await client.integrations.cargoaiTrackAndTrace.updatesV1("awb");
|
|
|
5779
5844
|
</dl>
|
|
5780
5845
|
</details>
|
|
5781
5846
|
|
|
5782
|
-
|
|
5783
|
-
|
|
5784
|
-
<details><summary><code>client.integrations.webcargoBookings.<a href="/src/api/resources/integrations/resources/webcargoBookings/client/Client.ts">retrieveV1</a>(taskGroupId) -> Chrt.WebcargoBookingRecord1</code></summary>
|
|
5847
|
+
<details><summary><code>client.integrations.cargoaiTrackAndTrace.<a href="/src/api/resources/integrations/resources/cargoaiTrackAndTrace/client/Client.ts">updatesV1</a>(awb) -> Chrt.CargoAiTrackAndTraceUpdate1[]</code></summary>
|
|
5785
5848
|
<dl>
|
|
5786
5849
|
<dd>
|
|
5787
5850
|
|
|
@@ -5793,7 +5856,7 @@ await client.integrations.cargoaiTrackAndTrace.updatesV1("awb");
|
|
|
5793
5856
|
<dl>
|
|
5794
5857
|
<dd>
|
|
5795
5858
|
|
|
5796
|
-
Retrieves
|
|
5859
|
+
Retrieves stored CargoAi tracking updates for an AWB, latest first (the first item is the current state). | authz: order participant | () -> (list[CargoAiTrackAndTraceUpdate1])
|
|
5797
5860
|
|
|
5798
5861
|
</dd>
|
|
5799
5862
|
</dl>
|
|
@@ -5809,7 +5872,7 @@ Retrieves the stored WebCargo booking record for a task group. Returns 404 if th
|
|
|
5809
5872
|
<dd>
|
|
5810
5873
|
|
|
5811
5874
|
```typescript
|
|
5812
|
-
await client.integrations.
|
|
5875
|
+
await client.integrations.cargoaiTrackAndTrace.updatesV1("awb");
|
|
5813
5876
|
```
|
|
5814
5877
|
|
|
5815
5878
|
</dd>
|
|
@@ -5825,7 +5888,7 @@ await client.integrations.webcargoBookings.retrieveV1("task_group_id");
|
|
|
5825
5888
|
<dl>
|
|
5826
5889
|
<dd>
|
|
5827
5890
|
|
|
5828
|
-
**
|
|
5891
|
+
**awb:** `string` — IATA Air Waybill number: 3-digit airline prefix + 8-digit serial, e.g. '020-12345678'.
|
|
5829
5892
|
|
|
5830
5893
|
</dd>
|
|
5831
5894
|
</dl>
|
|
@@ -5833,7 +5896,7 @@ await client.integrations.webcargoBookings.retrieveV1("task_group_id");
|
|
|
5833
5896
|
<dl>
|
|
5834
5897
|
<dd>
|
|
5835
5898
|
|
|
5836
|
-
**requestOptions:** `
|
|
5899
|
+
**requestOptions:** `CargoaiTrackAndTrace.RequestOptions`
|
|
5837
5900
|
|
|
5838
5901
|
</dd>
|
|
5839
5902
|
</dl>
|
|
@@ -5844,7 +5907,9 @@ await client.integrations.webcargoBookings.retrieveV1("task_group_id");
|
|
|
5844
5907
|
</dl>
|
|
5845
5908
|
</details>
|
|
5846
5909
|
|
|
5847
|
-
|
|
5910
|
+
## Integrations WebcargoBookings
|
|
5911
|
+
|
|
5912
|
+
<details><summary><code>client.integrations.webcargoBookings.<a href="/src/api/resources/integrations/resources/webcargoBookings/client/Client.ts">retrieveV1</a>(taskGroupId) -> Chrt.WebcargoBookingRecord1</code></summary>
|
|
5848
5913
|
<dl>
|
|
5849
5914
|
<dd>
|
|
5850
5915
|
|
|
@@ -5856,7 +5921,7 @@ await client.integrations.webcargoBookings.retrieveV1("task_group_id");
|
|
|
5856
5921
|
<dl>
|
|
5857
5922
|
<dd>
|
|
5858
5923
|
|
|
5859
|
-
|
|
5924
|
+
Retrieves the stored WebCargo booking record for a task group. Returns 404 if the booking has never been synced. | () -> (WebcargoBookingRecord1)
|
|
5860
5925
|
|
|
5861
5926
|
</dd>
|
|
5862
5927
|
</dl>
|
|
@@ -5872,7 +5937,70 @@ Fetches the latest booking record from WebCargo for a task group and upserts it
|
|
|
5872
5937
|
<dd>
|
|
5873
5938
|
|
|
5874
5939
|
```typescript
|
|
5875
|
-
await client.integrations.webcargoBookings.
|
|
5940
|
+
await client.integrations.webcargoBookings.retrieveV1("task_group_id");
|
|
5941
|
+
```
|
|
5942
|
+
|
|
5943
|
+
</dd>
|
|
5944
|
+
</dl>
|
|
5945
|
+
</dd>
|
|
5946
|
+
</dl>
|
|
5947
|
+
|
|
5948
|
+
#### ⚙️ Parameters
|
|
5949
|
+
|
|
5950
|
+
<dl>
|
|
5951
|
+
<dd>
|
|
5952
|
+
|
|
5953
|
+
<dl>
|
|
5954
|
+
<dd>
|
|
5955
|
+
|
|
5956
|
+
**taskGroupId:** `string`
|
|
5957
|
+
|
|
5958
|
+
</dd>
|
|
5959
|
+
</dl>
|
|
5960
|
+
|
|
5961
|
+
<dl>
|
|
5962
|
+
<dd>
|
|
5963
|
+
|
|
5964
|
+
**requestOptions:** `WebcargoBookings.RequestOptions`
|
|
5965
|
+
|
|
5966
|
+
</dd>
|
|
5967
|
+
</dl>
|
|
5968
|
+
</dd>
|
|
5969
|
+
</dl>
|
|
5970
|
+
|
|
5971
|
+
</dd>
|
|
5972
|
+
</dl>
|
|
5973
|
+
</details>
|
|
5974
|
+
|
|
5975
|
+
<details><summary><code>client.integrations.webcargoBookings.<a href="/src/api/resources/integrations/resources/webcargoBookings/client/Client.ts">syncV1</a>(taskGroupId) -> Chrt.WebcargoBookingRecord1</code></summary>
|
|
5976
|
+
<dl>
|
|
5977
|
+
<dd>
|
|
5978
|
+
|
|
5979
|
+
#### 📝 Description
|
|
5980
|
+
|
|
5981
|
+
<dl>
|
|
5982
|
+
<dd>
|
|
5983
|
+
|
|
5984
|
+
<dl>
|
|
5985
|
+
<dd>
|
|
5986
|
+
|
|
5987
|
+
Fetches the latest booking record from WebCargo for a task group and upserts it in the database. Creates the record on first call, updates on subsequent calls. | () -> (WebcargoBookingRecord1)
|
|
5988
|
+
|
|
5989
|
+
</dd>
|
|
5990
|
+
</dl>
|
|
5991
|
+
</dd>
|
|
5992
|
+
</dl>
|
|
5993
|
+
|
|
5994
|
+
#### 🔌 Usage
|
|
5995
|
+
|
|
5996
|
+
<dl>
|
|
5997
|
+
<dd>
|
|
5998
|
+
|
|
5999
|
+
<dl>
|
|
6000
|
+
<dd>
|
|
6001
|
+
|
|
6002
|
+
```typescript
|
|
6003
|
+
await client.integrations.webcargoBookings.syncV1("task_group_id");
|
|
5876
6004
|
```
|
|
5877
6005
|
|
|
5878
6006
|
</dd>
|
|
@@ -16334,9 +16462,9 @@ await client.orgs.connections.shippers.typeaheadV1({
|
|
|
16334
16462
|
</dl>
|
|
16335
16463
|
</details>
|
|
16336
16464
|
|
|
16337
|
-
## Shipping
|
|
16465
|
+
## Shipping CargoOnFlightAirWaybills
|
|
16338
16466
|
|
|
16339
|
-
<details><summary><code>client.shipping.
|
|
16467
|
+
<details><summary><code>client.shipping.cargoOnFlightAirWaybills.<a href="/src/api/resources/shipping/resources/cargoOnFlightAirWaybills/client/Client.ts">createV1</a>({ ...params }) -> Chrt.CargoOnFlightAirWaybill1</code></summary>
|
|
16340
16468
|
<dl>
|
|
16341
16469
|
<dd>
|
|
16342
16470
|
|
|
@@ -16348,7 +16476,7 @@ await client.orgs.connections.shippers.typeaheadV1({
|
|
|
16348
16476
|
<dl>
|
|
16349
16477
|
<dd>
|
|
16350
16478
|
|
|
16351
|
-
|
|
16479
|
+
Creates the air waybill for a confirmed cargo-on-flight booking: the parties, rating, charges, and security declaration sent to the airline as an FWB. | authz_personas=[task_group_coordinator_operators] | (CargoOnFlightAirWaybillClientCreate1) -> (CargoOnFlightAirWaybill1)
|
|
16352
16480
|
|
|
16353
16481
|
</dd>
|
|
16354
16482
|
</dl>
|
|
@@ -16364,10 +16492,168 @@ Lists a cargo-on-flight booking's searches with their results. | authz_personas=
|
|
|
16364
16492
|
<dd>
|
|
16365
16493
|
|
|
16366
16494
|
```typescript
|
|
16367
|
-
await client.shipping.
|
|
16495
|
+
await client.shipping.cargoOnFlightAirWaybills.createV1({
|
|
16368
16496
|
cargo_on_flight_booking_id: "cargo_on_flight_booking_id",
|
|
16369
|
-
|
|
16370
|
-
|
|
16497
|
+
carriers_execution: {
|
|
16498
|
+
authorisation_signature: "authorisation_signature",
|
|
16499
|
+
executed_on_date: "executed_on_date",
|
|
16500
|
+
place: "place",
|
|
16501
|
+
},
|
|
16502
|
+
charges_declaration: {
|
|
16503
|
+
charge_code: "CA",
|
|
16504
|
+
currency_code: "currency_code",
|
|
16505
|
+
},
|
|
16506
|
+
consignee: {
|
|
16507
|
+
address_line_1: "address_line_1",
|
|
16508
|
+
city_name: "city_name",
|
|
16509
|
+
country_code: "country_code",
|
|
16510
|
+
name: "name",
|
|
16511
|
+
},
|
|
16512
|
+
rate_lines: [
|
|
16513
|
+
{
|
|
16514
|
+
gross_weight_kilograms: 1.1,
|
|
16515
|
+
nature_and_quantity_of_goods: "nature_and_quantity_of_goods",
|
|
16516
|
+
number_of_pieces: 1,
|
|
16517
|
+
rate_class_code: "B",
|
|
16518
|
+
},
|
|
16519
|
+
],
|
|
16520
|
+
schema_version: 1,
|
|
16521
|
+
shipper: {
|
|
16522
|
+
address_line_1: "address_line_1",
|
|
16523
|
+
city_name: "city_name",
|
|
16524
|
+
country_code: "country_code",
|
|
16525
|
+
name: "name",
|
|
16526
|
+
},
|
|
16527
|
+
shippers_certification: "shippers_certification",
|
|
16528
|
+
});
|
|
16529
|
+
```
|
|
16530
|
+
|
|
16531
|
+
</dd>
|
|
16532
|
+
</dl>
|
|
16533
|
+
</dd>
|
|
16534
|
+
</dl>
|
|
16535
|
+
|
|
16536
|
+
#### ⚙️ Parameters
|
|
16537
|
+
|
|
16538
|
+
<dl>
|
|
16539
|
+
<dd>
|
|
16540
|
+
|
|
16541
|
+
<dl>
|
|
16542
|
+
<dd>
|
|
16543
|
+
|
|
16544
|
+
**request:** `Chrt.shipping.CargoOnFlightAirWaybillClientCreate1`
|
|
16545
|
+
|
|
16546
|
+
</dd>
|
|
16547
|
+
</dl>
|
|
16548
|
+
|
|
16549
|
+
<dl>
|
|
16550
|
+
<dd>
|
|
16551
|
+
|
|
16552
|
+
**requestOptions:** `CargoOnFlightAirWaybills.RequestOptions`
|
|
16553
|
+
|
|
16554
|
+
</dd>
|
|
16555
|
+
</dl>
|
|
16556
|
+
</dd>
|
|
16557
|
+
</dl>
|
|
16558
|
+
|
|
16559
|
+
</dd>
|
|
16560
|
+
</dl>
|
|
16561
|
+
</details>
|
|
16562
|
+
|
|
16563
|
+
<details><summary><code>client.shipping.cargoOnFlightAirWaybills.<a href="/src/api/resources/shipping/resources/cargoOnFlightAirWaybills/client/Client.ts">deleteV1</a>(cargoOnFlightAirWaybillId) -> boolean</code></summary>
|
|
16564
|
+
<dl>
|
|
16565
|
+
<dd>
|
|
16566
|
+
|
|
16567
|
+
#### 📝 Description
|
|
16568
|
+
|
|
16569
|
+
<dl>
|
|
16570
|
+
<dd>
|
|
16571
|
+
|
|
16572
|
+
<dl>
|
|
16573
|
+
<dd>
|
|
16574
|
+
|
|
16575
|
+
Deletes an air waybill and its house air waybills, while none of them has been sent to the airline. | authz_personas=[task_group_coordinator_operators] | () -> (bool)
|
|
16576
|
+
|
|
16577
|
+
</dd>
|
|
16578
|
+
</dl>
|
|
16579
|
+
</dd>
|
|
16580
|
+
</dl>
|
|
16581
|
+
|
|
16582
|
+
#### 🔌 Usage
|
|
16583
|
+
|
|
16584
|
+
<dl>
|
|
16585
|
+
<dd>
|
|
16586
|
+
|
|
16587
|
+
<dl>
|
|
16588
|
+
<dd>
|
|
16589
|
+
|
|
16590
|
+
```typescript
|
|
16591
|
+
await client.shipping.cargoOnFlightAirWaybills.deleteV1("cargo_on_flight_air_waybill_id");
|
|
16592
|
+
```
|
|
16593
|
+
|
|
16594
|
+
</dd>
|
|
16595
|
+
</dl>
|
|
16596
|
+
</dd>
|
|
16597
|
+
</dl>
|
|
16598
|
+
|
|
16599
|
+
#### ⚙️ Parameters
|
|
16600
|
+
|
|
16601
|
+
<dl>
|
|
16602
|
+
<dd>
|
|
16603
|
+
|
|
16604
|
+
<dl>
|
|
16605
|
+
<dd>
|
|
16606
|
+
|
|
16607
|
+
**cargoOnFlightAirWaybillId:** `string`
|
|
16608
|
+
|
|
16609
|
+
</dd>
|
|
16610
|
+
</dl>
|
|
16611
|
+
|
|
16612
|
+
<dl>
|
|
16613
|
+
<dd>
|
|
16614
|
+
|
|
16615
|
+
**requestOptions:** `CargoOnFlightAirWaybills.RequestOptions`
|
|
16616
|
+
|
|
16617
|
+
</dd>
|
|
16618
|
+
</dl>
|
|
16619
|
+
</dd>
|
|
16620
|
+
</dl>
|
|
16621
|
+
|
|
16622
|
+
</dd>
|
|
16623
|
+
</dl>
|
|
16624
|
+
</details>
|
|
16625
|
+
|
|
16626
|
+
<details><summary><code>client.shipping.cargoOnFlightAirWaybills.<a href="/src/api/resources/shipping/resources/cargoOnFlightAirWaybills/client/Client.ts">listV1</a>({ ...params }) -> Chrt.CargoOnFlightAirWaybillListRes</code></summary>
|
|
16627
|
+
<dl>
|
|
16628
|
+
<dd>
|
|
16629
|
+
|
|
16630
|
+
#### 📝 Description
|
|
16631
|
+
|
|
16632
|
+
<dl>
|
|
16633
|
+
<dd>
|
|
16634
|
+
|
|
16635
|
+
<dl>
|
|
16636
|
+
<dd>
|
|
16637
|
+
|
|
16638
|
+
Lists a flight task group's air waybills, one per cargo-on-flight booking. | authz_personas=[task_group_coordinator_operators] | () -> (CargoOnFlightAirWaybillListRes)
|
|
16639
|
+
|
|
16640
|
+
</dd>
|
|
16641
|
+
</dl>
|
|
16642
|
+
</dd>
|
|
16643
|
+
</dl>
|
|
16644
|
+
|
|
16645
|
+
#### 🔌 Usage
|
|
16646
|
+
|
|
16647
|
+
<dl>
|
|
16648
|
+
<dd>
|
|
16649
|
+
|
|
16650
|
+
<dl>
|
|
16651
|
+
<dd>
|
|
16652
|
+
|
|
16653
|
+
```typescript
|
|
16654
|
+
await client.shipping.cargoOnFlightAirWaybills.listV1({
|
|
16655
|
+
task_group_id: "task_group_id",
|
|
16656
|
+
filter_cargo_on_flight_booking_id: "filter_cargo_on_flight_booking_id",
|
|
16371
16657
|
sort_by: "created_at_timestamp",
|
|
16372
16658
|
sort_order: "asc",
|
|
16373
16659
|
page: 1,
|
|
@@ -16388,7 +16674,7 @@ await client.shipping.cargoOnFlightBookingSearches.listV1({
|
|
|
16388
16674
|
<dl>
|
|
16389
16675
|
<dd>
|
|
16390
16676
|
|
|
16391
|
-
**request:** `Chrt.shipping.
|
|
16677
|
+
**request:** `Chrt.shipping.CargoOnFlightAirWaybillsListV1Request`
|
|
16392
16678
|
|
|
16393
16679
|
</dd>
|
|
16394
16680
|
</dl>
|
|
@@ -16396,7 +16682,7 @@ await client.shipping.cargoOnFlightBookingSearches.listV1({
|
|
|
16396
16682
|
<dl>
|
|
16397
16683
|
<dd>
|
|
16398
16684
|
|
|
16399
|
-
**requestOptions:** `
|
|
16685
|
+
**requestOptions:** `CargoOnFlightAirWaybills.RequestOptions`
|
|
16400
16686
|
|
|
16401
16687
|
</dd>
|
|
16402
16688
|
</dl>
|
|
@@ -16407,7 +16693,7 @@ await client.shipping.cargoOnFlightBookingSearches.listV1({
|
|
|
16407
16693
|
</dl>
|
|
16408
16694
|
</details>
|
|
16409
16695
|
|
|
16410
|
-
<details><summary><code>client.shipping.
|
|
16696
|
+
<details><summary><code>client.shipping.cargoOnFlightAirWaybills.<a href="/src/api/resources/shipping/resources/cargoOnFlightAirWaybills/client/Client.ts">markAcceptedV1</a>(cargoOnFlightAirWaybillId, { ...params }) -> Chrt.CargoOnFlightAirWaybillsMarkAcceptedRes</code></summary>
|
|
16411
16697
|
<dl>
|
|
16412
16698
|
<dd>
|
|
16413
16699
|
|
|
@@ -16419,7 +16705,7 @@ await client.shipping.cargoOnFlightBookingSearches.listV1({
|
|
|
16419
16705
|
<dl>
|
|
16420
16706
|
<dd>
|
|
16421
16707
|
|
|
16422
|
-
|
|
16708
|
+
Marks a sent FWB and/or the FHLs of chosen house air waybills accepted, for an airline that never answered; a later airline answer replaces it. | authz_personas=[task_group_coordinator_operators] | (CargoOnFlightAirWaybillsMarkAcceptedReq) -> (CargoOnFlightAirWaybillsMarkAcceptedRes)
|
|
16423
16709
|
|
|
16424
16710
|
</dd>
|
|
16425
16711
|
</dl>
|
|
@@ -16435,13 +16721,8 @@ Retrieves a cargo-on-flight booking search with its results, optionally filtered
|
|
|
16435
16721
|
<dd>
|
|
16436
16722
|
|
|
16437
16723
|
```typescript
|
|
16438
|
-
await client.shipping.
|
|
16439
|
-
|
|
16440
|
-
filter_awb_required: true,
|
|
16441
|
-
filter_aircraft_body_type: "widebody",
|
|
16442
|
-
filter_currency_code: "filter_currency_code",
|
|
16443
|
-
sort_by: "departure",
|
|
16444
|
-
sort_order: "asc",
|
|
16724
|
+
await client.shipping.cargoOnFlightAirWaybills.markAcceptedV1("cargo_on_flight_air_waybill_id", {
|
|
16725
|
+
mark_fwb: true,
|
|
16445
16726
|
});
|
|
16446
16727
|
```
|
|
16447
16728
|
|
|
@@ -16458,7 +16739,7 @@ await client.shipping.cargoOnFlightBookingSearches.getV1("cargo_on_flight_bookin
|
|
|
16458
16739
|
<dl>
|
|
16459
16740
|
<dd>
|
|
16460
16741
|
|
|
16461
|
-
**
|
|
16742
|
+
**cargoOnFlightAirWaybillId:** `string`
|
|
16462
16743
|
|
|
16463
16744
|
</dd>
|
|
16464
16745
|
</dl>
|
|
@@ -16466,7 +16747,7 @@ await client.shipping.cargoOnFlightBookingSearches.getV1("cargo_on_flight_bookin
|
|
|
16466
16747
|
<dl>
|
|
16467
16748
|
<dd>
|
|
16468
16749
|
|
|
16469
|
-
**request:** `Chrt.shipping.
|
|
16750
|
+
**request:** `Chrt.shipping.CargoOnFlightAirWaybillsMarkAcceptedReq`
|
|
16470
16751
|
|
|
16471
16752
|
</dd>
|
|
16472
16753
|
</dl>
|
|
@@ -16474,7 +16755,7 @@ await client.shipping.cargoOnFlightBookingSearches.getV1("cargo_on_flight_bookin
|
|
|
16474
16755
|
<dl>
|
|
16475
16756
|
<dd>
|
|
16476
16757
|
|
|
16477
|
-
**requestOptions:** `
|
|
16758
|
+
**requestOptions:** `CargoOnFlightAirWaybills.RequestOptions`
|
|
16478
16759
|
|
|
16479
16760
|
</dd>
|
|
16480
16761
|
</dl>
|
|
@@ -16485,9 +16766,7 @@ await client.shipping.cargoOnFlightBookingSearches.getV1("cargo_on_flight_bookin
|
|
|
16485
16766
|
</dl>
|
|
16486
16767
|
</details>
|
|
16487
16768
|
|
|
16488
|
-
|
|
16489
|
-
|
|
16490
|
-
<details><summary><code>client.shipping.cargoOnFlightBookings.<a href="/src/api/resources/shipping/resources/cargoOnFlightBookings/client/Client.ts">cancelV1</a>(cargoOnFlightBookingId) -> Chrt.CargoOnFlightBooking1</code></summary>
|
|
16769
|
+
<details><summary><code>client.shipping.cargoOnFlightAirWaybills.<a href="/src/api/resources/shipping/resources/cargoOnFlightAirWaybills/client/Client.ts">updateV1</a>(cargoOnFlightAirWaybillId, { ...params }) -> Chrt.CargoOnFlightAirWaybill1</code></summary>
|
|
16491
16770
|
<dl>
|
|
16492
16771
|
<dd>
|
|
16493
16772
|
|
|
@@ -16499,7 +16778,7 @@ await client.shipping.cargoOnFlightBookingSearches.getV1("cargo_on_flight_bookin
|
|
|
16499
16778
|
<dl>
|
|
16500
16779
|
<dd>
|
|
16501
16780
|
|
|
16502
|
-
|
|
16781
|
+
Updates an air waybill; an FWB already sent is replaced at the airline only when it is sent again. | authz_personas=[task_group_coordinator_operators] | (CargoOnFlightAirWaybillClientUpdate1) -> (CargoOnFlightAirWaybill1)
|
|
16503
16782
|
|
|
16504
16783
|
</dd>
|
|
16505
16784
|
</dl>
|
|
@@ -16515,7 +16794,7 @@ Cancels a MANUAL booking, removing the flights it created from the task group an
|
|
|
16515
16794
|
<dd>
|
|
16516
16795
|
|
|
16517
16796
|
```typescript
|
|
16518
|
-
await client.shipping.
|
|
16797
|
+
await client.shipping.cargoOnFlightAirWaybills.updateV1("cargo_on_flight_air_waybill_id");
|
|
16519
16798
|
```
|
|
16520
16799
|
|
|
16521
16800
|
</dd>
|
|
@@ -16531,7 +16810,7 @@ await client.shipping.cargoOnFlightBookings.cancelV1("cargo_on_flight_booking_id
|
|
|
16531
16810
|
<dl>
|
|
16532
16811
|
<dd>
|
|
16533
16812
|
|
|
16534
|
-
**
|
|
16813
|
+
**cargoOnFlightAirWaybillId:** `string`
|
|
16535
16814
|
|
|
16536
16815
|
</dd>
|
|
16537
16816
|
</dl>
|
|
@@ -16539,7 +16818,15 @@ await client.shipping.cargoOnFlightBookings.cancelV1("cargo_on_flight_booking_id
|
|
|
16539
16818
|
<dl>
|
|
16540
16819
|
<dd>
|
|
16541
16820
|
|
|
16542
|
-
**
|
|
16821
|
+
**request:** `Chrt.shipping.CargoOnFlightAirWaybillClientUpdate1`
|
|
16822
|
+
|
|
16823
|
+
</dd>
|
|
16824
|
+
</dl>
|
|
16825
|
+
|
|
16826
|
+
<dl>
|
|
16827
|
+
<dd>
|
|
16828
|
+
|
|
16829
|
+
**requestOptions:** `CargoOnFlightAirWaybills.RequestOptions`
|
|
16543
16830
|
|
|
16544
16831
|
</dd>
|
|
16545
16832
|
</dl>
|
|
@@ -16550,7 +16837,7 @@ await client.shipping.cargoOnFlightBookings.cancelV1("cargo_on_flight_booking_id
|
|
|
16550
16837
|
</dl>
|
|
16551
16838
|
</details>
|
|
16552
16839
|
|
|
16553
|
-
<details><summary><code>client.shipping.
|
|
16840
|
+
<details><summary><code>client.shipping.cargoOnFlightAirWaybills.<a href="/src/api/resources/shipping/resources/cargoOnFlightAirWaybills/client/Client.ts">getV1</a>(cargoOnFlightAirWaybillId) -> Chrt.CargoOnFlightAirWaybill1</code></summary>
|
|
16554
16841
|
<dl>
|
|
16555
16842
|
<dd>
|
|
16556
16843
|
|
|
@@ -16562,7 +16849,7 @@ await client.shipping.cargoOnFlightBookings.cancelV1("cargo_on_flight_booking_id
|
|
|
16562
16849
|
<dl>
|
|
16563
16850
|
<dd>
|
|
16564
16851
|
|
|
16565
|
-
|
|
16852
|
+
Retrieves an air waybill. | authz_personas=[task_group_coordinator_operators] | () -> (CargoOnFlightAirWaybill1)
|
|
16566
16853
|
|
|
16567
16854
|
</dd>
|
|
16568
16855
|
</dl>
|
|
@@ -16578,21 +16865,7 @@ Creates a booking for a flight task group's cargos: a draft to search and book t
|
|
|
16578
16865
|
<dd>
|
|
16579
16866
|
|
|
16580
16867
|
```typescript
|
|
16581
|
-
await client.shipping.
|
|
16582
|
-
cargo_dimensions: [
|
|
16583
|
-
{
|
|
16584
|
-
height_inches: 1.1,
|
|
16585
|
-
length_inches: 1.1,
|
|
16586
|
-
quantity: 1,
|
|
16587
|
-
weight_per_piece_pounds: 1.1,
|
|
16588
|
-
width_inches: 1.1,
|
|
16589
|
-
},
|
|
16590
|
-
],
|
|
16591
|
-
cargo_ids: ["cargo_ids"],
|
|
16592
|
-
cargo_on_flight_integration: "cargoai",
|
|
16593
|
-
schema_version: 1,
|
|
16594
|
-
task_group_id: "task_group_id",
|
|
16595
|
-
});
|
|
16868
|
+
await client.shipping.cargoOnFlightAirWaybills.getV1("cargo_on_flight_air_waybill_id");
|
|
16596
16869
|
```
|
|
16597
16870
|
|
|
16598
16871
|
</dd>
|
|
@@ -16608,7 +16881,7 @@ await client.shipping.cargoOnFlightBookings.createV1({
|
|
|
16608
16881
|
<dl>
|
|
16609
16882
|
<dd>
|
|
16610
16883
|
|
|
16611
|
-
**
|
|
16884
|
+
**cargoOnFlightAirWaybillId:** `string`
|
|
16612
16885
|
|
|
16613
16886
|
</dd>
|
|
16614
16887
|
</dl>
|
|
@@ -16616,7 +16889,7 @@ await client.shipping.cargoOnFlightBookings.createV1({
|
|
|
16616
16889
|
<dl>
|
|
16617
16890
|
<dd>
|
|
16618
16891
|
|
|
16619
|
-
**requestOptions:** `
|
|
16892
|
+
**requestOptions:** `CargoOnFlightAirWaybills.RequestOptions`
|
|
16620
16893
|
|
|
16621
16894
|
</dd>
|
|
16622
16895
|
</dl>
|
|
@@ -16627,7 +16900,9 @@ await client.shipping.cargoOnFlightBookings.createV1({
|
|
|
16627
16900
|
</dl>
|
|
16628
16901
|
</details>
|
|
16629
16902
|
|
|
16630
|
-
|
|
16903
|
+
## Shipping CargoOnFlightBookingSearches
|
|
16904
|
+
|
|
16905
|
+
<details><summary><code>client.shipping.cargoOnFlightBookingSearches.<a href="/src/api/resources/shipping/resources/cargoOnFlightBookingSearches/client/Client.ts">listV1</a>({ ...params }) -> Chrt.CargoOnFlightBookingSearchListRes</code></summary>
|
|
16631
16906
|
<dl>
|
|
16632
16907
|
<dd>
|
|
16633
16908
|
|
|
@@ -16639,7 +16914,7 @@ await client.shipping.cargoOnFlightBookings.createV1({
|
|
|
16639
16914
|
<dl>
|
|
16640
16915
|
<dd>
|
|
16641
16916
|
|
|
16642
|
-
|
|
16917
|
+
Lists a cargo-on-flight booking's searches with their results. | authz_personas=[task_group_coordinator_operators] | () -> (CargoOnFlightBookingSearchListRes)
|
|
16643
16918
|
|
|
16644
16919
|
</dd>
|
|
16645
16920
|
</dl>
|
|
@@ -16655,7 +16930,15 @@ Deletes a draft booking that was never booked, with its searches. | authz_person
|
|
|
16655
16930
|
<dd>
|
|
16656
16931
|
|
|
16657
16932
|
```typescript
|
|
16658
|
-
await client.shipping.
|
|
16933
|
+
await client.shipping.cargoOnFlightBookingSearches.listV1({
|
|
16934
|
+
cargo_on_flight_booking_id: "cargo_on_flight_booking_id",
|
|
16935
|
+
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
16936
|
+
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
16937
|
+
sort_by: "created_at_timestamp",
|
|
16938
|
+
sort_order: "asc",
|
|
16939
|
+
page: 1,
|
|
16940
|
+
page_size: 1,
|
|
16941
|
+
});
|
|
16659
16942
|
```
|
|
16660
16943
|
|
|
16661
16944
|
</dd>
|
|
@@ -16671,7 +16954,7 @@ await client.shipping.cargoOnFlightBookings.deleteDraftV1("cargo_on_flight_booki
|
|
|
16671
16954
|
<dl>
|
|
16672
16955
|
<dd>
|
|
16673
16956
|
|
|
16674
|
-
**
|
|
16957
|
+
**request:** `Chrt.shipping.CargoOnFlightBookingSearchesListV1Request`
|
|
16675
16958
|
|
|
16676
16959
|
</dd>
|
|
16677
16960
|
</dl>
|
|
@@ -16679,7 +16962,7 @@ await client.shipping.cargoOnFlightBookings.deleteDraftV1("cargo_on_flight_booki
|
|
|
16679
16962
|
<dl>
|
|
16680
16963
|
<dd>
|
|
16681
16964
|
|
|
16682
|
-
**requestOptions:** `
|
|
16965
|
+
**requestOptions:** `CargoOnFlightBookingSearches.RequestOptions`
|
|
16683
16966
|
|
|
16684
16967
|
</dd>
|
|
16685
16968
|
</dl>
|
|
@@ -16690,7 +16973,7 @@ await client.shipping.cargoOnFlightBookings.deleteDraftV1("cargo_on_flight_booki
|
|
|
16690
16973
|
</dl>
|
|
16691
16974
|
</details>
|
|
16692
16975
|
|
|
16693
|
-
<details><summary><code>client.shipping.
|
|
16976
|
+
<details><summary><code>client.shipping.cargoOnFlightBookingSearches.<a href="/src/api/resources/shipping/resources/cargoOnFlightBookingSearches/client/Client.ts">getV1</a>(cargoOnFlightBookingSearchId, { ...params }) -> Chrt.CargoOnFlightBookingSearch1</code></summary>
|
|
16694
16977
|
<dl>
|
|
16695
16978
|
<dd>
|
|
16696
16979
|
|
|
@@ -16702,7 +16985,7 @@ await client.shipping.cargoOnFlightBookings.deleteDraftV1("cargo_on_flight_booki
|
|
|
16702
16985
|
<dl>
|
|
16703
16986
|
<dd>
|
|
16704
16987
|
|
|
16705
|
-
|
|
16988
|
+
Retrieves a cargo-on-flight booking search with its results, optionally filtered and sorted. | authz_personas=[task_group_coordinator_operators] | () -> (CargoOnFlightBookingSearch1)
|
|
16706
16989
|
|
|
16707
16990
|
</dd>
|
|
16708
16991
|
</dl>
|
|
@@ -16718,15 +17001,13 @@ Lists a flight task group's cargo-on-flight bookings, active and history. | auth
|
|
|
16718
17001
|
<dd>
|
|
16719
17002
|
|
|
16720
17003
|
```typescript
|
|
16721
|
-
await client.shipping.
|
|
16722
|
-
|
|
16723
|
-
|
|
16724
|
-
|
|
16725
|
-
|
|
16726
|
-
sort_by: "
|
|
17004
|
+
await client.shipping.cargoOnFlightBookingSearches.getV1("cargo_on_flight_booking_search_id", {
|
|
17005
|
+
filter_bookable: true,
|
|
17006
|
+
filter_awb_required: true,
|
|
17007
|
+
filter_aircraft_body_type: "widebody",
|
|
17008
|
+
filter_currency_code: "filter_currency_code",
|
|
17009
|
+
sort_by: "departure",
|
|
16727
17010
|
sort_order: "asc",
|
|
16728
|
-
page: 1,
|
|
16729
|
-
page_size: 1,
|
|
16730
17011
|
});
|
|
16731
17012
|
```
|
|
16732
17013
|
|
|
@@ -16743,7 +17024,7 @@ await client.shipping.cargoOnFlightBookings.listV1({
|
|
|
16743
17024
|
<dl>
|
|
16744
17025
|
<dd>
|
|
16745
17026
|
|
|
16746
|
-
**
|
|
17027
|
+
**cargoOnFlightBookingSearchId:** `string`
|
|
16747
17028
|
|
|
16748
17029
|
</dd>
|
|
16749
17030
|
</dl>
|
|
@@ -16751,7 +17032,15 @@ await client.shipping.cargoOnFlightBookings.listV1({
|
|
|
16751
17032
|
<dl>
|
|
16752
17033
|
<dd>
|
|
16753
17034
|
|
|
16754
|
-
**
|
|
17035
|
+
**request:** `Chrt.shipping.CargoOnFlightBookingSearchesGetV1Request`
|
|
17036
|
+
|
|
17037
|
+
</dd>
|
|
17038
|
+
</dl>
|
|
17039
|
+
|
|
17040
|
+
<dl>
|
|
17041
|
+
<dd>
|
|
17042
|
+
|
|
17043
|
+
**requestOptions:** `CargoOnFlightBookingSearches.RequestOptions`
|
|
16755
17044
|
|
|
16756
17045
|
</dd>
|
|
16757
17046
|
</dl>
|
|
@@ -16762,7 +17051,9 @@ await client.shipping.cargoOnFlightBookings.listV1({
|
|
|
16762
17051
|
</dl>
|
|
16763
17052
|
</details>
|
|
16764
17053
|
|
|
16765
|
-
|
|
17054
|
+
## Shipping CargoOnFlightBookings
|
|
17055
|
+
|
|
17056
|
+
<details><summary><code>client.shipping.cargoOnFlightBookings.<a href="/src/api/resources/shipping/resources/cargoOnFlightBookings/client/Client.ts">cancelV1</a>(cargoOnFlightBookingId) -> Chrt.CargoOnFlightBooking1</code></summary>
|
|
16766
17057
|
<dl>
|
|
16767
17058
|
<dd>
|
|
16768
17059
|
|
|
@@ -16774,7 +17065,7 @@ await client.shipping.cargoOnFlightBookings.listV1({
|
|
|
16774
17065
|
<dl>
|
|
16775
17066
|
<dd>
|
|
16776
17067
|
|
|
16777
|
-
|
|
17068
|
+
Cancels a MANUAL booking, removing the flights it created from the task group and its AWB from its cargos; an integration booking is cancelled through its integration. | authz_personas=[task_group_coordinator_operators] | () -> (CargoOnFlightBooking1)
|
|
16778
17069
|
|
|
16779
17070
|
</dd>
|
|
16780
17071
|
</dl>
|
|
@@ -16790,7 +17081,7 @@ Retrieves a cargo-on-flight booking. | authz_personas=[task_group_coordinator_op
|
|
|
16790
17081
|
<dd>
|
|
16791
17082
|
|
|
16792
17083
|
```typescript
|
|
16793
|
-
await client.shipping.cargoOnFlightBookings.
|
|
17084
|
+
await client.shipping.cargoOnFlightBookings.cancelV1("cargo_on_flight_booking_id");
|
|
16794
17085
|
```
|
|
16795
17086
|
|
|
16796
17087
|
</dd>
|
|
@@ -16825,72 +17116,7 @@ await client.shipping.cargoOnFlightBookings.getV1("cargo_on_flight_booking_id");
|
|
|
16825
17116
|
</dl>
|
|
16826
17117
|
</details>
|
|
16827
17118
|
|
|
16828
|
-
|
|
16829
|
-
|
|
16830
|
-
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">archiveV1</a>(driverId) -> boolean</code></summary>
|
|
16831
|
-
<dl>
|
|
16832
|
-
<dd>
|
|
16833
|
-
|
|
16834
|
-
#### 📝 Description
|
|
16835
|
-
|
|
16836
|
-
<dl>
|
|
16837
|
-
<dd>
|
|
16838
|
-
|
|
16839
|
-
<dl>
|
|
16840
|
-
<dd>
|
|
16841
|
-
|
|
16842
|
-
Archives a driver after draft, staged, and in-progress assignments are resolved, and denies their open bid threads. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (bool)
|
|
16843
|
-
|
|
16844
|
-
</dd>
|
|
16845
|
-
</dl>
|
|
16846
|
-
</dd>
|
|
16847
|
-
</dl>
|
|
16848
|
-
|
|
16849
|
-
#### 🔌 Usage
|
|
16850
|
-
|
|
16851
|
-
<dl>
|
|
16852
|
-
<dd>
|
|
16853
|
-
|
|
16854
|
-
<dl>
|
|
16855
|
-
<dd>
|
|
16856
|
-
|
|
16857
|
-
```typescript
|
|
16858
|
-
await client.shipping.drivers.archiveV1("driver_id");
|
|
16859
|
-
```
|
|
16860
|
-
|
|
16861
|
-
</dd>
|
|
16862
|
-
</dl>
|
|
16863
|
-
</dd>
|
|
16864
|
-
</dl>
|
|
16865
|
-
|
|
16866
|
-
#### ⚙️ Parameters
|
|
16867
|
-
|
|
16868
|
-
<dl>
|
|
16869
|
-
<dd>
|
|
16870
|
-
|
|
16871
|
-
<dl>
|
|
16872
|
-
<dd>
|
|
16873
|
-
|
|
16874
|
-
**driverId:** `string`
|
|
16875
|
-
|
|
16876
|
-
</dd>
|
|
16877
|
-
</dl>
|
|
16878
|
-
|
|
16879
|
-
<dl>
|
|
16880
|
-
<dd>
|
|
16881
|
-
|
|
16882
|
-
**requestOptions:** `Drivers.RequestOptions`
|
|
16883
|
-
|
|
16884
|
-
</dd>
|
|
16885
|
-
</dl>
|
|
16886
|
-
</dd>
|
|
16887
|
-
</dl>
|
|
16888
|
-
|
|
16889
|
-
</dd>
|
|
16890
|
-
</dl>
|
|
16891
|
-
</details>
|
|
16892
|
-
|
|
16893
|
-
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
17119
|
+
<details><summary><code>client.shipping.cargoOnFlightBookings.<a href="/src/api/resources/shipping/resources/cargoOnFlightBookings/client/Client.ts">createV1</a>({ ...params }) -> Chrt.CargoOnFlightBooking1</code></summary>
|
|
16894
17120
|
<dl>
|
|
16895
17121
|
<dd>
|
|
16896
17122
|
|
|
@@ -16902,7 +17128,7 @@ await client.shipping.drivers.archiveV1("driver_id");
|
|
|
16902
17128
|
<dl>
|
|
16903
17129
|
<dd>
|
|
16904
17130
|
|
|
16905
|
-
Creates a
|
|
17131
|
+
Creates a booking for a flight task group's cargos: a draft to search and book through an integration, or a MANUAL booking placed outside CHRT, confirmed with its AWB and itinerary, which sets the task group's flights and the cargos' AWB. | authz_personas=[task_group_coordinator_operators] | (CargoOnFlightBookingClientCreate1) -> (CargoOnFlightBooking1)
|
|
16906
17132
|
|
|
16907
17133
|
</dd>
|
|
16908
17134
|
</dl>
|
|
@@ -16918,9 +17144,20 @@ Creates a new driver profile for the target user (defaults to caller). Drivers c
|
|
|
16918
17144
|
<dd>
|
|
16919
17145
|
|
|
16920
17146
|
```typescript
|
|
16921
|
-
await client.shipping.
|
|
16922
|
-
|
|
17147
|
+
await client.shipping.cargoOnFlightBookings.createV1({
|
|
17148
|
+
cargo_dimensions: [
|
|
17149
|
+
{
|
|
17150
|
+
height_inches: 1.1,
|
|
17151
|
+
length_inches: 1.1,
|
|
17152
|
+
quantity: 1,
|
|
17153
|
+
weight_per_piece_pounds: 1.1,
|
|
17154
|
+
width_inches: 1.1,
|
|
17155
|
+
},
|
|
17156
|
+
],
|
|
17157
|
+
cargo_ids: ["cargo_ids"],
|
|
17158
|
+
cargo_on_flight_integration: "cargoai",
|
|
16923
17159
|
schema_version: 1,
|
|
17160
|
+
task_group_id: "task_group_id",
|
|
16924
17161
|
});
|
|
16925
17162
|
```
|
|
16926
17163
|
|
|
@@ -16937,7 +17174,7 @@ await client.shipping.drivers.createV1({
|
|
|
16937
17174
|
<dl>
|
|
16938
17175
|
<dd>
|
|
16939
17176
|
|
|
16940
|
-
**request:** `Chrt.shipping.
|
|
17177
|
+
**request:** `Chrt.shipping.CargoOnFlightBookingClientCreate1`
|
|
16941
17178
|
|
|
16942
17179
|
</dd>
|
|
16943
17180
|
</dl>
|
|
@@ -16945,7 +17182,7 @@ await client.shipping.drivers.createV1({
|
|
|
16945
17182
|
<dl>
|
|
16946
17183
|
<dd>
|
|
16947
17184
|
|
|
16948
|
-
**requestOptions:** `
|
|
17185
|
+
**requestOptions:** `CargoOnFlightBookings.RequestOptions`
|
|
16949
17186
|
|
|
16950
17187
|
</dd>
|
|
16951
17188
|
</dl>
|
|
@@ -16956,7 +17193,7 @@ await client.shipping.drivers.createV1({
|
|
|
16956
17193
|
</dl>
|
|
16957
17194
|
</details>
|
|
16958
17195
|
|
|
16959
|
-
<details><summary><code>client.shipping.
|
|
17196
|
+
<details><summary><code>client.shipping.cargoOnFlightBookings.<a href="/src/api/resources/shipping/resources/cargoOnFlightBookings/client/Client.ts">deleteDraftV1</a>(cargoOnFlightBookingId) -> boolean</code></summary>
|
|
16960
17197
|
<dl>
|
|
16961
17198
|
<dd>
|
|
16962
17199
|
|
|
@@ -16968,7 +17205,7 @@ await client.shipping.drivers.createV1({
|
|
|
16968
17205
|
<dl>
|
|
16969
17206
|
<dd>
|
|
16970
17207
|
|
|
16971
|
-
|
|
17208
|
+
Deletes a draft booking that was never booked, with its searches. | authz_personas=[task_group_coordinator_operators] | () -> (bool)
|
|
16972
17209
|
|
|
16973
17210
|
</dd>
|
|
16974
17211
|
</dl>
|
|
@@ -16984,7 +17221,7 @@ Retrieves driver information for the caller within their organization. | () -> (
|
|
|
16984
17221
|
<dd>
|
|
16985
17222
|
|
|
16986
17223
|
```typescript
|
|
16987
|
-
await client.shipping.
|
|
17224
|
+
await client.shipping.cargoOnFlightBookings.deleteDraftV1("cargo_on_flight_booking_id");
|
|
16988
17225
|
```
|
|
16989
17226
|
|
|
16990
17227
|
</dd>
|
|
@@ -17000,62 +17237,15 @@ await client.shipping.drivers.getForCallerV1();
|
|
|
17000
17237
|
<dl>
|
|
17001
17238
|
<dd>
|
|
17002
17239
|
|
|
17003
|
-
**
|
|
17004
|
-
|
|
17005
|
-
</dd>
|
|
17006
|
-
</dl>
|
|
17007
|
-
</dd>
|
|
17008
|
-
</dl>
|
|
17009
|
-
|
|
17010
|
-
</dd>
|
|
17011
|
-
</dl>
|
|
17012
|
-
</details>
|
|
17013
|
-
|
|
17014
|
-
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">clearLastSeenV1</a>() -> boolean</code></summary>
|
|
17015
|
-
<dl>
|
|
17016
|
-
<dd>
|
|
17017
|
-
|
|
17018
|
-
#### 📝 Description
|
|
17019
|
-
|
|
17020
|
-
<dl>
|
|
17021
|
-
<dd>
|
|
17022
|
-
|
|
17023
|
-
<dl>
|
|
17024
|
-
<dd>
|
|
17025
|
-
|
|
17026
|
-
Clears the driver's last known location and timestamp. | () -> (bool)
|
|
17027
|
-
|
|
17028
|
-
</dd>
|
|
17029
|
-
</dl>
|
|
17030
|
-
</dd>
|
|
17031
|
-
</dl>
|
|
17032
|
-
|
|
17033
|
-
#### 🔌 Usage
|
|
17034
|
-
|
|
17035
|
-
<dl>
|
|
17036
|
-
<dd>
|
|
17037
|
-
|
|
17038
|
-
<dl>
|
|
17039
|
-
<dd>
|
|
17040
|
-
|
|
17041
|
-
```typescript
|
|
17042
|
-
await client.shipping.drivers.clearLastSeenV1();
|
|
17043
|
-
```
|
|
17240
|
+
**cargoOnFlightBookingId:** `string`
|
|
17044
17241
|
|
|
17045
17242
|
</dd>
|
|
17046
17243
|
</dl>
|
|
17047
|
-
</dd>
|
|
17048
|
-
</dl>
|
|
17049
|
-
|
|
17050
|
-
#### ⚙️ Parameters
|
|
17051
17244
|
|
|
17052
17245
|
<dl>
|
|
17053
17246
|
<dd>
|
|
17054
17247
|
|
|
17055
|
-
|
|
17056
|
-
<dd>
|
|
17057
|
-
|
|
17058
|
-
**requestOptions:** `Drivers.RequestOptions`
|
|
17248
|
+
**requestOptions:** `CargoOnFlightBookings.RequestOptions`
|
|
17059
17249
|
|
|
17060
17250
|
</dd>
|
|
17061
17251
|
</dl>
|
|
@@ -17066,7 +17256,7 @@ await client.shipping.drivers.clearLastSeenV1();
|
|
|
17066
17256
|
</dl>
|
|
17067
17257
|
</details>
|
|
17068
17258
|
|
|
17069
|
-
<details><summary><code>client.shipping.
|
|
17259
|
+
<details><summary><code>client.shipping.cargoOnFlightBookings.<a href="/src/api/resources/shipping/resources/cargoOnFlightBookings/client/Client.ts">listV1</a>({ ...params }) -> Chrt.CargoOnFlightBookingListRes</code></summary>
|
|
17070
17260
|
<dl>
|
|
17071
17261
|
<dd>
|
|
17072
17262
|
|
|
@@ -17078,7 +17268,7 @@ await client.shipping.drivers.clearLastSeenV1();
|
|
|
17078
17268
|
<dl>
|
|
17079
17269
|
<dd>
|
|
17080
17270
|
|
|
17081
|
-
Lists
|
|
17271
|
+
Lists a flight task group's cargo-on-flight bookings, active and history. | authz_personas=[task_group_coordinator_operators] | () -> (CargoOnFlightBookingListRes)
|
|
17082
17272
|
|
|
17083
17273
|
</dd>
|
|
17084
17274
|
</dl>
|
|
@@ -17094,19 +17284,15 @@ Lists all drivers belonging to the caller's organization with filtering, sorting
|
|
|
17094
17284
|
<dd>
|
|
17095
17285
|
|
|
17096
17286
|
```typescript
|
|
17097
|
-
await client.shipping.
|
|
17287
|
+
await client.shipping.cargoOnFlightBookings.listV1({
|
|
17288
|
+
task_group_id: "task_group_id",
|
|
17289
|
+
filter_status: ["draft"],
|
|
17290
|
+
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
17291
|
+
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
17292
|
+
sort_by: "draft_started_at_timestamp",
|
|
17098
17293
|
sort_order: "asc",
|
|
17099
17294
|
page: 1,
|
|
17100
17295
|
page_size: 1,
|
|
17101
|
-
search: "search",
|
|
17102
|
-
filter_driver_ids: ["filter_driver_ids"],
|
|
17103
|
-
filter_waiting: true,
|
|
17104
|
-
filter_auto_assign_enabled: true,
|
|
17105
|
-
filter_vehicle_type: ["sedan"],
|
|
17106
|
-
filter_archived: true,
|
|
17107
|
-
filter_available_according_to_driver: true,
|
|
17108
|
-
filter_available_according_to_operators: true,
|
|
17109
|
-
filter_status: ["unassigned"],
|
|
17110
17296
|
});
|
|
17111
17297
|
```
|
|
17112
17298
|
|
|
@@ -17123,7 +17309,7 @@ await client.shipping.drivers.listV1({
|
|
|
17123
17309
|
<dl>
|
|
17124
17310
|
<dd>
|
|
17125
17311
|
|
|
17126
|
-
**request:** `Chrt.shipping.
|
|
17312
|
+
**request:** `Chrt.shipping.CargoOnFlightBookingsListV1Request`
|
|
17127
17313
|
|
|
17128
17314
|
</dd>
|
|
17129
17315
|
</dl>
|
|
@@ -17131,7 +17317,7 @@ await client.shipping.drivers.listV1({
|
|
|
17131
17317
|
<dl>
|
|
17132
17318
|
<dd>
|
|
17133
17319
|
|
|
17134
|
-
**requestOptions:** `
|
|
17320
|
+
**requestOptions:** `CargoOnFlightBookings.RequestOptions`
|
|
17135
17321
|
|
|
17136
17322
|
</dd>
|
|
17137
17323
|
</dl>
|
|
@@ -17142,7 +17328,7 @@ await client.shipping.drivers.listV1({
|
|
|
17142
17328
|
</dl>
|
|
17143
17329
|
</details>
|
|
17144
17330
|
|
|
17145
|
-
<details><summary><code>client.shipping.
|
|
17331
|
+
<details><summary><code>client.shipping.cargoOnFlightBookings.<a href="/src/api/resources/shipping/resources/cargoOnFlightBookings/client/Client.ts">getV1</a>(cargoOnFlightBookingId) -> Chrt.CargoOnFlightBooking1</code></summary>
|
|
17146
17332
|
<dl>
|
|
17147
17333
|
<dd>
|
|
17148
17334
|
|
|
@@ -17154,7 +17340,7 @@ await client.shipping.drivers.listV1({
|
|
|
17154
17340
|
<dl>
|
|
17155
17341
|
<dd>
|
|
17156
17342
|
|
|
17157
|
-
|
|
17343
|
+
Retrieves a cargo-on-flight booking. | authz_personas=[task_group_coordinator_operators] | () -> (CargoOnFlightBooking1)
|
|
17158
17344
|
|
|
17159
17345
|
</dd>
|
|
17160
17346
|
</dl>
|
|
@@ -17170,18 +17356,7 @@ Lists all organization members paired with their driver information if they are
|
|
|
17170
17356
|
<dd>
|
|
17171
17357
|
|
|
17172
17358
|
```typescript
|
|
17173
|
-
await client.shipping.
|
|
17174
|
-
filter_user_ids: ["filter_user_ids"],
|
|
17175
|
-
search: "search",
|
|
17176
|
-
filter_archived: true,
|
|
17177
|
-
filter_role: ["owner"],
|
|
17178
|
-
filter_available_according_to_driver: true,
|
|
17179
|
-
filter_available_according_to_operators: true,
|
|
17180
|
-
sort_by: "first_name",
|
|
17181
|
-
sort_order: "asc",
|
|
17182
|
-
page: 1,
|
|
17183
|
-
page_size: 1,
|
|
17184
|
-
});
|
|
17359
|
+
await client.shipping.cargoOnFlightBookings.getV1("cargo_on_flight_booking_id");
|
|
17185
17360
|
```
|
|
17186
17361
|
|
|
17187
17362
|
</dd>
|
|
@@ -17197,7 +17372,7 @@ await client.shipping.drivers.listOrgMembersAndDriversV1({
|
|
|
17197
17372
|
<dl>
|
|
17198
17373
|
<dd>
|
|
17199
17374
|
|
|
17200
|
-
**
|
|
17375
|
+
**cargoOnFlightBookingId:** `string`
|
|
17201
17376
|
|
|
17202
17377
|
</dd>
|
|
17203
17378
|
</dl>
|
|
@@ -17205,7 +17380,7 @@ await client.shipping.drivers.listOrgMembersAndDriversV1({
|
|
|
17205
17380
|
<dl>
|
|
17206
17381
|
<dd>
|
|
17207
17382
|
|
|
17208
|
-
**requestOptions:** `
|
|
17383
|
+
**requestOptions:** `CargoOnFlightBookings.RequestOptions`
|
|
17209
17384
|
|
|
17210
17385
|
</dd>
|
|
17211
17386
|
</dl>
|
|
@@ -17216,7 +17391,9 @@ await client.shipping.drivers.listOrgMembersAndDriversV1({
|
|
|
17216
17391
|
</dl>
|
|
17217
17392
|
</details>
|
|
17218
17393
|
|
|
17219
|
-
|
|
17394
|
+
## Shipping CargoOnFlightHouseAirWaybills
|
|
17395
|
+
|
|
17396
|
+
<details><summary><code>client.shipping.cargoOnFlightHouseAirWaybills.<a href="/src/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/client/Client.ts">createV1</a>({ ...params }) -> Chrt.CargoOnFlightHouseAirWaybill1</code></summary>
|
|
17220
17397
|
<dl>
|
|
17221
17398
|
<dd>
|
|
17222
17399
|
|
|
@@ -17228,7 +17405,7 @@ await client.shipping.drivers.listOrgMembersAndDriversV1({
|
|
|
17228
17405
|
<dl>
|
|
17229
17406
|
<dd>
|
|
17230
17407
|
|
|
17231
|
-
|
|
17408
|
+
Adds a house air waybill to an air waybill's consolidation, sent to the airline in its FHL. | authz_personas=[task_group_coordinator_operators] | (CargoOnFlightHouseAirWaybillClientCreate1) -> (CargoOnFlightHouseAirWaybill1)
|
|
17232
17409
|
|
|
17233
17410
|
</dd>
|
|
17234
17411
|
</dl>
|
|
@@ -17244,9 +17421,14 @@ Creates a driver's self-reported hours worked and miles driven for a single cale
|
|
|
17244
17421
|
<dd>
|
|
17245
17422
|
|
|
17246
17423
|
```typescript
|
|
17247
|
-
await client.shipping.
|
|
17248
|
-
|
|
17249
|
-
|
|
17424
|
+
await client.shipping.cargoOnFlightHouseAirWaybills.createV1({
|
|
17425
|
+
cargo_on_flight_air_waybill_id: "cargo_on_flight_air_waybill_id",
|
|
17426
|
+
destination_iata: "destination_iata",
|
|
17427
|
+
gross_weight_kilograms: 1.1,
|
|
17428
|
+
house_air_waybill_number: "house_air_waybill_number",
|
|
17429
|
+
manifest_description_of_goods: "manifest_description_of_goods",
|
|
17430
|
+
number_of_pieces: 1,
|
|
17431
|
+
origin_iata: "origin_iata",
|
|
17250
17432
|
schema_version: 1,
|
|
17251
17433
|
});
|
|
17252
17434
|
```
|
|
@@ -17264,7 +17446,7 @@ await client.shipping.drivers.createSelfReportedHoursAndMileageV1({
|
|
|
17264
17446
|
<dl>
|
|
17265
17447
|
<dd>
|
|
17266
17448
|
|
|
17267
|
-
**request:** `Chrt.shipping.
|
|
17449
|
+
**request:** `Chrt.shipping.CargoOnFlightHouseAirWaybillClientCreate1`
|
|
17268
17450
|
|
|
17269
17451
|
</dd>
|
|
17270
17452
|
</dl>
|
|
@@ -17272,7 +17454,7 @@ await client.shipping.drivers.createSelfReportedHoursAndMileageV1({
|
|
|
17272
17454
|
<dl>
|
|
17273
17455
|
<dd>
|
|
17274
17456
|
|
|
17275
|
-
**requestOptions:** `
|
|
17457
|
+
**requestOptions:** `CargoOnFlightHouseAirWaybills.RequestOptions`
|
|
17276
17458
|
|
|
17277
17459
|
</dd>
|
|
17278
17460
|
</dl>
|
|
@@ -17283,7 +17465,7 @@ await client.shipping.drivers.createSelfReportedHoursAndMileageV1({
|
|
|
17283
17465
|
</dl>
|
|
17284
17466
|
</details>
|
|
17285
17467
|
|
|
17286
|
-
<details><summary><code>client.shipping.
|
|
17468
|
+
<details><summary><code>client.shipping.cargoOnFlightHouseAirWaybills.<a href="/src/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/client/Client.ts">deleteV1</a>(cargoOnFlightHouseAirWaybillId) -> boolean</code></summary>
|
|
17287
17469
|
<dl>
|
|
17288
17470
|
<dd>
|
|
17289
17471
|
|
|
@@ -17295,7 +17477,7 @@ await client.shipping.drivers.createSelfReportedHoursAndMileageV1({
|
|
|
17295
17477
|
<dl>
|
|
17296
17478
|
<dd>
|
|
17297
17479
|
|
|
17298
|
-
|
|
17480
|
+
Deletes a house air waybill that has never been sent to the airline. | authz_personas=[task_group_coordinator_operators] | () -> (bool)
|
|
17299
17481
|
|
|
17300
17482
|
</dd>
|
|
17301
17483
|
</dl>
|
|
@@ -17311,7 +17493,7 @@ Permanently deletes a driver's self-report for a calendar day. Caller must be th
|
|
|
17311
17493
|
<dd>
|
|
17312
17494
|
|
|
17313
17495
|
```typescript
|
|
17314
|
-
await client.shipping.
|
|
17496
|
+
await client.shipping.cargoOnFlightHouseAirWaybills.deleteV1("cargo_on_flight_house_air_waybill_id");
|
|
17315
17497
|
```
|
|
17316
17498
|
|
|
17317
17499
|
</dd>
|
|
@@ -17327,7 +17509,7 @@ await client.shipping.drivers.deleteSelfReportedHoursAndMileageV1("driver_id", "
|
|
|
17327
17509
|
<dl>
|
|
17328
17510
|
<dd>
|
|
17329
17511
|
|
|
17330
|
-
**
|
|
17512
|
+
**cargoOnFlightHouseAirWaybillId:** `string`
|
|
17331
17513
|
|
|
17332
17514
|
</dd>
|
|
17333
17515
|
</dl>
|
|
@@ -17335,15 +17517,7 @@ await client.shipping.drivers.deleteSelfReportedHoursAndMileageV1("driver_id", "
|
|
|
17335
17517
|
<dl>
|
|
17336
17518
|
<dd>
|
|
17337
17519
|
|
|
17338
|
-
**
|
|
17339
|
-
|
|
17340
|
-
</dd>
|
|
17341
|
-
</dl>
|
|
17342
|
-
|
|
17343
|
-
<dl>
|
|
17344
|
-
<dd>
|
|
17345
|
-
|
|
17346
|
-
**requestOptions:** `Drivers.RequestOptions`
|
|
17520
|
+
**requestOptions:** `CargoOnFlightHouseAirWaybills.RequestOptions`
|
|
17347
17521
|
|
|
17348
17522
|
</dd>
|
|
17349
17523
|
</dl>
|
|
@@ -17354,7 +17528,7 @@ await client.shipping.drivers.deleteSelfReportedHoursAndMileageV1("driver_id", "
|
|
|
17354
17528
|
</dl>
|
|
17355
17529
|
</details>
|
|
17356
17530
|
|
|
17357
|
-
<details><summary><code>client.shipping.
|
|
17531
|
+
<details><summary><code>client.shipping.cargoOnFlightHouseAirWaybills.<a href="/src/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/client/Client.ts">listV1</a>({ ...params }) -> Chrt.CargoOnFlightHouseAirWaybillListRes</code></summary>
|
|
17358
17532
|
<dl>
|
|
17359
17533
|
<dd>
|
|
17360
17534
|
|
|
@@ -17366,7 +17540,7 @@ await client.shipping.drivers.deleteSelfReportedHoursAndMileageV1("driver_id", "
|
|
|
17366
17540
|
<dl>
|
|
17367
17541
|
<dd>
|
|
17368
17542
|
|
|
17369
|
-
|
|
17543
|
+
Lists the house air waybills consolidated under an air waybill. | authz_personas=[task_group_coordinator_operators] | () -> (CargoOnFlightHouseAirWaybillListRes)
|
|
17370
17544
|
|
|
17371
17545
|
</dd>
|
|
17372
17546
|
</dl>
|
|
@@ -17382,7 +17556,13 @@ Retrieves a driver's self-report for a single calendar day. Caller must be the d
|
|
|
17382
17556
|
<dd>
|
|
17383
17557
|
|
|
17384
17558
|
```typescript
|
|
17385
|
-
await client.shipping.
|
|
17559
|
+
await client.shipping.cargoOnFlightHouseAirWaybills.listV1({
|
|
17560
|
+
cargo_on_flight_air_waybill_id: "cargo_on_flight_air_waybill_id",
|
|
17561
|
+
sort_by: "created_at_timestamp",
|
|
17562
|
+
sort_order: "asc",
|
|
17563
|
+
page: 1,
|
|
17564
|
+
page_size: 1,
|
|
17565
|
+
});
|
|
17386
17566
|
```
|
|
17387
17567
|
|
|
17388
17568
|
</dd>
|
|
@@ -17398,15 +17578,7 @@ await client.shipping.drivers.getSelfReportedHoursAndMileageV1("driver_id", "rep
|
|
|
17398
17578
|
<dl>
|
|
17399
17579
|
<dd>
|
|
17400
17580
|
|
|
17401
|
-
**
|
|
17402
|
-
|
|
17403
|
-
</dd>
|
|
17404
|
-
</dl>
|
|
17405
|
-
|
|
17406
|
-
<dl>
|
|
17407
|
-
<dd>
|
|
17408
|
-
|
|
17409
|
-
**reportDate:** `string`
|
|
17581
|
+
**request:** `Chrt.shipping.CargoOnFlightHouseAirWaybillsListV1Request`
|
|
17410
17582
|
|
|
17411
17583
|
</dd>
|
|
17412
17584
|
</dl>
|
|
@@ -17414,7 +17586,7 @@ await client.shipping.drivers.getSelfReportedHoursAndMileageV1("driver_id", "rep
|
|
|
17414
17586
|
<dl>
|
|
17415
17587
|
<dd>
|
|
17416
17588
|
|
|
17417
|
-
**requestOptions:** `
|
|
17589
|
+
**requestOptions:** `CargoOnFlightHouseAirWaybills.RequestOptions`
|
|
17418
17590
|
|
|
17419
17591
|
</dd>
|
|
17420
17592
|
</dl>
|
|
@@ -17425,7 +17597,7 @@ await client.shipping.drivers.getSelfReportedHoursAndMileageV1("driver_id", "rep
|
|
|
17425
17597
|
</dl>
|
|
17426
17598
|
</details>
|
|
17427
17599
|
|
|
17428
|
-
<details><summary><code>client.shipping.
|
|
17600
|
+
<details><summary><code>client.shipping.cargoOnFlightHouseAirWaybills.<a href="/src/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/client/Client.ts">updateV1</a>(cargoOnFlightHouseAirWaybillId, { ...params }) -> Chrt.CargoOnFlightHouseAirWaybill1</code></summary>
|
|
17429
17601
|
<dl>
|
|
17430
17602
|
<dd>
|
|
17431
17603
|
|
|
@@ -17437,7 +17609,7 @@ await client.shipping.drivers.getSelfReportedHoursAndMileageV1("driver_id", "rep
|
|
|
17437
17609
|
<dl>
|
|
17438
17610
|
<dd>
|
|
17439
17611
|
|
|
17440
|
-
|
|
17612
|
+
Updates a house air waybill, all but its number; one already sent is replaced at the airline only when it is sent again. | authz_personas=[task_group_coordinator_operators] | (CargoOnFlightHouseAirWaybillClientUpdate1) -> (CargoOnFlightHouseAirWaybill1)
|
|
17441
17613
|
|
|
17442
17614
|
</dd>
|
|
17443
17615
|
</dl>
|
|
@@ -17453,13 +17625,7 @@ Lists a driver's self-reports across an optional date range with sorting and pag
|
|
|
17453
17625
|
<dd>
|
|
17454
17626
|
|
|
17455
17627
|
```typescript
|
|
17456
|
-
await client.shipping.
|
|
17457
|
-
filter_start_date: "filter_start_date",
|
|
17458
|
-
filter_end_date: "filter_end_date",
|
|
17459
|
-
sort_order: "asc",
|
|
17460
|
-
page: 1,
|
|
17461
|
-
page_size: 1,
|
|
17462
|
-
});
|
|
17628
|
+
await client.shipping.cargoOnFlightHouseAirWaybills.updateV1("cargo_on_flight_house_air_waybill_id");
|
|
17463
17629
|
```
|
|
17464
17630
|
|
|
17465
17631
|
</dd>
|
|
@@ -17475,7 +17641,7 @@ await client.shipping.drivers.listSelfReportedHoursAndMileageV1("driver_id", {
|
|
|
17475
17641
|
<dl>
|
|
17476
17642
|
<dd>
|
|
17477
17643
|
|
|
17478
|
-
**
|
|
17644
|
+
**cargoOnFlightHouseAirWaybillId:** `string`
|
|
17479
17645
|
|
|
17480
17646
|
</dd>
|
|
17481
17647
|
</dl>
|
|
@@ -17483,7 +17649,7 @@ await client.shipping.drivers.listSelfReportedHoursAndMileageV1("driver_id", {
|
|
|
17483
17649
|
<dl>
|
|
17484
17650
|
<dd>
|
|
17485
17651
|
|
|
17486
|
-
**request:** `Chrt.shipping.
|
|
17652
|
+
**request:** `Chrt.shipping.CargoOnFlightHouseAirWaybillClientUpdate1`
|
|
17487
17653
|
|
|
17488
17654
|
</dd>
|
|
17489
17655
|
</dl>
|
|
@@ -17491,7 +17657,7 @@ await client.shipping.drivers.listSelfReportedHoursAndMileageV1("driver_id", {
|
|
|
17491
17657
|
<dl>
|
|
17492
17658
|
<dd>
|
|
17493
17659
|
|
|
17494
|
-
**requestOptions:** `
|
|
17660
|
+
**requestOptions:** `CargoOnFlightHouseAirWaybills.RequestOptions`
|
|
17495
17661
|
|
|
17496
17662
|
</dd>
|
|
17497
17663
|
</dl>
|
|
@@ -17502,7 +17668,7 @@ await client.shipping.drivers.listSelfReportedHoursAndMileageV1("driver_id", {
|
|
|
17502
17668
|
</dl>
|
|
17503
17669
|
</details>
|
|
17504
17670
|
|
|
17505
|
-
<details><summary><code>client.shipping.
|
|
17671
|
+
<details><summary><code>client.shipping.cargoOnFlightHouseAirWaybills.<a href="/src/api/resources/shipping/resources/cargoOnFlightHouseAirWaybills/client/Client.ts">getV1</a>(cargoOnFlightHouseAirWaybillId) -> Chrt.CargoOnFlightHouseAirWaybill1</code></summary>
|
|
17506
17672
|
<dl>
|
|
17507
17673
|
<dd>
|
|
17508
17674
|
|
|
@@ -17514,7 +17680,7 @@ await client.shipping.drivers.listSelfReportedHoursAndMileageV1("driver_id", {
|
|
|
17514
17680
|
<dl>
|
|
17515
17681
|
<dd>
|
|
17516
17682
|
|
|
17517
|
-
|
|
17683
|
+
Retrieves a house air waybill. | authz_personas=[task_group_coordinator_operators] | () -> (CargoOnFlightHouseAirWaybill1)
|
|
17518
17684
|
|
|
17519
17685
|
</dd>
|
|
17520
17686
|
</dl>
|
|
@@ -17530,15 +17696,7 @@ Lists all drivers' self-reports in the caller's org with date-range filtering, s
|
|
|
17530
17696
|
<dd>
|
|
17531
17697
|
|
|
17532
17698
|
```typescript
|
|
17533
|
-
await client.shipping.
|
|
17534
|
-
filter_driver_id: "filter_driver_id",
|
|
17535
|
-
filter_start_date: "filter_start_date",
|
|
17536
|
-
filter_end_date: "filter_end_date",
|
|
17537
|
-
sort_by: "date",
|
|
17538
|
-
sort_order: "asc",
|
|
17539
|
-
page: 1,
|
|
17540
|
-
page_size: 1,
|
|
17541
|
-
});
|
|
17699
|
+
await client.shipping.cargoOnFlightHouseAirWaybills.getV1("cargo_on_flight_house_air_waybill_id");
|
|
17542
17700
|
```
|
|
17543
17701
|
|
|
17544
17702
|
</dd>
|
|
@@ -17554,7 +17712,7 @@ await client.shipping.drivers.orgListSelfReportedHoursAndMileageV1({
|
|
|
17554
17712
|
<dl>
|
|
17555
17713
|
<dd>
|
|
17556
17714
|
|
|
17557
|
-
**
|
|
17715
|
+
**cargoOnFlightHouseAirWaybillId:** `string`
|
|
17558
17716
|
|
|
17559
17717
|
</dd>
|
|
17560
17718
|
</dl>
|
|
@@ -17562,7 +17720,7 @@ await client.shipping.drivers.orgListSelfReportedHoursAndMileageV1({
|
|
|
17562
17720
|
<dl>
|
|
17563
17721
|
<dd>
|
|
17564
17722
|
|
|
17565
|
-
**requestOptions:** `
|
|
17723
|
+
**requestOptions:** `CargoOnFlightHouseAirWaybills.RequestOptions`
|
|
17566
17724
|
|
|
17567
17725
|
</dd>
|
|
17568
17726
|
</dl>
|
|
@@ -17573,7 +17731,9 @@ await client.shipping.drivers.orgListSelfReportedHoursAndMileageV1({
|
|
|
17573
17731
|
</dl>
|
|
17574
17732
|
</details>
|
|
17575
17733
|
|
|
17576
|
-
|
|
17734
|
+
## Shipping Drivers
|
|
17735
|
+
|
|
17736
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">archiveV1</a>(driverId) -> boolean</code></summary>
|
|
17577
17737
|
<dl>
|
|
17578
17738
|
<dd>
|
|
17579
17739
|
|
|
@@ -17585,7 +17745,7 @@ await client.shipping.drivers.orgListSelfReportedHoursAndMileageV1({
|
|
|
17585
17745
|
<dl>
|
|
17586
17746
|
<dd>
|
|
17587
17747
|
|
|
17588
|
-
|
|
17748
|
+
Archives a driver after draft, staged, and in-progress assignments are resolved, and denies their open bid threads. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (bool)
|
|
17589
17749
|
|
|
17590
17750
|
</dd>
|
|
17591
17751
|
</dl>
|
|
@@ -17601,7 +17761,753 @@ Partially updates a driver's self-reported hours worked and/or miles driven for
|
|
|
17601
17761
|
<dd>
|
|
17602
17762
|
|
|
17603
17763
|
```typescript
|
|
17604
|
-
await client.shipping.drivers.
|
|
17764
|
+
await client.shipping.drivers.archiveV1("driver_id");
|
|
17765
|
+
```
|
|
17766
|
+
|
|
17767
|
+
</dd>
|
|
17768
|
+
</dl>
|
|
17769
|
+
</dd>
|
|
17770
|
+
</dl>
|
|
17771
|
+
|
|
17772
|
+
#### ⚙️ Parameters
|
|
17773
|
+
|
|
17774
|
+
<dl>
|
|
17775
|
+
<dd>
|
|
17776
|
+
|
|
17777
|
+
<dl>
|
|
17778
|
+
<dd>
|
|
17779
|
+
|
|
17780
|
+
**driverId:** `string`
|
|
17781
|
+
|
|
17782
|
+
</dd>
|
|
17783
|
+
</dl>
|
|
17784
|
+
|
|
17785
|
+
<dl>
|
|
17786
|
+
<dd>
|
|
17787
|
+
|
|
17788
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
17789
|
+
|
|
17790
|
+
</dd>
|
|
17791
|
+
</dl>
|
|
17792
|
+
</dd>
|
|
17793
|
+
</dl>
|
|
17794
|
+
|
|
17795
|
+
</dd>
|
|
17796
|
+
</dl>
|
|
17797
|
+
</details>
|
|
17798
|
+
|
|
17799
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
17800
|
+
<dl>
|
|
17801
|
+
<dd>
|
|
17802
|
+
|
|
17803
|
+
#### 📝 Description
|
|
17804
|
+
|
|
17805
|
+
<dl>
|
|
17806
|
+
<dd>
|
|
17807
|
+
|
|
17808
|
+
<dl>
|
|
17809
|
+
<dd>
|
|
17810
|
+
|
|
17811
|
+
Creates a new driver profile for the target user (defaults to caller). Drivers can create themselves; operators+ can create any org member. Provider orgs only. | (DriverClientCreate1) -> (PydanticObjectId)
|
|
17812
|
+
|
|
17813
|
+
</dd>
|
|
17814
|
+
</dl>
|
|
17815
|
+
</dd>
|
|
17816
|
+
</dl>
|
|
17817
|
+
|
|
17818
|
+
#### 🔌 Usage
|
|
17819
|
+
|
|
17820
|
+
<dl>
|
|
17821
|
+
<dd>
|
|
17822
|
+
|
|
17823
|
+
<dl>
|
|
17824
|
+
<dd>
|
|
17825
|
+
|
|
17826
|
+
```typescript
|
|
17827
|
+
await client.shipping.drivers.createV1({
|
|
17828
|
+
target_user_id: "target_user_id",
|
|
17829
|
+
schema_version: 1,
|
|
17830
|
+
});
|
|
17831
|
+
```
|
|
17832
|
+
|
|
17833
|
+
</dd>
|
|
17834
|
+
</dl>
|
|
17835
|
+
</dd>
|
|
17836
|
+
</dl>
|
|
17837
|
+
|
|
17838
|
+
#### ⚙️ Parameters
|
|
17839
|
+
|
|
17840
|
+
<dl>
|
|
17841
|
+
<dd>
|
|
17842
|
+
|
|
17843
|
+
<dl>
|
|
17844
|
+
<dd>
|
|
17845
|
+
|
|
17846
|
+
**request:** `Chrt.shipping.DriverClientCreate1`
|
|
17847
|
+
|
|
17848
|
+
</dd>
|
|
17849
|
+
</dl>
|
|
17850
|
+
|
|
17851
|
+
<dl>
|
|
17852
|
+
<dd>
|
|
17853
|
+
|
|
17854
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
17855
|
+
|
|
17856
|
+
</dd>
|
|
17857
|
+
</dl>
|
|
17858
|
+
</dd>
|
|
17859
|
+
</dl>
|
|
17860
|
+
|
|
17861
|
+
</dd>
|
|
17862
|
+
</dl>
|
|
17863
|
+
</details>
|
|
17864
|
+
|
|
17865
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">getForCallerV1</a>() -> Chrt.DriverWithActiveTaskGroupIds1</code></summary>
|
|
17866
|
+
<dl>
|
|
17867
|
+
<dd>
|
|
17868
|
+
|
|
17869
|
+
#### 📝 Description
|
|
17870
|
+
|
|
17871
|
+
<dl>
|
|
17872
|
+
<dd>
|
|
17873
|
+
|
|
17874
|
+
<dl>
|
|
17875
|
+
<dd>
|
|
17876
|
+
|
|
17877
|
+
Retrieves driver information for the caller within their organization. | () -> (DriverWithActiveTaskGroupIds1)
|
|
17878
|
+
|
|
17879
|
+
</dd>
|
|
17880
|
+
</dl>
|
|
17881
|
+
</dd>
|
|
17882
|
+
</dl>
|
|
17883
|
+
|
|
17884
|
+
#### 🔌 Usage
|
|
17885
|
+
|
|
17886
|
+
<dl>
|
|
17887
|
+
<dd>
|
|
17888
|
+
|
|
17889
|
+
<dl>
|
|
17890
|
+
<dd>
|
|
17891
|
+
|
|
17892
|
+
```typescript
|
|
17893
|
+
await client.shipping.drivers.getForCallerV1();
|
|
17894
|
+
```
|
|
17895
|
+
|
|
17896
|
+
</dd>
|
|
17897
|
+
</dl>
|
|
17898
|
+
</dd>
|
|
17899
|
+
</dl>
|
|
17900
|
+
|
|
17901
|
+
#### ⚙️ Parameters
|
|
17902
|
+
|
|
17903
|
+
<dl>
|
|
17904
|
+
<dd>
|
|
17905
|
+
|
|
17906
|
+
<dl>
|
|
17907
|
+
<dd>
|
|
17908
|
+
|
|
17909
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
17910
|
+
|
|
17911
|
+
</dd>
|
|
17912
|
+
</dl>
|
|
17913
|
+
</dd>
|
|
17914
|
+
</dl>
|
|
17915
|
+
|
|
17916
|
+
</dd>
|
|
17917
|
+
</dl>
|
|
17918
|
+
</details>
|
|
17919
|
+
|
|
17920
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">clearLastSeenV1</a>() -> boolean</code></summary>
|
|
17921
|
+
<dl>
|
|
17922
|
+
<dd>
|
|
17923
|
+
|
|
17924
|
+
#### 📝 Description
|
|
17925
|
+
|
|
17926
|
+
<dl>
|
|
17927
|
+
<dd>
|
|
17928
|
+
|
|
17929
|
+
<dl>
|
|
17930
|
+
<dd>
|
|
17931
|
+
|
|
17932
|
+
Clears the driver's last known location and timestamp. | () -> (bool)
|
|
17933
|
+
|
|
17934
|
+
</dd>
|
|
17935
|
+
</dl>
|
|
17936
|
+
</dd>
|
|
17937
|
+
</dl>
|
|
17938
|
+
|
|
17939
|
+
#### 🔌 Usage
|
|
17940
|
+
|
|
17941
|
+
<dl>
|
|
17942
|
+
<dd>
|
|
17943
|
+
|
|
17944
|
+
<dl>
|
|
17945
|
+
<dd>
|
|
17946
|
+
|
|
17947
|
+
```typescript
|
|
17948
|
+
await client.shipping.drivers.clearLastSeenV1();
|
|
17949
|
+
```
|
|
17950
|
+
|
|
17951
|
+
</dd>
|
|
17952
|
+
</dl>
|
|
17953
|
+
</dd>
|
|
17954
|
+
</dl>
|
|
17955
|
+
|
|
17956
|
+
#### ⚙️ Parameters
|
|
17957
|
+
|
|
17958
|
+
<dl>
|
|
17959
|
+
<dd>
|
|
17960
|
+
|
|
17961
|
+
<dl>
|
|
17962
|
+
<dd>
|
|
17963
|
+
|
|
17964
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
17965
|
+
|
|
17966
|
+
</dd>
|
|
17967
|
+
</dl>
|
|
17968
|
+
</dd>
|
|
17969
|
+
</dl>
|
|
17970
|
+
|
|
17971
|
+
</dd>
|
|
17972
|
+
</dl>
|
|
17973
|
+
</details>
|
|
17974
|
+
|
|
17975
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">listV1</a>({ ...params }) -> Chrt.DriverListRes</code></summary>
|
|
17976
|
+
<dl>
|
|
17977
|
+
<dd>
|
|
17978
|
+
|
|
17979
|
+
#### 📝 Description
|
|
17980
|
+
|
|
17981
|
+
<dl>
|
|
17982
|
+
<dd>
|
|
17983
|
+
|
|
17984
|
+
<dl>
|
|
17985
|
+
<dd>
|
|
17986
|
+
|
|
17987
|
+
Lists all drivers belonging to the caller's organization with filtering, sorting, pagination, and optional full-text search. | () -> (DriverListRes)
|
|
17988
|
+
|
|
17989
|
+
</dd>
|
|
17990
|
+
</dl>
|
|
17991
|
+
</dd>
|
|
17992
|
+
</dl>
|
|
17993
|
+
|
|
17994
|
+
#### 🔌 Usage
|
|
17995
|
+
|
|
17996
|
+
<dl>
|
|
17997
|
+
<dd>
|
|
17998
|
+
|
|
17999
|
+
<dl>
|
|
18000
|
+
<dd>
|
|
18001
|
+
|
|
18002
|
+
```typescript
|
|
18003
|
+
await client.shipping.drivers.listV1({
|
|
18004
|
+
sort_order: "asc",
|
|
18005
|
+
page: 1,
|
|
18006
|
+
page_size: 1,
|
|
18007
|
+
search: "search",
|
|
18008
|
+
filter_driver_ids: ["filter_driver_ids"],
|
|
18009
|
+
filter_waiting: true,
|
|
18010
|
+
filter_auto_assign_enabled: true,
|
|
18011
|
+
filter_vehicle_type: ["sedan"],
|
|
18012
|
+
filter_archived: true,
|
|
18013
|
+
filter_available_according_to_driver: true,
|
|
18014
|
+
filter_available_according_to_operators: true,
|
|
18015
|
+
filter_status: ["unassigned"],
|
|
18016
|
+
});
|
|
18017
|
+
```
|
|
18018
|
+
|
|
18019
|
+
</dd>
|
|
18020
|
+
</dl>
|
|
18021
|
+
</dd>
|
|
18022
|
+
</dl>
|
|
18023
|
+
|
|
18024
|
+
#### ⚙️ Parameters
|
|
18025
|
+
|
|
18026
|
+
<dl>
|
|
18027
|
+
<dd>
|
|
18028
|
+
|
|
18029
|
+
<dl>
|
|
18030
|
+
<dd>
|
|
18031
|
+
|
|
18032
|
+
**request:** `Chrt.shipping.DriversListV1Request`
|
|
18033
|
+
|
|
18034
|
+
</dd>
|
|
18035
|
+
</dl>
|
|
18036
|
+
|
|
18037
|
+
<dl>
|
|
18038
|
+
<dd>
|
|
18039
|
+
|
|
18040
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
18041
|
+
|
|
18042
|
+
</dd>
|
|
18043
|
+
</dl>
|
|
18044
|
+
</dd>
|
|
18045
|
+
</dl>
|
|
18046
|
+
|
|
18047
|
+
</dd>
|
|
18048
|
+
</dl>
|
|
18049
|
+
</details>
|
|
18050
|
+
|
|
18051
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">listOrgMembersAndDriversV1</a>({ ...params }) -> Chrt.OrgMembersAndDriversListRes</code></summary>
|
|
18052
|
+
<dl>
|
|
18053
|
+
<dd>
|
|
18054
|
+
|
|
18055
|
+
#### 📝 Description
|
|
18056
|
+
|
|
18057
|
+
<dl>
|
|
18058
|
+
<dd>
|
|
18059
|
+
|
|
18060
|
+
<dl>
|
|
18061
|
+
<dd>
|
|
18062
|
+
|
|
18063
|
+
Lists all organization members paired with their driver information if they are drivers. Supports search by name, filtering, sorting, and pagination. | () -> (OrgMembersAndDriversListRes)
|
|
18064
|
+
|
|
18065
|
+
</dd>
|
|
18066
|
+
</dl>
|
|
18067
|
+
</dd>
|
|
18068
|
+
</dl>
|
|
18069
|
+
|
|
18070
|
+
#### 🔌 Usage
|
|
18071
|
+
|
|
18072
|
+
<dl>
|
|
18073
|
+
<dd>
|
|
18074
|
+
|
|
18075
|
+
<dl>
|
|
18076
|
+
<dd>
|
|
18077
|
+
|
|
18078
|
+
```typescript
|
|
18079
|
+
await client.shipping.drivers.listOrgMembersAndDriversV1({
|
|
18080
|
+
filter_user_ids: ["filter_user_ids"],
|
|
18081
|
+
search: "search",
|
|
18082
|
+
filter_archived: true,
|
|
18083
|
+
filter_role: ["owner"],
|
|
18084
|
+
filter_available_according_to_driver: true,
|
|
18085
|
+
filter_available_according_to_operators: true,
|
|
18086
|
+
sort_by: "first_name",
|
|
18087
|
+
sort_order: "asc",
|
|
18088
|
+
page: 1,
|
|
18089
|
+
page_size: 1,
|
|
18090
|
+
});
|
|
18091
|
+
```
|
|
18092
|
+
|
|
18093
|
+
</dd>
|
|
18094
|
+
</dl>
|
|
18095
|
+
</dd>
|
|
18096
|
+
</dl>
|
|
18097
|
+
|
|
18098
|
+
#### ⚙️ Parameters
|
|
18099
|
+
|
|
18100
|
+
<dl>
|
|
18101
|
+
<dd>
|
|
18102
|
+
|
|
18103
|
+
<dl>
|
|
18104
|
+
<dd>
|
|
18105
|
+
|
|
18106
|
+
**request:** `Chrt.shipping.DriversListOrgMembersAndDriversV1Request`
|
|
18107
|
+
|
|
18108
|
+
</dd>
|
|
18109
|
+
</dl>
|
|
18110
|
+
|
|
18111
|
+
<dl>
|
|
18112
|
+
<dd>
|
|
18113
|
+
|
|
18114
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
18115
|
+
|
|
18116
|
+
</dd>
|
|
18117
|
+
</dl>
|
|
18118
|
+
</dd>
|
|
18119
|
+
</dl>
|
|
18120
|
+
|
|
18121
|
+
</dd>
|
|
18122
|
+
</dl>
|
|
18123
|
+
</details>
|
|
18124
|
+
|
|
18125
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">createSelfReportedHoursAndMileageV1</a>({ ...params }) -> Chrt.DriverSelfReportedHoursAndMileage1</code></summary>
|
|
18126
|
+
<dl>
|
|
18127
|
+
<dd>
|
|
18128
|
+
|
|
18129
|
+
#### 📝 Description
|
|
18130
|
+
|
|
18131
|
+
<dl>
|
|
18132
|
+
<dd>
|
|
18133
|
+
|
|
18134
|
+
<dl>
|
|
18135
|
+
<dd>
|
|
18136
|
+
|
|
18137
|
+
Creates a driver's self-reported hours worked and miles driven for a single calendar day. Caller must be the driver themselves. | authz: allowed_org_types=[provider], min_org_role=driver | (DriverSelfReportedHoursAndMileageClientCreate1) -> (DriverSelfReportedHoursAndMileage1)
|
|
18138
|
+
|
|
18139
|
+
</dd>
|
|
18140
|
+
</dl>
|
|
18141
|
+
</dd>
|
|
18142
|
+
</dl>
|
|
18143
|
+
|
|
18144
|
+
#### 🔌 Usage
|
|
18145
|
+
|
|
18146
|
+
<dl>
|
|
18147
|
+
<dd>
|
|
18148
|
+
|
|
18149
|
+
<dl>
|
|
18150
|
+
<dd>
|
|
18151
|
+
|
|
18152
|
+
```typescript
|
|
18153
|
+
await client.shipping.drivers.createSelfReportedHoursAndMileageV1({
|
|
18154
|
+
date: "date",
|
|
18155
|
+
driver_id: "driver_id",
|
|
18156
|
+
schema_version: 1,
|
|
18157
|
+
});
|
|
18158
|
+
```
|
|
18159
|
+
|
|
18160
|
+
</dd>
|
|
18161
|
+
</dl>
|
|
18162
|
+
</dd>
|
|
18163
|
+
</dl>
|
|
18164
|
+
|
|
18165
|
+
#### ⚙️ Parameters
|
|
18166
|
+
|
|
18167
|
+
<dl>
|
|
18168
|
+
<dd>
|
|
18169
|
+
|
|
18170
|
+
<dl>
|
|
18171
|
+
<dd>
|
|
18172
|
+
|
|
18173
|
+
**request:** `Chrt.shipping.DriverSelfReportedHoursAndMileageClientCreate1`
|
|
18174
|
+
|
|
18175
|
+
</dd>
|
|
18176
|
+
</dl>
|
|
18177
|
+
|
|
18178
|
+
<dl>
|
|
18179
|
+
<dd>
|
|
18180
|
+
|
|
18181
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
18182
|
+
|
|
18183
|
+
</dd>
|
|
18184
|
+
</dl>
|
|
18185
|
+
</dd>
|
|
18186
|
+
</dl>
|
|
18187
|
+
|
|
18188
|
+
</dd>
|
|
18189
|
+
</dl>
|
|
18190
|
+
</details>
|
|
18191
|
+
|
|
18192
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">deleteSelfReportedHoursAndMileageV1</a>(driverId, reportDate) -> boolean</code></summary>
|
|
18193
|
+
<dl>
|
|
18194
|
+
<dd>
|
|
18195
|
+
|
|
18196
|
+
#### 📝 Description
|
|
18197
|
+
|
|
18198
|
+
<dl>
|
|
18199
|
+
<dd>
|
|
18200
|
+
|
|
18201
|
+
<dl>
|
|
18202
|
+
<dd>
|
|
18203
|
+
|
|
18204
|
+
Permanently deletes a driver's self-report for a calendar day. Caller must be the driver themselves. | authz: allowed_org_types=[provider], min_org_role=driver | () -> (bool)
|
|
18205
|
+
|
|
18206
|
+
</dd>
|
|
18207
|
+
</dl>
|
|
18208
|
+
</dd>
|
|
18209
|
+
</dl>
|
|
18210
|
+
|
|
18211
|
+
#### 🔌 Usage
|
|
18212
|
+
|
|
18213
|
+
<dl>
|
|
18214
|
+
<dd>
|
|
18215
|
+
|
|
18216
|
+
<dl>
|
|
18217
|
+
<dd>
|
|
18218
|
+
|
|
18219
|
+
```typescript
|
|
18220
|
+
await client.shipping.drivers.deleteSelfReportedHoursAndMileageV1("driver_id", "report_date");
|
|
18221
|
+
```
|
|
18222
|
+
|
|
18223
|
+
</dd>
|
|
18224
|
+
</dl>
|
|
18225
|
+
</dd>
|
|
18226
|
+
</dl>
|
|
18227
|
+
|
|
18228
|
+
#### ⚙️ Parameters
|
|
18229
|
+
|
|
18230
|
+
<dl>
|
|
18231
|
+
<dd>
|
|
18232
|
+
|
|
18233
|
+
<dl>
|
|
18234
|
+
<dd>
|
|
18235
|
+
|
|
18236
|
+
**driverId:** `string`
|
|
18237
|
+
|
|
18238
|
+
</dd>
|
|
18239
|
+
</dl>
|
|
18240
|
+
|
|
18241
|
+
<dl>
|
|
18242
|
+
<dd>
|
|
18243
|
+
|
|
18244
|
+
**reportDate:** `string`
|
|
18245
|
+
|
|
18246
|
+
</dd>
|
|
18247
|
+
</dl>
|
|
18248
|
+
|
|
18249
|
+
<dl>
|
|
18250
|
+
<dd>
|
|
18251
|
+
|
|
18252
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
18253
|
+
|
|
18254
|
+
</dd>
|
|
18255
|
+
</dl>
|
|
18256
|
+
</dd>
|
|
18257
|
+
</dl>
|
|
18258
|
+
|
|
18259
|
+
</dd>
|
|
18260
|
+
</dl>
|
|
18261
|
+
</details>
|
|
18262
|
+
|
|
18263
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">getSelfReportedHoursAndMileageV1</a>(driverId, reportDate) -> Chrt.DriverSelfReportedHoursAndMileage1</code></summary>
|
|
18264
|
+
<dl>
|
|
18265
|
+
<dd>
|
|
18266
|
+
|
|
18267
|
+
#### 📝 Description
|
|
18268
|
+
|
|
18269
|
+
<dl>
|
|
18270
|
+
<dd>
|
|
18271
|
+
|
|
18272
|
+
<dl>
|
|
18273
|
+
<dd>
|
|
18274
|
+
|
|
18275
|
+
Retrieves a driver's self-report for a single calendar day. Caller must be the driver themselves or an operator+ in the driver's org. | authz: allowed_org_types=[provider], min_org_role=driver | () -> (DriverSelfReportedHoursAndMileage1)
|
|
18276
|
+
|
|
18277
|
+
</dd>
|
|
18278
|
+
</dl>
|
|
18279
|
+
</dd>
|
|
18280
|
+
</dl>
|
|
18281
|
+
|
|
18282
|
+
#### 🔌 Usage
|
|
18283
|
+
|
|
18284
|
+
<dl>
|
|
18285
|
+
<dd>
|
|
18286
|
+
|
|
18287
|
+
<dl>
|
|
18288
|
+
<dd>
|
|
18289
|
+
|
|
18290
|
+
```typescript
|
|
18291
|
+
await client.shipping.drivers.getSelfReportedHoursAndMileageV1("driver_id", "report_date");
|
|
18292
|
+
```
|
|
18293
|
+
|
|
18294
|
+
</dd>
|
|
18295
|
+
</dl>
|
|
18296
|
+
</dd>
|
|
18297
|
+
</dl>
|
|
18298
|
+
|
|
18299
|
+
#### ⚙️ Parameters
|
|
18300
|
+
|
|
18301
|
+
<dl>
|
|
18302
|
+
<dd>
|
|
18303
|
+
|
|
18304
|
+
<dl>
|
|
18305
|
+
<dd>
|
|
18306
|
+
|
|
18307
|
+
**driverId:** `string`
|
|
18308
|
+
|
|
18309
|
+
</dd>
|
|
18310
|
+
</dl>
|
|
18311
|
+
|
|
18312
|
+
<dl>
|
|
18313
|
+
<dd>
|
|
18314
|
+
|
|
18315
|
+
**reportDate:** `string`
|
|
18316
|
+
|
|
18317
|
+
</dd>
|
|
18318
|
+
</dl>
|
|
18319
|
+
|
|
18320
|
+
<dl>
|
|
18321
|
+
<dd>
|
|
18322
|
+
|
|
18323
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
18324
|
+
|
|
18325
|
+
</dd>
|
|
18326
|
+
</dl>
|
|
18327
|
+
</dd>
|
|
18328
|
+
</dl>
|
|
18329
|
+
|
|
18330
|
+
</dd>
|
|
18331
|
+
</dl>
|
|
18332
|
+
</details>
|
|
18333
|
+
|
|
18334
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">listSelfReportedHoursAndMileageV1</a>(driverId, { ...params }) -> Chrt.DriverSelfReportedHoursAndMileageListRes</code></summary>
|
|
18335
|
+
<dl>
|
|
18336
|
+
<dd>
|
|
18337
|
+
|
|
18338
|
+
#### 📝 Description
|
|
18339
|
+
|
|
18340
|
+
<dl>
|
|
18341
|
+
<dd>
|
|
18342
|
+
|
|
18343
|
+
<dl>
|
|
18344
|
+
<dd>
|
|
18345
|
+
|
|
18346
|
+
Lists a driver's self-reports across an optional date range with sorting and pagination. Caller must be the driver themselves or an operator+ in the driver's org. | authz: allowed_org_types=[provider], min_org_role=driver | () -> (DriverSelfReportedHoursAndMileageListRes)
|
|
18347
|
+
|
|
18348
|
+
</dd>
|
|
18349
|
+
</dl>
|
|
18350
|
+
</dd>
|
|
18351
|
+
</dl>
|
|
18352
|
+
|
|
18353
|
+
#### 🔌 Usage
|
|
18354
|
+
|
|
18355
|
+
<dl>
|
|
18356
|
+
<dd>
|
|
18357
|
+
|
|
18358
|
+
<dl>
|
|
18359
|
+
<dd>
|
|
18360
|
+
|
|
18361
|
+
```typescript
|
|
18362
|
+
await client.shipping.drivers.listSelfReportedHoursAndMileageV1("driver_id", {
|
|
18363
|
+
filter_start_date: "filter_start_date",
|
|
18364
|
+
filter_end_date: "filter_end_date",
|
|
18365
|
+
sort_order: "asc",
|
|
18366
|
+
page: 1,
|
|
18367
|
+
page_size: 1,
|
|
18368
|
+
});
|
|
18369
|
+
```
|
|
18370
|
+
|
|
18371
|
+
</dd>
|
|
18372
|
+
</dl>
|
|
18373
|
+
</dd>
|
|
18374
|
+
</dl>
|
|
18375
|
+
|
|
18376
|
+
#### ⚙️ Parameters
|
|
18377
|
+
|
|
18378
|
+
<dl>
|
|
18379
|
+
<dd>
|
|
18380
|
+
|
|
18381
|
+
<dl>
|
|
18382
|
+
<dd>
|
|
18383
|
+
|
|
18384
|
+
**driverId:** `string`
|
|
18385
|
+
|
|
18386
|
+
</dd>
|
|
18387
|
+
</dl>
|
|
18388
|
+
|
|
18389
|
+
<dl>
|
|
18390
|
+
<dd>
|
|
18391
|
+
|
|
18392
|
+
**request:** `Chrt.shipping.DriversListSelfReportedHoursAndMileageV1Request`
|
|
18393
|
+
|
|
18394
|
+
</dd>
|
|
18395
|
+
</dl>
|
|
18396
|
+
|
|
18397
|
+
<dl>
|
|
18398
|
+
<dd>
|
|
18399
|
+
|
|
18400
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
18401
|
+
|
|
18402
|
+
</dd>
|
|
18403
|
+
</dl>
|
|
18404
|
+
</dd>
|
|
18405
|
+
</dl>
|
|
18406
|
+
|
|
18407
|
+
</dd>
|
|
18408
|
+
</dl>
|
|
18409
|
+
</details>
|
|
18410
|
+
|
|
18411
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">orgListSelfReportedHoursAndMileageV1</a>({ ...params }) -> Chrt.DriverSelfReportedHoursAndMileageListRes</code></summary>
|
|
18412
|
+
<dl>
|
|
18413
|
+
<dd>
|
|
18414
|
+
|
|
18415
|
+
#### 📝 Description
|
|
18416
|
+
|
|
18417
|
+
<dl>
|
|
18418
|
+
<dd>
|
|
18419
|
+
|
|
18420
|
+
<dl>
|
|
18421
|
+
<dd>
|
|
18422
|
+
|
|
18423
|
+
Lists all drivers' self-reports in the caller's org with date-range filtering, sorting, and pagination. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (DriverSelfReportedHoursAndMileageListRes)
|
|
18424
|
+
|
|
18425
|
+
</dd>
|
|
18426
|
+
</dl>
|
|
18427
|
+
</dd>
|
|
18428
|
+
</dl>
|
|
18429
|
+
|
|
18430
|
+
#### 🔌 Usage
|
|
18431
|
+
|
|
18432
|
+
<dl>
|
|
18433
|
+
<dd>
|
|
18434
|
+
|
|
18435
|
+
<dl>
|
|
18436
|
+
<dd>
|
|
18437
|
+
|
|
18438
|
+
```typescript
|
|
18439
|
+
await client.shipping.drivers.orgListSelfReportedHoursAndMileageV1({
|
|
18440
|
+
filter_driver_id: "filter_driver_id",
|
|
18441
|
+
filter_start_date: "filter_start_date",
|
|
18442
|
+
filter_end_date: "filter_end_date",
|
|
18443
|
+
sort_by: "date",
|
|
18444
|
+
sort_order: "asc",
|
|
18445
|
+
page: 1,
|
|
18446
|
+
page_size: 1,
|
|
18447
|
+
});
|
|
18448
|
+
```
|
|
18449
|
+
|
|
18450
|
+
</dd>
|
|
18451
|
+
</dl>
|
|
18452
|
+
</dd>
|
|
18453
|
+
</dl>
|
|
18454
|
+
|
|
18455
|
+
#### ⚙️ Parameters
|
|
18456
|
+
|
|
18457
|
+
<dl>
|
|
18458
|
+
<dd>
|
|
18459
|
+
|
|
18460
|
+
<dl>
|
|
18461
|
+
<dd>
|
|
18462
|
+
|
|
18463
|
+
**request:** `Chrt.shipping.DriversOrgListSelfReportedHoursAndMileageV1Request`
|
|
18464
|
+
|
|
18465
|
+
</dd>
|
|
18466
|
+
</dl>
|
|
18467
|
+
|
|
18468
|
+
<dl>
|
|
18469
|
+
<dd>
|
|
18470
|
+
|
|
18471
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
18472
|
+
|
|
18473
|
+
</dd>
|
|
18474
|
+
</dl>
|
|
18475
|
+
</dd>
|
|
18476
|
+
</dl>
|
|
18477
|
+
|
|
18478
|
+
</dd>
|
|
18479
|
+
</dl>
|
|
18480
|
+
</details>
|
|
18481
|
+
|
|
18482
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">updateSelfReportedHoursAndMileageV1</a>(driverId, reportDate, { ...params }) -> Chrt.DriverSelfReportedHoursAndMileage1</code></summary>
|
|
18483
|
+
<dl>
|
|
18484
|
+
<dd>
|
|
18485
|
+
|
|
18486
|
+
#### 📝 Description
|
|
18487
|
+
|
|
18488
|
+
<dl>
|
|
18489
|
+
<dd>
|
|
18490
|
+
|
|
18491
|
+
<dl>
|
|
18492
|
+
<dd>
|
|
18493
|
+
|
|
18494
|
+
Partially updates a driver's self-reported hours worked and/or miles driven for a calendar day. Caller must be the driver themselves. | authz: allowed_org_types=[provider], min_org_role=driver | (DriverSelfReportedHoursAndMileageClientUpdate1) -> (DriverSelfReportedHoursAndMileage1)
|
|
18495
|
+
|
|
18496
|
+
</dd>
|
|
18497
|
+
</dl>
|
|
18498
|
+
</dd>
|
|
18499
|
+
</dl>
|
|
18500
|
+
|
|
18501
|
+
#### 🔌 Usage
|
|
18502
|
+
|
|
18503
|
+
<dl>
|
|
18504
|
+
<dd>
|
|
18505
|
+
|
|
18506
|
+
<dl>
|
|
18507
|
+
<dd>
|
|
18508
|
+
|
|
18509
|
+
```typescript
|
|
18510
|
+
await client.shipping.drivers.updateSelfReportedHoursAndMileageV1("driver_id", "report_date");
|
|
17605
18511
|
```
|
|
17606
18512
|
|
|
17607
18513
|
</dd>
|
|
@@ -25881,7 +26787,7 @@ await client.shipping.taskArtifacts.s3Object.writeAiImageDescriptionV1("task_art
|
|
|
25881
26787
|
dispute_defensibility: "dispute_defensibility",
|
|
25882
26788
|
location_description: "location_description",
|
|
25883
26789
|
location_identifiers: ["location_identifiers"],
|
|
25884
|
-
model: "gpt-
|
|
26790
|
+
model: "gpt-6-astra",
|
|
25885
26791
|
package_appearance: "package_appearance",
|
|
25886
26792
|
package_types: ["package_types"],
|
|
25887
26793
|
proof_notes: ["proof_notes"],
|
|
@@ -26609,6 +27515,7 @@ await client.shipping.taskGroups.expanded.listForProviderOperatorsV1({
|
|
|
26609
27515
|
page_size: 1,
|
|
26610
27516
|
search: "search",
|
|
26611
27517
|
filter_task_group_ids: ["filter_task_group_ids"],
|
|
27518
|
+
filter_order_ids: ["filter_order_ids"],
|
|
26612
27519
|
filter_status: ["draft"],
|
|
26613
27520
|
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
26614
27521
|
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
@@ -38122,136 +39029,6 @@ await client.utils.root.pingOptionallyAuthd();
|
|
|
38122
39029
|
|
|
38123
39030
|
## Utils Dev
|
|
38124
39031
|
|
|
38125
|
-
<details><summary><code>client.utils.dev.<a href="/src/api/resources/utils/resources/dev/client/Client.ts">postAgentGeographyV1</a>({ ...params }) -> Chrt.GeographyRes</code></summary>
|
|
38126
|
-
<dl>
|
|
38127
|
-
<dd>
|
|
38128
|
-
|
|
38129
|
-
#### 📝 Description
|
|
38130
|
-
|
|
38131
|
-
<dl>
|
|
38132
|
-
<dd>
|
|
38133
|
-
|
|
38134
|
-
<dl>
|
|
38135
|
-
<dd>
|
|
38136
|
-
|
|
38137
|
-
Runs the Pydantic AI Temporal geography sample workflow and returns the response. | (GeographyReq) -> (GeographyRes)
|
|
38138
|
-
|
|
38139
|
-
</dd>
|
|
38140
|
-
</dl>
|
|
38141
|
-
</dd>
|
|
38142
|
-
</dl>
|
|
38143
|
-
|
|
38144
|
-
#### 🔌 Usage
|
|
38145
|
-
|
|
38146
|
-
<dl>
|
|
38147
|
-
<dd>
|
|
38148
|
-
|
|
38149
|
-
<dl>
|
|
38150
|
-
<dd>
|
|
38151
|
-
|
|
38152
|
-
```typescript
|
|
38153
|
-
await client.utils.dev.postAgentGeographyV1({
|
|
38154
|
-
prompt: "prompt",
|
|
38155
|
-
});
|
|
38156
|
-
```
|
|
38157
|
-
|
|
38158
|
-
</dd>
|
|
38159
|
-
</dl>
|
|
38160
|
-
</dd>
|
|
38161
|
-
</dl>
|
|
38162
|
-
|
|
38163
|
-
#### ⚙️ Parameters
|
|
38164
|
-
|
|
38165
|
-
<dl>
|
|
38166
|
-
<dd>
|
|
38167
|
-
|
|
38168
|
-
<dl>
|
|
38169
|
-
<dd>
|
|
38170
|
-
|
|
38171
|
-
**request:** `Chrt.utils.GeographyReq`
|
|
38172
|
-
|
|
38173
|
-
</dd>
|
|
38174
|
-
</dl>
|
|
38175
|
-
|
|
38176
|
-
<dl>
|
|
38177
|
-
<dd>
|
|
38178
|
-
|
|
38179
|
-
**requestOptions:** `Dev.RequestOptions`
|
|
38180
|
-
|
|
38181
|
-
</dd>
|
|
38182
|
-
</dl>
|
|
38183
|
-
</dd>
|
|
38184
|
-
</dl>
|
|
38185
|
-
|
|
38186
|
-
</dd>
|
|
38187
|
-
</dl>
|
|
38188
|
-
</details>
|
|
38189
|
-
|
|
38190
|
-
<details><summary><code>client.utils.dev.<a href="/src/api/resources/utils/resources/dev/client/Client.ts">postAgentOpenaiPingV1</a>({ ...params }) -> Chrt.PingOpenAiRes</code></summary>
|
|
38191
|
-
<dl>
|
|
38192
|
-
<dd>
|
|
38193
|
-
|
|
38194
|
-
#### 📝 Description
|
|
38195
|
-
|
|
38196
|
-
<dl>
|
|
38197
|
-
<dd>
|
|
38198
|
-
|
|
38199
|
-
<dl>
|
|
38200
|
-
<dd>
|
|
38201
|
-
|
|
38202
|
-
Runs a minimal Temporal workflow that sends a prompt to OpenAI and returns the response. | (PingOpenAIReq) -> (PingOpenAIRes)
|
|
38203
|
-
|
|
38204
|
-
</dd>
|
|
38205
|
-
</dl>
|
|
38206
|
-
</dd>
|
|
38207
|
-
</dl>
|
|
38208
|
-
|
|
38209
|
-
#### 🔌 Usage
|
|
38210
|
-
|
|
38211
|
-
<dl>
|
|
38212
|
-
<dd>
|
|
38213
|
-
|
|
38214
|
-
<dl>
|
|
38215
|
-
<dd>
|
|
38216
|
-
|
|
38217
|
-
```typescript
|
|
38218
|
-
await client.utils.dev.postAgentOpenaiPingV1({
|
|
38219
|
-
prompt: "prompt",
|
|
38220
|
-
});
|
|
38221
|
-
```
|
|
38222
|
-
|
|
38223
|
-
</dd>
|
|
38224
|
-
</dl>
|
|
38225
|
-
</dd>
|
|
38226
|
-
</dl>
|
|
38227
|
-
|
|
38228
|
-
#### ⚙️ Parameters
|
|
38229
|
-
|
|
38230
|
-
<dl>
|
|
38231
|
-
<dd>
|
|
38232
|
-
|
|
38233
|
-
<dl>
|
|
38234
|
-
<dd>
|
|
38235
|
-
|
|
38236
|
-
**request:** `Chrt.utils.PingOpenAiReq`
|
|
38237
|
-
|
|
38238
|
-
</dd>
|
|
38239
|
-
</dl>
|
|
38240
|
-
|
|
38241
|
-
<dl>
|
|
38242
|
-
<dd>
|
|
38243
|
-
|
|
38244
|
-
**requestOptions:** `Dev.RequestOptions`
|
|
38245
|
-
|
|
38246
|
-
</dd>
|
|
38247
|
-
</dl>
|
|
38248
|
-
</dd>
|
|
38249
|
-
</dl>
|
|
38250
|
-
|
|
38251
|
-
</dd>
|
|
38252
|
-
</dl>
|
|
38253
|
-
</details>
|
|
38254
|
-
|
|
38255
39032
|
<details><summary><code>client.utils.dev.<a href="/src/api/resources/utils/resources/dev/client/Client.ts">postAgentPingV1</a>({ ...params }) -> Chrt.PingRes</code></summary>
|
|
38256
39033
|
<dl>
|
|
38257
39034
|
<dd>
|