Contact extends BaseContact
Defines a contact entity
Table of Contents
- $actions : array<string|int, mixed>|null
- $address : string|null
- The contact's address
- $description : string|null
- The contact's description
- $email : string|null
- The contact's email. This field can be unset when updating.
- $id : string|null
- The contact's identifier
- $mobilePhoneNumber : string|null
- The contact's mobile phone number must be in the international format with no spaces between numbers (+country code - number). This field can be unset when updating.
- $name : string|null
- The contact's name
- $phoneNumber : string|null
- The contact's phone number must be in the international format with no spaces between numbers (+country code - number). This field can be unset when updating.
- $resources : array<string|int, mixed>|null
- from() : static
- Initializing a model from an array
- getActions() : array<string|int, string>
- Getter for actions
- getAddress() : string
- Getter for address
- getDescription() : string
- Getter for description
- getEmail() : string
- Getter for email
- getId() : string
- Getter for id
- getMobilePhoneNumber() : string
- Getter for mobilePhoneNumber
- getName() : string
- Getter for name
- getPhoneNumber() : string
- Getter for phoneNumber
- getResources() : array<string|int, string>
- Getter for resources
- jsonSerialize() : array<string|int, mixed>
- setActions() : static
- Setter for actions
- setAddress() : static
- Setter for address
- setDescription() : static
- Setter for description
- setEmail() : static
- Setter for email
- setId() : static
- Setter for id
- setMobilePhoneNumber() : static
- Setter for mobilePhoneNumber
- setName() : static
- Setter for name
- setPhoneNumber() : static
- Setter for phoneNumber
- setResources() : static
- Setter for resources
Properties
$actions
protected
array<string|int, mixed>|null
$actions
= null
$address
The contact's address
protected
string|null
$address
= null
$description
The contact's description
protected
string|null
$description
= null
The contact's email. This field can be unset when updating.
protected
string|null
$email
= null
$id
The contact's identifier
protected
string|null
$id
= null
$mobilePhoneNumber
The contact's mobile phone number must be in the international format with no spaces between numbers (+country code - number). This field can be unset when updating.
protected
string|null
$mobilePhoneNumber
= null
$name
The contact's name
protected
string|null
$name
= null
$phoneNumber
The contact's phone number must be in the international format with no spaces between numbers (+country code - number). This field can be unset when updating.
protected
string|null
$phoneNumber
= null
$resources
protected
array<string|int, mixed>|null
$resources
= null
Methods
from()
Initializing a model from an array
public
static from(array<string|int, mixed> $params) : static
Parameters
- $params : array<string|int, mixed>
-
Pass this parameter if you want to initial property value from an array. See API reference for all property names and types
Tags
Return values
static —getActions()
Getter for actions
public
getActions() : array<string|int, string>
Return values
array<string|int, string> —getAddress()
Getter for address
public
getAddress() : string
Return values
string —The contact's address
getDescription()
Getter for description
public
getDescription() : string
Return values
string —The contact's description
getEmail()
Getter for email
public
getEmail() : string
Return values
string —The contact's email. This field can be unset when updating.
getId()
Getter for id
public
getId() : string
Return values
string —The contact's identifier
getMobilePhoneNumber()
Getter for mobilePhoneNumber
public
getMobilePhoneNumber() : string
Return values
string —The contact's mobile phone number must be in the international format with no spaces between numbers (+country code - number). This field can be unset when updating.
getName()
Getter for name
public
getName() : string
Return values
string —The contact's name
getPhoneNumber()
Getter for phoneNumber
public
getPhoneNumber() : string
Return values
string —The contact's phone number must be in the international format with no spaces between numbers (+country code - number). This field can be unset when updating.
getResources()
Getter for resources
public
getResources() : array<string|int, string>
Return values
array<string|int, string> —jsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —setActions()
Setter for actions
public
setActions(array<string|int, string> $actions) : static
Parameters
- $actions : array<string|int, string>
Return values
static —To use in method chains
setAddress()
Setter for address
public
setAddress(string $address) : static
Parameters
- $address : string
-
The contact's address
Return values
static —To use in method chains
setDescription()
Setter for description
public
setDescription(string $description) : static
Parameters
- $description : string
-
The contact's description
Return values
static —To use in method chains
setEmail()
Setter for email
public
setEmail(string $email) : static
Parameters
- $email : string
-
The contact's email. This field can be unset when updating.
Return values
static —To use in method chains
setId()
Setter for id
public
setId(string $id) : static
Parameters
- $id : string
-
The contact's identifier
Return values
static —To use in method chains
setMobilePhoneNumber()
Setter for mobilePhoneNumber
public
setMobilePhoneNumber(string $mobilePhoneNumber) : static
Parameters
- $mobilePhoneNumber : string
-
The contact's mobile phone number must be in the international format with no spaces between numbers (+country code - number). This field can be unset when updating.
Return values
static —To use in method chains
setName()
Setter for name
public
setName(string $name) : static
Parameters
- $name : string
-
The contact's name
Return values
static —To use in method chains
setPhoneNumber()
Setter for phoneNumber
public
setPhoneNumber(string $phoneNumber) : static
Parameters
- $phoneNumber : string
-
The contact's phone number must be in the international format with no spaces between numbers (+country code - number). This field can be unset when updating.
Return values
static —To use in method chains
setResources()
Setter for resources
public
setResources(array<string|int, string> $resources) : static
Parameters
- $resources : array<string|int, string>
Return values
static —To use in method chains