Documentation

Customer extends Base
in package

Customer 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
$address  : Address
$audit_info  : AuditInfo
$comments  : string
$custom_fields  : mixed
$customer_accounts  : CustomerAccounts
$customer_reference  : string
$date_of_birth  : string
$email  : string
$first_name  : string
$funding_accounts  : FundingAccounts
$gender  : string
$home_phone  : string
$http_status_code  : mixed
$id  : string
$id_customer  : string
$invocation_context  : InvocationContext
$last_name  : string
$live_mode  : string
$locale  : string
$middle_name  : string
$mobile_phone  : string
$payment_setups  : PaymentSetups
$payments  : Payments
$registered_email  : string
$ssn  : string
$status  : string
$url  : string
$work_phone  : string
__construct()  : mixed
Customer 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
create()  : Customer
create
createdBy()  : Customer
createdBy
forClient()  : mixed
get()  : Customer
get
getAddress()  : Address
Gets address
getApiEndPoint()  : string
getAuditInfo()  : AuditInfo
Gets audit_info
getComments()  : string
Gets comments
getCustomerAccounts()  : CustomerAccounts
Gets customer_accounts
getCustomerReference()  : string
Gets customer_reference
getCustomFields()  : mixed
Gets custom_fields
getDateOfBirth()  : string
Gets date_of_birth
getEmail()  : string
Gets email
getFirstName()  : string
Gets first_name
getFundingAccounts()  : FundingAccounts
Gets funding_accounts
getGender()  : string
Gets gender
getHomePhone()  : string
Gets home_phone
getHttpStatusCode()  : mixed
getId()  : string
Gets id
getIdCustomer()  : string
Gets id_customer
getInvocationContext()  : InvocationContext
getLastName()  : string
Gets last_name
getLocale()  : string
Gets locale
getMiddleName()  : string
Gets middle_name
getMobilePhone()  : string
Gets mobile_phone
getPayments()  : Payments
Gets payments
getPaymentSetups()  : PaymentSetups
Gets payment_setups
getRegisteredEmail()  : string
Gets registered_email
getSsn()  : string
Gets ssn
getStatus()  : string
Gets status
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUrl()  : string
Gets url
getWorkPhone()  : string
Gets work_phone
jsonSerialize()  : mixed
Specify data which should be serialized to JSON
retrievedBy()  : Customer
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
update()  : Customer
update
updatedBy()  : Customer
updatedBy
videChannel()  : mixed
withAccounts()  : mixed
withAddress()  : mixed
withContactInfo()  : mixed
withContext()  : mixed
withCustomFields()  : mixed
withDetails()  : mixed
withLocale()  : mixed
withMemo()  : mixed
withReference()  : mixed
withStatus()  : 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 = ['first_name' => 'first_name', 'last_name' => 'last_name', 'middle_name' => 'middle_name', 'gender' => 'gender', 'date_of_birth' => 'date_of_birth', 'ssn' => 'ssn', 'locale' => 'locale', 'email' => 'email', 'registered_email' => 'registered_email', 'home_phone' => 'home_phone', 'work_phone' => 'work_phone', 'mobile_phone' => 'mobile_phone', 'address' => 'address', 'custom_fields' => 'custom_fields', 'customer_reference' => 'customer_reference', 'id' => 'id', 'status' => 'status', 'url' => 'url', 'comments' => 'comments', 'customer_accounts' => 'customer_accounts', 'funding_accounts' => 'funding_accounts', 'payments' => 'payments', 'payment_setups' => 'payment_setups', 'audit_info' => 'audit_info', 'id_customer' => 'ID_CUSTOMER']

$getters

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

protected static array<string|int, string> $getters = ['first_name' => 'getFirstName', 'last_name' => 'getLastName', 'middle_name' => 'getMiddleName', 'gender' => 'getGender', 'date_of_birth' => 'getDateOfBirth', 'ssn' => 'getSsn', 'locale' => 'getLocale', 'email' => 'getEmail', 'registered_email' => 'getRegisteredEmail', 'home_phone' => 'getHomePhone', 'work_phone' => 'getWorkPhone', 'mobile_phone' => 'getMobilePhone', 'address' => 'getAddress', 'custom_fields' => 'getCustomFields', 'customer_reference' => 'getCustomerReference', 'id' => 'getId', 'status' => 'getStatus', 'url' => 'getUrl', 'comments' => 'getComments', 'customer_accounts' => 'getCustomerAccounts', 'funding_accounts' => 'getFundingAccounts', 'payments' => 'getPayments', 'payment_setups' => 'getPaymentSetups', 'audit_info' => 'getAuditInfo', 'id_customer' => 'getIdCustomer']

