Documentation

GetBatchDetailApi

GetBatchDetailApi Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech

Table of Contents

contentTypes  = ['getBatchDetail' => ['application/json']]
$client  : ClientInterface
$config  : Configuration
$headerSelector  : HeaderSelector
$hostIndex  : int
$mockMode  : mixed
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
getBatchDetail()  : object
Operation getBatchDetail
getBatchDetailAsync()  : PromiseInterface
Operation getBatchDetailAsync
getBatchDetailAsyncWithHttpInfo()  : PromiseInterface
Operation getBatchDetailAsyncWithHttpInfo
getBatchDetailRequest()  : Request
Create request for operation 'getBatchDetail'
getBatchDetailWithHttpInfo()  : array<string|int, mixed>
Operation getBatchDetailWithHttpInfo
getConfig()  : Configuration
getHostIndex()  : int
Get the host index
getXIBMClientId()  : string
Give you ClientID obtained from Developer Portal
setHostIndex()  : void
Set the host index
setMockMode()  : mixed
setSUIPAddress()  : mixed
setXIBMClientId()  : string
Keep ClientID obtained from Developer Portal
createHttpClientOption()  : array<string|int, mixed>
Create http client option

Constants

contentTypes

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

Properties

$mockMode

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

protected mixed $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 = null

Description

$xIBMClientId

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

protected string $xIBMClientId = null

Methods

__construct()

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

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

Return values
mixed

getBatchDetail()

Operation getBatchDetail

public getBatchDetail(string $xRequestId, int $batchFileId[, string $contentType = self::contentTypes['getBatchDetail'][0] ]) : object
Parameters
$xRequestId : string

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

$batchFileId : int

Batch file id (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object

getBatchDetailAsync()

Operation getBatchDetailAsync

public getBatchDetailAsync(string $xRequestId, int $batchFileId[, string $contentType = self::contentTypes['getBatchDetail'][0] ]) : PromiseInterface
Parameters
$xRequestId : string

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

$batchFileId : int

Batch file id (required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getBatchDetailAsyncWithHttpInfo()

Operation getBatchDetailAsyncWithHttpInfo

public getBatchDetailAsyncWithHttpInfo(string $xRequestId, int $batchFileId[, string $contentType = self::contentTypes['getBatchDetail'][0] ]) : PromiseInterface
Parameters
$xRequestId : string

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

$batchFileId : int

Batch file id (required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getBatchDetailRequest()

Create request for operation 'getBatchDetail'

public getBatchDetailRequest(string $xRequestId, int $batchFileId[, string $contentType = self::contentTypes['getBatchDetail'][0] ]) : Request
Parameters
$xRequestId : string

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

$batchFileId : int

Batch file id (required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request

getBatchDetailWithHttpInfo()

Operation getBatchDetailWithHttpInfo

public getBatchDetailWithHttpInfo(string $xRequestId, int $batchFileId[, string $contentType = self::contentTypes['getBatchDetail'][0] ]) : array<string|int, mixed>
Parameters
$xRequestId : string

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

$batchFileId : int

Batch file id (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of object|object|object|object|object|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) : void
Parameters
$hostIndex : int

Host index (required)

Return values
void

setMockMode()

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

Use mocking api for development purposes ?

Return values
mixed

setSUIPAddress()

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

IP address of a client

Return values
mixed

setXIBMClientId()

Keep ClientID obtained from Developer Portal

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

Description

Return values
string

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