@zetra/citrineos-base 1.8.3-fork.1

package/dist/ocpp/model/2.0.1/schemas/AuthorizeRequest.json

@@ -0,0 +1,169 @@
+{
+    "$id": "AuthorizeRequest",
+    "comment": "OCPP 2.0.1 FINAL",
+    "definitions": {
+        "CustomDataType": {
+            "description": "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.",
+            "javaType": "CustomData",
+            "type": "object",
+            "properties": {
+                "vendorId": {
+                    "type": "string",
+                    "maxLength": 255
+                }
+            },
+            "required": ["vendorId"]
+        },
+        "HashAlgorithmEnumType": {
+            "description": "Used algorithms for the hashes provided.\r\n",
+            "javaType": "HashAlgorithmEnum",
+            "type": "string",
+            "additionalProperties": false,
+            "enum": ["SHA256", "SHA384", "SHA512"],
+            "tsEnumNames": ["SHA256", "SHA384", "SHA512"]
+        },
+        "IdTokenEnumType": {
+            "description": "Enumeration of possible idToken types.\r\n",
+            "javaType": "IdTokenEnum",
+            "type": "string",
+            "additionalProperties": false,
+            "enum": [
+                "Central",
+                "eMAID",
+                "ISO14443",
+                "ISO15693",
+                "KeyCode",
+                "Local",
+                "MacAddress",
+                "NoAuthorization"
+            ],
+            "tsEnumNames": [
+                "Central",
+                "eMAID",
+                "ISO14443",
+                "ISO15693",
+                "KeyCode",
+                "Local",
+                "MacAddress",
+                "NoAuthorization"
+            ]
+        },
+        "AdditionalInfoType": {
+            "description": "Contains a case insensitive identifier to use for the authorization and the type of authorization to support multiple forms of identifiers.\r\n",
+            "javaType": "AdditionalInfo",
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "customData": {
+                    "$ref": "#/definitions/CustomDataType"
+                },
+                "additionalIdToken": {
+                    "description": "This field specifies the additional IdToken.\r\n",
+                    "type": "string",
+                    "maxLength": 36,
+                    "pattern": "^[a-zA-Z0-9*\\-_=:+|@.]*$"
+                },
+                "type": {
+                    "description": "This defines the type of the additionalIdToken. This is a custom type, so the implementation needs to be agreed upon by all involved parties.\r\n",
+                    "type": "string",
+                    "maxLength": 50
+                }
+            },
+            "required": ["additionalIdToken", "type"]
+        },
+        "IdTokenType": {
+            "description": "Contains a case insensitive identifier to use for the authorization and the type of authorization to support multiple forms of identifiers.\r\n",
+            "javaType": "IdToken",
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "customData": {
+                    "$ref": "#/definitions/CustomDataType"
+                },
+                "additionalInfo": {
+                    "type": "array",
+                    "additionalItems": false,
+                    "items": {
+                        "$ref": "#/definitions/AdditionalInfoType"
+                    },
+                    "minItems": 1
+                },
+                "idToken": {
+                    "description": "IdToken is case insensitive. Might hold the hidden id of an RFID tag, but can for example also contain a UUID.\r\n",
+                    "type": "string",
+                    "maxLength": 36,
+                    "pattern": "^[a-zA-Z0-9*\\-_=:+|@.]*$"
+                },
+                "type": {
+                    "$ref": "#/definitions/IdTokenEnumType"
+                }
+            },
+            "required": ["idToken", "type"]
+        },
+        "OCSPRequestDataType": {
+            "javaType": "OCSPRequestData",
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "customData": {
+                    "$ref": "#/definitions/CustomDataType"
+                },
+                "hashAlgorithm": {
+                    "$ref": "#/definitions/HashAlgorithmEnumType"
+                },
+                "issuerNameHash": {
+                    "description": "Hashed value of the Issuer DN (Distinguished Name).\r\n\r\n",
+                    "type": "string",
+                    "maxLength": 128
+                },
+                "issuerKeyHash": {
+                    "description": "Hashed value of the issuers public key\r\n",
+                    "type": "string",
+                    "maxLength": 128
+                },
+                "serialNumber": {
+                    "description": "The serial number of the certificate.\r\n",
+                    "type": "string",
+                    "maxLength": 40
+                },
+                "responderURL": {
+                    "description": "This contains the responder URL (Case insensitive). \r\n\r\n",
+                    "type": "string",
+                    "maxLength": 512
+                }
+            },
+            "required": [
+                "hashAlgorithm",
+                "issuerNameHash",
+                "issuerKeyHash",
+                "serialNumber",
+                "responderURL"
+            ]
+        }
+    },
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+        "customData": {
+            "$ref": "#/definitions/CustomDataType"
+        },
+        "idToken": {
+            "$ref": "#/definitions/IdTokenType"
+        },
+        "certificate": {
+            "description": "The X.509 certificated presented by EV and encoded in PEM format.\r\n",
+            "type": "string",
+            "maxLength": 5500
+        },
+        "iso15118CertificateHashData": {
+            "type": "array",
+            "additionalItems": false,
+            "items": {
+                "$ref": "#/definitions/OCSPRequestDataType"
+            },
+            "minItems": 1,
+            "maxItems": 4
+        }
+    },
+    "required": ["idToken"]
+}

