ocpp-messages 0.1.0

package/v2.0/CustomerInformationRequest.d.ts

@@ -0,0 +1,114 @@
+/* tslint:disable */
+/**
+ * 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.
+ */
+
+/**
+ * Used algorithms for the hashes provided.
+ *
+ */
+export type HashAlgorithmEnumType = "SHA256" | "SHA384" | "SHA512";
+/**
+ * Enumeration of possible idToken types.
+ *
+ */
+export type IdTokenEnumType =
+  | "Central"
+  | "eMAID"
+  | "ISO14443"
+  | "ISO15693"
+  | "KeyCode"
+  | "Local"
+  | "MacAddress"
+  | "NoAuthorization";
+
+export interface UrnOCPPCp220203CustomerInformationRequest {
+  customData?: CustomDataType;
+  customerCertificate?: CertificateHashDataType;
+  idToken?: IdTokenType;
+  /**
+   * The Id of the request.
+   *
+   *
+   */
+  requestId: number;
+  /**
+   * Flag indicating whether the Charging Station should return NotifyCustomerInformationRequest messages containing information about the customer referred to.
+   *
+   */
+  report: boolean;
+  /**
+   * Flag indicating whether the Charging Station should clear all information about the customer referred to.
+   *
+   */
+  clear: boolean;
+  /**
+   * A (e.g. vendor specific) identifier of the customer this request refers to. This field contains a custom identifier other than IdToken and Certificate.
+   * One of the possible identifiers (customerIdentifier, customerIdToken or customerCertificate) should be in the request message.
+   *
+   */
+  customerIdentifier?: string;
+}
+/**
+ * This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.
+ */
+export interface CustomDataType {
+  vendorId: string;
+  [k: string]: unknown;
+}
+export interface CertificateHashDataType {
+  customData?: CustomDataType;
+  hashAlgorithm: HashAlgorithmEnumType;
+  /**
+   * Hashed value of the Issuer DN (Distinguished Name).
+   *
+   *
+   */
+  issuerNameHash: string;
+  /**
+   * Hashed value of the issuers public key
+   *
+   */
+  issuerKeyHash: string;
+  /**
+   * The serial number of the certificate.
+   *
+   */
+  serialNumber: string;
+}
+/**
+ * Contains a case insensitive identifier to use for the authorization and the type of authorization to support multiple forms of identifiers.
+ *
+ */
+export interface IdTokenType {
+  customData?: CustomDataType;
+  /**
+   * @minItems 1
+   */
+  additionalInfo?: [AdditionalInfoType, ...AdditionalInfoType[]];
+  /**
+   * IdToken is case insensitive. Might hold the hidden id of an RFID tag, but can for example also contain a UUID.
+   *
+   */
+  idToken: string;
+  type: IdTokenEnumType;
+}
+/**
+ * Contains a case insensitive identifier to use for the authorization and the type of authorization to support multiple forms of identifiers.
+ *
+ */
+export interface AdditionalInfoType {
+  customData?: CustomDataType;
+  /**
+   * This field specifies the additional IdToken.
+   *
+   */
+  additionalIdToken: string;
+  /**
+   * This defines the type of the additionalIdToken. This is a custom type, so the implementation needs to be agreed upon by all involved parties.
+   *
+   */
+  type: string;
+}

package/v2.0/CustomerInformationResponse.d.ts

@@ -0,0 +1,42 @@
+/* tslint:disable */
+/**
+ * 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.
+ */
+
+/**
+ * Indicates whether the request was accepted.
+ *
+ */
+export type CustomerInformationStatusEnumType = "Accepted" | "Rejected" | "Invalid";
+
+export interface UrnOCPPCp220203CustomerInformationResponse {
+  customData?: CustomDataType;
+  status: CustomerInformationStatusEnumType;
+  statusInfo?: StatusInfoType;
+}
+/**
+ * This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.
+ */
+export interface CustomDataType {
+  vendorId: string;
+  [k: string]: unknown;
+}
+/**
+ * Element providing more information about the status.
+ *
+ */
+export interface StatusInfoType {
+  customData?: CustomDataType;
+  /**
+   * A predefined code for the reason why the status is returned in this response. The string is case-insensitive.
+   *
+   */
+  reasonCode: string;
+  /**
+   * Additional text to provide detailed information.
+   *
+   */
+  additionalInfo?: string;
+}