$setters

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

protected static array<string|int, string> $setters = ['first_name' => 'setFirstName', 'last_name' => 'setLastName', 'middle_name' => 'setMiddleName', 'gender' => 'setGender', 'date_of_birth' => 'setDateOfBirth', 'ssn' => 'setSsn', 'locale' => 'setLocale', 'email' => 'setEmail', 'registered_email' => 'setRegisteredEmail', 'home_phone' => 'setHomePhone', 'work_phone' => 'setWorkPhone', 'mobile_phone' => 'setMobilePhone', 'address' => 'setAddress', 'custom_fields' => 'setCustomFields', 'customer_reference' => 'setCustomerReference', 'id' => 'setId', 'status' => 'setStatus', 'url' => 'setUrl', 'comments' => 'setComments', 'customer_accounts' => 'setCustomerAccounts', 'funding_accounts' => 'setFundingAccounts', 'payments' => 'setPayments', 'payment_setups' => 'setPaymentSetups', 'audit_info' => 'setAuditInfo', 'id_customer' => 'setIdCustomer']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['first_name' => null, 'last_name' => null, 'middle_name' => null, 'gender' => null, 'date_of_birth' => null, 'ssn' => null, 'locale' => null, 'email' => 'email', 'registered_email' => 'email', 'home_phone' => null, 'work_phone' => null, 'mobile_phone' => null, 'address' => null, 'custom_fields' => null, 'customer_reference' => null, 'id' => null, 'status' => null, 'url' => null, 'comments' => null, 'customer_accounts' => null, 'funding_accounts' => null, 'payments' => null, 'payment_setups' => null, 'audit_info' => null, 'id_customer' => null]

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['first_name' => 'string', 'last_name' => 'string', 'middle_name' => 'string', 'gender' => 'string', 'date_of_birth' => 'string', 'ssn' => 'string', 'locale' => 'string', 'email' => 'string', 'registered_email' => 'string', 'home_phone' => 'string', 'work_phone' => 'string', 'mobile_phone' => 'string', 'address' => '\Orbipay\PaymentsApi\Client\Wrappers\Address', 'custom_fields' => 'map[string,string]', 'customer_reference' => 'string', 'id' => 'string', 'status' => 'string', 'url' => 'string', 'comments' => 'string', 'customer_accounts' => '\Orbipay\PaymentsApi\Client\Wrappers\CustomerAccounts', 'funding_accounts' => '\Orbipay\PaymentsApi\Client\Wrappers\FundingAccounts', 'payments' => '\Orbipay\PaymentsApi\Client\Wrappers\Payments', 'payment_setups' => '\Orbipay\PaymentsApi\Client\Wrappers\PaymentSetups', 'audit_info' => '\Orbipay\PaymentsApi\Client\Wrappers\AuditInfo', 'id_customer' => 'string']

$custom_fields

private mixed $custom_fields

$customer_reference

private string $customer_reference

$date_of_birth

private string $date_of_birth

$http_status_code

private mixed $http_status_code

$id_customer

private string $id_customer

$live_mode

private string $live_mode

$middle_name

private string $middle_name

$mobile_phone

private string $mobile_phone

$registered_email

private string $registered_email

Methods

__construct()

Customer constructor.

public __construct([string $id_customer = null ]) : mixed
Parameters
$id_customer : string = null
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> —

createdBy()

createdBy

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

forClient()

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

getApiEndPoint()

public getApiEndPoint() : string
Return values
string —

getComments()

Gets comments

public getComments() : string
Return values
string —

$comments Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.

getCustomerReference()

Gets customer_reference

public getCustomerReference() : string
Return values
string —

$customer_reference The unique identifier in the client system for the customer.

getCustomFields()

Gets custom_fields

public getCustomFields() : mixed
Return values
mixed —

getDateOfBirth()

Gets date_of_birth