package/dist/ocpp/model/2.0.1/schemas/AuthorizeResponse.json

@@ -0,0 +1,248 @@
+{
+    "$id": "AuthorizeResponse",
+    "comment": "OCPP 2.0.1 FINAL",
+    "definitions": {
+        "CustomDataType": {
+            "description": "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.",
+            "javaType": "CustomData",
+            "type": "object",
+            "properties": {
+                "vendorId": {
+                    "type": "string",
+                    "maxLength": 255
+                }
+            },
+            "required": ["vendorId"]
+        },
+        "AuthorizationStatusEnumType": {
+            "description": "ID_ Token. Status. Authorization_ Status\r\nurn:x-oca:ocpp:uid:1:569372\r\nCurrent status of the ID Token.\r\n",
+            "javaType": "AuthorizationStatusEnum",
+            "type": "string",
+            "additionalProperties": false,
+            "enum": [
+                "Accepted",
+                "Blocked",
+                "ConcurrentTx",
+                "Expired",
+                "Invalid",
+                "NoCredit",
+                "NotAllowedTypeEVSE",
+                "NotAtThisLocation",
+                "NotAtThisTime",
+                "Unknown"
+            ],
+            "tsEnumNames": [
+                "Accepted",
+                "Blocked",
+                "ConcurrentTx",
+                "Expired",
+                "Invalid",
+                "NoCredit",
+                "NotAllowedTypeEVSE",
+                "NotAtThisLocation",
+                "NotAtThisTime",
+                "Unknown"
+            ]
+        },
+        "AuthorizeCertificateStatusEnumType": {
+            "description": "Certificate status information. \r\n- if all certificates are valid: return 'Accepted'.\r\n- if one of the certificates was revoked, return 'CertificateRevoked'.\r\n",
+            "javaType": "AuthorizeCertificateStatusEnum",
+            "type": "string",
+            "additionalProperties": false,
+            "enum": [
+                "Accepted",
+                "SignatureError",
+                "CertificateExpired",
+                "CertificateRevoked",
+                "NoCertificateAvailable",
+                "CertChainError",
+                "ContractCancelled"
+            ],
+            "tsEnumNames": [
+                "Accepted",
+                "SignatureError",
+                "CertificateExpired",
+                "CertificateRevoked",
+                "NoCertificateAvailable",
+                "CertChainError",
+                "ContractCancelled"
+            ]
+        },
+        "IdTokenEnumType": {
+            "description": "Enumeration of possible idToken types.\r\n",
+            "javaType": "IdTokenEnum",
+            "type": "string",
+            "additionalProperties": false,
+            "enum": [
+                "Central",
+                "eMAID",
+                "ISO14443",
+                "ISO15693",
+                "KeyCode",
+                "Local",
+                "MacAddress",
+                "NoAuthorization"
+            ],
+            "tsEnumNames": [
+                "Central",
+                "eMAID",
+                "ISO14443",
+                "ISO15693",
+                "KeyCode",
+                "Local",
+                "MacAddress",
+                "NoAuthorization"
+            ]
+        },
+        "MessageFormatEnumType": {
+            "description": "Message_ Content. Format. Message_ Format_ Code\r\nurn:x-enexis:ecdm:uid:1:570848\r\nFormat of the message.\r\n",
+            "javaType": "MessageFormatEnum",
+            "type": "string",
+            "additionalProperties": false,
+            "enum": ["ASCII", "HTML", "URI", "UTF8"],
+            "tsEnumNames": ["ASCII", "HTML", "URI", "UTF8"]
+        },
+        "AdditionalInfoType": {
+            "description": "Contains a case insensitive identifier to use for the authorization and the type of authorization to support multiple forms of identifiers.\r\n",
+            "javaType": "AdditionalInfo",
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "customData": {
+                    "$ref": "#/definitions/CustomDataType"
+                },
+                "additionalIdToken": {
+                    "description": "This field specifies the additional IdToken.\r\n",
+                    "type": "string",
+                    "maxLength": 36
+                },
+                "type": {
+                    "description": "This defines the type of the additionalIdToken. This is a custom type, so the implementation needs to be agreed upon by all involved parties.\r\n",
+                    "type": "string",
+                    "maxLength": 50
+                }
+            },
+            "required": ["additionalIdToken", "type"]
+        },
+        "IdTokenInfoType": {
+            "description": "ID_ Token\r\nurn:x-oca:ocpp:uid:2:233247\r\nContains status information about an identifier.\r\nIt is advised to not stop charging for a token that expires during charging, as ExpiryDate is only used for caching purposes. If ExpiryDate is not given, the status has no end date.\r\n",
+            "javaType": "IdTokenInfo",
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "customData": {
+                    "$ref": "#/definitions/CustomDataType"
+                },
+                "status": {
+                    "$ref": "#/definitions/AuthorizationStatusEnumType"
+                },
+                "cacheExpiryDateTime": {
+                    "description": "ID_ Token. Expiry. Date_ Time\r\nurn:x-oca:ocpp:uid:1:569373\r\nDate and Time after which the token must be considered invalid.\r\n",
+                    "type": "string",
+                    "format": "date-time"
+                },
+                "chargingPriority": {
+                    "description": "Priority from a business point of view. Default priority is 0, The range is from -9 to 9. Higher values indicate a higher priority. The chargingPriority in <<transactioneventresponse,TransactionEventResponse>> overrules this one. \r\n",
+                    "type": "integer",
+                    "minimum": -9,
+                    "maximum": 9
+                },
+                "language1": {
+                    "description": "ID_ Token. Language1. Language_ Code\r\nurn:x-oca:ocpp:uid:1:569374\r\nPreferred user interface language of identifier user. Contains a language code as defined in <<ref-RFC5646,[RFC5646]>>.\r\n\r\n",
+                    "type": "string",
+                    "maxLength": 8
+                },
+                "evseId": {
+                    "description": "Only used when the IdToken is only valid for one or more specific EVSEs, not for the entire Charging Station.\r\n\r\n",
+                    "type": "array",
+                    "additionalItems": false,
+                    "items": {
+                        "type": "integer",
+                        "minimum": -2147483648,
+                        "maximum": 2147483647
+                    },
+                    "minItems": 1
+                },
+                "groupIdToken": {
+                    "$ref": "#/definitions/IdTokenType"
+                },
+                "language2": {
+                    "description": "ID_ Token. Language2. Language_ Code\r\nurn:x-oca:ocpp:uid:1:569375\r\nSecond preferred user interface language of identifier user. Don’t use when language1 is omitted, has to be different from language1. Contains a language code as defined in <<ref-RFC5646,[RFC5646]>>.\r\n",
+                    "type": "string",
+                    "maxLength": 8
+                },
+                "personalMessage": {
+                    "$ref": "#/definitions/MessageContentType"
+                }
+            },
+            "required": ["status"]
+        },
+        "IdTokenType": {
+            "description": "Contains a case insensitive identifier to use for the authorization and the type of authorization to support multiple forms of identifiers.\r\n",
+            "javaType": "IdToken",
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "customData": {
+                    "$ref": "#/definitions/CustomDataType"
+                },
+                "additionalInfo": {
+                    "type": "array",
+                    "additionalItems": false,
+                    "items": {
+                        "$ref": "#/definitions/AdditionalInfoType"
+                    },
+                    "minItems": 1
+                },
+                "idToken": {
+                    "description": "IdToken is case insensitive. Might hold the hidden id of an RFID tag, but can for example also contain a UUID.\r\n",
+                    "type": "string",
+                    "maxLength": 36
+                },
+                "type": {
+                    "$ref": "#/definitions/IdTokenEnumType"
+                }
+            },
+            "required": ["idToken", "type"]
+        },
+        "MessageContentType": {
+            "description": "Message_ Content\r\nurn:x-enexis:ecdm:uid:2:234490\r\nContains message details, for a message to be displayed on a Charging Station.\r\n\r\n",
+            "javaType": "MessageContent",
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "customData": {
+                    "$ref": "#/definitions/CustomDataType"
+                },
+                "format": {
+                    "$ref": "#/definitions/MessageFormatEnumType"
+                },
+                "language": {
+                    "description": "Message_ Content. Language. Language_ Code\r\nurn:x-enexis:ecdm:uid:1:570849\r\nMessage language identifier. Contains a language code as defined in <<ref-RFC5646,[RFC5646]>>.\r\n",
+                    "type": "string",
+                    "maxLength": 8
+                },
+                "content": {
+                    "description": "Message_ Content. Content. Message\r\nurn:x-enexis:ecdm:uid:1:570852\r\nMessage contents.\r\n\r\n",
+                    "type": "string",
+                    "maxLength": 512
+                }
+            },
+            "required": ["format", "content"]
+        }
+    },
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+        "customData": {
+            "$ref": "#/definitions/CustomDataType"
+        },
+        "idTokenInfo": {
+            "$ref": "#/definitions/IdTokenInfoType"
+        },
+        "certificateStatus": {
+            "$ref": "#/definitions/AuthorizeCertificateStatusEnumType"
+        }
+    },
+    "required": ["idTokenInfo"]
+}