package/v2.0/DataTransferRequest.d.ts

@@ -0,0 +1,35 @@
+/* tslint:disable */
+/**
+ * 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.
+ */
+
+export interface UrnOCPPCp220203DataTransferRequest {
+  customData?: CustomDataType;
+  /**
+   * May be used to indicate a specific message or implementation.
+   *
+   */
+  messageId?: string;
+  /**
+   * Data without specified length or format. This needs to be decided by both parties (Open to implementation).
+   *
+   */
+  data?: {
+    [k: string]: unknown;
+  };
+  /**
+   * This identifies the Vendor specific implementation
+   *
+   *
+   */
+  vendorId: string;
+}
+/**
+ * This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.
+ */
+export interface CustomDataType {
+  vendorId: string;
+  [k: string]: unknown;
+}

package/v2.0/DataTransferResponse.d.ts

@@ -0,0 +1,49 @@
+/* tslint:disable */
+/**
+ * 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.
+ */
+
+/**
+ * This indicates the success or failure of the data transfer.
+ *
+ */
+export type DataTransferStatusEnumType = "Accepted" | "Rejected" | "UnknownMessageId" | "UnknownVendorId";
+
+export interface UrnOCPPCp220203DataTransferResponse {
+  customData?: CustomDataType;
+  status: DataTransferStatusEnumType;
+  statusInfo?: StatusInfoType;
+  /**
+   * Data without specified length or format, in response to request.
+   *
+   */
+  data?: {
+    [k: string]: unknown;
+  };
+}
+/**
+ * This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.
+ */
+export interface CustomDataType {
+  vendorId: string;
+  [k: string]: unknown;
+}
+/**
+ * Element providing more information about the status.
+ *
+ */
+export interface StatusInfoType {
+  customData?: CustomDataType;
+  /**
+   * A predefined code for the reason why the status is returned in this response. The string is case-insensitive.
+   *
+   */
+  reasonCode: string;
+  /**
+   * Additional text to provide detailed information.
+   *
+   */
+  additionalInfo?: string;
+}

package/v2.0/DeleteCertificateRequest.d.ts

@@ -0,0 +1,44 @@
+/* tslint:disable */
+/**
+ * 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.
+ */
+
+/**
+ * Used algorithms for the hashes provided.
+ *
+ */
+export type HashAlgorithmEnumType = "SHA256" | "SHA384" | "SHA512";
+
+export interface UrnOCPPCp220203DeleteCertificateRequest {
+  customData?: CustomDataType;
+  certificateHashData: CertificateHashDataType;
+}
+/**
+ * This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.
+ */
+export interface CustomDataType {
+  vendorId: string;
+  [k: string]: unknown;
+}
+export interface CertificateHashDataType {
+  customData?: CustomDataType;
+  hashAlgorithm: HashAlgorithmEnumType;
+  /**
+   * Hashed value of the Issuer DN (Distinguished Name).
+   *
+   *
+   */
+  issuerNameHash: string;
+  /**
+   * Hashed value of the issuers public key
+   *
+   */
+  issuerKeyHash: string;
+  /**
+   * The serial number of the certificate.
+   *
+   */
+  serialNumber: string;
+}

package/v2.0/DeleteCertificateResponse.d.ts

@@ -0,0 +1,42 @@
+/* tslint:disable */
+/**
+ * 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.
+ */
+
+/**
+ * Charging Station indicates if it can process the request.
+ *
+ */
+export type DeleteCertificateStatusEnumType = "Accepted" | "Failed" | "NotFound";
+
+export interface UrnOCPPCp220203DeleteCertificateResponse {
+  customData?: CustomDataType;
+  status: DeleteCertificateStatusEnumType;
+  statusInfo?: StatusInfoType;
+}
+/**
+ * This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.
+ */
+export interface CustomDataType {
+  vendorId: string;
+  [k: string]: unknown;
+}
+/**
+ * Element providing more information about the status.
+ *
+ */
+export interface StatusInfoType {
+  customData?: CustomDataType;
+  /**
+   * A predefined code for the reason why the status is returned in this response. The string is case-insensitive.
+   *
+   */
+  reasonCode: string;
+  /**
+   * Additional text to provide detailed information.
+   *
+   */
+  additionalInfo?: string;
+}

