Documentation

DownloadStatementApi
in package

DownloadStatementApi Class Doc Comment.

Tags
category

Class

author

OpenAPI Generator team

see
https://openapi-generator.tech

Table of Contents

contentTypes  = ['downloadStatement' => ['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
downloadStatement()  : object|SplFileObject|GetBalance404Response
Operation downloadStatement.
downloadStatementAsync()  : PromiseInterface
Operation downloadStatementAsync.
downloadStatementAsyncWithHttpInfo()  : PromiseInterface
Operation downloadStatementAsyncWithHttpInfo.
downloadStatementRequest()  : Request
Create request for operation 'downloadStatement'.
downloadStatementWithHttpInfo()  : array<string|int, mixed>
Operation downloadStatementWithHttpInfo.
getConfig()  : Configuration
getHostIndex()  : int
Get the host index.
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 = ['downloadStatement' => ['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

downloadStatement()

Operation downloadStatement.

public downloadStatement(string $xRequestId, string $acceptLanguage, DownloadStatementRequest $requestBody[, string $contentType = self::contentTypes['downloadStatement'][0] ]) : object|SplFileObject|GetBalance404Response
Parameters
$xRequestId : string

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

$acceptLanguage : string

The Accept-Language request HTTP header is used to determine document language. Supported languages are `cs` and `en`. (required)

$requestBody : DownloadStatementRequest

requestBody (required)

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

The value for the Content-Type header. Check self::contentTypes['downloadStatement'] 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|SplFileObject|GetBalance404Response

downloadStatementAsync()

Operation downloadStatementAsync.

public downloadStatementAsync(string $xRequestId, string $acceptLanguage, DownloadStatementRequest $requestBody[, string $contentType = self::contentTypes['downloadStatement'][0] ]) : PromiseInterface
Parameters
$xRequestId : string

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

$acceptLanguage : string

The Accept-Language request HTTP header is used to determine document language. Supported languages are `cs` and `en`. (required)

$requestBody : DownloadStatementRequest

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

downloadStatementAsyncWithHttpInfo()

Operation downloadStatementAsyncWithHttpInfo.

public downloadStatementAsyncWithHttpInfo(string $xRequestId, string $acceptLanguage, DownloadStatementRequest $requestBody[, string $contentType = self::contentTypes['downloadStatement'][0] ]) : PromiseInterface
Parameters
$xRequestId : string

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

$acceptLanguage : string

The Accept-Language request HTTP header is used to determine document language. Supported languages are `cs` and `en`. (required)

$requestBody : DownloadStatementRequest

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

downloadStatementRequest()

Create request for operation 'downloadStatement'.

public downloadStatementRequest(string $xRequestId, string $acceptLanguage, DownloadStatementRequest $requestBody[, string $contentType = self::contentTypes['downloadStatement'][0] ]) : Request
Parameters
$xRequestId : string

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

$acceptLanguage : string

The Accept-Language request HTTP header is used to determine document language. Supported languages are `cs` and `en`. (required)

$requestBody : DownloadStatementRequest

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

downloadStatementWithHttpInfo()

Operation downloadStatementWithHttpInfo.

public downloadStatementWithHttpInfo(string $xRequestId, string $acceptLanguage, DownloadStatementRequest $requestBody[, string $contentType = self::contentTypes['downloadStatement'][0] ]) : array<string|int, mixed>
Parameters
$xRequestId : string

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

$acceptLanguage : string

The Accept-Language request HTTP header is used to determine document language. Supported languages are `cs` and `en`. (required)

$requestBody : DownloadStatementRequest

(required)

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

The value for the Content-Type header. Check self::contentTypes['downloadStatement'] 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 \SplFileObject|object|object|object|\VitexSoftware\Raiffeisenbank\Model\GetBalance404Response|object, HTTP status code, HTTP response headers (array of strings)

getHostIndex()

Get the host index.

public getHostIndex() : int
Return values
int

Host index

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