Documentation

AccountAddress
in package
implements ModelInterface, ArrayAccess

AccountAddress Class Doc Comment

Tags
category

Class

description

Contains information about an account address.

author

Swagger Codegen team apihelp@docusign.com

license

The DocuSign PHP Client SDK is licensed under the MIT License.

link
https://github.com/swagger-api/swagger-codegen

Interfaces, Classes, Traits and Enums

ModelInterface
Interface abstracting model access.
ArrayAccess

Table of Contents

DISCRIMINATOR  = null
$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
getAddress1()  : string|null
Gets address1
getAddress2()  : string|null
Gets address2
getCity()  : string|null
Gets city
getCountry()  : string|null
Gets country
getEmail()  : string|null
Gets email
getFax()  : string|null
Gets fax
getFirstName()  : string|null
Gets first_name
getLastName()  : string|null
Gets last_name
getModelName()  : string
The original name of the model.
getPhone()  : string|null
Gets phone
getPostalCode()  : string|null
Gets postal_code
getState()  : string|null
Gets state
getSupportedCountries()  : array<string|int, Country>
Gets supported_countries
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
listInvalidProperties()  : array<string|int, mixed>
Show all the invalid properties with reasons.
offsetExists()  : bool
Returns true if offset exists. False otherwise.
offsetGet()  : mixed
Gets offset.
offsetSet()  : void
Sets value based on offset.
offsetUnset()  : void
Unsets offset.
setAddress1()  : $this
Sets address1
setAddress2()  : $this
Sets address2
setCity()  : $this
Sets city
setCountry()  : $this
Sets country
setEmail()  : $this
Sets email
setFax()  : $this
Sets fax
setFirstName()  : $this
Sets first_name
setLastName()  : $this
Sets last_name
setPhone()  : $this
Sets phone
setPostalCode()  : $this
Sets postal_code
setState()  : $this
Sets state
setSupportedCountries()  : $this
Sets supported_countries
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
valid()  : bool
Validate all the properties in the model return true if all passed

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 = ['address1' => 'address1', 'address2' => 'address2', 'city' => 'city', 'country' => 'country', 'email' => 'email', 'fax' => 'fax', 'first_name' => 'firstName', 'last_name' => 'lastName', 'phone' => 'phone', 'postal_code' => 'postalCode', 'state' => 'state', 'supported_countries' => 'supportedCountries']

$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 = ['address1' => 'getAddress1', 'address2' => 'getAddress2', 'city' => 'getCity', 'country' => 'getCountry', 'email' => 'getEmail', 'fax' => 'getFax', 'first_name' => 'getFirstName', 'last_name' => 'getLastName', 'phone' => 'getPhone', 'postal_code' => 'getPostalCode', 'state' => 'getState', 'supported_countries' => 'getSupportedCountries']

$setters

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

protected static array<string|int, string> $setters = ['address1' => 'setAddress1', 'address2' => 'setAddress2', 'city' => 'setCity', 'country' => 'setCountry', 'email' => 'setEmail', 'fax' => 'setFax', 'first_name' => 'setFirstName', 'last_name' => 'setLastName', 'phone' => 'setPhone', 'postal_code' => 'setPostalCode', 'state' => 'setState', 'supported_countries' => 'setSupportedCountries']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['address1' => null, 'address2' => null, 'city' => null, 'country' => null, 'email' => null, 'fax' => null, 'first_name' => null, 'last_name' => null, 'phone' => null, 'postal_code' => null, 'state' => null, 'supported_countries' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'accountAddress'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['address1' => '?string', 'address2' => '?string', 'city' => '?string', 'country' => '?string', 'email' => '?string', 'fax' => '?string', 'first_name' => '?string', 'last_name' => '?string', 'phone' => '?string', 'postal_code' => '?string', 'state' => '?string', 'supported_countries' => '\\DocuSign\\eSign\\Model\\Country[]']

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>

getAddress1()

Gets address1

public getAddress1() : string|null
Return values
string|null

getAddress2()

Gets address2

public getAddress2() : string|null
Return values
string|null

getCity()

Gets city

public getCity() : string|null
Return values
string|null

getCountry()

Gets country

public getCountry() : string|null
Return values
string|null

getEmail()

Gets email

public getEmail() : string|null
Return values
string|null

getFax()

Gets fax

public getFax() : string|null
Return values
string|null

getFirstName()

Gets first_name

public getFirstName() : string|null
Return values
string|null

getLastName()

Gets last_name

public getLastName() : string|null
Return values
string|null

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getPhone()

Gets phone

public getPhone() : string|null
Return values
string|null

getPostalCode()

Gets postal_code

public getPostalCode() : string|null
Return values
string|null

getState()

Gets state

public getState() : string|null
Return values
string|null

getSupportedCountries()

Gets supported_countries

public getSupportedCountries() : array<string|int, Country>
Return values
array<string|int, Country>

getters()

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

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

listInvalidProperties()

Show all the invalid properties with reasons.

public listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed>

invalid properties with reasons

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

setAddress1()

Sets address1

public setAddress1(string|null $address1) : $this
Parameters
$address1 : string|null

First Line of the address. Maximum length: 100 characters.

Return values
$this

setAddress2()

Sets address2

public setAddress2(string|null $address2) : $this
Parameters
$address2 : string|null

Second Line of the address. Maximum length: 100 characters.

Return values
$this

setCity()

Sets city

public setCity(string|null $city) : $this
Parameters
$city : string|null

The city value of the address.

Return values
$this

setCountry()

Sets country

public setCountry(string|null $country) : $this
Parameters
$country : string|null

Specifies the country associated with the address.

Return values
$this

setEmail()

Sets email

public setEmail(string|null $email) : $this
Parameters
$email : string|null
Return values
$this

setFax()

Sets fax

public setFax(string|null $fax) : $this
Parameters
$fax : string|null
Return values
$this

setFirstName()

Sets first_name

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

The user's first name. Maximum Length: 50 characters.

Return values
$this

setLastName()

Sets last_name

public setLastName(string|null $last_name) : $this
Parameters
$last_name : string|null
Return values
$this

setPhone()

Sets phone

public setPhone(string|null $phone) : $this
Parameters
$phone : string|null
Return values
$this

setPostalCode()

Sets postal_code

public setPostalCode(string|null $postal_code) : $this
Parameters
$postal_code : string|null
Return values
$this

setState()

Sets state

public setState(string|null $state) : $this
Parameters
$state : string|null

The state or province associated with the address.

Return values
$this

setSupportedCountries()

Sets supported_countries

public setSupportedCountries(array<string|int, Country$supported_countries) : $this
Parameters
$supported_countries : array<string|int, Country>

Contains an array of countries supported by the billing plan.

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>

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>

valid()

Validate all the properties in the model return true if all passed

public valid() : bool
Return values
bool

True if all properties are valid

Search results