package/v2.0/FirmwareStatusNotificationRequest.d.ts

@@ -0,0 +1,45 @@
+/* tslint:disable */
+/**
+ * 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.
+ */
+
+/**
+ * This contains the progress status of the firmware installation.
+ *
+ */
+export type FirmwareStatusEnumType =
+  | "Downloaded"
+  | "DownloadFailed"
+  | "Downloading"
+  | "DownloadScheduled"
+  | "DownloadPaused"
+  | "Idle"
+  | "InstallationFailed"
+  | "Installing"
+  | "Installed"
+  | "InstallRebooting"
+  | "InstallScheduled"
+  | "InstallVerificationFailed"
+  | "InvalidSignature"
+  | "SignatureVerified";
+
+export interface UrnOCPPCp220203FirmwareStatusNotificationRequest {
+  customData?: CustomDataType;
+  status: FirmwareStatusEnumType;
+  /**
+   * The request id that was provided in the
+   * UpdateFirmwareRequest that started this firmware update.
+   * This field is mandatory, unless the message was triggered by a TriggerMessageRequest AND there is no firmware update ongoing.
+   *
+   */
+  requestId?: number;
+}
+/**
+ * This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.
+ */
+export interface CustomDataType {
+  vendorId: string;
+  [k: string]: unknown;
+}

package/v2.0/FirmwareStatusNotificationResponse.d.ts

@@ -0,0 +1,17 @@
+/* tslint:disable */
+/**
+ * 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.
+ */
+
+export interface UrnOCPPCp220203FirmwareStatusNotificationResponse {
+  customData?: CustomDataType;
+}
+/**
+ * This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.
+ */
+export interface CustomDataType {
+  vendorId: string;
+  [k: string]: unknown;
+}

package/v2.0/Get15118EVCertificateRequest.d.ts

@@ -0,0 +1,35 @@
+/* tslint:disable */
+/**
+ * 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.
+ */
+
+/**
+ * Defines whether certificate needs to be installed or updated.
+ *
+ */
+export type CertificateActionEnumType = "Install" | "Update";
+
+export interface UrnOCPPCp220203Get15118EVCertificateRequest {
+  customData?: CustomDataType;
+  /**
+   * Schema version currently used for the 15118 session between EV and Charging Station. Needed for parsing of the EXI stream by the CSMS.
+   *
+   *
+   */
+  iso15118SchemaVersion: string;
+  action: CertificateActionEnumType;
+  /**
+   * Raw CertificateInstallationReq request from EV, Base64 encoded.
+   *
+   */
+  exiRequest: string;
+}
+/**
+ * This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.
+ */
+export interface CustomDataType {
+  vendorId: string;
+  [k: string]: unknown;
+}

package/v2.0/Get15118EVCertificateResponse.d.ts

@@ -0,0 +1,47 @@
+/* tslint:disable */
+/**
+ * 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.
+ */
+
+/**
+ * Indicates whether the message was processed properly.
+ *
+ */
+export type Iso15118EVCertificateStatusEnumType = "Accepted" | "Failed";
+
+export interface UrnOCPPCp220203Get15118EVCertificateResponse {
+  customData?: CustomDataType;
+  status: Iso15118EVCertificateStatusEnumType;
+  statusInfo?: StatusInfoType;
+  /**
+   * Raw CertificateInstallationRes response for the EV, Base64 encoded.
+   *
+   */
+  exiResponse: string;
+}
+/**
+ * This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.
+ */
+export interface CustomDataType {
+  vendorId: string;
+  [k: string]: unknown;
+}
+/**
+ * Element providing more information about the status.
+ *
+ */
+export interface StatusInfoType {
+  customData?: CustomDataType;
+  /**
+   * A predefined code for the reason why the status is returned in this response. The string is case-insensitive.
+   *
+   */
+  reasonCode: string;
+  /**
+   * Additional text to provide detailed information.
+   *
+   */
+  additionalInfo?: string;
+}

package/v2.0/GetBaseReportRequest.d.ts

