Class VattenfallService

Represents the Vattenfall Service, providing methods to interact with the service's API.

Constructors

constructor

new VattenfallService(username, password): VattenfallService
Constructs an instance of the class with a unique transaction ID, username, and password.
Parameters
- username: string
  The username for the instance.
- password: string
  The password for the instance.
Returns VattenfallService
- Defined in src/index.ts:111

Properties

`Protected` `Optional`_access_token_data

Optional variable _access_token_data which holds the access token information.

This variable may contain the data structure defined by the AccessTokenData type in the Types namespace. It is used to store the details of an access token, which typically includes properties such as the token value, expiry time, and possibly other metadata related to authentication and authorization.

`Protected`_debug_logging_enabled

_debug_logging_enabled: boolean = false

A boolean flag that indicates whether debug logging is enabled. When set to true, the application will output additional debug information to the logs. This can be useful for troubleshooting and development purposes. Default value is false.

`Protected` `Optional`_parent_log_id

_parent_log_id?: string

Represents the unique identifier of the parent log entry. This variable is optional, meaning it might be undefined. If present, it denotes the ID of the log entry that is the parent in a hierarchical log structure, aiding in tracking relational log data.

`Protected`_password

_password: string

Represents the password of a user. This string is used for authenticating the user. It should be kept confidential and secured.

`Protected` `Optional`_properties

_properties?: ServiceProperties

Represents the properties associated with the service, retrieved at instantiation time from service_properties_uri.

_transaction_id

_transaction_id: string

A unique identifier for a transaction. This ID is used to track and reference individual transactions within the system. It ensures that each transaction can be distinctly identified.

`Protected`_username

_username: string

Represents the username of a user in the system. This is a string that uniquely identifies a user.

`Readonly`access_token_ttl_seconds

access_token_ttl_seconds: number = ...

The number of seconds that an access token remains valid.

This value determines the time-to-live (TTL) for access tokens, ensuring they expire after a certain period of inactivity or usage. Typically used to control session timeouts and enhance security.

`Protected` `Readonly`api_client

api_client: string = "KSO"

The client's API identifier used for making requests. This string is typically configured to represent the name or key associated with the API client in use.

`Protected` `Readonly`api_tenant

api_tenant: string = "VESALES"

A string representing the tenant identifier for the API. This tenant id differentiates the API usage context and allows the system to apply the appropriate configurations and access controls.

Example: "VESALES"

`Readonly`api_version

api_version: number = 1.3

The version number of the API that the application is currently using. This variable helps in managing and differentiating between different iterations or releases of the API.

`Readonly`service_properties_uri

service_properties_uri = "https://service.vattenfall.de/properties.json"

The URI that points to the properties configuration file for the Vattenfall service. This URI is used to fetch various properties and settings required for the service's operation.

Accessors

access_token_data

get access_token_data(): undefined | AccessTokenData
Retrieves the access token data.

Returns undefined | AccessTokenData
The access token data, or undefined if not set.
- Defined in src/index.ts:140

password

get password(): string
Retrieves the current password.

Returns string
The current password.
- Defined in src/index.ts:131

service_properties

get service_properties(): undefined | ServiceProperties
Retrieves the service properties.

Returns undefined | ServiceProperties
The service properties if available, otherwise undefined.
- Defined in src/index.ts:149

username

get username(): string
Gets the current username.

Returns string
The current username.
- Defined in src/index.ts:122

Methods

`Protected`_processResponse

_processResponse<R>(response): Promise<R>
Processes the HTTP response and returns it in the specified format.
Type Parameters
- R extends Response
Parameters
- response: Response
  The HTTP response to process.
Returns Promise<R>
The processed response in the specified format.
- Defined in src/index.ts:316

`Protected`_request

_request<D>(uri, method?, data?): Promise<Response>
Makes an HTTP request to the specified URI with the given method and data. This is an internal method that returns a Response object.
Type Parameters
- D extends RequestData
Parameters
- uri: string
  The endpoint URI to which the request is made.
- method: HTTPMethod = Types.HTTPMethod.GET
  The HTTP method to be used for the request (e.g., GET, POST).
- Optionaldata: D
  The data to be sent with the request, if applicable.
Returns Promise<Response>
A promise that resolves to the response of the request.
- Defined in src/index.ts:274

