/** * Enumeration of possible idToken types. * */ export declare type IdTokenEnumType = 'Central' | 'eMAID' | 'ISO14443' | 'ISO15693' | 'KeyCode' | 'Local' | 'MacAddress' | 'NoAuthorization'; /** * ID_ Token. Status. Authorization_ Status * urn:x-oca:ocpp:uid:1:569372 * Current status of the ID Token. * */ export declare type AuthorizationStatusEnumType = 'Accepted' | 'Blocked' | 'ConcurrentTx' | 'Expired' | 'Invalid' | 'NoCredit' | 'NotAllowedTypeEVSE' | 'NotAtThisLocation' | 'NotAtThisTime' | 'Unknown'; /** * Message_ Content. Format. Message_ Format_ Code * urn:x-enexis:ecdm:uid:1:570848 * Format of the message. * */ export declare type MessageFormatEnumType = 'ASCII' | 'HTML' | 'URI' | 'UTF8'; /** * This contains the type of update (full or differential) of this request. * */ export declare type UpdateEnumType = 'Differential' | 'Full'; export default interface SendLocalListRequest { customData?: CustomDataType; localAuthorizationList?: [AuthorizationData, ...AuthorizationData[]]; /** * In case of a full update this is the version number of the full list. In case of a differential update it is the version number of the list after the update has been applied. * */ versionNumber: number; updateType: UpdateEnumType; } /** * 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; } /** * Contains the identifier to use for authorization. * */ export interface AuthorizationData { customData?: CustomDataType; idToken: IdTokenType; idTokenInfo?: IdTokenInfoType; } /** * 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; 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; } /** * ID_ Token * urn:x-oca:ocpp:uid:2:233247 * Contains status information about an identifier. * It 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. * */ export interface IdTokenInfoType { customData?: CustomDataType; status: AuthorizationStatusEnumType; /** * ID_ Token. Expiry. Date_ Time * urn:x-oca:ocpp:uid:1:569373 * Date and Time after which the token must be considered invalid. * */ cacheExpiryDateTime?: string; /** * 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. * */ chargingPriority?: number; /** * ID_ Token. Language1. Language_ Code * urn:x-oca:ocpp:uid:1:569374 * Preferred user interface language of identifier user. Contains a language code as defined in <<ref-RFC5646,[RFC5646]>>. * * */ language1?: string; /** * Only used when the IdToken is only valid for one or more specific EVSEs, not for the entire Charging Station. * * */ evseId?: [number, ...number[]]; groupIdToken?: IdTokenType; /** * ID_ Token. Language2. Language_ Code * urn:x-oca:ocpp:uid:1:569375 * Second 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]>>. * */ language2?: string; personalMessage?: MessageContentType; } /** * Message_ Content * urn:x-enexis:ecdm:uid:2:234490 * Contains message details, for a message to be displayed on a Charging Station. * * */ export interface MessageContentType { customData?: CustomDataType; format: MessageFormatEnumType; /** * Message_ Content. Language. Language_ Code * urn:x-enexis:ecdm:uid:1:570849 * Message language identifier. Contains a language code as defined in <<ref-RFC5646,[RFC5646]>>. * */ language?: string; /** * Message_ Content. Content. Message * urn:x-enexis:ecdm:uid:1:570852 * Message contents. * * */ content: string; }