@@ -0,0 +1,29 @@
+/* tslint:disable */
+/**
+ * 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.
+ */
+
+/**
+ * This field specifies the report base.
+ *
+ */
+export type ReportBaseEnumType = "ConfigurationInventory" | "FullInventory" | "SummaryInventory";
+
+export interface UrnOCPPCp220203GetBaseReportRequest {
+  customData?: CustomDataType;
+  /**
+   * The Id of the request.
+   *
+   */
+  requestId: number;
+  reportBase: ReportBaseEnumType;
+}
+/**
+ * This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.
+ */
+export interface CustomDataType {
+  vendorId: string;
+  [k: string]: unknown;
+}

package/v2.0/GetBaseReportResponse.d.ts

@@ -0,0 +1,42 @@
+/* tslint:disable */
+/**
+ * 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.
+ */
+
+/**
+ * This indicates whether the Charging Station is able to accept this request.
+ *
+ */
+export type GenericDeviceModelStatusEnumType = "Accepted" | "Rejected" | "NotSupported" | "EmptyResultSet";
+
+export interface UrnOCPPCp220203GetBaseReportResponse {
+  customData?: CustomDataType;
+  status: GenericDeviceModelStatusEnumType;
+  statusInfo?: StatusInfoType;
+}
+/**
+ * This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.
+ */
+export interface CustomDataType {
+  vendorId: string;
+  [k: string]: unknown;
+}
+/**
+ * Element providing more information about the status.
+ *
+ */
+export interface StatusInfoType {
+  customData?: CustomDataType;
+  /**
+   * A predefined code for the reason why the status is returned in this response. The string is case-insensitive.
+   *
+   */
+  reasonCode: string;
+  /**
+   * Additional text to provide detailed information.
+   *
+   */
+  additionalInfo?: string;
+}

package/v2.0/GetCertificateStatusRequest.d.ts

@@ -0,0 +1,50 @@
+/* tslint:disable */
+/**
+ * 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.
+ */
+
+/**
+ * Used algorithms for the hashes provided.
+ *
+ */
+export type HashAlgorithmEnumType = "SHA256" | "SHA384" | "SHA512";
+
+export interface UrnOCPPCp220203GetCertificateStatusRequest {
+  customData?: CustomDataType;
+  ocspRequestData: OCSPRequestDataType;
+}
+/**
+ * This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.
+ */
+export interface CustomDataType {
+  vendorId: string;
+  [k: string]: unknown;
+}
+export interface OCSPRequestDataType {
+  customData?: CustomDataType;
+  hashAlgorithm: HashAlgorithmEnumType;
+  /**
+   * Hashed value of the Issuer DN (Distinguished Name).
+   *
+   *
+   */
+  issuerNameHash: string;
+  /**
+   * Hashed value of the issuers public key
+   *
+   */
+  issuerKeyHash: string;
+  /**
+   * The serial number of the certificate.
+   *
+   */
+  serialNumber: string;
+  /**
+   * This contains the responder URL (Case insensitive).
+   *
+   *
+   */
+  responderURL: string;
+}

package/v2.0/GetCertificateStatusResponse.d.ts

@@ -0,0 +1,47 @@
+/* tslint:disable */
+/**
+ * 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.
+ */
+
+/**
+ * This indicates whether the charging station was able to retrieve the OCSP certificate status.
+ *
+ */
+export type GetCertificateStatusEnumType = "Accepted" | "Failed";
+
+export interface UrnOCPPCp220203GetCertificateStatusResponse {
+  customData?: CustomDataType;
+  status: GetCertificateStatusEnumType;
+  statusInfo?: StatusInfoType;
+  /**
+   * OCSPResponse class as defined in <<ref-ocpp_security_24, IETF RFC 6960>>. DER encoded (as defined in <<ref-ocpp_security_24, IETF RFC 6960>>), and then base64 encoded. MAY only be omitted when status is not Accepted.
+   *
+   */
+  ocspResult?: string;
+}
+/**
+ * This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.
+ */
+export interface CustomDataType {
+  vendorId: string;
+  [k: string]: unknown;
+}
+/**
+ * Element providing more information about the status.
+ *
+ */
+export interface StatusInfoType {
+  customData?: CustomDataType;
+  /**
+   * A predefined code for the reason why the status is returned in this response. The string is case-insensitive.
+   *
+   */
+  reasonCode: string;
+  /**
+   * Additional text to provide detailed information.
+   *
+   */
+  additionalInfo?: string;
+}