index.d overview

tslint:disable

Table of contents

utils

AuthorizeRequest (interface)

This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.

Signature

export interface AuthorizeRequest {
  idTag: string
}

BootNotificationRequest (interface)

This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.

Signature

export interface BootNotificationRequest {
  chargePointVendor: string
  chargePointModel: string
  chargePointSerialNumber?: string
  chargeBoxSerialNumber?: string
  firmwareVersion?: string
  iccid?: string
  imsi?: string
  meterType?: string
  meterSerialNumber?: string
}

CancelReservationRequest (interface)

This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.

Signature

export interface CancelReservationRequest {
  reservationId: number
}

ChangeAvailabilityRequest (interface)

This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.

Signature

export interface ChangeAvailabilityRequest {
  connectorId: number
  type: 'Inoperative' | 'Operative'
}

ChangeConfigurationRequest (interface)

This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.

Signature

export interface ChangeConfigurationRequest {
  key: string
  value: string
}

ClearCacheRequest (interface)

This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.

Signature

export interface ClearCacheRequest {}

ClearChargingProfileRequest (interface)

This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.

Signature

export interface ClearChargingProfileRequest {
  id?: number
  connectorId?: number
  chargingProfilePurpose?: 'ChargePointMaxProfile' | 'TxDefaultProfile' | 'TxProfile'
  stackLevel?: number
}

DataTransferRequest (interface)

This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.

Signature

export interface DataTransferRequest {
  vendorId: string
  messageId?: string
  data?: string
}

DiagnosticsStatusNotificationRequest (interface)

This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.

Signature

export interface DiagnosticsStatusNotificationRequest {
  status: 'Idle' | 'Uploaded' | 'UploadFailed' | 'Uploading'
}

FirmwareStatusNotificationRequest (interface)

This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.

Signature

export interface FirmwareStatusNotificationRequest {
  status: 'Downloaded' | 'DownloadFailed' | 'Downloading' | 'Idle' | 'InstallationFailed' | 'Installing' | 'Installed'
}

GetCompositeScheduleRequest (interface)

This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.

Signature

export interface GetCompositeScheduleRequest {
  connectorId: number
  duration: number
  chargingRateUnit?: 'A' | 'W'
}

GetConfigurationRequest (interface)

This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.

Signature

export interface GetConfigurationRequest {
  key?: string[]
}

GetDiagnosticsRequest (interface)

This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.

Signature

export interface GetDiagnosticsRequest {
  location: string
  retries?: number
  retryInterval?: number
  startTime?: string
  stopTime?: string
}

GetLocalListVersionRequest (interface)

This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.

Signature

export interface GetLocalListVersionRequest {}

HeartbeatRequest (interface)

This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.

Signature

export interface HeartbeatRequest {}

MeterValuesRequest (interface)

This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.

Signature

export interface MeterValuesRequest {
  connectorId: number
  transactionId?: number
  meterValue: {
    timestamp: string
    sampledValue: {
      value: string
      context?:
        | 'Interruption.Begin'
        | 'Interruption.End'
        | 'Sample.Clock'
        | 'Sample.Periodic'
        | 'Transaction.Begin'
        | 'Transaction.End'
        | 'Trigger'
        | 'Other'
      format?: 'Raw' | 'SignedData'
      measurand?:
        | 'Energy.Active.Export.Register'
        | 'Energy.Active.Import.Register'
        | 'Energy.Reactive.Export.Register'
        | 'Energy.Reactive.Import.Register'
        | 'Energy.Active.Export.Interval'
        | 'Energy.Active.Import.Interval'
        | 'Energy.Reactive.Export.Interval'
        | 'Energy.Reactive.Import.Interval'
        | 'Power.Active.Export'
        | 'Power.Active.Import'
        | 'Power.Offered'
        | 'Power.Reactive.Export'
        | 'Power.Reactive.Import'
        | 'Power.Factor'
        | 'Current.Import'
        | 'Current.Export'
        | 'Current.Offered'
        | 'Voltage'
        | 'Frequency'
        | 'Temperature'
        | 'SoC'
        | 'RPM'
      phase?: 'L1' | 'L2' | 'L3' | 'N' | 'L1-N' | 'L2-N' | 'L3-N' | 'L1-L2' | 'L2-L3' | 'L3-L1'
      location?: 'Cable' | 'EV' | 'Inlet' | 'Outlet' | 'Body'
      unit?:
        | 'Wh'
        | 'kWh'
        | 'varh'
        | 'kvarh'
        | 'W'
        | 'kW'
        | 'VA'
        | 'kVA'
        | 'var'
        | 'kvar'
        | 'A'
        | 'V'
        | 'K'
        | 'Celcius'
        | 'Fahrenheit'
        | 'Percent'
      [k: string]: unknown
    }[]
    [k: string]: unknown
  }[]
}