`Protected`debug

debug(...data): void
Logs the provided data to the console if debug logging is enabled.
Parameters
- Rest...data: unknown[]
  The data to be logged.
Returns void
- Defined in src/index.ts:168

delete

delete<R>(uri): Promise<R>
Deletes a resource at the specified URI.
Type Parameters
- R extends Response
Parameters
- uri: string
  The URI of the resource to be deleted.
Returns Promise<R>
A promise resolving to the API response.
- Defined in src/index.ts:386

error

error(message): never
Throws a VattenfallApiError with the given message.
Parameters
- message: string
  The error message to be included in the VattenfallApiError.
Returns never
This method does not return as it always throws an error.
- Defined in src/index.ts:159

get

get<R>(uri): Promise<R>
Makes an HTTP GET request to the given URI and returns the response.
Type Parameters
- R extends Response
Parameters
- uri: string
  The URI to send the GET request to.
Returns Promise<R>
A promise that resolves to the API response.
- Defined in src/index.ts:354

getAccessToken

getAccessToken(force?): Promise<string>
Retrieves an access token for the user. If the current access token is expired and the force parameter is set to false, it refreshes the access token.
Parameters
- force: boolean = false
  Whether to forcefully obtain a new access token even if the current one is not expired.
Returns Promise<string>
A promise that resolves to the access token string.
- Defined in src/index.ts:427

getAccount

getAccount(): Promise<Account>
Fetches the account information from the server.

Returns Promise<Account>
A promise that resolves to the account information.
- Defined in src/index.ts:490

getContract

getContract(contract_id): Promise<ContractResponse>
Retrieves contract data based on the provided contract ID.
Parameters
- contract_id: string
  The ID of the contract to retrieve.
Returns Promise<ContractResponse>
A promise that resolves with the contract data.
- Defined in src/index.ts:518

getContractList

getContractList(): Promise<ContractResponse>
Fetches the list of contracts for the user.

Returns Promise<ContractResponse>
A promise that resolves to the contract data.
- Defined in src/index.ts:502

getMeterReadings

getMeterReadings(contract_id): Promise<MeterReadingResponse>
Fetches the meter readings for a given contract ID.
Parameters
- contract_id: string
  The ID of the contract for which meter readings are being requested.
Returns Promise<MeterReadingResponse>
A promise that resolves to the meter reading response.
- Defined in src/index.ts:530

getServiceProperties

getServiceProperties(refresh?): Promise<ServiceProperties>
Fetches and returns the service properties. If the service properties have been previously fetched and stored, it returns the stored properties. Otherwise, it fetches the properties from a predefined URL, stores them, and then returns them. In case of an error during fetching, it logs the error message.
Parameters
- refresh: boolean = false
Returns Promise<ServiceProperties>
A promise that resolves to the service properties.
- Defined in src/index.ts:228

isAuthenticated

isAuthenticated(): boolean
Checks if the user is authenticated by verifying the presence of access token data.

Returns boolean
Returns true if access token data exists, otherwise false.
- Defined in src/index.ts:246

isTokenExpired

isTokenExpired(): boolean
Checks if the current access token has expired.

Returns boolean
True if the token is expired, otherwise false.
- Defined in src/index.ts:255

logIn

logIn(): Promise<void>
Returns Promise<void>
- Defined in src/index.ts:458

logOut

logOut(): Promise<void>
Logs the user out by invalidating the current access token.

This method checks if the user is authenticated before attempting to log out. If authenticated, it sends a request to the server to delete the current token. If the server response indicates a token expiry error, the error is not thrown. Otherwise, any other errors encountered during the logout process are thrown.

Returns Promise<void>
A promise that resolves when the logout operation is complete.
- Defined in src/index.ts:472

post

post<R, D>(uri, data): Promise<R>
Sends an HTTP POST request to the specified URI with the given request data and returns the response.
Type Parameters
- R extends Response
- D extends RequestData
Parameters
- uri: string
  The URI to send the POST request to.
- data: D
  The data to be sent with the POST request.
Returns Promise<R>
A promise that resolves to the response data.
- Defined in src/index.ts:365

put

put<R, D>(uri, data): Promise<R>
Sends an HTTP PUT request to the specified URI with the given data.
Type Parameters
- R extends Response
- D extends RequestData
Parameters
- uri: string
  The URI to which the PUT request is sent.
