ocpp-messages 0.1.0

package/v2.0/CancelReservationRequest.d.ts

@@ -0,0 +1,22 @@
+/* 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 UrnOCPPCp220203CancelReservationRequest {
+  customData?: CustomDataType;
+  /**
+   * Id of the reservation to cancel.
+   *
+   */
+  reservationId: 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/CancelReservationResponse.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 the success or failure of the canceling of a reservation by CSMS.
+ *
+ */
+export type CancelReservationStatusEnumType = "Accepted" | "Rejected";
+
+export interface UrnOCPPCp220203CancelReservationResponse {
+  customData?: CustomDataType;
+  status: CancelReservationStatusEnumType;
+  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/CertificateSignedRequest.d.ts

@@ -0,0 +1,32 @@
+/* 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 the type of the signed certificate that is returned. When omitted the certificate is used for both the 15118 connection (if implemented) and the Charging Station to CSMS connection. This field is required when a typeOfCertificate was included in the <<signcertificaterequest,SignCertificateRequest>> that requested this certificate to be signed AND both the 15118 connection and the Charging Station connection are implemented.
+ *
+ *
+ */
+export type CertificateSigningUseEnumType = "ChargingStationCertificate" | "V2GCertificate";
+
+export interface UrnOCPPCp220203CertificateSignedRequest {
+  customData?: CustomDataType;
+  /**
+   * The signed PEM encoded X.509 certificate. This can also contain the necessary sub CA certificates. In that case, the order of the bundle should follow the certificate chain, starting from the leaf certificate.
+   *
+   * The Configuration Variable <<configkey-max-certificate-chain-size,MaxCertificateChainSize>> can be used to limit the maximum size of this field.
+   *
+   */
+  certificateChain: string;
+  certificateType?: CertificateSigningUseEnumType;
+}
+/**
+ * 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/CertificateSignedResponse.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.
+ */
+
+/**
+ * Returns whether certificate signing has been accepted, otherwise rejected.
+ *
+ */
+export type CertificateSignedStatusEnumType = "Accepted" | "Rejected";
+
+export interface UrnOCPPCp220203CertificateSignedResponse {
+  customData?: CustomDataType;
+  status: CertificateSignedStatusEnumType;
+  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/ChangeAvailabilityRequest.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 contains the type of availability change that the Charging Station should perform.
+ *
+ *
+ */
+export type OperationalStatusEnumType = "Inoperative" | "Operative";
+
+export interface UrnOCPPCp220203ChangeAvailabilityRequest {
+  customData?: CustomDataType;
+  evse?: EVSEType;
+  operationalStatus: OperationalStatusEnumType;
+}
+/**
+ * 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;
+}
+/**
+ * EVSE
+ * urn:x-oca:ocpp:uid:2:233123
+ * Electric Vehicle Supply Equipment
+ *
+ */
+export interface EVSEType {
+  customData?: CustomDataType;
+  /**
+   * Identified_ Object. MRID. Numeric_ Identifier
+   * urn:x-enexis:ecdm:uid:1:569198
+   * EVSE Identifier. This contains a number (> 0) designating an EVSE of the Charging Station.
+   *
+   */
+  id: number;
+  /**
+   * An id to designate a specific connector (on an EVSE) by connector index number.
+   *
+   */
+  connectorId?: number;
+}

package/v2.0/ChangeAvailabilityResponse.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 perform the availability change.
+ *
+ */
+export type ChangeAvailabilityStatusEnumType = "Accepted" | "Rejected" | "Scheduled";
+
+export interface UrnOCPPCp220203ChangeAvailabilityResponse {
+  customData?: CustomDataType;
+  status: ChangeAvailabilityStatusEnumType;
+  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/ClearCacheRequest.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 UrnOCPPCp220203ClearCacheRequest {
+  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/ClearCacheResponse.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.
+ */
+
+/**
+ * Accepted if the Charging Station has executed the request, otherwise rejected.
+ *
+ */
+export type ClearCacheStatusEnumType = "Accepted" | "Rejected";
+
+export interface UrnOCPPCp220203ClearCacheResponse {
+  customData?: CustomDataType;
+  status: ClearCacheStatusEnumType;
+  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/ClearChargingProfileRequest.d.ts

@@ -0,0 +1,60 @@
+/* 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_ Profile. Charging_ Profile_ Purpose. Charging_ Profile_ Purpose_ Code
+ * urn:x-oca:ocpp:uid:1:569231
+ * Specifies to purpose of the charging profiles that will be cleared, if they meet the other criteria in the request.
+ *
+ */
+export type ChargingProfilePurposeEnumType =
+  | "ChargingStationExternalConstraints"
+  | "ChargingStationMaxProfile"
+  | "TxDefaultProfile"
+  | "TxProfile";
+
+export interface UrnOCPPCp220203ClearChargingProfileRequest {
+  customData?: CustomDataType;
+  /**
+   * The Id of the charging profile to clear.
+   *
+   */
+  chargingProfileId?: number;
+  chargingProfileCriteria?: ClearChargingProfileType;
+}
+/**
+ * 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;
+}
+/**
+ * Charging_ Profile
+ * urn:x-oca:ocpp:uid:2:233255
+ * A ChargingProfile consists of a ChargingSchedule, describing the amount of power or current that can be delivered per time interval.
+ *
+ */
+export interface ClearChargingProfileType {
+  customData?: CustomDataType;
+  /**
+   * Identified_ Object. MRID. Numeric_ Identifier
+   * urn:x-enexis:ecdm:uid:1:569198
+   * Specifies the id of the EVSE for which to clear charging profiles. An evseId of zero (0) specifies the charging profile for the overall Charging Station. Absence of this parameter means the clearing applies to all charging profiles that match the other criteria in the request.
+   *
+   *
+   */
+  evseId?: number;
+  chargingProfilePurpose?: ChargingProfilePurposeEnumType;
+  /**
+   * Charging_ Profile. Stack_ Level. Counter
+   * urn:x-oca:ocpp:uid:1:569230
+   * Specifies the stackLevel for which charging profiles will be cleared, if they meet the other criteria in the request.
+   *
+   */
+  stackLevel?: number;
+}

package/v2.0/ClearChargingProfileResponse.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 if the Charging Station was able to execute the request.
+ *
+ */
+export type ClearChargingProfileStatusEnumType = "Accepted" | "Unknown";
+
+export interface UrnOCPPCp220203ClearChargingProfileResponse {
+  customData?: CustomDataType;
+  status: ClearChargingProfileStatusEnumType;
+  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/ClearDisplayMessageRequest.d.ts

@@ -0,0 +1,22 @@
+/* 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 UrnOCPPCp220203ClearDisplayMessageRequest {
+  customData?: CustomDataType;
+  /**
+   * Id of the message that SHALL be removed from the Charging Station.
+   *
+   */
+  id: 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/ClearDisplayMessageResponse.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.
+ */
+
+/**
+ * Returns whether the Charging Station has been able to remove the message.
+ *
+ */
+export type ClearMessageStatusEnumType = "Accepted" | "Unknown";
+
+export interface UrnOCPPCp220203ClearDisplayMessageResponse {
+  customData?: CustomDataType;
+  status: ClearMessageStatusEnumType;
+  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/ClearVariableMonitoringRequest.d.ts

@@ -0,0 +1,24 @@
+/* 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 UrnOCPPCp220203ClearVariableMonitoringRequest {
+  customData?: CustomDataType;
+  /**
+   * List of the monitors to be cleared, identified by there Id.
+   *
+   *
+   * @minItems 1
+   */
+  id: [number, ...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/ClearVariableMonitoringResponse.d.ts

@@ -0,0 +1,56 @@
+/* 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.
+ */
+
+/**
+ * Result of the clear request for this monitor, identified by its Id.
+ *
+ *
+ */
+export type ClearMonitoringStatusEnumType = "Accepted" | "Rejected" | "NotFound";
+
+export interface UrnOCPPCp220203ClearVariableMonitoringResponse {
+  customData?: CustomDataType;
+  /**
+   * @minItems 1
+   */
+  clearMonitoringResult: [ClearMonitoringResultType, ...ClearMonitoringResultType[]];
+}
+/**
+ * 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 ClearMonitoringResultType {
+  customData?: CustomDataType;
+  status: ClearMonitoringStatusEnumType;
+  /**
+   * Id of the monitor of which a clear was requested.
+   *
+   *
+   */
+  id: number;
+  statusInfo?: StatusInfoType;
+}
+/**
+ * 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/ClearedChargingLimitRequest.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.
+ */
+
+/**
+ * Source of the charging limit.
+ *
+ */
+export type ChargingLimitSourceEnumType = "EMS" | "Other" | "SO" | "CSO";
+
+export interface UrnOCPPCp220203ClearedChargingLimitRequest {
+  customData?: CustomDataType;
+  chargingLimitSource: ChargingLimitSourceEnumType;
+  /**
+   * EVSE Identifier.
+   *
+   */
+  evseId?: 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/ClearedChargingLimitResponse.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 UrnOCPPCp220203ClearedChargingLimitResponse {
+  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/CostUpdatedRequest.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.
+ */
+
+export interface UrnOCPPCp220203CostUpdatedRequest {
+  customData?: CustomDataType;
+  /**
+   * Current total cost, based on the information known by the CSMS, of the transaction including taxes. In the currency configured with the configuration Variable: [<<configkey-currency, Currency>>]
+   *
+   *
+   */
+  totalCost: number;
+  /**
+   * Transaction Id of the transaction the current cost are asked for.
+   *
+   *
+   */
+  transactionId: 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/CostUpdatedResponse.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 UrnOCPPCp220203CostUpdatedResponse {
+  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;
+}