Documentation

Address
in package

Address Class Doc Comment

Tags
category

Class

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
$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
$swaggerTypes  : array<string|int, string>
Array of property to type mappings. Used for (de)serialization
$address_city  : string
$address_country  : string
$address_line1  : string
$address_line2  : string
$address_state  : string
$address_zip1  : string
$address_zip2  : string
__construct()  : mixed
Address constructor.
attributeMap()  : array<string|int, mixed>
Array of attributes where the key is the local name, and the value is the original name
getAddressCity()  : string
Gets address_city
getAddressCountry()  : string
Gets address_country
getAddressLine1()  : string
Gets address_line1
getAddressLine2()  : string
Gets address_line2
getAddressState()  : string
Gets address_state
getAddressZip1()  : string
Gets address_zip1
getAddressZip2()  : string
Gets address_zip2
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
jsonSerialize()  : mixed
Specify data which should be serialized to JSON
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

Constants

DISCRIMINATOR

public mixed DISCRIMINATOR = null

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 = ['address_line1' => 'address_line1', 'address_line2' => 'address_line2', 'address_city' => 'address_city', 'address_state' => 'address_state', 'address_country' => 'address_country', 'address_zip1' => 'address_zip1', 'address_zip2' => 'address_zip2']

$getters

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

protected static array<string|int, string> $getters = ['address_line1' => 'getAddressLine1', 'address_line2' => 'getAddressLine2', 'address_city' => 'getAddressCity', 'address_state' => 'getAddressState', 'address_country' => 'getAddressCountry', 'address_zip1' => 'getAddressZip1', 'address_zip2' => 'getAddressZip2']

$setters

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

protected static array<string|int, string> $setters = ['address_line1' => 'setAddressLine1', 'address_line2' => 'setAddressLine2', 'address_city' => 'setAddressCity', 'address_state' => 'setAddressState', 'address_country' => 'setAddressCountry', 'address_zip1' => 'setAddressZip1', 'address_zip2' => 'setAddressZip2']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['address_line1' => null, 'address_line2' => null, 'address_city' => null, 'address_state' => null, 'address_country' => null, 'address_zip1' => null, 'address_zip2' => null]

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['address_line1' => 'string', 'address_line2' => 'string', 'address_city' => 'string', 'address_state' => 'string', 'address_country' => 'string', 'address_zip1' => 'string', 'address_zip2' => 'string']

$address_city

private string $address_city

$address_country

private string $address_country

$address_line1

private string $address_line1

$address_line2

private string $address_line2

$address_state

private string $address_state

$address_zip1

private string $address_zip1

$address_zip2

private string $address_zip2

Methods

__construct()

Address constructor.

public __construct([string $address_line1 = null ][, string $address_line2 = null ][, string $address_city = null ][, string $address_state = null ][, string $address_country = null ][, string $address_zip1 = null ][, string $address_zip2 = null ]) : mixed
Parameters
$address_line1 : string = null
$address_line2 : string = null
$address_city : string = null
$address_state : string = null
$address_country : string = null
$address_zip1 : string = null
$address_zip2 : string = null
Return values
mixed —

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

getAddressCity()

Gets address_city

public getAddressCity() : string
Return values
string —

$address_city City of the address.

getAddressCountry()

Gets address_country

public getAddressCountry() : string
Return values
string —

$address_country The 3 letter country code as per ISO 3166-1 (alpha-3).

getAddressLine1()

Gets address_line1

public getAddressLine1() : string
Return values
string —

$address_line1 Line one of the address.

getAddressLine2()

Gets address_line2

public getAddressLine2() : string
Return values
string —

$address_line2 Line two of the address.

getAddressState()

Gets address_state

public getAddressState() : string
Return values
string —

$address_state The state or province code as per ISO_3166-2.

getAddressZip1()

Gets address_zip1

public getAddressZip1() : string
Return values
string —

$address_zip1 The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.

getAddressZip2()

Gets address_zip2

public getAddressZip2() : string
Return values
string —

$address_zip2 The 4 digit add-on code used, in addition to the 5 digit postal code, by the US Postal Service.

getters()

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

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

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

Search results