package/dist/ocpp/model/2.0.1/schemas/BootNotificationRequest.json

@@ -0,0 +1,117 @@
+{
+    "$id": "BootNotificationRequest",
+    "comment": "OCPP 2.0.1 FINAL",
+    "definitions": {
+        "CustomDataType": {
+            "description": "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.",
+            "javaType": "CustomData",
+            "type": "object",
+            "properties": {
+                "vendorId": {
+                    "type": "string",
+                    "maxLength": 255
+                }
+            },
+            "required": ["vendorId"]
+        },
+        "BootReasonEnumType": {
+            "description": "This contains the reason for sending this message to the CSMS.\r\n",
+            "javaType": "BootReasonEnum",
+            "type": "string",
+            "additionalProperties": false,
+            "enum": [
+                "ApplicationReset",
+                "FirmwareUpdate",
+                "LocalReset",
+                "PowerUp",
+                "RemoteReset",
+                "ScheduledReset",
+                "Triggered",
+                "Unknown",
+                "Watchdog"
+            ],
+            "tsEnumNames": [
+                "ApplicationReset",
+                "FirmwareUpdate",
+                "LocalReset",
+                "PowerUp",
+                "RemoteReset",
+                "ScheduledReset",
+                "Triggered",
+                "Unknown",
+                "Watchdog"
+            ]
+        },
+        "ChargingStationType": {
+            "description": "Charge_ Point\r\nurn:x-oca:ocpp:uid:2:233122\r\nThe physical system where an Electrical Vehicle (EV) can be charged.\r\n",
+            "javaType": "ChargingStation",
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "customData": {
+                    "$ref": "#/definitions/CustomDataType"
+                },
+                "serialNumber": {
+                    "description": "Device. Serial_ Number. Serial_ Number\r\nurn:x-oca:ocpp:uid:1:569324\r\nVendor-specific device identifier.\r\n",
+                    "type": "string",
+                    "maxLength": 25
+                },
+                "model": {
+                    "description": "Device. Model. CI20_ Text\r\nurn:x-oca:ocpp:uid:1:569325\r\nDefines the model of the device.\r\n",
+                    "type": "string",
+                    "maxLength": 20
+                },
+                "modem": {
+                    "$ref": "#/definitions/ModemType"
+                },
+                "vendorName": {
+                    "description": "Identifies the vendor (not necessarily in a unique manner).\r\n",
+                    "type": "string",
+                    "maxLength": 50
+                },
+                "firmwareVersion": {
+                    "description": "This contains the firmware version of the Charging Station.\r\n\r\n",
+                    "type": "string",
+                    "maxLength": 50
+                }
+            },
+            "required": ["model", "vendorName"]
+        },
+        "ModemType": {
+            "description": "Wireless_ Communication_ Module\r\nurn:x-oca:ocpp:uid:2:233306\r\nDefines parameters required for initiating and maintaining wireless communication with other devices.\r\n",
+            "javaType": "Modem",
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "customData": {
+                    "$ref": "#/definitions/CustomDataType"
+                },
+                "iccid": {
+                    "description": "Wireless_ Communication_ Module. ICCID. CI20_ Text\r\nurn:x-oca:ocpp:uid:1:569327\r\nThis contains the ICCID of the modem's SIM card.\r\n",
+                    "type": "string",
+                    "maxLength": 20,
+                    "pattern": "^[a-zA-Z0-9*\\-_=:+|@.]*$"
+                },
+                "imsi": {
+                    "description": "Wireless_ Communication_ Module. IMSI. CI20_ Text\r\nurn:x-oca:ocpp:uid:1:569328\r\nThis contains the IMSI of the modem’s SIM card.\r\n",
+                    "type": "string",
+                    "maxLength": 20
+                }
+            }
+        }
+    },
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+        "customData": {
+            "$ref": "#/definitions/CustomDataType"
+        },
+        "chargingStation": {
+            "$ref": "#/definitions/ChargingStationType"
+        },
+        "reason": {
+            "$ref": "#/definitions/BootReasonEnumType"
+        }
+    },
+    "required": ["reason", "chargingStation"]
+}