RemoteStartTransactionRequest (interface)

This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.

Signature

export interface RemoteStartTransactionRequest {
  connectorId?: number
  idTag: string
  chargingProfile?: {
    chargingProfileId: number
    transactionId?: number
    stackLevel: number
    chargingProfilePurpose: 'ChargePointMaxProfile' | 'TxDefaultProfile' | 'TxProfile'
    chargingProfileKind: 'Absolute' | 'Recurring' | 'Relative'
    recurrencyKind?: 'Daily' | 'Weekly'
    validFrom?: string
    validTo?: string
    chargingSchedule: {
      duration?: number
      startSchedule?: string
      chargingRateUnit: 'A' | 'W'
      chargingSchedulePeriod: {
        startPeriod: number
        limit: number
        numberPhases?: number
        [k: string]: unknown
      }[]
      minChargingRate?: number
      [k: string]: unknown
    }
    [k: string]: unknown
  }
}

RemoteStopTransactionRequest (interface)

This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.

Signature

export interface RemoteStopTransactionRequest {
  transactionId: number
}

ReserveNowRequest (interface)

This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.

Signature

export interface ReserveNowRequest {
  connectorId: number
  expiryDate: string
  idTag: string
  parentIdTag?: string
  reservationId: number
}

ResetRequest (interface)

This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.

Signature

export interface ResetRequest {
  type: 'Hard' | 'Soft'
}

SendLocalListRequest (interface)

This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.

Signature

export interface SendLocalListRequest {
  listVersion: number
  localAuthorizationList?: {
    idTag: string
    idTagInfo?: {
      status: 'Accepted' | 'Blocked' | 'Expired' | 'Invalid' | 'ConcurrentTx'
      [k: string]: unknown
    }
    [k: string]: unknown
  }[]
  updateType: 'Differential' | 'Full'
}

SetChargingProfileRequest (interface)

This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.

Signature

export interface SetChargingProfileRequest {
  connectorId: number
  csChargingProfiles: {
    chargingProfileId: number
    transactionId?: number
    stackLevel: number
    chargingProfilePurpose: 'ChargePointMaxProfile' | 'TxDefaultProfile' | 'TxProfile'
    chargingProfileKind: 'Absolute' | 'Recurring' | 'Relative'
    recurrencyKind?: 'Daily' | 'Weekly'
    validFrom?: string
    validTo?: string
    chargingSchedule: {
      duration?: number
      startSchedule?: string
      chargingRateUnit: 'A' | 'W'
      chargingSchedulePeriod: {
        startPeriod: number
        limit: number
        numberPhases?: number
        [k: string]: unknown
      }[]
      minChargingRate?: number
      [k: string]: unknown
    }
    [k: string]: unknown
  }
}

StartTransactionRequest (interface)

This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.

Signature

export interface StartTransactionRequest {
  connectorId: number
  idTag: string
  meterStart: number
  reservationId?: number
  timestamp: string
}

StatusNotificationRequest (interface)

This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.

Signature

