Documentation

Customers extends Base
in package

Customers Class Doc Comment

Tags
category

Class

Table of Contents

DISCRIMINATOR  = null
$api_end_point  : string
$attributeMap  : array<string|int, string>
Array of attributes where the key is the local name, and the value is the original name
$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
$swaggerTypes  : array<string|int, string>
Array of property to type mappings. Used for (de)serialization
$account_number  : string
$customer_reference  : string
$email  : string
$from_index  : string
$has_more_results  : string
$http_status_code  : mixed
$invocation_context  : InvocationContext
$list  : array<string|int, Customer>
$live_mode  : string
$page_size  : string
$query_id  : string
$ssn  : string
$to_index  : string
$total_results_count  : string
$url  : string
__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
findBy()  : mixed
forClient()  : mixed
get()  : Customers
get
getAccountNumber()  : string
Gets account_number
getApiEndPoint()  : string
getCustomerReference()  : string
Gets customer_reference
getEmail()  : string
Gets email
getFromIndex()  : string
Gets from_index
getHasMoreResults()  : string
Gets has_more_results
getHttpStatusCode()  : mixed
getInvocationContext()  : InvocationContext
getList()  : array<string|int, Customer>
Gets list
getPage()  : Customers
getPage
getPageSize()  : string
Gets page_size
getQueryId()  : string
Gets query_id
getSsn()  : string
Gets ssn
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getToIndex()  : string
Gets to_index
getTotalResultsCount()  : string
Gets total_results_count
getUrl()  : string
Gets url
jsonSerialize()  : mixed
Specify data which should be serialized to JSON
retrievedBy()  : Customers
retrievedBy
setInvocationContext()  : mixed
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
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
videChannel()  : mixed
withContext()  : mixed
requestedBy()  : mixed
setAPIEndpoint()  : mixed

Constants

DISCRIMINATOR

public mixed DISCRIMINATOR = null

Properties

$api_end_point

protected string $api_end_point

$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 = ['list' => 'list', 'total_results_count' => 'total_results_count', 'has_more_results' => 'has_more_results', 'url' => 'url', 'from_index' => 'from_index', 'to_index' => 'to_index', 'query_id' => 'query_id', 'page_size' => 'page_size', 'customer_reference' => 'customer_reference', 'ssn' => 'ssn', 'email' => 'email', 'account_number' => 'account_number']

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['list' => 'getList', 'total_results_count' => 'getTotalResultsCount', 'has_more_results' => 'getHasMoreResults', 'url' => 'getUrl', 'from_index' => 'getFromIndex', 'to_index' => 'getToIndex', 'query_id' => 'getQueryId', 'page_size' => 'getPageSize', 'customer_reference' => 'getCustomerReference', 'ssn' => 'getSsn', 'email' => 'getEmail', 'account_number' => 'getAccountNumber']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['list' => 'setList', 'total_results_count' => 'setTotalResultsCount', 'has_more_results' => 'setHasMoreResults', 'url' => 'setUrl', 'from_index' => 'setFromIndex', 'to_index' => 'setToIndex', 'query_id' => 'setQueryId', 'page_size' => 'setPageSize', 'customer_reference' => 'setCustomerReference', 'ssn' => 'setSsn', 'email' => 'setEmail', 'account_number' => 'setAccountNumber']

$swaggerFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerFormats = ['list' => null, 'total_results_count' => null, 'has_more_results' => null, 'url' => null, 'from_index' => null, 'to_index' => null, 'query_id' => null, 'page_size' => null, 'customer_reference' => null, 'ssn' => null, 'email' => null, 'account_number' => null]

$swaggerTypes

Array of property to type mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerTypes = ['list' => '\Orbipay\PaymentsApi\Client\Wrappers\Customer[]', 'total_results_count' => 'string', 'has_more_results' => 'string', 'url' => 'string', 'from_index' => 'string', 'to_index' => 'string', 'query_id' => 'string', 'page_size' => 'string', 'customer_reference' => 'string', 'ssn' => 'string', 'email' => 'string', 'account_number' => 'string']

$account_number

private string $account_number

$customer_reference

private string $customer_reference

$has_more_results

private string $has_more_results

$http_status_code

private mixed $http_status_code

$live_mode

private string $live_mode

$total_results_count

private string $total_results_count

Methods

__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> —

findBy()

public findBy([MultiMap $filterMap = null ]) : mixed
Parameters
$filterMap : MultiMap = null
Return values
mixed —

forClient()

public forClient([mixed $client_key = null ]) : mixed
Parameters
$client_key : mixed = null
Return values
mixed —

getAccountNumber()

Gets account_number

public getAccountNumber() : string
Return values
string —

$account_number Customer Account Number of the customer to get details of.

getApiEndPoint()

public getApiEndPoint() : string
Return values
string —

getCustomerReference()

Gets customer_reference

public getCustomerReference() : string
Return values
string —

$customer_reference Unique ID assigned by the biller/client system for a given customer.

getEmail()

Gets email

public getEmail() : string
Return values
string —

$email This field contains the customer’s email address within EBPP.

getFromIndex()

Gets from_index

public getFromIndex() : string
Return values
string —

$from_index The id of the object before which the previous set of objects are to be retrieved.

getHasMoreResults()

Gets has_more_results

public getHasMoreResults() : string
Return values
string —

$has_more_results true if there are more results or pages

getHttpStatusCode()

public getHttpStatusCode() : mixed
Return values
mixed —

getList()

Gets list

public getList() : array<string|int, Customer>
Return values
array<string|int, Customer> —

$list list

getPageSize()

Gets page_size

public getPageSize() : string
Return values
string —

$page_size The maximum number of objects returned in the query.

getQueryId()

Gets query_id

public getQueryId() : string
Return values
string —

$query_id The query id of the object.

getSsn()

Gets ssn

public getSsn() : string
Return values
string —

$ssn The SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business.

getters()

Array of attributes to getter functions (for serialization of requests)

public static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getToIndex()

Gets to_index

public getToIndex() : string
Return values
string —

$to_index The id of the object after which the next set of objects are to be retrieved.

getTotalResultsCount()

Gets total_results_count

public getTotalResultsCount() : string
Return values
string —

$total_results_count The total number of customers available matching the search criteria.

getUrl()

Gets url

public getUrl() : string
Return values
string —

$url This URL fetches the next or previous set of payments, based on the presence of after_object or before_object parameter.

retrievedBy()

retrievedBy

public retrievedBy([ $requestor = null ][,  $requestor_type = null ]) : Customers
Parameters
$requestor : = null
$requestor_type : = null
Return values
Customers —

setters()

Array of attributes to setter functions (for deserialization of responses)

public static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

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>
Return values
array<string|int, mixed> —

videChannel()

public videChannel([mixed $channel = null ]) : mixed
Parameters
$channel : mixed = null
Return values
mixed —

withContext()

public withContext(InvocationContext $request[, string $live_mode = null ][, string $apiEndPoint = null ]) : mixed
Parameters
$request : InvocationContext
$live_mode : string = null
$apiEndPoint : string = null
Return values
mixed —

requestedBy()

protected requestedBy(mixed $requestor, mixed $requestor_type) : mixed
Parameters
$requestor : mixed
$requestor_type : mixed
Return values
mixed —

setAPIEndpoint()

protected setAPIEndpoint([string $live_mode = null ][, string $apiEndPoint = null ]) : mixed
Parameters
$live_mode : string = null
$apiEndPoint : string = null
Return values
mixed —

Search results