Documentation

CustomerResponse
in package
implements ModelInterface, ArrayAccess

Warning:

This class subject to change without prior notice, Please dont use this class directly.

Tags
category

Class

Interfaces, Classes and Traits

ModelInterface
Warning:
ArrayAccess

Table of Contents

DISCRIMINATOR  = null
GENDER_FEMALE  = 'female'
GENDER_MALE  = 'male'
STATUS_ACTIVE  = 'active'
STATUS_REVOKED  = 'revoked'
STATUS_SUSPENDED  = 'suspended'
$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
getAddress()  : AddressVo
Gets address
getAuditInfo()  : AuditInfoVo
Gets audit_info
getComments()  : string
Gets comments
getCustomerAccounts()  : CustomersCustomerAccountsResponse
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()  : CustomersFundingAccountsResponse
Gets funding_accounts
getGender()  : string
Gets gender
getGenderAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getHomePhone()  : string
Gets home_phone
getId()  : string
Gets id
getLastName()  : string
Gets last_name
getLocale()  : string
Gets locale
getMiddleName()  : string
Gets middle_name
getMobilePhone()  : string
Gets mobile_phone
getModelName()  : string
The original name of the model.
getPayments()  : CustomersPaymentsResponse
Gets payments
getPaymentSetups()  : CustomersPaymentSetupsResponse
Gets payment_setups
getRegisteredEmail()  : string
Gets registered_email
getSsn()  : string
Gets ssn
getStatus()  : string
Gets status
getStatusAllowableValues()  : 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)
getUrl()  : string
Gets url
getWorkPhone()  : string
Gets work_phone
offsetExists()  : bool
Returns true if offset exists. False otherwise.
offsetGet()  : mixed
Gets offset.
offsetSet()  : void
Sets value based on offset.
offsetUnset()  : void
Unsets offset.
setAddress()  : $this
Sets address
setAuditInfo()  : $this
Sets audit_info
setComments()  : $this
Sets comments
setCustomerAccounts()  : $this
Sets customer_accounts
setCustomerReference()  : $this
Sets customer_reference
setCustomFields()  : $this
Sets custom_fields
setDateOfBirth()  : $this
Sets date_of_birth
setEmail()  : $this
Sets email
setFirstName()  : $this
Sets first_name
setFundingAccounts()  : $this
Sets funding_accounts
setGender()  : $this
Sets gender
setHomePhone()  : $this
Sets home_phone
setId()  : $this
Sets id
setLastName()  : $this
Sets last_name
setLocale()  : $this
Sets locale
setMiddleName()  : $this
Sets middle_name
setMobilePhone()  : $this
Sets mobile_phone
setPayments()  : $this
Sets payments
setPaymentSetups()  : $this
Sets payment_setups
setRegisteredEmail()  : $this
Sets registered_email
setSsn()  : $this
Sets ssn
setStatus()  : $this
Sets status
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUrl()  : $this
Sets url
setWorkPhone()  : $this
Sets work_phone
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

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 = ['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']

$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 = ['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']

$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']

$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]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'CustomerResponse'

$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\Model\AddressVo', 'custom_fields' => 'map[string,string]', 'customer_reference' => 'string', 'id' => 'string', 'status' => 'string', 'url' => 'string', 'comments' => 'string', 'customer_accounts' => '\Orbipay\PaymentsApi\Client\Model\CustomersCustomerAccountsResponse', 'funding_accounts' => '\Orbipay\PaymentsApi\Client\Model\CustomersFundingAccountsResponse', 'payments' => '\Orbipay\PaymentsApi\Client\Model\CustomersPaymentsResponse', 'payment_setups' => '\Orbipay\PaymentsApi\Client\Model\CustomersPaymentSetupsResponse', 'audit_info' => '\Orbipay\PaymentsApi\Client\Model\AuditInfoVo']

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

getComments()

Gets comments

public getComments() : string
Return values
string —

getCustomerReference()

Gets customer_reference