export interface StatusNotificationRequest {
  connectorId: number
  errorCode:
    | 'ConnectorLockFailure'
    | 'EVCommunicationError'
    | 'GroundFailure'
    | 'HighTemperature'
    | 'InternalError'
    | 'LocalListConflict'
    | 'NoError'
    | 'OtherError'
    | 'OverCurrentFailure'
    | 'PowerMeterFailure'
    | 'PowerSwitchFailure'
    | 'ReaderFailure'
    | 'ResetFailure'
    | 'UnderVoltage'
    | 'OverVoltage'
    | 'WeakSignal'
  info?: string
  status:
    | 'Available'
    | 'Preparing'
    | 'Charging'
    | 'SuspendedEVSE'
    | 'SuspendedEV'
    | 'Finishing'
    | 'Reserved'
    | 'Unavailable'
    | 'Faulted'
  timestamp?: string
  vendorId?: string
  vendorErrorCode?: string
}

StopTransactionRequest (interface)

This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.

Signature

export interface StopTransactionRequest {
  idTag?: string
  meterStop: number
  timestamp: string
  transactionId: number
  reason?:
    | 'EmergencyStop'
    | 'EVDisconnected'
    | 'HardReset'
    | 'Local'
    | 'Other'
    | 'PowerLoss'
    | 'Reboot'
    | 'Remote'
    | 'SoftReset'
    | 'UnlockCommand'
    | 'DeAuthorized'
  transactionData?: {
    timestamp: string
    sampledValue: {
      value: string
      context?:
        | 'Interruption.Begin'
        | 'Interruption.End'
        | 'Sample.Clock'
        | 'Sample.Periodic'
        | 'Transaction.Begin'
        | 'Transaction.End'
        | 'Trigger'
        | 'Other'
      format?: 'Raw' | 'SignedData'
      measurand?:
        | 'Energy.Active.Export.Register'
        | 'Energy.Active.Import.Register'
        | 'Energy.Reactive.Export.Register'
        | 'Energy.Reactive.Import.Register'
        | 'Energy.Active.Export.Interval'
        | 'Energy.Active.Import.Interval'
        | 'Energy.Reactive.Export.Interval'
        | 'Energy.Reactive.Import.Interval'
        | 'Power.Active.Export'
        | 'Power.Active.Import'
        | 'Power.Offered'
        | 'Power.Reactive.Export'
        | 'Power.Reactive.Import'
        | 'Power.Factor'
        | 'Current.Import'
        | 'Current.Export'
        | 'Current.Offered'
        | 'Voltage'
        | 'Frequency'
        | 'Temperature'
        | 'SoC'
        | 'RPM'
      phase?: 'L1' | 'L2' | 'L3' | 'N' | 'L1-N' | 'L2-N' | 'L3-N' | 'L1-L2' | 'L2-L3' | 'L3-L1'
      location?: 'Cable' | 'EV' | 'Inlet' | 'Outlet' | 'Body'
      unit?:
        | 'Wh'
        | 'kWh'
        | 'varh'
        | 'kvarh'
        | 'W'
        | 'kW'
        | 'VA'
        | 'kVA'
        | 'var'
        | 'kvar'
        | 'A'
        | 'V'
        | 'K'
        | 'Celcius'
        | 'Fahrenheit'
        | 'Percent'
      [k: string]: unknown
    }[]
    [k: string]: unknown
  }[]
}

TriggerMessageRequest (interface)

This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.

Signature

export interface TriggerMessageRequest {
  requestedMessage:
    | 'BootNotification'
    | 'DiagnosticsStatusNotification'
    | 'FirmwareStatusNotification'
    | 'Heartbeat'
    | 'MeterValues'
    | 'StatusNotification'
  connectorId?: number
}

UnlockConnectorRequest (interface)

This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.

Signature

export interface UnlockConnectorRequest {
  connectorId: number
}

UpdateFirmwareRequest (interface)

This file was automatically generated by json-schema-to-typescript. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, and run json-schema-to-typescript to regenerate this file.

Signature

export interface UpdateFirmwareRequest {
  location: string
  retries?: number
  retrieveDate: string
  retryInterval?: number
}