PbtContact
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
- TYPE_SMS = 'sms'
- VERIFIED_BY_ORBIPAY = 'orbipay'
- VERIFIED_BY_OTHER = 'other'
- $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
- getModelName() : string
- The original name of the model.
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getType() : string
- Gets type
- getTypeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getValue() : string
- Gets value
- getVerificationCode() : string
- Gets verification_code
- getVerifiedBy() : string
- Gets verified_by
- getVerifiedByAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- offsetExists() : bool
- Returns true if offset exists. False otherwise.
- offsetGet() : mixed
- Gets offset.
- offsetSet() : void
- Sets value based on offset.
- offsetUnset() : void
- Unsets offset.
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setType() : $this
- Sets type
- setValue() : $this
- Sets value
- setVerificationCode() : $this
- Sets verification_code
- setVerifiedBy() : $this
- Sets verified_by
- 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
TYPE_SMS
public
mixed
TYPE_SMS
= 'sms'
VERIFIED_BY_ORBIPAY
public
mixed
VERIFIED_BY_ORBIPAY
= 'orbipay'
VERIFIED_BY_OTHER
public
mixed
VERIFIED_BY_OTHER
= 'other'
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
= ['value' => 'value', 'type' => 'type', 'verified_by' => 'verified_by', 'verification_code' => 'verification_code']
$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
= ['value' => 'getValue', 'type' => 'getType', 'verified_by' => 'getVerifiedBy', 'verification_code' => 'getVerificationCode']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['value' => 'setValue', 'type' => 'setType', 'verified_by' => 'setVerifiedBy', 'verification_code' => 'setVerificationCode']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['value' => null, 'type' => null, 'verified_by' => null, 'verification_code' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'pbt_contact'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['value' => 'string', 'type' => 'string', 'verified_by' => 'string', 'verification_code' => '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> —getModelName()
The original name of the model.
public
getModelName() : string
Return values
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> —getType()
Gets type
public
getType() : string
Return values
string —getTypeAllowableValues()
Gets allowable values of the enum
public
getTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getValue()
Gets value
public
getValue() : string
Return values
string —getVerificationCode()
Gets verification_code
public
getVerificationCode() : string
Return values
string —getVerifiedBy()
Gets verified_by
public
getVerifiedBy() : string
Return values
string —getVerifiedByAllowableValues()
Gets allowable values of the enum
public
getVerifiedByAllowableValues() : array<string|int, string>
Return values
array<string|int, 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 —setters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —setType()
Sets type
public
setType(string $type) : $this
Parameters
- $type : string
-
The type of contact information.
Return values
$this —setValue()
Sets value
public
setValue(string $value) : $this
Parameters
- $value : string
-
The customer's phone number to be enrolled for pay-by-text.
Return values
$this —setVerificationCode()
Sets verification_code
public
setVerificationCode(string $verification_code) : $this
Parameters
- $verification_code : string
-
The unique verification code generated by EBPP using <a href="#operation/initiateContactVerification"> Initiate Contact Verification API. This field is mandatory if the verified_by type is orbipay, indicating that the contact has been verified by the EBPP. If the verified_by type is other or none, this field may be left empty or null.
Return values
$this —setVerifiedBy()
Sets verified_by
public
setVerifiedBy(string $verified_by) : $this
Parameters
- $verified_by : string
-
The entity that verified the contact. The "orbipay" value indicates that the contact has been verified by the EBPP, which is a reliable and trusted method of contact verification. The "other" value indicates that the contact has been verified client or some other trusted third-party. While this method may also be reliable, it is not as widely recognized or trusted as EBPP. For the Manage PBT Enrollment API, it is mandatory to use a contact that has been verified by either EBPP or a trusted third party."
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>