- data: D
  The data to be sent in the body of the PUT request.
Returns Promise<R>
A promise that resolves to the response of the PUT request.
- Defined in src/index.ts:376

raiseOnErrorResponse

raiseOnErrorResponse(response): void
Checks the given API response and throws an error if the response status is not "OK".
Parameters
- response: Response
  The API response to check for an error status.
Returns void
Returns nothing if the response is "OK"; otherwise, throws a VattenfallApiError.
- Defined in src/index.ts:187

refreshAccessToken

refreshAccessToken(): Promise<void>
Refreshes the access token using the refresh token.

This method checks if the current access token data is available. If not, it triggers a fresh retrieval of the access token. Otherwise, it attempts to refresh the current access token using the refresh token. In case of any error that indicates token expiry, it retrieves a new access token.

Returns Promise<void>
A promise that resolves once the access token is refreshed or a new one is retrieved.
- Defined in src/index.ts:401

`Protected`request

request<R, D>(uri, method?, data?): Promise<R>
Makes an HTTP request to the specified URI with the provided method and data, and returns a promise that resolves to the response.
Type Parameters
- R extends Response
- D extends RequestData
Parameters
- uri: string
  The URI to send the request to.
- method: HTTPMethod = Types.HTTPMethod.GET
  The HTTP method to use for the request. Defaults to GET.
- Optionaldata: D
  The data to send with the request. Optional.
Returns Promise<R>
A promise that resolves to the response of the HTTP request.
- Defined in src/index.ts:339

resetTransactionId

resetTransactionId(id?): Promise<void>
Resets the transaction ID for the current session.
Parameters
- Optionalid: string
  Optional parameter to set a specific transaction ID. If not provided, a new UUID will be generated and used.
Returns Promise<void>
- A promise that resolves when the transaction ID has been reset.
- Defined in src/index.ts:201

setCredentials

setCredentials(username, password): Promise<void>
Asynchronously sets the user credentials for a transaction.
Parameters
- username: string
  The username to be set.
- password: string
  The password to be set.
Returns Promise<void>
- Defined in src/index.ts:213

setDebugLogging

setDebugLogging(enabled): void
Enables or disables debug logging for the application.
Parameters
- enabled: boolean
  A boolean value indicating whether debug logging should be enabled.
Returns void
- Defined in src/index.ts:177

Class VattenfallService

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns VattenfallService

Properties

Protected Optional_access_token_data

Protected_debug_logging_enabled

Protected Optional_parent_log_id

Protected_password

Protected Optional_properties

_transaction_id

Protected_username

Readonlyaccess_token_ttl_seconds

Protected Readonlyapi_client

Protected Readonlyapi_tenant

Readonlyapi_version

Readonlyservice_properties_uri

Accessors

access_token_data

Returns undefined | AccessTokenData

password

Returns string

service_properties

Returns undefined | ServiceProperties

username

Returns string

Methods

Protected_processResponse

Type Parameters

Parameters

Returns Promise<R>

Protected_request

Type Parameters

Parameters

Returns Promise<Response>

Protecteddebug

Parameters

Returns void

delete

Type Parameters

Parameters

Returns Promise<R>

error

Parameters

Returns never

get

Type Parameters

Parameters

Returns Promise<R>

getAccessToken

Parameters

Returns Promise<string>

getAccount

Returns Promise<Account>

getContract

Parameters

Returns Promise<ContractResponse>

getContractList

Returns Promise<ContractResponse>

getMeterReadings

Parameters

Returns Promise<MeterReadingResponse>

getServiceProperties

Parameters

Returns Promise<ServiceProperties>

isAuthenticated

Returns boolean

isTokenExpired

Returns boolean

logIn

Returns Promise<void>

logOut

Returns Promise<void>

post

`Protected` `Optional`_access_token_data

`Protected`_debug_logging_enabled

`Protected` `Optional`_parent_log_id

`Protected`_password

`Protected` `Optional`_properties

`Protected`_username

`Readonly`access_token_ttl_seconds

`Protected` `Readonly`api_client

`Protected` `Readonly`api_tenant

`Readonly`api_version

`Readonly`service_properties_uri

`Protected`_processResponse

`Protected`_request

`Protected`debug

`Protected`request