public getCustomerReference() : string
Return values
string —

getCustomFields()

Gets custom_fields

public getCustomFields() : mixed
Return values
mixed —

getDateOfBirth()

Gets date_of_birth

public getDateOfBirth() : string
Return values
string —

getEmail()

Gets email

public getEmail() : string
Return values
string —

getFirstName()

Gets first_name

public getFirstName() : string
Return values
string —

getGender()

Gets gender

public getGender() : string
Return values
string —

getGenderAllowableValues()

Gets allowable values of the enum

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

getHomePhone()

Gets home_phone

public getHomePhone() : string
Return values
string —

getLastName()

Gets last_name

public getLastName() : string
Return values
string —

getLocale()

Gets locale

public getLocale() : string
Return values
string —

getMiddleName()

Gets middle_name

public getMiddleName() : string
Return values
string —

getMobilePhone()

Gets mobile_phone

public getMobilePhone() : string
Return values
string —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getRegisteredEmail()

Gets registered_email

public getRegisteredEmail() : string
Return values
string —

getStatus()

Gets status

public getStatus() : string
Return values
string —

getStatusAllowableValues()

Gets allowable values of the enum

public getStatusAllowableValues() : 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> —

getWorkPhone()

Gets work_phone

public getWorkPhone() : 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 —

setComments()

Sets comments

public setComments(string $comments) : $this
Parameters
$comments : string

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.

Return values
$this —

setCustomerReference()

Sets customer_reference

public setCustomerReference(string $customer_reference) : $this
Parameters
$customer_reference : string

The unique identifier in the client system for the customer.

Return values
$this —

setCustomFields()

Sets custom_fields

public setCustomFields(mixed $custom_fields) : $this
Parameters
$custom_fields : mixed
Return values
$this —

setDateOfBirth()

Sets date_of_birth

public setDateOfBirth(string $date_of_birth) : $this
Parameters
$date_of_birth : string

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

Return values
$this —

setEmail()

Sets email

public setEmail(string $email) : $this
Parameters
$email : string

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.

Return values
$this —

setFirstName()

Sets first_name

public setFirstName(string $first_name) : $this
Parameters
$first_name : string

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

Return values
$this —

setGender()

Sets gender

public setGender(string $gender) : $this
Parameters
$gender : string

The gender of the customer.

Return values
$this —

setHomePhone()

Sets home_phone

public setHomePhone(string $home_phone) : $this
Parameters
$home_phone : string

The home phone number of the customer.

Return values
$this —

setId()

Sets id

public setId(string $id) : $this
Parameters
$id : string

The unique identifier assigned by EBPP to the customer.

Return values
$this —

setLastName()

Sets last_name

public setLastName(string $last_name) : $this
Parameters
$last_name : string

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

Return values
$this —

setLocale()

Sets locale

public setLocale(string $locale) : $this
Parameters
$locale : string

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.

Return values
$this —

setMiddleName()

Sets middle_name

public setMiddleName(string $middle_name) : $this
Parameters
$middle_name : string

The middle name of the customer.

Return values
$this —

setMobilePhone()

Sets mobile_phone

public setMobilePhone(string $mobile_phone) : $this
Parameters
$mobile_phone : string

The mobile phone number of the customer.

Return values
$this —

setRegisteredEmail()

Sets registered_email

public setRegisteredEmail(string $registered_email) : $this
Parameters
$registered_email : string

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.

Return values
$this —

setSsn()

Sets ssn

public setSsn(string $ssn) : $this
Parameters
$ssn : string

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

Return values
$this —

setStatus()

Sets status

public setStatus(string $status) : $this
Parameters
$status : string

The status of the customer in EBPP.

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

setUrl()

Sets url

public setUrl(string $url) : $this
Parameters
$url : string

This URL fetches the Customer details.

Return values
$this —

setWorkPhone()

Sets work_phone

public setWorkPhone(string $work_phone) : $this
Parameters
$work_phone : string

The work phone number of the customer.

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

Search results