typed-ocpp/dist/ocpp21/callresult.d.ts

A library for type-aware parsing, serialization and validation of OCPP 1.6, OCPP 2.0 and OCPP 2.1 messages

import type { Call } from './call.js';
import type { BaseMessage } from './utils.js';
import type { WithErrorsArr, ValidateFn } from '../common/utils.js';
import { Action, MessageType } from './utils.js';
import * as types from './types.js';
export type UncheckedCallResult<P extends {} = {}> = BaseMessage<MessageType.CALLRESULT, [payload: P]>;
export type AdjustPeriodicEventStreamCallResult = UncheckedCallResult<types.AdjustPeriodicEventStreamResponse>;
export type AFRRSignalCallResult = UncheckedCallResult<types.AFRRSignalResponse>;
export type AuthorizeCallResult = UncheckedCallResult<types.AuthorizeResponse>;
export type BatterySwapCallResult = UncheckedCallResult<types.BatterySwapResponse>;
export type BootNotificationCallResult = UncheckedCallResult<types.BootNotificationResponse>;
export type CancelReservationCallResult = UncheckedCallResult<types.CancelReservationResponse>;
export type CertificateSignedCallResult = UncheckedCallResult<types.CertificateSignedResponse>;
export type ChangeAvailabilityCallResult = UncheckedCallResult<types.ChangeAvailabilityResponse>;
export type ChangeTransactionTariffCallResult = UncheckedCallResult<types.ChangeTransactionTariffResponse>;
export type ClearCacheCallResult = UncheckedCallResult<types.ClearCacheResponse>;
export type ClearChargingProfileCallResult = UncheckedCallResult<types.ClearChargingProfileResponse>;
export type ClearDERControlCallResult = UncheckedCallResult<types.ClearDERControlResponse>;
export type ClearDisplayMessageCallResult = UncheckedCallResult<types.ClearDisplayMessageResponse>;
export type ClearedChargingLimitCallResult = UncheckedCallResult<types.ClearedChargingLimitResponse>;
export type ClearTariffsCallResult = UncheckedCallResult<types.ClearTariffsResponse>;
export type ClearVariableMonitoringCallResult = UncheckedCallResult<types.ClearVariableMonitoringResponse>;
export type ClosePeriodicEventStreamCallResult = UncheckedCallResult<types.ClosePeriodicEventStreamResponse>;
export type CostUpdatedCallResult = UncheckedCallResult<types.CostUpdatedResponse>;
export type CustomerInformationCallResult = UncheckedCallResult<types.CustomerInformationResponse>;
export type DataTransferCallResult = UncheckedCallResult<types.DataTransferResponse>;
export type DeleteCertificateCallResult = UncheckedCallResult<types.DeleteCertificateResponse>;
export type FirmwareStatusNotificationCallResult = UncheckedCallResult<types.FirmwareStatusNotificationResponse>;
export type Get15118EVCertificateCallResult = UncheckedCallResult<types.Get15118EVCertificateResponse>;
export type GetBaseReportCallResult = UncheckedCallResult<types.GetBaseReportResponse>;
export type GetCertificateChainStatusCallResult = UncheckedCallResult<types.GetCertificateChainStatusResponse>;
export type GetCertificateStatusCallResult = UncheckedCallResult<types.GetCertificateStatusResponse>;
export type GetChargingProfilesCallResult = UncheckedCallResult<types.GetChargingProfilesResponse>;
export type GetCompositeScheduleCallResult = UncheckedCallResult<types.GetCompositeScheduleResponse>;
export type GetDERControlCallResult = UncheckedCallResult<types.GetDERControlResponse>;
export type GetDisplayMessagesCallResult = UncheckedCallResult<types.GetDisplayMessagesResponse>;
export type GetInstalledCertificateIdsCallResult = UncheckedCallResult<types.GetInstalledCertificateIdsResponse>;
export type GetLocalListVersionCallResult = UncheckedCallResult<types.GetLocalListVersionResponse>;
export type GetLogCallResult = UncheckedCallResult<types.GetLogResponse>;
export type GetMonitoringReportCallResult = UncheckedCallResult<types.GetMonitoringReportResponse>;
export type GetPeriodicEventStreamCallResult = UncheckedCallResult<types.GetPeriodicEventStreamResponse>;
export type GetReportCallResult = UncheckedCallResult<types.GetReportResponse>;
export type GetTariffsCallResult = UncheckedCallResult<types.GetTariffsResponse>;
export type GetTransactionStatusCallResult = UncheckedCallResult<types.GetTransactionStatusResponse>;
export type GetVariablesCallResult = UncheckedCallResult<types.GetVariablesResponse>;
export type HeartbeatCallResult = UncheckedCallResult<types.HeartbeatResponse>;
export type InstallCertificateCallResult = UncheckedCallResult<types.InstallCertificateResponse>;
export type LogStatusNotificationCallResult = UncheckedCallResult<types.LogStatusNotificationResponse>;
export type MeterValuesCallResult = UncheckedCallResult<types.MeterValuesResponse>;
export type NotifyAllowedEnergyTransferCallResult = UncheckedCallResult<types.NotifyAllowedEnergyTransferResponse>;
export type NotifyChargingLimitCallResult = UncheckedCallResult<types.NotifyChargingLimitResponse>;
export type NotifyCustomerInformationCallResult = UncheckedCallResult<types.NotifyCustomerInformationResponse>;
export type NotifyDERAlarmCallResult = UncheckedCallResult<types.NotifyDERAlarmResponse>;
export type NotifyDERStartStopCallResult = UncheckedCallResult<types.NotifyDERStartStopResponse>;
export type NotifyDisplayMessagesCallResult = UncheckedCallResult<types.NotifyDisplayMessagesResponse>;
export type NotifyEVChargingNeedsCallResult = UncheckedCallResult<types.NotifyEVChargingNeedsResponse>;
export type NotifyEVChargingScheduleCallResult = UncheckedCallResult<types.NotifyEVChargingScheduleResponse>;
export type NotifyEventCallResult = UncheckedCallResult<types.NotifyEventResponse>;
export type NotifyMonitoringReportCallResult = UncheckedCallResult<types.NotifyMonitoringReportResponse>;
export type NotifyPriorityChargingCallResult = UncheckedCallResult<types.NotifyPriorityChargingResponse>;
export type NotifyReportCallResult = UncheckedCallResult<types.NotifyReportResponse>;
export type NotifySettlementCallResult = UncheckedCallResult<types.NotifySettlementResponse>;
export type NotifyWebPaymentStartedCallResult = UncheckedCallResult<types.NotifyWebPaymentStartedResponse>;
export type OpenPeriodicEventStreamCallResult = UncheckedCallResult<types.OpenPeriodicEventStreamResponse>;
export type PublishFirmwareCallResult = UncheckedCallResult<types.PublishFirmwareResponse>;
export type PublishFirmwareStatusNotificationCallResult = UncheckedCallResult<types.PublishFirmwareStatusNotificationResponse>;
export type PullDynamicScheduleUpdateCallResult = UncheckedCallResult<types.PullDynamicScheduleUpdateResponse>;
export type ReportChargingProfilesCallResult = UncheckedCallResult<types.ReportChargingProfilesResponse>;
export type ReportDERControlCallResult = UncheckedCallResult<types.ReportDERControlResponse>;
export type RequestBatterySwapCallResult = UncheckedCallResult<types.RequestBatterySwapResponse>;
export type RequestStartTransactionCallResult = UncheckedCallResult<types.RequestStartTransactionResponse>;
export type RequestStopTransactionCallResult = UncheckedCallResult<types.RequestStopTransactionResponse>;
export type ReservationStatusUpdateCallResult = UncheckedCallResult<types.ReservationStatusUpdateResponse>;
export type ReserveNowCallResult = UncheckedCallResult<types.ReserveNowResponse>;
export type ResetCallResult = UncheckedCallResult<types.ResetResponse>;
export type SecurityEventNotificationCallResult = UncheckedCallResult<types.SecurityEventNotificationResponse>;
export type SendLocalListCallResult = UncheckedCallResult<types.SendLocalListResponse>;
export type SetChargingProfileCallResult = UncheckedCallResult<types.SetChargingProfileResponse>;
export type SetDefaultTariffCallResult = UncheckedCallResult<types.SetDefaultTariffResponse>;
export type SetDERControlCallResult = UncheckedCallResult<types.SetDERControlResponse>;
export type SetDisplayMessageCallResult = UncheckedCallResult<types.SetDisplayMessageResponse>;
export type SetMonitoringBaseCallResult = UncheckedCallResult<types.SetMonitoringBaseResponse>;
export type SetMonitoringLevelCallResult = UncheckedCallResult<types.SetMonitoringLevelResponse>;
export type SetNetworkProfileCallResult = UncheckedCallResult<types.SetNetworkProfileResponse>;
export type SetVariableMonitoringCallResult = UncheckedCallResult<types.SetVariableMonitoringResponse>;
export type SetVariablesCallResult = UncheckedCallResult<types.SetVariablesResponse>;
export type SignCertificateCallResult = UncheckedCallResult<types.SignCertificateResponse>;
export type StatusNotificationCallResult = UncheckedCallResult<types.StatusNotificationResponse>;
export type TransactionEventCallResult = UncheckedCallResult<types.TransactionEventResponse>;
export type TriggerMessageCallResult = UncheckedCallResult<types.TriggerMessageResponse>;
export type UnlockConnectorCallResult = UncheckedCallResult<types.UnlockConnectorResponse>;
export type UnpublishFirmwareCallResult = UncheckedCallResult<types.UnpublishFirmwareResponse>;
export type UpdateDynamicScheduleCallResult = UncheckedCallResult<types.UpdateDynamicScheduleResponse>;
export type UpdateFirmwareCallResult = UncheckedCallResult<types.UpdateFirmwareResponse>;
export type UsePriorityChargingCallResult = UncheckedCallResult<types.UsePriorityChargingResponse>;
export type VatNumberValidationCallResult = UncheckedCallResult<types.VatNumberValidationResponse>;
export type CallResult = AdjustPeriodicEventStreamCallResult | AFRRSignalCallResult | AuthorizeCallResult | BatterySwapCallResult | BootNotificationCallResult | CancelReservationCallResult | CertificateSignedCallResult | ChangeAvailabilityCallResult | ChangeTransactionTariffCallResult | ClearCacheCallResult | ClearChargingProfileCallResult | ClearDERControlCallResult | ClearDisplayMessageCallResult | ClearedChargingLimitCallResult | ClearTariffsCallResult | ClearVariableMonitoringCallResult | ClosePeriodicEventStreamCallResult | CostUpdatedCallResult | CustomerInformationCallResult | DataTransferCallResult | DeleteCertificateCallResult | FirmwareStatusNotificationCallResult | Get15118EVCertificateCallResult | GetBaseReportCallResult | GetCertificateChainStatusCallResult | GetCertificateStatusCallResult | GetChargingProfilesCallResult | GetCompositeScheduleCallResult | GetDERControlCallResult | GetDisplayMessagesCallResult | GetInstalledCertificateIdsCallResult | GetLocalListVersionCallResult | GetLogCallResult | GetMonitoringReportCallResult | GetPeriodicEventStreamCallResult | GetReportCallResult | GetTariffsCallResult | GetTransactionStatusCallResult | GetVariablesCallResult | HeartbeatCallResult | InstallCertificateCallResult | LogStatusNotificationCallResult | MeterValuesCallResult | NotifyAllowedEnergyTransferCallResult | NotifyChargingLimitCallResult | NotifyCustomerInformationCallResult | NotifyDERAlarmCallResult | NotifyDERStartStopCallResult | NotifyDisplayMessagesCallResult | NotifyEVChargingNeedsCallResult | NotifyEVChargingScheduleCallResult | NotifyEventCallResult | NotifyMonitoringReportCallResult | NotifyPriorityChargingCallResult | NotifyReportCallResult | NotifySettlementCallResult | NotifyWebPaymentStartedCallResult | OpenPeriodicEventStreamCallResult | PublishFirmwareCallResult | PublishFirmwareStatusNotificationCallResult | PullDynamicScheduleUpdateCallResult | ReportChargingProfilesCallResult | ReportDERControlCallResult | RequestBatterySwapCallResult | RequestStartTransactionCallResult | RequestStopTransactionCallResult | ReservationStatusUpdateCallResult | ReserveNowCallResult | ResetCallResult | SecurityEventNotificationCallResult | SendLocalListCallResult | SetChargingProfileCallResult | SetDefaultTariffCallResult | SetDERControlCallResult | SetDisplayMessageCallResult | SetMonitoringBaseCallResult | SetMonitoringLevelCallResult | SetNetworkProfileCallResult | SetVariableMonitoringCallResult | SetVariablesCallResult | SignCertificateCallResult | StatusNotificationCallResult | TransactionEventCallResult | TriggerMessageCallResult | UnlockConnectorCallResult | UnpublishFirmwareCallResult | UpdateDynamicScheduleCallResult | UpdateFirmwareCallResult | UsePriorityChargingCallResult | VatNumberValidationCallResult;
export declare const validateCallResult: ValidateFn<any, UncheckedCallResult>;
export interface CallResultTypesByAction extends Record<Action, CallResult> {
    [Action.AdjustPeriodicEventStream]: AdjustPeriodicEventStreamCallResult;
    [Action.AFRRSignal]: AFRRSignalCallResult;
    [Action.Authorize]: AuthorizeCallResult;
    [Action.BatterySwap]: BatterySwapCallResult;
    [Action.BootNotification]: BootNotificationCallResult;
    [Action.CancelReservation]: CancelReservationCallResult;
    [Action.CertificateSigned]: CertificateSignedCallResult;
    [Action.ChangeAvailability]: ChangeAvailabilityCallResult;
    [Action.ChangeTransactionTariff]: ChangeTransactionTariffCallResult;
    [Action.ClearCache]: ClearCacheCallResult;
    [Action.ClearChargingProfile]: ClearChargingProfileCallResult;
    [Action.ClearDERControl]: ClearDERControlCallResult;
    [Action.ClearDisplayMessage]: ClearDisplayMessageCallResult;
    [Action.ClearedChargingLimit]: ClearedChargingLimitCallResult;
    [Action.ClearTariffs]: ClearTariffsCallResult;
    [Action.ClearVariableMonitoring]: ClearVariableMonitoringCallResult;
    [Action.ClosePeriodicEventStream]: ClosePeriodicEventStreamCallResult;
    [Action.CostUpdated]: CostUpdatedCallResult;
    [Action.CustomerInformation]: CustomerInformationCallResult;
    [Action.DataTransfer]: DataTransferCallResult;
    [Action.DeleteCertificate]: DeleteCertificateCallResult;
    [Action.FirmwareStatusNotification]: FirmwareStatusNotificationCallResult;
    [Action.Get15118EVCertificate]: Get15118EVCertificateCallResult;
    [Action.GetBaseReport]: GetBaseReportCallResult;
    [Action.GetCertificateChainStatus]: GetCertificateChainStatusCallResult;
    [Action.GetCertificateStatus]: GetCertificateStatusCallResult;
    [Action.GetChargingProfiles]: GetChargingProfilesCallResult;
    [Action.GetCompositeSchedule]: GetCompositeScheduleCallResult;
    [Action.GetDERControl]: GetDERControlCallResult;
    [Action.GetDisplayMessages]: GetDisplayMessagesCallResult;
    [Action.GetInstalledCertificateIds]: GetInstalledCertificateIdsCallResult;
    [Action.GetLocalListVersion]: GetLocalListVersionCallResult;
    [Action.GetLog]: GetLogCallResult;
    [Action.GetMonitoringReport]: GetMonitoringReportCallResult;
    [Action.GetPeriodicEventStream]: GetPeriodicEventStreamCallResult;
    [Action.GetReport]: GetReportCallResult;
    [Action.GetTariffs]: GetTariffsCallResult;
    [Action.GetTransactionStatus]: GetTransactionStatusCallResult;
    [Action.GetVariables]: GetVariablesCallResult;
    [Action.Heartbeat]: HeartbeatCallResult;
    [Action.InstallCertificate]: InstallCertificateCallResult;
    [Action.LogStatusNotification]: LogStatusNotificationCallResult;
    [Action.MeterValues]: MeterValuesCallResult;
    [Action.NotifyAllowedEnergyTransfer]: NotifyAllowedEnergyTransferCallResult;
    [Action.NotifyChargingLimit]: NotifyChargingLimitCallResult;
    [Action.NotifyCustomerInformation]: NotifyCustomerInformationCallResult;
    [Action.NotifyDERAlarm]: NotifyDERAlarmCallResult;
    [Action.NotifyDERStartStop]: NotifyDERStartStopCallResult;
    [Action.NotifyDisplayMessages]: NotifyDisplayMessagesCallResult;
    [Action.NotifyEVChargingNeeds]: NotifyEVChargingNeedsCallResult;
    [Action.NotifyEVChargingSchedule]: NotifyEVChargingScheduleCallResult;
    [Action.NotifyEvent]: NotifyEventCallResult;
    [Action.NotifyMonitoringReport]: NotifyMonitoringReportCallResult;
    [Action.NotifyPriorityCharging]: NotifyPriorityChargingCallResult;
    [Action.NotifyReport]: NotifyReportCallResult;
    [Action.NotifySettlement]: NotifySettlementCallResult;
    [Action.NotifyWebPaymentStarted]: NotifyWebPaymentStartedCallResult;
    [Action.OpenPeriodicEventStream]: OpenPeriodicEventStreamCallResult;
    [Action.PublishFirmware]: PublishFirmwareCallResult;
    [Action.PublishFirmwareStatusNotification]: PublishFirmwareStatusNotificationCallResult;
    [Action.PullDynamicScheduleUpdate]: PullDynamicScheduleUpdateCallResult;
    [Action.ReportChargingProfiles]: ReportChargingProfilesCallResult;
    [Action.ReportDERControl]: ReportDERControlCallResult;
    [Action.RequestBatterySwap]: RequestBatterySwapCallResult;
    [Action.RequestStartTransaction]: RequestStartTransactionCallResult;
    [Action.RequestStopTransaction]: RequestStopTransactionCallResult;
    [Action.ReservationStatusUpdate]: ReservationStatusUpdateCallResult;
    [Action.ReserveNow]: ReserveNowCallResult;
    [Action.Reset]: ResetCallResult;
    [Action.SecurityEventNotification]: SecurityEventNotificationCallResult;
    [Action.SendLocalList]: SendLocalListCallResult;
    [Action.SetChargingProfile]: SetChargingProfileCallResult;
    [Action.SetDefaultTariff]: SetDefaultTariffCallResult;
    [Action.SetDERControl]: SetDERControlCallResult;
    [Action.SetDisplayMessage]: SetDisplayMessageCallResult;
    [Action.SetMonitoringBase]: SetMonitoringBaseCallResult;
    [Action.SetMonitoringLevel]: SetMonitoringLevelCallResult;
    [Action.SetNetworkProfile]: SetNetworkProfileCallResult;
    [Action.SetVariableMonitoring]: SetVariableMonitoringCallResult;
    [Action.SetVariables]: SetVariablesCallResult;
    [Action.SignCertificate]: SignCertificateCallResult;
    [Action.StatusNotification]: StatusNotificationCallResult;
    [Action.TransactionEvent]: TransactionEventCallResult;
    [Action.TriggerMessage]: TriggerMessageCallResult;
    [Action.UnlockConnector]: UnlockConnectorCallResult;
    [Action.UnpublishFirmware]: UnpublishFirmwareCallResult;
    [Action.UpdateDynamicSchedule]: UpdateDynamicScheduleCallResult;
    [Action.UpdateFirmware]: UpdateFirmwareCallResult;
    [Action.UsePriorityCharging]: UsePriorityChargingCallResult;
    [Action.VatNumberValidation]: VatNumberValidationCallResult;
}
export type CheckedCallResult<C extends Call> = CallResultTypesByAction[C[2]];
export interface CheckCallResultFn extends WithErrorsArr {
    <C extends Call>(value: CheckedCallResult<Call>, call: C): value is CheckedCallResult<C>;
    errors: string[];
}
export declare const checkCallResult: CheckCallResultFn;