Documentation

AddressVo implements ModelInterface, ArrayAccess

Warning:

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

Tags
category

Class

Interfaces, Classes and Traits

ModelInterface
Warning:
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
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
getModelName()  : string
The original name of the model.
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
offsetExists()  : bool
Returns true if offset exists. False otherwise.
offsetGet()  : mixed
Gets offset.
offsetSet()  : void
Sets value based on offset.
offsetUnset()  : void
Unsets offset.
setAddressCity()  : $this
Sets address_city
setAddressCountry()  : $this
Sets address_country
setAddressLine1()  : $this
Sets address_line1
setAddressLine2()  : $this
Sets address_line2
setAddressState()  : $this
Sets address_state
setAddressZip1()  : $this
Sets address_zip1
setAddressZip2()  : $this
Sets address_zip2
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']

$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 = ['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]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'AddressVo'

$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']

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>

getAddressCity()

Gets address_city

public getAddressCity() : string
Return values
string

getAddressCountry()

Gets address_country

public getAddressCountry() : string
Return values
string

getAddressLine1()

Gets address_line1

public getAddressLine1() : string
Return values
string

getAddressLine2()

Gets address_line2

public getAddressLine2() : string
Return values
string

getAddressState()

Gets address_state

public getAddressState() : string
Return values
string

getAddressZip1()

Gets address_zip1

public getAddressZip1() : string
Return values
string

getAddressZip2()

Gets address_zip2

public getAddressZip2() : string
Return values
string

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>

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

setAddressCity()

Sets address_city

public setAddressCity(string $address_city) : $this
Parameters
$address_city : string

City of the address.

Return values
$this

setAddressCountry()

Sets address_country

public setAddressCountry(string $address_country) : $this
Parameters
$address_country : string

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

Return values
$this

setAddressLine1()

Sets address_line1

public setAddressLine1(string $address_line1) : $this
Parameters
$address_line1 : string

Line one of the address.

Return values
$this

setAddressLine2()

Sets address_line2

public setAddressLine2(string $address_line2) : $this
Parameters
$address_line2 : string

Line two of the address.

Return values
$this

setAddressState()

Sets address_state

public setAddressState(string $address_state) : $this
Parameters
$address_state : string

The state or province code as per ISO_3166-2.

Return values
$this

setAddressZip1()

Sets address_zip1

public setAddressZip1(string $address_zip1) : $this
Parameters
$address_zip1 : string

The first part of the postal code for the address as per the system followed in the appropriate country where it belongs. In the case of US, it's the 5 digit postal code used by the US Postal Service.

Return values
$this

setAddressZip2()

Sets address_zip2

public setAddressZip2(string $address_zip2) : $this
Parameters
$address_zip2 : string

The 4 digit add-on code used, in addition to the 5 digit postal code, by the US Postal Service.This is not applicable and will be ignored in the case of non-US addresses.

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>

Search results