ResourceAuditVo
in package
implements
ModelInterface, ArrayAccess
Warning:
This class subject to change without prior notice, Please dont use this class directly.
Tags
Interfaces, Classes and Traits
- ModelInterface
- Warning:
- ArrayAccess
Table of Contents
- DISCRIMINATOR = null
- REQUESTOR_TYPE_CLIENT_AGENT = 'client_agent'
- REQUESTOR_TYPE_CUSTOMER = 'customer'
- REQUESTOR_TYPE_EXTERNAL_USER = 'external_user'
- REQUESTOR_TYPE_SYSTEM = 'system'
- $attributeMap : array<string|int, string>
- Array of attributes where the key is the local name, and the value is the original name
- $container : array<string|int, mixed>
- Associative array for storing property values
- $getters : array<string|int, string>
- Array of attributes to getter functions (for serialization of requests)
- $setters : array<string|int, string>
- Array of attributes to setter functions (for deserialization of responses)
- $swaggerFormats : array<string|int, string>
- Array of property to format mappings. Used for (de)serialization
- $swaggerModelName : string
- The original name of the model.
- $swaggerTypes : array<string|int, string>
- Array of property to type mappings. Used for (de)serialization
- __construct() : mixed
- Constructor
- __toString() : string
- Gets the string presentation of the object
- attributeMap() : array<string|int, mixed>
- Array of attributes where the key is the local name, and the value is the original name
- getChannel() : string
- Gets channel
- getModelName() : string
- The original name of the model.
- getRequestor() : string
- Gets requestor
- getRequestorType() : string
- Gets requestor_type
- getRequestorTypeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTimestamp() : string
- Gets timestamp
- offsetExists() : bool
- Returns true if offset exists. False otherwise.
- offsetGet() : mixed
- Gets offset.
- offsetSet() : void
- Sets value based on offset.
- offsetUnset() : void
- Unsets offset.
- setChannel() : $this
- Sets channel
- setRequestor() : $this
- Sets requestor
- setRequestorType() : $this
- Sets requestor_type
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTimestamp() : $this
- Sets timestamp
- swaggerFormats() : array<string|int, mixed>
- Array of property to format mappings. Used for (de)serialization
- swaggerTypes() : array<string|int, mixed>
- Array of property to type mappings. Used for (de)serialization
Constants
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
REQUESTOR_TYPE_CLIENT_AGENT
public
mixed
REQUESTOR_TYPE_CLIENT_AGENT
= 'client_agent'
REQUESTOR_TYPE_CUSTOMER
public
mixed
REQUESTOR_TYPE_CUSTOMER
= 'customer'
REQUESTOR_TYPE_EXTERNAL_USER
public
mixed
REQUESTOR_TYPE_EXTERNAL_USER
= 'external_user'
REQUESTOR_TYPE_SYSTEM
public
mixed
REQUESTOR_TYPE_SYSTEM
= 'system'
Properties
$attributeMap
Array of attributes where the key is the local name, and the value is the original name
protected
static array<string|int, string>
$attributeMap
= ['channel' => 'channel', 'requestor_type' => 'requestor_type', 'requestor' => 'requestor', 'timestamp' => 'timestamp']
$container
Associative array for storing property values
protected
array<string|int, mixed>
$container
= []
$getters
Array of attributes to getter functions (for serialization of requests)
protected
static array<string|int, string>
$getters
= ['channel' => 'getChannel', 'requestor_type' => 'getRequestorType', 'requestor' => 'getRequestor', 'timestamp' => 'getTimestamp']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['channel' => 'setChannel', 'requestor_type' => 'setRequestorType', 'requestor' => 'setRequestor', 'timestamp' => 'setTimestamp']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['channel' => null, 'requestor_type' => null, 'requestor' => null, 'timestamp' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'ResourceAuditVo'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['channel' => 'string', 'requestor_type' => 'string', 'requestor' => 'string', 'timestamp' => 'string']
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
- $data : array<string|int, mixed> = null
-
Associated array of property values initializing the model
Return values
mixed —__toString()
Gets the string presentation of the object
public
__toString() : string
Return values
string —attributeMap()
Array of attributes where the key is the local name, and the value is the original name
public
static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —getChannel()
Gets channel
public
getChannel() : string
Return values
string —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getRequestor()
Gets requestor
public
getRequestor() : string
Return values
string —getRequestorType()
Gets requestor_type
public
getRequestorType() : string
Return values
string —getRequestorTypeAllowableValues()
Gets allowable values of the enum
public
getRequestorTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getTimestamp()
Gets timestamp
public
getTimestamp() : string
Return values
string —offsetExists()
Returns true if offset exists. False otherwise.
public
offsetExists(int $offset) : bool
Parameters
- $offset : int
-
Offset
Return values
bool —offsetGet()
Gets offset.
public
offsetGet(int $offset) : mixed
Parameters
- $offset : int
-
Offset
Return values
mixed —offsetSet()
Sets value based on offset.
public
offsetSet(int $offset, mixed $value) : void
Parameters
- $offset : int
-
Offset
- $value : mixed
-
Value to be set
Return values
void —offsetUnset()
Unsets offset.
public
offsetUnset(int $offset) : void
Parameters
- $offset : int
-
Offset
Return values
void —setChannel()
Sets channel
public
setChannel(string $channel) : $this
Parameters
- $channel : string
-
The channel through which the API is invoked. Please contact <a href = "mailto: support@billerpayments.com">support@billerpayments.com to configure channels.
Return values
$this —setRequestor()
Sets requestor
public
setRequestor(string $requestor) : $this
Parameters
- $requestor : string
-
The identifier for the requestor of the API, in EBPP. The value to be passed in the requestor field would depend on the requestor_type. If the requestor_type is "customer", the requestor should be the EBPP generated customer id. In the case of self registration, where there is no EBPP generated customer id yet, the requestor should be set to 'guest'. If the requestor_type is "external_user", the requestor can be any unique identifier that the client may have for the external agent. If the requestor_type is system, requestor is optional.
Return values
$this —setRequestorType()
Sets requestor_type
public
setRequestorType(string $requestor_type) : $this
Parameters
- $requestor_type : string
-
If an API is being requested from an application that is being used directly by a customer, like the customer portal and IVR, the requestor_type should be set to "customer". If an API is being requested from an application that is being used by third party agents/brokers servicing a customer on behalf of a biller/client, then the requestor_type should be set to "external_user". It should be noted that these users would not have logins for the EBPP Portal or Payment Center.
Return values
$this —setters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —setTimestamp()
Sets timestamp
public
setTimestamp(string $timestamp) : $this
Parameters
- $timestamp : string
-
The UTC timestamp, in ISO8601 format, for the moment when the resource got created or modified in EBPP. For e.g., 2019-08-13T09:21:34.359+0000
Return values
$this —swaggerFormats()
Array of property to format mappings. Used for (de)serialization
public
static swaggerFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —swaggerTypes()
Array of property to type mappings. Used for (de)serialization
public
static swaggerTypes() : array<string|int, mixed>