module:models/ContactslinkContact(value, type, verified_by)

new module:models/ContactslinkContact(value, type, verified_by)
models/ContactslinkContact.js, line 36

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

Constructs a new ContactslinkContact.
Parameters:
Name Type Description
value String

The customer's contact information that need to be linked If the type field is set to email, the value field should be a valid email address. If the type field is set to sms, the value field should be a mobile number in E.164 format with the appropriate country code.
type module:models/ContactslinkContact.TypeEnum

The type of contact.
verified_by module:models/ContactslinkContact.VerifiedByEnum

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. The "none" value indicates that the contact has not been verified by anyone and may be considered unverified or potentially unreliable."

Members

static, readonly TypeEnum :String
models/ContactslinkContact.js, line 99

Allowed values for the type property.

Properties:
Name Type Description
sms String

value: "sms"
email String

value: "email"

static, readonly VerifiedByEnum :String
models/ContactslinkContact.js, line 116

Allowed values for the verified_by property.

Properties:
Name Type Description
orbipay String

value: "orbipay"
other String

value: "other"
none String

value: "none"

inner type :module:models/ContactslinkContact.TypeEnum
models/ContactslinkContact.js, line 77

The type of contact.

inner value :String
models/ContactslinkContact.js, line 72

The customer's contact information that need to be linked If the type field is set to email, the value field should be a valid email address. If the type field is set to sms, the value field should be a mobile number in E.164 format with the appropriate country code.

inner verification_code :String
models/ContactslinkContact.js, line 87

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.

inner verified_by :module:models/ContactslinkContact.VerifiedByEnum
models/ContactslinkContact.js, line 82

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. The "none" value indicates that the contact has not been verified by anyone and may be considered unverified or potentially unreliable."

Methods

static constructFromObject(data, obj) → {module:models/ContactslinkContact}
models/ContactslinkContact.js, line 52

Constructs a ContactslinkContact from a plain JavaScript object, optionally creating a new instance. Copies all relevant properties from data to obj if supplied or a new instance if not.

Parameters:
Name Type Description
data Object

The plain JavaScript object bearing properties of interest.
obj module:models/ContactslinkContact

Optional instance to populate.
Returns:
module:models/ContactslinkContact -

The populated ContactslinkContact instance.