public getDateOfBirth() : string
Return values
string —

$date_of_birth The date of birth of the customer. It should be in the full-date format as per ISO8601, namely, YYYY-MM-DD.

getEmail()

Gets email

public getEmail() : string
Return values
string —

$email The email address of the customer to which notifications from EBPP will be sent. This will default to the registered_email while creating a customer.

getFirstName()

Gets first_name

public getFirstName() : string
Return values
string —

$first_name The first name of the customer. Either first_name or last_name is required to create a customer.

getGender()

Gets gender

public getGender() : string
Return values
string —

$gender The gender of the customer.

getHomePhone()

Gets home_phone

public getHomePhone() : string
Return values
string —

$home_phone The home phone number of the customer.

getHttpStatusCode()

public getHttpStatusCode() : mixed
Return values
mixed —

getId()

Gets id

public getId() : string
Return values
string —

$id The unique identifier assigned by EBPP to the customer.

getIdCustomer()

Gets id_customer

public getIdCustomer() : string
Return values
string —

$id_customer The unique identifier assigned by EBPP to the customer.

getLastName()

Gets last_name

public getLastName() : string
Return values
string —

$last_name The last name of the customer. Either first_name or last_name is required to create a customer.

getLocale()

Gets locale

public getLocale() : string
Return values
string —

$locale The language in which the customer wants the alerts and notifications from EBPP. This is to be specified in the format,
< ISO-639-1 language code >_< ISO ALPHA-2 Country Code >.
For e.g., en_US indicates the language preference as US English, which is also the default value.

getMiddleName()

Gets middle_name

public getMiddleName() : string
Return values
string —

$middle_name The middle name of the customer.

getMobilePhone()

Gets mobile_phone

public getMobilePhone() : string
Return values
string —

$mobile_phone The mobile phone number of the customer.

getRegisteredEmail()

Gets registered_email

public getRegisteredEmail() : string
Return values
string —

$registered_email The email address of the customer registered with the client. This may be used to uniquely identify the customer if the client is set up accordingly in EBPP.

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.

getStatus()

Gets status

public getStatus() : string
Return values
string —

$status The status of the customer in EBPP.

getters()

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

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

getUrl()

Gets url

public getUrl() : string
Return values
string —

$url This URL fetches the Customer details.

getWorkPhone()

Gets work_phone

public getWorkPhone() : string
Return values
string —

$work_phone The work phone number of the customer.

retrievedBy()

retrievedBy

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

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

updatedBy()

updatedBy

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

videChannel()

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

withAccounts()

public withAccounts([mixed $customer_accounts = null ]) : mixed
Parameters
$customer_accounts : mixed = null
Return values
mixed —

withAddress()

public withAddress([mixed $address = null ]) : mixed
Parameters
$address : mixed = null
Return values
mixed —

withContactInfo()

public withContactInfo([mixed $email = null ][, mixed $home_phone = null ][, mixed $work_phone = null ][, mixed $mobile_phone = null ]) : mixed
Parameters
$email : mixed = null
$home_phone : mixed = null
$work_phone : mixed = null
$mobile_phone : 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 —

withCustomFields()

public withCustomFields([mixed $custom_fields = null ]) : mixed
Parameters
$custom_fields : mixed = null
Return values
mixed —

withDetails()

public withDetails([mixed $first_name = null ][, mixed $last_name = null ][, mixed $middle_name = null ][, mixed $date_of_birth = null ][, mixed $ssn = null ][, mixed $gender = null ][, mixed $registered_email = null ]) : mixed
Parameters
$first_name : mixed = null
$last_name : mixed = null
$middle_name : mixed = null
$date_of_birth : mixed = null
$ssn : mixed = null
$gender : mixed = null
$registered_email : mixed = null
Return values
mixed —

withLocale()

public withLocale([mixed $locale = null ]) : mixed
Parameters
$locale : mixed = null
Return values
mixed —

withMemo()

public withMemo([mixed $comments = null ]) : mixed
Parameters
$comments : mixed = null
Return values
mixed —

withReference()

public withReference([mixed $customer_reference = null ]) : mixed
Parameters
$customer_reference : mixed = null
Return values
mixed —

withStatus()

public withStatus([mixed $status = null ]) : mixed
Parameters
$status : mixed = 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