GetFxRatesApi
in package
GetFxRatesApi Class Doc Comment.
Tags
Table of Contents
Constants
- contentTypes = ['getFxRates' => ['application/json']]
Properties
- $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.
Methods
- __construct() : mixed
- getConfig() : Configuration
- getFxRates() : CurrencyListSimple|GetBalance429Response
- Operation getFxRates.
- getFxRatesAsync() : PromiseInterface
- Operation getFxRatesAsync.
- getFxRatesAsyncWithHttpInfo() : PromiseInterface
- Operation getFxRatesAsyncWithHttpInfo.
- getFxRatesRequest() : Request
- Create request for operation 'getFxRates'.
- getFxRatesWithHttpInfo() : array<string|int, mixed>
- Operation getFxRatesWithHttpInfo.
- 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
= ['getFxRates' => ['application/json']]
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
$hostIndex
protected
int
$hostIndex
= 0
Host index
$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 = 0 ]) : mixed
Parameters
- $client : ClientInterface|null = null
- $config : Configuration|null = null
- $selector : HeaderSelector|null = null
- $hostIndex : int = 0
-
(Optional) host index to select the list of hosts if defined in the OpenAPI spec
getConfig()
public
getConfig() : Configuration
Return values
ConfigurationgetFxRates()
Operation getFxRates.
public
getFxRates(string $xRequestId, string $currencyCode[, null|DateTime $date = null ][, string $contentType = self::contentTypes['getFxRates'][0] ]) : CurrencyListSimple|GetBalance429Response
Parameters
- $xRequestId : string
-
Unique request id provided by consumer application for reference and auditing. (required)
- $currencyCode : string
-
The foreign currency code in ISO-4217 format. (required)
- $date : null|DateTime = null
-
The effective date for which the FX rates are requested. Will default to now when not specified. (optional)
- $contentType : string = self::contentTypes['getFxRates'][0]
-
The value for the Content-Type header. Check self::contentTypes['getFxRates'] to see the possible values for this operation
Tags
Return values
CurrencyListSimple|GetBalance429ResponsegetFxRatesAsync()
Operation getFxRatesAsync.
public
getFxRatesAsync(string $xRequestId, string $currencyCode[, null|DateTime $date = null ][, string $contentType = self::contentTypes['getFxRates'][0] ]) : PromiseInterface
Parameters
- $xRequestId : string
-
Unique request id provided by consumer application for reference and auditing. (required)
- $currencyCode : string
-
The foreign currency code in ISO-4217 format. (required)
- $date : null|DateTime = null
-
The effective date for which the FX rates are requested. Will default to now when not specified. (optional)
- $contentType : string = self::contentTypes['getFxRates'][0]
-
The value for the Content-Type header. Check self::contentTypes['getFxRates'] to see the possible values for this operation
Tags
Return values
PromiseInterfacegetFxRatesAsyncWithHttpInfo()
Operation getFxRatesAsyncWithHttpInfo.
public
getFxRatesAsyncWithHttpInfo(string $xRequestId, string $currencyCode[, null|DateTime $date = null ][, string $contentType = self::contentTypes['getFxRates'][0] ]) : PromiseInterface
Parameters
- $xRequestId : string
-
Unique request id provided by consumer application for reference and auditing. (required)
- $currencyCode : string
-
The foreign currency code in ISO-4217 format. (required)
- $date : null|DateTime = null
-
The effective date for which the FX rates are requested. Will default to now when not specified. (optional)
- $contentType : string = self::contentTypes['getFxRates'][0]
-
The value for the Content-Type header. Check self::contentTypes['getFxRates'] to see the possible values for this operation
Tags
Return values
PromiseInterfacegetFxRatesRequest()
Create request for operation 'getFxRates'.
public
getFxRatesRequest(string $xRequestId, string $currencyCode[, null|DateTime $date = null ][, string $contentType = self::contentTypes['getFxRates'][0] ]) : Request
Parameters
- $xRequestId : string
-
Unique request id provided by consumer application for reference and auditing. (required)
- $currencyCode : string
-
The foreign currency code in ISO-4217 format. (required)
- $date : null|DateTime = null
-
The effective date for which the FX rates are requested. Will default to now when not specified. (optional)
- $contentType : string = self::contentTypes['getFxRates'][0]
-
The value for the Content-Type header. Check self::contentTypes['getFxRates'] to see the possible values for this operation
Tags
Return values
RequestgetFxRatesWithHttpInfo()
Operation getFxRatesWithHttpInfo.
public
getFxRatesWithHttpInfo(string $xRequestId, string $currencyCode[, null|DateTime $date = null ][, string $contentType = self::contentTypes['getFxRates'][0] ]) : array<string|int, mixed>
Parameters
- $xRequestId : string
-
Unique request id provided by consumer application for reference and auditing. (required)
- $currencyCode : string
-
The foreign currency code in ISO-4217 format. (required)
- $date : null|DateTime = null
-
The effective date for which the FX rates are requested. Will default to now when not specified. (optional)
- $contentType : string = self::contentTypes['getFxRates'][0]
-
The value for the Content-Type header. Check self::contentTypes['getFxRates'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \VitexSoftware\Raiffeisenbank\Model\CurrencyListSimple|\VitexSoftware\Raiffeisenbank\Model\GetBalance429Response, 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
stringsetHostIndex()
Set the host index.
public
setHostIndex(int $hostIndex) : self
Parameters
- $hostIndex : int
-
Host index (required)
Return values
selfsetMockMode()
public
setMockMode(bool $mocking) : self
Parameters
- $mocking : bool
-
Use mocking api for development purposes ?
Return values
selfsetSUIPAddress()
public
setSUIPAddress(string $SUIPAddress) : self
Parameters
- $SUIPAddress : string
-
IP address of a client
Return values
selfsetXIBMClientId()
Keep ClientID obtained from Developer Portal.
public
setXIBMClientId(string $clientId) : self
Parameters
- $clientId : string
-
Description
Return values
selfcreateHttpClientOption()
Create http client option.
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options