Documentation

GetTransactionListApi
in package

GetTransactionListApi Class Doc Comment.

Tags
category

Class

author

OpenAPI Generator team

see
https://openapi-generator.tech

Table of Contents

contentTypes  = ['getTransactionList' => ['application/json']]
$client  : ClientInterface
$config  : Configuration
$headerSelector  : HeaderSelector
$hostIndex  : int
$mockMode  : bool
Use the /rbcz/premium/mock/* path for endpoints ?
$SUIPAddress  : string
the end IP address of the client application (no server) in IPv4 or IPv6 format. If the bank client (your user) uses a browser by which he accesses your server app, we need to know the IP address of his browser. Always provide the closest IP address to the real end-user possible. (optional).
$xIBMClientId  : string
ClientID obtained from Developer Portal - when you registered your app with us.
__construct()  : mixed
getConfig()  : Configuration
getHostIndex()  : int
Get the host index.
getTransactionList()  : object
Operation getTransactionList.
getTransactionListAsync()  : PromiseInterface
Operation getTransactionListAsync.
getTransactionListAsyncWithHttpInfo()  : PromiseInterface
Operation getTransactionListAsyncWithHttpInfo.
getTransactionListRequest()  : Request
Create request for operation 'getTransactionList'.
getTransactionListWithHttpInfo()  : array<string|int, mixed>
Operation getTransactionListWithHttpInfo.
getXIBMClientId()  : string
Give you ClientID obtained from Developer Portal.
setHostIndex()  : self
Set the host index.
setMockMode()  : self
setSUIPAddress()  : self
setXIBMClientId()  : self
Keep ClientID obtained from Developer Portal.
createHttpClientOption()  : array<string|int, mixed>
Create http client option.

Constants

contentTypes

public array<string|int, string> contentTypes = ['getTransactionList' => ['application/json']]

Properties

$mockMode

Use the /rbcz/premium/mock/* path for endpoints ?

protected bool $mockMode = false

$SUIPAddress

the end IP address of the client application (no server) in IPv4 or IPv6 format. If the bank client (your user) uses a browser by which he accesses your server app, we need to know the IP address of his browser. Always provide the closest IP address to the real end-user possible. (optional).

protected string $SUIPAddress = ''

Description

$xIBMClientId

ClientID obtained from Developer Portal - when you registered your app with us.

protected string $xIBMClientId = ''

Methods

__construct()

public __construct([ClientInterface|null $client = null ][, Configuration|null $config = null ][, HeaderSelector|null $selector = null ], int $hostIndex) : mixed
Parameters
$client : ClientInterface|null = null
$config : Configuration|null = null
$selector : HeaderSelector|null = null
$hostIndex : int

(Optional) host index to select the list of hosts if defined in the OpenAPI spec

Return values
mixed

getHostIndex()

Get the host index.

public getHostIndex() : int
Return values
int

Host index

getTransactionList()

Operation getTransactionList.

public getTransactionList(string $xRequestId, string $accountNumber, string $currencyCode, DateTime $from, DateTime $to[, null|int $page = null ][, string $contentType = self::contentTypes['getTransactionList'][0] ]) : object
Parameters
$xRequestId : string

Unique request id provided by consumer application for reference and auditing. (required)

$accountNumber : string

Account number for which to get list of transactions in national format without 0 padding. (required)

$currencyCode : string

Currency code of the account in ISO-4217 standard (e.g. czk, eur, usd) (required)

$from : DateTime

Defines date (and optionally time) from which transactions will be requested. If no time is specified then 00:00:00.0 (Central European Time) will be used. Example values - 2021-08-01 or 2021-08-01T10:00:00.0Z (required)

$to : DateTime

Defines date (and optionally time) until which transactions will be requested. If no time is specified then 23:59:59.999 (Central European Time) will be used. Example values - 2021-08-02 or 2021-08-02T14:00:00.0Z (required)

$page : null|int = null

Page number to be requested. The first page is 1. (optional)

$contentType : string = self::contentTypes['getTransactionList'][0]

The value for the Content-Type header. Check self::contentTypes['getTransactionList'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
throws
ApiException

on non-2xx response or if the response body is not in the expected format

Return values
object

getTransactionListAsync()

Operation getTransactionListAsync.

public getTransactionListAsync(string $xRequestId, string $accountNumber, string $currencyCode, DateTime $from, DateTime $to[, null|int $page = null ][, string $contentType = self::contentTypes['getTransactionList'][0] ]) : PromiseInterface
Parameters
$xRequestId : string

Unique request id provided by consumer application for reference and auditing. (required)

$accountNumber : string

Account number for which to get list of transactions in national format without 0 padding. (required)

$currencyCode : string

Currency code of the account in ISO-4217 standard (e.g. czk, eur, usd) (required)

$from : DateTime

Defines date (and optionally time) from which transactions will be requested. If no time is specified then 00:00:00.0 (Central European Time) will be used. Example values - 2021-08-01 or 2021-08-01T10:00:00.0Z (required)

$to : DateTime

Defines date (and optionally time) until which transactions will be requested. If no time is specified then 23:59:59.999 (Central European Time) will be used. Example values - 2021-08-02 or 2021-08-02T14:00:00.0Z (required)

$page : null|int = null

Page number to be requested. The first page is 1. (optional)

$contentType : string = self::contentTypes['getTransactionList'][0]

The value for the Content-Type header. Check self::contentTypes['getTransactionList'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getTransactionListAsyncWithHttpInfo()

Operation getTransactionListAsyncWithHttpInfo.

public getTransactionListAsyncWithHttpInfo(string $xRequestId, string $accountNumber, string $currencyCode, DateTime $from, DateTime $to[, null|int $page = null ][, string $contentType = self::contentTypes['getTransactionList'][0] ]) : PromiseInterface
Parameters
$xRequestId : string

Unique request id provided by consumer application for reference and auditing. (required)

$accountNumber : string

Account number for which to get list of transactions in national format without 0 padding. (required)

$currencyCode : string

Currency code of the account in ISO-4217 standard (e.g. czk, eur, usd) (required)

$from : DateTime

Defines date (and optionally time) from which transactions will be requested. If no time is specified then 00:00:00.0 (Central European Time) will be used. Example values - 2021-08-01 or 2021-08-01T10:00:00.0Z (required)

$to : DateTime

Defines date (and optionally time) until which transactions will be requested. If no time is specified then 23:59:59.999 (Central European Time) will be used. Example values - 2021-08-02 or 2021-08-02T14:00:00.0Z (required)

$page : null|int = null

Page number to be requested. The first page is 1. (optional)

$contentType : string = self::contentTypes['getTransactionList'][0]

The value for the Content-Type header. Check self::contentTypes['getTransactionList'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getTransactionListRequest()

Create request for operation 'getTransactionList'.

public getTransactionListRequest(string $xRequestId, string $accountNumber, string $currencyCode, DateTime $from, DateTime $to[, null|int $page = null ][, string $contentType = self::contentTypes['getTransactionList'][0] ]) : Request
Parameters
$xRequestId : string

Unique request id provided by consumer application for reference and auditing. (required)

$accountNumber : string

Account number for which to get list of transactions in national format without 0 padding. (required)

$currencyCode : string

Currency code of the account in ISO-4217 standard (e.g. czk, eur, usd) (required)

$from : DateTime

Defines date (and optionally time) from which transactions will be requested. If no time is specified then 00:00:00.0 (Central European Time) will be used. Example values - 2021-08-01 or 2021-08-01T10:00:00.0Z (required)

$to : DateTime

Defines date (and optionally time) until which transactions will be requested. If no time is specified then 23:59:59.999 (Central European Time) will be used. Example values - 2021-08-02 or 2021-08-02T14:00:00.0Z (required)

$page : null|int = null

Page number to be requested. The first page is 1. (optional)

$contentType : string = self::contentTypes['getTransactionList'][0]

The value for the Content-Type header. Check self::contentTypes['getTransactionList'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getTransactionListWithHttpInfo()

Operation getTransactionListWithHttpInfo.

public getTransactionListWithHttpInfo(string $xRequestId, string $accountNumber, string $currencyCode, DateTime $from, DateTime $to[, null|int $page = null ][, string $contentType = self::contentTypes['getTransactionList'][0] ]) : array<string|int, mixed>
Parameters
$xRequestId : string

Unique request id provided by consumer application for reference and auditing. (required)

$accountNumber : string

Account number for which to get list of transactions in national format without 0 padding. (required)

$currencyCode : string

Currency code of the account in ISO-4217 standard (e.g. czk, eur, usd) (required)

$from : DateTime

Defines date (and optionally time) from which transactions will be requested. If no time is specified then 00:00:00.0 (Central European Time) will be used. Example values - 2021-08-01 or 2021-08-01T10:00:00.0Z (required)

$to : DateTime

Defines date (and optionally time) until which transactions will be requested. If no time is specified then 23:59:59.999 (Central European Time) will be used. Example values - 2021-08-02 or 2021-08-02T14:00:00.0Z (required)

$page : null|int = null

Page number to be requested. The first page is 1. (optional)

$contentType : string = self::contentTypes['getTransactionList'][0]

The value for the Content-Type header. Check self::contentTypes['getTransactionList'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
throws
ApiException

on non-2xx response or if the response body is not in the expected format

Return values
array<string|int, mixed>

of object|object|object|object|object|object, HTTP status code, HTTP response headers (array of strings)

getXIBMClientId()

Give you ClientID obtained from Developer Portal.

public getXIBMClientId() : string
Return values
string

setHostIndex()

Set the host index.

public setHostIndex(int $hostIndex) : self
Parameters
$hostIndex : int

Host index (required)

Return values
self

setMockMode()

public setMockMode(bool $mocking) : self
Parameters
$mocking : bool

Use mocking api for development purposes ?

Return values
self

setSUIPAddress()

public setSUIPAddress(string $SUIPAddress) : self
Parameters
$SUIPAddress : string

IP address of a client

Return values
self

setXIBMClientId()

Keep ClientID obtained from Developer Portal.

public setXIBMClientId(string $clientId) : self
Parameters
$clientId : string

Description

Return values
self

createHttpClientOption()

Create http client option.

protected createHttpClientOption() : array<string|int, mixed>
Tags
throws
RuntimeException

on file opening failure

Return values
array<string|int, mixed>

of http client options

Search results