GetAccountsApi
in package
GetAccountsApi Class Doc Comment.
Tags
Table of Contents
- contentTypes = ['getAccounts' => ['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
- getAccounts() : object
- Operation getAccounts.
- getAccountsAsync() : PromiseInterface
- Operation getAccountsAsync.
- getAccountsAsyncWithHttpInfo() : PromiseInterface
- Operation getAccountsAsyncWithHttpInfo.
- getAccountsRequest() : Request
- Create request for operation 'getAccounts'.
- getAccountsWithHttpInfo() : array<string|int, mixed>
- Operation getAccountsWithHttpInfo.
- 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
= ['getAccounts' => ['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) : 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 —getAccounts()
Operation getAccounts.
public
getAccounts(string $xRequestId[, null|int $page = null ][, null|int $size = null ][, string $contentType = self::contentTypes['getAccounts'][0] ]) : object
Parameters
- $xRequestId : string
-
Unique request id provided by consumer application for reference and auditing. (required)
- $page : null|int = null
-
Number of the requested page. Default is 1. (optional)
- $size : null|int = null
-
Number of items on the page. Default is 15. (optional)
- $contentType : string = self::contentTypes['getAccounts'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAccounts'] to see the possible values for this operation
Tags
Return values
object —getAccountsAsync()
Operation getAccountsAsync.
public
getAccountsAsync(string $xRequestId[, null|int $page = null ][, null|int $size = null ][, string $contentType = self::contentTypes['getAccounts'][0] ]) : PromiseInterface
Parameters
- $xRequestId : string
-
Unique request id provided by consumer application for reference and auditing. (required)
- $page : null|int = null
-
Number of the requested page. Default is 1. (optional)
- $size : null|int = null
-
Number of items on the page. Default is 15. (optional)
- $contentType : string = self::contentTypes['getAccounts'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAccounts'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAccountsAsyncWithHttpInfo()
Operation getAccountsAsyncWithHttpInfo.
public
getAccountsAsyncWithHttpInfo(string $xRequestId[, null|int $page = null ][, null|int $size = null ][, string $contentType = self::contentTypes['getAccounts'][0] ]) : PromiseInterface
Parameters
- $xRequestId : string
-
Unique request id provided by consumer application for reference and auditing. (required)
- $page : null|int = null
-
Number of the requested page. Default is 1. (optional)
- $size : null|int = null
-
Number of items on the page. Default is 15. (optional)
- $contentType : string = self::contentTypes['getAccounts'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAccounts'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAccountsRequest()
Create request for operation 'getAccounts'.
public
getAccountsRequest(string $xRequestId[, null|int $page = null ][, null|int $size = null ][, string $contentType = self::contentTypes['getAccounts'][0] ]) : Request
Parameters
- $xRequestId : string
-
Unique request id provided by consumer application for reference and auditing. (required)
- $page : null|int = null
-
Number of the requested page. Default is 1. (optional)
- $size : null|int = null
-
Number of items on the page. Default is 15. (optional)
- $contentType : string = self::contentTypes['getAccounts'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAccounts'] to see the possible values for this operation
Tags
Return values
Request —getAccountsWithHttpInfo()
Operation getAccountsWithHttpInfo.
public
getAccountsWithHttpInfo(string $xRequestId[, null|int $page = null ][, null|int $size = null ][, string $contentType = self::contentTypes['getAccounts'][0] ]) : array<string|int, mixed>
Parameters
- $xRequestId : string
-
Unique request id provided by consumer application for reference and auditing. (required)
- $page : null|int = null
-
Number of the requested page. Default is 1. (optional)
- $size : null|int = null
-
Number of items on the page. Default is 15. (optional)
- $contentType : string = self::contentTypes['getAccounts'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAccounts'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of object|object|object|object, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —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
Return values
array<string|int, mixed> —of http client options