Client | pankkiyhteys

Hierarchy

SoapClient
- Client
  - Osuuspankki

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Client(username: string, key: Key, language: Language, bic: string, endpoint: string, certService: CertService, environment?: Environment): Client

- Defined in application.ts:116
Parameters
- username: string
- key: Key
- language: Language
- bic: string
- endpoint: string
- certService: CertService
- Default value environment: Environment = Environment.PRODUCTION
Returns Client

Properties

bic

bic: string

Bank identification code

endpoint

endpoint: string

environment

environment: Environment

key

key: Key

language

language: Language

trustStore

trustStore: TrustStore

username

username: string

Methods

addMinutes

addMinutes(date: Date, time: number): Date

Inherited from SoapClient.addMinutes
- Defined in soap.ts:29
Helper method to add minutes to given Date object.

If a parameter specified is outside of the expected range, set*() attempts to update the date information in the Date object accordingly

Parameters
- date: Date
- time: number
Returns Date

formatTime

formatTime(date: Date): string

Inherited from SoapClient.formatTime
- Defined in soap.ts:19
Helper method to format time string.

Parameters
- date: Date
Returns string

getFile

getFile(fileReference: string): Promise<Buffer>

- Defined in application.ts:169
Download file

The client must have obtained the fileReference value beforehand, e.g. using the getFileList or uploadFile operations.

Parameters
- fileReference: string
  
  Unique identification of the file.
Returns Promise<Buffer>

getFileList

getFileList(options?: GetFileListOptions): Promise<any>

- Defined in application.ts:145
Get list of files

Parameters
- Default value options: GetFileListOptions = {}
Returns Promise<any>

makeRequest

makeRequest(service: string, applicationRequest: ApplicationRequest, timestamp?: Date): Promise<object>

- Defined in application.ts:204
Make request to corporate file service.

Parameters
- service: string
  
  Request type
- applicationRequest: ApplicationRequest
  
  Request payload
- Default value timestamp: Date = new Date()
Returns Promise<object>

makeSoapRequest

makeSoapRequest(url: string, body: __type): Promise<any>
makeSoapRequest(url: string, body: __type, signatureKey: Key, trustStore: TrustStore): Promise<any>

Inherited from SoapClient.makeSoapRequest
- Defined in soap.ts:47
Make soap request.

Parameters
- url: string
  
  Endpoint url.
- body: __type
  
  Soap request body element.
Returns Promise<any>
Inherited from SoapClient.makeSoapRequest
- Defined in soap.ts:48
Parameters
- url: string
- body: __type
- signatureKey: Key
- trustStore: TrustStore
Returns Promise<any>

requestId

requestId(): string

Inherited from SoapClient.requestId
- Defined in soap.ts:37
Generate 35 character long random request id.

Returns string

Protected signApplicationRequest

signApplicationRequest(xml: string): string

- Defined in application.ts:265
Sign application request

Parameters
- xml: string
Returns string

verifyRequestCallback

verifyRequestCallback(xml: string, document: any): Promise<void>

- Defined in application.ts:274
Verify request signature in application request parsing callback

Parameters
- xml: string
- document: any
Returns Promise<void>

Generated using TypeDoc