package/dist/ocpp/model/2.0.1/schemas/BootNotificationResponse.json

@@ -0,0 +1,73 @@
+{
+    "$id": "BootNotificationResponse",
+    "comment": "OCPP 2.0.1 FINAL",
+    "definitions": {
+        "CustomDataType": {
+            "description": "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.",
+            "javaType": "CustomData",
+            "type": "object",
+            "properties": {
+                "vendorId": {
+                    "type": "string",
+                    "maxLength": 255
+                }
+            },
+            "required": ["vendorId"]
+        },
+        "RegistrationStatusEnumType": {
+            "description": "This contains whether the Charging Station has been registered\r\nwithin the CSMS.\r\n",
+            "javaType": "RegistrationStatusEnum",
+            "type": "string",
+            "additionalProperties": false,
+            "enum": ["Accepted", "Pending", "Rejected"],
+            "tsEnumNames": ["Accepted", "Pending", "Rejected"]
+        },
+        "StatusInfoType": {
+            "description": "Element providing more information about the status.\r\n",
+            "javaType": "StatusInfo",
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "customData": {
+                    "$ref": "#/definitions/CustomDataType"
+                },
+                "reasonCode": {
+                    "description": "A predefined code for the reason why the status is returned in this response. The string is case-insensitive.\r\n",
+                    "type": "string",
+                    "maxLength": 20
+                },
+                "additionalInfo": {
+                    "description": "Additional text to provide detailed information.\r\n",
+                    "type": "string",
+                    "maxLength": 512
+                }
+            },
+            "required": ["reasonCode"]
+        }
+    },
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+        "customData": {
+            "$ref": "#/definitions/CustomDataType"
+        },
+        "currentTime": {
+            "description": "This contains the CSMS’s current time.\r\n",
+            "type": "string",
+            "format": "date-time"
+        },
+        "interval": {
+            "description": "When <<cmn_registrationstatusenumtype,Status>> is Accepted, this contains the heartbeat interval in seconds. If the CSMS returns something other than Accepted, the value of the interval field indicates the minimum wait time before sending a next BootNotification request.\r\n",
+            "type": "integer",
+            "minimum": -2147483648,
+            "maximum": 2147483647
+        },
+        "status": {
+            "$ref": "#/definitions/RegistrationStatusEnumType"
+        },
+        "statusInfo": {
+            "$ref": "#/definitions/StatusInfoType"
+        }
+    },
+    "required": ["currentTime", "interval", "status"]
+}

package/dist/ocpp/model/2.0.1/schemas/CancelReservationRequest.json

@@ -0,0 +1,32 @@
+{
+    "$id": "CancelReservationRequest",
+    "comment": "OCPP 2.0.1 FINAL",
+    "definitions": {
+        "CustomDataType": {
+            "description": "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.",
+            "javaType": "CustomData",
+            "type": "object",
+            "properties": {
+                "vendorId": {
+                    "type": "string",
+                    "maxLength": 255
+                }
+            },
+            "required": ["vendorId"]
+        }
+    },
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+        "customData": {
+            "$ref": "#/definitions/CustomDataType"
+        },
+        "reservationId": {
+            "description": "Id of the reservation to cancel.\r\n",
+            "type": "integer",
+            "minimum": -2147483648,
+            "maximum": 2147483647
+        }
+    },
+    "required": ["reservationId"]
+}